Annotation of parser3/src/types/pa_value.h, revision 1.171
1.22 paf 1: /** @file
1.110 paf 2: Parser: Value, Method, Junction .
1.24 paf 3:
1.169 moko 4: Copyright (c) 2001-2023 Art. Lebedev Studio (http://www.artlebedev.com)
5: Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.1 paf 6: */
7:
8: #ifndef PA_VALUE_H
9: #define PA_VALUE_H
1.87 paf 10:
1.171 ! moko 11: #define IDENT_PA_VALUE_H "$Id: pa_value.h,v 1.170 2024/09/10 19:09:56 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.157 moko 17: #include "pa_opcode.h"
1.1 paf 18:
1.99 paf 19: // forwards
20:
1.9 paf 21: class VStateless_class;
1.1 paf 22: class WContext;
1.133 misha 23: class Request;
24: class Request_charsets;
1.17 paf 25: class Junction;
1.123 paf 26: class VJunction;
1.17 paf 27: class Method;
1.131 misha 28: class Value;
1.64 parser 29: class MethodParams;
1.93 paf 30: class VObject;
1.99 paf 31: class VMethodFrame;
1.110 paf 32: class VFile;
33: class Table;
1.143 misha 34: struct XDocOutputOptions;
1.133 misha 35: typedef Array<Value*> ArrayValue;
1.1 paf 36:
1.165 moko 37: struct Json_options : public PA_Allocated {
1.139 misha 38: Request* r;
1.149 moko 39: String::Body key;
1.139 misha 40: HashStringValue* methods;
1.149 moko 41: Value* default_method;
1.139 misha 42: Value* params;
43: bool skip_unknown;
1.162 moko 44: bool one_line;
1.150 moko 45: uint json_string_recoursion;
1.141 moko 46: const char* indent;
1.143 misha 47: XDocOutputOptions* xdoc_options;
1.156 moko 48: enum Date { D_SQL, D_GMT, D_ISO, D_TIMESTAMP } date;
1.142 moko 49: enum Table { T_ARRAY, T_OBJECT, T_COMPACT } table;
1.170 moko 50: enum Array { A_ARRAY, A_OBJECT, A_COMPACT } array;
1.139 misha 51: enum File { F_BODYLESS, F_BASE64, F_TEXT } file;
1.153 misha 52: enum Void { V_NULL, V_STRING } fvoid;
1.139 misha 53:
1.149 moko 54: Json_options(Request* arequest):
1.139 misha 55: r(arequest),
56: methods(NULL),
1.149 moko 57: default_method(NULL),
1.139 misha 58: params(NULL),
59: skip_unknown(false),
1.162 moko 60: one_line(false),
1.150 moko 61: json_string_recoursion(0),
1.140 moko 62: indent(NULL),
1.161 moko 63: xdoc_options(NULL),
1.139 misha 64: date(D_SQL),
65: table(T_OBJECT),
1.170 moko 66: array(A_COMPACT),
1.153 misha 67: file(F_BODYLESS),
68: fvoid(V_NULL)
1.139 misha 69: {}
70:
71: bool set_date_format(const String &value){
1.156 moko 72: if(value == "sql-string") date = D_SQL;
73: else if (value == "gmt-string") date = D_GMT;
74: else if (value == "iso-string") date = D_ISO;
1.139 misha 75: else if (value == "unix-timestamp") date = D_TIMESTAMP;
76: else return false;
77: return true;
78: }
79:
80: bool set_table_format(const String &value){
81: if(value == "array") table = T_ARRAY;
82: else if (value == "object") table = T_OBJECT;
1.142 moko 83: else if (value == "compact") table = T_COMPACT;
1.139 misha 84: else return false;
85: return true;
86: }
87:
1.170 moko 88: bool set_array_format(const String &value){
89: if(value == "array") array = A_ARRAY;
90: else if (value == "object") array = A_OBJECT;
91: else if (value == "compact") array = A_COMPACT;
92: else return false;
93: return true;
94: }
95:
1.139 misha 96: bool set_file_format(const String &value){
97: if(value == "base64") file = F_BASE64;
98: else if (value == "text") file = F_TEXT;
1.148 misha 99: else if (value == "stat") file = F_BODYLESS;
1.139 misha 100: else return false;
101: return true;
102: }
1.149 moko 103:
1.153 misha 104: bool set_void_format(const String &value){
105: if(value == "null") fvoid = V_NULL;
106: else if(value == "string") fvoid = V_STRING;
107: else return false;
108: return true;
109: }
110:
1.155 moko 111: const String* hash_json_string(HashStringValue *hash);
1.170 moko 112: const String* array_json_string(ArrayValue *array);
113: const String* array_compact_json_string(ArrayValue *array);
1.139 misha 114: };
115:
1.31 paf 116: /// grandfather of all @a values in @b Parser
1.110 paf 117: class Value: public PA_Object {
1.1 paf 118: public: // Value
119:
1.106 paf 120: /// value type, used for error reporting and 'is' expression operator
1.110 paf 121: virtual const char* type() const =0;
1.89 paf 122:
123: /**
1.171 ! moko 124: all except VObject/VClass: true if @atype eq type()
1.95 paf 125: VObject/VClass: can locate parent class by it's type
1.89 paf 126: */
1.171 ! moko 127: virtual bool is(const char* atype) { return atype && strcmp(type(), atype)==0; }
1.164 moko 128:
1.106 paf 129: /// is this value defined?
1.38 paf 130: virtual bool is_defined() const { return true; }
1.164 moko 131:
1.106 paf 132: /// is this value string?
1.38 paf 133: virtual bool is_string() const { return false; }
1.124 paf 134:
135: /// is this value void?
136: virtual bool is_void() const { return false; }
137:
1.128 misha 138: /// is this value bool?
139: virtual bool is_bool() const { return false; }
140:
1.124 paf 141: /// is this value number?
1.126 paf 142: virtual bool is_evaluated_expr() const { return false; }
1.124 paf 143:
1.106 paf 144: /// what's the meaning of this value in context of expression?
1.147 moko 145: virtual Value& as_expr_result() {
1.112 paf 146: return *bark("is '%s', can not be used in expression");
1.34 paf 147: }
1.110 paf 148:
149: /** extract HashStringValue if any
150: WARNING: FOR LOCAL USE ONLY, THIS POINTER IS NOT TO PASS TO ANYBODY!
151: */
152: virtual HashStringValue* get_hash() { return 0; }
1.164 moko 153:
1.106 paf 154: /// extract const String
1.110 paf 155: virtual const String* get_string() { return 0; }
1.136 misha 156:
1.139 misha 157: /// extract json-string
1.149 moko 158: virtual const String* get_json_string(Json_options& options);
1.154 misha 159: const String* default_method_2_json_string(Value& default_method, Json_options& options);
1.139 misha 160:
1.164 moko 161: /// for reflection
1.136 misha 162: virtual HashStringValue* get_fields() { return 0; }
1.159 moko 163: virtual HashStringValue* get_fields_reference() { return 0; }
1.164 moko 164:
1.106 paf 165: /// extract double
1.110 paf 166: virtual double as_double() const { bark("is '%s', it does not have numerical (double) value"); return 0; }
1.164 moko 167:
1.106 paf 168: /// extract integer
1.110 paf 169: virtual int as_int () const { bark("is '%s', it does not have numerical (int) value"); return 0; }
1.59 parser 170:
1.106 paf 171: /// extract bool
1.110 paf 172: virtual bool as_bool() const { bark("is '%s', it does not have logical value"); return 0; }
1.164 moko 173:
1.106 paf 174: /// extract file
1.168 moko 175: virtual VFile* as_vfile();
176: virtual VFile* as_vfile(String::Language /*lang*/, const Request_charsets* /*charsets*/) { return as_vfile(); }
1.164 moko 177:
1.106 paf 178: /// extract Junction
1.110 paf 179: virtual Junction* get_junction();
1.164 moko 180:
1.120 paf 181: /// @return Value element; can return Junction for methods; Code-Junction for code; Getter-Junction for property
1.134 misha 182: virtual Value* get_element(const String& /*aname*/);
1.92 paf 183:
1.157 moko 184: #ifdef FEATURE_GET_ELEMENT4CALL
185: /// same as get_element, but methods have higher priority in table and hash
186: virtual Value* get_element4call(const String& aname){
187: return get_element(aname);
188: }
189: #endif
190:
1.106 paf 191: /// store Value element under @a name
1.166 moko 192: /// @returns putter method junction, or 0
1.151 moko 193: virtual const VJunction* put_element(const String& aname, Value* /*avalue*/) {
1.65 parser 194: // to prevent modification of system classes,
195: // created at system startup, and not having exception
196: // handler installed, we neet to bark using request.pool
1.112 paf 197: bark("element can not be stored to %s", &aname);
1.120 paf 198: return 0;
1.65 parser 199: }
1.137 moko 200:
201: /// VObject default getter & setter support
202: virtual void enable_default_getter(){ }
203: virtual void enable_default_setter(){ }
204: virtual void disable_default_getter(){ }
205: virtual void disable_default_setter(){ }
206: virtual bool is_enabled_default_getter(){ return true; }
1.152 moko 207: virtual bool is_enabled_default_setter(){ return true; }
1.164 moko 208:
1.106 paf 209: /// extract VStateless_class
1.135 misha 210: virtual VStateless_class* get_class()=0;
1.107 paf 211:
1.135 misha 212: /// extract base class, if any
213: virtual VStateless_class* base() { return 0; }
1.32 paf 214:
1.106 paf 215: /// extract VTable
1.110 paf 216: virtual Table* get_table() { return 0; }
1.1 paf 217:
1.164 moko 218: /// warning war, no overhead as destructors are called manually only when required
219: virtual ~Value() {}
220:
1.1 paf 221: public: // usage
222:
1.160 moko 223: /// @return sure String or barks if it doesn't have string value
1.1 paf 224: const String& as_string() {
1.160 moko 225: const String* result=get_string();
1.1 paf 226: if(!result)
1.110 paf 227: bark("is '%s', it has no string representation");
1.6 paf 228:
1.1 paf 229: return *result;
230: }
231:
1.160 moko 232: /// @return Hash or barks if it is not hash compatible
233: HashStringValue* as_hash(const char* name=0);
234:
1.22 paf 235: /// throws exception specifying bark-reason and name() type() of problematic value
1.112 paf 236: Value* bark(const char *reason, const String *problem_source=0) const {
1.166 moko 237: throw Exception(PARSER_RUNTIME, problem_source, reason, type());
1.1 paf 238: }
239:
1.17 paf 240: };
1.48 paf 241:
242: /**
1.164 moko 243: $content-type[text/html] ->
1.110 paf 244: content-type: text/html
1.164 moko 245: $content-type[$.value[text/html] $.charset[windows-1251]] ->
1.110 paf 246: content-type: text/html; charset=windows-1251
1.48 paf 247: */
1.164 moko 248: const String& attributed_meaning_to_string(Value& meaning, String::Language lang, bool forced=false, bool allow_bool=false);
1.110 paf 249:
250: // defines
251:
252: ///@{common field names
253: #define CHARSET_NAME "charset"
254: #define VALUE_NAME "value"
1.114 paf 255: #define EXPIRES_NAME "expires"
1.110 paf 256: #define CONTENT_TYPE_NAME "content-type"
1.119 paf 257: #define NAME_NAME "name"
1.110 paf 258: //@}
259:
260: ///@{common field names
261: extern const String value_name;
1.114 paf 262: extern const String expires_name;
1.110 paf 263: extern const String content_type_name;
264: extern const String name_name;
265: ///@}
1.1 paf 266:
267: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_value.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / types