Initial commit: ReclassX structured binary editor

third_party/qscintilla/src/Qsci/qscilexerpov.h

@@ -0,0 +1,203 @@
+// This defines the interface to the QsciLexerPOV 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 QSCILEXERPOV_H
+#define QSCILEXERPOV_H
+
+#include <QObject>
+
+#include <Qsci/qsciglobal.h>
+#include <Qsci/qscilexer.h>
+
+
+//! \brief The QsciLexerPOV class encapsulates the Scintilla POV lexer.
+class QSCINTILLA_EXPORT QsciLexerPOV : public QsciLexer
+{
+    Q_OBJECT
+
+public:
+    //! This enum defines the meanings of the different styles used by the
+    //! POV lexer.
+    enum {
+        //! The default.
+        Default = 0,
+
+        //! A comment.
+        Comment = 1,
+
+        //! A comment line.
+        CommentLine = 2,
+
+        //! A number.
+        Number = 3,
+
+        //! An operator.
+        Operator = 4,
+
+        //! An identifier
+        Identifier = 5,
+
+        //! A string.
+        String = 6,
+
+        //! The end of a line where a string is not closed.
+        UnclosedString = 7,
+
+        //! A directive.
+        Directive = 8,
+
+        //! A bad directive.
+        BadDirective = 9,
+
+        //! Objects, CSG and appearance.
+        ObjectsCSGAppearance = 10,
+
+        //! Types, modifiers and items.
+        TypesModifiersItems = 11,
+
+        //! Predefined identifiers.
+        PredefinedIdentifiers = 12,
+
+        //! Predefined identifiers.
+        PredefinedFunctions = 13,
+
+        //! 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 = 14,
+
+        //! 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 = 15,
+
+        //! A keyword defined in keyword set number 8.  The class must be
+        //! sub-classed and re-implement keywords() to make use of this style.
+        KeywordSet8 = 16
+    };
+
+    //! Construct a QsciLexerPOV with parent \a parent.  \a parent is typically
+    //! the QsciScintilla instance.
+    QsciLexerPOV(QObject *parent = 0);
+
+    //! Destroys the QsciLexerPOV instance.
+    virtual ~QsciLexerPOV();
+
+    //! 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 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 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;
+
+    //! Returns true if directives can be folded.
+    //!
+    //! \sa setFoldDirectives()
+    bool foldDirectives() 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);
+
+    //! 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);
+
+    //! If \a fold is true then directives can be folded.  The default is
+    //! false.
+    //!
+    //! \sa foldDirectives()
+    virtual void setFoldDirectives(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();
+    void setCompactProp();
+    void setDirectiveProp();
+
+    bool fold_comments;
+    bool fold_compact;
+    bool fold_directives;
+
+    QsciLexerPOV(const QsciLexerPOV &);
+    QsciLexerPOV &operator=(const QsciLexerPOV &);
+};
+
+#endif