243 lines
7.3 KiB
C++
243 lines
7.3 KiB
C++
// This defines the interface to the QsciLexerD class.
|
|
//
|
|
// Copyright (c) 2023 Riverbank Computing Limited <info@riverbankcomputing.com>
|
|
//
|
|
// This file is part of QScintilla.
|
|
//
|
|
// This file may be used under the terms of the GNU General Public License
|
|
// version 3.0 as published by the Free Software Foundation and appearing in
|
|
// the file LICENSE included in the packaging of this file. Please review the
|
|
// following information to ensure the GNU General Public License version 3.0
|
|
// requirements will be met: http://www.gnu.org/copyleft/gpl.html.
|
|
//
|
|
// If you do not wish to use this file under the terms of the GPL version 3.0
|
|
// then you may purchase a commercial license. For more information contact
|
|
// info@riverbankcomputing.com.
|
|
//
|
|
// 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 QSCILEXERD_H
|
|
#define QSCILEXERD_H
|
|
|
|
#include <QObject>
|
|
|
|
#include <Qsci/qsciglobal.h>
|
|
#include <Qsci/qscilexer.h>
|
|
|
|
|
|
//! \brief The QsciLexerD class encapsulates the Scintilla D lexer.
|
|
class QSCINTILLA_EXPORT QsciLexerD : public QsciLexer
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
//! This enum defines the meanings of the different styles used by the D
|
|
//! lexer.
|
|
enum {
|
|
//! The default.
|
|
Default = 0,
|
|
|
|
//! A comment.
|
|
Comment = 1,
|
|
|
|
//! A comment line.
|
|
CommentLine = 2,
|
|
|
|
//! A JavaDoc and Doxygen comment.
|
|
CommentDoc = 3,
|
|
|
|
//! A nested comment.
|
|
CommentNested = 4,
|
|
|
|
//! A number.
|
|
Number = 5,
|
|
|
|
//! A keyword.
|
|
Keyword = 6,
|
|
|
|
//! A secondary keyword.
|
|
KeywordSecondary = 7,
|
|
|
|
//! A doc keyword
|
|
KeywordDoc = 8,
|
|
|
|
//! Typedefs and aliases
|
|
Typedefs = 9,
|
|
|
|
//! A string.
|
|
String = 10,
|
|
|
|
//! The end of a line where a string is not closed.
|
|
UnclosedString = 11,
|
|
|
|
//! A character
|
|
Character = 12,
|
|
|
|
//! An operator.
|
|
Operator = 13,
|
|
|
|
//! An identifier
|
|
Identifier = 14,
|
|
|
|
//! A JavaDoc and Doxygen line.
|
|
CommentLineDoc = 15,
|
|
|
|
//! A JavaDoc and Doxygen keyword.
|
|
CommentDocKeyword = 16,
|
|
|
|
//! A JavaDoc and Doxygen keyword error.
|
|
CommentDocKeywordError = 17,
|
|
|
|
//! A backquoted string.
|
|
BackquoteString = 18,
|
|
|
|
//! A raw, hexadecimal or delimited string.
|
|
RawString = 19,
|
|
|
|
//! A keyword defined in keyword set number 5. The class must be
|
|
//! sub-classed and re-implement keywords() to make use of this style.
|
|
KeywordSet5 = 20,
|
|
|
|
//! A keyword defined in keyword set number 6. The class must be
|
|
//! sub-classed and re-implement keywords() to make use of this style.
|
|
KeywordSet6 = 21,
|
|
|
|
//! A keyword defined in keyword set number 7. The class must be
|
|
//! sub-classed and re-implement keywords() to make use of this style.
|
|
KeywordSet7 = 22,
|
|
};
|
|
|
|
//! Construct a QsciLexerD with parent \a parent. \a parent is typically
|
|
//! the QsciScintilla instance.
|
|
QsciLexerD(QObject *parent = 0);
|
|
|
|
//! Destroys the QsciLexerD instance.
|
|
virtual ~QsciLexerD();
|
|
|
|
//! Returns the name of the language.
|
|
const char *language() const;
|
|
|
|
//! Returns the name of the lexer. Some lexers support a number of
|
|
//! languages.
|
|
const char *lexer() const;
|
|
|
|
//! \internal Returns the character sequences that can separate
|
|
//! auto-completion words.
|
|
QStringList autoCompletionWordSeparators() const;
|
|
|
|
//! \internal Returns a space separated list of words or characters in a
|
|
//! particular style that define the end of a block for auto-indentation.
|
|
//! The styles is returned via \a style.
|
|
const char *blockEnd(int *style = 0) const;
|
|
|
|
//! \internal Returns a space separated list of words or characters in a
|
|
//! particular style that define the start of a block for auto-indentation.
|
|
//! The styles is returned via \a style.
|
|
const char *blockStart(int *style = 0) const;
|
|
|
|
//! \internal Returns a space separated list of keywords in a particular
|
|
//! style that define the start of a block for auto-indentation. The
|
|
//! styles is returned via \a style.
|
|
const char *blockStartKeyword(int *style = 0) const;
|
|
|
|
//! \internal Returns the style used for braces for brace matching.
|
|
int braceStyle() const;
|
|
|
|
//! Returns the string of characters that comprise a word.
|
|
const char *wordCharacters() const;
|
|
|
|
//! Returns the foreground colour of the text for style number \a style.
|
|
//!
|
|
//! \sa defaultPaper()
|
|
QColor defaultColor(int style) const;
|
|
|
|
//! Returns the end-of-line fill for style number \a style.
|
|
bool defaultEolFill(int style) const;
|
|
|
|
//! Returns the font for style number \a style.
|
|
QFont defaultFont(int style) const;
|
|
|
|
//! Returns the background colour of the text for style number \a style.
|
|
//!
|
|
//! \sa defaultColor()
|
|
QColor defaultPaper(int style) const;
|
|
|
|
//! Returns the set of keywords for the keyword set \a set recognised by
|
|
//! the lexer as a space separated string.
|
|
const char *keywords(int set) const;
|
|
|
|
//! Returns the descriptive name for style number \a style. If the style
|
|
//! is invalid for this language then an empty QString is returned. This
|
|
//! is intended to be used in user preference dialogs.
|
|
QString description(int style) const;
|
|
|
|
//! Causes all properties to be refreshed by emitting the propertyChanged()
|
|
//! signal as required.
|
|
void refreshProperties();
|
|
|
|
//! Returns true if "} else {" lines can be folded.
|
|
//!
|
|
//! \sa setFoldAtElse()
|
|
bool foldAtElse() const;
|
|
|
|
//! Returns true if multi-line comment blocks can be folded.
|
|
//!
|
|
//! \sa setFoldComments()
|
|
bool foldComments() const;
|
|
|
|
//! Returns true if trailing blank lines are included in a fold block.
|
|
//!
|
|
//! \sa setFoldCompact()
|
|
bool foldCompact() const;
|
|
|
|
public slots:
|
|
//! If \a fold is true then "} else {" lines can be folded. The default is
|
|
//! false.
|
|
//!
|
|
//! \sa foldAtElse()
|
|
virtual void setFoldAtElse(bool fold);
|
|
|
|
//! If \a fold is true then multi-line comment blocks can be folded. The
|
|
//! default is false.
|
|
//!
|
|
//! \sa foldComments()
|
|
virtual void setFoldComments(bool fold);
|
|
|
|
//! If \a fold is true then trailing blank lines are included in a fold
|
|
//! block. The default is true.
|
|
//!
|
|
//! \sa foldCompact()
|
|
virtual void setFoldCompact(bool fold);
|
|
|
|
protected:
|
|
//! The lexer's properties are read from the settings \a qs. \a prefix
|
|
//! (which has a trailing '/') should be used as a prefix to the key of
|
|
//! each setting. true is returned if there is no error.
|
|
//!
|
|
//! \sa writeProperties()
|
|
bool readProperties(QSettings &qs,const QString &prefix);
|
|
|
|
//! The lexer's properties are written to the settings \a qs. \a prefix
|
|
//! (which has a trailing '/') should be used as a prefix to the key of
|
|
//! each setting. true is returned if there is no error.
|
|
//!
|
|
//! \sa readProperties()
|
|
bool writeProperties(QSettings &qs,const QString &prefix) const;
|
|
|
|
private:
|
|
void setAtElseProp();
|
|
void setCommentProp();
|
|
void setCompactProp();
|
|
|
|
bool fold_atelse;
|
|
bool fold_comments;
|
|
bool fold_compact;
|
|
|
|
QsciLexerD(const QsciLexerD &);
|
|
QsciLexerD &operator=(const QsciLexerD &);
|
|
};
|
|
|
|
#endif
|