Annotation of parser3/src/types/pa_vmethod_frame.h, revision 1.67
1.3 paf 1: /** @file
1.5 paf 2: Parser: @b method_frame write context
1.3 paf 3:
1.58 paf 4: Copyright (c) 2001-2005 ArtLebedev Group (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.67 ! misha 11: static const char * const IDENT_VMETHOD_FRAME_H="$Date: 2008-07-23 14:05:48 $";
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.40 paf 22:
1.46 paf 23: // forwards
24:
25: class Request;
26:
27: /**
28: @b method parameters passed in this array.
29: contains handy typecast ad junction/not junction ensurers
30:
31: */
32: class MethodParams: public Array<Value*> {
33: public:
34: Value& operator[] (size_t index) { return *get(index); }
35:
36: Value& last() { return *get(count()-1); }
37:
38: /// handy is-value-a-junction ensurer
39: Value& as_junction(int index, const char* msg) {
1.56 paf 40: Value* value=get(index);
41: return as_junction(value, msg, index);
42: }
43: /// handy is-value-a-junction ensurer
44: Value& as_junction(Value* value, const char* msg, int index) {
45: return get_as(value, true, msg, index);
1.46 paf 46: }
47: /// handy value-is-not-a-junction ensurer
48: Value& as_no_junction(int index, const char* msg) {
1.56 paf 49: Value* value=get(index);
50: return as_no_junction(value, msg, index);
51: }
52: /// handy value-is-not-a-junction ensurer
53: Value& as_no_junction(Value* value, const char* msg, int index) {
54: return get_as(value, false, msg, index);
1.46 paf 55: }
1.62 misha 56: /// handy is-value-a-junction ensurer or can be auto-processed
57: Value& as_expression(int index, const char* msg) {
58: Value* value=get(index);
59: if(value->is_evaluated_expr()){
60: return *value;
61: } else {
62: return get_as(value, true, msg, index);
63: }
64: }
1.46 paf 65: /// handy expression auto-processing to double
66: double as_double(int index, const char* msg, Request& r) {
1.56 paf 67: Value* value=get(index);
1.60 paf 68: if(!value->is_evaluated_expr())
1.57 paf 69: value=&get_processed(value, msg, index, r);
70: return value->as_double();
1.46 paf 71: }
72: /// handy expression auto-processing to int
73: int as_int(int index, const char* msg, Request& r) {
1.56 paf 74: Value* value=get(index);
1.60 paf 75: if(!value->is_evaluated_expr())
1.57 paf 76: value=&get_processed(value, msg, index, r);
77: return value->as_int();
1.46 paf 78: }
79: /// handy expression auto-processing to bool
80: bool as_bool(int index, const char* msg, Request& r) {
1.56 paf 81: Value* value=get(index);
1.60 paf 82: if(!value->is_evaluated_expr())
1.59 paf 83: value=&get_processed(value, msg, index, r);
84: return value->as_bool();
1.46 paf 85: }
86: /// handy string ensurer
87: const String& as_string(int index, const char* msg) {
88: return as_no_junction(index, msg).as_string();
89: }
90:
91: private:
92:
93: /// handy value-is/not-a-junction ensurer
1.56 paf 94: Value& get_as(Value* value, bool as_junction, const char* msg, int index) {
95: if((value->get_junction()!=0) ^ as_junction)
1.61 misha 96: throw Exception(PARSER_RUNTIME,
1.46 paf 97: 0,
98: "%s (parameter #%d)", msg, 1+index);
99:
1.56 paf 100: return *value;
1.46 paf 101: }
102:
1.56 paf 103: Value& get_processed(Value* value, const char* msg, int index, Request& r);
1.46 paf 104:
105: };
106:
1.4 paf 107: /** Method frame write context
108: accepts values written by method code
109: also handles method parameters and local variables
1.3 paf 110: */
1.46 paf 111: class VMethodFrame: public WContext {
1.63 misha 112: protected:
1.46 paf 113: VMethodFrame *fcaller;
114:
115: size_t store_param_index;
116: HashStringValue* my;/*OR*/MethodParams* fnumbered_params;
117: Value* fself;
118:
119: Value* fresult_initial_void;
1.64 misha 120: typedef const VJunction* (VMethodFrame::*put_element_t)(const String& aname, Value* avalue);
121: put_element_t put_element_impl;
1.46 paf 122:
1.1 paf 123: public: // Value
124:
1.46 paf 125: override const char* type() const { return "method_frame"; }
1.20 paf 126:
127: /// VMethodFrame: $result | parent get_string(=accumulated fstring)
1.46 paf 128: override const String* get_string() {
1.20 paf 129: // check the $result value
1.46 paf 130: Value* result=get_result_variable();
1.20 paf 131: // if we have one, return it's string value, else return as usual: accumulated fstring or fvalue
132: return result ? result->get_string() : WContext::get_string();
133: }
134:
1.40 paf 135: /// VMethodFrame: my or self_transparent or $caller
1.51 paf 136: override Value* get_element(const String& aname, Value& /*aself*/, bool looking_up) {
1.42 paf 137: if(aname==CALLER_ELEMENT_NAME)
1.40 paf 138: return caller();
1.42 paf 139:
1.67 ! misha 140: if(aname==SELF_ELEMENT_NAME)
! 141: return &self();
! 142:
1.66 misha 143: Value* result;
144: if(my && (result=my->get(aname)))
145: return result;
146:
147: if(result=self().get_element(aname, self(), looking_up))
148: return result;
1.40 paf 149:
150: return 0;
1.1 paf 151: }
152:
1.4 paf 153: /// VMethodFrame: self_transparent
1.46 paf 154: override VStateless_class* get_class() { return self().get_class(); }
1.44 paf 155:
156: /// VMethodFrame: self_transparent
1.46 paf 157: override Value* base() { return self().base(); }
1.1 paf 158:
1.64 misha 159: /// VMethodFrame: my or self_transparent
160: override const VJunction* put_element(Value& /*aself*/, const String& aname, Value* avalue, bool /*areplace*/) {
161: return (this->*put_element_impl)(aname, avalue);
162: }
163:
164: private:
165:
166: const VJunction* put_element_local(const String& aname, Value* avalue){
167: set_my_variable(aname, *avalue);
168: return PUT_ELEMENT_REPLACED_ELEMENT;
169: }
170:
171: const VJunction* put_element_global(const String& aname, Value* avalue){
172: if(my && my->put_replaced(aname, avalue))
173: return PUT_ELEMENT_REPLACED_ELEMENT;
174: return self().put_element(self(), aname, avalue, false/*=always, areplace*/);
175: }
176:
1.30 paf 177: public: // WContext
1.1 paf 178:
1.46 paf 179: override StringOrValue result() {
1.1 paf 180: // check the $result value
1.46 paf 181: Value* result_value=get_result_variable();
1.1 paf 182: // if we have one, return it, else return as usual: accumulated fstring or fvalue
1.52 paf 183: return result_value ? StringOrValue(*result_value) : WContext::result();
1.1 paf 184: }
185:
1.46 paf 186: void write(Value& avalue, String::Language alang) {
187: WContext::write(avalue, alang);
188: }
189:
1.1 paf 190: public: // usage
191:
1.46 paf 192: VMethodFrame(
1.40 paf 193: const Junction& ajunction/*info: always method-junction*/,
1.46 paf 194: VMethodFrame *acaller);
1.1 paf 195:
1.40 paf 196: VMethodFrame *caller() { return fcaller; }
1.25 paf 197:
1.38 paf 198: void set_self(Value& aself) { fself=&aself; }
1.41 paf 199: /// we sure that someone already set our self with VMethodFrame::set_self(Value&)
200: Value& self() { return *fself; }
1.1 paf 201:
1.27 paf 202: bool can_store_param() {
203: const Method& method=*junction.method;
1.46 paf 204: return method.params_names && store_param_index<method.params_names->count();
1.27 paf 205: }
1.46 paf 206: void store_param(Value& value) {
1.1 paf 207: const Method& method=*junction.method;
1.46 paf 208: size_t max_params=
1.1 paf 209: method.max_numbered_params_count?method.max_numbered_params_count:
1.46 paf 210: method.params_names?method.params_names->count():
1.1 paf 211: 0;
212: if(store_param_index==max_params)
1.61 misha 213: throw Exception(PARSER_RUNTIME,
1.46 paf 214: 0, //&name(),
1.7 paf 215: "method of %s (%s) accepts maximum %d parameter(s)",
1.38 paf 216: junction.self.get_class()->name_cstr(),
217: junction.self.type(),
1.1 paf 218: max_params);
219:
1.46 paf 220: if(fnumbered_params) { // are this method params numbered?
221: *fnumbered_params+=&value;
1.1 paf 222: } else { // named param
1.25 paf 223: // speedup: not checking for clash with "result" fname
1.46 paf 224: const String& fname=*(*method.params_names)[store_param_index];
1.25 paf 225: set_my_variable(fname, value);
1.1 paf 226: }
227: store_param_index++;
228: }
229: void fill_unspecified_params() {
230: const Method &method=*junction.method;
1.46 paf 231: if(method.params_names) { // there are any named parameters might need filling?
232: size_t param_count=method.params_names->count();
233: for(; store_param_index<param_count; store_param_index++) {
234: const String& fname=*(*method.params_names)[store_param_index];
235: my->put(fname, new VVoid);
1.1 paf 236: }
1.46 paf 237: }
1.1 paf 238: }
239:
1.46 paf 240: MethodParams* numbered_params() { return fnumbered_params; }
1.18 paf 241:
1.63 misha 242: protected:
1.18 paf 243:
1.46 paf 244: void set_my_variable(const String& fname, Value& value) {
245: my->put(fname, &value); // remember param
1.25 paf 246: }
247:
1.46 paf 248: Value* get_result_variable();
1.1 paf 249:
250: public:
251:
252: const Junction& junction;
253:
1.41 paf 254: };
255:
256: /// Auto-object used for temporary changing VMethod_frame::fself.
257: class Temp_method_frame_self {
258: VMethodFrame& fmethod_frame;
1.46 paf 259: Value* saved_self;
1.41 paf 260: public:
261: Temp_method_frame_self(VMethodFrame& amethod_frame, Value& aself) :
262: fmethod_frame(amethod_frame),
1.46 paf 263: saved_self(&amethod_frame.self()) {
1.41 paf 264: fmethod_frame.set_self(aself);
265: }
266: ~Temp_method_frame_self() {
1.46 paf 267: fmethod_frame.set_self(*saved_self);
1.41 paf 268: }
1.1 paf 269: };
270:
271: #endif
E-mail: