Annotation of parser3/src/types/pa_value.h, revision 1.176

1.22      paf         1: /** @file
1.110     paf         2:        Parser: Value, Method, Junction .
1.24      paf         3: 
1.176   ! moko        4:        Copyright (c) 2001-2024 Art. Lebedev Studio (http://www.artlebedev.com)
1.169     moko        5:        Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.1       paf         6: */
                      7: 
                      8: #ifndef PA_VALUE_H
                      9: #define PA_VALUE_H
1.87      paf        10: 
1.176   ! moko       11: #define IDENT_PA_VALUE_H "$Id: pa_value.h,v 1.175 2024/10/02 21:24:41 moko Exp $"
1.1       paf        12: 
1.133     misha      13: #include "pa_common.h"
1.1       paf        14: #include "pa_array.h"
                     15: #include "pa_exception.h"
1.120     paf        16: #include "pa_property.h"
1.157     moko       17: #include "pa_opcode.h"
1.1       paf        18: 
1.99      paf        19: // forwards
                     20: 
1.9       paf        21: class VStateless_class;
1.1       paf        22: class WContext;
1.133     misha      23: class Request;
                     24: class Request_charsets;
1.17      paf        25: class Junction;
1.123     paf        26: class VJunction;
1.17      paf        27: class Method;
1.131     misha      28: class Value;
1.64      parser     29: class MethodParams;
1.93      paf        30: class VObject;
1.99      paf        31: class VMethodFrame;
1.110     paf        32: class VFile;
                     33: class Table;
1.143     misha      34: struct XDocOutputOptions;
1.172     moko       35: 
                     36: template <typename T>class SparseArray;
                     37: typedef SparseArray<Value*> ArrayValue;
1.1       paf        38: 
1.165     moko       39: struct Json_options : public PA_Allocated {
1.139     misha      40:        Request* r;
1.149     moko       41:        String::Body key;
1.139     misha      42:        HashStringValue* methods;
1.149     moko       43:        Value* default_method;
1.139     misha      44:        Value* params;
                     45:        bool skip_unknown;
1.162     moko       46:        bool one_line;
1.175     moko       47:        uint json_string_recursion;
1.141     moko       48:        const char* indent;
1.143     misha      49:        XDocOutputOptions* xdoc_options;
1.156     moko       50:        enum Date { D_SQL, D_GMT, D_ISO, D_TIMESTAMP } date;
1.142     moko       51:        enum Table { T_ARRAY, T_OBJECT, T_COMPACT } table;
1.170     moko       52:        enum Array { A_ARRAY, A_OBJECT, A_COMPACT } array;
1.139     misha      53:        enum File { F_BODYLESS, F_BASE64, F_TEXT } file;
1.153     misha      54:        enum Void { V_NULL, V_STRING } fvoid;
1.139     misha      55: 
1.149     moko       56:        Json_options(Request* arequest):
1.139     misha      57:                r(arequest),
                     58:                methods(NULL),
1.149     moko       59:                default_method(NULL),
1.139     misha      60:                params(NULL),
                     61:                skip_unknown(false),
1.162     moko       62:                one_line(false),
1.175     moko       63:                json_string_recursion(0),
1.140     moko       64:                indent(NULL),
1.161     moko       65:                xdoc_options(NULL),
1.139     misha      66:                date(D_SQL),
                     67:                table(T_OBJECT),
1.170     moko       68:                array(A_COMPACT),
1.153     misha      69:                file(F_BODYLESS),
                     70:                fvoid(V_NULL)
1.139     misha      71:        {}
                     72: 
                     73:        bool set_date_format(const String &value){
1.156     moko       74:                if(value == "sql-string") date = D_SQL;
                     75:                else if (value == "gmt-string") date = D_GMT;
                     76:                else if (value == "iso-string") date = D_ISO;
1.139     misha      77:                else if (value == "unix-timestamp") date = D_TIMESTAMP;
                     78:                else return false;
                     79:                return true;
                     80:        }
                     81: 
                     82:        bool set_table_format(const String &value){
                     83:                if(value == "array") table = T_ARRAY;
                     84:                else if (value == "object") table = T_OBJECT;
1.142     moko       85:                else if (value == "compact") table = T_COMPACT;
1.139     misha      86:                else return false;
                     87:                return true;
                     88:        }
                     89: 
1.170     moko       90:        bool set_array_format(const String &value){
                     91:                if(value == "array") array = A_ARRAY;
                     92:                else if (value == "object") array = A_OBJECT;
                     93:                else if (value == "compact") array = A_COMPACT;
                     94:                else return false;
                     95:                return true;
                     96:        }
                     97: 
1.139     misha      98:        bool set_file_format(const String &value){
                     99:                if(value == "base64") file = F_BASE64;
                    100:                else if (value == "text") file = F_TEXT;
1.148     misha     101:                else if (value == "stat") file = F_BODYLESS;
1.139     misha     102:                else return false;
                    103:                return true;
                    104:        }
1.149     moko      105: 
1.153     misha     106:        bool set_void_format(const String &value){
                    107:                if(value == "null") fvoid = V_NULL;
                    108:                else if(value == "string") fvoid = V_STRING;
                    109:                else return false;
                    110:                return true;
                    111:        }
                    112: 
1.155     moko      113:        const String* hash_json_string(HashStringValue *hash);
1.170     moko      114:        const String* array_json_string(ArrayValue *array);
                    115:        const String* array_compact_json_string(ArrayValue *array);
1.139     misha     116: };
                    117: 
