Annotation of parser3/src/types/pa_value.h, revision 1.137

1.22      paf         1: /** @file
1.110     paf         2:        Parser: Value, Method, Junction .
1.24      paf         3: 
1.131     misha       4:        Copyright (c) 2001-2009 ArtLebedev Group (http://www.artlebedev.com)
1.79      paf         5:        Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.1       paf         6: */
                      7: 
                      8: #ifndef PA_VALUE_H
                      9: #define PA_VALUE_H
1.87      paf        10: 
1.137   ! moko       11: static const char * const IDENT_VALUE_H="$Date: 2009-09-18 09:16:07 $";
1.1       paf        12: 
1.133     misha      13: #include "pa_common.h"
1.1       paf        14: #include "pa_array.h"
                     15: #include "pa_exception.h"
1.120     paf        16: #include "pa_property.h"
1.1       paf        17: 
1.99      paf        18: // forwards
                     19: 
1.9       paf        20: class VStateless_class;
1.1       paf        21: class WContext;
1.133     misha      22: class Request;
                     23: class Request_charsets;
1.17      paf        24: class Junction;
1.123     paf        25: class VJunction;
1.17      paf        26: class Method;
1.131     misha      27: class Value;
1.64      parser     28: class MethodParams;
1.93      paf        29: class VObject;
1.99      paf        30: class VMethodFrame;
1.110     paf        31: class VFile;
                     32: class Table;
1.133     misha      33: typedef Array<Value*> ArrayValue;
1.1       paf        34: 
1.31      paf        35: ///    grandfather of all @a values in @b Parser
1.110     paf        36: class Value: public PA_Object {
1.1       paf        37: public: // Value
                     38: 
1.106     paf        39:        /// value type, used for error reporting and 'is' expression operator
1.110     paf        40:        virtual const char* type() const =0;
1.89      paf        41: 
                     42:        /**
1.95      paf        43:                all except VObject/VClass: this if @atype eq type()
                     44:                VObject/VClass: can locate parent class by it's type
1.89      paf        45:        */
1.134     misha      46:        virtual Value* as(const char* atype) {
1.96      paf        47:                return atype && strcmp(type(), atype)==0?this:0;
1.89      paf        48:        }
1.97      paf        49:        /// type checking helper, uses Value::as
1.134     misha      50:        bool is(const char* atype) { return as(atype)!=0; }
1.59      parser     51:        
1.106     paf        52:        /// is this value defined?
1.38      paf        53:        virtual bool is_defined() const { return true; }
1.59      parser     54:        
1.106     paf        55:        /// is this value string?
1.38      paf        56:        virtual bool is_string() const { return false; }
1.124     paf        57: 
                     58:        /// is this value void?
                     59:        virtual bool is_void() const { return false; }
                     60: 
1.128     misha      61:        /// is this value bool?
                     62:        virtual bool is_bool() const { return false; }
                     63: 
1.124     paf        64:        /// is this value number?
1.126     paf        65:        virtual bool is_evaluated_expr() const { return false; }
1.124     paf        66: 
1.106     paf        67:        /// what's the meaning of this value in context of expression?
1.110     paf        68:        virtual Value& as_expr_result(bool /*return_string_as_is*/=false) {
1.112     paf        69:                return *bark("is '%s', can not be used in expression"); 
1.34      paf        70:        }
1.59      parser     71:        
1.110     paf        72:        
                     73: 
                     74:        /** extract HashStringValue if any
                     75:                WARNING: FOR LOCAL USE ONLY, THIS POINTER IS NOT TO PASS TO ANYBODY!
                     76:        */
                     77:        virtual HashStringValue* get_hash() { return 0; }
1.59      parser     78:        
1.106     paf        79:        /// extract const String
1.110     paf        80:        virtual const String* get_string() { return 0; }
1.136     misha      81: 
                     82:        virtual HashStringValue* get_fields() { return 0; }
1.59      parser     83:        
1.106     paf        84:        /// extract double
1.110     paf        85:        virtual double as_double() const { bark("is '%s', it does not have numerical (double) value"); return 0; }
1.59      parser     86:        
1.106     paf        87:        /// extract integer
1.110     paf        88:        virtual int as_int () const { bark("is '%s', it does not have numerical (int) value"); return 0; }
1.59      parser     89: 
1.106     paf        90:        /// extract bool
1.110     paf        91:        virtual bool as_bool() const { bark("is '%s', it does not have logical value"); return 0; }
1.59      parser     92:        
1.106     paf        93:        /// extract file
1.132     misha      94:        virtual VFile* as_vfile(String::Language lang, const Request_charsets* charsets=0);
1.59      parser     95:        
1.106     paf        96:        /// extract Junction
1.110     paf        97:        virtual Junction* get_junction();
1.59      parser     98:        
1.120     paf        99:        /// @return Value element; can return Junction for methods; Code-Junction for code; Getter-Junction for property
1.134     misha     100:        virtual Value* get_element(const String& /*aname*/);
1.92      paf       101: 
1.122     paf       102:        /// indicator value meaning that put_element overwritten something
1.123     paf       103:        #define PUT_ELEMENT_REPLACED_ELEMENT reinterpret_cast<const VJunction*>(1)
1.134     misha     104: 
1.106     paf       105:        /// store Value element under @a name
1.122     paf       106:        /// @returns putter method junction, or it can just report[PUT_ELEMENT_REPLACED_ELEMENT] 
                    107:        /// that it replaced something in base fields 
1.134     misha     108:        virtual const VJunction* put_element(const String& aname, Value* /*avalue*/, bool /*areplace*/) { 
1.65      parser    109:                // to prevent modification of system classes,
                    110:                // created at system startup, and not having exception
                    111:                // handler installed, we neet to bark using request.pool
1.112     paf       112:                bark("element can not be stored to %s", &aname); 
1.120     paf       113:                return 0;
1.65      parser    114:        }
1.137   ! moko      115: 
        !           116:        /// VObject default getter & setter support
        !           117:        virtual void enable_default_getter(){ }
        !           118:        virtual void enable_default_setter(){ }
        !           119:        virtual void disable_default_getter(){ }
        !           120:        virtual void disable_default_setter(){ }
        !           121:        virtual bool is_enabled_default_getter(){ return true; }
1.59      parser    122:        
1.106     paf       123:        /// extract VStateless_class
1.135     misha     124:        virtual VStateless_class* get_class()=0;
1.107     paf       125: 
1.135     misha     126:        /// extract base class, if any
                    127:        virtual VStateless_class* base() { return 0; }
1.32      paf       128: 
1.106     paf       129:        /// extract VTable
1.110     paf       130:        virtual Table* get_table() { return 0; }
1.1       paf       131: 
                    132: public: // usage
                    133: 
1.26      paf       134:        /// @return sure String. if it doesn't have string value barks
1.1       paf       135:        const String& as_string() {
1.110     paf       136:                const String* result=get_string(); 
1.1       paf       137:                if(!result)
1.110     paf       138:                        bark("is '%s', it has no string representation");
1.6       paf       139: 
1.1       paf       140:                return *result;
                    141:        }
                    142: 
1.6       paf       143: protected: 
1.1       paf       144: 
1.22      paf       145:        /// throws exception specifying bark-reason and name() type() of problematic value
1.112     paf       146:        Value* bark(const char *reason, const String *problem_source=0) const {
1.127     paf       147:                //if(this) // removing warnings on unreachable code
1.129     misha     148:                        throw Exception(PARSER_RUNTIME,
1.117     paf       149:                                problem_source, 
                    150:                                reason, type());
                    151: 
1.127     paf       152:                //return 0;
1.1       paf       153:        }
                    154: 
1.17      paf       155: };
1.110     paf       156:        
1.48      paf       157: 
                    158: /**
1.110     paf       159:        $content-type[text/html] -> 
                    160:                content-type: text/html
1.130     misha     161:        $content-type[$.value[text/html] $.charset[windows-1251]] -> 
1.110     paf       162:                content-type: text/html; charset=windows-1251
1.48      paf       163: */
1.110     paf       164: const String& attributed_meaning_to_string(Value& meaning, 
                    165:                                           String::Language lang, 
1.128     misha     166:                                           bool forced=false,
                    167:                                           bool allow_bool=false);
1.110     paf       168: 
                    169: // defines
                    170: 
                    171: ///@{common field names
                    172: #define CHARSET_NAME "charset"
                    173: #define VALUE_NAME "value"
1.114     paf       174: #define EXPIRES_NAME "expires"
1.110     paf       175: #define CONTENT_TYPE_NAME "content-type"
1.119     paf       176: #define NAME_NAME "name"
1.110     paf       177: //@}
                    178: 
                    179: ///@{common field names
                    180: extern const String value_name;
1.114     paf       181: extern const String expires_name;
1.110     paf       182: extern const String content_type_name;
                    183: extern const String name_name;
                    184: ///@}
1.1       paf       185: 
                    186: #endif

E-mail: