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

1.3       paf         1: /** @file
1.5       paf         2:        Parser: @b method_frame write context
1.3       paf         3: 
1.98      moko        4:        Copyright (c) 2001-2015 Art. Lebedev Studio (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.100   ! moko       11: #define IDENT_PA_VMETHOD_FRAME_H "$Id: pa_vmethod_frame.h,v 1.99 2016/04/01 16:27:32 moko Exp $"
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.81      misha      22: extern const String result_var_name, caller_element_name, self_element_name;
1.40      paf        23: 
1.46      paf        24: // forwards
                     25: 
                     26: class Request;
                     27: 
                     28: /**
                     29:        @b method parameters passed in this array.
                     30:        contains handy typecast ad junction/not junction ensurers
                     31: 
                     32: */
1.78      misha      33: class MethodParams {
1.46      paf        34: public:
1.78      misha      35:        MethodParams() : felements(0), fused(0){}
                     36: 
1.82      misha      37: #ifdef USE_DESTRUCTORS
                     38:        ~MethodParams(){
                     39:                Value **flast=felements+count();
1.95      moko       40:                for(Value **current=felements;current<flast;current++){
                     41:                        Junction* junction=(*current)->get_junction();
                     42:                        if (junction && junction->code)
1.82      misha      43:                                delete *current;
1.95      moko       44:                }
1.82      misha      45:        }
                     46: #endif
                     47: 
1.77      misha      48:        void store_params(Value **params, size_t count){ 
1.78      misha      49:                felements=params;
1.77      misha      50:                fused=count;
                     51:        }
                     52: 
1.78      misha      53:        inline size_t count() const { return fused; }
                     54: 
                     55:        inline Value *get(size_t index) const {
                     56:                assert(index<count());
                     57:                return felements[index];
                     58:        }
                     59: 
1.77      misha      60:        inline Value& operator[] (size_t index) { return *get(index); }
1.46      paf        61: 
                     62:        Value& last() { return *get(count()-1); }
                     63: 
                     64:        /// handy is-value-a-junction ensurer
                     65:        Value& as_junction(int index, const char* msg) { 
1.56      paf        66:                Value* value=get(index);
                     67:                return as_junction(value, msg, index); 
                     68:        }
                     69:        /// handy is-value-a-junction ensurer
                     70:        Value& as_junction(Value* value, const char* msg, int index) { 
                     71:                return get_as(value, true, msg, index); 
1.46      paf        72:        }
                     73:        /// handy value-is-not-a-junction ensurer
                     74:        Value& as_no_junction(int index, const char* msg) { 
1.56      paf        75:                Value* value=get(index);
                     76:                return as_no_junction(value, msg, index); 
                     77:        }
                     78:        /// handy value-is-not-a-junction ensurer
                     79:        Value& as_no_junction(Value* value, const char* msg, int index) { 
                     80:                return get_as(value, false, msg, index); 
1.46      paf        81:        }
1.62      misha      82:        /// handy is-value-a-junction ensurer or can be auto-processed
                     83:        Value& as_expression(int index, const char* msg) { 
                     84:                Value* value=get(index);
                     85:                if(value->is_evaluated_expr()){
                     86:                        return *value;
                     87:                } else {
                     88:                        return get_as(value, true, msg, index);
                     89:                }
                     90:        }
1.46      paf        91:        /// handy expression auto-processing to double
                     92:        double as_double(int index, const char* msg, Request& r) { 
1.56      paf        93:                Value* value=get(index);
1.60      paf        94:                if(!value->is_evaluated_expr())
1.57      paf        95:                        value=&get_processed(value, msg, index, r);
                     96:                return value->as_double(); 
1.46      paf        97:        }
                     98:        /// handy expression auto-processing to int
                     99:        int as_int(int index, const char* msg, Request& r) { 
1.56      paf       100:                Value* value=get(index);
1.60      paf       101:                if(!value->is_evaluated_expr())
1.57      paf       102:                        value=&get_processed(value, msg, index, r);
                    103:                return value->as_int(); 
1.46      paf       104:        }
                    105:        /// handy expression auto-processing to bool
                    106:        bool as_bool(int index, const char* msg, Request& r) { 
1.56      paf       107:                Value* value=get(index);
1.60      paf       108:                if(!value->is_evaluated_expr())
1.59      paf       109:                        value=&get_processed(value, msg, index, r);
                    110:                return value->as_bool(); 
1.46      paf       111:        }
                    112:        /// handy string ensurer
                    113:        const String& as_string(int index, const char* msg) { 
                    114:                return as_no_junction(index, msg).as_string();
                    115:        }
1.93      misha     116:        /// handy hash ensurers
                    117:        HashStringValue* as_hash(int index, const char* name=0);
                    118:        /// handy table ensurer
                    119:        Table* as_table(int index, const char* name=0);
                    120: 
1.46      paf       121: private:
                    122: 
1.78      misha     123:        Value **felements;
                    124:        size_t fused;
                    125: 
1.46      paf       126:        /// handy value-is/not-a-junction ensurer
1.56      paf       127:        Value& get_as(Value* value, bool as_junction, const char* msg, int index) { 
                    128:                if((value->get_junction()!=0) ^ as_junction)
1.61      misha     129:                        throw Exception(PARSER_RUNTIME,
1.46      paf       130:                                0,
                    131:                                "%s (parameter #%d)", msg, 1+index);
                    132: 
1.56      paf       133:                return *value;
1.46      paf       134:        }
                    135: 
1.56      paf       136:        Value& get_processed(Value* value, const char* msg, int index, Request& r);
1.46      paf       137: 
                    138: };
                    139: 
