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

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.139   ! misha      11: static const char * const IDENT_VALUE_H="$Date: 2010-09-06 21:17:49 $";
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.139   ! misha      35: struct Json_options {
        !            36:        Request* r;
        !            37:        HashStringValue* methods;
        !            38:        Value* params;
        !            39:        bool skip_unknown;
        !            40:        enum Date { D_SQL, D_GMT, D_TIMESTAMP } date;
        !            41:        enum Table { T_ARRAY, T_OBJECT } table;
        !            42:        enum File { F_BODYLESS, F_BASE64, F_TEXT } file;
        !            43: 
        !            44:        Json_options(Request* arequest): 
        !            45:                r(arequest),
        !            46:                methods(NULL),
        !            47:                params(NULL),
        !            48:                skip_unknown(false),
        !            49:                date(D_SQL),
        !            50:                table(T_OBJECT),
        !            51:                file(F_BODYLESS)
        !            52:        {}
        !            53: 
        !            54:        bool set_date_format(const String &value){
        !            55:                if(value == "gmt-string") date = D_GMT;
        !            56:                else if (value == "sql-string") date = D_SQL;
        !            57:                else if (value == "unix-timestamp") date = D_TIMESTAMP;
        !            58:                else return false;
        !            59:                return true;
        !            60:        }
        !            61: 
        !            62:        bool set_table_format(const String &value){
        !            63:                if(value == "array") table = T_ARRAY;
        !            64:                else if (value == "object") table = T_OBJECT;
        !            65:                else return false;
        !            66:                return true;
        !            67:        }
        !            68: 
        !            69:        bool set_file_format(const String &value){
        !            70:                if(value == "base64") file = F_BASE64;
        !            71:                else if (value == "text") file = F_TEXT;
        !            72:                else return false;
        !            73:                return true;
        !            74:        }
        !            75: };
        !            76: 
1.31      paf        77: ///    grandfather of all @a values in @b Parser
1.110     paf        78: class Value: public PA_Object {
1.1       paf        79: public: // Value
                     80: 
1.106     paf        81:        /// value type, used for error reporting and 'is' expression operator
1.110     paf        82:        virtual const char* type() const =0;
1.89      paf        83: 
                     84:        /**
1.95      paf        85:                all except VObject/VClass: this if @atype eq type()
                     86:                VObject/VClass: can locate parent class by it's type
1.89      paf        87:        */
1.134     misha      88:        virtual Value* as(const char* atype) {
1.96      paf        89:                return atype && strcmp(type(), atype)==0?this:0;
1.89      paf        90:        }
1.97      paf        91:        /// type checking helper, uses Value::as
1.134     misha      92:        bool is(const char* atype) { return as(atype)!=0; }
1.59      parser     93:        
1.106     paf        94:        /// is this value defined?
1.38      paf        95:        virtual bool is_defined() const { return true; }
1.59      parser     96:        
1.106     paf        97:        /// is this value string?
1.38      paf        98:        virtual bool is_string() const { return false; }
1.124     paf        99: 
                    100:        /// is this value void?
                    101:        virtual bool is_void() const { return false; }
                    102: 
1.128     misha     103:        /// is this value bool?
                    104:        virtual bool is_bool() const { return false; }
                    105: 
1.124     paf       106:        /// is this value number?
1.126     paf       107:        virtual bool is_evaluated_expr() const { return false; }
1.124     paf       108: 
1.106     paf       109:        /// what's the meaning of this value in context of expression?
1.110     paf       110:        virtual Value& as_expr_result(bool /*return_string_as_is*/=false) {
1.112     paf       111:                return *bark("is '%s', can not be used in expression"); 
1.34      paf       112:        }
1.59      parser    113:        
1.110     paf       114:        
                    115: 
                    116:        /** extract HashStringValue if any
                    117:                WARNING: FOR LOCAL USE ONLY, THIS POINTER IS NOT TO PASS TO ANYBODY!
                    118:        */
                    119:        virtual HashStringValue* get_hash() { return 0; }
1.59      parser    120:        
1.106     paf       121:        /// extract const String
1.110     paf       122:        virtual const String* get_string() { return 0; }
1.136     misha     123: 
1.139   ! misha     124:        /// extract json-string
        !           125:        virtual const String* get_json_string(Json_options* options=0);
        !           126: 
1.136     misha     127:        virtual HashStringValue* get_fields() { return 0; }
1.59      parser    128:        
1.106     paf       129:        /// extract double
1.110     paf       130:        virtual double as_double() const { bark("is '%s', it does not have numerical (double) value"); return 0; }
1.59      parser    131:        
1.106     paf       132:        /// extract integer
1.110     paf       133:        virtual int as_int () const { bark("is '%s', it does not have numerical (int) value"); return 0; }
1.59      parser    134: 
1.106     paf       135:        /// extract bool
1.110     paf       136:        virtual bool as_bool() const { bark("is '%s', it does not have logical value"); return 0; }
1.59      parser    137:        
1.106     paf       138:        /// extract file
1.132     misha     139:        virtual VFile* as_vfile(String::Language lang, const Request_charsets* charsets=0);
1.59      parser    140:        
1.106     paf       141:        /// extract Junction
1.110     paf       142:        virtual Junction* get_junction();
1.59      parser    143:        
1.120     paf       144:        /// @return Value element; can return Junction for methods; Code-Junction for code; Getter-Junction for property
1.134     misha     145:        virtual Value* get_element(const String& /*aname*/);
1.92      paf       146: 
1.122     paf       147:        /// indicator value meaning that put_element overwritten something
1.123     paf       148:        #define PUT_ELEMENT_REPLACED_ELEMENT reinterpret_cast<const VJunction*>(1)
1.134     misha     149: 
1.106     paf       150:        /// store Value element under @a name
1.122     paf       151:        /// @returns putter method junction, or it can just report[PUT_ELEMENT_REPLACED_ELEMENT] 
                    152:        /// that it replaced something in base fields 
1.134     misha     153:        virtual const VJunction* put_element(const String& aname, Value* /*avalue*/, bool /*areplace*/) { 
1.65      parser    154:                // to prevent modification of system classes,
                    155:                // created at system startup, and not having exception
                    156:                // handler installed, we neet to bark using request.pool
1.112     paf       157:                bark("element can not be stored to %s", &aname); 
1.120     paf       158:                return 0;
1.65      parser    159:        }
1.137     moko      160: 
                    161:        /// VObject default getter & setter support
                    162:        virtual void enable_default_getter(){ }
                    163:        virtual void enable_default_setter(){ }
                    164:        virtual void disable_default_getter(){ }
                    165:        virtual void disable_default_setter(){ }
                    166:        virtual bool is_enabled_default_getter(){ return true; }
1.59      parser    167:        
1.106     paf       168:        /// extract VStateless_class
1.135     misha     169:        virtual VStateless_class* get_class()=0;
1.107     paf       170: 
1.135     misha     171:        /// extract base class, if any
                    172:        virtual VStateless_class* base() { return 0; }
1.32      paf       173: 
1.106     paf       174:        /// extract VTable
1.110     paf       175:        virtual Table* get_table() { return 0; }
1.1       paf       176: 
                    177: public: // usage
                    178: 
1.26      paf       179:        /// @return sure String. if it doesn't have string value barks
1.1       paf       180:        const String& as_string() {
1.110     paf       181:                const String* result=get_string(); 
1.1       paf       182:                if(!result)
1.110     paf       183:                        bark("is '%s', it has no string representation");
1.6       paf       184: 
1.1       paf       185:                return *result;
                    186:        }
                    187: 
1.22      paf       188:        /// throws exception specifying bark-reason and name() type() of problematic value
1.112     paf       189:        Value* bark(const char *reason, const String *problem_source=0) const {
1.127     paf       190:                //if(this) // removing warnings on unreachable code
1.129     misha     191:                        throw Exception(PARSER_RUNTIME,
1.117     paf       192:                                problem_source, 
                    193:                                reason, type());
                    194: 
1.127     paf       195:                //return 0;
1.1       paf       196:        }
                    197: 
1.17      paf       198: };
1.110     paf       199:        
1.48      paf       200: 
                    201: /**
1.110     paf       202:        $content-type[text/html] -> 
                    203:                content-type: text/html
1.130     misha     204:        $content-type[$.value[text/html] $.charset[windows-1251]] -> 
1.110     paf       205:                content-type: text/html; charset=windows-1251
1.48      paf       206: */
1.110     paf       207: const String& attributed_meaning_to_string(Value& meaning, 
                    208:                                           String::Language lang, 
1.128     misha     209:                                           bool forced=false,
                    210:                                           bool allow_bool=false);
1.110     paf       211: 
                    212: // defines
                    213: 
                    214: ///@{common field names
                    215: #define CHARSET_NAME "charset"
                    216: #define VALUE_NAME "value"
1.114     paf       217: #define EXPIRES_NAME "expires"
1.110     paf       218: #define CONTENT_TYPE_NAME "content-type"
1.119     paf       219: #define NAME_NAME "name"
1.110     paf       220: //@}
                    221: 
                    222: ///@{common field names
                    223: extern const String value_name;
1.114     paf       224: extern const String expires_name;
1.110     paf       225: extern const String content_type_name;
                    226: extern const String name_name;
                    227: ///@}
1.1       paf       228: 
                    229: #endif

E-mail: