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

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

E-mail: