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

1.3       paf         1: /** @file
1.5       paf         2:        Parser: @b method_frame write context
1.3       paf         3: 
1.68      misha       4:        Copyright (c) 2001-2009 ArtLebedev Group (http://www.artlebedev.com)
1.22      paf         5:        Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.1       paf         6: */
                      7: 
                      8: #ifndef PA_VMETHOD_FRAME_H
                      9: #define PA_VMETHOD_FRAME_H
1.28      paf        10: 
1.87    ! moko       11: static const char * const IDENT_VMETHOD_FRAME_H="$Date: 2009-08-24 08:08:04 $";
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();
                     40:                for(Value **current=felements;current<flast;current++)
                     41:                        if ((*current)->get_junction()!=0)
                     42:                                delete *current;
                     43:        }
                     44: #endif
                     45: 
1.77      misha      46:        void store_params(Value **params, size_t count){ 
1.78      misha      47:                felements=params;
1.77      misha      48:                fused=count;
                     49:        }
                     50: 
1.78      misha      51:        inline size_t count() const { return fused; }
                     52: 
                     53:        inline Value *get(size_t index) const {
                     54:                assert(index<count());
                     55:                return felements[index];
                     56:        }
                     57: 
1.77      misha      58:        inline Value& operator[] (size_t index) { return *get(index); }
1.46      paf        59: 
                     60:        Value& last() { return *get(count()-1); }
                     61: 
                     62:        /// handy is-value-a-junction ensurer
                     63:        Value& as_junction(int index, const char* msg) { 
1.56      paf        64:                Value* value=get(index);
                     65:                return as_junction(value, msg, index); 
                     66:        }
                     67:        /// handy is-value-a-junction ensurer
                     68:        Value& as_junction(Value* value, const char* msg, int index) { 
                     69:                return get_as(value, true, msg, index); 
1.46      paf        70:        }
                     71:        /// handy value-is-not-a-junction ensurer
                     72:        Value& as_no_junction(int index, const char* msg) { 
1.56      paf        73:                Value* value=get(index);
                     74:                return as_no_junction(value, msg, index); 
                     75:        }
                     76:        /// handy value-is-not-a-junction ensurer
                     77:        Value& as_no_junction(Value* value, const char* msg, int index) { 
                     78:                return get_as(value, false, msg, index); 
1.46      paf        79:        }
1.62      misha      80:        /// handy is-value-a-junction ensurer or can be auto-processed
                     81:        Value& as_expression(int index, const char* msg) { 
                     82:                Value* value=get(index);
                     83:                if(value->is_evaluated_expr()){
                     84:                        return *value;
                     85:                } else {
                     86:                        return get_as(value, true, msg, index);
                     87:                }
                     88:        }
1.46      paf        89:        /// handy expression auto-processing to double
                     90:        double as_double(int index, const char* msg, Request& r) { 
1.56      paf        91:                Value* value=get(index);
1.60      paf        92:                if(!value->is_evaluated_expr())
1.57      paf        93:                        value=&get_processed(value, msg, index, r);
                     94:                return value->as_double(); 
1.46      paf        95:        }
                     96:        /// handy expression auto-processing to int
                     97:        int as_int(int index, const char* msg, Request& r) { 
1.56      paf        98:                Value* value=get(index);
1.60      paf        99:                if(!value->is_evaluated_expr())
1.57      paf       100:                        value=&get_processed(value, msg, index, r);
                    101:                return value->as_int(); 
1.46      paf       102:        }
                    103:        /// handy expression auto-processing to bool
                    104:        bool as_bool(int index, const char* msg, Request& r) { 
1.56      paf       105:                Value* value=get(index);
1.60      paf       106:                if(!value->is_evaluated_expr())
1.59      paf       107:                        value=&get_processed(value, msg, index, r);
                    108:                return value->as_bool(); 
1.46      paf       109:        }
                    110:        /// handy string ensurer
                    111:        const String& as_string(int index, const char* msg) { 
                    112:                return as_no_junction(index, msg).as_string();
                    113:        }
                    114: private:
                    115: 
1.78      misha     116:        Value **felements;
                    117:        size_t fused;
                    118: 
1.46      paf       119:        /// handy value-is/not-a-junction ensurer
1.56      paf       120:        Value& get_as(Value* value, bool as_junction, const char* msg, int index) { 
                    121:                if((value->get_junction()!=0) ^ as_junction)
1.61      misha     122:                        throw Exception(PARSER_RUNTIME,
1.46      paf       123:                                0,
                    124:                                "%s (parameter #%d)", msg, 1+index);
                    125: 
1.56      paf       126:                return *value;
1.46      paf       127:        }
                    128: 
1.56      paf       129:        Value& get_processed(Value* value, const char* msg, int index, Request& r);
1.46      paf       130: 
                    131: };
                    132: 
