YCPValue.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                                                                      |  
|                      __   __    ____ _____ ____                      |  
|                      \ \ / /_ _/ ___|_   _|___ \                     |  
|                       \ V / _` \___ \ | |   __) |                    |  
|                        | | (_| |___) || |  / __/                     |  
|                        |_|\__,_|____/ |_| |_____|                    |  
|                                                                      |  
|                               core system                            | 
|                                                        (C) SuSE GmbH |  
\----------------------------------------------------------------------/ 

   File:       YCPValue.h

   Authors:     Mathias Kettner <kettner@suse.de>
                Klaus Kaempf <kkaempf@suse.de>
   Maintainer:  Klaus Kaempf <kkaempf@suse.de>

/-*/
// -*- c++ -*-

#ifndef YCPValue_h
#define YCPValue_h

#define XREFDEBUG "Y2XREFDEBUG"

#include "YCPElement.h"

class bytecodeistream;

enum YCPValueType { 
    YT_VOID        = 0,
    YT_BOOLEAN     = 1,
    YT_INTEGER     = 2,
    YT_FLOAT       = 3,
    YT_STRING      = 4,
    YT_BYTEBLOCK   = 5,
    YT_PATH        = 6,
    YT_SYMBOL      = 7,
    YT_LIST        = 8,
    YT_TERM        = 9,
    YT_MAP         = 10,
    YT_CODE        = 11,        // YCode as YCPValue
    YT_RETURN      = 12,        // value of 'return;'
    YT_BREAK       = 13,        // value of 'break;'
    YT_ENTRY       = 14,        // just a placeholder for a SymbolEntry belonging to a function (i.e. foreach())
    YT_ERROR       = 15,        // error value, will cause trouble
    YT_REFERENCE   = 16,        // a reference to a variable
    YT_EXTERNAL    = 17         // a reference to an external data
};

enum YCPOrder {
    YO_LESS        = -1,
    YO_EQUAL       =  0,
    YO_GREATER     =  1
};

class YCPValueRep : public YCPElementRep
{
public:
    virtual YCPValueType valuetype() const = 0;

    const char * valuetype_str() const;

    bool isVoid() const;

    bool isBoolean() const;

    bool isInteger() const;

    bool isFloat() const;

    bool isString() const;

    bool isByteblock() const;

    bool isPath() const;

    bool isSymbol() const;

    bool isList() const;

    bool isTerm() const;

    bool isMap() const;

    bool isCode() const;

    bool isBreak() const;

    bool isReturn() const;

    bool isEntry() const;

    bool isReference() const;

    bool isExternal() const;

    YCPVoid asVoid() const;
    
    YCPBoolean asBoolean() const;

    YCPInteger asInteger() const;

    YCPFloat asFloat() const;

    YCPString asString() const;

    YCPByteblock asByteblock() const;

    YCPPath asPath() const;

    YCPSymbol asSymbol() const;

    YCPList asList() const;

    YCPTerm asTerm() const;

    YCPMap asMap() const;

    YCPCode asCode() const;

    YCPEntry asEntry() const;

    YCPReference asReference() const;

    YCPExternal asExternal() const;

    bool equal (const YCPValue&) const;

    YCPOrder compare(const YCPValue &v, bool rl = false) const;

    virtual std::ostream & toXml (std::ostream & str, int indent ) const = 0;
};


class YCPValue : public YCPElement
{
    DEF_COMMON(Value, Element);
public:
    YCPValue ();
};


// FIXME: remove this in the future
extern YCPValue YCPError ( string message, const YCPValue &ret = YCPNull ());

#endif   // YCPValue_h