YExpression.h

Go to the documentation of this file.

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

   File:        YExpression.h

   Author:      Klaus Kaempf <kkaempf@suse.de>
   Maintainer:  Klaus Kaempf <kkaempf@suse.de>

   This file defines the various 'expressions' in YCode

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

#ifndef YExpression_h
#define YExpression_h

#include <iosfwd>
#include <string>
using std::string;

#include "ycp/YCode.h"
#include "y2/Y2Function.h"

class Logger;

//---------------------------------------------------------

DEFINE_DERIVED_POINTER(YEVariable, YCode);
DEFINE_DERIVED_POINTER(YEReference, YCode);
DEFINE_DERIVED_POINTER(YETerm, YCode);
DEFINE_DERIVED_POINTER(YECompare, YCode);
DEFINE_DERIVED_POINTER(YELocale, YCode);
DEFINE_DERIVED_POINTER(YEList, YCode);
DEFINE_DERIVED_POINTER(YEMap, YCode);
DEFINE_DERIVED_POINTER(YEPropagate, YCode);
DEFINE_DERIVED_POINTER(YEUnary, YCode);
DEFINE_DERIVED_POINTER(YEBinary, YCode);
DEFINE_DERIVED_POINTER(YETriple, YCode);
DEFINE_DERIVED_POINTER(YEIs, YCode);
DEFINE_DERIVED_POINTER(YEReturn, YCode);
DEFINE_DERIVED_POINTER(YEBracket, YCode);
DEFINE_DERIVED_POINTER(YEBuiltin, YCode);
DEFINE_DERIVED_POINTER(YECall, YCode);
DEFINE_DERIVED_POINTER(YEFunction, YECall);
DEFINE_DERIVED_POINTER(YEFunctionPointer, YECall);

//---------------------------------------------------------
// variable ref (-> Block + position)

class YEVariable : public YCode
{
    REP_BODY(YEVariable);
    SymbolEntryPtr m_entry;
public:
    YEVariable (SymbolEntryPtr entry);
    YEVariable (bytecodeistream & str);
    ~YEVariable () {};
    virtual ykind kind () const { return yeVariable; }
    const char *name () const;
    SymbolEntryPtr entry () const;
    string toString () const;
    virtual bool isReferenceable () const { return true; }
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return m_entry->type(); }
};

//---------------------------------------------------------
// reference (-> Block + position)

class YEReference : public YCode
{
    REP_BODY(YEReference);
    SymbolEntryPtr m_entry;
public:
    YEReference (SymbolEntryPtr entry);
    YEReference (bytecodeistream & str);
    ~YEReference () {};
    virtual ykind kind () const { return yeReference; }
    const char *name () const;
    SymbolEntryPtr entry () const;
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const;
};

//---------------------------------------------------------
// Term (-> name, args)

class YETerm : public YCode
{
    REP_BODY(YETerm);
    const char *m_name;
    ycodelist_t *m_parameters;
public:
    YETerm (const char *name);
    YETerm (bytecodeistream & str);
    ~YETerm ();
    virtual ykind kind () const { return yeTerm; }
    // dummy is here just to make it similar to YEBuiltin and YEFunction
    constTypePtr attachParameter (YCodePtr code, constTypePtr dummy = Type::Unspec);
    string toString () const;
    const char *name () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return Type::Term; }
};


//---------------------------------------------------------
// Compare (-> arg1, arg2, type)

class YECompare : public YCode
{
    REP_BODY(YECompare);
public:
    enum cmp_op { C_NOT = 1, C_EQ = 2, C_LT = 4,        // base operations
                  C_NEQ = C_NOT|C_EQ,
                  C_LE =  C_EQ|C_LT,
                  C_GE =  C_NOT|C_LT,
                  C_GT =  C_NOT|C_EQ|C_LT
    };
    typedef cmp_op c_op;            
private:
    YCodePtr m_left;
    c_op m_op;
    YCodePtr m_right;
public:
    YECompare (YCodePtr left, c_op op, YCodePtr right);
    YECompare (bytecodeistream & str);
    ~YECompare ();
    virtual ykind kind () const { return yeCompare; }
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return Type::Boolean; }
};


//---------------------------------------------------------
// locale expression (-> singular, plural, count)

class YELocale : public YCode
{
    REP_BODY(YELocale);
    const char *m_singular;
    const char *m_plural;
    YCodePtr m_count;
    YLocale::t_uniquedomains::const_iterator m_domain;
public:
    YELocale (const char *singular, const char *plural, YCodePtr count, const char *textdomain);
    YELocale (bytecodeistream & str);
    ~YELocale ();
    virtual ykind kind () const { return yeLocale; }
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return Type::Locale; }
};


