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

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

E-mail: