Annotation of parser3/src/types/pa_vmethod_frame.h, revision 1.145
1.3 paf 1: /** @file
1.5 paf 2: Parser: @b method_frame write context
1.3 paf 3:
1.133 moko 4: Copyright (c) 2001-2024 Art. Lebedev Studio (http://www.artlebedev.com)
1.129 moko 5: Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.1 paf 6: */
7:
8: #ifndef PA_VMETHOD_FRAME_H
9: #define PA_VMETHOD_FRAME_H
1.28 paf 10:
1.145 ! moko 11: #define IDENT_PA_VMETHOD_FRAME_H "$Id: pa_vmethod_frame.h,v 1.144 2024/12/11 23:53:49 moko Exp $"
1.1 paf 12:
1.101 moko 13: #include "pa_symbols.h"
1.1 paf 14: #include "pa_wcontext.h"
1.12 parser 15: #include "pa_vvoid.h"
1.1 paf 16: #include "pa_vjunction.h"
17:
1.46 paf 18: // forwards
19:
20: class Request;
21:
22: /**
23: @b method parameters passed in this array.
24: contains handy typecast ad junction/not junction ensurers
1.114 moko 25: */
1.46 paf 26:
1.78 misha 27: class MethodParams {
1.46 paf 28: public:
1.130 moko 29: MethodParams() : felements(0), fsize(0) {}
1.78 misha 30:
1.82 misha 31: #ifdef USE_DESTRUCTORS
1.109 moko 32: ~MethodParams() {
1.82 misha 33: Value **flast=felements+count();
1.95 moko 34: for(Value **current=felements;current<flast;current++){
35: Junction* junction=(*current)->get_junction();
36: if (junction && junction->code)
1.111 moko 37: delete (VJunction*)(*current);
1.95 moko 38: }
1.82 misha 39: }
40: #endif
41:
1.109 moko 42: void store_params(Value **params, size_t count) {
1.78 misha 43: felements=params;
1.130 moko 44: fsize=count;
1.77 misha 45: }
46:
1.130 moko 47: inline size_t count() const { return fsize; }
1.78 misha 48:
1.108 moko 49: inline Value& get(size_t index) const {
1.78 misha 50: assert(index<count());
1.108 moko 51: return *felements[index];
1.78 misha 52: }
53:
1.108 moko 54: inline Value& operator[] (size_t index) { return get(index); }
1.46 paf 55:
56: /// handy is-value-a-junction ensurer
1.109 moko 57: Value& as_junction(int index, const char* msg) {
1.108 moko 58: Value& value=get(index);
1.110 moko 59: if(value.get_junction())
60: return value;
1.143 moko 61: throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d is '%s')", msg, 1+index, value.type());
1.46 paf 62: }
1.107 moko 63:
1.46 paf 64: /// handy value-is-not-a-junction ensurer
1.109 moko 65: Value& as_no_junction(int index, const char* msg) {
1.108 moko 66: Value& value=get(index);
1.110 moko 67: if(!value.get_junction())
68: return value;
1.143 moko 69: throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d is '%s')", msg, 1+index, value.type());
1.46 paf 70: }
1.107 moko 71:
1.62 misha 72: /// handy is-value-a-junction ensurer or can be auto-processed
1.109 moko 73: Value& as_expression(int index, const char* msg) {
1.108 moko 74: Value& value=get(index);
1.110 moko 75: if(value.is_evaluated_expr())
1.107 moko 76: return value;
1.110 moko 77: if(value.get_junction())
1.107 moko 78: return value;
1.143 moko 79: throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d is '%s')", msg, 1+index, value.type());
1.62 misha 80: }
1.107 moko 81:
1.46 paf 82: /// handy expression auto-processing to double
1.107 moko 83: double as_double(int index, const char* msg, Request& r) {
1.108 moko 84: Value& value=get(index);
1.107 moko 85: if(value.is_evaluated_expr())
86: return value.as_double();
87: return get_processed(value, msg, index, r).as_double();
1.46 paf 88: }
1.107 moko 89:
1.46 paf 90: /// handy expression auto-processing to int
1.107 moko 91: int as_int(int index, const char* msg, Request& r) {
1.108 moko 92: Value& value=get(index);
1.107 moko 93: if(value.is_evaluated_expr())
94: return value.as_int();
95: return get_processed(value, msg, index, r).as_int();
1.46 paf 96: }
1.107 moko 97:
1.132 moko 98: /// handy param auto-processing to index
99: int as_index(int index, size_t count, Request& r) {
100: if(get(index).is_string()) {
101: const String& svalue=*get(index).get_string();
102: if(svalue == "last")
103: return count-1;
104: else if(svalue != "first")
105: throw Exception(PARSER_RUNTIME, &svalue, "index must be 'first', 'last' or expression");
106: return 0;
107: } else {
108: int result=as_int(index, "index must be 'first', 'last' or expression", r);
109: if(result < 0)
110: result+=count;
111: return result;
112: }
113: }
114:
1.46 paf 115: /// handy expression auto-processing to bool
1.107 moko 116: bool as_bool(int index, const char* msg, Request& r) {
1.108 moko 117: Value& value=get(index);
1.107 moko 118: if(value.is_evaluated_expr())
119: return value.as_bool();
120: return get_processed(value, msg, index, r).as_bool();
1.46 paf 121: }
1.107 moko 122:
1.46 paf 123: /// handy string ensurer
1.109 moko 124: const String& as_string(int index, const char* msg) {
1.142 moko 125: if(const String *result=get(index).get_string())
126: return *result;
1.143 moko 127: throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d is '%s')", msg, 1+index, get(index).type());
1.46 paf 128: }
1.107 moko 129:
1.134 moko 130: /// handy file name ensurer
1.141 moko 131: const String& as_file_name(int index);
132:
133: /// handy file name from string or file
134: const String& as_file_spec(int index);
1.134 moko 135:
1.93 misha 136: /// handy hash ensurers
137: HashStringValue* as_hash(int index, const char* name=0);
1.107 moko 138:
1.93 misha 139: /// handy table ensurer
140: Table* as_table(int index, const char* name=0);
141:
1.46 paf 142: private:
143:
1.78 misha 144: Value **felements;
1.130 moko 145: size_t fsize;
1.78 misha 146:
1.107 moko 147: Value& get_processed(Value& value, const char* msg, int index, Request& r);
1.46 paf 148:
149: };
150:
1.114 moko 151: /**
152: Method frame write context
1.4 paf 153: accepts values written by method code
1.3 paf 154: */
1.114 moko 155:
1.46 paf 156: class VMethodFrame: public WContext {
1.63 misha 157: protected:
1.46 paf 158: VMethodFrame *fcaller;
1.114 moko 159: Value& fself;
160:
161: public: // Value
162:
163: override const char* type() const { return "method_frame"; }
164:
165: /// VMethodFrame: self_transparent
166: override VStateless_class* get_class() { return self().get_class(); }
167:
168: /// VMethodFrame: self_transparent
169: override VStateless_class* base() { return self().base(); }
170:
171: public: // usage
172:
173: VMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself):
174: WContext(0 /* no parent, junctions can be reattached only up to VMethodFrame */),
175: fcaller(acaller),
176: fself(aself),
177: method(amethod) {
178: }
179:
180: VMethodFrame *caller() { return fcaller; }
181:
182: Value& self() { return fself; }
183:
184: void check_call_type(){
1.115 moko 185: if(method.call_type==Method::CT_ANY)
186: return;
187:
1.114 moko 188: Method::Call_type call_type=self().get_class()==&self() ? Method::CT_STATIC : Method::CT_DYNAMIC;
1.115 moko 189:
190: if(method.call_type!=call_type) // call type not allowed?
1.121 moko 191: throw Exception(PARSER_RUNTIME, method.name, "method of '%s' is not allowed to be called %s",
192: self().type(), call_type==Method::CT_STATIC ? "statically" : "dynamically");
1.114 moko 193: }
194:
195: public:
196:
197: const Method& method;
198: };
1.46 paf 199:
200:
1.114 moko 201: class VNativeMethodFrame: public VMethodFrame {
202: protected:
203: MethodParams fnumbered_params;
1.46 paf 204:
1.114 moko 205: public: // usage
206:
207: VNativeMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VMethodFrame(amethod, acaller, aself){}
208:
1.122 moko 209: // params should be declared outside of *_FRAME_ACTION as MethodParams destructor will be called in ~VNativeMethodFrame
1.114 moko 210: void store_params(Value **params, size_t count) {
211: fnumbered_params.store_params(params, count);
212: method.check_actual_numbered_params(self(), &fnumbered_params);
213: }
214:
215: void empty_params() {
216: method.check_actual_numbered_params(self(), &fnumbered_params);
217: }
218:
219: void call(Request &r);
220:
221: };
222:
223:
224: /**
225: Handles named parameters and local variables
226: */
227:
228: class VParserMethodFrame: public VMethodFrame {
229: public: // Value
1.20 paf 230:
1.114 moko 231: /// VParserMethodFrame: $result | parent get_string(=accumulated fstring)
1.109 moko 232: override const String* get_string() {
1.139 moko 233: // if we have $result, return it's string value, else return as usual: accumulated fstring or fvalue
234: return my_result ? my_result->get_string() : WContext::get_string();
1.20 paf 235: }
1.114 moko 236:
237: /// VParserMethodFrame: my or self_transparent or $caller
1.109 moko 238: override Value* get_element(const String& aname) {
1.139 moko 239: if(SYMBOLS_EQ(aname,RESULT_SYMBOL))
240: return my_result ? my_result : VVoid::get();
241:
1.103 moko 242: if(SYMBOLS_EQ(aname,CALLER_SYMBOL))
1.118 moko 243: return get_caller_wrapper();
1.42 paf 244:
1.103 moko 245: if(SYMBOLS_EQ(aname,SELF_SYMBOL))
1.67 misha 246: return &self();
247:
1.114 moko 248: if(Value* result=my.get(aname))
1.66 misha 249: return result;
250:
1.114 moko 251: if(Value* result=self().get_element(aname))
1.66 misha 252: return result;
1.40 paf 253:
254: return 0;
1.1 paf 255: }
256:
1.114 moko 257: /// VParserMethodFrame: my or self_transparent
1.94 moko 258: override const VJunction* put_element(const String& aname, Value* avalue) {
1.139 moko 259: if(SYMBOLS_EQ(aname,RESULT_SYMBOL)){
260: my_result=avalue;
261: #ifdef OPTIMIZE_RESULT
1.140 moko 262: // This check is only for maintaining consistency. Even if we change the mode from RO_USE_WCONTEXT, it will not work because
263: // CO_WITHOUT_WCONTEXT is also active. In this mode writes go directly to the parent context and result() is never called.
264: // If we also change CO_WITHOUT_WCONTEXT, the current method call will still continue writing to the parent context and
265: // result() will not be called. Only subsequent method calls will use $result.
266: // The current behavior is more predictable: the first method call determines result_optimization, and subsequent calls never change it.
267: if(method.result_optimization==Method::RO_UNKNOWN)
268: ((Method *)&method)->result_optimization=Method::RO_USE_RESULT;
1.139 moko 269: #endif
270: return 0;
271: }
1.114 moko 272: if(my.put_replaced(aname, avalue))
1.126 moko 273: return 0;
1.114 moko 274: return self().put_element(aname, avalue);
1.64 misha 275: }
276:
1.114 moko 277: public: // WContext
278:
279: /// VParserMethodFrame: skip write when RO_USE_RESULT
1.112 moko 280: override void write(const String& astring) {
1.79 misha 281: #ifdef OPTIMIZE_RESULT
1.125 moko 282: if(method.result_optimization != Method::RO_USE_RESULT)
1.79 misha 283: #endif
1.125 moko 284: WContext::write(astring);
1.69 misha 285: }
286:
1.114 moko 287: override void write(Value& avalue) {
288: WContext::write(avalue);
1.64 misha 289: }
290:
1.119 moko 291: override ValueRef result() {
1.139 moko 292: // if we have $result, return it, else return as usual: accumulated fstring or fvalue
293: if(my_result)
294: return my_result;
1.79 misha 295: #ifdef OPTIMIZE_RESULT
1.114 moko 296: if(method.result_optimization==Method::RO_USE_RESULT)
1.120 moko 297: return VVoid::get();
1.140 moko 298:
299: // Due to call optimization, the following code is called only once.
300: // CO_WITHOUT_WCONTEXT means subsequent writes will be to the parent context, and the result() won't be called.
301:
1.114 moko 302: ((Method *)&method)->result_optimization=Method::RO_USE_WCONTEXT;
1.79 misha 303: #ifdef OPTIMIZE_CALL // nested as CO_WITHOUT_WCONTEXT assumes that $result not used
1.114 moko 304: ((Method *)&method)->call_optimization=Method::CO_WITHOUT_WCONTEXT;
1.79 misha 305: #endif
306: #endif
307: return WContext::result();
1.1 paf 308: }
309:
310: public: // usage
311:
1.123 moko 312: HashString<Value*> my; // public for ^stack[]
1.139 moko 313: Value* my_result;
1.123 moko 314:
1.114 moko 315: VParserMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself);
1.1 paf 316:
1.114 moko 317: void store_params(Value **params, size_t count) {
318: size_t param_count=method.params_count;
319: size_t i=0;
1.25 paf 320:
1.114 moko 321: if(count>param_count){
1.136 moko 322:
323: for(; i<param_count; i++) {
324: const String& fname=*(*method.params_names)[i];
1.138 moko 325: set_my_variable(fname, params[i]);
1.136 moko 326: }
327:
1.114 moko 328: if(method.extra_params){
329: VHash& vargs=*new VHash();
330: HashStringValue& args = vargs.hash();
1.1 paf 331:
1.114 moko 332: for(; i<count; i++) {
1.145 ! moko 333: args.put(String::Body::uitoa(args.count()), params[i]);
1.114 moko 334: }
1.77 misha 335:
1.138 moko 336: set_my_variable(*method.extra_params, &vargs);
1.136 moko 337: } else if(method.named_params){
338: if(count!=param_count+1)
339: throw Exception(PARSER_RUNTIME, method.name, "method of '%s' accepts maximum %d parameter(s) (%d present)", self().type(), param_count+1, count);
340:
341: HashStringValue* named_args = params[i]->as_hash("named parameter");
342: size_t named_count=method.named_params->count();
343: for(i=0; i<named_count; i++) {
344: const String& fname=*(*method.named_params)[i];
345: Value *arg=named_args ? named_args->get(fname) : NULL;
1.138 moko 346: set_my_variable(fname, arg ? arg : VVoid::get());
1.136 moko 347: }
1.114 moko 348: } else
1.121 moko 349: throw Exception(PARSER_RUNTIME, method.name, "method of '%s' accepts maximum %d parameter(s) (%d present)", self().type(), param_count, count);
1.135 moko 350: } else {
1.136 moko 351:
352: for(; i<count; i++) {
353: const String& fname=*(*method.params_names)[i];
1.138 moko 354: set_my_variable(fname, params[i]);
1.136 moko 355: }
356:
357: for(; i<param_count; i++) {
358: const String& fname=*(*method.params_names)[i];
1.138 moko 359: set_my_variable(fname, VVoid::get());
1.136 moko 360: }
361:
1.135 moko 362: if(method.extra_params){
1.138 moko 363: set_my_variable(*method.extra_params, VVoid::get());
1.136 moko 364: } else if(method.named_params){
365: size_t named_count=method.named_params->count();
366: for(i=0; i<named_count; i++) {
367: const String& fname=*(*method.named_params)[i];
1.138 moko 368: set_my_variable(fname, VVoid::get());
1.136 moko 369: }
1.135 moko 370: }
1.114 moko 371: }
1.1 paf 372: }
373:
1.78 misha 374: void empty_params(){
1.114 moko 375: size_t param_count=method.params_count;
376: if(param_count>0){
1.138 moko 377: set_my_variable(*(*method.params_names)[0], VString::empty());
1.114 moko 378: for(size_t i=1; i<param_count; i++)
1.138 moko 379: set_my_variable(*(*method.params_names)[i], VVoid::get());
1.78 misha 380: }
1.137 moko 381: if(method.extra_params){
1.138 moko 382: set_my_variable(*method.extra_params, VVoid::get());
1.137 moko 383: } else if(method.named_params){
384: size_t named_count=method.named_params->count();
1.144 moko 385: for(size_t i=0; i<named_count; i++) {
1.137 moko 386: const String& fname=*(*method.named_params)[i];
1.138 moko 387: set_my_variable(fname, VVoid::get());
1.137 moko 388: }
389: }
1.78 misha 390: }
391:
1.114 moko 392: void call(Request &r);
1.18 paf 393:
1.63 misha 394: protected:
1.18 paf 395:
1.139 moko 396: inline void set_my_variable(const String& aname, Value* value) {
397: if(SYMBOLS_EQ(aname,RESULT_SYMBOL)){
398: my_result=value;
399: #ifdef OPTIMIZE_RESULT
400: ((Method *)&method)->result_optimization=Method::RO_USE_RESULT;
401: #endif
402: return;
403: }
404: my.put(aname, value); // remember param
1.25 paf 405: }
406:
1.118 moko 407: Value* get_caller_wrapper();
408:
1.114 moko 409: };
410:
411:
412: class VLocalParserMethodFrame: public VParserMethodFrame {
413: public: // Value
414:
415: override const VJunction* put_element(const String& aname, Value* avalue){
1.138 moko 416: set_my_variable(aname, avalue);
1.126 moko 417: return 0;
1.114 moko 418: }
419:
420: public: // usage
421:
422: VLocalParserMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VParserMethodFrame(amethod, acaller, aself) {}
1.1 paf 423:
1.41 paf 424: };
425:
1.114 moko 426:
427: template<typename Parent> class VExpressionFrame: public Parent {
1.113 moko 428: public:
1.114 moko 429: VExpressionFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : Parent(amethod, acaller, aself) {}
1.113 moko 430:
1.117 moko 431: /// in expressions only strings are written as strings
1.113 moko 432: override void write_as_string(Value& avalue) {
1.117 moko 433: if(avalue.is_string())
434: Parent::write(*avalue.get_string());
435: else
436: Parent::write(avalue);
1.113 moko 437: }
438: };
439:
440:
1.114 moko 441: template<typename Parent> class VConstructorFrame: public Parent {
1.85 misha 442: public:
1.114 moko 443: VConstructorFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : Parent(amethod, acaller, aself) {
1.87 moko 444: // prevent non-string writes for better error reporting [constructors are not expected to return anything]
445: VMethodFrame::write(aself);
446: }
1.85 misha 447:
1.113 moko 448: override void write(const String& /*astring*/) {}
1.85 misha 449: };
450:
1.114 moko 451:
452: #define METHOD_FRAME_ACTION(method, caller, self, action) \
453: if((method).native_code){ \
454: VNativeMethodFrame frame(method, caller, self); \
455: action; \
456: } else { \
457: if((method).all_vars_local){ \
458: VLocalParserMethodFrame frame(method, caller, self); \
459: action; \
460: } else { \
461: VParserMethodFrame frame(method, caller, self); \
462: action; \
463: } \
464: }
465:
466: #define EXPRESSION_FRAME_ACTION(method, caller, self, action) \
467: if((method).native_code){ \
468: VExpressionFrame<VNativeMethodFrame> frame(method, caller, self); \
469: action; \
470: } else { \
471: if((method).all_vars_local){ \
1.128 moko 472: VLocalParserMethodFrame frame(method, caller, self); \
1.114 moko 473: action; \
474: } else { \
1.128 moko 475: VParserMethodFrame frame(method, caller, self); \
1.114 moko 476: action; \
477: } \
478: }
479:
480: #define CONSTRUCTOR_FRAME_ACTION(method, caller, self, action) \
481: if((method).native_code){ \
482: VConstructorFrame<VNativeMethodFrame> frame(method, caller, self); \
483: action; \
484: } else { \
485: if((method).all_vars_local){ \
486: VConstructorFrame<VLocalParserMethodFrame> frame(method, caller, self); \
487: action; \
488: } else { \
489: VConstructorFrame<VParserMethodFrame> frame(method, caller, self); \
490: action; \
491: } \
492: }
493:
1.1 paf 494: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_vmethod_frame.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / types