/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*

 * This file is part of the LibreOffice project.

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 *

 * This file incorporates work covered by the following license notice:

 *

 *   Licensed to the Apache Software Foundation (ASF) under one or more

 *   contributor license agreements. See the NOTICE file distributed

 *   with this work for additional information regarding copyright

 *   ownership. The ASF licenses this file to you under the Apache

 *   License, Version 2.0 (the "License"); you may not use this file

 *   except in compliance with the License. You may obtain a copy of

 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .

 */

/** Parses the starmath code and creates the nodes.

  *

  */

#pragma once

#include "parsebase.hxx"

#include <unotools/charclass.hxx>

class SmParser5 final : public AbstractSmParser

{

    OUString m_aBufferString;

    SmToken m_aCurToken;

    ESelection m_aCurESelection;

    std::vector<SmErrorDesc> m_aErrDescList;

    int m_nCurError;

    sal_Int32 m_nBufferIndex, m_nTokenIndex;

    sal_Int32 m_nRow, // 1-based

        m_nColOff; // 0-based

    bool m_bImportSymNames, m_bExportSymNames;

    sal_Int32 m_nParseDepth;

    // map of used symbols (used to reduce file size by exporting only actually used symbols)

    std::set<OUString> m_aUsedSymbols;

    // CharClass representing a locale for parsing numbers

    CharClass m_aNumCC;

    // pointer to System locale's CharClass, which is alive inside SM_MOD()

    const CharClass* m_pSysCC;

    SmParser5(const SmParser5&) = delete;

    SmParser5& operator=(const SmParser5&) = delete;

    // Moves between tokens inside starmath code.

    void NextToken();

    void NextTokenColor(SmTokenType dvipload);

    void NextTokenFontSize();

    sal_Int32 GetTokenIndex() const { return m_nTokenIndex; }

    void Replace(sal_Int32 nPos, sal_Int32 nLen, std::u16string_view aText);

    inline bool TokenInGroup(TG nGroup);

    // grammar

    std::unique_ptr<SmTableNode> DoTable();

    std::unique_ptr<SmNode> DoLine();

    std::unique_ptr<SmNode> DoExpression(bool bUseExtraSpaces = true);

    std::unique_ptr<SmNode> DoRelation();

    std::unique_ptr<SmNode> DoSum();

    std::unique_ptr<SmNode> DoProduct();

    std::unique_ptr<SmNode> DoSubSup(TG nActiveGroup, std::unique_ptr<SmNode> xGivenNode);

    std::unique_ptr<SmNode> DoSubSupEvaluate(std::unique_ptr<SmNode> xGivenNode);

    std::unique_ptr<SmNode> DoOpSubSup();

    std::unique_ptr<SmNode> DoPower();

    std::unique_ptr<SmBlankNode> DoBlank();

    std::unique_ptr<SmNode> DoTerm(bool bGroupNumberIdent);

    std::unique_ptr<SmNode> DoEscape();

    std::unique_ptr<SmOperNode> DoOperator();

    std::unique_ptr<SmNode> DoOper();

    std::unique_ptr<SmStructureNode> DoUnOper();

    std::unique_ptr<SmNode> DoAlign(bool bUseExtraSpaces = true);

    std::unique_ptr<SmStructureNode> DoFontAttribute();

    std::unique_ptr<SmStructureNode> DoAttribute();

    std::unique_ptr<SmStructureNode> DoFont();

    std::unique_ptr<SmStructureNode> DoFontSize();

    std::unique_ptr<SmStructureNode> DoColor();

    std::unique_ptr<SmStructureNode> DoBrace();

    std::unique_ptr<SmBracebodyNode> DoBracebody(bool bIsLeftRight);

    std::unique_ptr<SmNode> DoEvaluate();

    std::unique_ptr<SmTextNode> DoFunction();

    std::unique_ptr<SmTableNode> DoBinom();

    std::unique_ptr<SmBinVerNode> DoFrac();

    std::unique_ptr<SmStructureNode> DoStack();

    std::unique_ptr<SmStructureNode> DoMatrix();

    std::unique_ptr<SmSpecialNode> DoSpecial();

    std::unique_ptr<SmGlyphSpecialNode> DoGlyphSpecial();

    std::unique_ptr<SmExpressionNode> DoError(SmParseError Error);

    // end of grammar

public:

    SmParser5();

    virtual ~SmParser5();

    /** Parse rBuffer to formula tree */

    std::unique_ptr<SmTableNode> Parse(const OUString& rBuffer);

    /** Parse rBuffer to formula subtree that constitutes an expression */

    std::unique_ptr<SmNode> ParseExpression(const OUString& rBuffer);

    const OUString& GetText() const { return m_aBufferString; };

    bool IsImportSymbolNames() const { return m_bImportSymNames; }

    void SetImportSymbolNames(bool bVal) { m_bImportSymNames = bVal; }

    bool IsExportSymbolNames() const { return m_bExportSymNames; }

    void SetExportSymbolNames(bool bVal) { m_bExportSymNames = bVal; }

    const SmErrorDesc* NextError();

    const SmErrorDesc* PrevError();

    const SmErrorDesc* GetError() const;

    const std::set<OUString>& GetUsedSymbols() const { return m_aUsedSymbols; }

};

inline bool SmParser5::TokenInGroup(TG nGroup) { return bool(m_aCurToken.nGroup & nGroup); }

const SmTokenTableEntry* GetTokenTableEntry(const OUString& rName);

OUString encloseOrEscapeLiteral(const OUString& string, bool force);

inline bool isSingleCharMathOperator(sal_Unicode c)

{

    return c == '+' || c == '-' || c == '*' || c == '/' || c == '=' || c == '<' || c == '>';

}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */