Annotation of parser3/src/types/pa_vmethod_frame.h, revision 1.97
1.3 paf 1: /** @file
1.5 paf 2: Parser: @b method_frame write context
1.3 paf 3:
1.90 moko 4: Copyright (c) 2001-2012 Art. Lebedev Studio (http://www.artlebedev.com)
1.22 paf 5: Author: Alexandr Petrosian <paf@design.ru> (http://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.97 ! moko 11: #define IDENT_PA_VMETHOD_FRAME_H "$Id: pa_vmethod_frame.h,v 1.96 2015/03/16 09:47:36 misha Exp $"
1.1 paf 12:
13: #include "pa_wcontext.h"
1.12 parser 14: #include "pa_vvoid.h"
1.1 paf 15: #include "pa_vjunction.h"
16:
1.40 paf 17: // defines
18:
1.42 paf 19: #define CALLER_ELEMENT_NAME "caller"
20: #define SELF_ELEMENT_NAME "self"
1.50 paf 21: #define RESULT_VAR_NAME "result"
1.81 misha 22: extern const String result_var_name, caller_element_name, self_element_name;
1.96 misha 23: #ifdef OPTIMIZE_BYTECODE_GET_ELEMENT__SPECIAL
24: #define CLASS_ELEMENT_NAME "CLASS"
25: #define CLASS_NAME_ELEMENT_NAME "CLASS_NAME"
26: extern const String class_element_name, class_name_element_name;
27: #endif
1.40 paf 28:
1.46 paf 29: // forwards
30:
31: class Request;
32:
33: /**
34: @b method parameters passed in this array.
35: contains handy typecast ad junction/not junction ensurers
36:
37: */
1.78 misha 38: class MethodParams {
1.46 paf 39: public:
1.78 misha 40: MethodParams() : felements(0), fused(0){}
41:
1.82 misha 42: #ifdef USE_DESTRUCTORS
43: ~MethodParams(){
44: Value **flast=felements+count();
1.95 moko 45: for(Value **current=felements;current<flast;current++){
46: Junction* junction=(*current)->get_junction();
47: if (junction && junction->code)
1.82 misha 48: delete *current;
1.95 moko 49: }
1.82 misha 50: }
51: #endif
52:
1.77 misha 53: void store_params(Value **params, size_t count){
1.78 misha 54: felements=params;
1.77 misha 55: fused=count;
56: }
57:
1.78 misha 58: inline size_t count() const { return fused; }
59:
60: inline Value *get(size_t index) const {
61: assert(index<count());
62: return felements[index];
63: }
64:
1.77 misha 65: inline Value& operator[] (size_t index) { return *get(index); }
1.46 paf 66:
67: Value& last() { return *get(count()-1); }
68:
69: /// handy is-value-a-junction ensurer
70: Value& as_junction(int index, const char* msg) {
1.56 paf 71: Value* value=get(index);
72: return as_junction(value, msg, index);
73: }
74: /// handy is-value-a-junction ensurer
75: Value& as_junction(Value* value, const char* msg, int index) {
76: return get_as(value, true, msg, index);
1.46 paf 77: }
78: /// handy value-is-not-a-junction ensurer
79: Value& as_no_junction(int index, const char* msg) {
1.56 paf 80: Value* value=get(index);
81: return as_no_junction(value, msg, index);
82: }
83: /// handy value-is-not-a-junction ensurer
84: Value& as_no_junction(Value* value, const char* msg, int index) {
85: return get_as(value, false, msg, index);
1.46 paf 86: }
1.62 misha 87: /// handy is-value-a-junction ensurer or can be auto-processed
88: Value& as_expression(int index, const char* msg) {
89: Value* value=get(index);
90: if(value->is_evaluated_expr()){
91: return *value;
92: } else {
93: return get_as(value, true, msg, index);
94: }
95: }
1.46 paf 96: /// handy expression auto-processing to double
97: double as_double(int index, const char* msg, Request& r) {
1.56 paf 98: Value* value=get(index);
1.60 paf 99: if(!value->is_evaluated_expr())
1.57 paf 100: value=&get_processed(value, msg, index, r);
101: return value->as_double();
1.46 paf 102: }
103: /// handy expression auto-processing to int
104: int as_int(int index, const char* msg, Request& r) {
1.56 paf 105: Value* value=get(index);
1.60 paf 106: if(!value->is_evaluated_expr())
1.57 paf 107: value=&get_processed(value, msg, index, r);
108: return value->as_int();
1.46 paf 109: }
110: /// handy expression auto-processing to bool
111: bool as_bool(int index, const char* msg, Request& r) {
1.56 paf 112: Value* value=get(index);
1.60 paf 113: if(!value->is_evaluated_expr())
1.59 paf 114: value=&get_processed(value, msg, index, r);
115: return value->as_bool();
1.46 paf 116: }
117: /// handy string ensurer
118: const String& as_string(int index, const char* msg) {
119: return as_no_junction(index, msg).as_string();
120: }
1.93 misha 121: /// handy hash ensurers
122: HashStringValue* as_hash(int index, const char* name=0);
123: /// handy table ensurer
124: Table* as_table(int index, const char* name=0);
125:
1.46 paf 126: private:
127:
1.78 misha 128: Value **felements;
129: size_t fused;
130:
1.46 paf 131: /// handy value-is/not-a-junction ensurer
1.56 paf 132: Value& get_as(Value* value, bool as_junction, const char* msg, int index) {
133: if((value->get_junction()!=0) ^ as_junction)
1.61 misha 134: throw Exception(PARSER_RUNTIME,
1.46 paf 135: 0,
136: "%s (parameter #%d)", msg, 1+index);
137:
1.56 paf 138: return *value;
1.46 paf 139: }
140:
1.56 paf 141: Value& get_processed(Value* value, const char* msg, int index, Request& r);
1.46 paf 142:
143: };
144:
1.4 paf 145: /** Method frame write context
146: accepts values written by method code
147: also handles method parameters and local variables
1.3 paf 148: */
1.46 paf 149: class VMethodFrame: public WContext {
1.63 misha 150: protected:
1.46 paf 151: VMethodFrame *fcaller;
152:
1.83 misha 153: HashString<Value*>* my; /*OR*/ MethodParams fnumbered_params;
1.87 moko 154: Value& fself;
1.46 paf 155:
1.64 misha 156: typedef const VJunction* (VMethodFrame::*put_element_t)(const String& aname, Value* avalue);
157: put_element_t put_element_impl;
1.46 paf 158:
1.1 paf 159: public: // Value
160:
1.46 paf 161: override const char* type() const { return "method_frame"; }
1.20 paf 162:
163: /// VMethodFrame: $result | parent get_string(=accumulated fstring)
1.46 paf 164: override const String* get_string() {
1.20 paf 165: // check the $result value
1.46 paf 166: Value* result=get_result_variable();
1.20 paf 167: // if we have one, return it's string value, else return as usual: accumulated fstring or fvalue
168: return result ? result->get_string() : WContext::get_string();
169: }
170:
1.40 paf 171: /// VMethodFrame: my or self_transparent or $caller
1.84 misha 172: override Value* get_element(const String& aname) {
1.81 misha 173: if(aname==caller_element_name)
1.40 paf 174: return caller();
1.42 paf 175:
1.81 misha 176: if(aname==self_element_name)
1.67 misha 177: return &self();
178:
1.66 misha 179: Value* result;
180: if(my && (result=my->get(aname)))
181: return result;
182:
1.84 misha 183: if(result=self().get_element(aname))
1.66 misha 184: return result;
1.40 paf 185:
186: return 0;
1.1 paf 187: }
188:
1.4 paf 189: /// VMethodFrame: self_transparent
1.46 paf 190: override VStateless_class* get_class() { return self().get_class(); }
1.44 paf 191:
192: /// VMethodFrame: self_transparent
1.85 misha 193: override VStateless_class* base() { return self().base(); }
1.1 paf 194:
1.64 misha 195: /// VMethodFrame: my or self_transparent
1.94 moko 196: override const VJunction* put_element(const String& aname, Value* avalue) {
1.64 misha 197: return (this->*put_element_impl)(aname, avalue);
198: }
199:
1.69 misha 200: /// VMethodFrame: appends a fstring to result
201: override void write(const String& astring, String::Language alang) {
1.79 misha 202: #ifdef OPTIMIZE_RESULT
1.87 moko 203: switch (method.result_optimization){
1.97 ! moko 204: case Method::RO_USE_RESULT:
1.79 misha 205: return;
206: case Method::RO_UNKNOWN:
207: if(get_result_variable()){
1.87 moko 208: ((Method *)&method)->result_optimization=Method::RO_USE_RESULT;
1.79 misha 209: return;
210: }
1.97 ! moko 211: case Method::RO_USE_WCONTEXT: break;
1.69 misha 212: }
1.79 misha 213: #endif
214: WContext::write(astring, alang);
1.69 misha 215: }
216:
1.64 misha 217: private:
218:
219: const VJunction* put_element_local(const String& aname, Value* avalue){
220: set_my_variable(aname, *avalue);
221: return PUT_ELEMENT_REPLACED_ELEMENT;
222: }
223:
224: const VJunction* put_element_global(const String& aname, Value* avalue){
225: if(my && my->put_replaced(aname, avalue))
226: return PUT_ELEMENT_REPLACED_ELEMENT;
1.94 moko 227: return self().put_element(aname, avalue);
1.64 misha 228: }
229:
1.30 paf 230: public: // WContext
1.1 paf 231:
1.46 paf 232: override StringOrValue result() {
1.80 misha 233: if(my){
234: // check the $result value
235: Value* result_value=get_result_variable();
236: // if we have one, return it, else return as usual: accumulated fstring or fvalue
237: if(result_value)
238: return StringOrValue(*result_value);
1.79 misha 239: #ifdef OPTIMIZE_RESULT
1.87 moko 240: if(method.result_optimization==Method::RO_USE_RESULT)
1.80 misha 241: return StringOrValue(*VVoid::get());
1.87 moko 242: ((Method *)&method)->result_optimization=Method::RO_USE_WCONTEXT;
1.79 misha 243: #ifdef OPTIMIZE_CALL // nested as CO_WITHOUT_WCONTEXT assumes that $result not used
1.87 moko 244: ((Method *)&method)->call_optimization=Method::CO_WITHOUT_WCONTEXT;
1.79 misha 245: #endif
246: #endif
1.80 misha 247: }
1.79 misha 248: return WContext::result();
1.1 paf 249: }
250:
1.85 misha 251: override void write(Value& avalue) {
252: WContext::write(avalue);
1.46 paf 253: }
254:
1.1 paf 255: public: // usage
256:
1.87 moko 257: VMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself);
1.1 paf 258:
1.40 paf 259: VMethodFrame *caller() { return fcaller; }
1.25 paf 260:
1.76 misha 261: #ifdef USE_DESTRUCTORS
1.75 misha 262: ~VMethodFrame(){
263: if(my){
264: delete my;
265: }
266: }
1.76 misha 267: #endif
1.75 misha 268:
1.87 moko 269: Value& self() { return fself; }
1.1 paf 270:
1.77 misha 271: size_t method_params_count() {
272: return method.params_names ? method.params_names->count():0;
1.27 paf 273: }
1.77 misha 274:
275: void store_params(Value **params, size_t count) {
1.92 moko 276: if(my) {
277: size_t param_count=method.params_names ? method.params_names->count():0;
1.89 moko 278: size_t i=0;
279:
280: if(count>param_count){
281: if(method.extra_params){
282: for(; i<param_count; i++) {
283: const String& fname=*(*method.params_names)[i];
284: set_my_variable(fname, *params[i]);
285: }
286:
287: VHash& vargs=*new VHash();
288: HashStringValue& args = vargs.hash();
289:
290: for(; i<count; i++) {
291: args.put(format(args.count(), 0), params[i]);
292: }
1.86 misha 293:
1.89 moko 294: set_my_variable(*method.extra_params, vargs);
295: return;
296: } else
1.86 misha 297: throw Exception(PARSER_RUNTIME,
298: 0, //&name(),
299: "method of %s (%s) accepts maximum %d parameter(s) (%d present)",
1.87 moko 300: self().get_class()->name_cstr(),
301: self().type(),
1.86 misha 302: param_count,
303: count);
1.89 moko 304: }
1.78 misha 305:
1.86 misha 306: for(; i<count; i++) {
1.77 misha 307: const String& fname=*(*method.params_names)[i];
308: set_my_variable(fname, *params[i]);
309: }
310:
311: for(; i<param_count; i++) {
312: const String& fname=*(*method.params_names)[i];
1.68 misha 313: my->put(fname, VVoid::get());
1.1 paf 314: }
1.86 misha 315: } else
1.77 misha 316: fnumbered_params.store_params(params,count);
1.1 paf 317: }
318:
1.78 misha 319: void empty_params(){
320: if(method.params_names){
321: size_t param_count=method.params_names->count();
1.91 moko 322: if(param_count>0){
323: const String& fname=*(*method.params_names)[0];
324: my->put(fname, VString::empty());
325: for(size_t i=1; i<param_count; i++) {
326: const String& fname=*(*method.params_names)[i];
327: my->put(fname, VVoid::get());
328: }
1.78 misha 329: }
330: }
331: }
332:
1.72 misha 333: MethodParams* numbered_params() { return &fnumbered_params; }
1.18 paf 334:
1.63 misha 335: protected:
1.18 paf 336:
1.46 paf 337: void set_my_variable(const String& fname, Value& value) {
338: my->put(fname, &value); // remember param
1.25 paf 339: }
340:
1.46 paf 341: Value* get_result_variable();
1.1 paf 342:
343: public:
344:
1.87 moko 345: const Method& method;
1.1 paf 346:
1.41 paf 347: };
348:
1.85 misha 349: class VConstructorFrame: public VMethodFrame {
350: public:
1.87 moko 351: VConstructorFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VMethodFrame(amethod, acaller, aself) {
352: // prevent non-string writes for better error reporting [constructors are not expected to return anything]
353: VMethodFrame::write(aself);
354: }
1.85 misha 355:
356: override void write(const String& /*astring*/, String::Language /*alang*/) {}
357: };
358:
1.1 paf 359: #endif
E-mail: