OpenMS  2.8.0
ToolHandler.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2021.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
40 
41 class QStringList;
42 
43 namespace OpenMS
44 {
59  /*
60  internal details & discussion:
61 
62  We could create the list of TOPP tools and UTILS from a set of files in /share
63  instead of hard coding them here.
64  Advantage: - no recompile if new tool is added (but the new tool will necessitate that anyway)
65  - quickly changing a tool's category (e.g. from PreProcessing to Quantitation) and thus its place in TOPPAS
66  even users could rearrange tools themselves...
67  Disadvantage:
68  - when to library loads, we'd need to parse all the files. Making our start-up time even longer...
69  - when files are broken/missing, we will have a hard time initializing the lib
70  */
71 
74 
75  class OPENMS_DLLAPI ToolHandler
76  {
77 public:
78 
80  static ToolListType getTOPPToolList(const bool includeGenericWrapper = false);
81 
84 
86  static StringList getTypes(const String& toolname);
87 
90  static bool checkDuplicated(const String& toolname);
91 
94  static String getCategory(const String& toolname);
95 
98 
101 
102 private:
103 
105  static QStringList getExternalToolConfigFiles_();
106  static void loadExternalToolConfig_();
109 
110  static std::vector<Internal::ToolDescription> getInternalTools_();
111  static QStringList getInternalToolConfigFiles_();
112  static void loadInternalToolConfig_();
113  static std::vector<Internal::ToolDescription> tools_internal_;
115  };
116 
117 } // namespace OpenMS
118 
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:52
A more convenient string class.
Definition: String.h:60
Definition: ToolHandler.h:76
static String getInternalToolsPath()
get File::getOpenMSDataPath() + "/TOOLS/INTERNAL"
static String getExternalToolsPath()
get getOpenMSDataPath() + "/TOOLS/EXTERNAL"
static void loadExternalToolConfig_()
static QStringList getInternalToolConfigFiles_()
static String getCategory(const String &toolname)
static bool tools_internal_loaded_
Definition: ToolHandler.h:114
static std::vector< Internal::ToolDescription > tools_internal_
Definition: ToolHandler.h:113
static QStringList getExternalToolConfigFiles_()
static Internal::ToolDescription tools_external_
Definition: ToolHandler.h:107
static StringList getTypes(const String &toolname)
get all types of a tool (empty if none)
static bool checkDuplicated(const String &toolname)
static ToolListType getTOPPToolList(const bool includeGenericWrapper=false)
Returns the list of official TOPP tools contained in the OpenMS/TOPP release.
static Internal::ToolDescription getExternalTools_()
static bool tools_external_loaded_
Definition: ToolHandler.h:108
static ToolListType getUtilList()
Returns the list of official UTIL tools contained in the OpenMS/TOPP release.
static std::vector< Internal::ToolDescription > getInternalTools_()
static void loadInternalToolConfig_()
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Map< String, Internal::ToolDescription > ToolListType
Handles lists of TOPP and UTILS tools and their categories (for TOPPAS)
Definition: ToolHandler.h:73
Definition: ToolDescription.h:138