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

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

E-mail: