muParserBase.h

Go to the documentation of this file.

/*
                 __________
    _____   __ __\______   \_____  _______  ______  ____ _______
   /     \ |  |  \|     ___/\__  \ \_  __ \/  ___/_/ __ \\_  __ \
  |  Y Y  \|  |  /|    |     / __ \_|  | \/\___ \ \  ___/ |  | \/
  |__|_|  /|____/ |____|    (____  /|__|  /____  > \___  >|__|
        \/                       \/            \/      \/
  Copyright (C) 2012 Ingo Berg
 
  Permission is hereby granted, free of charge, to any person obtaining a copy of this
  software and associated documentation files (the "Software"), to deal in the Software
  without restriction, including without limitation the rights to use, copy, modify,
  merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all copies or
  substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
  NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef MU_PARSER_BASE_H
#define MU_PARSER_BASE_H
 
//--- Standard includes ------------------------------------------------------------------------
#include <cmath>
#include <string>
#include <iostream>
#include <map>
#include <memory>
#include <locale>
#include <list>
 
//--- Parser includes --------------------------------------------------------------------------
#include "muParserDef.h"
#include "muParserStack.h"
#include "muParserTokenReader.h"
#include "muParserBytecode.h"
#include "muParserError.h"
#include "muParserState.hpp"
 
class StringView;
class MutableStringView;
 
namespace mu
{
    typedef std::map<std::string,std::vector<value_type>> vectormap_type;
 
 
    //--------------------------------------------------------------------------------------------------
    class ParserBase
    {
        private:
            friend class ParserTokenReader;
 
            typedef void (ParserBase::*ParseFunction)();
 
            typedef std::vector<string_type> stringbuf_type;
 
            typedef ParserTokenReader token_reader_type;
 
            typedef ParserToken<value_type, string_type> token_type;
 
        public:
 
            typedef ParserError exception_type;
 
            mutable std::map<std::string, std::string>* mVarMapPntr;
            mutable std::list<mu::value_type*> m_lDataStorage;
 
            // Bytecode caching and loop caching interface section
            void ActivateLoopMode(unsigned int _nLoopLength);
            void DeactivateLoopMode();
            void SetIndex(unsigned int _nLoopElement);
            void SetCompiling(bool _bCompiling = true);
            bool IsCompiling();
            void CacheCurrentAccess(const CachedDataAccess& _access);
            size_t HasCachedAccess();
            void DisableAccessCaching();
            bool CanCacheAccess();
            const CachedDataAccess& GetCachedAccess(size_t nthAccess);
            void CacheCurrentEquation(const std::string& sEquation);
            const std::string& GetCachedEquation() const;
            void CacheCurrentTarget(const std::string& sEquation);
            const std::string& GetCachedTarget() const;
            int IsValidByteCode(unsigned int _nthLoopElement = -1, unsigned int _nthPartEquation = 0);
            bool ActiveLoopMode() const;
            bool IsLockedPause() const;
            void LockPause(bool _bLock = true);
            void PauseLoopMode(bool _bPause = true);
            bool IsAlreadyParsed(StringView sNewEquation);
            bool IsNotLastStackItem() const;
 
            static void EnableDebugDump(bool bDumpCmd, bool bDumpStack);
 
            ParserBase();
            ParserBase(const ParserBase& a_Parser);
            ParserBase& operator=(const ParserBase& a_Parser);
 
            virtual ~ParserBase();
 
            value_type  Eval();
            value_type* Eval(int& nStackSize);
            void Eval(value_type* results, int nBulkSize);
 
            void SetExpr(StringView a_sExpr);
            void SetVarFactory(facfun_type a_pFactory, void* pUserData = NULL);
 
            void SetDecSep(char_type cDecSep);
            void SetThousandsSep(char_type cThousandsSep = 0);
            void ResetLocale();
 
            void EnableOptimizer(bool a_bIsOn = true);
            void EnableBuiltInOprt(bool a_bIsOn = true);
 
            bool HasBuiltInOprt() const;
            void AddValIdent(identfun_type a_pCallback);
 
            template<typename T>
            void DefineFun(const string_type& a_strName, T a_pFun, bool optimizeAway = true)
            {
                AddCallback( a_strName, ParserCallback(a_pFun, optimizeAway), m_FunDef, ValidNameChars() );
            }
 
            void DefineOprt(const string_type& a_strName,
                            fun_type2 a_pFun,
                            unsigned a_iPri = 0,
                            EOprtAssociativity a_eAssociativity = oaLEFT,
                            bool optimizeAway = true);
            void DefineConst(const string_type& a_sName, value_type a_fVal);
            void DefineStrConst(const string_type& a_sName, const string_type& a_strVal);
            void DefineVar(const string_type& a_sName, value_type* a_fVar);
            void DefinePostfixOprt(const string_type& a_strFun, fun_type1 a_pOprt, bool optimizeAway = true);
            void DefineInfixOprt(const string_type& a_strName, fun_type1 a_pOprt, int a_iPrec = prINFIX, bool optimizeAway = true);
 
            // Clear user defined variables, constants or functions
            void ClearVar();
            void ClearFun();
            void ClearConst();
            void ClearInfixOprt();
            void ClearPostfixOprt();
            void ClearOprt();
 
            void RemoveVar(const string_type& a_strVarName);
            const varmap_type& GetUsedVar();
            const varmap_type& GetVar() const;
            const valmap_type& GetConst() const;
            const string_type& GetExpr() const;
            const funmap_type& GetFunDef() const;
            const std::map<std::string, std::vector<mu::value_type> >& GetVectors() const;
            string_type GetVersion(EParserVersionInfo eInfo = pviFULL) const;
 
            const char_type** GetOprtDef() const;
            void DefineNameChars(const char_type* a_szCharset);
            void DefineOprtChars(const char_type* a_szCharset);
            void DefineInfixOprtChars(const char_type* a_szCharset);
 
            const char_type* ValidNameChars() const;
            const char_type* ValidOprtChars() const;
            const char_type* ValidInfixOprtChars() const;
 
            void SetArgSep(char_type cArgSep);
            char_type GetArgSep() const;
 
            void  Error(EErrorCodes a_iErrc,
                        int a_iPos = (int)mu::string_type::npos,
                        const string_type& a_strTok = string_type() ) const;
            void  Error(EErrorCodes a_iErrc,
                        const string_type& a_Expr,
                        int a_iPos = (int)mu::string_type::npos,
                        const string_type& a_strTok = string_type() ) const;
 
            string_type CreateTempVectorVar(const std::vector<mu::value_type>& vVar);
            void SetVectorVar(const std::string& sVarName, const std::vector<mu::value_type>& vVar, bool bAddVectorType = false);
            std::vector<mu::value_type>* GetVectorVar(const std::string& sVarName);
            void UpdateVectorVar(const std::string& sVarName);
            void ClearVectorVars(bool bIgnoreProcedureVects = false);
            bool ContainsVectorVars(StringView sExpr, bool ignoreSingletons);
 
        protected:
 
            void Init();
 
            virtual void InitCharSets() = 0;
            virtual void InitFun() = 0;
            virtual void InitConst() = 0;
            virtual void InitOprt() = 0;
 
            virtual void OnDetectVar(string_type* pExpr, int& nStart, int& nEnd);
 
            static const char_type* c_DefaultOprt[];
            static std::locale s_locale;  
            static bool g_DbgDumpCmdCode;
            static bool g_DbgDumpStack;
 
            template<class TChar>
            class change_dec_sep : public std::numpunct<TChar>
            {
                public:
 
                    explicit change_dec_sep(char_type cDecSep, char_type cThousandsSep = 0, int nGroup = 3)
                        : std::numpunct<TChar>()
                        , m_nGroup(nGroup)
                        , m_cDecPoint(cDecSep)
                        , m_cThousandsSep(cThousandsSep)
                    {}
 
                protected:
 
                    virtual char_type do_decimal_point() const
                    {
                        return m_cDecPoint;
                    }
 
                    virtual char_type do_thousands_sep() const
                    {
                        return m_cThousandsSep;
                    }
 
                    virtual std::string do_grouping() const
                    {
                        return std::string(1, m_nGroup);
                    }
 
                private:
 
                    int m_nGroup;
                    char_type m_cDecPoint;
                    char_type m_cThousandsSep;
            };
 
        private:
            void replaceLocalVars(std::string& sLine);
            bool checkDelimiter(StringView sLine);
            MutableStringView compileVectors(MutableStringView sExpr);
            bool compileVectorsInMultiArgFunc(MutableStringView& sExpr, size_t& nPos);
            size_t FindMultiArgFunc(StringView sExpr, size_t nPos, std::string& sMultArgFunc);
            void compileVectorExpansion(MutableStringView sSubExpr, const std::string& sVectorVarName);
            void expandVector(mu::value_type dFirst,
                              const mu::value_type& dLast,
                              const mu::value_type& dIncrement,
                              std::vector<mu::value_type>& vResults);
            void evaluateTemporaryVectors(const VectorEvaluation& vectEval, int nStackSize);
            string_type getNextVarObject(std::string& sArgList, bool bCut);
            string_type getNextVectorVarIndex();
            void Assign(const ParserBase& a_Parser);
            void InitTokenReader();
            void ReInit();
            ExpressionTarget& getTarget() const;
 
            void AddCallback( const string_type& a_strName,
                              const ParserCallback& a_Callback,
                              funmap_type& a_Storage,
                              const char_type* a_szCharSet );
 
            void ApplyRemainingOprt(ParserStack<token_type>& a_stOpt,
                                    ParserStack<token_type>& a_stVal) const;
            void ApplyBinOprt(ParserStack<token_type>& a_stOpt,
                              ParserStack<token_type>& a_stVal) const;
 
            void ApplyIfElse(ParserStack<token_type>& a_stOpt,
                             ParserStack<token_type>& a_stVal) const;
 
            void ApplyFunc(ParserStack<token_type>& a_stOpt,
                           ParserStack<token_type>& a_stVal,
                           int iArgCount) const;
 
            token_type ApplyStrFunc(const token_type& a_FunTok,
                                    const std::vector<token_type>& a_vArg) const;
 
            int GetOprtPrecedence(const token_type& a_Tok) const;
            EOprtAssociativity GetOprtAssociativity(const token_type& a_Tok) const;
 
            void CreateRPN();
 
            void ParseString();
            void ParseCmdCode();
            void ParseCmdCodeBulk(int nOffset, int nThreadID);
            void ParseCmdCodeBulkParallel(size_t nVectorLength);
 
            void  CheckName(const string_type& a_strName, const string_type& a_CharSet) const;
            void  CheckOprt(const string_type& a_sName,
                            const ParserCallback& a_Callback,
                            const string_type& a_szCharSet) const;
 
            void StackDump(const ParserStack<token_type >& a_stVal,
                           const ParserStack<token_type >& a_stOprt) const;
 
            mutable ParseFunction  m_pParseFormula;
            mutable State m_compilingState;
            mutable ExpressionTarget m_compilingTarget;
            mutable StateStacks m_stateStacks;
            State* m_state;
            mutable valbuf_type m_buffer;
 
            //static const int s_MaxNumOpenMPThreads = 4;
 
            mutable vectormap_type mVectorVars;
 
            unsigned int nthLoopElement;
            unsigned int nthLoopPartEquation;
            unsigned int nCurrVectorIndex;
            bool bMakeLoopByteCode;
            bool bPauseLoopByteCode;
            bool bPauseLock;
            bool bCompiling;
            int nMaxThreads;
 
            mutable stringbuf_type  m_vStringBuf; 
            stringbuf_type  m_vStringVarBuf;
 
            std::unique_ptr<token_reader_type> m_pTokenReader; 
 
            funmap_type  m_FunDef;         
            funmap_type  m_PostOprtDef;    
            funmap_type  m_InfixOprtDef;   
            funmap_type  m_OprtDef;        
            valmap_type  m_ConstDef;       
            strmap_type  m_StrVarDef;      
            varmap_type  m_VarDef;         
 
            bool m_bBuiltInOp;             
 
            string_type m_sNameChars;      
            string_type m_sOprtChars;      
            string_type m_sInfixOprtChars; 
 
            mutable int m_nIfElseCounter;  
 
            // items merely used for caching state information
            const std::string EMPTYSTRING;
    };
 
} // namespace mu
 
#endif