| OpenMS 2.5.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-2020.
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
37 #include <OpenMS/DATASTRUCTURES/ToolDescription.h>
38 #include <OpenMS/DATASTRUCTURES/Map.h>
39 #include <OpenMS/DATASTRUCTURES/String.h>
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
73 typedef Map<String, Internal::ToolDescription> ToolListType;
74
75 class OPENMS_DLLAPI ToolHandler
76 {
77 public:
78
80 static ToolListType getTOPPToolList(const bool includeGenericWrapper = false);
81
83 static ToolListType getUtilList();
84
86 static StringList getTypes(const String& toolname);
87
90 static String getCategory(const String& toolname);
91
93 static String getExternalToolsPath();
94
96 static String getInternalToolsPath();
97
98 private:
99
100 static Internal::ToolDescription getExternalTools_();
101 static QStringList getExternalToolConfigFiles_();
102 static void loadExternalToolConfig_();
103 static Internal::ToolDescription tools_external_;
104 static bool tools_external_loaded_;
105
106 static std::vector<Internal::ToolDescription> getInternalTools_();
107 static QStringList getInternalToolConfigFiles_();
108 static void loadInternalToolConfig_();
109 static std::vector<Internal::ToolDescription> tools_internal_;
110 static bool tools_internal_loaded_;
111 };
112
113 } // namespace OpenMS
114
OpenMS::String
A more convenient string class.
Definition: String.h:58
ToolDescription.h
OpenMS::ToolListType
Map< String, Internal::ToolDescription > ToolListType
Handles lists of TOPP and UTILS tools and their categories (for TOPPAS)
Definition: ToolHandler.h:73
String.h
OpenMS::Map
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:50
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::ToolHandler::tools_external_loaded_
static bool tools_external_loaded_
Definition: ToolHandler.h:104
Map.h
OpenMS::Internal::ToolDescription
Definition: ToolDescription.h:122
OpenMS::ToolHandler::tools_internal_loaded_
static bool tools_internal_loaded_
Definition: ToolHandler.h:110
OpenMS::ToolHandler::tools_external_
static Internal::ToolDescription tools_external_
Definition: ToolHandler.h:103
OpenMS::ToolHandler
Definition: ToolHandler.h:75
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
OpenMS::ToolHandler::tools_internal_
static std::vector< Internal::ToolDescription > tools_internal_
Definition: ToolHandler.h:109