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

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.115   ! moko       11: #define IDENT_PA_VMETHOD_FRAME_H "$Id: pa_vmethod_frame.h,v 1.114 2016/11/03 16:17:38 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
1.114     moko       25: */
1.46      paf        26: 
1.78      misha      27: class MethodParams {
1.46      paf        28: public:
1.109     moko       29:        MethodParams() : felements(0), fused(0) {}
1.78      misha      30: 
1.82      misha      31: #ifdef USE_DESTRUCTORS
1.109     moko       32:        ~MethodParams() {
1.82      misha      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.111     moko       37:                                delete (VJunction*)(*current);
1.95      moko       38:                }
1.82      misha      39:        }
                     40: #endif
                     41: 
1.109     moko       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: 
1.108     moko       49:        inline Value& get(size_t index) const {
1.78      misha      50:                assert(index<count());
1.108     moko       51:                return *felements[index];
1.78      misha      52:        }
                     53: 
1.108     moko       54:        inline Value& operator[] (size_t index) { return get(index); }
1.46      paf        55: 
                     56:        /// handy is-value-a-junction ensurer
1.109     moko       57:        Value& as_junction(int index, const char* msg) {
1.108     moko       58:                Value& value=get(index);
1.110     moko       59:                if(value.get_junction())
                     60:                        return value;
                     61:                throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d)", msg, 1+index);
1.46      paf        62:        }
1.107     moko       63: 
1.46      paf        64:        /// handy value-is-not-a-junction ensurer
1.109     moko       65:        Value& as_no_junction(int index, const char* msg) {
1.108     moko       66:                Value& value=get(index);
1.110     moko       67:                if(!value.get_junction())
                     68:                        return value;
                     69:                throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d)", msg, 1+index);
1.46      paf        70:        }
1.107     moko       71: 
1.62      misha      72:        /// handy is-value-a-junction ensurer or can be auto-processed
1.109     moko       73:        Value& as_expression(int index, const char* msg) {
1.108     moko       74:                Value& value=get(index);
1.110     moko       75:                if(value.is_evaluated_expr())
1.107     moko       76:                        return value;
1.110     moko       77:                if(value.get_junction())
1.107     moko       78:                        return value;
1.110     moko       79:                throw Exception(PARSER_RUNTIME, 0, "%s (parameter #%d)", msg, 1+index);
1.62      misha      80:        }
1.107     moko       81: 
1.46      paf        82:        /// handy expression auto-processing to double
1.107     moko       83:        double as_double(int index, const char* msg, Request& r) {
1.108     moko       84:                Value& value=get(index);
1.107     moko       85:                if(value.is_evaluated_expr())
                     86:                        return value.as_double();
                     87:                return get_processed(value, msg, index, r).as_double();
1.46      paf        88:        }
1.107     moko       89: 
1.46      paf        90:        /// handy expression auto-processing to int
1.107     moko       91:        int as_int(int index, const char* msg, Request& r) {
1.108     moko       92:                Value& value=get(index);
1.107     moko       93:                if(value.is_evaluated_expr())
                     94:                        return value.as_int();
                     95:                return get_processed(value, msg, index, r).as_int();
1.46      paf        96:        }
1.107     moko       97: 
1.46      paf        98:        /// handy expression auto-processing to bool
1.107     moko       99:        bool as_bool(int index, const char* msg, Request& r) {
1.108     moko      100:                Value& value=get(index);
1.107     moko      101:                if(value.is_evaluated_expr())
                    102:                        return value.as_bool();
                    103:                return get_processed(value, msg, index, r).as_bool();
1.46      paf       104:        }
1.107     moko      105: 
1.46      paf       106:        /// handy string ensurer
1.109     moko      107:        const String& as_string(int index, const char* msg) {
1.46      paf       108:                return as_no_junction(index, msg).as_string();
                    109:        }
1.107     moko      110: 
1.93      misha     111:        /// handy hash ensurers
                    112:        HashStringValue* as_hash(int index, const char* name=0);
1.107     moko      113: 
1.93      misha     114:        /// handy table ensurer
                    115:        Table* as_table(int index, const char* name=0);
                    116: 
1.46      paf       117: private:
                    118: 
1.78      misha     119:        Value **felements;
                    120:        size_t fused;
                    121: 
1.107     moko      122:        Value& get_processed(Value& value, const char* msg, int index, Request& r);
1.46      paf       123: 
                    124: };
                    125: 
1.114     moko      126: /**
                    127:        Method frame write context
1.4       paf       128:        accepts values written by method code
1.3       paf       129: */
1.114     moko      130: 
1.46      paf       131: class VMethodFrame: public WContext {
1.63      misha     132: protected:
1.46      paf       133:        VMethodFrame *fcaller;
1.114     moko      134:        Value& fself;
                    135: 
                    136: public: // Value
                    137: 
                    138:        override const char* type() const { return "method_frame"; }
                    139: 
                    140:        /// VMethodFrame: self_transparent
                    141:        override VStateless_class* get_class() { return self().get_class(); }
                    142: 
                    143:        /// VMethodFrame: self_transparent
                    144:        override VStateless_class* base() { return self().base(); }
                    145: 
                    146: public: // usage
                    147: 
                    148:        VMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself):
                    149:                WContext(0 /* no parent, junctions can be reattached only up to VMethodFrame */),
                    150:                fcaller(acaller),
                    151:                fself(aself),
                    152:                method(amethod) {
                    153:        }
                    154: 
                    155:        VMethodFrame *caller() { return fcaller; }
                    156: 
                    157:        Value& self() { return fself; }
                    158: 
                    159:        void check_call_type(){
1.115   ! moko      160:                if(method.call_type==Method::CT_ANY)
        !           161:                        return;
        !           162: 
1.114     moko      163:                Method::Call_type call_type=self().get_class()==&self() ? Method::CT_STATIC : Method::CT_DYNAMIC;
1.115   ! moko      164: 
        !           165:                 if(method.call_type!=call_type) // call type not allowed?
1.114     moko      166:                        throw Exception(PARSER_RUNTIME, 0, "is not allowed to be called %s", call_type==Method::CT_STATIC ? "statically" : "dynamically");
                    167:        }
                    168: 
                    169: public:
                    170: 
                    171:        const Method& method;
                    172: };
1.46      paf       173: 
                    174: 
1.114     moko      175: class VNativeMethodFrame: public VMethodFrame {
                    176: protected:
                    177:        MethodParams fnumbered_params;
1.46      paf       178: 
1.1       paf       179: public: // Value
                    180: 
1.114     moko      181:        /// VNativeMethodFrame: self_transparent or $caller
                    182:        override Value* get_element(const String& aname) {
                    183:                if(SYMBOLS_EQ(aname,CALLER_SYMBOL))
                    184:                        return caller();
                    185: 
                    186:                if(SYMBOLS_EQ(aname,SELF_SYMBOL))
                    187:                        return &self();
                    188: 
                    189:                if(Value* result=self().get_element(aname))
                    190:                        return result;
                    191: 
                    192:                return 0;
                    193:        }
                    194: 
                    195:        /// VNativeMethodFrame: self_transparent
                    196:        override const VJunction* put_element(const String& aname, Value* avalue) {
                    197:                return self().put_element(aname, avalue);
                    198:        }
                    199: 
                    200: public: // usage
                    201: 
                    202:        VNativeMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VMethodFrame(amethod, acaller, aself){}
                    203: 
                    204:        void store_params(Value **params, size_t count) {
                    205:                fnumbered_params.store_params(params, count);
                    206:                method.check_actual_numbered_params(self(), &fnumbered_params);
                    207:        }
                    208: 
                    209:        void empty_params() {
                    210:                method.check_actual_numbered_params(self(), &fnumbered_params);
                    211:        }
                    212: 
                    213:        void call(Request &r);
                    214: 
                    215: };
                    216: 
                    217: 
                    218: /**
                    219:        Handles named parameters and local variables
                    220: */
                    221: 
                    222: class VParserMethodFrame: public VMethodFrame {
                    223: protected:
                    224:        HashString<Value*> my;
                    225: 
                    226: public: // Value
1.20      paf       227: 
1.114     moko      228:        /// VParserMethodFrame: $result | parent get_string(=accumulated fstring)
1.109     moko      229:        override const String* get_string() {
1.20      paf       230:                // check the $result value
1.46      paf       231:                Value* result=get_result_variable();
1.20      paf       232:                // if we have one, return it's string value, else return as usual: accumulated fstring or fvalue
                    233:                return result ? result->get_string() : WContext::get_string();
                    234:        }
1.114     moko      235: 
                    236:        /// VParserMethodFrame: my or self_transparent or $caller
1.109     moko      237:        override Value* get_element(const String& aname) {
1.103     moko      238:                if(SYMBOLS_EQ(aname,CALLER_SYMBOL))
1.40      paf       239:                        return caller();
1.42      paf       240: 
1.103     moko      241:                if(SYMBOLS_EQ(aname,SELF_SYMBOL))
1.67      misha     242:                        return &self();
                    243: 
1.114     moko      244:                if(Value* result=my.get(aname))
1.66      misha     245:                        return result;
                    246: 
1.114     moko      247:                if(Value* result=self().get_element(aname))
1.66      misha     248:                        return result;
1.40      paf       249: 
                    250:                return 0;
1.1       paf       251:        }
                    252: 
1.114     moko      253:        /// VParserMethodFrame: my or self_transparent
1.94      moko      254:        override const VJunction* put_element(const String& aname, Value* avalue) {
1.114     moko      255:                if(my.put_replaced(aname, avalue))
                    256:                        return PUT_ELEMENT_REPLACED_ELEMENT;
                    257:                return self().put_element(aname, avalue);
1.64      misha     258:        }
                    259: 
1.114     moko      260: public: // WContext
                    261: 
                    262:        /// VParserMethodFrame: skip write when RO_USE_RESULT
1.112     moko      263:        override void write(const String& astring) {
1.79      misha     264: #ifdef OPTIMIZE_RESULT
1.87      moko      265:                switch (method.result_optimization){
1.97      moko      266:                        case Method::RO_USE_RESULT:
1.79      misha     267:                                return;
                    268:                        case Method::RO_UNKNOWN:
                    269:                                if(get_result_variable()){
1.87      moko      270:                                        ((Method *)&method)->result_optimization=Method::RO_USE_RESULT;
1.79      misha     271:                                        return;
                    272:                                }
1.97      moko      273:                        case Method::RO_USE_WCONTEXT: break;
1.69      misha     274:                }
1.79      misha     275: #endif
1.112     moko      276:                WContext::write(astring);
1.69      misha     277:        }
                    278: 
1.114     moko      279:        override void write(Value& avalue) {
                    280:                WContext::write(avalue);
1.64      misha     281:        }
                    282: 
1.105     moko      283:        override Value& result() {
1.114     moko      284:                // check the $result value
                    285:                Value* result_value=get_result_variable();
                    286:                // if we have one, return it, else return as usual: accumulated fstring or fvalue
                    287:                if(result_value)
                    288:                        return *result_value;
1.79      misha     289: #ifdef OPTIMIZE_RESULT
1.114     moko      290:                if(method.result_optimization==Method::RO_USE_RESULT)
                    291:                        return *VVoid::get();
                    292:                ((Method *)&method)->result_optimization=Method::RO_USE_WCONTEXT;
1.79      misha     293: #ifdef OPTIMIZE_CALL // nested as CO_WITHOUT_WCONTEXT assumes that $result not used
1.114     moko      294:                ((Method *)&method)->call_optimization=Method::CO_WITHOUT_WCONTEXT;
1.79      misha     295: #endif
                    296: #endif
                    297:                return WContext::result();
1.1       paf       298:        }
                    299: 
                    300: public: // usage
                    301: 
1.114     moko      302:        VParserMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself);
1.1       paf       303: 
1.114     moko      304:        void store_params(Value **params, size_t count) {
                    305:                size_t param_count=method.params_count;
                    306:                size_t i=0;
1.25      paf       307: 
1.114     moko      308:                if(count>param_count){
                    309:                        if(method.extra_params){
                    310:                                for(; i<param_count; i++) {
                    311:                                        const String& fname=*(*method.params_names)[i];
                    312:                                        set_my_variable(fname, *params[i]);
                    313:                                }
1.75      misha     314: 
1.114     moko      315:                                VHash& vargs=*new VHash();
                    316:                                HashStringValue& args = vargs.hash();
1.1       paf       317: 
1.114     moko      318:                                for(; i<count; i++) {
                    319:                                        args.put(format(args.count(), 0), params[i]);
                    320:                                }
1.77      misha     321: 
1.114     moko      322:                                set_my_variable(*method.extra_params, vargs);
                    323:                                return;
                    324:                        } else
                    325:                                throw Exception(PARSER_RUNTIME, 0, "method of %s accepts maximum %d parameter(s) (%d present)", self().type(), param_count, count);
                    326:                }
1.86      misha     327: 
1.114     moko      328:                for(; i<count; i++) {
                    329:                        const String& fname=*(*method.params_names)[i];
                    330:                        set_my_variable(fname, *params[i]);
                    331:                }
1.78      misha     332: 
1.114     moko      333:                for(; i<param_count; i++) {
                    334:                        const String& fname=*(*method.params_names)[i];
                    335:                        my.put(fname, VVoid::get());
                    336:                }
1.1       paf       337:        }
                    338: 
1.78      misha     339:        void empty_params(){
1.114     moko      340:                size_t param_count=method.params_count;
                    341:                if(param_count>0){
                    342:                        my.put(*(*method.params_names)[0], VString::empty());
                    343:                        for(size_t i=1; i<param_count; i++)
                    344:                                my.put(*(*method.params_names)[i], VVoid::get());
1.78      misha     345:                }
                    346:        }
                    347: 
1.114     moko      348:        void call(Request &r);
1.18      paf       349: 
1.63      misha     350: protected:
1.18      paf       351: 
1.46      paf       352:        void set_my_variable(const String& fname, Value& value) {
1.114     moko      353:                my.put(fname, &value); // remember param
1.25      paf       354:        }
                    355: 
1.46      paf       356:        Value* get_result_variable();
1.1       paf       357: 
1.114     moko      358: };
                    359: 
                    360: 
                    361: class VLocalParserMethodFrame: public VParserMethodFrame {
                    362: public: // Value
                    363: 
                    364:        override const VJunction* put_element(const String& aname, Value* avalue){
                    365:                set_my_variable(aname, *avalue);
                    366:                return PUT_ELEMENT_REPLACED_ELEMENT;
                    367:        }
                    368: 
                    369: public: // usage
                    370: 
                    371:        VLocalParserMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VParserMethodFrame(amethod, acaller, aself) {}
1.1       paf       372: 
1.41      paf       373: };
                    374: 
1.114     moko      375: 
                    376: template<typename Parent> class VExpressionFrame: public Parent {
1.113     moko      377: public:
1.114     moko      378:        VExpressionFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : Parent(amethod, acaller, aself) {}
1.113     moko      379: 
                    380:        /// in expressions we don't attempt to convert to string
                    381:        override void write_as_string(Value& avalue) {
1.114     moko      382:                Parent::write(avalue);
1.113     moko      383:        }
                    384: };
                    385: 
                    386: 
1.114     moko      387: template<typename Parent> class VConstructorFrame: public Parent {
1.85      misha     388: public:
1.114     moko      389:        VConstructorFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : Parent(amethod, acaller, aself) {
1.87      moko      390:                // prevent non-string writes for better error reporting [constructors are not expected to return anything]
                    391:                VMethodFrame::write(aself);
                    392:        }
1.85      misha     393: 
1.113     moko      394:        override void write(const String& /*astring*/) {}
1.85      misha     395: };
                    396: 
1.114     moko      397: 
                    398: #define METHOD_FRAME_ACTION(method, caller, self, action)                                      \
                    399:        if((method).native_code){                                                               \
                    400:                VNativeMethodFrame frame(method, caller, self);                                 \
                    401:                action;                                                                         \
                    402:        } else {                                                                                \
                    403:                if((method).all_vars_local){                                                    \
                    404:                        VLocalParserMethodFrame frame(method, caller, self);                    \
                    405:                        action;                                                                 \
                    406:                } else {                                                                        \
                    407:                        VParserMethodFrame frame(method, caller, self);                         \
                    408:                        action;                                                                 \
                    409:                }                                                                               \
                    410:        }
                    411: 
                    412: #define EXPRESSION_FRAME_ACTION(method, caller, self, action)                                  \
                    413:        if((method).native_code){                                                               \
                    414:                VExpressionFrame<VNativeMethodFrame> frame(method, caller, self);               \
                    415:                action;                                                                         \
                    416:        } else {                                                                                \
                    417:                if((method).all_vars_local){                                                    \
                    418:                        VExpressionFrame<VLocalParserMethodFrame> frame(method, caller, self);  \
                    419:                        action;                                                                 \
                    420:                } else {                                                                        \
                    421:                        VExpressionFrame<VParserMethodFrame> frame(method, caller, self);       \
                    422:                        action;                                                                 \
                    423:                }                                                                               \
                    424:        }
                    425: 
                    426: #define CONSTRUCTOR_FRAME_ACTION(method, caller, self, action)                                 \
                    427:        if((method).native_code){                                                               \
                    428:                VConstructorFrame<VNativeMethodFrame> frame(method, caller, self);              \
                    429:                action;                                                                         \
                    430:        } else {                                                                                \
                    431:                if((method).all_vars_local){                                                    \
                    432:                        VConstructorFrame<VLocalParserMethodFrame> frame(method, caller, self); \
                    433:                        action;                                                                 \
                    434:                } else {                                                                        \
                    435:                        VConstructorFrame<VParserMethodFrame> frame(method, caller, self);      \
                    436:                        action;                                                                 \
                    437:                }                                                                               \
                    438:        }
                    439: 
1.1       paf       440: #endif

E-mail: