241 lines
6.7 KiB
C++
241 lines
6.7 KiB
C++
// This defines the interface to the QsciLexerRuby 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 QSCILEXERRUBY_H
|
|
#define QSCILEXERRUBY_H
|
|
|
|
#include <QObject>
|
|
|
|
#include <Qsci/qsciglobal.h>
|
|
#include <Qsci/qscilexer.h>
|
|
|
|
|
|
//! \brief The QsciLexerRuby class encapsulates the Scintilla Ruby lexer.
|
|
class QSCINTILLA_EXPORT QsciLexerRuby : public QsciLexer
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
//! This enum defines the meanings of the different styles used by the
|
|
//! Ruby lexer.
|
|
enum {
|
|
//! The default.
|
|
Default = 0,
|
|
|
|
//! An error.
|
|
Error = 1,
|
|
|
|
//! A comment.
|
|
Comment = 2,
|
|
|
|
//! A POD.
|
|
POD = 3,
|
|
|
|
//! A number.
|
|
Number = 4,
|
|
|
|
//! A keyword.
|
|
Keyword = 5,
|
|
|
|
//! A double-quoted string.
|
|
DoubleQuotedString = 6,
|
|
|
|
//! A single-quoted string.
|
|
SingleQuotedString = 7,
|
|
|
|
//! The name of a class.
|
|
ClassName = 8,
|
|
|
|
//! The name of a function or method.
|
|
FunctionMethodName = 9,
|
|
|
|
//! An operator.
|
|
Operator = 10,
|
|
|
|
//! An identifier
|
|
Identifier = 11,
|
|
|
|
//! A regular expression.
|
|
Regex = 12,
|
|
|
|
//! A global.
|
|
Global = 13,
|
|
|
|
//! A symbol.
|
|
Symbol = 14,
|
|
|
|
//! The name of a module.
|
|
ModuleName = 15,
|
|
|
|
//! An instance variable.
|
|
InstanceVariable = 16,
|
|
|
|
//! A class variable.
|
|
ClassVariable = 17,
|
|
|
|
//! Backticks.
|
|
Backticks = 18,
|
|
|
|
//! A data section.
|
|
DataSection = 19,
|
|
|
|
//! A here document delimiter.
|
|
HereDocumentDelimiter = 20,
|
|
|
|
//! A here document.
|
|
HereDocument = 21,
|
|
|
|
//! A %q string.
|
|
PercentStringq = 24,
|
|
|
|
//! A %Q string.
|
|
PercentStringQ = 25,
|
|
|
|
//! A %x string.
|
|
PercentStringx = 26,
|
|
|
|
//! A %r string.
|
|
PercentStringr = 27,
|
|
|
|
//! A %w string.
|
|
PercentStringw = 28,
|
|
|
|
//! A demoted keyword.
|
|
DemotedKeyword = 29,
|
|
|
|
//! stdin.
|
|
Stdin = 30,
|
|
|
|
//! stdout.
|
|
Stdout = 31,
|
|
|
|
//! stderr.
|
|
Stderr = 40
|
|
};
|
|
|
|
//! Construct a QsciLexerRuby with parent \a parent. \a parent is
|
|
//! typically the QsciScintilla instance.
|
|
QsciLexerRuby(QObject *parent = 0);
|
|
|
|
//! Destroys the QsciLexerRuby instance.
|
|
virtual ~QsciLexerRuby();
|
|
|
|
//! 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 a space separated list of words or characters in
|
|
//! a particular style that define the end of a block for
|
|
//! auto-indentation. The style 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 style 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 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();
|
|
|
|
//! If \a fold is true then multi-line comment blocks can be folded.
|
|
//! The default is false.
|
|
//!
|
|
//! \sa foldComments()
|
|
void setFoldComments(bool fold);
|
|
|
|
//! Returns true if multi-line comment blocks can be folded.
|
|
//!
|
|
//! \sa setFoldComments()
|
|
bool foldComments() const {return fold_comments;}
|
|
|
|
//! If \a fold is true then trailing blank lines are included in a fold
|
|
//! block. The default is true.
|
|
//!
|
|
//! \sa foldCompact()
|
|
void setFoldCompact(bool fold);
|
|
|
|
//! Returns true if trailing blank lines are included in a fold block.
|
|
//!
|
|
//! \sa setFoldCompact()
|
|
bool foldCompact() const {return fold_compact;}
|
|
|
|
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.
|
|
//!
|
|
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.
|
|
//!
|
|
bool writeProperties(QSettings &qs, const QString &prefix) const;
|
|
|
|
private:
|
|
void setCommentProp();
|
|
void setCompactProp();
|
|
|
|
bool fold_comments;
|
|
bool fold_compact;
|
|
|
|
QsciLexerRuby(const QsciLexerRuby &);
|
|
QsciLexerRuby &operator=(const QsciLexerRuby &);
|
|
};
|
|
|
|
#endif
|