Source

Coin / include / Inventor / scxml / ScXMLEvaluator.h

Full commit
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
#ifndef COIN_SCXMLEVALUATOR_H
#define COIN_SCXMLEVALUATOR_H

/**************************************************************************\
 * Copyright (c) Kongsberg Oil & Gas Technologies AS
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/

#include <Inventor/scxml/ScXMLObject.h>
#include <Inventor/tools/SbLazyPimplPtr.h>

class ScXMLDocument;
class ScXMLStateMachine;
class ScXMLDataObj;


class COIN_DLL_API ScXMLEvaluator : public ScXMLObject {
  typedef ScXMLObject inherited;
  SCXML_OBJECT_ABSTRACT_HEADER(ScXMLEvaluator)
public:
  static void initClass(void);
  static void cleanClass(void);

  ScXMLEvaluator(void);
  virtual ~ScXMLEvaluator(void);

  virtual void setStateMachine(ScXMLStateMachine * sm);
  ScXMLStateMachine * getStateMachine(void) const { return this->statemachine; }

  virtual ScXMLDataObj * evaluate(const char * expression) const = 0;

  virtual SbBool setAtLocation(const char * location, ScXMLDataObj * obj) = 0;
  virtual ScXMLDataObj * locate(const char * location) const = 0;

  virtual void clearTemporaryVariables(void);

protected:

private:
  ScXMLStateMachine * statemachine;

  class PImpl;
  SbLazyPimplPtr<PImpl> pimpl;

}; // ScXMLEvaluator


// *************************************************************************

class COIN_DLL_API ScXMLDataObj : public ScXMLObject {
  SCXML_OBJECT_ABSTRACT_HEADER(ScXMLDataObj)
  typedef ScXMLObject inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  ScXMLDataObj(void);
  virtual ~ScXMLDataObj(void);

  void setContainer(ScXMLObject * container);
  ScXMLObject * getContainer(void) const { return this->container; }

private:
  ScXMLObject * container;

}; // ScXMLDataObj

class COIN_DLL_API ScXMLConstantDataObj : public ScXMLDataObj {
  SCXML_OBJECT_ABSTRACT_HEADER(ScXMLConstantDataObj)
  typedef ScXMLDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  virtual ScXMLDataObj * clone(void) const = 0;
  virtual void convertToString(SbString & str) const = 0;

};


class COIN_DLL_API ScXMLStringDataObj : public ScXMLConstantDataObj {
  SCXML_OBJECT_HEADER(ScXMLStringDataObj)
  typedef ScXMLConstantDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(const char * value);

  ScXMLStringDataObj(void);
  ScXMLStringDataObj(const char * value);
  virtual ~ScXMLStringDataObj(void);

  void setString(const char * value);
  const char * getString(void) const { return this->value; }

  virtual ScXMLDataObj * clone(void) const;
  virtual void convertToString(SbString & str) const;

private:
  char * value;

};


class COIN_DLL_API ScXMLRealDataObj : public ScXMLConstantDataObj {
  SCXML_OBJECT_HEADER(ScXMLRealDataObj)
  typedef ScXMLConstantDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(double value);

  ScXMLRealDataObj(void);
  ScXMLRealDataObj(double value);
  virtual ~ScXMLRealDataObj(void);

  void setReal(double value);
  double getReal(void) const { return this->value; }

  virtual ScXMLDataObj * clone(void) const;
  virtual void convertToString(SbString & str) const;

private:
  double value;

};


class COIN_DLL_API ScXMLBoolDataObj : public ScXMLConstantDataObj {
  SCXML_OBJECT_HEADER(ScXMLBoolDataObj)
  typedef ScXMLConstantDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(SbBool value);

  ScXMLBoolDataObj(void);
  ScXMLBoolDataObj(SbBool value);
  virtual ~ScXMLBoolDataObj(void);

  void setBool(SbBool value);
  SbBool getBool(void) const { return this->value; }

  virtual ScXMLDataObj * clone(void) const;
  virtual void convertToString(SbString & str) const;

private:
  SbBool value;

};


class COIN_DLL_API ScXMLSbDataObj : public ScXMLConstantDataObj {
  SCXML_OBJECT_HEADER(ScXMLSbDataObj)
  typedef ScXMLConstantDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(const char * value);

  ScXMLSbDataObj(void);
  ScXMLSbDataObj(const char * value);
  virtual ~ScXMLSbDataObj(void);

  void setSbValue(const char * value);
  const char * getSbValue(void) const { return this->value; }

  virtual ScXMLDataObj * clone(void) const;
  virtual void convertToString(SbString & str) const;

private:
  char * value;

};


class COIN_DLL_API ScXMLXMLDataObj : public ScXMLDataObj {
  SCXML_OBJECT_HEADER(ScXMLXMLDataObj)
  typedef ScXMLDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  ScXMLXMLDataObj(void);
  virtual ~ScXMLXMLDataObj(void);

  virtual ScXMLDataObj * clone(void) const;

};


class COIN_DLL_API ScXMLExprDataObj : public ScXMLDataObj {
  SCXML_OBJECT_ABSTRACT_HEADER(ScXMLExprDataObj)
  typedef ScXMLDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  ScXMLExprDataObj(void);
  virtual ~ScXMLExprDataObj(void);

  ScXMLDataObj * evaluate(ScXMLStateMachine * sm);

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const = 0;

private:
  ScXMLDataObj * result;

};


class COIN_DLL_API ScXMLReferenceDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLReferenceDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(const char * reference);

  ScXMLReferenceDataObj(void);
  ScXMLReferenceDataObj(const char * reference);
  virtual ~ScXMLReferenceDataObj(void);

  void setReference(const char * reference);
  const char * getReference(void) const { return this->reference; }

  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  char * reference;

};


// *************************************************************************
// logical operators

class COIN_DLL_API ScXMLAndOpExprDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLAndOpExprDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(ScXMLDataObj * lhs, ScXMLDataObj * rhs);

  ScXMLAndOpExprDataObj(void);
  ScXMLAndOpExprDataObj(ScXMLDataObj * lhs, ScXMLDataObj * rhs);
  virtual ~ScXMLAndOpExprDataObj(void);

  void setLHS(ScXMLDataObj * lhs);
  const ScXMLDataObj * getLHS(void) const { return this->lhs; }
  void setRHS(ScXMLDataObj * rhs);
  const ScXMLDataObj * getRHS(void) const { return this->rhs; }

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  ScXMLDataObj * lhs, * rhs;

};


class COIN_DLL_API ScXMLOrOpExprDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLOrOpExprDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(ScXMLDataObj * lhs, ScXMLDataObj * rhs);

  ScXMLOrOpExprDataObj(void);
  ScXMLOrOpExprDataObj(ScXMLDataObj * lhs, ScXMLDataObj * rhs);
  virtual ~ScXMLOrOpExprDataObj(void);

  void setLHS(ScXMLDataObj * lhs);
  const ScXMLDataObj * getLHS(void) const { return this->lhs; }
  void setRHS(ScXMLDataObj * rhs);
  const ScXMLDataObj * getRHS(void) const { return this->rhs; }

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  ScXMLDataObj * lhs, * rhs;

};


class COIN_DLL_API ScXMLNotOpExprDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLNotOpExprDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(ScXMLDataObj * rhs);

  ScXMLNotOpExprDataObj(void);
  ScXMLNotOpExprDataObj(ScXMLDataObj * rhs);
  virtual ~ScXMLNotOpExprDataObj(void);

  void setRHS(ScXMLDataObj * rhs);
  const ScXMLDataObj * getRHS(void) const { return this->rhs; }

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  ScXMLDataObj * rhs;

};


class COIN_DLL_API ScXMLEqualsOpExprDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLEqualsOpExprDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(ScXMLDataObj * lhs, ScXMLDataObj * rhs);

  ScXMLEqualsOpExprDataObj(void);
  ScXMLEqualsOpExprDataObj(ScXMLDataObj * lhs, ScXMLDataObj * rhs);
  virtual ~ScXMLEqualsOpExprDataObj(void);

  void setLHS(ScXMLDataObj * lhs);
  const ScXMLDataObj * getLHS(void) const { return this->lhs; }
  void setRHS(ScXMLDataObj * rhs);
  const ScXMLDataObj * getRHS(void) const { return this->rhs; }

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  ScXMLDataObj * lhs, * rhs;

};


// *************************************************************************
// arithmetic operators

class COIN_DLL_API ScXMLAddOpExprDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLAddOpExprDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(ScXMLDataObj * lhs, ScXMLDataObj * rhs);

  ScXMLAddOpExprDataObj(void);
  ScXMLAddOpExprDataObj(ScXMLDataObj * lhs, ScXMLDataObj * rhs);
  virtual ~ScXMLAddOpExprDataObj(void);

  void setLHS(ScXMLDataObj * lhs);
  const ScXMLDataObj * getLHS(void) const { return this->lhs; }
  void setRHS(ScXMLDataObj * rhs);
  const ScXMLDataObj * getRHS(void) const { return this->rhs; }

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  ScXMLDataObj * lhs, * rhs;

};


class COIN_DLL_API ScXMLSubtractOpExprDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLSubtractOpExprDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(ScXMLDataObj * lhs, ScXMLDataObj * rhs);

  ScXMLSubtractOpExprDataObj(void);
  ScXMLSubtractOpExprDataObj(ScXMLDataObj * lhs, ScXMLDataObj * rhs);
  virtual ~ScXMLSubtractOpExprDataObj(void);

  void setLHS(ScXMLDataObj * lhs);
  const ScXMLDataObj * getLHS(void) const { return this->lhs; }
  void setRHS(ScXMLDataObj * rhs);
  const ScXMLDataObj * getRHS(void) const { return this->rhs; }

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  ScXMLDataObj * lhs, * rhs;

};


class COIN_DLL_API ScXMLMultiplyOpExprDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLMultiplyOpExprDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(ScXMLDataObj * lhs, ScXMLDataObj * rhs);

  ScXMLMultiplyOpExprDataObj(void);
  ScXMLMultiplyOpExprDataObj(ScXMLDataObj * lhs, ScXMLDataObj * rhs);
  virtual ~ScXMLMultiplyOpExprDataObj(void);

  void setLHS(ScXMLDataObj * lhs);
  const ScXMLDataObj * getLHS(void) const { return this->lhs; }
  void setRHS(ScXMLDataObj * rhs);
  const ScXMLDataObj * getRHS(void) const { return this->rhs; }

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  ScXMLDataObj * lhs, * rhs;

};


class COIN_DLL_API ScXMLDivideOpExprDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLDivideOpExprDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(ScXMLDataObj * lhs, ScXMLDataObj * rhs);

  ScXMLDivideOpExprDataObj(void);
  ScXMLDivideOpExprDataObj(ScXMLDataObj * lhs, ScXMLDataObj * rhs);
  virtual ~ScXMLDivideOpExprDataObj(void);

  void setLHS(ScXMLDataObj * lhs);
  const ScXMLDataObj * getLHS(void) const { return this->lhs; }
  void setRHS(ScXMLDataObj * rhs);
  const ScXMLDataObj * getRHS(void) const { return this->rhs; }

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  ScXMLDataObj * lhs, * rhs;

};


class COIN_DLL_API ScXMLNegateOpExprDataObj : public ScXMLExprDataObj {
  SCXML_OBJECT_HEADER(ScXMLNegateOpExprDataObj)
  typedef ScXMLExprDataObj inherited;
public:
  static void initClass(void);
  static void cleanClass(void);

  static ScXMLDataObj * createFor(ScXMLDataObj * rhs);

  ScXMLNegateOpExprDataObj(void);
  ScXMLNegateOpExprDataObj(ScXMLDataObj * rhs);
  virtual ~ScXMLNegateOpExprDataObj(void);

  void setRHS(ScXMLDataObj * rhs);
  const ScXMLDataObj * getRHS(void) const { return this->rhs; }

protected:
  virtual SbBool evaluateNow(ScXMLStateMachine * sm, ScXMLDataObj *& pointer) const;

private:
  ScXMLDataObj * rhs;

};


#endif // !COIN_SCXMLEVALUATOR_H