Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
SoSubEvent.h
1 #ifndef COIN_SOSUBEVENT_H
2 #define COIN_SOSUBEVENT_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/C/tidbits.h>
37 
38 // *************************************************************************
39 
40 #define SO_EVENT_HEADER() \
41 private: \
42  static SoType classTypeId; \
43  static void cleanupClass(void) { classTypeId STATIC_SOTYPE_INIT; }; \
44  static void * createInstance(void); \
45 public: \
46  static SoType getClassTypeId(void); \
47  virtual SoType getTypeId(void) const
48 
49 #define SO_EVENT_ABSTRACT_HEADER() \
50 private: \
51  static SoType classTypeId; \
52  static void cleanupClass(void) { classTypeId STATIC_SOTYPE_INIT; }; \
53 public: \
54  static SoType getClassTypeId(void); \
55  virtual SoType getTypeId(void) const
56 
57 // *************************************************************************
58 
59 #define SO_EVENT_ABSTRACT_SOURCE(_class_) \
60 SoType _class_::getClassTypeId(void) { return _class_::classTypeId; } \
61 SoType _class_::getTypeId(void) const { return _class_::classTypeId; } \
62 SoType _class_::classTypeId STATIC_SOTYPE_INIT
63 
64 #define SO_EVENT_SOURCE(_class_) \
65 SoType _class_::getClassTypeId(void) { return _class_::classTypeId; } \
66 SoType _class_::getTypeId(void) const { return _class_::classTypeId; } \
67 void * _class_::createInstance(void) { return static_cast<void *>(new _class_); } \
68 SoType _class_::classTypeId STATIC_SOTYPE_INIT
69 
70 // *************************************************************************
71 
72 #define SO_EVENT_INIT_ABSTRACT_CLASS(_class_, _parentclass_) \
73  do { \
74  /* Make sure we only initialize once. */ \
75  assert(_class_::classTypeId == SoType::badType()); \
76  /* Make sure superclass get initialized before subclass. */ \
77  assert(_parentclass_::getClassTypeId() != SoType::badType()); \
78  \
79  _class_::classTypeId = \
80  SoType::createType(_parentclass_::getClassTypeId(), SO__QUOTE(_class_)); \
81  /* FIXME: internal code should not use this function, but use the coin_atexit() function */ \
82  /* with priority set to CC_ATEXIT_NORMAL. As it is now, the clean-up functions for */ \
83  /* these classes will always be run before all other Coin at-exit clean-ups. 20070126 mortene */ \
84  cc_coin_atexit(reinterpret_cast<coin_atexit_f *>(cleanupClass)); \
85  } WHILE_0
86 
87 #define SO_EVENT_INIT_CLASS(_class_, _parentclass_) \
88  do { \
89  /* Make sure we only initialize once. */ \
90  assert(_class_::classTypeId == SoType::badType()); \
91  /* Make sure superclass get initialized before subclass. */ \
92  assert(_parentclass_::getClassTypeId() != SoType::badType()); \
93  \
94  _class_::classTypeId = \
95  SoType::createType(_parentclass_::getClassTypeId(), SO__QUOTE(_class_), _class_::createInstance); \
96  /* FIXME: internal code should not use this function, but use the coin_atexit() function */ \
97  /* with priority set to CC_ATEXIT_NORMAL. As it is now, the clean-up functions for */ \
98  /* these classes will always be run before all other Coin at-exit clean-ups. 20070126 mortene */ \
99  cc_coin_atexit(reinterpret_cast<coin_atexit_f *>(cleanupClass)); \
100  } WHILE_0
101 
102 // *************************************************************************
103 
104 #endif // !COIN_SOSUBEVENT_H