1.4       paf       133: /**    Method frame write context
                    134:        accepts values written by method code
                    135:        also handles method parameters and local variables
1.3       paf       136: */
1.46      paf       137: class VMethodFrame: public WContext {
1.63      misha     138: protected:
1.46      paf       139:        VMethodFrame *fcaller;
                    140: 
1.83      misha     141:        HashString<Value*>* my; /*OR*/ MethodParams fnumbered_params;
1.87    ! moko      142:        Value& fself;
1.46      paf       143: 
1.64      misha     144:        typedef const VJunction* (VMethodFrame::*put_element_t)(const String& aname, Value* avalue);
                    145:        put_element_t put_element_impl;
1.46      paf       146: 
1.1       paf       147: public: // Value
                    148: 
1.46      paf       149:        override const char* type() const { return "method_frame"; }
1.20      paf       150: 
                    151:        /// VMethodFrame: $result | parent get_string(=accumulated fstring)
1.46      paf       152:        override const String* get_string() { 
1.20      paf       153:                // check the $result value
1.46      paf       154:                Value* result=get_result_variable();
1.20      paf       155:                // if we have one, return it's string value, else return as usual: accumulated fstring or fvalue
                    156:                return result ? result->get_string() : WContext::get_string();
                    157:        }
                    158:        
1.40      paf       159:        /// VMethodFrame: my or self_transparent or $caller
1.84      misha     160:        override Value* get_element(const String& aname) { 
1.81      misha     161:                if(aname==caller_element_name)
1.40      paf       162:                        return caller();
1.42      paf       163: 
1.81      misha     164:                if(aname==self_element_name)
1.67      misha     165:                        return &self();
                    166: 
1.66      misha     167:                Value* result;
                    168:                if(my && (result=my->get(aname)))
                    169:                        return result;
                    170: 
1.84      misha     171:                if(result=self().get_element(aname))
1.66      misha     172:                        return result;
1.40      paf       173: 
                    174:                return 0;
1.1       paf       175:        }
                    176: 
1.4       paf       177:        /// VMethodFrame: self_transparent
1.46      paf       178:        override VStateless_class* get_class() { return self().get_class(); }
1.44      paf       179: 
                    180:        /// VMethodFrame: self_transparent
1.85      misha     181:        override VStateless_class* base() { return self().base(); }
1.1       paf       182: 
1.64      misha     183:        /// VMethodFrame: my or self_transparent
1.84      misha     184:        override const VJunction* put_element(const String& aname, Value* avalue, bool /*areplace*/) {
1.64      misha     185:                return (this->*put_element_impl)(aname, avalue);
                    186:        }
                    187: 
1.69      misha     188:        /// VMethodFrame: appends a fstring to result
                    189:        override void write(const String& astring, String::Language alang) {
1.79      misha     190: #ifdef OPTIMIZE_RESULT
1.87    ! moko      191:                switch (method.result_optimization){
1.79      misha     192:                        case Method::RO_USE_RESULT: 
                    193:                                return;
                    194:                        case Method::RO_UNKNOWN:
                    195:                                if(get_result_variable()){
1.87    ! moko      196:                                        ((Method *)&method)->result_optimization=Method::RO_USE_RESULT;
1.79      misha     197:                                        return;
                    198:                                }
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.84      misha     214:                return self().put_element(aname, avalue, false/*=always, areplace*/);
1.64      misha     215:        }
                    216: 
1.30      paf       217: public: // WContext
1.1       paf       218: 
1.46      paf       219:        override StringOrValue 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)
                    225:                                return StringOrValue(*result_value);
1.79      misha     226: #ifdef OPTIMIZE_RESULT
1.87    ! moko      227:                        if(method.result_optimization==Method::RO_USE_RESULT)
1.80      misha     228:                                return StringOrValue(*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.86      misha     263:                if(method.params_names) {
                    264:                        size_t param_count=method.params_names->count();
                    265: 
                    266:                        if(count>param_count)
                    267:                                throw Exception(PARSER_RUNTIME,
                    268:                                        0, //&name(),
                    269:                                        "method of %s (%s) accepts maximum %d parameter(s) (%d present)", 
1.87    ! moko      270:                                        self().get_class()->name_cstr(),
        !           271:                                        self().type(),
1.86      misha     272:                                        param_count,
                    273:                                        count);
1.78      misha     274: 
1.77      misha     275:                        size_t i=0;
1.86      misha     276:                        for(; i<count; i++) {
1.77      misha     277:                                const String& fname=*(*method.params_names)[i];
                    278:                                set_my_variable(fname, *params[i]);
                    279:                        }
                    280: 
                    281:                        for(; i<param_count; i++) {
                    282:                                const String& fname=*(*method.params_names)[i];
1.68      misha     283:                                my->put(fname, VVoid::get());
1.1       paf       284:                        }
1.86      misha     285:                } else
1.77      misha     286:                        fnumbered_params.store_params(params,count);
1.1       paf       287:        }
                    288: 
1.78      misha     289:        void empty_params(){
                    290:                if(method.params_names){
                    291:                        size_t param_count=method.params_names->count();
                    292:                        for(size_t i=0; i<param_count; i++) {
                    293:                                const String& fname=*(*method.params_names)[i];
                    294:                                my->put(fname, VVoid::get());
                    295:                        }
                    296:                }
                    297:        }
                    298: 
1.72      misha     299:        MethodParams* numbered_params() { return &fnumbered_params; }
1.18      paf       300: 
1.63      misha     301: protected:
1.18      paf       302: 
1.46      paf       303:        void set_my_variable(const String& fname, Value& value) {
                    304:                my->put(fname, &value); // remember param
1.25      paf       305:        }
                    306: 
1.46      paf       307:        Value* get_result_variable();
1.1       paf       308: 
                    309: public:
                    310:        
1.87    ! moko      311:        const Method& method;
1.1       paf       312: 
1.41      paf       313: };
                    314: 
1.85      misha     315: class VConstructorFrame: public VMethodFrame {
                    316: public:
1.87    ! moko      317:        VConstructorFrame(const Method& amethod, VMethodFrame *acaller, Value& aself) : VMethodFrame(amethod, acaller, aself) {
        !           318:                // prevent non-string writes for better error reporting [constructors are not expected to return anything]
        !           319:                VMethodFrame::write(aself);
        !           320:        }
1.85      misha     321: 
                    322:        override void write(const String& /*astring*/, String::Language /*alang*/) {}
                    323: };
                    324: 
1.1       paf       325: #endif

E-mail: