Annotation of parser3/src/types/pa_value.h, revision 1.132
1.22 paf 1: /** @file
1.110 paf 2: Parser: Value, Method, Junction .
1.24 paf 3:
1.131 misha 4: Copyright (c) 2001-2009 ArtLebedev Group (http://www.artlebedev.com)
1.79 paf 5: Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.1 paf 6: */
7:
8: #ifndef PA_VALUE_H
9: #define PA_VALUE_H
1.87 paf 10:
1.132 ! misha 11: static const char * const IDENT_VALUE_H="$Date: 2009-05-14 11:27:23 $";
1.1 paf 12:
13: #include "pa_string.h"
14: #include "pa_array.h"
15: #include "pa_exception.h"
1.120 paf 16: #include "pa_property.h"
1.1 paf 17:
1.99 paf 18: // forwards
19:
1.9 paf 20: class VStateless_class;
1.1 paf 21: class WContext;
1.110 paf 22: class Request; class Request_charsets;
1.17 paf 23: class Junction;
1.123 paf 24: class VJunction;
1.17 paf 25: class Method;
1.131 misha 26: class Value;
1.110 paf 27: template<typename K, typename V> class Hash;
1.131 misha 28: template<typename V> class HashString;
29: typedef HashString<Value*> HashStringValue;
1.110 paf 30: typedef Array<Value*> ArrayValue;
1.64 parser 31: class MethodParams;
1.93 paf 32: class VObject;
1.99 paf 33: class VMethodFrame;
1.110 paf 34: class VFile;
35: class Table;
1.1 paf 36:
1.31 paf 37: /// grandfather of all @a values in @b Parser
1.110 paf 38: class Value: public PA_Object {
1.1 paf 39: public: // Value
40:
1.106 paf 41: /// value type, used for error reporting and 'is' expression operator
1.110 paf 42: virtual const char* type() const =0;
1.89 paf 43:
1.91 paf 44: /** remember derived class instance
45: - VObject: the only client
46: */
1.110 paf 47: virtual VObject* set_derived(VObject* /*aderived*/);
1.91 paf 48:
1.89 paf 49: /**
1.95 paf 50: all except VObject/VClass: this if @atype eq type()
51: VObject/VClass: can locate parent class by it's type
1.89 paf 52: */
1.111 paf 53: virtual Value* as(const char* atype, bool /*looking_up*/) {
1.96 paf 54: return atype && strcmp(type(), atype)==0?this:0;
1.89 paf 55: }
1.97 paf 56: /// type checking helper, uses Value::as
1.110 paf 57: bool is(const char* atype) { return as(atype, false)!=0; }
1.59 parser 58:
1.106 paf 59: /// is this value defined?
1.38 paf 60: virtual bool is_defined() const { return true; }
1.59 parser 61:
1.106 paf 62: /// is this value string?
1.38 paf 63: virtual bool is_string() const { return false; }
1.124 paf 64:
65: /// is this value void?
66: virtual bool is_void() const { return false; }
67:
1.128 misha 68: /// is this value bool?
69: virtual bool is_bool() const { return false; }
70:
1.124 paf 71: /// is this value number?
1.126 paf 72: virtual bool is_evaluated_expr() const { return false; }
1.124 paf 73:
1.106 paf 74: /// what's the meaning of this value in context of expression?
1.110 paf 75: virtual Value& as_expr_result(bool /*return_string_as_is*/=false) {
1.112 paf 76: return *bark("is '%s', can not be used in expression");
1.34 paf 77: }
1.59 parser 78:
1.110 paf 79:
80:
81: /** extract HashStringValue if any
82: WARNING: FOR LOCAL USE ONLY, THIS POINTER IS NOT TO PASS TO ANYBODY!
83: */
84: virtual HashStringValue* get_hash() { return 0; }
1.59 parser 85:
1.106 paf 86: /// extract const String
1.110 paf 87: virtual const String* get_string() { return 0; }
1.59 parser 88:
1.106 paf 89: /// extract double
1.110 paf 90: virtual double as_double() const { bark("is '%s', it does not have numerical (double) value"); return 0; }
1.59 parser 91:
1.106 paf 92: /// extract integer
1.110 paf 93: virtual int as_int () const { bark("is '%s', it does not have numerical (int) value"); return 0; }
1.59 parser 94:
1.106 paf 95: /// extract bool
1.110 paf 96: virtual bool as_bool() const { bark("is '%s', it does not have logical value"); return 0; }
1.59 parser 97:
1.106 paf 98: /// extract file
1.132 ! misha 99: virtual VFile* as_vfile(String::Language lang, const Request_charsets* charsets=0);
1.59 parser 100:
1.106 paf 101: /// extract Junction
1.110 paf 102: virtual Junction* get_junction();
1.59 parser 103:
1.120 paf 104: /// extract Property
105: virtual Property* get_property() { return 0; }
106:
1.93 paf 107: /** extract base object of Value
108: @return for
109: - VObject: fbase
110: */
1.110 paf 111: virtual Value* base_object();
1.93 paf 112:
1.120 paf 113: /// @return Value element; can return Junction for methods; Code-Junction for code; Getter-Junction for property
1.110 paf 114: virtual Value* get_element(const String& /*aname*/, Value& /*aself*/, bool /*looking_up*/);
1.92 paf 115:
1.122 paf 116: /// indicator value meaning that put_element overwritten something
1.123 paf 117: #define PUT_ELEMENT_REPLACED_ELEMENT reinterpret_cast<const VJunction*>(1)
1.106 paf 118: /// store Value element under @a name
1.122 paf 119: /// @returns putter method junction, or it can just report[PUT_ELEMENT_REPLACED_ELEMENT]
120: /// that it replaced something in base fields
1.123 paf 121: virtual const VJunction* put_element(Value& /*aself*/, const String& aname, Value* /*avalue*/, bool /*areplace*/) {
1.65 parser 122: // to prevent modification of system classes,
123: // created at system startup, and not having exception
124: // handler installed, we neet to bark using request.pool
1.112 paf 125: bark("element can not be stored to %s", &aname);
1.120 paf 126: return 0;
1.65 parser 127: }
1.59 parser 128:
1.106 paf 129: /// extract VStateless_class
1.85 paf 130: virtual VStateless_class *get_class()=0;
1.107 paf 131:
132: /// extract VStateless_class
133: virtual VStateless_class *get_last_derived_class() {
134: return get_class();
135: };
1.108 paf 136: /// extract base object or class of Value, if any
1.110 paf 137: virtual Value* base() { return 0; }
1.32 paf 138:
1.106 paf 139: /// extract VTable
1.110 paf 140: virtual Table* get_table() { return 0; }
1.1 paf 141:
142: public: // usage
143:
1.26 paf 144: /// @return sure String. if it doesn't have string value barks
1.1 paf 145: const String& as_string() {
1.110 paf 146: const String* result=get_string();
1.1 paf 147: if(!result)
1.110 paf 148: bark("is '%s', it has no string representation");
1.6 paf 149:
1.1 paf 150: return *result;
151: }
152:
1.6 paf 153: protected:
1.1 paf 154:
1.22 paf 155: /// throws exception specifying bark-reason and name() type() of problematic value
1.112 paf 156: Value* bark(const char *reason, const String *problem_source=0) const {
1.127 paf 157: //if(this) // removing warnings on unreachable code
1.129 misha 158: throw Exception(PARSER_RUNTIME,
1.117 paf 159: problem_source,
160: reason, type());
161:
1.127 paf 162: //return 0;
1.1 paf 163: }
164:
1.17 paf 165: };
1.110 paf 166:
1.48 paf 167:
168: /**
1.110 paf 169: $content-type[text/html] ->
170: content-type: text/html
1.130 misha 171: $content-type[$.value[text/html] $.charset[windows-1251]] ->
1.110 paf 172: content-type: text/html; charset=windows-1251
1.48 paf 173: */
1.110 paf 174: const String& attributed_meaning_to_string(Value& meaning,
175: String::Language lang,
1.128 misha 176: bool forced=false,
177: bool allow_bool=false);
1.110 paf 178:
179: // defines
180:
181: ///@{common field names
182: #define CHARSET_NAME "charset"
183: #define VALUE_NAME "value"
1.114 paf 184: #define EXPIRES_NAME "expires"
1.110 paf 185: #define CONTENT_TYPE_NAME "content-type"
1.119 paf 186: #define NAME_NAME "name"
1.110 paf 187: //@}
188:
189: ///@{common field names
190: extern const String value_name;
1.114 paf 191: extern const String expires_name;
1.110 paf 192: extern const String content_type_name;
193: extern const String name_name;
194: ///@}
1.1 paf 195:
196: #endif
E-mail: