NXWidgets: singletons.hxx Source File

NXWidgets 1.19

singletons.hxx
Go to the documentation of this file.
1 /****************************************************************************
2 * NxWidgets/libnxwidgets/include/singletons.hxx
3 *
4 * Copyright (C) 2012 Gregory Nutt. All rights reserved.
5 * Author: Gregory Nutt <gnutt@nuttx.org>
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
16 * distribution.
17 * 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
18 * me be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *
34 ****************************************************************************
35 *
36 * Portions of this package derive from Woopsi (http://woopsi.org/) and
37 * portions are original efforts. It is difficult to determine at this
38 * point what parts are original efforts and which parts derive from Woopsi.
39 * However, in any event, the work of Antony Dzeryn will be acknowledged
40 * in most NxWidget files. Thanks Antony!
41 *
42 * Copyright (c) 2007-2011, Antony Dzeryn
43 * All rights reserved.
44 *
45 * Redistribution and use in source and binary forms, with or without
46 * modification, are permitted provided that the following conditions are met:
47 *
48 * * Redistributions of source code must retain the above copyright
49 * notice, this list of conditions and the following disclaimer.
50 * * Redistributions in binary form must reproduce the above copyright
51 * notice, this list of conditions and the following disclaimer in the
52 * documentation and/or other materials provided with the distribution.
53 * * Neither the names "Woopsi", "Simian Zombie" nor the
54 * names of its contributors may be used to endorse or promote products
55 * derived from this software without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY Antony Dzeryn ``AS IS'' AND ANY
58 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
59 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
60 * DISCLAIMED. IN NO EVENT SHALL Antony Dzeryn BE LIABLE FOR ANY
61 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
62 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
63 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
64 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
66 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67 *
68 ****************************************************************************/
69
70 #ifndef __INCLUDE_SINGLETONS_HXX
71 #define __INCLUDE_SINGLETONS_HXX
72
73 /****************************************************************************
74 * Included Files
75 ****************************************************************************/
76
77 #include <nuttx/config.h>
78
79 #include <stdint.h>
80 #include <stdbool.h>
81
82 #include <cnxtimer.hxx>
83
84 /****************************************************************************
85 * Pre-Processor Definitions
86 ****************************************************************************/
87
88 /****************************************************************************
89 * Implementation Classes
90 ****************************************************************************/
91
92 #if defined(__cplusplus)
93
94 namespace NXWidgets
95 {
96 /**
97 * Forward References
98 */
99
100 class CWidgetStyle;
101 class CNxString;
102
103 /**
104 * Global singleton instances
105 */
106
107 extern CWidgetStyle *g_defaultWidgetStyle; /**< The default widget style */
108 extern CNxString *g_nullString; /**< The reusable empty string */
109 extern TNxArray<CNxTimer*> *g_nxTimers; /**< An array of all timers */
110
111 /**
112 * Setup misc singleton instances.
113 *
114 * Q: Why is there here?
115 * A: Because it needs to be done one time before any widgets are created.
116 * Q: So why isn't it just the default style just a statically constructed class?
117 * A: Because not all platforms will support static class constructions.
118 * Q: Why isn't it part of CNxServer?
119 * A: Because the singletons may be needed before the server is started.
120 */
121
122 void instantiateSingletons(void);
123
124 /**
125 * Free the singleton instances when the last NX server is destroyed.
126 *
127 * Q: Why is there here is it is only called as part of the CNxServer destructor?
128 * A: Just for symmetry with instantiateSingletons().
129 */
130
131 void freeSingletons(void);
132 }
133
134 #endif // __cplusplus
135
136 #endif // __INCLUDE_SINGLETONS_HXX
NXWidgets::instantiateSingletons
void instantiateSingletons(void)
Definition: singletons.cxx:114
NXWidgets
Definition: cbgwindow.hxx:65
NXWidgets::g_nxTimers
TNxArray< CNxTimer * > * g_nxTimers
Definition: singletons.hxx:109
TNxArray
Definition: tnxarray.hxx:109
cnxtimer.hxx
NXWidgets::g_defaultWidgetStyle
CWidgetStyle * g_defaultWidgetStyle
Definition: singletons.hxx:101
NXWidgets::freeSingletons
void freeSingletons(void)
Definition: singletons.cxx:170
NXWidgets::g_nullString
CNxString * g_nullString
Definition: singletons.hxx:108