path: root/muparser/muParserToken.h

/*
                 __________                                      
    _____   __ __\______   \_____  _______  ______  ____ _______ 
   /     \ |  |  \|     ___/\__  \ \_  __ \/  ___/_/ __ \\_  __ \
  |  Y Y  \|  |  /|    |     / __ \_|  | \/\___ \ \  ___/ |  | \/
  |__|_|  /|____/ |____|    (____  /|__|  /____  > \___  >|__|   
        \/                       \/            \/      \/        
  Copyright (C) 2004-2006 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_TOKEN_H
#define MU_PARSER_TOKEN_H

#include <cassert>
#include <string>
#include <stack>
#include <vector>
#include <memory>

#include "muParserError.h"
#include "muParserCallback.h"


namespace mu
{

/** \brief Encapsulation of the data for a single formula token. 

  Formula token implementation. Part of the Math Parser Package.
  Formula tokens can be either one of the following:
  <ul>
    <li>value</li>
    <li>variable</li>
    <li>function with numerical arguments</li>
    <li>functions with a string as argument</li>
    <li>prefix operators</li>
    <li>infix operators</li>
	  <li>binary operator</li>
  </ul>

 \author (C) 2004 Ingo Berg 
*/
template<typename TBase, typename TString>
class ParserToken
{
public:
    /** \brief Additional token flags. */
    enum ETokFlags
	  {
	    flVOLATILE = 1    ///< Mark a token that depends on a variable or a function that is not conservative
	  };

private:
    ECmdCode  m_iCode;  ///< Type of the token; The token type is a constant of type #ECmdCode.
    ETypeCode m_iType;
    void  *m_pTok;      ///< Stores Token pointer; not applicable for all tokens
  	int  m_iFlags;      ///< Additional flags for the token.
    int  m_iIdx;        ///< An otional index to an external buffer storing the token data
    TString m_strTok;   ///< Token string
    TString m_strVal;   ///< Value for string variables
    value_type m_fVal;
    std::auto_ptr<ParserCallback> m_pCallback;

public:

    //---------------------------------------------------------------------------
    /** \brief Constructor (default).
      
        Sets token to an neutral state of type cmUNKNOWN.
        \throw nothrow
        \sa ECmdCode
    */
    ParserToken()
      :m_iCode(cmUNKNOWN)
      ,m_iType(tpVOID)
      ,m_pTok(0)
      ,m_iFlags(0)
      ,m_iIdx(-1)
      ,m_strTok()
      ,m_pCallback()
    {}

    //------------------------------------------------------------------------------
    /** \brief Create token from another one.
    
        Implemented by calling Assign(...)
        \throw nothrow
        \post m_iType==cmUNKNOWN
        \sa #Assign
    */
    ParserToken(const ParserToken &a_Tok)
    {
      Assign(a_Tok);
    }
    
    //------------------------------------------------------------------------------
    /** \brief Assignement operator. 
    
        Copy token state from another token and return this.
        Implemented by calling Assign(...).
        \throw nothrow
    */
    ParserToken& operator=(const ParserToken &a_Tok)
    {
      Assign(a_Tok);
      return *this;
    }

    //------------------------------------------------------------------------------
    /** \brief Copy token information from argument.
    
        \throw nothrow
    */
    void Assign(const ParserToken &a_Tok)
    {
      m_iCode = a_Tok.m_iCode;
      m_pTok = a_Tok.m_pTok;
      m_iFlags = a_Tok.m_iFlags;
      m_strTok = a_Tok.m_strTok;
      m_iIdx = a_Tok.m_iIdx;
      m_strVal = a_Tok.m_strVal;
      m_iType = a_Tok.m_iType;
      m_fVal = a_Tok.m_fVal;
      // create new callback object if a_Tok has one 
      m_pCallback.reset(a_Tok.m_pCallback.get() ? a_Tok.m_pCallback->Clone() : 0);
    }

    //------------------------------------------------------------------------------
    /** \brief Add additional flags to the token. 

        Flags are currently used to mark volatile (non optimizeable) functions.
        \sa m_iFlags, ETokFlags    
    */
    void AddFlags(int a_iFlags)
    {
      m_iFlags |= a_iFlags;
    }

    //------------------------------------------------------------------------------
    /** \brief Check if a certain flag ist set. 

        \throw nothrow
    */
    bool IsFlagSet(int a_iFlags) const
    {
        #if defined(_MSC_VER)
          #pragma warning( disable : 4800 )
        #endif
        
        return (bool)(m_iFlags & a_iFlags);

        #if defined(_MSC_VER)
          #pragma warning( default : 4800 ) // int: Variable set to boolean value (may degrade performance)
        #endif
    }

    //------------------------------------------------------------------------------
    /** \brief Assign a token type. 

      Token may not be of type value, variable or function. Those have seperate set functions. 

      \pre [assert] a_iType!=cmVAR
      \pre [assert] a_iType!=cmVAL
      \pre [assert] a_iType!=cmFUNC
      \post m_fVal = 0
      \post m_pTok = 0
    */
    ParserToken& Set(ECmdCode a_iType, const TString &a_strTok=TString())
    {
      // The following types cant be set this way, they have special Set functions
      assert(a_iType!=cmVAR);
      assert(a_iType!=cmVAL);
      assert(a_iType!=cmFUNC);

      m_iCode = a_iType;
      m_iType = tpVOID;
      m_pTok = 0;
      m_iFlags = 0;
      m_strTok = a_strTok;
      m_iIdx = -1;

      return *this;
    }

    //------------------------------------------------------------------------------
    /** \brief Set Callback type. */
    ParserToken& Set(const ParserCallback &a_pCallback, const TString &a_sTok)
    {
      assert(a_pCallback.GetAddr());

      m_iCode = a_pCallback.GetCode();
      m_iType = tpVOID;
      m_strTok = a_sTok;
      m_pCallback.reset(new ParserCallback(a_pCallback));

      m_pTok = 0;
      m_iFlags = 0;
      m_iIdx = -1;
      
      if (!m_pCallback->IsOptimizable())
        AddFlags(flVOLATILE);

      return *this;
    }

    //------------------------------------------------------------------------------
    /** \brief Make this token a value token. 
    
        Member variables not necessary for value tokens will be invalidated.
        \throw nothrow
    */
    ParserToken& SetVal(TBase a_fVal, const TString &a_strTok=TString())
    {
      m_iCode = cmVAL;
      m_iType = tpDBL;
      m_fVal = a_fVal;
      m_iFlags = 0;
      m_strTok = a_strTok;
      m_iIdx = -1;
      
      m_pTok = 0;
      m_pCallback.reset(0);

      return *this;
    }

    //------------------------------------------------------------------------------
    /** \brief make this token a variable token. 
    
        Member variables not necessary for variable tokens will be invalidated.
        \throw nothrow
    */
    ParserToken& SetVar(TBase *a_pVar, const TString &a_strTok)
    {
      m_iCode = cmVAR;
      m_iType = tpDBL;
      m_iFlags = 0;
      m_strTok = a_strTok;
      m_iIdx = -1;
      m_pTok = (void*)a_pVar;
      m_pCallback.reset(0);

      AddFlags(ParserToken::flVOLATILE);
      return *this;
    }

    //------------------------------------------------------------------------------
    /** \brief Make this token a variable token. 
    
        Member variables not necessary for variable tokens will be invalidated.
        \throw nothrow
    */
    ParserToken& SetString(const TString &a_strTok, std::size_t a_iSize)
    {
      m_iCode = cmSTRING; // cmSTRVAR;
      m_iType = tpSTR;
      m_iFlags = 0;
      m_strTok = a_strTok;
      m_iIdx = static_cast<int>(a_iSize);

      m_pTok = 0;
      m_pCallback.reset(0);

      AddFlags(ParserToken::flVOLATILE);
      return *this;
    }

    //------------------------------------------------------------------------------
    /** \brief Make token a string token.

        String tokens are used to store the value of string function arguments. 
        \param a_strTok the string content.
        \post #m_iType==cmSTRING, #m_strTok==a_strTok
        \throw nothrow
    */
    ParserToken& SetString(const string_type &a_strTok)
    {
      m_iCode = cmSTRING;
      m_iType = tpSTR;
      m_iFlags = 0;
      m_iIdx = -1;

      m_pTok = 0;
      m_pCallback.reset(0);
        
      m_strTok = a_strTok;

      return *this;
    }

    //------------------------------------------------------------------------------
    /** \brief Set an index associated with the token related data. 
    
        In cmSTRFUNC - This is the index to a string table in the main parser.
        \param a_iIdx The index the string function result will take in the bytecode parser.
        \throw exception_type if #a_iIdx<0 or #m_iType!=cmSTRING
    */
    void SetIdx(int a_iIdx)
    {
      if (m_iCode!=cmSTRING || a_iIdx<0)
	      throw ParserError(ecINTERNAL_ERROR);
      
      m_iIdx = a_iIdx;
    }

    //------------------------------------------------------------------------------
    /** \brief Return Index associated with the token related data. 
    
        In cmSTRFUNC - This is the index to a string table in the main parser.

        \throw exception_type if #m_iIdx<0 or #m_iType!=cmSTRING
        \return The index the result will take in the Bytecode calculatin array (#m_iIdx).
    */
    int GetIdx() const
    {
      if (m_iIdx<0 || m_iCode!=cmSTRING )
        throw ParserError(ecINTERNAL_ERROR);

      return m_iIdx;
    }

    //------------------------------------------------------------------------------
    /** \brief Return the token type.
    
        \return #m_iType
        \throw nothrow
    */
    ECmdCode GetCode() const
    {
      if (m_pCallback.get())
      {
        return m_pCallback->GetCode();
      }
      else
      {
        return m_iCode;
      }
    }

    //------------------------------------------------------------------------------
    ETypeCode GetType() const
    {
      if (m_pCallback.get())
      {
        return m_pCallback->GetType();
      }
      else
      {
        return m_iType;
      }
    }
    
    //------------------------------------------------------------------------------
    int GetPri() const
    {
      if ( !m_pCallback.get())
	      throw ParserError(ecINTERNAL_ERROR);
          
      if ( m_pCallback->GetCode()!=cmOPRT_BIN && m_pCallback->GetCode()!=cmOPRT_INFIX)
	      throw ParserError(ecINTERNAL_ERROR);

      return m_pCallback->GetPri();
    }

    //------------------------------------------------------------------------------
    /** \brief Return the address of the callback function assoziated with
               function and operator tokens.

        \return The pointer stored in #m_pTok.
        \throw exception_type if token type is non of:
               <ul>
                 <li>cmFUNC</li>
                 <li>cmSTRFUNC</li>
                 <li>cmPOSTOP</li>
                 <li>cmINFIXOP</li>
                 <li>cmOPRT_BIN</li>
               </ul>
        \sa ECmdCode
    */
    void* GetFuncAddr() const
    {
      return (m_pCallback.get()) ? m_pCallback->GetAddr() : 0;
    }

    //------------------------------------------------------------------------------
    /** \biref Get value of the token.
      
        Only applicable to variable and value tokens.
        \throw exception_type if token is no value/variable token.
    */
    TBase GetVal() const
    {
      switch (m_iCode)
      {
        case cmVAL:  return m_fVal;
        case cmVAR:  return *((TBase*)m_pTok);
        default:     throw ParserError(ecVAL_EXPECTED);
      }
    }

    //------------------------------------------------------------------------------
    /** \brief Get address of a variable token.

      Valid only if m_iType==CmdVar.
      \throw exception_type if token is no variable token.
    */
    TBase* GetVar() const
    {
      if (m_iCode!=cmVAR)
	      throw ParserError(ecINTERNAL_ERROR);

      return (TBase*)m_pTok;
    }

    //------------------------------------------------------------------------------
    /** \brief Return the number of function arguments. 

      Valid only if m_iType==CmdFUNC.
    */
    int GetArgCount() const
    {
      assert(m_pCallback.get());

      if (!m_pCallback->GetAddr())
	      throw ParserError(ecINTERNAL_ERROR);

      return m_pCallback->GetArgc();
    }

    //------------------------------------------------------------------------------
    /** \brief Return the token identifier. 
        
        If #m_iType is cmSTRING the token identifier is the value of the string argument
        for a string function.
        \return #m_strTok
        \throw nothrow
        \sa m_strTok
    */
    const TString& GetAsString() const
    {
      return m_strTok;
    }
};

} // namespace mu

#endif