consoleWidget.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2024, Institut für Technische Optik (ITO),
    Universität Stuttgart, Germany
 
    This file is part of itom.
 
    itom is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public Licence as published by
    the Free Software Foundation; either version 2 of the Licence, or (at
    your option) any later version.
 
    itom 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 Library
    General Public Licence for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************** */
 
#ifndef CONSOLEWIDGET_H
#define CONSOLEWIDGET_H
 
#include <queue>
 
#include "common/sharedStructures.h"
#include "common/sharedStructuresQt.h"
#include "../python/qDebugStream.h"
#include "../global.h"
 
#include "abstractCodeEditorWidget.h"
#include "../codeEditor/modes/lineBackgroundMarker.h"
#include "../codeEditor/modes/pyGotoAssignment.h"
#include "../codeEditor/panels/lineNumber.h"
 
#include <QKeyEvent>
#include <QDropEvent>
#include <qevent.h>
#include <qstring.h>
#include <qstringlist.h>
#include <qdebug.h>
#include <qsettings.h>
#include <qtimer.h>
#include <qelapsedtimer.h>
#include <qregularexpression.h>
 
 
 
namespace ito
{
 
class DequeCommandList;
 
class ConsoleWidget : public AbstractCodeEditorWidget
{
    Q_OBJECT
 
public:
    ConsoleWidget(QWidget* parent = nullptr);
    ~ConsoleWidget();
 
    static const QString lineBreak;
    static const QString newCommandPrefix;
 
    virtual QString codeText(int &line, int &column) const;
 
protected:
    virtual void loadSettings();
    virtual void contextMenuAboutToShow(int contextMenuLine);
    virtual int startLineOffset(int lineIdx) const;
    void initMenus();
 
public slots:
    virtual void copy();
    virtual void paste();
    virtual void cut();
    void receiveStream(QString text, ito::tStreamMessageType msgType);
    void pythonRunSelection(QString selectionText);
    void pythonStateChanged(tPythonTransitions pyTransition);
    void clearCommandLine();
    void interruptCommandInput(); // interrupt a possibly running input command
    void startInputCommandLine(QSharedPointer<QByteArray> buffer, ItomSharedSemaphore *inputWaitCond);
 
signals:
    void wantToCopy();
    void sendToLastCommand(QString cmd);
 
protected:
    virtual bool keyPressInternalEvent(QKeyEvent *event);
    void dropEvent (QDropEvent *event);
    void dragEnterEvent (QDragEnterEvent *event);
    void dragMoveEvent (QDragMoveEvent *event);
    void wheelEvent(QWheelEvent *event);
    bool canInsertFromMimeData(const QMimeData *source) const;
    void mouseDoubleClickEvent(QMouseEvent *e);
 
private slots:
    void selChanged();
    void textDoubleClicked(int position, int line, int modifiers);
    void clearAndStartNewCommand();
    void toggleAutoWheel(bool enable);
    void processStreamBuffer();
 
private:
    struct CmdQueueItem
    {
        CmdQueueItem() :
            m_lineBegin(-1),
            m_nrOfLines(1)
        {}
 
        CmdQueueItem(const QString &text, int lineBegin, int nrOfLines)  :
            m_singleLine(text),
            m_lineBegin(lineBegin),
            m_nrOfLines(nrOfLines)
        {}
 
        QString m_singleLine;
        int m_lineBegin;
        int m_nrOfLines;
    };
 
    struct StreamBuffer
    {
        QString text;
        ito::tStreamMessageType msgType;
    };
 
    struct InputTextMode
    {
        bool inputModeEnabled;
        bool calltipsModeCurrentState; //current enable state of calltips mode before starting input text mode (only valid if inputModeEnabled = true)
        bool autoCompletionModeCurrentState; //current enable state of completion mode before starting input text mode (only valid if inputModeEnabled = true)
    };
 
    RetVal initEditor();
    RetVal clearEditor();
    RetVal startNewCommand(bool clearEditorFirst = false);
    RetVal execCommand(int lineBegin, int lineEnd);
    RetVal useCmdListCommand(int dir);
 
    RetVal executeCmdQueue();
 
    void autoLineDelete(); 
    void moveCursorToEnd();
    void moveCursorToValidRegion();
 
    int checkValidDropRegion(const QPoint &pos);
 
    void enableInputTextMode();
    void disableInputTextMode();
 
    QList<ito::TextBlockUserData::AnsiTextCharFormat> parseReceiveStreamBufferForAnsiCodes(const QString &inputText, QString &strippedText);
    QList<QSharedPointer<QList<ito::TextBlockUserData::AnsiTextCharFormat>>> handleTextLinesAndSplitLongLines(
        QString &text,
        const QList<ito::TextBlockUserData::AnsiTextCharFormat> &ansiTextCharFormat,
        bool smartSplitting);
    QList<QSharedPointer<QList<ito::TextBlockUserData::AnsiTextCharFormat>>> splitLongLinesText(
        QString &text,
        const QSharedPointer<QList<ito::TextBlockUserData::AnsiTextCharFormat>> &ansiTextCharFormat,
        bool smartSplitting);
    void updateAnsiTextCharFormat(ito::TextBlockUserData::AnsiTextCharFormat &format, const QString &mainChar, const QString &args);
 
    int m_startLineBeginCmd; 
 
    DequeCommandList *m_pCmdList;
 
    std::queue<CmdQueueItem> m_cmdQueue; 
 
    bool m_canCopy;
    bool m_canCut;
    StreamBuffer m_receiveStreamBuffer;
    QTimer m_receiveStreamBufferTimer;
    bool m_splitLongLines;
    int m_splitLongLinesMaxLength;
    CmdQueueItem m_currentlyExecutedCommand;
 
    QSharedPointer<LineBackgroundMarkerMode> m_markErrorLineMode;
    QSharedPointer<LineBackgroundMarkerMode> m_markCurrentLineMode;
    QSharedPointer<LineBackgroundMarkerMode> m_markInputLineMode;
    QSharedPointer<LineNumberPanel> m_lineNumberPanel;
 
    bool m_waitForCmdExecutionDone; 
    bool m_pythonBusy; 
 
    QString m_temporaryRemovedCommands; 
 
    ItomSharedSemaphore *m_inputStreamWaitCond; 
    QSharedPointer<QByteArray> m_inputStreamBuffer;
    int m_inputStartLine; 
    int m_inputStartCol; 
    bool m_autoWheel; 
 
    QMap<QString, QAction*> m_contextMenuActions;
 
    InputTextMode m_inputTextMode;
 
    ito::TextBlockUserData::AnsiTextCharFormat m_recentAnsiTextCharFormat;
    QRegularExpression m_ansiEscapeSeqRegExp;
    bool m_considerAnsiEscapeSequences;
 
    static const QString longLineWrapPrefix;
 
};
 
class DequeCommandList
{
public:
    DequeCommandList(int maxLength);
    ~DequeCommandList();
 
    RetVal add(const QString &cmd);
    RetVal moveLast();
    QString getPrevious();
    QString getNext();
 
private:
    int m_maxItems;
    std::deque<QString> m_cmdList;
    std::deque<QString>::reverse_iterator m_rit;
};
 
} //end namespace ito
 
#endif