1.4       paf       140: /**    Method frame write context
                    141:        accepts values written by method code
                    142:        also handles method parameters and local variables
1.3       paf       143: */
1.46      paf       144: class VMethodFrame: public WContext {
1.63      misha     145: protected:
1.46      paf       146:        VMethodFrame *fcaller;
                    147: 
1.83      misha     148:        HashString<Value*>* my; /*OR*/ MethodParams fnumbered_params;
1.87      moko      149:        Value& fself;
1.46      paf       150: 
1.64      misha     151:        typedef const VJunction* (VMethodFrame::*put_element_t)(const String& aname, Value* avalue);
                    152:        put_element_t put_element_impl;
1.46      paf       153: 
1.1       paf       154: public: // Value
                    155: 
1.46      paf       156:        override const char* type() const { return "method_frame"; }
1.20      paf       157: 
                    158:        /// VMethodFrame: $result | parent get_string(=accumulated fstring)
1.46      paf       159:        override const String* get_string() { 
1.20      paf       160:                // check the $result value
1.46      paf       161:                Value* result=get_result_variable();
1.20      paf       162:                // if we have one, return it's string value, else return as usual: accumulated fstring or fvalue
                    163:                return result ? result->get_string() : WContext::get_string();
                    164:        }
                    165:        
1.40      paf       166:        /// VMethodFrame: my or self_transparent or $caller
1.84      misha     167:        override Value* get_element(const String& aname) { 
1.81      misha     168:                if(aname==caller_element_name)
1.40      paf       169:                        return caller();
1.42      paf       170: 
1.81      misha     171:                if(aname==self_element_name)
1.67      misha     172:                        return &self();
                    173: 
1.66      misha     174:                Value* result;
                    175:                if(my && (result=my->get(aname)))
                    176:                        return result;
                    177: 
1.84      misha     178:                if(result=self().get_element(aname))
1.66      misha     179:                        return result;
1.40      paf       180: 
                    181:                return 0;
1.1       paf       182:        }
                    183: 
1.4       paf       184:        /// VMethodFrame: self_transparent
1.46      paf       185:        override VStateless_class* get_class() { return self().get_class(); }
1.44      paf       186: 
                    187:        /// VMethodFrame: self_transparent
1.85      misha     188:        override VStateless_class* base() { return self().base(); }
1.1       paf       189: 
1.64      misha     190:        /// VMethodFrame: my or self_transparent
1.94      moko      191:        override const VJunction* put_element(const String& aname, Value* avalue) {
1.64      misha     192:                return (this->*put_element_impl)(aname, avalue);
                    193:        }
                    194: 
1.69      misha     195:        /// VMethodFrame: appends a fstring to result
                    196:        override void write(const String& astring, String::Language alang) {
1.79      misha     197: #ifdef OPTIMIZE_RESULT
1.87      moko      198:                switch (method.result_optimization){
1.97      moko      199:                        case Method::RO_USE_RESULT:
1.79      misha     200:                                return;
                    201:                        case Method::RO_UNKNOWN:
                    202:                                if(get_result_variable()){
1.87      moko      203:                                        ((Method *)&method)->result_optimization=Method::RO_USE_RESULT;
1.79      misha     204:                                        return;
                    205:                                }
1.97      moko      206:                        case Method::RO_USE_WCONTEXT: break;
1.69      misha     207:                }
1.79      misha     208: #endif
                    209:                WContext::write(astring, alang);
1.69      misha     210:        }
                    211: 
1.64      misha     212: private:
                    213: 
                    214:        const VJunction* put_element_local(const String& aname, Value* avalue){
                    215:                set_my_variable(aname, *avalue);
                    216:                return PUT_ELEMENT_REPLACED_ELEMENT;
                    217:        }
                    218: 
                    219:        const VJunction* put_element_global(const String& aname, Value* avalue){
                    220:                if(my && my->put_replaced(aname, avalue))
                    221:                        return PUT_ELEMENT_REPLACED_ELEMENT;
1.94      moko      222:                return self().put_element(aname, avalue);
1.64      misha     223:        }
                    224: 
1.30      paf       225: public: // WContext
1.1       paf       226: 
1.46      paf       227:        override StringOrValue result() {
1.80      misha     228:                if(my){
                    229:                        // check the $result value
                    230:                        Value* result_value=get_result_variable();
                    231:                        // if we have one, return it, else return as usual: accumulated fstring or fvalue
                    232:                        if(result_value)
                    233:                                return StringOrValue(*result_value);
1.79      misha     234: #ifdef OPTIMIZE_RESULT
1.87      moko      235:                        if(method.result_optimization==Method::RO_USE_RESULT)
1.80      misha     236:                                return StringOrValue(*VVoid::get());
1.87      moko      237:                        ((Method *)&method)->result_optimization=Method::RO_USE_WCONTEXT;
1.79      misha     238: #ifdef OPTIMIZE_CALL // nested as CO_WITHOUT_WCONTEXT assumes that $result not used
1.87      moko      239:                        ((Method *)&method)->call_optimization=Method::CO_WITHOUT_WCONTEXT;
1.79      misha     240: #endif
                    241: #endif
1.80      misha     242:                }
1.79      misha     243:                return WContext::result();
1.1       paf       244:        }
                    245: 
1.85      misha     246:        override void write(Value& avalue) {
                    247:                WContext::write(avalue);
1.46      paf       248:        }
                    249: 
1.1       paf       250: public: // usage
                    251: 
1.87      moko      252:        VMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself);
1.1       paf       253: 
1.40      paf       254:        VMethodFrame *caller() { return fcaller; }
1.25      paf       255: 
1.76      misha     256: #ifdef USE_DESTRUCTORS
1.75      misha     257:        ~VMethodFrame(){
                    258:                if(my){
                    259:                        delete my;
                    260:                }
                    261:        }
