Annotation of parser3/src/types/pa_value.h, revision 1.54
1.22 paf 1: /** @file
1.24 paf 2: Parser: Value, Method, Junction class decls.
3:
1.1 paf 4: Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
1.24 paf 5:
1.2 paf 6: Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
1.1 paf 7:
1.54 ! paf 8: $Id: pa_value.h,v 1.53 2001/05/07 14:00:53 paf Exp $
1.1 paf 9: */
10:
11: #ifndef PA_VALUE_H
12: #define PA_VALUE_H
13:
14: #include "pa_pool.h"
15: #include "pa_string.h"
16: #include "pa_array.h"
17: #include "pa_exception.h"
1.13 paf 18: #include "pa_globals.h"
1.1 paf 19:
1.9 paf 20: class VStateless_class;
1.1 paf 21: class WContext;
22: class VAliased;
23: class Request;
1.35 paf 24: class Table;
1.17 paf 25: class Junction;
26: class Method;
1.20 paf 27: class Hash;
1.42 paf 28: class VFile;
1.1 paf 29:
1.31 paf 30: /// grandfather of all @a values in @b Parser
1.1 paf 31: class Value : public Pooled {
32: public: // Value
33:
1.53 paf 34: /// all: value type, used for error reporting and 'is' expression operator
1.1 paf 35: virtual const char *type() const =0;
36: const String& name() const { return *fname; }
1.23 paf 37: /** is this value defined?
1.22 paf 38: @return for
1.25 paf 39: - VUnknown: false
1.22 paf 40: - others: true
41: */
1.38 paf 42: virtual bool is_defined() const { return true; }
1.35 paf 43: /** is this value string?
44: @return for
45: - VString: true
46: - others: false
47: */
1.38 paf 48: virtual bool is_string() const { return false; }
1.23 paf 49: /** what's the meaning of this value in context of expression?
1.22 paf 50: @return for
1.34 paf 51: - VString: fstring as VDouble or this depending on return_string_as_is
1.25 paf 52: - VBool: this
53: - VDouble: this
54: - VInt: this
55: - VUnknown: this
1.27 paf 56: - VFile: this
1.45 paf 57: - VImage: this
1.22 paf 58: */
1.35 paf 59: virtual Value *as_expr_result(bool return_string_as_is=false) {
1.34 paf 60: bark("(%s) can not be used in expression"); return 0;
61: }
1.23 paf 62: /** extract Hash
1.22 paf 63: @return for
1.25 paf 64: - VHash: fhash
65: - VResponse: ffields
1.22 paf 66: */
1.20 paf 67: virtual Hash *get_hash() { return 0; }
1.23 paf 68: /** extract const String
1.22 paf 69: @return for
1.25 paf 70: - VString: value
71: - VUnknown: ""
72: - VDouble: value
73: - VBool: must be 0: so in ^if(1>2) it would'nt become "FALSE" string which is 'true'
1.22 paf 74: - others: 0
75: - WContext: accumulated fstring
76: */
1.1 paf 77: virtual const String *get_string() { return 0; }
1.23 paf 78: /** extract double
1.22 paf 79: @return for
1.25 paf 80: - VString: value
81: - VDouble: value
82: - VInt: finteger
83: - VBool: value
1.37 paf 84: - VUnknown: 0
1.22 paf 85: */
1.35 paf 86: virtual double as_double() { bark("(%s) does not have numerical value"); return 0; }
1.23 paf 87: /** extract bool
1.22 paf 88: @return for
1.25 paf 89: - VUnknown: false
90: - VBool: value
91: - VInt: 0 or !0
92: - VDouble: 0 or !0
1.27 paf 93: - VFile: true
1.22 paf 94: */
1.35 paf 95: virtual bool as_bool() { bark("(%s) does not have logical value"); return 0; }
1.42 paf 96: /** extract file
97: @return for
98: - VFile: this
99: - VString: vfile
1.45 paf 100: - VImage: true
1.42 paf 101: */
1.46 paf 102: virtual const VFile *as_vfile(String::Untaint_lang lang=String::UL_UNSPECIFIED) const {
1.42 paf 103: bark("(%s) does not have file value"); return 0;
104: }
1.23 paf 105: /** extract Junction
1.22 paf 106: @return for
107: - junction: itself
108: */
1.1 paf 109: virtual Junction *get_junction() { return 0; }
1.23 paf 110: /** extract Value element
1.22 paf 111: @return for
1.25 paf 112: - VHash: (key)=value
1.45 paf 113: - VAliased: sometimes $CLASS, $BASE [@see VAliased::hide_class()]
1.29 paf 114: - VStateless_class: +$method
115: - VStateless_object: +$method
1.51 paf 116: - VCodeFrame: wcontext_transparent
117: - VMethodFrame: my or self_transparent
1.52 paf 118: - VTable: columns,methods
1.28 paf 119: - VEnv: field
1.25 paf 120: - VForm: CLASS,BASE,method,field
1.45 paf 121: - VString: $method
1.30 paf 122: - VRequest: fields
1.45 paf 123: - VResponse: method,fields
1.28 paf 124: - VCookie: field
1.45 paf 125: - VFile: method,field
1.26 paf 126: */
1.36 paf 127: virtual Value *get_element(const String& name) { bark("(%s) has no elements"); return 0; }
1.31 paf 128: /** store Value element under @a name
1.22 paf 129: @return for
1.25 paf 130: - VHash: (key)=value
131: - VStateless_object: (CLASS)=vclass;(BASE)=base;(method)=method_ref
1.26 paf 132: - VStateless_class: (field)=value - static values only
133: - VStateless_object: (field)=value
1.51 paf 134: - VCodeFrame: wcontext_transparent
135: - VMethodFrame: my or self_transparent
1.25 paf 136: - VResponse: (attribute)=value
137: - VCookie: field
1.22 paf 138: */
1.7 paf 139: virtual void put_element(const String& name, Value *value) { bark("(%s) does not accept elements"); }
1.23 paf 140: /** extract VStateless_class
1.22 paf 141: @return for
1.25 paf 142: - VStateless_class: this
143: - VStateless_object: fclass_real
1.26 paf 144: - WContext: none yet | transparent
1.22 paf 145: */
1.9 paf 146: virtual VStateless_class *get_class() { return 0; }
1.23 paf 147: /** extract VAliased
1.22 paf 148: @return for
1.33 paf 149: - VAliased: this
1.26 paf 150: - WContext: transparent
1.51 paf 151: - VMethodFrame: self_transparent
1.22 paf 152: */
1.1 paf 153: virtual VAliased *get_aliased() { return 0; }
1.32 paf 154:
155: /** extract VTable
156: @return for
1.35 paf 157: - VTable: ftable
1.32 paf 158: */
1.35 paf 159: virtual Table *get_table() { return 0; }
1.1 paf 160:
161: public: // usage
162:
163: Value(Pool& apool) : Pooled(apool), fname(unnamed_name) {
164: }
165:
1.22 paf 166: /// set's the name which is used in error messages
1.1 paf 167: void set_name(const String& aname) { fname=&aname; }
168:
1.26 paf 169: /// @return sure String. if it doesn't have string value barks
1.1 paf 170: const String& as_string() {
171: const String *result=get_string();
172: if(!result)
1.35 paf 173: bark("(%s) has no string representation");
1.6 paf 174:
1.1 paf 175: return *result;
176: }
177:
178: private:
179:
180: const String *fname;
181:
1.6 paf 182: protected:
1.1 paf 183:
1.22 paf 184: /// throws exception specifying bark-reason and name() type() of problematic value
185: void bark(char *reason) const {
1.44 paf 186: THROW(0, 0,
1.1 paf 187: &name(),
1.22 paf 188: reason, type());
1.1 paf 189: }
190:
1.17 paf 191: };
192:
1.23 paf 193: /** \b junction is some code joined with context of it's evaluation.
1.22 paf 194:
195: there are code-junctions and method-junctions
196: - code-junctions are used when some parameter passed in cury brackets
197: - method-junctions used in ^method[] calls or $method references
198: */
1.17 paf 199: class Junction : public Pooled {
200: public:
201:
202: Junction(Pool& apool,
203: Value& aself,
204: VStateless_class *avclass, const Method *amethod,
205: Value *aroot,
206: Value *arcontext,
207: WContext *awcontext,
208: const Array *acode) : Pooled(apool),
209:
210: self(aself),
211: vclass(avclass), method(amethod),
212: root(aroot),
213: rcontext(arcontext),
214: wcontext(awcontext),
215: code(acode) {
216: }
217:
1.22 paf 218: /// always present
1.17 paf 219: Value& self;
1.22 paf 220: //@{
221: /// @name either these // so called 'method-junction'
1.17 paf 222: VStateless_class *vclass; const Method *method;
1.22 paf 223: //@}
224: //@{
225: /// @name or these are present // so called 'code-junction'
1.17 paf 226: Value *root;
227: Value *rcontext;
228: WContext *wcontext;
229: const Array *code;
1.22 paf 230: //@}
1.17 paf 231: };
232:
1.48 paf 233: /**
234: @b method parameters passed in this array.
235: contains handy typecast ad junction/not junction ensurers
236:
237: */
238: class MethodParams : public Array {
239: public:
240: MethodParams(Pool& pool, const String& amethod_name) : Array(pool),
241: fmethod_name(amethod_name) {
242: }
243:
244: /// handy typecast. I long for templates
1.49 paf 245: Value& get(int index) { return *static_cast<Value *>(Array::get(index)); }
1.48 paf 246: /// handy is-value-a-junction ensurer
1.49 paf 247: Value& get_junction(int index, const char *msg) { return get_as(index, true, msg); }
1.48 paf 248: /// handy value-is-not-a-junction ensurer
1.49 paf 249: Value& get_no_junction(int index, const char *msg) { return get_as(index, false, msg); }
1.48 paf 250:
251: private:
252:
253: /// handy value-is/not-a-junction ensurer
1.49 paf 254: Value& get_as(int index, bool as_junction, const char *msg) {
1.48 paf 255: Value& result=get(index);
1.49 paf 256: if((result.get_junction()!=0) ^ as_junction)
1.48 paf 257: THROW(0, 0,
258: &fmethod_name,
259: msg);
260: return result;
261: }
262:
263: private:
264:
265: const String& fmethod_name;
266:
267: };
268:
269: /**
270: native code method
271: params can be NULL when
1.53 paf 272: method min&max params (see VStateless_class::add_native_method)
1.48 paf 273: counts are zero.
274: */
1.39 paf 275: typedef void (*Native_code_ptr)(Request& request,
276: const String& method_name,
1.48 paf 277: MethodParams *params);
1.39 paf 278:
1.23 paf 279: /**
1.22 paf 280: class method.
281:
282: methods can have
283: - named or
284: - numbered parameters
285:
286: methods can be
287: - parser or
288: - native onces
289:
1.40 paf 290: holds
1.22 paf 291: - parameter names or number limits
292: - local names
293: - code [parser or native]
294: */
1.17 paf 295: class Method : public Pooled {
296: public:
1.39 paf 297:
1.41 paf 298: /// allowed method call types
1.39 paf 299: enum Call_type {
1.41 paf 300: CT_ANY, ///< method can be called either statically or dynamically
301: CT_STATIC, ///< method can be called only statically
302: CT_DYNAMIC ///< method can be called only dynamically
1.39 paf 303: };
304:
305: /// name for error reporting
1.17 paf 306: const String& name;
1.39 paf 307: ///
308: Call_type call_type;
1.22 paf 309: //@{
310: /// @name either numbered params // for native-code methods = operators
1.17 paf 311: int min_numbered_params_count, max_numbered_params_count;
1.22 paf 312: //@}
313: //@{
314: /// @name or named params&locals // for parser-code methods
1.17 paf 315: Array *params_names; Array *locals_names;
1.22 paf 316: //@}
317: //@{
318: /// @name the Code
1.17 paf 319: const Array *parser_code;/*OR*/Native_code_ptr native_code;
1.22 paf 320: //@}
1.17 paf 321:
322: Method(
323: Pool& apool,
324: const String& aname,
1.39 paf 325: Call_type call_type,
1.17 paf 326: int amin_numbered_params_count, int amax_numbered_params_count,
327: Array *aparams_names, Array *alocals_names,
328: const Array *aparser_code, Native_code_ptr anative_code) :
329:
330: Pooled(apool),
331: name(aname),
1.39 paf 332: call_type(call_type),
1.17 paf 333: min_numbered_params_count(amin_numbered_params_count),
334: max_numbered_params_count(amax_numbered_params_count),
335: params_names(aparams_names), locals_names(alocals_names),
336: parser_code(aparser_code), native_code(anative_code) {
337: }
338:
1.22 paf 339: /// call this before invoking to ensure proper actual numbered params count
1.17 paf 340: void check_actual_numbered_params(
341: Value& self, const String& actual_name, Array *actual_numbered_params) const {
1.54 ! paf 342: Pool& pool=self.pool();
! 343:
1.17 paf 344: int actual_count=actual_numbered_params?actual_numbered_params->size():0;
345: if(actual_count<min_numbered_params_count) // not proper count? bark
1.54 ! paf 346: PTHROW(0, 0,
1.17 paf 347: &actual_name,
1.47 paf 348: "native method of %s (%s) accepts minimum %d parameter(s) (%d present)",
1.17 paf 349: self.name().cstr(),
350: self.type(),
1.47 paf 351: min_numbered_params_count,
352: actual_count);
1.17 paf 353:
354: }
1.1 paf 355: };
356:
357: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_value.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / types