TOPPASVertex.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-2022.
//
// 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: Johannes Veit $
// $Authors: Johannes Junker, Chris Bielow $
// --------------------------------------------------------------------------

#pragma once

// ------------- DEBUGGING ----------------

// ---- Uncomment to enable debug mode ----
//#define TOPPAS_DEBUG
// ----------------------------------------

#ifdef TOPPAS_DEBUG
#define __DEBUG_BEGIN_METHOD__ \
  {                                                                                                                                                                                   \
    for (int dbg_indnt_cntr = 0; dbg_indnt_cntr < global_debug_indent_; ++dbg_indnt_cntr)   \
    {                                                                                                                                                                           \
      std::cout << "  ";                                                                                                                                  \
    }                                                                                                                                                                           \
    std::cout << "BEGIN [" << topo_nr_ << "] " << OPENMS_PRETTY_FUNCTION << std::endl;             \
    ++global_debug_indent_;                                                                                                                             \
  }

#define __DEBUG_END_METHOD__ \
  {                                                                                                                                                                                       \
    --global_debug_indent_;                                                                                                                             \
    if (global_debug_indent_ < 0) global_debug_indent_ = 0;                                                             \
    for (int dbg_indnt_cntr = 0; dbg_indnt_cntr < global_debug_indent_; ++dbg_indnt_cntr)   \
    {                                                                                                                                                                           \
      std::cout << "  ";                                                                                                                                  \
    }                                                                                                                                                                           \
    std::cout << "END [" << topo_nr_ << "] " << OPENMS_PRETTY_FUNCTION << std::endl;                   \
  }
#else
#define __DEBUG_BEGIN_METHOD__ {}
#define __DEBUG_END_METHOD__ {}
#endif

// ----------------------------------------

// OpenMS_GUI config
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>

#include <OpenMS/DATASTRUCTURES/String.h>

#include <QPainter>
#include <QPainterPath>
#include <QtWidgets/QGraphicsSceneMouseEvent>
#include <QtWidgets/QGraphicsSceneContextMenuEvent>
#include <QtWidgets/QGraphicsItem>
#include <QtCore/QProcess>
#include <QtWidgets/QMenu>
#include <QStringList>

namespace OpenMS
{
  class TOPPASEdge;

