helpcompiler/inc/BasCodeTagger.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef INCLUDED_HELPCOMPILER_INC_BASCODETAGGER_HXX
  11 #define INCLUDED_HELPCOMPILER_INC_BASCODETAGGER_HXX
  12
  13 #include <deque>
  14 #include <memory>
  15 #include <vector>
  16 #include <libxml/parser.h>
  17 #include <comphelper/syntaxhighlight.hxx>
  18
  19 class LibXmlTreeWalker;
  20
  21 //!Tagger class.
  22 class BasicCodeTagger
  23 {
  24   private:
  25     xmlDocPtr             m_pDocument;
  26     std::vector<xmlNodePtr> m_BasicCodeContainerTags;
  27     std::unique_ptr<LibXmlTreeWalker>  m_pXmlTreeWalker;
  28     SyntaxHighlighter     m_Highlighter;
  29     bool m_bTaggingCompleted;
  30     void tagParagraph( xmlNodePtr paragraph );
  31     static xmlChar* getTypeString( TokenType tokenType );
  32     void getBasicCodeContainerNodes();
  33     void tagBasCodeParagraphs();
  34
  35   public:
  36     enum TaggerException { NULL_DOCUMENT, EMPTY_DOCUMENT };
  37     BasicCodeTagger( xmlDocPtr rootDoc );
  38     ~BasicCodeTagger();
  39     void tagBasicCodes();
  40 };
  41
  42 //================LibXmlTreeWalker===========================================================
  43
  44 class LibXmlTreeWalker
  45 {
  46   private:
  47     xmlNodePtr            m_pCurrentNode;
  48     std::deque<xmlNodePtr> m_Queue; //!Queue for breath-first search
  49
  50   public:
  51     LibXmlTreeWalker( xmlDocPtr doc );
  52     void nextNode();
  53     xmlNodePtr currentNode() { return m_pCurrentNode;}
  54     bool end() const;
  55     void ignoreCurrNodesChildren();
  56 };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */