Annotation of parser3/src/types/pa_vmethod_frame.h, revision 1.62

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.62    ! misha      11: static const char * const IDENT_VMETHOD_FRAME_H="$Date: 2007/04/23 10:30:50 $";
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 {
                    112:        VMethodFrame *fcaller;
                    113: 
                    114:        size_t store_param_index;
                    115:        HashStringValue* my;/*OR*/MethodParams* fnumbered_params;
                    116:        Value* fself;
                    117: 
                    118:        Value* fresult_initial_void;
                    119: 
1.1       paf       120: public: // Value
                    121: 
1.46      paf       122:        override const char* type() const { return "method_frame"; }
1.20      paf       123: 
                    124:        /// VMethodFrame: $result | parent get_string(=accumulated fstring)
1.46      paf       125:        override const String* get_string() { 
1.20      paf       126:                // check the $result value
1.46      paf       127:                Value* result=get_result_variable();
1.20      paf       128:                // if we have one, return it's string value, else return as usual: accumulated fstring or fvalue
                    129:                return result ? result->get_string() : WContext::get_string();
                    130:        }
                    131:        
1.40      paf       132:        /// VMethodFrame: my or self_transparent or $caller
1.51      paf       133:        override Value* get_element(const String& aname, Value& /*aself*/, bool looking_up) { 
1.46      paf       134:                if(my) {
                    135:                        if(Value* result=my->get(aname))
1.1       paf       136:                                return result;
                    137:                }
1.51      paf       138:                if(Value* result=self().get_element(aname, self(), looking_up))
1.40      paf       139:                        return result;
                    140: 
1.42      paf       141:                if(aname==CALLER_ELEMENT_NAME)
1.40      paf       142:                        return caller();
1.42      paf       143: 
                    144:                if(aname==SELF_ELEMENT_NAME)
                    145:                        return &self();
1.40      paf       146: 
                    147:                return 0;
1.1       paf       148:        }
1.4       paf       149:        /// VMethodFrame: my or self_transparent
1.55      paf       150:        override const VJunction* put_element(Value& /*aself*/, const String& aname, Value* avalue, bool /*areplace*/) { 
1.53      paf       151:                if(my && my->put_replaced(aname, avalue))
1.52      paf       152:                        return PUT_ELEMENT_REPLACED_ELEMENT;
1.32      paf       153: 
1.54      paf       154:                return self().put_element(self(), aname, avalue, false/*=always, areplace*/);
1.1       paf       155:        }
                    156: 
1.4       paf       157:        /// VMethodFrame: self_transparent
1.46      paf       158:        override VStateless_class* get_class() { return self().get_class(); }
1.44      paf       159: 
                    160:        /// VMethodFrame: self_transparent
1.46      paf       161:        override Value* base() { return self().base(); }
1.1       paf       162: 
1.30      paf       163: public: // WContext
1.1       paf       164: 
1.46      paf       165:        override StringOrValue result() {
1.1       paf       166:                // check the $result value
1.46      paf       167:                Value* result_value=get_result_variable();
1.1       paf       168:                // if we have one, return it, else return as usual: accumulated fstring or fvalue
1.52      paf       169:                return result_value ? StringOrValue(*result_value) : WContext::result();
1.1       paf       170:        }
                    171: 
1.46      paf       172:        void write(Value& avalue, String::Language alang) {
                    173:                WContext::write(avalue, alang);
                    174:        }
                    175: 
1.1       paf       176: public: // usage
                    177: 
1.46      paf       178:        VMethodFrame(
1.40      paf       179:                const Junction& ajunction/*info: always method-junction*/,
1.46      paf       180:                VMethodFrame *acaller);
1.1       paf       181: 
1.40      paf       182:        VMethodFrame *caller() { return fcaller; }
1.25      paf       183: 
1.38      paf       184:        void set_self(Value& aself) { fself=&aself; }
1.41      paf       185:        /// we sure that someone already set our self with VMethodFrame::set_self(Value&)
                    186:        Value& self() { return *fself; }
1.1       paf       187: 
1.27      paf       188:        bool can_store_param() {
                    189:                const Method& method=*junction.method;
1.46      paf       190:                return method.params_names && store_param_index<method.params_names->count();
1.27      paf       191:        }
1.46      paf       192:        void store_param(Value& value) {
1.1       paf       193:                const Method& method=*junction.method;
1.46      paf       194:                size_t max_params=
1.1       paf       195:                        method.max_numbered_params_count?method.max_numbered_params_count:
1.46      paf       196:                        method.params_names?method.params_names->count():
1.1       paf       197:                        0;
                    198:                if(store_param_index==max_params)
1.61      misha     199:                        throw Exception(PARSER_RUNTIME,
1.46      paf       200:                                0, //&name(),
1.7       paf       201:                                "method of %s (%s) accepts maximum %d parameter(s)", 
1.38      paf       202:                                        junction.self.get_class()->name_cstr(),
                    203:                                        junction.self.type(),
1.1       paf       204:                                        max_params);
                    205:                
1.46      paf       206:                if(fnumbered_params) { // are this method params numbered?
                    207:                        *fnumbered_params+=&value;
1.1       paf       208:                } else { // named param
1.25      paf       209:                        // speedup: not checking for clash with "result" fname
1.46      paf       210:                        const String& fname=*(*method.params_names)[store_param_index];
1.25      paf       211:                        set_my_variable(fname, value);
1.1       paf       212:                }
                    213:                store_param_index++;
                    214:        }
                    215:        void fill_unspecified_params() {
                    216:                const Method &method=*junction.method;
1.46      paf       217:                if(method.params_names) { // there are any named parameters might need filling?
                    218:                        size_t param_count=method.params_names->count();
                    219:                        for(; store_param_index<param_count; store_param_index++) {
                    220:                                const String& fname=*(*method.params_names)[store_param_index];
                    221:                                my->put(fname, new VVoid);
1.1       paf       222:                        }
1.46      paf       223:                }
1.1       paf       224:        }
                    225: 
1.46      paf       226:        MethodParams* numbered_params() { return fnumbered_params; }
1.18      paf       227: 
                    228: private:
                    229: 
1.46      paf       230:        void set_my_variable(const String& fname, Value& value) {
                    231:                my->put(fname, &value); // remember param
1.25      paf       232:        }
                    233: 
1.46      paf       234:        Value* get_result_variable();
1.1       paf       235: 
                    236: public:
                    237:        
                    238:        const Junction& junction;
                    239: 
1.41      paf       240: };
                    241: 
                    242: ///    Auto-object used for temporary changing VMethod_frame::fself.
                    243: class Temp_method_frame_self {
                    244:        VMethodFrame& fmethod_frame;
1.46      paf       245:        Value* saved_self;
1.41      paf       246: public:
                    247:        Temp_method_frame_self(VMethodFrame& amethod_frame, Value& aself) :
                    248:                fmethod_frame(amethod_frame),
1.46      paf       249:                saved_self(&amethod_frame.self()) {
1.41      paf       250:                fmethod_frame.set_self(aself);
                    251:        }
                    252:        ~Temp_method_frame_self() {
1.46      paf       253:                fmethod_frame.set_self(*saved_self);
1.41      paf       254:        }
1.1       paf       255: };
                    256: 
                    257: #endif

E-mail: