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

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

E-mail: