OpenMS  3.0.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-2022.
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 
39 
40 #include <map>
41 
42 class QStringList;
43 
44 namespace OpenMS
45 {
60  /*
61  internal details & discussion:
62 
63  We could create the list of TOPP tools and UTILS from a set of files in /share
64  instead of hard coding them here.
65  Advantage: - no recompile if new tool is added (but the new tool will necessitate that anyway)
66  - quickly changing a tool's category (e.g. from PreProcessing to Quantitation) and thus its place in TOPPAS
67  even users could rearrange tools themselves...
68  Disadvantage:
69  - when to library loads, we'd need to parse all the files. Making our start-up time even longer...
70  - when files are broken/missing, we will have a hard time initializing the lib
71  */
72 
74  typedef std::map<String, Internal::ToolDescription> ToolListType;
75 
76  class OPENMS_DLLAPI ToolHandler
77  {
78 public:
79 
81  static ToolListType getTOPPToolList(const bool includeGenericWrapper = false);
82 
84  static ToolListType getUtilList();
85 
87  static StringList getTypes(const String& toolname);
88 
91  static bool checkDuplicated(const String& toolname);
92 
95  static String getCategory(const String& toolname);
96 
98  static String getExternalToolsPath();
99 
101  static String getInternalToolsPath();
102 
103 private:
104 
105  static Internal::ToolDescription getExternalTools_();
106  static QStringList getExternalToolConfigFiles_();
107  static void loadExternalToolConfig_();
110 
111  static std::vector<Internal::ToolDescription> getInternalTools_();
112  static QStringList getInternalToolConfigFiles_();
113  static void loadInternalToolConfig_();
114  static std::vector<Internal::ToolDescription> tools_internal_;
116  };
117 
118 } // namespace OpenMS
119 
ToolDescription.h
OpenMS::ToolHandler::tools_internal_
static std::vector< Internal::ToolDescription > tools_internal_
Definition: ToolHandler.h:114
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::ToolHandler::tools_external_
static Internal::ToolDescription tools_external_
Definition: ToolHandler.h:108
OpenMS::ToolHandler::tools_internal_loaded_
static bool tools_internal_loaded_
Definition: ToolHandler.h:115
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
OpenMS::ToolListType
std::map< String, Internal::ToolDescription > ToolListType
Handles lists of TOPP and UTILS tools and their categories (for TOPPAS)
Definition: ToolHandler.h:74
OpenMS::ToolHandler
Definition: ToolHandler.h:76
OpenMS::ToolHandler::tools_external_loaded_
static bool tools_external_loaded_
Definition: ToolHandler.h:109
OpenMS::Internal::ToolDescription
Definition: ToolDescription.h:136
String.h