Annotation of parser3/src/types/pa_vmethod_frame.h, revision 1.131
1.3 paf 1: /** @file
1.5 paf 2: Parser: @b method_frame write context
1.3 paf 3:
1.129 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_VMETHOD_FRAME_H
9: #define PA_VMETHOD_FRAME_H
1.28 paf 10:
1.131 ! moko 11: #define IDENT_PA_VMETHOD_FRAME_H "$Id: pa_vmethod_frame.h,v 1.130 2024/09/16 23:22:52 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;
61: throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d)", msg, 1+index);
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;
69: throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d)", msg, 1+index);
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.110 moko 79: throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d)", msg, 1+index);
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.46 paf 98: /// handy expression auto-processing to bool
1.107 moko 99: bool as_bool(int index, const char* msg, Request& r) {
1.108 moko 100: Value& value=get(index);
1.107 moko 101: if(value.is_evaluated_expr())
102: return value.as_bool();
103: return get_processed(value, msg, index, r).as_bool();
1.46 paf 104: }
1.107 moko 105:
1.46 paf 106: /// handy string ensurer
1.109 moko 107: const String& as_string(int index, const char* msg) {
1.46 paf 108: return as_no_junction(index, msg).as_string();
109: }
1.107 moko 110:
1.93 misha 111: /// handy hash ensurers
112: HashStringValue* as_hash(int index, const char* name=0);
1.107 moko 113:
1.93 misha 114: /// handy table ensurer
115: Table* as_table(int index, const char* name=0);
116:
1.46 paf 117: private:
118:
1.78 misha 119: Value **felements;
1.130 moko 120: size_t fsize;
1.78 misha 121:
1.107 moko 122: Value& get_processed(Value& value, const char* msg, int index, Request& r);
1.46 paf 123:
124: };
125:
1.114 moko 126: /**
127: Method frame write context
1.4 paf 128: accepts values written by method code
1.3 paf 129: */
1.114 moko 130:
1.46 paf 131: class VMethodFrame: public WContext {
1.63 misha 132: protected:
1.46 paf 133: VMethodFrame *fcaller;
1.114 moko 134: Value& fself;
135:
136: public: // Value
137:
138: override const char* type() const { return "method_frame"; }
139:
140: /// VMethodFrame: self_transparent
141: override VStateless_class* get_class() { return self().get_class(); }
142:
143: /// VMethodFrame: self_transparent
144: override VStateless_class* base() { return self().base(); }
145:
146: public: // usage
147:
148: VMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself):
149: WContext(0 /* no parent, junctions can be reattached only up to VMethodFrame */),
150: fcaller(acaller),
151: fself(aself),
152: method(amethod) {
153: }
154:
155: VMethodFrame *caller() { return fcaller; }
156:
157: Value& self() { return fself; }
158:
159: void check_call_type(){
1.115 moko 160: if(method.call_type==Method::CT_ANY)
161: return;
162:
1.114 moko 163: Method::Call_type call_type=self().get_class()==&self() ? Method::CT_STATIC : Method::CT_DYNAMIC;
1.115 moko 164:
165: if(method.call_type!=call_type) // call type not allowed?
1.121 moko 166: throw Exception(PARSER_RUNTIME, method.name, "method of '%s' is not allowed to be called %s",
167: self().type(), call_type==Method::CT_STATIC ? "statically" : "dynamically");
1.114 moko 168: }
169:
170: public:
171:
172: const Method& method;
173: };
1.46 paf 174:
175:
1.114 moko 176: class VNativeMethodFrame: public VMethodFrame {
177: protected:
178: MethodParams fnumbered_params;
1.46 paf 179:
1.114 moko 180: public: // usage
181:
182: VNativeMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VMethodFrame(amethod, acaller, aself){}
183:
1.122 moko 184: // params should be declared outside of *_FRAME_ACTION as MethodParams destructor will be called in ~VNativeMethodFrame
1.114 moko 185: void store_params(Value **params, size_t count) {
186: fnumbered_params.store_params(params, count);
187: method.check_actual_numbered_params(self(), &fnumbered_params);
188: }
189:
190: void empty_params() {
191: method.check_actual_numbered_params(self(), &fnumbered_params);
192: }
193:
194: void call(Request &r);
195:
196: };
197:
198:
199: /**
200: Handles named parameters and local variables
201: */
202:
203: class VParserMethodFrame: public VMethodFrame {
204: public: // Value
1.20 paf 205:
1.114 moko 206: /// VParserMethodFrame: $result | parent get_string(=accumulated fstring)
1.109 moko 207: override const String* get_string() {
1.20 paf 208: // check the $result value
1.46 paf 209: Value* result=get_result_variable();
1.20 paf 210: // if we have one, return it's string value, else return as usual: accumulated fstring or fvalue
211: return result ? result->get_string() : WContext::get_string();
212: }
1.114 moko 213:
214: /// VParserMethodFrame: my or self_transparent or $caller
1.109 moko 215: override Value* get_element(const String& aname) {
1.103 moko 216: if(SYMBOLS_EQ(aname,CALLER_SYMBOL))
1.118 moko 217: return get_caller_wrapper();
1.42 paf 218:
1.103 moko 219: if(SYMBOLS_EQ(aname,SELF_SYMBOL))
1.67 misha 220: return &self();
221:
1.114 moko 222: if(Value* result=my.get(aname))
1.66 misha 223: return result;
224:
1.114 moko 225: if(Value* result=self().get_element(aname))
1.66 misha 226: return result;
1.40 paf 227:
228: return 0;
1.1 paf 229: }
230:
1.114 moko 231: /// VParserMethodFrame: my or self_transparent
1.94 moko 232: override const VJunction* put_element(const String& aname, Value* avalue) {
1.114 moko 233: if(my.put_replaced(aname, avalue))
1.126 moko 234: return 0;
1.114 moko 235: return self().put_element(aname, avalue);
1.64 misha 236: }
237:
1.114 moko 238: public: // WContext
239:
240: /// VParserMethodFrame: skip write when RO_USE_RESULT
1.112 moko 241: override void write(const String& astring) {
1.79 misha 242: #ifdef OPTIMIZE_RESULT
1.125 moko 243: if(method.result_optimization != Method::RO_USE_RESULT)
1.79 misha 244: #endif
1.125 moko 245: WContext::write(astring);
1.69 misha 246: }
247:
1.114 moko 248: override void write(Value& avalue) {
249: WContext::write(avalue);
1.64 misha 250: }
251:
1.119 moko 252: override ValueRef result() {
1.114 moko 253: // check the $result value
254: Value* result_value=get_result_variable();
255: // if we have one, return it, else return as usual: accumulated fstring or fvalue
1.125 moko 256: if(result_value){
257: #ifdef OPTIMIZE_RESULT
258: ((Method *)&method)->result_optimization=Method::RO_USE_RESULT;
259: #endif
1.120 moko 260: return result_value;
1.125 moko 261: }
1.79 misha 262: #ifdef OPTIMIZE_RESULT
1.114 moko 263: if(method.result_optimization==Method::RO_USE_RESULT)
1.120 moko 264: return VVoid::get();
1.114 moko 265: ((Method *)&method)->result_optimization=Method::RO_USE_WCONTEXT;
1.79 misha 266: #ifdef OPTIMIZE_CALL // nested as CO_WITHOUT_WCONTEXT assumes that $result not used
1.114 moko 267: ((Method *)&method)->call_optimization=Method::CO_WITHOUT_WCONTEXT;
1.79 misha 268: #endif
269: #endif
270: return WContext::result();
1.1 paf 271: }
272:
273: public: // usage
274:
1.123 moko 275: HashString<Value*> my; // public for ^stack[]
276:
1.114 moko 277: VParserMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself);
1.1 paf 278:
1.114 moko 279: void store_params(Value **params, size_t count) {
280: size_t param_count=method.params_count;
281: size_t i=0;
1.25 paf 282:
1.114 moko 283: if(count>param_count){
284: if(method.extra_params){
285: for(; i<param_count; i++) {
286: const String& fname=*(*method.params_names)[i];
287: set_my_variable(fname, *params[i]);
288: }
1.75 misha 289:
1.114 moko 290: VHash& vargs=*new VHash();
291: HashStringValue& args = vargs.hash();
1.1 paf 292:
1.114 moko 293: for(; i<count; i++) {
1.131 ! moko 294: args.put(pa_uitoa(args.count()), params[i]);
1.114 moko 295: }
1.77 misha 296:
1.114 moko 297: set_my_variable(*method.extra_params, vargs);
298: return;
299: } else
1.121 moko 300: throw Exception(PARSER_RUNTIME, method.name, "method of '%s' accepts maximum %d parameter(s) (%d present)", self().type(), param_count, count);
1.114 moko 301: }
1.86 misha 302:
1.114 moko 303: for(; i<count; i++) {
304: const String& fname=*(*method.params_names)[i];
305: set_my_variable(fname, *params[i]);
306: }
1.78 misha 307:
1.114 moko 308: for(; i<param_count; i++) {
309: const String& fname=*(*method.params_names)[i];
310: my.put(fname, VVoid::get());
311: }
1.1 paf 312: }
313:
1.78 misha 314: void empty_params(){
1.114 moko 315: size_t param_count=method.params_count;
316: if(param_count>0){
317: my.put(*(*method.params_names)[0], VString::empty());
318: for(size_t i=1; i<param_count; i++)
319: my.put(*(*method.params_names)[i], VVoid::get());
1.78 misha 320: }
321: }
322:
1.114 moko 323: void call(Request &r);
1.18 paf 324:
1.63 misha 325: protected:
1.18 paf 326:
1.46 paf 327: void set_my_variable(const String& fname, Value& value) {
1.114 moko 328: my.put(fname, &value); // remember param
1.25 paf 329: }
330:
1.46 paf 331: Value* get_result_variable();
1.1 paf 332:
1.118 moko 333: Value* get_caller_wrapper();
334:
1.114 moko 335: };
336:
337:
338: class VLocalParserMethodFrame: public VParserMethodFrame {
339: public: // Value
340:
341: override const VJunction* put_element(const String& aname, Value* avalue){
342: set_my_variable(aname, *avalue);
1.126 moko 343: return 0;
1.114 moko 344: }
345:
346: public: // usage
347:
348: VLocalParserMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VParserMethodFrame(amethod, acaller, aself) {}
1.1 paf 349:
1.41 paf 350: };
351:
1.114 moko 352:
353: template<typename Parent> class VExpressionFrame: public Parent {
1.113 moko 354: public:
1.114 moko 355: VExpressionFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : Parent(amethod, acaller, aself) {}
1.113 moko 356:
1.117 moko 357: /// in expressions only strings are written as strings
1.113 moko 358: override void write_as_string(Value& avalue) {
1.117 moko 359: if(avalue.is_string())
360: Parent::write(*avalue.get_string());
361: else
362: Parent::write(avalue);
1.113 moko 363: }
364: };
365:
366:
1.114 moko 367: template<typename Parent> class VConstructorFrame: public Parent {
1.85 misha 368: public:
1.114 moko 369: VConstructorFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : Parent(amethod, acaller, aself) {
1.87 moko 370: // prevent non-string writes for better error reporting [constructors are not expected to return anything]
371: VMethodFrame::write(aself);
372: }
1.85 misha 373:
1.113 moko 374: override void write(const String& /*astring*/) {}
1.85 misha 375: };
376:
1.114 moko 377:
378: #define METHOD_FRAME_ACTION(method, caller, self, action) \
379: if((method).native_code){ \
380: VNativeMethodFrame frame(method, caller, self); \
381: action; \
382: } else { \
383: if((method).all_vars_local){ \
384: VLocalParserMethodFrame frame(method, caller, self); \
385: action; \
386: } else { \
387: VParserMethodFrame frame(method, caller, self); \
388: action; \
389: } \
390: }
391:
392: #define EXPRESSION_FRAME_ACTION(method, caller, self, action) \
393: if((method).native_code){ \
394: VExpressionFrame<VNativeMethodFrame> frame(method, caller, self); \
395: action; \
396: } else { \
397: if((method).all_vars_local){ \
1.128 moko 398: VLocalParserMethodFrame frame(method, caller, self); \
1.114 moko 399: action; \
400: } else { \
1.128 moko 401: VParserMethodFrame frame(method, caller, self); \
1.114 moko 402: action; \
403: } \
404: }
405:
406: #define CONSTRUCTOR_FRAME_ACTION(method, caller, self, action) \
407: if((method).native_code){ \
408: VConstructorFrame<VNativeMethodFrame> frame(method, caller, self); \
409: action; \
410: } else { \
411: if((method).all_vars_local){ \
412: VConstructorFrame<VLocalParserMethodFrame> frame(method, caller, self); \
413: action; \
414: } else { \
415: VConstructorFrame<VParserMethodFrame> frame(method, caller, self); \
416: action; \
417: } \
418: }
419:
1.1 paf 420: #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