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

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.114   ! moko       11: #define IDENT_PA_VMETHOD_FRAME_H "$Id: pa_vmethod_frame.h,v 1.113 2016/11/01 22:39:00 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(){
        !           160:                Method::Call_type call_type=self().get_class()==&self() ? Method::CT_STATIC : Method::CT_DYNAMIC;
        !           161:                if(method.call_type!=Method::CT_ANY && method.call_type!=call_type) // call type not allowed?
        !           162:                        throw Exception(PARSER_RUNTIME, 0, "is not allowed to be called %s", call_type==Method::CT_STATIC ? "statically" : "dynamically");
        !           163:        }
        !           164: 
        !           165: public:
        !           166: 
        !           167:        const Method& method;
        !           168: };
1.46      paf       169: 
                    170: 
1.114   ! moko      171: class VNativeMethodFrame: public VMethodFrame {
        !           172: protected:
        !           173:        MethodParams fnumbered_params;
1.46      paf       174: 
1.1       paf       175: public: // Value
                    176: 
1.114   ! moko      177:        /// VNativeMethodFrame: self_transparent or $caller
        !           178:        override Value* get_element(const String& aname) {
        !           179:                if(SYMBOLS_EQ(aname,CALLER_SYMBOL))
        !           180:                        return caller();
        !           181: 
        !           182:                if(SYMBOLS_EQ(aname,SELF_SYMBOL))
        !           183:                        return &self();
        !           184: 
        !           185:                if(Value* result=self().get_element(aname))
        !           186:                        return result;
        !           187: 
        !           188:                return 0;
        !           189:        }
        !           190: 
        !           191:        /// VNativeMethodFrame: self_transparent
        !           192:        override const VJunction* put_element(const String& aname, Value* avalue) {
        !           193:                return self().put_element(aname, avalue);
        !           194:        }
        !           195: 
        !           196: public: // usage
        !           197: 
        !           198:        VNativeMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VMethodFrame(amethod, acaller, aself){}
        !           199: 
        !           200:        void store_params(Value **params, size_t count) {
        !           201:                fnumbered_params.store_params(params, count);
        !           202:                method.check_actual_numbered_params(self(), &fnumbered_params);
        !           203:        }
        !           204: 
        !           205:        void empty_params() {
        !           206:                method.check_actual_numbered_params(self(), &fnumbered_params);
        !           207:        }
        !           208: 
        !           209:        void call(Request &r);
        !           210: 
        !           211: };
        !           212: 
        !           213: 
        !           214: /**
        !           215:        Handles named parameters and local variables
        !           216: */
        !           217: 
        !           218: class VParserMethodFrame: public VMethodFrame {
        !           219: protected:
        !           220:        HashString<Value*> my;
        !           221: 
        !           222: public: // Value
1.20      paf       223: 
1.114   ! moko      224:        /// VParserMethodFrame: $result | parent get_string(=accumulated fstring)
1.109     moko      225:        override const String* get_string() {
1.20      paf       226:                // check the $result value
1.46      paf       227:                Value* result=get_result_variable();
1.20      paf       228:                // if we have one, return it's string value, else return as usual: accumulated fstring or fvalue
                    229:                return result ? result->get_string() : WContext::get_string();
                    230:        }
1.114   ! moko      231: 
        !           232:        /// VParserMethodFrame: my or self_transparent or $caller
1.109     moko      233:        override Value* get_element(const String& aname) {
1.103     moko      234:                if(SYMBOLS_EQ(aname,CALLER_SYMBOL))
1.40      paf       235:                        return caller();
1.42      paf       236: 
1.103     moko      237:                if(SYMBOLS_EQ(aname,SELF_SYMBOL))
1.67      misha     238:                        return &self();
                    239: 
1.114   ! moko      240:                if(Value* result=my.get(aname))
1.66      misha     241:                        return result;
                    242: 
1.114   ! moko      243:                if(Value* result=self().get_element(aname))
1.66      misha     244:                        return result;
1.40      paf       245: 
                    246:                return 0;
1.1       paf       247:        }
                    248: 
1.114   ! moko      249:        /// VParserMethodFrame: my or self_transparent
1.94      moko      250:        override const VJunction* put_element(const String& aname, Value* avalue) {
1.114   ! moko      251:                if(my.put_replaced(aname, avalue))
        !           252:                        return PUT_ELEMENT_REPLACED_ELEMENT;
        !           253:                return self().put_element(aname, avalue);
1.64      misha     254:        }
                    255: 
1.114   ! moko      256: public: // WContext
        !           257: 
        !           258:        /// VParserMethodFrame: skip write when RO_USE_RESULT
1.112     moko      259:        override void write(const String& astring) {
1.79      misha     260: #ifdef OPTIMIZE_RESULT
1.87      moko      261:                switch (method.result_optimization){
1.97      moko      262:                        case Method::RO_USE_RESULT:
1.79      misha     263:                                return;
                    264:                        case Method::RO_UNKNOWN:
                    265:                                if(get_result_variable()){
1.87      moko      266:                                        ((Method *)&method)->result_optimization=Method::RO_USE_RESULT;
1.79      misha     267:                                        return;
                    268:                                }
1.97      moko      269:                        case Method::RO_USE_WCONTEXT: break;
1.69      misha     270:                }
1.79      misha     271: #endif
1.112     moko      272:                WContext::write(astring);
1.69      misha     273:        }
                    274: 
1.114   ! moko      275:        override void write(Value& avalue) {
        !           276:                WContext::write(avalue);
1.64      misha     277:        }
                    278: 
1.105     moko      279:        override Value& result() {
1.114   ! moko      280:                // check the $result value
        !           281:                Value* result_value=get_result_variable();
        !           282:                // if we have one, return it, else return as usual: accumulated fstring or fvalue
        !           283:                if(result_value)
        !           284:                        return *result_value;
1.79      misha     285: #ifdef OPTIMIZE_RESULT
1.114   ! moko      286:                if(method.result_optimization==Method::RO_USE_RESULT)
        !           287:                        return *VVoid::get();
        !           288:                ((Method *)&method)->result_optimization=Method::RO_USE_WCONTEXT;
1.79      misha     289: #ifdef OPTIMIZE_CALL // nested as CO_WITHOUT_WCONTEXT assumes that $result not used
1.114   ! moko      290:                ((Method *)&method)->call_optimization=Method::CO_WITHOUT_WCONTEXT;
1.79      misha     291: #endif
                    292: #endif
                    293:                return WContext::result();
1.1       paf       294:        }
                    295: 
                    296: public: // usage
                    297: 
1.114   ! moko      298:        VParserMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself);
1.1       paf       299: 
1.114   ! moko      300:        void store_params(Value **params, size_t count) {
        !           301:                size_t param_count=method.params_count;
        !           302:                size_t i=0;
1.25      paf       303: 
1.114   ! moko      304:                if(count>param_count){
        !           305:                        if(method.extra_params){
        !           306:                                for(; i<param_count; i++) {
        !           307:                                        const String& fname=*(*method.params_names)[i];
        !           308:                                        set_my_variable(fname, *params[i]);
        !           309:                                }
1.75      misha     310: 
1.114   ! moko      311:                                VHash& vargs=*new VHash();
        !           312:                                HashStringValue& args = vargs.hash();
1.1       paf       313: 
1.114   ! moko      314:                                for(; i<count; i++) {
        !           315:                                        args.put(format(args.count(), 0), params[i]);
        !           316:                                }
1.77      misha     317: 
1.114   ! moko      318:                                set_my_variable(*method.extra_params, vargs);
        !           319:                                return;
        !           320:                        } else
        !           321:                                throw Exception(PARSER_RUNTIME, 0, "method of %s accepts maximum %d parameter(s) (%d present)", self().type(), param_count, count);
        !           322:                }
1.86      misha     323: 
1.114   ! moko      324:                for(; i<count; i++) {
        !           325:                        const String& fname=*(*method.params_names)[i];
        !           326:                        set_my_variable(fname, *params[i]);
        !           327:                }
1.78      misha     328: 
1.114   ! moko      329:                for(; i<param_count; i++) {
        !           330:                        const String& fname=*(*method.params_names)[i];
        !           331:                        my.put(fname, VVoid::get());
        !           332:                }
1.1       paf       333:        }
                    334: 
1.78      misha     335:        void empty_params(){
1.114   ! moko      336:                size_t param_count=method.params_count;
        !           337:                if(param_count>0){
        !           338:                        my.put(*(*method.params_names)[0], VString::empty());
        !           339:                        for(size_t i=1; i<param_count; i++)
        !           340:                                my.put(*(*method.params_names)[i], VVoid::get());
1.78      misha     341:                }
                    342:        }
                    343: 
1.114   ! moko      344:        void call(Request &r);
1.18      paf       345: 
1.63      misha     346: protected:
1.18      paf       347: 
1.46      paf       348:        void set_my_variable(const String& fname, Value& value) {
1.114   ! moko      349:                my.put(fname, &value); // remember param
1.25      paf       350:        }
                    351: 
1.46      paf       352:        Value* get_result_variable();
1.1       paf       353: 
1.114   ! moko      354: };
        !           355: 
        !           356: 
        !           357: class VLocalParserMethodFrame: public VParserMethodFrame {
        !           358: public: // Value
        !           359: 
        !           360:        override const VJunction* put_element(const String& aname, Value* avalue){
        !           361:                set_my_variable(aname, *avalue);
        !           362:                return PUT_ELEMENT_REPLACED_ELEMENT;
        !           363:        }
        !           364: 
        !           365: public: // usage
        !           366: 
        !           367:        VLocalParserMethodFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VParserMethodFrame(amethod, acaller, aself) {}
1.1       paf       368: 
1.41      paf       369: };
                    370: 
1.114   ! moko      371: 
        !           372: template<typename Parent> class VExpressionFrame: public Parent {
1.113     moko      373: public:
1.114   ! moko      374:        VExpressionFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : Parent(amethod, acaller, aself) {}
1.113     moko      375: 
                    376:        /// in expressions we don't attempt to convert to string
                    377:        override void write_as_string(Value& avalue) {
1.114   ! moko      378:                Parent::write(avalue);
1.113     moko      379:        }
                    380: };
                    381: 
                    382: 
1.114   ! moko      383: template<typename Parent> class VConstructorFrame: public Parent {
1.85      misha     384: public:
1.114   ! moko      385:        VConstructorFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : Parent(amethod, acaller, aself) {
1.87      moko      386:                // prevent non-string writes for better error reporting [constructors are not expected to return anything]
                    387:                VMethodFrame::write(aself);
                    388:        }
1.85      misha     389: 
1.113     moko      390:        override void write(const String& /*astring*/) {}
1.85      misha     391: };
                    392: 
1.114   ! moko      393: 
        !           394: #define METHOD_FRAME_ACTION(method, caller, self, action)                                      \
        !           395:        if((method).native_code){                                                               \
        !           396:                VNativeMethodFrame frame(method, caller, self);                                 \
        !           397:                action;                                                                         \
        !           398:        } else {                                                                                \
        !           399:                if((method).all_vars_local){                                                    \
        !           400:                        VLocalParserMethodFrame frame(method, caller, self);                    \
        !           401:                        action;                                                                 \
        !           402:                } else {                                                                        \
        !           403:                        VParserMethodFrame frame(method, caller, self);                         \
        !           404:                        action;                                                                 \
        !           405:                }                                                                               \
        !           406:        }
        !           407: 
        !           408: #define EXPRESSION_FRAME_ACTION(method, caller, self, action)                                  \
        !           409:        if((method).native_code){                                                               \
        !           410:                VExpressionFrame<VNativeMethodFrame> frame(method, caller, self);               \
        !           411:                action;                                                                         \
        !           412:        } else {                                                                                \
        !           413:                if((method).all_vars_local){                                                    \
        !           414:                        VExpressionFrame<VLocalParserMethodFrame> frame(method, caller, self);  \
        !           415:                        action;                                                                 \
        !           416:                } else {                                                                        \
        !           417:                        VExpressionFrame<VParserMethodFrame> frame(method, caller, self);       \
        !           418:                        action;                                                                 \
        !           419:                }                                                                               \
        !           420:        }
        !           421: 
        !           422: #define CONSTRUCTOR_FRAME_ACTION(method, caller, self, action)                                 \
        !           423:        if((method).native_code){                                                               \
        !           424:                VConstructorFrame<VNativeMethodFrame> frame(method, caller, self);              \
        !           425:                action;                                                                         \
        !           426:        } else {                                                                                \
        !           427:                if((method).all_vars_local){                                                    \
        !           428:                        VConstructorFrame<VLocalParserMethodFrame> frame(method, caller, self); \
        !           429:                        action;                                                                 \
        !           430:                } else {                                                                        \
        !           431:                        VConstructorFrame<VParserMethodFrame> frame(method, caller, self);      \
        !           432:                        action;                                                                 \
        !           433:                }                                                                               \
        !           434:        }
        !           435: 
1.1       paf       436: #endif

E-mail: