Files
qt-creator/src/plugins/texteditor/basetexteditor.h
hjk e90a8a051c TextEditor: Only use tooltipOverrideRequested in *Widget
One signal less, one connection less, less indirection in user code.

Change-Id: Ie49d4a76982f2ff9d2b307ed541c33c6a7ea6480
Reviewed-by: hjk <hjk121@nokiamail.com>
2014-09-19 16:51:36 +02:00

671 lines
21 KiB
C++

/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef BASETEXTEDITOR_H
#define BASETEXTEDITOR_H
#include "basetextdocument.h"
#include "codeassist/assistenums.h"
#include "texteditor_global.h"
#include <texteditor/texteditoractionhandler.h>
#include <coreplugin/textdocument.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
#include <coreplugin/editormanager/ieditorfactory.h>
#include <coreplugin/find/ifindsupport.h>
#include <utils/uncommentselection.h>
#include <QPlainTextEdit>
#include <functional>
QT_BEGIN_NAMESPACE
class QToolBar;
class QPrinter;
class QMenu;
class QPainter;
class QPoint;
class QRect;
class QTextBlock;
QT_END_NAMESPACE
namespace Core { class MimeType; }
namespace TextEditor {
class TabSettings;
class RefactorOverlay;
struct RefactorMarker;
class IAssistMonitorInterface;
class AssistInterface;
class IAssistProvider;
class ICodeStylePreferences;
class CompletionAssistProvider;
typedef QList<RefactorMarker> RefactorMarkers;
namespace Internal {
class BaseTextEditorPrivate;
class BaseTextEditorWidgetPrivate;
class TextEditorOverlay;
}
class AutoCompleter;
class BaseTextEditor;
class BaseTextEditorFactory;
class BaseTextEditorWidget;
class PlainTextEditorFactory;
class BehaviorSettings;
class CompletionSettings;
class DisplaySettings;
class ExtraEncodingSettings;
class FontSettings;
class Indenter;
class MarginSettings;
class StorageSettings;
class TypingSettings;
class TEXTEDITOR_EXPORT BlockRange
{
public:
BlockRange() : _first(0), _last(-1) {}
BlockRange(int firstPosition, int lastPosition)
: _first(firstPosition), _last(lastPosition)
{}
inline bool isNull() const { return _last < _first; }
int first() const { return _first; }
int last() const { return _last; }
private:
int _first;
int _last;
};
class TEXTEDITOR_EXPORT BaseTextEditor : public Core::IEditor
{
Q_OBJECT
public:
enum PositionOperation {
Current = 1,
EndOfLine = 2,
StartOfLine = 3,
Anchor = 4,
EndOfDoc = 5
};
BaseTextEditor();
~BaseTextEditor();
virtual void finalizeInitialization() {}
enum MarkRequestKind {
BreakpointRequest,
BookmarkRequest,
TaskMarkRequest
};
static BaseTextEditor *currentTextEditor();
BaseTextEditorWidget *editorWidget() const;
BaseTextDocument *textDocument() const;
// Some convenience text access
QTextDocument *qdocument() const;
void setTextCursor(const QTextCursor &cursor);
QTextCursor textCursor() const;
QChar characterAt(int pos) const;
QString textAt(int from, int to) const;
void addContext(Core::Id id);
// IEditor
Core::IDocument *document();
bool open(QString *errorString, const QString &fileName, const QString &realFileName);
IEditor *duplicate();
QByteArray saveState() const;
bool restoreState(const QByteArray &state);
QWidget *toolBar();
QString contextHelpId() const; // from IContext
int currentLine() const;
int currentColumn() const;
void gotoLine(int line, int column = 0, bool centerLine = true);
/*! Returns the amount of visible columns (in characters) in the editor */
int columnCount() const;
/*! Returns the amount of visible lines (in characters) in the editor */
int rowCount() const;
/*! Returns the position at \a posOp in characters from the beginning of the document */
virtual int position(PositionOperation posOp = Current, int at = -1) const;
/*! Converts the \a pos in characters from beginning of document to \a line and \a column */
virtual void convertPosition(int pos, int *line, int *column) const;
/*! Returns the cursor rectangle in pixels at \a pos, or current position if \a pos = -1 */
virtual QRect cursorRect(int pos = -1) const;
virtual QString selectedText() const;
/*! Removes \a length characters to the right of the cursor. */
virtual void remove(int length);
/*! Inserts the given string to the right of the cursor. */
virtual void insert(const QString &string);
/*! Replaces \a length characters to the right of the cursor with the given string. */
virtual void replace(int length, const QString &string);
/*! Sets current cursor position to \a pos. */
virtual void setCursorPosition(int pos);
/*! Selects text between current cursor position and \a toPos. */
virtual void select(int toPos);
signals:
void markRequested(TextEditor::BaseTextEditor *editor, int line, TextEditor::BaseTextEditor::MarkRequestKind kind);
void markContextMenuRequested(TextEditor::BaseTextEditor *editor, int line, QMenu *menu);
void tooltipRequested(TextEditor::BaseTextEditor *editor, const QPoint &globalPos, int position);
void markTooltipRequested(TextEditor::BaseTextEditor *editor, const QPoint &globalPos, int line);
void contextHelpIdRequested(TextEditor::BaseTextEditor *editor, int position);
private:
friend class BaseTextEditorFactory;
Internal::BaseTextEditorPrivate *d;
};
class TEXTEDITOR_EXPORT BaseTextEditorWidget : public QPlainTextEdit
{
Q_OBJECT
Q_PROPERTY(int verticalBlockSelectionFirstColumn READ verticalBlockSelectionFirstColumn)
Q_PROPERTY(int verticalBlockSelectionLastColumn READ verticalBlockSelectionLastColumn)
public:
BaseTextEditorWidget(QWidget *parent = 0);
~BaseTextEditorWidget();
void setTextDocument(const BaseTextDocumentPtr &doc);
BaseTextDocument *textDocument() const;
BaseTextDocumentPtr textDocumentPtr() const;
// IEditor
virtual bool open(QString *errorString, const QString &fileName, const QString &realFileName);
QByteArray saveState() const;
bool restoreState(const QByteArray &state);
void gotoLine(int line, int column = 0, bool centerLine = true);
int position(BaseTextEditor::PositionOperation posOp = BaseTextEditor::Current,
int at = -1) const;
void convertPosition(int pos, int *line, int *column) const;
using QPlainTextEdit::cursorRect;
QRect cursorRect(int pos) const;
void setCursorPosition(int pos);
void print(QPrinter *);
void appendStandardContextMenuActions(QMenu *menu);
void setAutoCompleter(AutoCompleter *autoCompleter);
AutoCompleter *autoCompleter() const;
// Works only in conjunction with a syntax highlighter that puts
// parentheses into text block user data
void setParenthesesMatchingEnabled(bool b);
bool isParenthesesMatchingEnabled() const;
void setHighlightCurrentLine(bool b);
bool highlightCurrentLine() const;
void setLineNumbersVisible(bool b);
bool lineNumbersVisible() const;
void setAlwaysOpenLinksInNextSplit(bool b);
bool alwaysOpenLinksInNextSplit() const;
void setMarksVisible(bool b);
bool marksVisible() const;
void setRequestMarkEnabled(bool b);
bool requestMarkEnabled() const;
void setLineSeparatorsAllowed(bool b);
bool lineSeparatorsAllowed() const;
bool codeFoldingVisible() const;
void setCodeFoldingSupported(bool b);
bool codeFoldingSupported() const;
void setMouseNavigationEnabled(bool b);
bool mouseNavigationEnabled() const;
void setMouseHidingEnabled(bool b);
bool mouseHidingEnabled() const;
void setScrollWheelZoomingEnabled(bool b);
bool scrollWheelZoomingEnabled() const;
void setConstrainTooltips(bool b);
bool constrainTooltips() const;
void setCamelCaseNavigationEnabled(bool b);
bool camelCaseNavigationEnabled() const;
void setRevisionsVisible(bool b);
bool revisionsVisible() const;
void setVisibleWrapColumn(int column);
int visibleWrapColumn() const;
int columnCount() const;
int rowCount() const;
void setReadOnly(bool b);
void setTextCursor(const QTextCursor &cursor, bool keepBlockSelection);
void setTextCursor(const QTextCursor &cursor);
void insertCodeSnippet(const QTextCursor &cursor, const QString &snippet);
void setBlockSelection(bool on);
void setBlockSelection(int positionBlock, int positionColumn, int anchhorBlock,
int anchorColumn);
void setBlockSelection(const QTextCursor &cursor);
QTextCursor blockSelection() const;
bool hasBlockSelection() const;
int verticalBlockSelectionFirstColumn() const;
int verticalBlockSelectionLastColumn() const;
QRegion translatedLineRegion(int lineStart, int lineEnd) const;
QPoint toolTipPosition(const QTextCursor &c) const;
void invokeAssist(AssistKind assistKind, IAssistProvider *provider = 0);
virtual TextEditor::AssistInterface *createAssistInterface(AssistKind assistKind,
AssistReason assistReason) const;
static QMimeData *duplicateMimeData(const QMimeData *source);
static QString msgTextTooLarge(quint64 size);
void insertPlainText(const QString &text);
QWidget *extraArea() const;
virtual int extraAreaWidth(int *markWidthPtr = 0) const;
virtual void extraAreaPaintEvent(QPaintEvent *);
virtual void extraAreaLeaveEvent(QEvent *);
virtual void extraAreaContextMenuEvent(QContextMenuEvent *);
virtual void extraAreaMouseEvent(QMouseEvent *);
void updateFoldingHighlight(const QPoint &pos);
void setLanguageSettingsId(Core::Id settingsId);
Core::Id languageSettingsId() const;
void setCodeStyle(ICodeStylePreferences *settings);
const DisplaySettings &displaySettings() const;
const MarginSettings &marginSettings() const;
void ensureCursorVisible();
enum ExtraSelectionKind {
CurrentLineSelection,
ParenthesesMatchingSelection,
CodeWarningsSelection,
CodeSemanticsSelection,
UndefinedSymbolSelection,
UnusedSymbolSelection,
FakeVimSelection,
OtherSelection,
SnippetPlaceholderSelection,
ObjCSelection,
DebuggerExceptionSelection,
NExtraSelectionKinds
};
void setExtraSelections(ExtraSelectionKind kind, const QList<QTextEdit::ExtraSelection> &selections);
QList<QTextEdit::ExtraSelection> extraSelections(ExtraSelectionKind kind) const;
QString extraSelectionTooltip(int pos) const;
RefactorMarkers refactorMarkers() const;
void setRefactorMarkers(const RefactorMarkers &markers);
// the blocks list must be sorted
void setIfdefedOutBlocks(const QList<BlockRange> &blocks);
bool isMissingSyntaxDefinition() const;
enum Side { Left, Right };
void insertExtraToolBarWidget(Side side, QWidget *widget);
virtual void copy();
virtual void paste();
virtual void cut();
virtual void selectAll();
virtual void format();
virtual void rewrapParagraph();
virtual void unCommentSelection();
virtual void setDisplaySettings(const TextEditor::DisplaySettings &);
void setMarginSettings(const TextEditor::MarginSettings &);
void setBehaviorSettings(const TextEditor::BehaviorSettings &);
void setTypingSettings(const TextEditor::TypingSettings &);
void setStorageSettings(const TextEditor::StorageSettings &);
void setCompletionSettings(const TextEditor::CompletionSettings &);
void setExtraEncodingSettings(const TextEditor::ExtraEncodingSettings &);
void circularPaste();
void switchUtf8bom();
void zoomIn();
void zoomOut();
void zoomReset();
void cutLine();
void copyLine();
void deleteLine();
void deleteEndOfWord();
void deleteEndOfWordCamelCase();
void deleteStartOfWord();
void deleteStartOfWordCamelCase();
void unfoldAll();
void fold();
void unfold();
void selectEncoding();
void updateTextCodecLabel();
void gotoBlockStart();
void gotoBlockEnd();
void gotoBlockStartWithSelection();
void gotoBlockEndWithSelection();
void gotoLineStart();
void gotoLineStartWithSelection();
void gotoLineEnd();
void gotoLineEndWithSelection();
void gotoNextLine();
void gotoNextLineWithSelection();
void gotoPreviousLine();
void gotoPreviousLineWithSelection();
void gotoPreviousCharacter();
void gotoPreviousCharacterWithSelection();
void gotoNextCharacter();
void gotoNextCharacterWithSelection();
void gotoPreviousWord();
void gotoPreviousWordWithSelection();
void gotoNextWord();
void gotoNextWordWithSelection();
void gotoPreviousWordCamelCase();
void gotoPreviousWordCamelCaseWithSelection();
void gotoNextWordCamelCase();
void gotoNextWordCamelCaseWithSelection();
bool selectBlockUp();
bool selectBlockDown();
void moveLineUp();
void moveLineDown();
void viewPageUp();
void viewPageDown();
void viewLineUp();
void viewLineDown();
void copyLineUp();
void copyLineDown();
void joinLines();
void insertLineAbove();
void insertLineBelow();
void uppercaseSelection();
void lowercaseSelection();
void cleanWhitespace();
void indent();
void unindent();
void undo();
void redo();
void openLinkUnderCursor();
void openLinkUnderCursorInNextSplit();
/// Abort code assistant if it is running.
void abortAssist();
void configureMimeType(const QString &mimeType);
void configureMimeType(const Core::MimeType &mimeType);
Q_INVOKABLE void inSnippetMode(bool *active); // Used by FakeVim.
void setCompletionAssistProvider(CompletionAssistProvider *provider);
virtual CompletionAssistProvider *completionAssistProvider() const;
signals:
void assistFinished();
void readOnlyChanged();
void requestFontZoom(int zoom);
void requestZoomReset();
void requestBlockUpdate(const QTextBlock &);
protected:
bool event(QEvent *e);
void inputMethodEvent(QInputMethodEvent *e);
void keyPressEvent(QKeyEvent *e);
void wheelEvent(QWheelEvent *e);
void changeEvent(QEvent *e);
void focusInEvent(QFocusEvent *e);
void focusOutEvent(QFocusEvent *e);
void showEvent(QShowEvent *);
bool viewportEvent(QEvent *event);
void resizeEvent(QResizeEvent *);
void paintEvent(QPaintEvent *);
void timerEvent(QTimerEvent *);
void mouseMoveEvent(QMouseEvent *);
void mousePressEvent(QMouseEvent *);
void mouseReleaseEvent(QMouseEvent *);
void mouseDoubleClickEvent(QMouseEvent *);
void leaveEvent(QEvent *);
void keyReleaseEvent(QKeyEvent *);
void dragEnterEvent(QDragEnterEvent *e);
QMimeData *createMimeDataFromSelection() const;
bool canInsertFromMimeData(const QMimeData *source) const;
void insertFromMimeData(const QMimeData *source);
virtual QString plainTextFromSelection(const QTextCursor &cursor) const;
static QString convertToPlainText(const QString &txt);
virtual QString lineNumber(int blockNumber) const;
virtual int lineNumberDigits() const;
virtual bool selectionVisible(int blockNumber) const;
virtual bool replacementVisible(int blockNumber) const;
virtual QColor replacementPenColor(int blockNumber) const;
virtual void triggerPendingUpdates();
virtual void applyFontSettings();
virtual void onRefactorMarkerClicked(const RefactorMarker &) {}
void showDefaultContextMenu(QContextMenuEvent *e, Core::Id menuContextId);
virtual void finalizeInitialization() {}
virtual void finalizeInitializationAfterDuplication(BaseTextEditorWidget *) {}
public:
struct Link
{
Link(const QString &fileName = QString(), int line = 0, int column = 0)
: linkTextStart(-1)
, linkTextEnd(-1)
, targetFileName(fileName)
, targetLine(line)
, targetColumn(column)
{}
bool hasValidTarget() const
{ return !targetFileName.isEmpty(); }
bool hasValidLinkText() const
{ return linkTextStart != linkTextEnd; }
bool operator==(const Link &other) const
{ return linkTextStart == other.linkTextStart && linkTextEnd == other.linkTextEnd; }
int linkTextStart;
int linkTextEnd;
QString targetFileName;
int targetLine;
int targetColumn;
};
QString selectedText() const;
void setupAsPlainEditor();
void setupFallBackEditor(Core::Id id);
void remove(int length);
void replace(int length, const QString &string);
QChar characterAt(int pos) const;
QString textAt(int from, int to) const;
protected:
/*!
Reimplement this function to enable code navigation.
\a resolveTarget is set to true when the target of the link is relevant
(it isn't until the link is used).
*/
virtual Link findLinkAt(const QTextCursor &, bool resolveTarget = true,
bool inNextSplit = false);
/*!
Reimplement this function if you want to customize the way a link is
opened. Returns whether the link was opened successfully.
*/
virtual bool openLink(const Link &link, bool inNextSplit = false);
/*!
Reimplement this function to change the default replacement text.
*/
virtual QString foldReplacementText(const QTextBlock &block) const;
virtual void drawCollapsedBlockPopup(QPainter &painter,
const QTextBlock &block,
QPointF offset,
const QRect &clip);
int visibleFoldedBlockNumber() const;
signals:
void markRequested(int line, TextEditor::BaseTextEditor::MarkRequestKind kind);
void markContextMenuRequested(int line, QMenu *menu);
void tooltipOverrideRequested(TextEditor::BaseTextEditorWidget *editorWidget,
const QPoint &globalPos, int position, bool *handled);
void tooltipRequested(const QPoint &globalPos, int position);
void markTooltipRequested(const QPoint &globalPos, int line);
void activateEditor();
void clearContentsHelpId();
protected slots:
virtual void slotCursorPositionChanged(); // Used in VcsBase
virtual void slotCodeStyleSettingsChanged(const QVariant &); // Used in CppEditor
void doFoo();
private:
Internal::BaseTextEditorWidgetPrivate *d;
friend class BaseTextEditor;
friend class BaseTextEditorFactory;
friend class Internal::BaseTextEditorWidgetPrivate;
friend class Internal::TextEditorOverlay;
friend class RefactorOverlay;
};
class TEXTEDITOR_EXPORT BaseTextEditorFactory : public Core::IEditorFactory
{
Q_OBJECT
public:
BaseTextEditorFactory(QObject *parent = 0);
typedef std::function<BaseTextEditor *()> EditorCreator;
typedef std::function<BaseTextDocument *()> DocumentCreator;
typedef std::function<BaseTextEditorWidget *()> EditorWidgetCreator;
typedef std::function<SyntaxHighlighter *()> SyntaxHighLighterCreator;
typedef std::function<Indenter *()> IndenterCreator;
typedef std::function<AutoCompleter *()> AutoCompleterCreator;
void setDocumentCreator(const DocumentCreator &creator);
void setEditorWidgetCreator(const EditorWidgetCreator &creator);
void setEditorCreator(const EditorCreator &creator);
void setIndenterCreator(const IndenterCreator &creator);
void setSyntaxHighlighterCreator(const SyntaxHighLighterCreator &creator);
void setGenericSyntaxHighlighter(const QString &mimeType);
void setAutoCompleterCreator(const AutoCompleterCreator &creator);
void setEditorActionHandlers(Core::Id contextId, uint optionalActions);
void setEditorActionHandlers(uint optionalActions);
void setCommentStyle(Utils::CommentDefinition::Style style);
void setDuplicatedSupported(bool on);
Core::IEditor *createEditor();
private:
friend class BaseTextEditor;
friend class PlainTextEditorFactory;
BaseTextEditor *createEditorHelper(const BaseTextDocumentPtr &doc);
BaseTextEditor *duplicateTextEditor(BaseTextEditor *);
DocumentCreator m_documentCreator;
EditorWidgetCreator m_widgetCreator;
EditorCreator m_editorCreator;
AutoCompleterCreator m_autoCompleterCreator;
IndenterCreator m_indenterCreator;
SyntaxHighLighterCreator m_syntaxHighlighterCreator;
Utils::CommentDefinition::Style m_commentStyle;
bool m_duplicatedSupported;
};
} // namespace TextEditor
Q_DECLARE_METATYPE(TextEditor::BaseTextEditorWidget::Link)
#endif // BASETEXTEDITOR_H