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