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

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

E-mail: