148 lines
4.3 KiB
C++
148 lines
4.3 KiB
C++
// This defines the interface to the QsciLexerYAML 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 QSCILEXERYAML_H
|
|
#define QSCILEXERYAML_H
|
|
|
|
#include <QObject>
|
|
|
|
#include <Qsci/qsciglobal.h>
|
|
#include <Qsci/qscilexer.h>
|
|
|
|
|
|
//! \brief The QsciLexerYAML class encapsulates the Scintilla YAML lexer.
|
|
class QSCINTILLA_EXPORT QsciLexerYAML : public QsciLexer
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
//! This enum defines the meanings of the different styles used by the
|
|
//! YAML lexer.
|
|
enum {
|
|
//! The default.
|
|
Default = 0,
|
|
|
|
//! A comment.
|
|
Comment = 1,
|
|
|
|
//! An identifier.
|
|
Identifier = 2,
|
|
|
|
//! A keyword
|
|
Keyword = 3,
|
|
|
|
//! A number.
|
|
Number = 4,
|
|
|
|
//! A reference.
|
|
Reference = 5,
|
|
|
|
//! A document delimiter.
|
|
DocumentDelimiter = 6,
|
|
|
|
//! A text block marker.
|
|
TextBlockMarker = 7,
|
|
|
|
//! A syntax error marker.
|
|
SyntaxErrorMarker = 8,
|
|
|
|
//! An operator.
|
|
Operator = 9
|
|
};
|
|
|
|
//! Construct a QsciLexerYAML with parent \a parent. \a parent is
|
|
//! typically the QsciScintilla instance.
|
|
QsciLexerYAML(QObject *parent = 0);
|
|
|
|
//! Destroys the QsciLexerYAML instance.
|
|
virtual ~QsciLexerYAML();
|
|
|
|
//! 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;
|
|
|
|
//! 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 multi-line comment blocks can be folded.
|
|
//!
|
|
//! \sa setFoldComments()
|
|
bool foldComments() const;
|
|
|
|
public slots:
|
|
//! If \a fold is true then multi-line comment blocks can be folded.
|
|
//! The default is false.
|
|
//!
|
|
//! \sa foldComments()
|
|
virtual void setFoldComments(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.
|
|
//!
|
|
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();
|
|
|
|
bool fold_comments;
|
|
|
|
QsciLexerYAML(const QsciLexerYAML &);
|
|
QsciLexerYAML &operator=(const QsciLexerYAML &);
|
|
};
|
|
|
|
#endif
|