486 lines
13 KiB
C++
486 lines
13 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2006-2009 fullmetalcoder <fullmetalcoder@hotmail.fr>
|
|
**
|
|
** This file is part of the Edyuk project <http://edyuk.org>
|
|
**
|
|
** This file may be used under the terms of the GNU General Public License
|
|
** version 3 as published by the Free Software Foundation and appearing in the
|
|
** file GPL.txt included in the packaging of this file.
|
|
**
|
|
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
|
|
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#ifndef _QEDITOR_H_
|
|
#define _QEDITOR_H_
|
|
|
|
#include "qce-config.h"
|
|
|
|
/*!
|
|
\file qeditor.h
|
|
\brief Definition of the QEditor class
|
|
*/
|
|
|
|
#include <QAbstractScrollArea>
|
|
#include <QBasicTimer>
|
|
#include <QFontMetrics>
|
|
#include <QHash>
|
|
#include <QPointer>
|
|
#include <QScrollBar>
|
|
|
|
#include "qdocument.h"
|
|
#include "qdocumentcursor.h"
|
|
|
|
class QMenu;
|
|
class QAction;
|
|
class QMimeData;
|
|
class QActionGroup;
|
|
|
|
class QReliableFileWatch;
|
|
|
|
class QDocumentLineHandle;
|
|
|
|
class QLanguageDefinition;
|
|
class QCodeCompletionEngine;
|
|
|
|
class QEditorInputBindingInterface;
|
|
|
|
class QCE_EXPORT QEditor : public QAbstractScrollArea {
|
|
friend class QEditConfig;
|
|
friend class QEditorFactory;
|
|
|
|
Q_OBJECT
|
|
|
|
public:
|
|
enum CodecUpdatePolicy {
|
|
NoUpdate = 0,
|
|
UpdateOld = 1,
|
|
UpdateDefault = 2,
|
|
UpdateCustom = 4,
|
|
|
|
UpdateAll = 7
|
|
};
|
|
|
|
enum EditFlag {
|
|
None = 0,
|
|
|
|
Overwrite = 0x001,
|
|
CursorOn = 0x002,
|
|
ReadOnly = 0x004,
|
|
MousePressed = 0x008,
|
|
MaybeDrag = 0x010,
|
|
Selection = 0x020,
|
|
EnsureVisible = 0x040,
|
|
|
|
FoldedCursor = 0x100,
|
|
|
|
Internal = 0x00000fff,
|
|
|
|
LineWrap = 0x00001000,
|
|
|
|
CtrlNavigation = 0x00010000,
|
|
CursorJumpPastWrap = 0x00020000,
|
|
|
|
ReplaceTabs = 0x00100000,
|
|
RemoveTrailing = 0x00200000,
|
|
PreserveTrailingIndent = 0x00400000,
|
|
AdjustIndent = 0x00800000,
|
|
|
|
AutoCloseChars = 0x01000000,
|
|
AutoIndent = 0x02000000,
|
|
|
|
Accessible = 0xfffff000
|
|
};
|
|
|
|
Q_DECLARE_FLAGS(State, EditFlag)
|
|
|
|
struct PlaceHolder {
|
|
class Affector {
|
|
public:
|
|
virtual ~Affector() {}
|
|
virtual void affect(const QStringList &base, int ph,
|
|
const QKeyEvent *e, int mirror,
|
|
QString &after) const = 0;
|
|
};
|
|
|
|
PlaceHolder() : length(0), autoRemove(false), affector(0) {}
|
|
PlaceHolder(const PlaceHolder &ph)
|
|
: length(ph.length), autoRemove(ph.autoRemove),
|
|
affector(ph.affector) {
|
|
cursor = ph.cursor;
|
|
mirrors << ph.mirrors;
|
|
}
|
|
|
|
int length;
|
|
bool autoRemove;
|
|
Affector *affector;
|
|
QDocumentCursor cursor;
|
|
QList<QDocumentCursor> mirrors;
|
|
};
|
|
|
|
explicit QEditor(QWidget *p = nullptr);
|
|
explicit QEditor(bool actions, QWidget *p = nullptr);
|
|
virtual ~QEditor();
|
|
|
|
bool flag(EditFlag) const;
|
|
|
|
bool canUndo() const;
|
|
bool canRedo() const;
|
|
|
|
QString text() const;
|
|
QString text(int line) const;
|
|
|
|
QString codecName() const;
|
|
QDocument *document() const;
|
|
|
|
QList<QEditorInputBindingInterface *> inputBindings() const;
|
|
|
|
bool isCursorVisible() const;
|
|
QDocumentCursor cursor() const;
|
|
|
|
int cursorMirrorCount() const;
|
|
QDocumentCursor cursorMirror(int i) const;
|
|
|
|
QLanguageDefinition *languageDefinition() const;
|
|
QCodeCompletionEngine *completionEngine() const;
|
|
|
|
QAction *action(const QString &s);
|
|
|
|
virtual QRect cursorRect() const;
|
|
virtual QRect selectionRect() const;
|
|
virtual QRect lineRect(int line) const;
|
|
virtual QRect lineRect(const QDocumentLine &l) const;
|
|
virtual QRect cursorRect(const QDocumentCursor &c) const;
|
|
|
|
QString name() const;
|
|
QString fileName() const;
|
|
|
|
bool isContentModified() const;
|
|
|
|
bool isInConflict() const;
|
|
|
|
int wrapWidth() const;
|
|
|
|
inline int horizontalOffset() const {
|
|
return horizontalScrollBar()->isVisible()
|
|
? horizontalScrollBar()->value()
|
|
: 0;
|
|
}
|
|
inline int verticalOffset() const {
|
|
return verticalScrollBar()->isVisible()
|
|
? verticalScrollBar()->value() *
|
|
m_doc->fontMetrics().lineSpacing()
|
|
: 0;
|
|
}
|
|
|
|
inline QPoint mapToContents(const QPoint &point) const {
|
|
return QPoint(point.x() + horizontalOffset(),
|
|
point.y() + verticalOffset());
|
|
}
|
|
|
|
inline QPoint mapFromContents(const QPoint &point) const {
|
|
return QPoint(point.x() - horizontalOffset(),
|
|
point.y() - verticalOffset());
|
|
}
|
|
|
|
void createSimpleBasicContextMenu(bool shortcut, bool extTool);
|
|
|
|
virtual bool protectedCursor(const QDocumentCursor &c) const;
|
|
|
|
static int defaultFlags();
|
|
static void setDefaultFlags(int f);
|
|
|
|
static QFont defaultFont();
|
|
static void setDefaultFont(const QFont &font);
|
|
|
|
static int defaultTabStop();
|
|
static void setDefaultTabStop(int tabstop);
|
|
|
|
static QDocument::LineEnding defaultLineEnding();
|
|
static void setDefaultLineEnding(QDocument::LineEnding le);
|
|
|
|
static QDocument::WhiteSpaceMode defaultShowSpaces();
|
|
static void setDefaultShowSpaces(QDocument::WhiteSpaceMode y);
|
|
|
|
static QString defaultCodecName();
|
|
static void setDefaultCodec(const QString &name, int update);
|
|
|
|
static QEditorInputBindingInterface *
|
|
registeredInputBinding(const QString &n);
|
|
static QString defaultInputBindingId();
|
|
static QStringList registeredInputBindingIds();
|
|
static void registerInputBinding(QEditorInputBindingInterface *b);
|
|
static void unregisterInputBinding(QEditorInputBindingInterface *b);
|
|
static void setDefaultInputBinding(QEditorInputBindingInterface *b);
|
|
static void setDefaultInputBinding(const QString &b);
|
|
|
|
static inline const QList<QEditor *> &editors() { return m_editors; }
|
|
|
|
public slots:
|
|
void undo();
|
|
void redo();
|
|
|
|
virtual void cut();
|
|
virtual void copy();
|
|
virtual void paste();
|
|
|
|
void clear();
|
|
|
|
void selectAll();
|
|
|
|
void find();
|
|
void findNext();
|
|
void replace();
|
|
|
|
void gotoLine();
|
|
|
|
void indentSelection();
|
|
void unindentSelection();
|
|
|
|
void commentSelection();
|
|
void uncommentSelection();
|
|
|
|
void setLineWrapping(bool on);
|
|
|
|
virtual bool save();
|
|
bool save(const QString &filename);
|
|
|
|
virtual void print();
|
|
|
|
virtual void retranslate();
|
|
|
|
virtual void write(const QString &s, const QString &sfmtID = {});
|
|
|
|
void addAction(QAction *a, const QString &menu,
|
|
const QString &toolbar = QString());
|
|
void removeAction(QAction *a, const QString &menu,
|
|
const QString &toolbar = QString());
|
|
|
|
bool load(const QString &file);
|
|
void setText(const QString &s);
|
|
|
|
void setCodec(const QString &name);
|
|
|
|
void setDocument(QDocument *d);
|
|
|
|
void addInputBinding(QEditorInputBindingInterface *b);
|
|
void removeInputBinding(QEditorInputBindingInterface *b);
|
|
void setInputBinding(QEditorInputBindingInterface *b);
|
|
|
|
void setCursor(const QDocumentCursor &c);
|
|
|
|
void setLanguageDefinition(QLanguageDefinition *d);
|
|
|
|
void setCompletionEngine(QCodeCompletionEngine *e);
|
|
|
|
void setScaleRate(qreal rate);
|
|
|
|
void setPanelMargins(int l, int t, int r, int b);
|
|
void getPanelMargins(int *l, int *t, int *r, int *b) const;
|
|
|
|
void setTitle(const QString &title);
|
|
|
|
void highlight();
|
|
|
|
void clearPlaceHolders();
|
|
void removePlaceHolder(int i);
|
|
void addPlaceHolder(const QEditor::PlaceHolder &p, bool autoUpdate = true);
|
|
|
|
void nextPlaceHolder();
|
|
void previousPlaceHolder();
|
|
void setPlaceHolder(int i);
|
|
|
|
void setUndoRedoEnabled(bool b);
|
|
|
|
void setCursorMirrorEnabled(bool b);
|
|
|
|
virtual void setFileName(const QString &f);
|
|
|
|
public:
|
|
int placeHolderCount() const;
|
|
int currentPlaceHolder() const;
|
|
qreal scaleRate() const;
|
|
|
|
signals:
|
|
void loaded(QEditor *e, const QString &s);
|
|
void needLoading();
|
|
void saved(QEditor *e, const QString &s);
|
|
|
|
void contentModified(bool y);
|
|
void titleChanged(const QString &title);
|
|
|
|
void textEdited(QKeyEvent *e);
|
|
void cursorPositionChanged();
|
|
|
|
void copyAvailable(bool y);
|
|
|
|
void undoAvailable(bool y);
|
|
void redoAvailable(bool y);
|
|
|
|
void markChanged(const QString &f, QDocumentLineHandle *l, int mark,
|
|
bool on);
|
|
|
|
void zoomed();
|
|
|
|
public slots:
|
|
void checkClipboard();
|
|
void reconnectWatcher();
|
|
void fileChanged(const QString &f);
|
|
|
|
void setContentClean(bool y);
|
|
|
|
void emitCursorPositionChanged();
|
|
|
|
virtual void setContentModified(bool y);
|
|
|
|
protected:
|
|
virtual bool event(QEvent *e);
|
|
|
|
virtual void paintEvent(QPaintEvent *e);
|
|
virtual void timerEvent(QTimerEvent *e);
|
|
|
|
virtual void keyPressEvent(QKeyEvent *e);
|
|
|
|
virtual void inputMethodEvent(QInputMethodEvent *e);
|
|
|
|
virtual void mouseMoveEvent(QMouseEvent *e);
|
|
virtual void mousePressEvent(QMouseEvent *e);
|
|
virtual void mouseReleaseEvent(QMouseEvent *e);
|
|
virtual void mouseDoubleClickEvent(QMouseEvent *e);
|
|
|
|
virtual void dragEnterEvent(QDragEnterEvent *e);
|
|
virtual void dragLeaveEvent(QDragLeaveEvent *e);
|
|
virtual void dragMoveEvent(QDragMoveEvent *e);
|
|
virtual void dropEvent(QDropEvent *e);
|
|
|
|
virtual void changeEvent(QEvent *e);
|
|
virtual void showEvent(QShowEvent *);
|
|
virtual void wheelEvent(QWheelEvent *e);
|
|
virtual void resizeEvent(QResizeEvent *e);
|
|
virtual void focusInEvent(QFocusEvent *e);
|
|
virtual void focusOutEvent(QFocusEvent *e);
|
|
|
|
virtual void contextMenuEvent(QContextMenuEvent *e);
|
|
|
|
virtual bool focusNextPrevChild(bool next);
|
|
|
|
virtual bool moveKeyEvent(QDocumentCursor &c, QKeyEvent *e, bool *leave);
|
|
virtual bool isProcessingKeyEvent(QKeyEvent *e, int *offset = 0);
|
|
virtual bool processCursor(QDocumentCursor &c, QKeyEvent *e, bool &b);
|
|
|
|
virtual void startDrag();
|
|
virtual QMimeData *createMimeDataFromSelection() const;
|
|
virtual void insertFromMimeData(const QMimeData *d);
|
|
|
|
virtual void scrollContentsBy(int dx, int dy);
|
|
|
|
// got to make it public for bindings
|
|
public:
|
|
void setFlag(EditFlag f, bool b);
|
|
|
|
void pageUp(QDocumentCursor::MoveMode moveMode);
|
|
void pageDown(QDocumentCursor::MoveMode moveMode);
|
|
|
|
void repaintCursor();
|
|
void ensureCursorVisible();
|
|
void ensureVisible(int line);
|
|
void ensureVisible(const QRect &rect);
|
|
|
|
void preInsert(QDocumentCursor &c, const QString &text);
|
|
void insertText(QDocumentCursor &c, const QString &text,
|
|
const QString &sfmtID = {});
|
|
|
|
QDocumentLine lineAtPosition(const QPoint &p) const;
|
|
QDocumentCursor cursorForPosition(const QPoint &p) const;
|
|
|
|
void setClipboardSelection();
|
|
void setCursorPosition(const QPoint &p);
|
|
|
|
void setCursorPosition(int line, int index);
|
|
void getCursorPosition(int &line, int &index);
|
|
|
|
void clearCursorMirrors();
|
|
void addCursorMirror(const QDocumentCursor &c);
|
|
|
|
bool undoRedoEnabled() const;
|
|
|
|
bool cursorMirrorEnabled() const;
|
|
|
|
private:
|
|
bool unindent(const QDocumentCursor &cur);
|
|
|
|
bool isAutoCloseChar(const QString &ch);
|
|
|
|
QString getPairedCloseChar(const QString &ch);
|
|
|
|
protected slots:
|
|
void documentWidthChanged(int newWidth);
|
|
void documentHeightChanged(int newWidth);
|
|
|
|
void repaintContent(int i, int n);
|
|
void updateContent(int i, int n);
|
|
|
|
void emitMarkChanged(QDocumentLineHandle *l, int mark, bool on);
|
|
|
|
void bindingSelected(QAction *a);
|
|
|
|
protected:
|
|
enum SaveState { Undefined, Saving, Saved, Conflict };
|
|
|
|
void init(bool actions = true);
|
|
void updateBindingsMenu();
|
|
|
|
QString m_name, m_fileName;
|
|
|
|
QMenu *pMenu;
|
|
QHash<QString, QAction *> m_actions;
|
|
|
|
QMenu *m_bindingsMenu;
|
|
QAction *aDefaultBinding;
|
|
QActionGroup *m_bindingsActions;
|
|
|
|
char m_saveState;
|
|
quint16 m_checksum;
|
|
|
|
QDocument *m_doc;
|
|
QString m_codec;
|
|
QList<QEditorInputBindingInterface *> m_bindings;
|
|
|
|
QLanguageDefinition *m_definition;
|
|
QPointer<QCodeCompletionEngine> m_completionEngine;
|
|
|
|
QDocumentCursor m_cursor, m_doubleClick, m_dragAndDrop;
|
|
|
|
QList<QDocumentCursor> m_mirrors;
|
|
|
|
int m_curPlaceHolder, m_cphOffset;
|
|
QList<PlaceHolder> m_placeHolders;
|
|
|
|
bool m_undoRedoEnabled = true;
|
|
bool m_cursorMirrorEnabled = true;
|
|
|
|
int m_state;
|
|
bool m_selection;
|
|
QRect m_crect, m_margins;
|
|
QPoint m_clickPoint, m_dragPoint;
|
|
QBasicTimer m_blink, m_scroll, m_click, m_drag;
|
|
|
|
QFont _docfont;
|
|
qreal _scaleRate = 1.0;
|
|
|
|
static QReliableFileWatch *watcher();
|
|
|
|
static int m_defaultFlags;
|
|
static QString m_defaultCodecName;
|
|
|
|
static QList<QEditor *> m_editors;
|
|
static QEditorInputBindingInterface *m_defaultBinding;
|
|
static QHash<QString, QEditorInputBindingInterface *> m_registeredBindings;
|
|
};
|
|
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(QEditor::State);
|
|
|
|
#endif
|