starmath/inc/parsebase.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
  20 /** Parses the starmath code and creates the nodes.
  21   *
  22   */
  23
  24 #pragma once
  25
  26 #include <unotools/resmgr.hxx>
  27
  28 #include "node.hxx"
  29
  30 #include <set>
  31 #include <utility>
  32
  33 #define DEPTH_LIMIT 1024
  34
  35 // Those are the errors that the parser may encounter.
  36 enum class SmParseError : uint_fast8_t
  37 {
  38     None = 0,
  39     UnexpectedChar = 1,
  40     UnexpectedToken = 2,
  41     PoundExpected = 3,
  42     ColorExpected = 4,
  43     LgroupExpected = 5,
  44     RgroupExpected = 6,
  45     LbraceExpected = 7,
  46     RbraceExpected = 8,
  47     ParentMismatch = 9,
  48     RightExpected = 10,
  49     FontExpected = 11,
  50     SizeExpected = 12,
  51     DoubleAlign = 13,
  52     DoubleSubsupscript = 14,
  53     NumberExpected = 15
  54 };
  55
  56 struct SmErrorDesc
  57 {
  58     SmParseError m_eType;
  59     SmNode* m_pNode;
  60     OUString m_aText;
  61
  62     SmErrorDesc(SmParseError eType, SmNode* pNode, OUString aText)
  63         : m_eType(eType)
  64         , m_pNode(pNode)
  65         , m_aText(std::move(aText))
  66     {
  67     }
  68 };
  69
  70 class DepthProtect
  71 {
  72 private:
  73     sal_Int32& m_rParseDepth;
  74
  75 public:
  76     DepthProtect(sal_Int32& rParseDepth)
  77         : m_rParseDepth(rParseDepth)
  78     {
  79         ++m_rParseDepth;
  80         if (m_rParseDepth > DEPTH_LIMIT)
  81             throw std::range_error("parser depth limit");
  82     }
  83     ~DepthProtect() { --m_rParseDepth; }
  84 };
  85
  86 namespace starmathdatabase
  87 {
  88 // Must be in sync with SmParseError list
  89 extern const TranslateId SmParseErrorDesc[16];
  90
  91 OUString getParseErrorDesc(SmParseError err);
  92 }
  93
  94 class AbstractSmParser
  95 {
  96 public:
  97     virtual ~AbstractSmParser() {}
  98
  99     /** Parse rBuffer to formula tree */
 100     virtual std::unique_ptr<SmTableNode> Parse(const OUString& rBuffer) = 0;
 101     /** Parse rBuffer to formula subtree that constitutes an expression */
 102     virtual std::unique_ptr<SmNode> ParseExpression(const OUString& rBuffer) = 0;
 103
 104     virtual const OUString& GetText() const = 0;
 105
 106     virtual bool IsImportSymbolNames() const = 0;
 107     virtual void SetImportSymbolNames(bool bVal) = 0;
 108     virtual bool IsExportSymbolNames() const = 0;
 109     virtual void SetExportSymbolNames(bool bVal) = 0;
 110
 111     virtual const SmErrorDesc* NextError() = 0;
 112     virtual const SmErrorDesc* PrevError() = 0;
 113     virtual const SmErrorDesc* GetError() const = 0;
 114     virtual const std::set<OUString>& GetUsedSymbols() const = 0;
 115 };
 116
 117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */