Annotation of parser3/src/types/pa_value.h, revision 1.109.2.2
1.22 paf 1: /** @file
1.24 paf 2: Parser: Value, Method, Junction class decls.
3:
1.109 paf 4: Copyright (c) 2001, 2003 ArtLebedev Group (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.109.2.2! paf 11: static const char* IDENT_VALUE_H="$Date: 2003/01/23 17:05:34 $";
1.1 paf 12:
13: #include "pa_pool.h"
14: #include "pa_string.h"
15: #include "pa_array.h"
16: #include "pa_exception.h"
1.109.2.2! paf 17: //#include "pa_globals.h"
1.1 paf 18:
1.99 paf 19: // forwards
20:
1.9 paf 21: class VStateless_class;
1.1 paf 22: class WContext;
23: class Request;
1.109.2.2! paf 24: class Table; typedef object_ptr<Table> TablePtr;
1.17 paf 25: class Junction;
1.109.2.2! paf 26: typedef object_ptr<Junction> JunctionPtr;
1.17 paf 27: class Method;
1.109.2.2! paf 28: template<typename K, typename V> class Hash;
! 29: class Value;
! 30: typedef object_ptr<Value> ValuePtr;
! 31: const ValuePtr ValuePtrZero(0);
! 32: typedef Hash<ConstStringPtr, ValuePtr> HashStringValue;
! 33: typedef object_ptr<HashStringValue> HashStringValuePtr;
1.42 paf 34: class VFile;
1.109.2.2! paf 35: typedef object_ptr<VFile> VFilePtr;
1.64 parser 36: class MethodParams;
1.93 paf 37: class VObject;
1.99 paf 38: class VMethodFrame;
1.1 paf 39:
1.31 paf 40: /// grandfather of all @a values in @b Parser
1.109.2.2! paf 41: class Value : public PA_Object {
1.1 paf 42: public: // Value
43:
1.106 paf 44: /// value type, used for error reporting and 'is' expression operator
1.1 paf 45: virtual const char *type() const =0;
1.89 paf 46:
1.91 paf 47: /** remember derived class instance
48: - VObject: the only client
49: */
1.93 paf 50: virtual VObject *set_derived(VObject * /*aderived*/) { return 0; }
1.91 paf 51:
1.89 paf 52: /**
1.95 paf 53: all except VObject/VClass: this if @atype eq type()
54: VObject/VClass: can locate parent class by it's type
1.89 paf 55: */
1.109.2.2! paf 56: virtual ValuePtr as(const char *atype, bool looking_up) {
1.96 paf 57: return atype && strcmp(type(), atype)==0?this:0;
1.89 paf 58: }
1.97 paf 59: /// type checking helper, uses Value::as
60: bool is(const char *atype) { return as(atype, false)!=0; }
1.59 parser 61:
1.106 paf 62: /// is this value defined?
1.38 paf 63: virtual bool is_defined() const { return true; }
1.59 parser 64:
1.106 paf 65: /// is this value string?
1.38 paf 66: virtual bool is_string() const { return false; }
1.59 parser 67:
1.106 paf 68: /// what's the meaning of this value in context of expression?
1.109.2.2! paf 69: virtual ValuePtr as_expr_result(bool /*return_string_as_is*/=false) {
1.34 paf 70: bark("(%s) can not be used in expression"); return 0;
71: }
1.59 parser 72:
1.109.2.2! paf 73: /// extract HashStringValue
! 74: virtual HashStringValuePtr get_hash(ConstStringPtr /*source*/) { return 0; }
1.59 parser 75:
1.106 paf 76: /// extract const String
1.109.2.2! paf 77: virtual ConstStringPtr get_string(Pool& /*pool*/) { return ConstStringPtrZero; }
1.59 parser 78:
1.106 paf 79: /// extract double
1.72 parser 80: virtual double as_double() const { bark("(%s) does not have numerical (double) value"); return 0; }
1.59 parser 81:
1.106 paf 82: /// extract integer
1.72 parser 83: virtual int as_int () const { bark("(%s) does not have numerical (int) value"); return 0; }
1.59 parser 84:
1.106 paf 85: /// extract bool
1.72 parser 86: virtual bool as_bool() const { bark("(%s) does not have logical value"); return 0; }
1.59 parser 87:
1.106 paf 88: /// extract file
1.109.2.2! paf 89: virtual VFilePtr as_vfile(String::Untaint_lang /*lang*/=String::UL_UNSPECIFIED,
1.75 parser 90: bool /*origins_mode*/=false) {
1.42 paf 91: bark("(%s) does not have file value"); return 0;
92: }
1.59 parser 93:
1.106 paf 94: /// extract Junction
1.109.2.2! paf 95: virtual JunctionPtr get_junction() { return 0; }
1.59 parser 96:
1.93 paf 97: /** extract base object of Value
98: @return for
99: - VObject: fbase
100: */
1.109.2.2! paf 101: virtual ValuePtr base_object() { bark("(%s) has no base object"); return 0; }
1.93 paf 102:
1.106 paf 103: /// extract Value element
1.109.2.2! paf 104: virtual ValuePtr get_element(ConstStringPtr /*aname*/, Value& /*aself*/, bool /*looking_up*/) { bark("(%s) has no elements"); return 0; }
1.92 paf 105:
1.106 paf 106: /// store Value element under @a name
1.109.2.2! paf 107: virtual bool put_element(ConstStringPtr name, ValuePtr /*value*/, bool /*replace*/) {
1.65 parser 108: // to prevent modification of system classes,
109: // created at system startup, and not having exception
110: // handler installed, we neet to bark using request.pool
111: bark("(%s) does not accept elements",
1.109.2.2! paf 112: "element can not be stored to %s", name);
1.93 paf 113: return false;
1.65 parser 114: }
1.59 parser 115:
1.106 paf 116: /// extract VStateless_class
1.85 paf 117: virtual VStateless_class *get_class()=0;
1.107 paf 118:
119: /// extract VStateless_class
120: virtual VStateless_class *get_last_derived_class() {
121: return get_class();
122: };
1.108 paf 123: /// extract base object or class of Value, if any
124: virtual Value *base() { bark("(%s) has can not have base"); return 0; }
1.32 paf 125:
1.106 paf 126: /// extract VTable
1.109.2.2! paf 127: virtual TablePtr get_table() { return 0; }
1.1 paf 128:
129: public: // usage
130:
1.26 paf 131: /// @return sure String. if it doesn't have string value barks
1.109.2.2! paf 132: ConstStringPtr as_string(Pool& pool) {
! 133: ConstStringPtr result=get_string(pool);
! 134: if(!result.get())
1.35 paf 135: bark("(%s) has no string representation");
1.6 paf 136:
1.109.2.2! paf 137: return result;
1.1 paf 138: }
139:
1.6 paf 140: protected:
1.1 paf 141:
1.22 paf 142: /// throws exception specifying bark-reason and name() type() of problematic value
1.65 parser 143: void bark(char *reason,
1.109.2.2! paf 144: const char *alt_reason=0, ConstStringPtr problem_source=Exception::undefined_source) const {
1.80 paf 145: throw Exception("parser.runtime",
1.84 paf 146: problem_source,
147: alt_reason?alt_reason:reason, type());
1.1 paf 148: }
149:
1.17 paf 150: };
151:
1.23 paf 152: /** \b junction is some code joined with context of it's evaluation.
1.22 paf 153:
154: there are code-junctions and method-junctions
155: - code-junctions are used when some parameter passed in cury brackets
156: - method-junctions used in ^method[] calls or $method references
1.99 paf 157:
158: Junctions register themselves in method_frame [if any] for consequent invalidation.
159: This prevents evaluation of junctions in outdated context
160:
161: To stop situations like this:
162: @code
163: @main[]
164: ^method1[]
165: ^method2[]
166:
167: @method1[]
168: $junction{
169: some code
170: }
171:
172: @method2[]
173: ^junction[]
174: @endcode
175:
1.101 paf 176: On wcontext[most dynamic context of all] scope exit (WContext::~WContext()) got cleaned -
177: Junction::wcontext becomes WContext.fparent (if any),
178: or Junction::method_frame becomes 0 (if no parent), which later in Request::process triggers exception
179:
180: parent changing helps ^switch implementation to remain simple
1.22 paf 181: */
1.109.2.2! paf 182: class Junction: public PA_Object {
1.17 paf 183: public:
184:
1.109.2.2! paf 185: Junction(
1.104 paf 186: Value& aself,
1.103 paf 187: const Method *amethod,
1.99 paf 188: VMethodFrame *amethod_frame,
1.109.2.2! paf 189: ValuePtr arcontext,
1.17 paf 190: WContext *awcontext,
1.99 paf 191: const Array *acode);
1.81 paf 192:
1.100 paf 193: void reattach(WContext *new_wcontext);
1.17 paf 194:
1.105 paf 195: /// always present
1.104 paf 196: Value& self;
1.22 paf 197: //@{
198: /// @name either these // so called 'method-junction'
1.103 paf 199: const Method *method;
1.22 paf 200: //@}
201: //@{
202: /// @name or these are present // so called 'code-junction'
1.99 paf 203: VMethodFrame *method_frame;
1.109.2.2! paf 204: ValuePtr rcontext;
1.17 paf 205: WContext *wcontext;
206: const Array *code;
1.22 paf 207: //@}
1.48 paf 208: };
209:
210: /**
211: native code method
212: params can be NULL when
1.53 paf 213: method min&max params (see VStateless_class::add_native_method)
1.48 paf 214: counts are zero.
215: */
1.39 paf 216: typedef void (*Native_code_ptr)(Request& request,
1.109.2.2! paf 217: ConstStringPtr method_name,
1.48 paf 218: MethodParams *params);
1.39 paf 219:
1.23 paf 220: /**
1.22 paf 221: class method.
222:
223: methods can have
224: - named or
225: - numbered parameters
226:
227: methods can be
228: - parser or
229: - native onces
230:
1.40 paf 231: holds
1.22 paf 232: - parameter names or number limits
233: - local names
234: - code [parser or native]
235: */
1.109.2.2! paf 236: class Method: public PA_Object {
1.17 paf 237: public:
1.39 paf 238:
1.41 paf 239: /// allowed method call types
1.39 paf 240: enum Call_type {
1.41 paf 241: CT_ANY, ///< method can be called either statically or dynamically
242: CT_STATIC, ///< method can be called only statically
243: CT_DYNAMIC ///< method can be called only dynamically
1.39 paf 244: };
245:
246: /// name for error reporting
1.109.2.2! paf 247: ConstStringPtr name;
1.39 paf 248: ///
249: Call_type call_type;
1.22 paf 250: //@{
251: /// @name either numbered params // for native-code methods = operators
1.17 paf 252: int min_numbered_params_count, max_numbered_params_count;
1.22 paf 253: //@}
254: //@{
255: /// @name or named params&locals // for parser-code methods
1.17 paf 256: Array *params_names; Array *locals_names;
1.22 paf 257: //@}
258: //@{
259: /// @name the Code
1.17 paf 260: const Array *parser_code;/*OR*/Native_code_ptr native_code;
1.22 paf 261: //@}
1.17 paf 262:
263: Method(
264: Pool& apool,
1.109.2.2! paf 265: ConstStringPtr aname,
1.39 paf 266: Call_type call_type,
1.17 paf 267: int amin_numbered_params_count, int amax_numbered_params_count,
268: Array *aparams_names, Array *alocals_names,
269: const Array *aparser_code, Native_code_ptr anative_code) :
270:
271: name(aname),
1.39 paf 272: call_type(call_type),
1.17 paf 273: min_numbered_params_count(amin_numbered_params_count),
274: max_numbered_params_count(amax_numbered_params_count),
275: params_names(aparams_names), locals_names(alocals_names),
276: parser_code(aparser_code), native_code(anative_code) {
277: }
278:
1.22 paf 279: /// call this before invoking to ensure proper actual numbered params count
1.75 parser 280: void check_actual_numbered_params(
1.109.2.2! paf 281: Value& self, ConstStringPtr actual_name, Array *actual_numbered_params) const;
1.86 paf 282: };
283:
284: /// Auto-object used for temporarily substituting/removing elements
285: class Temp_value_element {
286: Value& fwhere;
1.109.2.2! paf 287: ConstStringPtr fname;
! 288: ValuePtr saved;
1.86 paf 289: public:
1.109.2.2! paf 290: Temp_value_element(Value& awhere, ConstStringPtr aname, ValuePtr awhat) :
1.86 paf 291: fwhere(awhere),
292: fname(aname),
1.108 paf 293: saved(awhere.get_element(aname, awhere, false)) {
1.93 paf 294: fwhere.put_element(aname, awhat, false);
1.86 paf 295: }
296: ~Temp_value_element() {
1.93 paf 297: fwhere.put_element(fname, saved, false);
1.86 paf 298: }
1.1 paf 299: };
1.109.2.1 paf 300:
301: /**
302: $content-type[text/html] ->
303: content-type: text/html
304: $content-type[$value[text/html] charset[windows-1251]] ->
305: content-type: text/html; charset=windows-1251
306: */
1.109.2.2! paf 307: ConstStringPtr attributed_meaning_to_string(ValuePtr meaning, String::Untaint_lang lang, bool forced);
1.1 paf 308:
309: #endif
E-mail: