formula.h

/* This file is part of the KDE project
   Copyright (C) 2003,2004 Ariya Hidayat <ariya@kde.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#ifndef KSPREAD_FORMULA
#define KSPREAD_FORMULA
 
#include <tqstring.h>
#include <tqvaluevector.h>
 
class TDELocale;
 
namespace KSpread
{
class Cell;
class Sheet;
class Value;

class Token
{
  public:
    enum Type
    {
      Unknown = 0, 
      Boolean,     
      Integer,     
      Float,       
      String,      
      Operator,    
      Cell,        
      Range,       
      Identifier   
    };

    enum Op
    {
      InvalidOp = 0,  
      Plus,           
      Minus,          
      Asterisk,       
      Slash,          
      Caret,          
      LeftPar,        
      RightPar,       
      Comma,          
      Semicolon,      
      Ampersand,      
      Equal,          
      NotEqual,       
      Less,           
      Greater,        
      LessEqual,      
      GreaterEqual,   
      Percent         
    };

    Token( Type type = Unknown, const TQString& text = TQString(), int pos = -1 );
 
    static const Token null;
 
    Token( const Token& );
    Token& operator=( const Token& );

    Type type() const { return m_type; }

    TQString text() const { return m_text; }
 
    int pos() const { return m_pos; };

    bool isBoolean() const { return m_type == Boolean; }

    bool isInteger() const { return m_type == Integer; }

    bool isFloat() const { return m_type == Float; }

    bool isNumber() const { return (m_type == Integer) || (m_type == Float); }

    bool isString() const { return m_type == String; }

    bool isOperator() const { return m_type == Operator; }

    bool isCell() const { return m_type == Cell; }

    bool isRange() const { return m_type == Range; }

    bool isIdentifier() const { return m_type == Identifier; }

    bool asBoolean() const;

    long asInteger() const;

    double asFloat() const;

    TQString asString() const;

    Op asOperator() const;

    TQString sheetName() const;

    TQString description() const;
 
  protected:
 
    Type m_type;
    TQString m_text;
    int m_pos;
 
};

class Tokens: public TQValueVector<Token>
{
public:
  Tokens(): TQValueVector<Token>(), m_valid(true) {};
  bool valid() const { return m_valid; }
  void setValid( bool v ){ m_valid = v; }
protected:
  bool m_valid;
};
 

class Formula
{
  public:

    Formula (Sheet *sheet,  Cell *cell = 0);

    Formula();

    ~Formula();

    Sheet* sheet() const;
    Cell* cell() const;

    void setExpression( const TQString& expr );

    TQString expression() const;

    void clear();

    bool isValid() const;

    Tokens tokens() const;

    Value eval() const;

    Tokens scan( const TQString& expr, TDELocale* locale = 0 ) const;
 
    TQString dump() const;
 
  protected:
 
    void compile( const Tokens& tokens ) const;

    bool isNamedArea( const TQString& expr ) const;
 
  private:
    class Private;
    Private *d;
    // no copy or assign
    Formula( const Formula& );
    Formula& operator=( const Formula& );
};

TQTextStream& operator<<( TQTextStream& ts, Formula formula );
 

Token::Op matchOperator( const TQString& text );

bool isIdentifier( TQChar ch );
 
} // namespace KSpread
 
 
 
#endif // KSPREAD_FORMULA