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

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

E-mail: