TVToolDiscovery.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2023.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: David Voigt $
// $Authors: David Voigt $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
 
#include <future>
#include <map>
#include <OpenMS/DATASTRUCTURES/Param.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
namespace OpenMS
{
  class OPENMS_GUI_DLLAPI TVToolDiscovery
  {
  public:
    TVToolDiscovery() :
      plugin_path_() {};
 
    TVToolDiscovery(const TVToolDiscovery&) = delete;
 
    TVToolDiscovery& operator=(const TVToolDiscovery&) = delete;
 
    ~TVToolDiscovery() = default;
 
    void loadToolParams();
 
    void waitForToolParams();
    void waitForPluginParams();
 
    const Param& getToolParams();
 
    const Param& getPluginParams();
 
    const std::vector<std::string>& getPlugins();
 
    [[maybe_unused]] bool setPluginPath(const String& path, bool create=false);
 
    void setVerbose(int verbosity_level);
 
    const std::string getPluginPath();
 
    std::string findPluginExecutable(const std::string& name);
 
  private:
    static Param getParamFromIni_(const String& tool_path, bool plugins=false);
 
    void loadPluginParams();
 
    const StringList getPlugins_();
 
    std::string plugin_path_;
 
    std::vector<std::future<Param>> tool_param_futures_;
    std::vector<std::future<Param>> plugin_param_futures_;
 
    Param tool_params_;
 
    Param plugin_params_;
 
    std::vector<std::string> plugins_;
 
    int verbosity_level_ = 0;
  };
}