TOPPBase.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors:  Marc Sturm, Clemens Groepl $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/APPLICATIONS/OpenMS_CLIConfig.h>
 
#include <OpenMS/APPLICATIONS/TOPPBase_defs.h>
 
#include <OpenMS/CONCEPT/ProgressLogger.h>
 
#include <OpenMS/DATASTRUCTURES/Param.h>
#include <OpenMS/DATASTRUCTURES/ParamTags.h>
 
#include <OpenMS/METADATA/DataProcessing.h>
 
#include <OpenMS/KERNEL/StandardTypes.h>
 
#include <iosfwd>
#include <map>
#include <memory>
#include <optional>
#include <vector>
 
namespace OpenMS
{
  class FeatureMap;
  class ConsensusMap;
  struct ParameterInformation;
 
  class OPENMS_CLI_DLLAPI TOPPBase
  {
public:
    inline static const char* TAG_OUTPUT_FILE = ParamTags::TAG_OUTPUT_FILE;
    inline static const char* TAG_INPUT_FILE = ParamTags::TAG_INPUT_FILE;
    inline static const char* TAG_OUTPUT_DIR = ParamTags::TAG_OUTPUT_DIR;
    inline static const char* TAG_OUTPUT_PREFIX = ParamTags::TAG_OUTPUT_PREFIX;
    inline static const char* TAG_ADVANCED = ParamTags::TAG_ADVANCED;
    inline static const char* TAG_REQUIRED = ParamTags::TAG_REQUIRED;
 
    enum ExitCodes
    {
      EXECUTION_OK,
      INPUT_FILE_NOT_FOUND,
      INPUT_FILE_NOT_READABLE,
      INPUT_FILE_CORRUPT,
      INPUT_FILE_EMPTY,
      CANNOT_WRITE_OUTPUT_FILE,
      ILLEGAL_PARAMETERS,
      MISSING_PARAMETERS,
      UNKNOWN_ERROR,
      EXTERNAL_PROGRAM_ERROR,
      PARSE_ERROR,
      INCOMPATIBLE_INPUT_DATA,
      INTERNAL_ERROR,
      UNEXPECTED_RESULT,
      EXTERNAL_PROGRAM_NOTFOUND 
    };
 
 
 
    TOPPBase() = delete;
 
    TOPPBase(const TOPPBase&) = delete;
 
    TOPPBase(const std::string& name, const std::string& description, const std::vector<Citation>& citations = {}, bool toolhandler_test = true);
 
    virtual ~TOPPBase();
 
    ExitCodes main(int argc, const char** argv);
 
    static void setMaxNumberOfThreads(int num_threads);
 
    std::string getToolPrefix() const;
 
    std::string getDocumentationURL() const;
 
    static const Citation cite_openms;
 
  private:
    std::string const tool_name_;
 
    std::string const tool_description_;
 
    std::string const ini_location_;
 
    Param param_;
 
    Param param_inifile_;
 
    Param param_cmdline_;
 
    Param param_instance_;
 
    Param param_common_tool_;
 
    Param param_common_;
 
    mutable std::unique_ptr<std::ofstream> log_;
 
    void enableLogging_() const;
 
    std::vector<ParameterInformation> parameters_;
 
    virtual Param getSubsectionDefaults_(const std::string& section) const;
 
    Param getSubsectionDefaults_() const;
 
    std::map<std::string, std::string> subsections_;
 
    std::map<std::string, std::string> subsections_TOPP_;
 
 
    Param parseCommandLine_(const int argc, const char** argv, const std::string& misc = "misc", const std::string& unknown = "unknown");
 
    std::string getParamAsString_(const std::string& key, const std::string& default_value = "") const;
 
    Int getParamAsInt_(const std::string& key, Int default_value = 0) const;
 
    double getParamAsDouble_(const std::string& key, double default_value = 0) const;
 
    StringList getParamAsStringList_(const std::string& key, const StringList& default_value) const;
 
    IntList getParamAsIntList_(const std::string& key, const IntList& default_value) const;
 
    DoubleList getParamAsDoubleList_(const std::string& key, const DoubleList& default_value) const;
 
    bool getParamAsBool_(const std::string& key) const;
 
    const ParamValue& getParam_(const std::string& key) const;
 
    std::string getSubsection_(const std::string& name) const;
 
    Param getDefaultParameters_() const;
 
    Param getToolUserDefaults_(const std::string& tool_name) const;
 
protected:
    std::string version_;
 
    std::string verboseVersion_;
 
    std::vector<Citation> citations_;
 
    bool toolhandler_test_;
 
    const std::string& getIniLocation_() const
    {
      return ini_location_;
    }
 
    const std::string& toolName_() const;
 
    virtual void registerOptionsAndFlags_() = 0;
 
    std::string getParamArgument_(const Param::ParamEntry& entry) const;
 
    std::vector<ParameterInformation> paramToParameterInformation_(const Param& param) const;
 
    ParameterInformation paramEntryToParameterInformation_(const Param::ParamEntry& entry, const std::string& argument = "", const std::string& full_name = "") const;
 
    void registerParamSubsectionsAsTOPPSubsections_(const Param& param);
 
    void registerFullParam_(const Param& param);
 
    void registerStringOption_(const std::string& name, const std::string& argument, const std::string& default_value, const std::string& description, bool required = true, bool advanced = false);
 
