WareSrcFileEditor.hpp

Go to the documentation of this file.

/*
 
  This file is part of OpenFLUID software
  Copyright(c) 2021-2026, INRAE
 
 
 == GNU General Public License Usage ==
 
  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  OpenFLUID is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
 
 
 == Other Usage ==
 
  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
 
 */
 
/**
 @file WareSrcFileEditor.hpp
 
 @author Aline LIBRES <aline.libres@gmail.com>
 @author Armel THÖNI <armel.thoni@inrae.fr>
 */
 
#ifndef __OPENFLUID_UIWARESDEV_WARESRCFILEEDITOR_HPP__
#define __OPENFLUID_UIWARESDEV_WARESRCFILEEDITOR_HPP__
 
 
#include <QPlainTextEdit>
#include <QTextBlock>
#include <QCompleter>
#include <QSignalMapper>
#include <QMenu>
#include <QStack>
 
#include <openfluid/dllexport.hpp>
#include <openfluid/ui/waresdev/CompletionProvider.hpp>
#include <openfluid/ui/waresdev/WareSrcFiletypeManager.hpp>
#include <openfluid/ui/waresdev/WareFileEditor.hpp>
#include <openfluid/ui/common/DefaultAction.hpp>
#include <openfluid/ui/config.hpp>
 
 
namespace openfluid { namespace ui { namespace waresdev {
 
 
class WareSrcSyntaxHighlighter;
 
 
class OPENFLUID_API WareSrcFileEditor: public QPlainTextEdit, public WareFileEditor
{
  Q_OBJECT
 
 
  private slots:
 
    void updateLineNumberAreaWidth();
 
    void highlightCurrentLine();
 
    void updateLineNumberArea(const QRect& Rect, int);
 
    void onChanged(bool Changed);
 
    void onInsertRequested(const QString& Str);
 
    void insertCompletion();
 
    void onCompletionPopupCurrentRowChanged(const QModelIndex &Current, const QModelIndex& Previous);
 
 
  private:
 
    class LineMarker
    {
      private:
 
        WareSrcMsgParser::WareSrcMsg::MessageType m_MajorMarkerType;
        QStringList m_ContentList;
 
        QColor Red = QColor(openfluid::ui::config::LINEMARKER_ERRCOLOR);
        QColor Orange = QColor(openfluid::ui::config::LINEMARKER_WARNCOLOR);
 
      public:
 
        QRect m_Rect;
 
        LineMarker(WareSrcMsgParser::WareSrcMsg::MessageType MsgType, const QString& Content) :
            m_MajorMarkerType(MsgType)
        {
          QString Cleared = Content.trimmed();
          if (!Cleared.isEmpty())
          {
            m_ContentList.append(Cleared);
          }
        }
 
 
        // =====================================================================
        // =====================================================================
 
 
        QColor getColor() const
        {
          if (m_MajorMarkerType == WareSrcMsgParser::WareSrcMsg::MessageType::MSG_ERROR)
          {
            return Red;
          }
          return Orange;
        }
 
 
        // =====================================================================
        // =====================================================================
 
 
        QString getContent() const
        {
          if (m_ContentList.isEmpty())
          {
            return "";
          }
 
          if (m_ContentList.size() == 1)
          {
            return QString("<html>%1</html>").arg(m_ContentList[0]);
          }
 
          return QString("&bull;&nbsp;%1").arg(m_ContentList.join("<br/>&bull;&nbsp;"));
        }
 
 
        // =====================================================================
        // =====================================================================
 
 
        void update(WareSrcMsgParser::WareSrcMsg::MessageType MsgType, const QString& Content)
        {
          if (MsgType == WareSrcMsgParser::WareSrcMsg::MessageType::MSG_ERROR)
          {
            m_MajorMarkerType = MsgType;
          }
 
          m_ContentList.append(Content.trimmed());
        }
    };
 
    WareSrcSyntaxHighlighter* mp_SyntaxHighlighter = nullptr;
 
#if (QT_VERSION_MAJOR < 6)
    QRegExp m_SelectionTagsRegExp;
    QRegExp m_AllTagsRegExp;
    QRegExp m_WordPartRegExp;
#else
    QRegularExpression m_SelectionTagsRegExp;
    QRegularExpression m_AllTagsRegExp;
    QRegularExpression m_WordPartRegExp;
#endif
 
    QWidget* mp_LineNumberArea;
 
    QColor m_LineColor;
    QColor m_LineNbAreaColor = QColor("#F8F8FF");
    QColor m_LineNbTextColor = QColor("#999999");
 
    QString m_IndentString;
 
    int m_SpaceCharWidth;
 
    openfluid::ui::waresdev::CompletionProvider::Rules m_CompletionRules;
 
    QSignalMapper* mp_SignalMapper;
 
    QMap<QString, QMenu*> m_InsertionMenus;
 
    QCompleter* mp_Completer;
 
    QMap<QTextBlock, LineMarker> m_LineMarkersByBlock;
 
    bool m_ShowLineMarkers = true;
 
    struct SelectionData 
    {
      QTextCursor TextCursor;
 
      QTextBlock FirstBlock;
 
      int CursorPos;
 
      int StartPos;
 
      int EndPos;
    };
 
    QString CommentExtraSpaceString = " ";
 
    void writeString(const QString& Str, int InitialIndentInSpaceNb);
 
    void insertNewLine();
 
    bool findString(const QString& StringToFind, QTextDocument::FindFlags Options);
 
    bool replaceString(const QString& StringToFind, const QString& StringForReplace, Qt::CaseSensitivity Cs);
 
    int getLeadingSpacesCount(const QString& QStr);
 
    bool hasCharInBlockBeforePos(int Pos);
 
    void selectText(int StartPos, int EndPos);
 
    SelectionData createSelectionData();
 
    void addLinePrefix(const QString& PrefixStr, const QTextBlock& Block);
 
    /**
      Remove a prefix string from a block text. (It also removes one extra space (if found) after prefix string)
      If the block text does not start with the prefix string (excluding spaces), it does nothing.
      @param[in] PrefixStr The prefix string to remove from block text
      @param[in] Block The block where to remove the prefix string
      @return the number of characters removed from the block text
    */
    int removeLinePrefix(const QString& PrefixStr, const QTextBlock& Block);
 
    void addMultilinePrefix(const QString& PrefixStr);
 
    void removeMultilinePrefix(const QString& PrefixStr);
 
    void handleSelectionCommenting();
 
 
  protected:
 
    void resizeEvent(QResizeEvent* Event);
 
    void contextMenuEvent(QContextMenuEvent* Event);
 
    void keyPressEvent(QKeyEvent* Event);
 
 
  signals :
 
    void editorTxtChanged(WareFileEditor* Editor, bool Changed);
 
    void editorSaved();
 
 
  public slots :
 
    void setShowLineMarkers(bool ShowMarkers);
 
 
  public:
 
    WareSrcFileEditor(const QString& FilePath, QWidget* Parent = nullptr);
 
    virtual ~WareSrcFileEditor();
 
    void lineNumberAreaPaintEvent(QPaintEvent* Event);
 
    int lineNumberAreaWidth();
 
    void saveContent();
 
    void saveContentToPath(const QString& Path);
 
    void updateContent();
 
    bool findReplace(FindReplaceDialog::FindReplaceAction Action, const QString& StringToFind,
                     const QString& StringForReplace, QTextDocument::FindFlags Options, QString& Message);
 
    QString getSelectedText();
 
    void clearLineMessages();
 
    void addLineMessage(WareSrcMsgParser::WareSrcMsg Message);
 
    void updateLineNumberArea();
 
    void tooltipEvent(const QPoint& Position);
 
    void selectLine(int LineNumber);
 
    bool getShowLineMarkers();
 
    void goToLine();
 
    void updateSettings();
 
    bool isModified();
 
    QWidget* getWidget();
 
    void copy();
 
    void cut();
 
    void paste();
 
    void setFocus();
 
};
 
 
// =====================================================================
// =====================================================================
 
 
class LineNumberArea: public QWidget
{
  Q_OBJECT
 
  private:
 
    WareSrcFileEditor* mp_Editor;
 
    QAction* mp_ShowMarkersAction = nullptr;
 
 
  protected:
 
    void paintEvent(QPaintEvent* Event)
    {
      mp_Editor->lineNumberAreaPaintEvent(Event);
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    bool event(QEvent* Event)
    {
      if (Event->type() == QEvent::ToolTip)
      {
        QHelpEvent* HelpEvent = static_cast<QHelpEvent*>(Event);
        mp_Editor->tooltipEvent(HelpEvent->pos());
      }
      return QWidget::event(Event);
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    void contextMenuEvent(QContextMenuEvent* Event)
    {
      mp_ShowMarkersAction->setChecked(mp_Editor->getShowLineMarkers());
 
      QMenu* Menu = new QMenu();
      Menu->addAction(mp_ShowMarkersAction);
      Menu->exec(Event->globalPos());
      delete Menu;
    }
 
 
  public:
 
    LineNumberArea(WareSrcFileEditor* Editor) :
        QWidget(Editor)
    {
      setStyleSheet("QToolTip {min-width:300px;}");
 
      mp_Editor = Editor;
 
      mp_ShowMarkersAction = new openfluid::ui::common::DefaultAction("Show markers", this);
      mp_ShowMarkersAction->setCheckable(true);
 
      connect(mp_ShowMarkersAction, SIGNAL(triggered(bool)), mp_Editor, SLOT(setShowLineMarkers(bool)));
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    QSize sizeHint() const
    {
      return QSize(mp_Editor->lineNumberAreaWidth(), 0);
    }
};
 
 
} } }  // namespaces
 
 
#endif /* __OPENFLUID_UIWARESDEV_WARESRCFILEEDITOR_HPP__ */