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

1.22      paf         1: /** @file
1.110   ! paf         2:        Parser: Value, Method, Junction .
1.24      paf         3: 
1.110   ! paf         4:        Copyright (c) 2001-2003 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.110   ! paf        11: static const char* IDENT_VALUE_H="$Date: 2003/04/21 07:32:23 $";
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;
        !            26: typedef Hash<const StringBody, Value*> HashStringValue; 
        !            27: typedef Hash<const StringBody, PA_Object*> HashStringObject;
        !            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.110   ! 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.59      parser     62:        
1.106     paf        63:        /// what's the meaning of this value in context of expression?
1.110   ! paf        64:        virtual Value& as_expr_result(bool /*return_string_as_is*/=false) {
        !            65:                bark("is '%s', can not be used in expression"); 
        !            66:                return *static_cast<Value*>(0); // never
1.34      paf        67:        }
1.59      parser     68:        
1.110   ! paf        69:        
        !            70: 
        !            71:        /** extract HashStringValue if any
        !            72:                WARNING: FOR LOCAL USE ONLY, THIS POINTER IS NOT TO PASS TO ANYBODY!
        !            73:        */
        !            74:        virtual HashStringValue* get_hash() { return 0; }
1.59      parser     75:        
1.106     paf        76:        /// extract const String
1.110   ! paf        77:        virtual const String* get_string() { return 0; }
1.59      parser     78:        
1.106     paf        79:        /// extract double
1.110   ! paf        80:        virtual double as_double() const { bark("is '%s', it does not have numerical (double) value"); return 0; }
1.59      parser     81:        
1.106     paf        82:        /// extract integer
1.110   ! paf        83:        virtual int as_int () const { bark("is '%s', it does not have numerical (int) value"); return 0; }
1.59      parser     84: 
1.106     paf        85:        /// extract bool
1.110   ! paf        86:        virtual bool as_bool() const { bark("is '%s', it does not have logical value"); return 0; }
1.59      parser     87:        
1.106     paf        88:        /// extract file
1.110   ! paf        89:        virtual VFile* as_vfile(String::Language lang=String::L_UNSPECIFIED, 
        !            90:                const Request_charsets* charsets=0);
1.59      parser     91:        
1.106     paf        92:        /// extract Junction
1.110   ! paf        93:        virtual Junction* get_junction();
1.59      parser     94:        
1.93      paf        95:        /** extract base object of Value
                     96:                @return for
                     97:                - VObject: fbase
                     98:        */
1.110   ! paf        99:        virtual Value* base_object();
1.93      paf       100:        
1.106     paf       101:        /// extract Value element
1.110   ! paf       102:        virtual Value* get_element(const String& /*aname*/, Value& /*aself*/, bool /*looking_up*/);
1.92      paf       103: 
1.106     paf       104:        /// store Value element under @a name
1.110   ! paf       105:        virtual bool put_element(const String& aname, Value* /*avalue*/, bool /*areplace*/) { 
1.65      parser    106:                // to prevent modification of system classes,
                    107:                // created at system startup, and not having exception
                    108:                // handler installed, we neet to bark using request.pool
1.110   ! paf       109:                bark("is '%s', it does not accept elements", 
        !           110:                        "element can not be stored to %s", &aname); 
1.93      paf       111:                return false;
1.65      parser    112:        }
1.59      parser    113:        
1.106     paf       114:        /// extract VStateless_class
1.85      paf       115:        virtual VStateless_class *get_class()=0;
1.107     paf       116: 
                    117:        /// extract VStateless_class
                    118:        virtual VStateless_class *get_last_derived_class() {
                    119:                return get_class();
                    120:        };
1.108     paf       121:        /// extract base object or class of Value, if any
1.110   ! paf       122:        virtual Value* base() { return 0; }
1.32      paf       123: 
1.106     paf       124:        /// extract VTable
1.110   ! paf       125:        virtual Table* get_table() { return 0; }
1.1       paf       126: 
                    127: public: // usage
                    128: 
1.26      paf       129:        /// @return sure String. if it doesn't have string value barks
1.1       paf       130:        const String& as_string() {
1.110   ! paf       131:                const String* result=get_string(); 
1.1       paf       132:                if(!result)
1.110   ! paf       133:                        bark("is '%s', it has no string representation");
1.6       paf       134: 
1.1       paf       135:                return *result;
                    136:        }
                    137: 
1.6       paf       138: protected: 
1.1       paf       139: 
1.22      paf       140:        /// throws exception specifying bark-reason and name() type() of problematic value
1.65      parser    141:        void bark(char *reason, 
1.110   ! paf       142:                const char* alt_reason=0, const String *problem_source=0) const {
1.80      paf       143:                throw Exception("parser.runtime",
1.84      paf       144:                        problem_source,
                    145:                        alt_reason?alt_reason:reason, type());
1.1       paf       146:        }
                    147: 
1.17      paf       148: };
1.110   ! paf       149:        
1.48      paf       150: 
                    151: /**
1.110   ! paf       152:        $content-type[text/html] -> 
        !           153:                content-type: text/html
        !           154:        $content-type[$value[text/html] charset[windows-1251]] -> 
        !           155:                content-type: text/html; charset=windows-1251
1.48      paf       156: */
1.110   ! paf       157: const String& attributed_meaning_to_string(Value& meaning, 
        !           158:                                           String::Language lang, 
        !           159:                                           bool forced=false);
        !           160: 
        !           161: // defines
        !           162: 
        !           163: ///@{common field names
        !           164: #define CHARSET_NAME "charset"
        !           165: #define VALUE_NAME "value"
        !           166: #define CONTENT_TYPE_NAME "content-type"
        !           167: //@}
        !           168: 
        !           169: ///@{common field names
        !           170: extern const String value_name;
        !           171: extern const String content_type_name;
        !           172: extern const String name_name;
        !           173: ///@}
1.1       paf       174: 
                    175: #endif

E-mail: