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

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

E-mail: