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

1.3       paf         1: /** @file
1.5       paf         2:        Parser: @b method_frame write context
1.3       paf         3: 
1.49      paf         4:        Copyright (c) 2001-2004 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.57    ! paf        11: static const char * const IDENT_VMETHOD_FRAME_H="$Date: 2005/08/09 07:37:12 $";
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:        }
                     56:        /// handy expression auto-processing to double
                     57:        double as_double(int index, const char* msg, Request& r) { 
1.56      paf        58:                Value* value=get(index);
1.57    ! paf        59:                if(!value->is_number())
        !            60:                        value=&get_processed(value, msg, index, r);
        !            61:                return value->as_double(); 
1.46      paf        62:        }
                     63:        /// handy expression auto-processing to int
                     64:        int as_int(int index, const char* msg, Request& r) { 
1.56      paf        65:                Value* value=get(index);
1.57    ! paf        66:                if(!value->is_number())
        !            67:                        value=&get_processed(value, msg, index, r);
        !            68:                return value->as_int(); 
1.46      paf        69:        }
                     70:        /// handy expression auto-processing to bool
                     71:        bool as_bool(int index, const char* msg, Request& r) { 
1.56      paf        72:                Value* value=get(index);
                     73:                return get_processed(value, msg, index, r).as_bool(); 
1.46      paf        74:        }
                     75:        /// handy string ensurer
                     76:        const String& as_string(int index, const char* msg) { 
                     77:                return as_no_junction(index, msg).as_string();
                     78:        }
                     79: 
                     80: private:
                     81: 
                     82:        /// handy value-is/not-a-junction ensurer
1.56      paf        83:        Value& get_as(Value* value, bool as_junction, const char* msg, int index) { 
                     84:                if((value->get_junction()!=0) ^ as_junction)
1.46      paf        85:                        throw Exception("parser.runtime",
                     86:                                0,
                     87:                                "%s (parameter #%d)", msg, 1+index);
                     88: 
1.56      paf        89:                return *value;
1.46      paf        90:        }
                     91: 
1.56      paf        92:        Value& get_processed(Value* value, const char* msg, int index, Request& r);
1.46      paf        93: 
                     94: };
                     95: 
1.4       paf        96: /**    Method frame write context
                     97:        accepts values written by method code
                     98:        also handles method parameters and local variables
1.3       paf        99: */
1.46      paf       100: class VMethodFrame: public WContext {
                    101:        VMethodFrame *fcaller;
                    102: 
                    103:        size_t store_param_index;
                    104:        HashStringValue* my;/*OR*/MethodParams* fnumbered_params;
                    105:        Value* fself;
                    106: 
                    107:        Value* fresult_initial_void;
                    108: 
1.1       paf       109: public: // Value
                    110: 
1.46      paf       111:        override const char* type() const { return "method_frame"; }
1.20      paf       112: 
                    113:        /// VMethodFrame: $result | parent get_string(=accumulated fstring)
1.46      paf       114:        override const String* get_string() { 
1.20      paf       115:                // check the $result value
1.46      paf       116:                Value* result=get_result_variable();
1.20      paf       117:                // if we have one, return it's string value, else return as usual: accumulated fstring or fvalue
                    118:                return result ? result->get_string() : WContext::get_string();
                    119:        }
                    120:        
1.40      paf       121:        /// VMethodFrame: my or self_transparent or $caller
1.51      paf       122:        override Value* get_element(const String& aname, Value& /*aself*/, bool looking_up) { 
1.46      paf       123:                if(my) {
                    124:                        if(Value* result=my->get(aname))
1.1       paf       125:                                return result;
                    126:                }
1.51      paf       127:                if(Value* result=self().get_element(aname, self(), looking_up))
1.40      paf       128:                        return result;
                    129: 
1.42      paf       130:                if(aname==CALLER_ELEMENT_NAME)
1.40      paf       131:                        return caller();
1.42      paf       132: 
                    133:                if(aname==SELF_ELEMENT_NAME)
                    134:                        return &self();
1.40      paf       135: 
                    136:                return 0;
1.1       paf       137:        }
1.4       paf       138:        /// VMethodFrame: my or self_transparent
1.55      paf       139:        override const VJunction* put_element(Value& /*aself*/, const String& aname, Value* avalue, bool /*areplace*/) { 
1.53      paf       140:                if(my && my->put_replaced(aname, avalue))
1.52      paf       141:                        return PUT_ELEMENT_REPLACED_ELEMENT;
1.32      paf       142: 
1.54      paf       143:                return self().put_element(self(), aname, avalue, false/*=always, areplace*/);
1.1       paf       144:        }
                    145: 
1.4       paf       146:        /// VMethodFrame: self_transparent
1.46      paf       147:        override VStateless_class* get_class() { return self().get_class(); }
1.44      paf       148: 
                    149:        /// VMethodFrame: self_transparent
1.46      paf       150:        override Value* base() { return self().base(); }
1.1       paf       151: 
1.30      paf       152: public: // WContext
1.1       paf       153: 
1.46      paf       154:        override StringOrValue result() {
1.1       paf       155:                // check the $result value
1.46      paf       156:                Value* result_value=get_result_variable();
1.1       paf       157:                // if we have one, return it, else return as usual: accumulated fstring or fvalue
1.52      paf       158:                return result_value ? StringOrValue(*result_value) : WContext::result();
1.1       paf       159:        }
                    160: 
1.46      paf       161:        void write(Value& avalue, String::Language alang) {
                    162:                WContext::write(avalue, alang);
                    163:        }
                    164: 
1.1       paf       165: public: // usage
                    166: 
1.46      paf       167:        VMethodFrame(
1.40      paf       168:                const Junction& ajunction/*info: always method-junction*/,
1.46      paf       169:                VMethodFrame *acaller);
1.1       paf       170: 
1.40      paf       171:        VMethodFrame *caller() { return fcaller; }
1.25      paf       172: 
1.38      paf       173:        void set_self(Value& aself) { fself=&aself; }
1.41      paf       174:        /// we sure that someone already set our self with VMethodFrame::set_self(Value&)
                    175:        Value& self() { return *fself; }
1.1       paf       176: 
1.27      paf       177:        bool can_store_param() {
                    178:                const Method& method=*junction.method;
1.46      paf       179:                return method.params_names && store_param_index<method.params_names->count();
1.27      paf       180:        }
1.46      paf       181:        void store_param(Value& value) {
1.1       paf       182:                const Method& method=*junction.method;
1.46      paf       183:                size_t max_params=
1.1       paf       184:                        method.max_numbered_params_count?method.max_numbered_params_count:
1.46      paf       185:                        method.params_names?method.params_names->count():
1.1       paf       186:                        0;
                    187:                if(store_param_index==max_params)
1.23      paf       188:                        throw Exception("parser.runtime",
1.46      paf       189:                                0, //&name(),
1.7       paf       190:                                "method of %s (%s) accepts maximum %d parameter(s)", 
1.38      paf       191:                                        junction.self.get_class()->name_cstr(),
                    192:                                        junction.self.type(),
1.1       paf       193:                                        max_params);
                    194:                
1.46      paf       195:                if(fnumbered_params) { // are this method params numbered?
                    196:                        *fnumbered_params+=&value;
1.1       paf       197:                } else { // named param
1.25      paf       198:                        // speedup: not checking for clash with "result" fname
1.46      paf       199:                        const String& fname=*(*method.params_names)[store_param_index];
1.25      paf       200:                        set_my_variable(fname, value);
1.1       paf       201:                }
                    202:                store_param_index++;
                    203:        }
                    204:        void fill_unspecified_params() {
                    205:                const Method &method=*junction.method;
1.46      paf       206:                if(method.params_names) { // there are any named parameters might need filling?
                    207:                        size_t param_count=method.params_names->count();
                    208:                        for(; store_param_index<param_count; store_param_index++) {
                    209:                                const String& fname=*(*method.params_names)[store_param_index];
                    210:                                my->put(fname, new VVoid);
1.1       paf       211:                        }
1.46      paf       212:                }
1.1       paf       213:        }
                    214: 
1.46      paf       215:        MethodParams* numbered_params() { return fnumbered_params; }
1.18      paf       216: 
                    217: private:
                    218: 
1.46      paf       219:        void set_my_variable(const String& fname, Value& value) {
                    220:                my->put(fname, &value); // remember param
1.25      paf       221:        }
                    222: 
1.46      paf       223:        Value* get_result_variable();
1.1       paf       224: 
                    225: public:
                    226:        
                    227:        const Junction& junction;
                    228: 
1.41      paf       229: };
                    230: 
                    231: ///    Auto-object used for temporary changing VMethod_frame::fself.
                    232: class Temp_method_frame_self {
                    233:        VMethodFrame& fmethod_frame;
1.46      paf       234:        Value* saved_self;
1.41      paf       235: public:
                    236:        Temp_method_frame_self(VMethodFrame& amethod_frame, Value& aself) :
                    237:                fmethod_frame(amethod_frame),
1.46      paf       238:                saved_self(&amethod_frame.self()) {
1.41      paf       239:                fmethod_frame.set_self(aself);
                    240:        }
                    241:        ~Temp_method_frame_self() {
1.46      paf       242:                fmethod_frame.set_self(*saved_self);
1.41      paf       243:        }
1.1       paf       244: };
                    245: 
                    246: #endif

E-mail: