text: /****************************************************************************
  **
  ** Copyright (C) 2016 The Qt Company Ltd.
  ** Contact: https://www.qt.io/licensing/
  **
  ** This file is part of Qt Creator.
  **
  ** Commercial License Usage
  ** Licensees holding valid commercial Qt licenses may use this file in
  ** accordance with the commercial license agreement provided with the
  ** Software or, alternatively, in accordance with the terms contained in
  ** a written agreement between you and The Qt Company. For licensing terms
  ** and conditions see https://www.qt.io/terms-conditions. For further
  ** information use the contact form at https://www.qt.io/contact-us.
  **
  ** GNU General Public License Usage
  ** Alternatively, this file may be used under the terms of the GNU
  ** General Public License version 3 as published by the Free Software
  ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
  ** included in the packaging of this file. Please review the following
  ** information to ensure the GNU General Public License requirements will
  ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
  **
  ****************************************************************************/
  
  #pragma once
  
  #include <QString>
  #include <QSharedPointer>
  #include <QStack>
  
  #include <QXmlDefaultHandler>
  
  namespace TextEditor {
  namespace Internal {
  
  class KeywordList;
  class Context;
  class Rule;
  class HighlightDefinition;
  
  class HighlightDefinitionHandler : public QXmlDefaultHandler
  {
  public:
      HighlightDefinitionHandler(const QSharedPointer<HighlightDefinition> &definition);
      ~HighlightDefinitionHandler();
  
      bool startDocument();
      bool endDocument();
      bool startElement(const QString &namespaceURI, const QString &localName,
                        const QString &qName, const QXmlAttributes &atts);
      bool endElement(const QString &namespaceURI, const QString &localName, const QString &qName);
      bool characters(const QString &ch);
  
  private:
      void listElementStarted(const QXmlAttributes &atts);
      void itemElementStarted();
      void contextElementStarted(const QXmlAttributes &atts);
      void itemDataElementStarted(const QXmlAttributes &atts) const;
      void commentElementStarted(const QXmlAttributes &atts) const;
      void keywordsElementStarted(const QXmlAttributes &atts) const;
      void foldingElementStarted(const QXmlAttributes &atts) const;
      void ruleElementStarted(const QXmlAttributes &atts, const QSharedPointer<Rule> &rule);
  
      // Specific rules.
      void detectCharStarted(const QXmlAttributes &atts);
      void detect2CharsStarted(const QXmlAttributes &atts);
      void anyCharStarted(const QXmlAttributes &atts);
      void stringDetectedStarted(const QXmlAttributes &atts);
      void regExprStarted(const QXmlAttributes &atts);
      void keywordStarted(const QXmlAttributes &atts);
      void intStarted(const QXmlAttributes &atts);
      void floatStarted(const QXmlAttributes &atts);
      void hlCOctStarted(const QXmlAttributes &atts);
      void hlCHexStarted(const QXmlAttributes &atts);
      void hlCStringCharStarted(const QXmlAttributes &atts);
      void hlCCharStarted(const QXmlAttributes &atts);
      void rangeDetectStarted(const QXmlAttributes &atts);
      void lineContinue(const QXmlAttributes &atts);
      void includeRulesStarted(const QXmlAttributes &atts);
      void detectSpacesStarted(const QXmlAttributes &atts);
      void detectIdentifier(const QXmlAttributes &atts);
  
      void processIncludeRules() const;
      void processIncludeRules(const QSharedPointer<Context> &context) const;
  
      QSharedPointer<HighlightDefinition> m_definition;
  
      bool m_processingKeyword;
      QString m_currentKeyword;
      QSharedPointer<KeywordList> m_currentList;
      QSharedPointer<Context> m_currentContext;
      QStack<QSharedPointer<Rule> > m_currentRule;
  
      bool m_initialContext;
  };
  
  } // namespace Internal
  } // namespace TextEditor
  