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

1.22      paf         1: /** @file
1.110     paf         2:        Parser: Value, Method, Junction .
1.24      paf         3: 
1.119.6.1  paf         4:        Copyright (c) 2001-2005 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.119.6.4! paf        11: static const char * const IDENT_VALUE_H="$Date: 2005/11/21 09:47:35 $";
1.1       paf        12: 
                     13: #include "pa_string.h"
                     14: #include "pa_array.h"
                     15: #include "pa_exception.h"
                     16: 
1.99      paf        17: // forwards
                     18: 
1.9       paf        19: class VStateless_class;
1.1       paf        20: class WContext;
1.110     paf        21: class Request; class Request_charsets;
1.17      paf        22: class Junction;
                     23: class Method;
1.110     paf        24: template<typename K, typename V> class Hash;
                     25: class Value;
1.113     paf        26: typedef Hash<const String::Body, Value*> HashStringValue; 
                     27: typedef Hash<const String::Body, PA_Object*> HashStringObject;
1.110     paf        28: typedef Array<Value*> ArrayValue;
1.64      parser     29: class MethodParams;
1.93      paf        30: class VObject;
1.99      paf        31: class VMethodFrame;
1.110     paf        32: class VFile;
                     33: class Table;
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.119.6.2  paf        62: 
1.119.6.4! paf        63:        /// is this value void?
        !            64:        virtual bool is_void() const { return false; }
        !            65: 
1.119.6.2  paf        66:        /// is this value number?
1.119.6.3  paf        67:        virtual bool is_evaluated_expr() const { return false; }
1.119.6.2  paf        68: 
1.106     paf        69:        /// what's the meaning of this value in context of expression?
1.110     paf        70:        virtual Value& as_expr_result(bool /*return_string_as_is*/=false) {
1.112     paf        71:                return *bark("is '%s', can not be used in expression"); 
1.34      paf        72:        }
1.59      parser     73:        
1.110     paf        74:        
                     75: 
                     76:        /** extract HashStringValue if any
                     77:                WARNING: FOR LOCAL USE ONLY, THIS POINTER IS NOT TO PASS TO ANYBODY!
                     78:        */
                     79:        virtual HashStringValue* get_hash() { return 0; }
1.59      parser     80:        
1.106     paf        81:        /// extract const String
1.110     paf        82:        virtual const String* get_string() { 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.110     paf        94:        virtual VFile* as_vfile(String::Language lang=String::L_UNSPECIFIED, 
                     95:                const Request_charsets* charsets=0);
1.59      parser     96:        
1.106     paf        97:        /// extract Junction
1.110     paf        98:        virtual Junction* get_junction();
1.59      parser     99:        
1.93      paf       100:        /** extract base object of Value
                    101:                @return for
                    102:                - VObject: fbase
                    103:        */
1.110     paf       104:        virtual Value* base_object();
1.93      paf       105:        
1.106     paf       106:        /// extract Value element
1.110     paf       107:        virtual Value* get_element(const String& /*aname*/, Value& /*aself*/, bool /*looking_up*/);
1.92      paf       108: 
1.106     paf       109:        /// store Value element under @a name
1.110     paf       110:        virtual bool put_element(const String& aname, Value* /*avalue*/, bool /*areplace*/) { 
1.65      parser    111:                // to prevent modification of system classes,
                    112:                // created at system startup, and not having exception
                    113:                // handler installed, we neet to bark using request.pool
1.112     paf       114:                bark("element can not be stored to %s", &aname); 
1.93      paf       115:                return false;
1.65      parser    116:        }
1.59      parser    117:        
1.106     paf       118:        /// extract VStateless_class
1.85      paf       119:        virtual VStateless_class *get_class()=0;
1.107     paf       120: 
                    121:        /// extract VStateless_class
                    122:        virtual VStateless_class *get_last_derived_class() {
                    123:                return get_class();
                    124:        };
1.108     paf       125:        /// extract base object or class of Value, if any
1.110     paf       126:        virtual Value* base() { return 0; }
1.32      paf       127: 
1.106     paf       128:        /// extract VTable
1.110     paf       129:        virtual Table* get_table() { return 0; }
1.1       paf       130: 
                    131: public: // usage
                    132: 
1.26      paf       133:        /// @return sure String. if it doesn't have string value barks
1.1       paf       134:        const String& as_string() {
1.110     paf       135:                const String* result=get_string(); 
1.1       paf       136:                if(!result)
1.110     paf       137:                        bark("is '%s', it has no string representation");
1.6       paf       138: 
1.1       paf       139:                return *result;
                    140:        }
                    141: 
1.6       paf       142: protected: 
1.1       paf       143: 
1.22      paf       144:        /// throws exception specifying bark-reason and name() type() of problematic value
1.112     paf       145:        Value* bark(const char *reason, const String *problem_source=0) const {
1.117     paf       146:                if(this) // removing warnings on unreachable code
                    147:                        throw Exception("parser.runtime",
                    148:                                problem_source, 
                    149:                                reason, type());
                    150: 
                    151:                return 0;
1.1       paf       152:        }
                    153: 
1.17      paf       154: };
1.110     paf       155:        
1.48      paf       156: 
                    157: /**
1.110     paf       158:        $content-type[text/html] -> 
                    159:                content-type: text/html
                    160:        $content-type[$value[text/html] charset[windows-1251]] -> 
                    161:                content-type: text/html; charset=windows-1251
1.48      paf       162: */
1.110     paf       163: const String& attributed_meaning_to_string(Value& meaning, 
                    164:                                           String::Language lang, 
                    165:                                           bool forced=false);
                    166: 
                    167: // defines
                    168: 
                    169: ///@{common field names
                    170: #define CHARSET_NAME "charset"
                    171: #define VALUE_NAME "value"
1.114     paf       172: #define EXPIRES_NAME "expires"
1.110     paf       173: #define CONTENT_TYPE_NAME "content-type"
1.119     paf       174: #define NAME_NAME "name"
1.110     paf       175: //@}
                    176: 
                    177: ///@{common field names
                    178: extern const String value_name;
1.114     paf       179: extern const String expires_name;
1.110     paf       180: extern const String content_type_name;
                    181: extern const String name_name;
                    182: ///@}
1.1       paf       183: 
                    184: #endif

E-mail: