editors/sc-ide/widgets/code_editor/editor.hpp

   1 /*
   2     SuperCollider Qt IDE
   3     Copyright (c) 2012 Jakob Leben & Tim Blechmann
   4     http://www.audiosynth.com
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  19 */
  20
  21 #ifndef SCIDE_WIDGETS_CODE_EDITOR_EDITOR_HPP_INCLUDED
  22 #define SCIDE_WIDGETS_CODE_EDITOR_EDITOR_HPP_INCLUDED
  23
  24 #include "tokens.hpp"
  25
  26 #include <QGraphicsScene>
  27 #include <QPlainTextEdit>
  28 #include <QTextBlock>
  29 #include <QList>
  30
  31 namespace ScIDE {
  32
  33 namespace Settings { class Manager; }
  34
  35 class Document;
  36
  37 class GenericCodeEditor : public QPlainTextEdit
  38 {
  39     Q_OBJECT
  40
  41     friend class LineIndicator;
  42
  43 public:
  44     GenericCodeEditor (Document *, QWidget * parent = NULL);
  45
  46     Document *document() { return mDoc; }
  47     QTextDocument *textDocument() { return QPlainTextEdit::document(); }
  48     void setDocument( Document * );
  49     bool showWhitespace();
  50     bool find( const QRegExp &expr, QTextDocument::FindFlags options = 0);
  51     bool replace( const QRegExp &expr, const QString &replacement, QTextDocument::FindFlags options = 0);
  52     int findAll( const QRegExp &expr, QTextDocument::FindFlags options = 0 );
  53     int replaceAll( const QRegExp &expr, const QString &replacement,
  54                     QTextDocument::FindFlags options = 0 );
  55
  56     void showPosition( int charPosition, int selectionLength );
  57     QString symbolUnderCursor();
  58
  59 protected:
  60     virtual void keyPressEvent( QKeyEvent * );
  61     virtual void wheelEvent( QWheelEvent * );
  62     virtual void dragEnterEvent( QDragEnterEvent * );
  63
  64 public Q_SLOTS:
  65     void zoomIn(int steps = 1);
  66     void zoomOut(int steps = 1);
  67     void resetFontSize();
  68     void setShowWhitespace(bool);
  69     void clearSearchHighlighting();
  70     void toggleOverwriteMode();
  71     void copyLineUp();
  72     void copyLineDown();
  73     void moveLineUp();
  74     void moveLineDown();
  75     void gotoPreviousEmptyLine();
  76     void gotoNextEmptyLine();
  77
  78 protected Q_SLOTS:
  79     void updateLayout();
  80     void updateLineIndicator( QRect, int );
  81     void onDocumentFontChanged();
  82
  83 protected:
  84     void resizeEvent( QResizeEvent * );
  85     void paintLineIndicator( QPaintEvent * );
  86     virtual void updateExtraSelections();
  87     virtual void indentCurrentRegion() {}
  88
  89     void zoomFont(int steps);
  90
  91     void copyUpDown(bool up);
  92     void moveLineUpDown(bool up);
  93     void gotoEmptyLineUpDown(bool up);
  94
  95     void hideMouseCursor();
  96
  97     class LineIndicator *mLineIndicator;
  98
  99     Document *mDoc;
 100     QList<QTextEdit::ExtraSelection> mSearchSelections;
 101 };
 102
 103 class CodeEditor : public GenericCodeEditor
 104 {
 105     Q_OBJECT
 106
 107 public:
 108     CodeEditor( Document *, QWidget *parent = 0 );
 109     void setIndentWidth( int );
 110     QTextCursor currentRegion();
 111     QTextCursor regionAtCursor( const QTextCursor & );
 112     void blinkCode( const QTextCursor & c );
 113
 114
 115 public Q_SLOTS:
 116     void setSpaceIndent(bool on) { mSpaceIndent = on; }
 117     void applySettings( Settings::Manager * );
 118     void indent();
 119     void triggerAutoCompletion();
 120     void triggerMethodCallAid();
 121     void toggleComment();
 122     void gotoPreviousBlock();
 123     void gotoNextBlock();
 124     void selectCurrentRegion();
 125     void gotoNextRegion();
 126     void gotoPreviousRegion();
 127     bool openDocumentation();
 128     void openDefinition();
 129     void findReferences();
 130
 131 protected:
 132     virtual bool event( QEvent * );
 133     virtual void keyPressEvent( QKeyEvent * );
 134     virtual void mouseReleaseEvent ( QMouseEvent * );
 135     virtual void mouseDoubleClickEvent( QMouseEvent * );
 136     virtual void mouseMoveEvent( QMouseEvent * );
 137     virtual void paintEvent( QPaintEvent * );
 138
 139 private Q_SLOTS:
 140     void matchBrackets();
 141     void onOverlayChanged ( const QList<QRectF> & region );
 142
 143 private:
 144     struct BracketMatch {
 145         TokenIterator first;
 146         TokenIterator second;
 147     };
 148
 149     void matchBracket( const TokenIterator & bracket, BracketMatch & match );
 150     void updateExtraSelections();
 151     void indentCurrentRegion();
 152
 153     void toggleCommentSingleLine( QTextCursor );
 154     void toggleCommentSingleLine();
 155     void toggleCommentSelection();
 156     void addSingleLineComment( QTextCursor, int indentationLevel );
 157     void removeSingleLineComment( QTextCursor );
 158
 159     QTextCursor blockAtCursor(const QTextCursor &); // text cursor should point to bracket!
 160
 161     int indentedStartOfLine( const QTextBlock & );
 162     void indent( const QTextCursor & );
 163     QTextBlock indent( const QTextBlock & b, int level );
 164     QString makeIndentationString( int level );
 165     int indentationLevel( const QTextCursor & );
 166
 167     QTextCursor cursorAt( const TokenIterator, int offset = 0 );
 168
 169     int mIndentWidth;
 170     bool mSpaceIndent;
 171     int mBlinkDuration;
 172     QTextCharFormat mBracketHighlight;
 173
 174     QList<QTextEdit::ExtraSelection> mBracketSelections;
 175     bool mMouseBracketMatch;
 176
 177     QGraphicsScene *mOverlay;
 178
 179     class AutoCompleter *mAutoCompleter;
 180 };
 181
 182 } // namespace ScIDE
 183
 184 #endif // SCIDE_WIDGETS_CODE_EDITOR_EDITOR_HPP_INCLUDED