    void setValidStrings_(const std::string& name, const std::vector<std::string>& strings);
 
    void setValidStrings_(const std::string& name, const std::string vstrings[], int count);
 
    void registerInputFile_(const std::string& name, const std::string& argument, const std::string& default_value, const std::string& description, bool required = true, bool advanced = false, const StringList& tags = StringList());
 
    void registerOutputFile_(const std::string& name, const std::string& argument, const std::string& default_value, const std::string& description, bool required = true, bool advanced = false);
 
    void registerOutputPrefix_(const std::string& name, const std::string& argument, const std::string& default_value, const std::string& description, bool required = true, bool advanced = false);
 
    void registerOutputDir_(const std::string& name, const std::string& argument, const std::string& default_value, const std::string& description, bool required = true, bool advanced = false);
 
    
    void setValidFormats_(const std::string& name, const std::vector<std::string>& formats, const bool force_OpenMS_format = true);
 
 
    void registerDoubleOption_(const std::string& name, const std::string& argument, double default_value, const std::string& description, bool required = true, bool advanced = false);
 
    void setMinInt_(const std::string& name, Int min);
    void setMaxInt_(const std::string& name, Int max);
    void setMinFloat_(const std::string& name, double min);
    void setMaxFloat_(const std::string& name, double max);
 
    void registerIntOption_(const std::string& name, const std::string& argument,
                            Int default_value, const std::string& description,
                            bool required = true, bool advanced = false);
 
    void registerIntList_(const std::string& name, const std::string& argument, const IntList& default_value, const std::string& description, bool required = true, bool advanced = false);
 
    void registerDoubleList_(const std::string& name, const std::string& argument, const DoubleList& default_value, const std::string& description, bool required = true, bool advanced = false);
 
    void registerStringList_(const std::string& name, const std::string& argument, const StringList& default_value, const std::string& description, bool required = true, bool advanced = false);
 
    void registerInputFileList_(const std::string& name, const std::string& argument, const StringList& default_value, const std::string& description, bool required = true, bool advanced = false, const StringList& tags = StringList());
 
    void registerOutputFileList_(const std::string& name, const std::string& argument, const StringList& default_value, const std::string& description, bool required = true, bool advanced = false);
 
    void registerFlag_(const std::string& name, const std::string& description, bool advanced = false);
 
    void registerSubsection_(const std::string& name, const std::string& description);
 
    void registerTOPPSubsection_(const std::string& name, const std::string& description);
 
 
    void addEmptyLine_();
 
 
    std::string getStringOption_(const std::string& name) const;
    
    std::string getOutputDirOption(const std::string& name) const;
 
    double getDoubleOption_(const std::string& name) const;
 
    Int getIntOption_(const std::string& name) const;
 
    StringList getStringList_(const std::string& name) const;
 
    IntList getIntList_(const std::string& name) const;
 
    DoubleList getDoubleList_(const std::string& name) const;
 
    bool getFlag_(const std::string& name) const;
 
    const ParameterInformation& findEntry_(const std::string& name) const;
 
    Param const& getParam_() const;
 
    void checkParam_(const Param& param, const std::string& filename, const std::string& location) const;
 
    void fileParamValidityCheck_(const StringList& param_value, const std::string& param_name, const ParameterInformation& p) const;
 
    void fileParamValidityCheck_(std::string& param_value, const std::string& param_name, const ParameterInformation& p) const;
 
    virtual bool findExecutable_(std::string& executable) const;
 
    void checkIfIniParametersAreApplicable_(const Param& ini_params);
 
    void printUsage_();
 
    virtual ExitCodes main_(int argc, const char** argv) = 0;
 
 
 
    void writeLogInfo_(const std::string& text) const;
 
    void writeLogWarn_(const std::string& text) const;
 
    void writeLogError_(const std::string& text) const;
 
    void writeDebug_(const std::string& text, UInt min_level) const;
 
    void writeDebug_(const std::string& text, const Param& param, UInt min_level) const;
 
    // NOTE: runExternalProcess_() moved to the TOPPExternalToolBase subclass
    // (APPLICATIONS/TOPPExternalToolBase.h); tools that shell out should derive from it.
 
    void inputFileReadable_(const std::string& filename, const std::string& param_name) const;
 
    void outputFileWritable_(const std::string& filename, const std::string& param_name) const;
 
    bool parseRange_(const std::string& text, double& low, double& high) const;
 
    bool parseRange_(const std::string& text, Int& low, Int& high) const;
 
    ProgressLogger::LogType log_type_;
 
 
 
    void addDataProcessing_(ConsensusMap& map, const DataProcessing& dp) const;
 
    void addDataProcessing_(FeatureMap& map, const DataProcessing& dp) const;
 
    void addDataProcessing_(PeakMap& map, const DataProcessing& dp) const;
 
    DataProcessing getProcessingInfo_(DataProcessing::ProcessingAction action) const;
 
    DataProcessing getProcessingInfo_(const std::set<DataProcessing::ProcessingAction>& actions) const;
 
 
    bool test_mode_;
 
    static std::string topp_ini_file_;
 
    Int debug_level_;
private:
 
    void addText_(const std::string& text);
 
    ParameterInformation& getParameterByName_(const std::string& name);
 
    std::optional<ExitCodes> handleWriteCommands_();
 
  };
 
} // namespace OpenMS