openmw/apps/opencs/view/world/scriptedit.hpp

#ifndef SCRIPTEDIT_H
#define SCRIPTEDIT_H

#include <QFont>
#include <QPlainTextEdit>
#include <QRegularExpression>
#include <QTimer>
#include <QVector>
#include <QWidget>

#include <string>

#include "../../model/world/universalid.hpp"

#include "scripthighlighter.hpp"

class QAction;
class QContextMenuEvent;
class QDragEnterEvent;
class QDragMoveEvent;
class QDropEvent;
class QEvent;
class QObject;
class QPaintEvent;
class QRect;
class QResizeEvent;

namespace CSMPrefs
{
    class Setting;
}

namespace CSMDoc
{
    class Document;
}

namespace CSVWorld
{
    class LineNumberArea;

    /// \brief Editor for scripts.
    class ScriptEdit : public QPlainTextEdit
    {
        Q_OBJECT

    public:
        class ChangeLock
        {
            ScriptEdit& mEdit;

            ChangeLock(const ChangeLock&);
            ChangeLock& operator=(const ChangeLock&);

        public:
            ChangeLock(ScriptEdit& edit);
            ~ChangeLock();
        };

        friend class ChangeLock;

    private:
        int mChangeLocked;
        ScriptHighlighter* mHighlighter;
        QTimer mUpdateTimer;
        bool mShowLineNum;
        LineNumberArea* mLineNumberArea;
        QFont mDefaultFont;
        QFont mMonoFont;
        int mTabCharCount;
        bool mMarkOccurrences;
        QAction* mCommentAction;
        QAction* mUncommentAction;

    protected:
        bool event(QEvent* event) override;

    public:
        ScriptEdit(const CSMDoc::Document& document, ScriptHighlighter::Mode mode, QWidget* parent);

        /// Should changes to the data be ignored (i.e. not cause updated)?
        ///
        /// \note This mechanism is used to avoid infinite update recursions
        bool isChangeLocked() const;

        void lineNumberAreaPaintEvent(QPaintEvent* event);
        int lineNumberAreaWidth();
        void showLineNum(bool show);

    protected:
        void resizeEvent(QResizeEvent* e) override;

        void contextMenuEvent(QContextMenuEvent* event) override;

    private:
        QVector<CSMWorld::UniversalId::Type> mAllowedTypes;
        const CSMDoc::Document& mDocument;
        const QRegularExpression mWhiteListQuotes;

        void dragEnterEvent(QDragEnterEvent* event) override;

        void dropEvent(QDropEvent* event) override;

        void dragMoveEvent(QDragMoveEvent* event) override;

        bool stringNeedsQuote(const std::string& id) const;

        /// \brief Set tab width for script editor.
        void setTabWidth();

        /// \brief Turn line wrapping in script editor on or off.
        /// \param wrap Whether or not to wrap lines.
        void wrapLines(bool wrap);

    private slots:

        /// \brief Update editor when related setting is changed.
        /// \param setting Setting that was changed.
        void settingChanged(const CSMPrefs::Setting* setting);

        void idListChanged();

        void updateHighlighting();

        void updateLineNumberAreaWidth(int newBlockCount);

        void updateLineNumberArea(const QRect&, int);

        void markOccurrences();

        void commentSelection();

        void uncommentSelection();
    };

    class LineNumberArea : public QWidget
    {
        ScriptEdit* mScriptEdit;

    public:
        LineNumberArea(ScriptEdit* editor);
        QSize sizeHint() const override;

    protected:
        void paintEvent(QPaintEvent* event) override;
    };
}
#endif // SCRIPTEDIT_H