value.h

/* Swinder - Portable library for spreadsheet 
   Copyright (C) 2003 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, or (at your option) any later version.
   
   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 SWINDER_VALUE_H
#define SWINDER_VALUE_H
 
#include <iostream>
#include "ustring.h"
 
namespace Swinder
{
 
class ValueData;
 
 

 
class Value
{
 
  public:
 
    typedef enum {
      Empty,
      Boolean,
      Integer,
      Float,
      String,
      CellRange, // not used yet
      Array,     // not used yet
      Error
    } Type;

    Value();

    Value( Type _type );

    virtual ~Value();

    Value( const Value& _value );

    Value& operator= ( const Value& _value );

    Value& assign( const Value& _value );

    Value( bool b );

    Value( int i );

    Value( double f );

    Value( const UString& s );

    Type type() const;

    bool isEmpty() const { return type() == Empty; }

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

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

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

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

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

    bool isError() const { return type() == Error; }
 
    void setValue( const Value& v );

    void setValue( bool b );

    void setValue( int i );

    void setValue( double f );

    void setValue( const UString& s );

    void setError( const UString& msg );

    bool asBoolean() const;

    int asInteger() const;

    double asFloat() const;

    UString asString() const;

    UString errorMessage() const;

    void detach();

    static const Value& empty();

    static const Value& errorDIV0();

    static const Value& errorNA();

    static const Value& errorNAME();

    static const Value& errorNUM();

    static const Value& errorNULL();

    static const Value& errorREF();

    static const Value& errorVALUE();
 
  protected:
 
    ValueData* d; // can't never be 0
};

std::ostream& operator<<( std::ostream& s, Value value );
 
} // namespace Swinder
 
#endif // SWINDER_VALUE_H