starmath/inc/parse.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_STARMATH_INC_PARSE_HXX
  20 #define INCLUDED_STARMATH_INC_PARSE_HXX
  21
  22 #include <unotools/charclass.hxx>
  23 #include <memory>
  24 #include <set>
  25 #include <vector>
  26
  27 #include "types.hxx"
  28 #include "token.hxx"
  29 #include "error.hxx"
  30 #include "node.hxx"
  31
  32 #define DEPTH_LIMIT 1024
  33
  34 class SmParser
  35 {
  36     OUString        m_aBufferString;
  37     SmToken         m_aCurToken;
  38     std::vector<std::unique_ptr<SmErrorDesc>> m_aErrDescList;
  39     int             m_nCurError;
  40     sal_Int32       m_nBufferIndex,
  41                     m_nTokenIndex;
  42     sal_Int32       m_nRow,    // 1-based
  43                     m_nColOff; // 0-based
  44     bool            m_bImportSymNames,
  45                     m_bExportSymNames;
  46     sal_Int32       m_nParseDepth;
  47
  48     class DepthProtect
  49     {
  50     private:
  51         sal_Int32& m_rParseDepth;
  52     public:
  53         DepthProtect(sal_Int32& rParseDepth)
  54             : m_rParseDepth(rParseDepth)
  55         {
  56             ++m_rParseDepth;
  57         }
  58         bool TooDeep() const { return m_rParseDepth > DEPTH_LIMIT; }
  59         ~DepthProtect()
  60         {
  61             --m_rParseDepth;
  62         }
  63     };
  64
  65     // map of used symbols (used to reduce file size by exporting only actually used symbols)
  66     std::set< OUString >   m_aUsedSymbols;
  67
  68     // CharClass representing a locale for parsing numbers
  69     CharClass m_aNumCC;
  70     // pointer to System locale's CharClass, which is alive inside SM_MOD()
  71     const CharClass* m_pSysCC;
  72
  73     SmParser(const SmParser&) = delete;
  74     SmParser& operator=(const SmParser&) = delete;
  75
  76     void            NextToken();
  77     sal_Int32       GetTokenIndex() const   { return m_nTokenIndex; }
  78     void            Replace( sal_Int32 nPos, sal_Int32 nLen, const OUString &rText );
  79
  80     inline bool     TokenInGroup( TG nGroup );
  81
  82     // grammar
  83     std::unique_ptr<SmTableNode> DoTable();
  84     std::unique_ptr<SmNode> DoLine();
  85     std::unique_ptr<SmNode> DoExpression(bool bUseExtraSpaces = true);
  86     std::unique_ptr<SmNode> DoRelation();
  87     std::unique_ptr<SmNode> DoSum();
  88     std::unique_ptr<SmNode> DoProduct();
  89     std::unique_ptr<SmNode> DoSubSup(TG nActiveGroup, SmNode *pGivenNode);
  90     std::unique_ptr<SmNode> DoOpSubSup();
  91     std::unique_ptr<SmNode> DoPower();
  92     SmBlankNode *DoBlank();
  93     SmNode *DoTerm(bool bGroupNumberIdent);
  94     SmNode *DoEscape();
  95     SmOperNode *DoOperator();
  96     std::unique_ptr<SmNode> DoOper();
  97     SmStructureNode *DoUnOper();
  98     std::unique_ptr<SmNode> DoAlign(bool bUseExtraSpaces = true);
  99     std::unique_ptr<SmStructureNode> DoFontAttribut();
 100     std::unique_ptr<SmStructureNode> DoAttribut();
 101     std::unique_ptr<SmStructureNode> DoFont();
 102     std::unique_ptr<SmStructureNode> DoFontSize();
 103     std::unique_ptr<SmStructureNode> DoColor();
 104     SmStructureNode *DoBrace();
 105     SmBracebodyNode *DoBracebody(bool bIsLeftRight);
 106     SmTextNode *DoFunction();
 107     SmTableNode *DoBinom();
 108     SmStructureNode *DoStack();
 109     SmStructureNode *DoMatrix();
 110     SmSpecialNode *DoSpecial();
 111     SmGlyphSpecialNode *DoGlyphSpecial();
 112     SmExpressionNode *DoError(SmParseError Error);
 113     // end of grammar
 114
 115 public:
 116                  SmParser();
 117
 118     /** Parse rBuffer to formula tree */
 119     std::unique_ptr<SmTableNode> Parse(const OUString &rBuffer);
 120     /** Parse rBuffer to formula subtree that constitutes an expression */
 121     std::unique_ptr<SmNode> ParseExpression(const OUString &rBuffer);
 122
 123     const OUString & GetText() const { return m_aBufferString; };
 124
 125     bool        IsImportSymbolNames() const        { return m_bImportSymNames; }
 126     void        SetImportSymbolNames(bool bVal)    { m_bImportSymNames = bVal; }
 127     bool        IsExportSymbolNames() const        { return m_bExportSymNames; }
 128     void        SetExportSymbolNames(bool bVal)    { m_bExportSymNames = bVal; }
 129
 130     void        AddError(SmParseError Type, SmNode *pNode);
 131     const SmErrorDesc*  NextError();
 132     const SmErrorDesc*  PrevError();
 133     const SmErrorDesc*  GetError();
 134     static const SmTokenTableEntry* GetTokenTableEntry( const OUString &rName );
 135     const std::set< OUString >&   GetUsedSymbols() const      { return m_aUsedSymbols; }
 136 };
 137
 138
 139 inline bool SmParser::TokenInGroup( TG nGroup)
 140 {
 141     return bool(m_aCurToken.nGroup & nGroup);
 142 }
 143
 144
 145 #endif
 146
 147 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */