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