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