blob: 2e6a5e157e7c657c849bed4705c31148aa1fa67c (
plain)
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
|
// -*- C++ -*-
//=============================================================================
/**
* @file TypeCode_Struct_Field.h
*
* $Id$
*
* Header file for @c TAO::TypeCode::Struct_Field type.
*
* @author Ossama Othman <ossama@dre.vanderbilt.edu>
* @author Carlos O'Ryan
*/
//=============================================================================
#ifndef TAO_TYPECODE_STRUCT_FIELD_H
#define TAO_TYPECODE_STRUCT_FIELD_H
#include /**/ "ace/pre.h"
#include "ace/config.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
namespace CORBA
{
class TypeCode;
typedef TypeCode* TypeCode_ptr;
}
namespace TAO
{
namespace TypeCode
{
/**
* @struct Struct_Field
*
* @brief Name/type pair for fields of an OMG IDL defined
* structure or exception.
*
* A @c Struct_Field contains the corresponding name and pointer
* to the @c CORBA::TypeCode for a given OMG IDL defined type.
* For example, the fields in following OMG IDL structure:
*
* \code
* struct Foo
* {
* long the_number;
* string the_string;
* };
* \endcode
*
* would be represented using the following statically instantiated
* @c TAO::TypeCode::Struct_Field array:
*
* \code
* TAO::TypeCode::Struct_Field<char const *> _tao_fields_Foo[] =
* {
* { "the_number", &CORBA::_tc_long },
* { "the_string", &CORBA::_tc_string },
* };
* \endcode
*
* The template parameter @a STRING_TYPE is either @c char
* @c const @c * or @c CORBA::String_var. The latter is only used
* when creating @c CORBA::tk_struct or @c CORBA::tk_except
* @c TypeCodes dynamically, such as through the TypeCodeFactory.
*/
template <typename STRING_TYPE>
struct Struct_Field
{
/// Destructor.
~Struct_Field (void);
/// Return the name of the @c Struct_Field.
/**
* @note This method unfortunately exists so that we can
* retrieve the underlying string when the @a STRING_TYPE
* is @c CORBA::String_var rather than the
* @c CORBA::String_var itself. This is necessary to
* silence a warning about better conversion sequences
* exhibited by some C++ compilers.
*/
char const * get_name (void) const;
/// The name of the field.
STRING_TYPE name;
/// Pointer to the @c CORBA::TypeCode of the field.
/**
* A pointer to the @c CORBA::TypeCode_ptr rather than the
* @c CORBA::TypeCode_ptr itself is stored since that address is
* well-defined. We may not know the value of the @c
* CORBA::TypeCode_ptr when creating this @c Struct_Field
* statically at compile-time, hence the indirection.
*
* @note This @c TypeCode is released upon destruction of this
* @c Struct_Field.
*/
CORBA::TypeCode_ptr const * type;
};
} // End namespace TypeCode
} // End namespace TAO
// If we didn't have to worry about better conversion sequence
// warnings, and drop the Struct_Field<>::get_name() method, we could
// drop the below #include directives and remove the files contained
// within them altogether.
#ifdef __ACE_INLINE__
# include "tao/TypeCode_Struct_Field.inl"
#endif /* __ACE_INLINE__ */
#ifdef ACE_TEMPLATES_REQUIRE_SOURCE
# include "tao/TypeCode_Struct_Field.cpp"
#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */
#ifdef ACE_TEMPLATES_REQUIRE_PRAGMA
# pragma implementation ("TypeCode_Struct_Field.cpp")
#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */
#include /**/ "ace/post.h"
#endif /* TAO_TYPECODE_STRUCT_FIELD_H */
|
