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

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.133   ! misha      11: static const char * const IDENT_VALUE_H="$Date: 2009-07-07 05:48:24 $";
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: 
1.91      paf        42:        /** remember derived class instance 
                     43:            - VObject: the only client
                     44:        */
1.110     paf        45:        virtual VObject* set_derived(VObject* /*aderived*/);
1.91      paf        46: 
1.89      paf        47:        /**
1.95      paf        48:                all except VObject/VClass: this if @atype eq type()
                     49:                VObject/VClass: can locate parent class by it's type
1.89      paf        50:        */
1.111     paf        51:        virtual Value* as(const char* atype, bool /*looking_up*/) {
1.96      paf        52:                return atype && strcmp(type(), atype)==0?this:0;
1.89      paf        53:        }
1.97      paf        54:        /// type checking helper, uses Value::as
1.110     paf        55:        bool is(const char* atype) { return as(atype, false)!=0; }
1.59      parser     56:        
1.106     paf        57:        /// is this value defined?
1.38      paf        58:        virtual bool is_defined() const { return true; }
1.59      parser     59:        
1.106     paf        60:        /// is this value string?
1.38      paf        61:        virtual bool is_string() const { return false; }
1.124     paf        62: 
                     63:        /// is this value void?
                     64:        virtual bool is_void() const { return false; }
                     65: 
1.128     misha      66:        /// is this value bool?
                     67:        virtual bool is_bool() const { return false; }
                     68: 
1.124     paf        69:        /// is this value number?
1.126     paf        70:        virtual bool is_evaluated_expr() const { return false; }
1.124     paf        71: 
1.106     paf        72:        /// what's the meaning of this value in context of expression?
1.110     paf        73:        virtual Value& as_expr_result(bool /*return_string_as_is*/=false) {
1.112     paf        74:                return *bark("is '%s', can not be used in expression"); 
1.34      paf        75:        }
1.59      parser     76:        
1.110     paf        77:        
                     78: 
                     79:        /** extract HashStringValue if any
                     80:                WARNING: FOR LOCAL USE ONLY, THIS POINTER IS NOT TO PASS TO ANYBODY!
                     81:        */
                     82:        virtual HashStringValue* get_hash() { return 0; }
1.59      parser     83:        
1.106     paf        84:        /// extract const String
1.110     paf        85:        virtual const String* get_string() { return 0; }
1.59      parser     86:        
1.106     paf        87:        /// extract double
1.110     paf        88:        virtual double as_double() const { bark("is '%s', it does not have numerical (double) value"); return 0; }
1.59      parser     89:        
1.106     paf        90:        /// extract integer
1.110     paf        91:        virtual int as_int () const { bark("is '%s', it does not have numerical (int) value"); return 0; }
1.59      parser     92: 
1.106     paf        93:        /// extract bool
1.110     paf        94:        virtual bool as_bool() const { bark("is '%s', it does not have logical value"); return 0; }
1.59      parser     95:        
1.106     paf        96:        /// extract file
1.132     misha      97:        virtual VFile* as_vfile(String::Language lang, const Request_charsets* charsets=0);
1.59      parser     98:        
1.106     paf        99:        /// extract Junction
1.110     paf       100:        virtual Junction* get_junction();
1.59      parser    101:        
1.120     paf       102:        /// extract Property
                    103:        virtual Property* get_property() { return 0; }
                    104:        
1.93      paf       105:        /** extract base object of Value
                    106:                @return for
                    107:                - VObject: fbase
                    108:        */
1.110     paf       109:        virtual Value* base_object();
1.93      paf       110:        
1.120     paf       111:        /// @return Value element; can return Junction for methods; Code-Junction for code; Getter-Junction for property
1.110     paf       112:        virtual Value* get_element(const String& /*aname*/, Value& /*aself*/, bool /*looking_up*/);
1.92      paf       113: 
1.122     paf       114:        /// indicator value meaning that put_element overwritten something
1.123     paf       115:        #define PUT_ELEMENT_REPLACED_ELEMENT reinterpret_cast<const VJunction*>(1)
1.106     paf       116:        /// store Value element under @a name
1.122     paf       117:        /// @returns putter method junction, or it can just report[PUT_ELEMENT_REPLACED_ELEMENT] 
                    118:        /// that it replaced something in base fields 
1.123     paf       119:        virtual const VJunction* put_element(Value& /*aself*/, const String& aname, Value* /*avalue*/, bool /*areplace*/) { 
1.65      parser    120:                // to prevent modification of system classes,
                    121:                // created at system startup, and not having exception
                    122:                // handler installed, we neet to bark using request.pool
1.112     paf       123:                bark("element can not be stored to %s", &aname); 
1.120     paf       124:                return 0;
1.65      parser    125:        }
1.59      parser    126:        
1.106     paf       127:        /// extract VStateless_class
1.85      paf       128:        virtual VStateless_class *get_class()=0;
1.107     paf       129: 
                    130:        /// extract VStateless_class
                    131:        virtual VStateless_class *get_last_derived_class() {
                    132:                return get_class();
                    133:        };
1.108     paf       134:        /// extract base object or class of Value, if any
1.110     paf       135:        virtual Value* base() { return 0; }
1.32      paf       136: 
1.106     paf       137:        /// extract VTable
1.110     paf       138:        virtual Table* get_table() { return 0; }
1.1       paf       139: 
                    140: public: // usage
                    141: 
1.26      paf       142:        /// @return sure String. if it doesn't have string value barks
1.1       paf       143:        const String& as_string() {
1.110     paf       144:                const String* result=get_string(); 
1.1       paf       145:                if(!result)
1.110     paf       146:                        bark("is '%s', it has no string representation");
1.6       paf       147: 
1.1       paf       148:                return *result;
                    149:        }
                    150: 
1.6       paf       151: protected: 
1.1       paf       152: 
1.22      paf       153:        /// throws exception specifying bark-reason and name() type() of problematic value
1.112     paf       154:        Value* bark(const char *reason, const String *problem_source=0) const {
1.127     paf       155:                //if(this) // removing warnings on unreachable code
1.129     misha     156:                        throw Exception(PARSER_RUNTIME,
1.117     paf       157:                                problem_source, 
                    158:                                reason, type());
                    159: 
1.127     paf       160:                //return 0;
1.1       paf       161:        }
                    162: 
1.17      paf       163: };
1.110     paf       164:        
1.48      paf       165: 
                    166: /**
1.110     paf       167:        $content-type[text/html] -> 
                    168:                content-type: text/html
1.130     misha     169:        $content-type[$.value[text/html] $.charset[windows-1251]] -> 
1.110     paf       170:                content-type: text/html; charset=windows-1251
1.48      paf       171: */
1.110     paf       172: const String& attributed_meaning_to_string(Value& meaning, 
                    173:                                           String::Language lang, 
1.128     misha     174:                                           bool forced=false,
                    175:                                           bool allow_bool=false);
1.110     paf       176: 
                    177: // defines
                    178: 
                    179: ///@{common field names
                    180: #define CHARSET_NAME "charset"
                    181: #define VALUE_NAME "value"
1.114     paf       182: #define EXPIRES_NAME "expires"
1.110     paf       183: #define CONTENT_TYPE_NAME "content-type"
1.119     paf       184: #define NAME_NAME "name"
1.110     paf       185: //@}
                    186: 
                    187: ///@{common field names
                    188: extern const String value_name;
1.114     paf       189: extern const String expires_name;
1.110     paf       190: extern const String content_type_name;
                    191: extern const String name_name;
                    192: ///@}
1.1       paf       193: 
                    194: #endif

E-mail: