text: // This defines the interface to the QsciLexerLua class.
  //
  // Copyright (c) 2017 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 QSCILEXERLUA_H
  #define QSCILEXERLUA_H
  
  #include <QObject>
  
  #include <thirdparty/qscintilla/Qt4Qt5/Qsci/qsciglobal.h>
  #include <thirdparty/qscintilla/Qt4Qt5/Qsci/qscilexer.h>
  
  
  //! \brief The QsciLexerLua class encapsulates the Scintilla Lua
  //! lexer.
  class QSCINTILLA_EXPORT QsciLexerLua : public QsciLexer
  {
      Q_OBJECT
  
  public:
      //! This enum defines the meanings of the different styles used by the
      //! Lua lexer.
      enum {
          //! The default.
          Default = 0,
  
          //! A block comment.
          Comment = 1,
  
          //! A line comment.
          LineComment = 2,
  
          //! A number.
          Number = 4,
  
          //! A keyword.
          Keyword = 5,
  
          //! A string.
          String = 6,
  
          //! A character.
          Character = 7,
  
          //! A literal string.
          LiteralString = 8,
  
          //! Preprocessor
          Preprocessor = 9,
  
          //! An operator.
          Operator = 10,
  
          //! An identifier
          Identifier = 11,
  
          //! The end of a line where a string is not closed.
          UnclosedString = 12,
  
          //! Basic functions.
          BasicFunctions = 13,
  
          //! String, table and maths functions.
          StringTableMathsFunctions = 14,
  
          //! Coroutines, I/O and system facilities.
          CoroutinesIOSystemFacilities = 15,
  
          //! 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 = 16,
  
          //! 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 = 17,
  
          //! 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 = 18,
  
          //! 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 = 19,
  
          //! A label.
          Label = 20
      };
  
      //! Construct a QsciLexerLua with parent \a parent.  \a parent is typically
      //! the QsciScintilla instance.
      QsciLexerLua(QObject *parent = nullptr);
  
      //! Destroys the QsciLexerLua instance.
      virtual ~QsciLexerLua();
  
      //! 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 start of a block for
      //! auto-indentation.  The styles is returned via \a style.
      const char *blockStart(int *style = nullptr) 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();
  
      //! 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 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.
      //!
      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 setCompactProp();
  
      bool fold_compact;
  
      QsciLexerLua(const QsciLexerLua &);
      QsciLexerLua &operator=(const QsciLexerLua &);
  };
  
  #endif
  