1.76      misha     262: #endif
1.75      misha     263: 
1.87      moko      264:        Value& self() { return fself; }
1.1       paf       265: 
1.77      misha     266:        size_t method_params_count() {
                    267:                return method.params_names ? method.params_names->count():0;
1.27      paf       268:        }
1.77      misha     269: 
                    270:        void store_params(Value **params, size_t count) {
1.92      moko      271:                if(my) {
                    272:                        size_t param_count=method.params_names ? method.params_names->count():0;
1.89      moko      273:                        size_t i=0;
                    274: 
                    275:                        if(count>param_count){
                    276:                                if(method.extra_params){
                    277:                                        for(; i<param_count; i++) {
                    278:                                                const String& fname=*(*method.params_names)[i];
                    279:                                                set_my_variable(fname, *params[i]);
                    280:                                        }
                    281: 
                    282:                                        VHash& vargs=*new VHash();
                    283:                                        HashStringValue& args = vargs.hash();
                    284: 
                    285:                                        for(; i<count; i++) {
                    286:                                                args.put(format(args.count(), 0), params[i]);
                    287:                                        }
1.86      misha     288: 
1.89      moko      289:                                        set_my_variable(*method.extra_params, vargs);
                    290:                                        return;
                    291:                                } else
1.86      misha     292:                                throw Exception(PARSER_RUNTIME,
                    293:                                        0, //&name(),
1.99      moko      294:                                        "method of %s accepts maximum %d parameter(s) (%d present)", 
1.87      moko      295:                                        self().type(),
1.86      misha     296:                                        param_count,
                    297:                                        count);
1.89      moko      298:                        }
1.78      misha     299: 
1.86      misha     300:                        for(; i<count; i++) {
1.77      misha     301:                                const String& fname=*(*method.params_names)[i];
                    302:                                set_my_variable(fname, *params[i]);
                    303:                        }
                    304: 
                    305:                        for(; i<param_count; i++) {
                    306:                                const String& fname=*(*method.params_names)[i];
1.68      misha     307:                                my->put(fname, VVoid::get());
1.1       paf       308:                        }
1.86      misha     309:                } else
1.77      misha     310:                        fnumbered_params.store_params(params,count);
1.1       paf       311:        }
                    312: 
1.78      misha     313:        void empty_params(){
                    314:                if(method.params_names){
                    315:                        size_t param_count=method.params_names->count();
1.91      moko      316:                        if(param_count>0){
                    317:                                const String& fname=*(*method.params_names)[0];
                    318:                                my->put(fname, VString::empty());
                    319:                                for(size_t i=1; i<param_count; i++) {
                    320:                                        const String& fname=*(*method.params_names)[i];
                    321:                                        my->put(fname, VVoid::get());
                    322:                                }
1.78      misha     323:                        }
                    324:                }
                    325:        }
                    326: 
1.72      misha     327:        MethodParams* numbered_params() { return &fnumbered_params; }
1.18      paf       328: 
1.63      misha     329: protected:
1.18      paf       330: 
1.46      paf       331:        void set_my_variable(const String& fname, Value& value) {
                    332:                my->put(fname, &value); // remember param
1.25      paf       333:        }
                    334: 
1.46      paf       335:        Value* get_result_variable();
1.1       paf       336: 
                    337: public:
                    338:        
1.87      moko      339:        const Method& method;
1.1       paf       340: 
1.41      paf       341: };
                    342: 
1.85      misha     343: class VConstructorFrame: public VMethodFrame {
                    344: public:
1.87      moko      345:        VConstructorFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VMethodFrame(amethod, acaller, aself) {
                    346:                // prevent non-string writes for better error reporting [constructors are not expected to return anything]
                    347:                VMethodFrame::write(aself);
                    348:        }
1.85      misha     349: 
                    350:        override void write(const String& /*astring*/, String::Language /*alang*/) {}
                    351: };
                    352: 
1.1       paf       353: #endif

E-mail: