Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
ScXMLElt.h
1 #ifndef COIN_SCXMLELT_H
2 #define COIN_SCXMLELT_H
3 
4 /**************************************************************************\
5  * Copyright (c) Kongsberg Oil & Gas Technologies AS
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  *
19  * Neither the name of the copyright holder nor the names of its
20  * contributors may be used to endorse or promote products derived from
21  * this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 \**************************************************************************/
35 
36 #include <Inventor/SbBasic.h>
37 #include <Inventor/SoType.h>
38 #include <Inventor/tools/SbPimplPtr.h>
39 #include <Inventor/scxml/ScXMLObject.h>
40 #include <Inventor/scxml/ScXMLSubObject.h>
41 
42 class ScXMLStateMachine;
43 
44 class COIN_DLL_API ScXMLElt : public ScXMLObject {
45  typedef ScXMLObject inherited;
46  SCXML_ELEMENT_ABSTRACT_HEADER(ScXMLElt)
47 
48 public:
49  static void initClass(void);
50  static void cleanClass(void);
51 
52  ScXMLElt(void);
53  virtual ~ScXMLElt(void);
54 
55  void setXMLAttribute(const char * attribute, const char * value);
56  const char * getXMLAttribute(const char * attribute) const;
57 
58  virtual SbBool handleXMLAttributes(void);
59 
60  virtual const ScXMLElt * search(const char * attrname, const char * attrvalue) const;
61 
62  ScXMLElt * clone(void) const;
63  virtual void copyContents(const ScXMLElt * rhs);
64 
65  virtual void setContainer(ScXMLElt * container);
66  ScXMLElt * getContainer(void) const { return this->containerptr; }
67 
68  SbBool isContainedIn(const ScXMLElt * object) const;
69 
70 protected:
71  static void registerClassType(const char * xmlns,
72  const char * classname, SoType type);
73  static void registerInvokeClassType(const char * xmlns,
74  const char * targettype,
75  const char * source, SoType type);
76 
77 private:
78  ScXMLElt * containerptr;
79 
80 private:
81  ScXMLElt(const ScXMLElt & rhs); // N/A
82  ScXMLElt & operator = (const ScXMLElt & rhs); // N/A
83 
84  class PImpl;
85  SbPimplPtr<PImpl> pimpl;
86 
87 }; // ScXMLElt
88 
89 // *************************************************************************
90 
91 class ScXMLDocument;
92 class ScXMLStateMachine;
93 struct cc_xml_elt;
94 
95 class COIN_DLL_API ScXMLEltReader {
96 public:
97  ScXMLEltReader(const char * eltname);
98  virtual ~ScXMLEltReader(void);
99 
100  virtual ScXMLElt * read(ScXMLElt * container, cc_xml_elt * elt,
101  ScXMLDocument * doc, ScXMLStateMachine * sm) = 0;
102 
103 protected:
104  const char * element;
105 
106  void setXMLAttributes(ScXMLElt * scxmlelt, cc_xml_elt * xmlelt);
107 
108 }; // ScXMLEltReader
109 
110 // *************************************************************************
111 
112 #endif // !COIN_SCXMLELT_H
base class for element reader objects
Definition: ScXMLElt.h:95
static void registerInvokeClassType(const char *xmlns, const char *targettype, const char *source, SoType type)
Definition: ScXMLObject.cpp:158
base class for all SCXML elements.
Definition: ScXMLElt.h:44
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition: ScXMLObject.cpp:102
Definition: ScXMLDocument.h:47
static void cleanClass(void)
Does the opposite of initClass, deallocates any class specific resources and resets the class to an u...
Definition: ScXMLObject.cpp:115
Base class for all SCXML objects.
Definition: ScXMLObject.h:41
The SoType class is the basis for the runtime type system in Coin.
Definition: SoType.h:59
static void registerClassType(const char *xmlns, const char *classname, SoType type)
Definition: ScXMLObject.cpp:148
Manager for processing events and setting states in SCXML structures.
Definition: ScXMLStateMachine.h:61