//---------------------------------------------------------
// list expression (-> value, next list value)

class YEList : public YCode
{
    REP_BODY(YEList);
    ycodelist_t *m_first;
public:
    YEList (YCodePtr code);
    YEList (bytecodeistream & str);
    ~YEList ();
    virtual ykind kind () const { return yeList; }
    void attach (YCodePtr element);
//    YCodePtr code () const;
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const;
    int count () const;
    YCodePtr value (int index) const;
};


//---------------------------------------------------------
// map expression (-> key, value, next key/value pair)

class YEMap : public YCode
{
    REP_BODY(YEMap);
    typedef struct mapval { YCodePtr key; YCodePtr value; struct mapval *next; } mapval_t;
    mapval_t *m_first;
public:
    YEMap (YCodePtr key, YCodePtr value);
    YEMap (bytecodeistream & str);
    ~YEMap ();
    virtual ykind kind () const { return yeMap; }
    void attach (YCodePtr key, YCodePtr value);
//    YCodePtr key () const;
//    YCodePtr value () const;
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const;
};


//---------------------------------------------------------
// propagation expression (-> value, from type, to type)

class YEPropagate : public YCode
{
    REP_BODY(YEPropagate);
    constTypePtr m_from;
    constTypePtr m_to;
    YCodePtr m_value;
public:
    YEPropagate (YCodePtr value, constTypePtr from, constTypePtr to);
    YEPropagate (bytecodeistream & str);
    ~YEPropagate ();
    virtual ykind kind () const { return yePropagate; }
    string toString () const;
    bool canPropagate(const YCPValue& value, constTypePtr to_type) const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return m_to; }
};


//---------------------------------------------------------
// unary expression (-> declaration_t, arg)

class YEUnary : public YCode
{
    REP_BODY(YEUnary);
    declaration_t *m_decl;
    YCodePtr m_arg;             // argument
public:
    YEUnary (declaration_t *decl, YCodePtr arg);                // expression
    YEUnary (bytecodeistream & str);
    ~YEUnary ();
    virtual ykind kind () const { return yeUnary; }
    declaration_t *decl () const;
//    YCodePtr arg () const;
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return ((constFunctionTypePtr)m_decl->type)->returnType (); }
};


//---------------------------------------------------------
// binary expression (-> declaration_t, arg1, arg2)

class YEBinary : public YCode
{
    REP_BODY(YEBinary);
    declaration_t *m_decl;
    YCodePtr m_arg1;            // argument1
    YCodePtr m_arg2;            // argument2
public:
    YEBinary (declaration_t *decl, YCodePtr arg1, YCodePtr arg2);
    YEBinary (bytecodeistream & str);
    ~YEBinary ();
    virtual ykind kind () const { return yeBinary; }
    declaration_t *decl ();
//    YCodePtr arg1 () const;
//    YCodePtr arg2 () const;
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const;
};


//---------------------------------------------------------
// Triple (? :) expression (-> bool expr, true value, false value)

class YETriple : public YCode
{
    REP_BODY(YETriple);
    YCodePtr m_expr;            // bool expr
    YCodePtr m_true;            // true value
    YCodePtr m_false;           // false value
public:
    YETriple (YCodePtr a_expr, YCodePtr a_true, YCodePtr a_false);
    YETriple (bytecodeistream & str);
    ~YETriple ();
    virtual ykind kind () const { return yeTriple; }
//    YCodePtr expr () const;
//    YCodePtr iftrue () const;
//    YCodePtr iffalse () const;
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return m_true->type ()->commontype (m_false->type ()); }
};


//---------------------------------------------------------
// is (-> expression, type)

class YEIs : public YCode
{
    REP_BODY(YEIs);
    YCodePtr m_expr;
    constTypePtr m_type;
public:
    YEIs (YCodePtr expr, constTypePtr type);
    YEIs (bytecodeistream & str);
    ~YEIs ();
    virtual ykind kind () const { return yeIs; }
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return Type::Boolean; }
};


//---------------------------------------------------------
// return (-> expression)

class YEReturn : public YCode
{
    REP_BODY(YEReturn);
    YCodePtr m_expr;
public:
    YEReturn (YCodePtr expr);
    YEReturn (bytecodeistream & str);
    ~YEReturn ();
    virtual ykind kind () const { return yeReturn; }
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return m_expr->type(); }
};


//---------------------------------------------------------
// bracket (-> expression)

class YEBracket : public YCode
{
    REP_BODY(YEBracket);
    YCodePtr m_var;             // (list, map) variable
    YCodePtr m_arg;             // bracket arguments
    YCodePtr m_def;             // default expression
    constTypePtr m_resultType;  // result type according to the parser
public:
    YEBracket (YCodePtr var, YCodePtr arg, YCodePtr def, constTypePtr resultType);
    YEBracket (bytecodeistream & str);
    ~YEBracket ();
    virtual ykind kind () const { return yeBracket; }
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const { return m_resultType; }
    YCodePtr def () const { return m_def; }
};


//---------------------------------------------------------
// Builtin ref (-> declaration_t, type, Args)

class YEBuiltin : public YCode
{
    REP_BODY(YEBuiltin);
    declaration_t *m_decl;
    constFunctionTypePtr m_type;

    // symbol parameters (NULL, if no symbolic parameters)
    YBlockPtr m_parameterblock;

    ycodelist_t *m_parameters;
public:
    YEBuiltin (declaration_t *decl, YBlockPtr parameterblock = 0, constTypePtr type = 0);
    YEBuiltin (bytecodeistream & str);
    ~YEBuiltin ();
    virtual ykind kind () const { return yeBuiltin; }
    declaration_t *decl () const;
    constTypePtr finalize (Logger* problem_logger);
    // check if m_parameterblock is really needed, drop if not
    void closeParameters ();
    // see YEFunction::attachParameter
    constTypePtr attachParameter (YCodePtr code, constTypePtr type = Type::Unspec);
    // attach symbolic variable parameter to function, return created TableEntry
    constTypePtr attachSymVariable (const char *name, constTypePtr type, unsigned int line, TableEntry *&tentry);
    string toString () const;
    YCPValue evaluate (bool cse = false);
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type () const;
    constTypePtr completeType () const;
    YBlockPtr parameterBlock () const;
};

//---------------------------------------------------------
// Function call - parameter handling common base 

class YECall : public YCode
{
    REP_BODY(YECall);
protected:
    TableEntry* m_entry;
    SymbolEntryPtr m_sentry;
    YCodePtr *m_parameters;
    constTypePtr *m_parameter_types;
    Y2Function* m_functioncall;
    
    uint m_next_param_id;
public:
    YECall (TableEntry* entry);
    YECall (bytecodeistream & str);
    ~YECall ();
    const SymbolEntryPtr entry () const;
    constTypePtr attachParameter (YCodePtr code, constTypePtr type);
    virtual constTypePtr finalize ();
    string toString () const;
    std::ostream & toStream (std::ostream & str) const;
    std::ostream & toXml (std::ostream & str, int indent ) const;
    constTypePtr type() const;
    string qualifiedName () const;
    
    static YECallPtr readCall (bytecodeistream & str);
};

//---------------------------------------------------------
// Function ref (-> SymbolEntry ( param, param, ...) )

class YEFunction : public YECall
{
    REP_BODY(YEFunction);
public:
    YEFunction (TableEntry* entry);
    YEFunction (bytecodeistream & str);
    virtual ykind kind () const { return yeFunction; }
    virtual YCPValue evaluate (bool cse = false);
    virtual constTypePtr finalize ();
};

//---------------------------------------------------------
// Function ref (-> SymbolEntry ( param, param, ...) )

class YEFunctionPointer : public YECall
{
    REP_BODY(YEFunctionPointer);
public:
    YEFunctionPointer (TableEntry* entry);
    YEFunctionPointer (bytecodeistream & str);
    virtual ykind kind () const { return yeFunctionPointer; }
    virtual YCPValue evaluate (bool cse = false);
};

//---------------------------------------------------------
// Function call for outer space (similar to YEFunction) ref (-> SymbolEntry ( param, param, ...) )

class Y2YCPFunction : public Y2Function
{
    YSymbolEntryPtr m_sentry;
    YCPValue* m_parameters;
public:
    Y2YCPFunction (YSymbolEntryPtr entry);
    ~Y2YCPFunction ();
    
    string qualifiedName () const;
    string name () const;

    // implementation of the Y2Function interface:

    virtual bool attachParameter (const YCPValue& arg, const int pos);
    virtual constTypePtr wantedParameterType () const;
    virtual bool appendParameter (const YCPValue& arg);
    virtual bool finishParameters ();
    virtual YCPValue evaluateCall ();
    virtual bool reset ();
};

#endif   // YExpression_h