  class OPENMS_GUI_DLLAPI TOPPASVertex :
    public QObject,
    public QGraphicsItem
  {
    Q_OBJECT
    Q_INTERFACES(QGraphicsItem)

public:
    typedef QList<TOPPASEdge *> EdgeContainer;
    typedef EdgeContainer::iterator EdgeIterator;
    typedef EdgeContainer::const_iterator ConstEdgeIterator;

    class TOPPASFilenames
    {
      public:
      TOPPASFilenames() = default;
      TOPPASFilenames(const QStringList& filenames);
      int size() const;
      const QStringList& get() const;
      const QString& operator[](int i) const;


      void set(const QStringList& filenames);
      void set(const QString& filename, int i);
      void push_back(const QString& filename);
      void append(const QStringList& filenames);

      QStringList getSuffixCounts() const;

      private:
      /*
      @brief Check length of filename and throw Exception::FileNotWritable() if too long
    
      @param filename Full path to file (using relative paths will circumvent the effectiveness)
      @throw Exception::FileNotWritable() if too long (>=255 chars)
      */
      void check_(const QString& filename);
      QStringList filenames_;   
    };

    struct VertexRoundPackage
    {
      TOPPASFilenames filenames; 
      TOPPASEdge* edge = nullptr; 
    };

    typedef std::map<Int, VertexRoundPackage> RoundPackage;
    typedef RoundPackage::const_iterator RoundPackageConstIt;
    typedef RoundPackage::iterator RoundPackageIt;

    typedef std::vector<RoundPackage> RoundPackages;

    enum DFS_COLOR
    {
      DFS_WHITE,
      DFS_GRAY,
      DFS_BLACK
    };

    enum SUBSTREESTATUS
    {
      TV_ALLFINISHED,  
      TV_UNFINISHED,   
      TV_UNFINISHED_INBRANCH 
    };

    TOPPASVertex();
    TOPPASVertex(const TOPPASVertex & rhs);
    ~TOPPASVertex() override = default;
    TOPPASVertex& operator=(const TOPPASVertex & rhs);
    void paint(QPainter* painter, const QStyleOptionGraphicsItem* /*option*/, QWidget* /*widget*/, bool round_shape = true);

    bool buildRoundPackages(RoundPackages & pkg, String & error_msg);

    bool isUpstreamFinished() const;

    QRectF boundingRect() const override = 0;
    QPainterPath shape() const final;
    ConstEdgeIterator outEdgesBegin() const;
    ConstEdgeIterator outEdgesEnd() const;
    ConstEdgeIterator inEdgesBegin() const;
    ConstEdgeIterator inEdgesEnd() const;
    Size incomingEdgesCount();
    Size outgoingEdgesCount();
    void addInEdge(TOPPASEdge * edge);
    void addOutEdge(TOPPASEdge * edge);
    void removeInEdge(TOPPASEdge * edge);
    void removeOutEdge(TOPPASEdge * edge);
    DFS_COLOR getDFSColor();
    void setDFSColor(DFS_COLOR color);
    TOPPASVertex::SUBSTREESTATUS getSubtreeStatus() const;
    bool isTopoSortMarked() const;
    void setTopoSortMarked(bool b);
    UInt getTopoNr() const;
    virtual void setTopoNr(UInt nr);
    virtual void reset(bool reset_all_files = false);
    virtual void markUnreachable();
    bool isReachable() const;
    bool isFinished() const;
    virtual void run();
    virtual bool invertRecylingMode();
    bool isRecyclingEnabled() const;
    void setRecycling(const bool is_enabled);

    // get the name of the vertex (to be overridden by derived classes)
    virtual String getName() const = 0;

    QStringList getFileNames(int param_index, int round) const;

    QStringList getFileNames() const;

    // get the output structure directly
    const RoundPackages & getOutputFiles() const;


    bool allInputsReady() const;


public slots:

    virtual void inEdgeHasChanged();
    virtual void outEdgeHasChanged();

signals:

    void clicked();
    void released();
    void hoveringEdgePosChanged(const QPointF & new_pos);
    void newHoveringEdge(const QPointF & pos);
    void finishHoveringEdge();
    void somethingHasChanged();
    void itemDragged(qreal dx, qreal dy);
    void parameterChanged(const bool invalidates_running_pipeline);

protected:

    EdgeContainer in_edges_;
    EdgeContainer out_edges_;
    bool edge_being_created_{false};
    QColor pen_color_{Qt::black};
    QColor brush_color_{ Qt::lightGray};
    DFS_COLOR dfs_color_{DFS_WHITE};
    bool topo_sort_marked_{false};
    UInt topo_nr_;
    RoundPackages output_files_;
    int round_total_{-1};
    int round_counter_{0};
    bool finished_{false};
    bool reachable_{true};
    bool allow_output_recycling_{false};


#ifdef TOPPAS_DEBUG
    // Indentation level for nicer debug output
    static int global_debug_indent_;
#endif


    void mouseReleaseEvent(QGraphicsSceneMouseEvent * e) override;
    void mousePressEvent(QGraphicsSceneMouseEvent * e) override;
    void mouseDoubleClickEvent(QGraphicsSceneMouseEvent * e) override;
    void mouseMoveEvent(QGraphicsSceneMouseEvent * e) override;
    void contextMenuEvent(QGraphicsSceneContextMenuEvent * event) override;

    virtual void moveNewEdgeTo_(const QPointF & pos);
    String get3CharsNumber_(UInt number) const;

    void debugOut_(const String &
#ifdef TOPPAS_DEBUG
                   message
#endif
                   ) const
    {
#ifdef TOPPAS_DEBUG
      for (int i = 0; i < global_debug_indent_; ++i)
      {
        std::cout << "  ";
      }
      std::cout << "[" << topo_nr_ << "] " << message << std::endl;
#endif
    }

  };
}