1.31      paf       118: ///    grandfather of all @a values in @b Parser
1.110     paf       119: class Value: public PA_Object {
1.1       paf       120: public: // Value
                    121: 
1.106     paf       122:        /// value type, used for error reporting and 'is' expression operator
1.110     paf       123:        virtual const char* type() const =0;
1.89      paf       124: 
                    125:        /**
1.171     moko      126:                all except VObject/VClass: true if @atype eq type()
1.95      paf       127:                VObject/VClass: can locate parent class by it's type
1.89      paf       128:        */
1.171     moko      129:        virtual bool is(const char* atype) { return atype && strcmp(type(), atype)==0; }
1.164     moko      130: 
1.106     paf       131:        /// is this value defined?
1.38      paf       132:        virtual bool is_defined() const { return true; }
1.164     moko      133: 
1.106     paf       134:        /// is this value string?
1.38      paf       135:        virtual bool is_string() const { return false; }
1.124     paf       136: 
                    137:        /// is this value void?
                    138:        virtual bool is_void() const { return false; }
                    139: 
1.128     misha     140:        /// is this value bool?
                    141:        virtual bool is_bool() const { return false; }
                    142: 
1.124     paf       143:        /// is this value number?
1.126     paf       144:        virtual bool is_evaluated_expr() const { return false; }
1.124     paf       145: 
1.106     paf       146:        /// what's the meaning of this value in context of expression?
1.147     moko      147:        virtual Value& as_expr_result() {
1.173     moko      148:                return *bark("is '%s', cannot be used in expression"); 
1.34      paf       149:        }
1.110     paf       150: 
                    151:        /** extract HashStringValue if any
                    152:                WARNING: FOR LOCAL USE ONLY, THIS POINTER IS NOT TO PASS TO ANYBODY!
                    153:        */
                    154:        virtual HashStringValue* get_hash() { return 0; }
1.164     moko      155: 
1.106     paf       156:        /// extract const String
1.110     paf       157:        virtual const String* get_string() { return 0; }
1.136     misha     158: 
1.139     misha     159:        /// extract json-string
1.149     moko      160:        virtual const String* get_json_string(Json_options& options);
1.154     misha     161:        const String* default_method_2_json_string(Value& default_method, Json_options& options);
1.139     misha     162: 
1.164     moko      163:        /// for reflection
1.136     misha     164:        virtual HashStringValue* get_fields() { return 0; }
1.159     moko      165:        virtual HashStringValue* get_fields_reference() { return 0; }
1.164     moko      166: 
1.106     paf       167:        /// extract double
1.110     paf       168:        virtual double as_double() const { bark("is '%s', it does not have numerical (double) value"); return 0; }
1.164     moko      169: 
1.106     paf       170:        /// extract integer
1.110     paf       171:        virtual int as_int () const { bark("is '%s', it does not have numerical (int) value"); return 0; }
1.59      parser    172: 
1.106     paf       173:        /// extract bool
1.110     paf       174:        virtual bool as_bool() const { bark("is '%s', it does not have logical value"); return 0; }
1.164     moko      175: 
1.106     paf       176:        /// extract file
1.168     moko      177:        virtual VFile* as_vfile();
                    178:        virtual VFile* as_vfile(String::Language /*lang*/, const Request_charsets* /*charsets*/) { return as_vfile(); }
1.164     moko      179: 
1.106     paf       180:        /// extract Junction
1.110     paf       181:        virtual Junction* get_junction();
1.164     moko      182: 
1.120     paf       183:        /// @return Value element; can return Junction for methods; Code-Junction for code; Getter-Junction for property
1.134     misha     184:        virtual Value* get_element(const String& /*aname*/);
1.92      paf       185: 
1.157     moko      186: #ifdef FEATURE_GET_ELEMENT4CALL
                    187:        /// same as get_element, but methods have higher priority in table and hash
                    188:        virtual Value* get_element4call(const String& aname){
                    189:                return get_element(aname);
                    190:        }
                    191: #endif
                    192: 
1.106     paf       193:        /// store Value element under @a name
1.166     moko      194:        /// @returns putter method junction, or 0
1.151     moko      195:        virtual const VJunction* put_element(const String& aname, Value* /*avalue*/) { 
1.65      parser    196:                // to prevent modification of system classes,
                    197:                // created at system startup, and not having exception
                    198:                // handler installed, we neet to bark using request.pool
1.174     moko      199:                bark("element cannot be stored into %s", &aname); 
1.120     paf       200:                return 0;
1.65      parser    201:        }
1.137     moko      202: 
                    203:        /// VObject default getter & setter support
                    204:        virtual void enable_default_getter(){ }
                    205:        virtual void enable_default_setter(){ }
                    206:        virtual void disable_default_getter(){ }
                    207:        virtual void disable_default_setter(){ }
                    208:        virtual bool is_enabled_default_getter(){ return true; }
1.152     moko      209:        virtual bool is_enabled_default_setter(){ return true; }
1.164     moko      210: 
1.106     paf       211:        /// extract VStateless_class
1.135     misha     212:        virtual VStateless_class* get_class()=0;
1.107     paf       213: 
1.135     misha     214:        /// extract base class, if any
                    215:        virtual VStateless_class* base() { return 0; }
1.32      paf       216: 
1.106     paf       217:        /// extract VTable
1.110     paf       218:        virtual Table* get_table() { return 0; }
1.1       paf       219: 
1.164     moko      220:        /// warning war, no overhead as destructors are called manually only when required
                    221:        virtual ~Value() {}
                    222: 
1.1       paf       223: public: // usage
                    224: 
1.160     moko      225:        /// @return sure String or barks if it doesn't have string value
1.1       paf       226:        const String& as_string() {
1.160     moko      227:                const String* result=get_string();
1.1       paf       228:                if(!result)
1.110     paf       229:                        bark("is '%s', it has no string representation");
1.6       paf       230: 
1.1       paf       231:                return *result;
                    232:        }
                    233: 
1.160     moko      234:        /// @return Hash or barks if it is not hash compatible
                    235:        HashStringValue* as_hash(const char* name=0);
                    236: 
1.22      paf       237:        /// throws exception specifying bark-reason and name() type() of problematic value
1.112     paf       238:        Value* bark(const char *reason, const String *problem_source=0) const {
1.166     moko      239:                throw Exception(PARSER_RUNTIME, problem_source, reason, type());
1.1       paf       240:        }
                    241: 
1.17      paf       242: };
1.48      paf       243: 
                    244: /**
1.164     moko      245:        $content-type[text/html] ->
1.110     paf       246:                content-type: text/html
1.164     moko      247:        $content-type[$.value[text/html] $.charset[windows-1251]] ->
1.110     paf       248:                content-type: text/html; charset=windows-1251
1.48      paf       249: */
1.164     moko      250: const String& attributed_meaning_to_string(Value& meaning, String::Language lang, bool forced=false, bool allow_bool=false);
1.110     paf       251: 
                    252: // defines
                    253: 
                    254: ///@{common field names
                    255: #define CHARSET_NAME "charset"
                    256: #define VALUE_NAME "value"
1.114     paf       257: #define EXPIRES_NAME "expires"
1.110     paf       258: #define CONTENT_TYPE_NAME "content-type"
1.119     paf       259: #define NAME_NAME "name"
1.110     paf       260: //@}
                    261: 
                    262: ///@{common field names
                    263: extern const String value_name;
1.114     paf       264: extern const String expires_name;
1.110     paf       265: extern const String content_type_name;
                    266: extern const String name_name;
                    267: ///@}
1.1       paf       268: 
                    269: #endif

E-mail: