xref: /aoo41x/main/autodoc/inc/ary/cpp/c_vari.hxx (revision cdf0e10c)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef ARY_CPP_C_VARI_HXX
29 #define ARY_CPP_C_VARI_HXX
30 
31 
32 // USED SERVICES
33 	// BASE CLASSES
34 #include <ary/cpp/c_ce.hxx>
35 	// OTHER
36 #include <ary/cessentl.hxx>
37 #include <ary/cpp/c_types4cpp.hxx>
38 #include <ary/cpp/c_vfflag.hxx>
39 
40 
41 
42 namespace ary
43 {
44 namespace cpp
45 {
46 
47 
48 /** A C++ variable or constant declaration.
49 */
50 class Variable : public CodeEntity
51 {
52   public:
53     // LIFECYCLE
54     enum E_ClassId { class_id = 1005 };
55 
56 						Variable(
57                             const String  &     i_sLocalName,
58                             Ce_id               i_nOwner,
59                             E_Protection        i_eProtection,
60                             loc::Le_id          i_nFile,
61                             Type_id             i_nType,
62                             VariableFlags       i_aFlags,
63                             const String  &     i_sArraySize,
64                             const String  &     i_sInitValue );
65 						~Variable();
66 
67 
68     // INQUIRY
69 	Type_id             Type() const;
70 	const String  &     ArraySize() const;
71 	const String  &     Initialisation() const;
72 	E_Protection        Protection() const      { return eProtection; }
73 
74   private:
75     // Interface csv::ConstProcessorClient
76     virtual void        do_Accept(
77                             csv::ProcessorIfc & io_processor ) const;
78 
79     // Interface ary::cpp::CodeEntity
80 	virtual const String  &
81                         inq_LocalName() const;
82 	virtual Cid         inq_Owner() const;
83 	virtual Lid			inq_Location() const;
84 
85     // Interface ary::cpp::CppEntity
86     virtual ClassId     get_AryClass() const;
87 
88     // DATA
89 	CeEssentials		aEssentials;
90 	Type_id             nType;
91 	E_Protection		eProtection;
92     VariableFlags       aFlags;
93     String              sArraySize;
94     String              sInitialisation;
95 };
96 
97 
98 
99 // IMPLEMENTATION
100 inline Type_id
101 Variable::Type() const
102     { return nType; }
103 inline const String  &
104 Variable::ArraySize() const
105     { return sArraySize; }
106 inline const String  &
107 Variable::Initialisation() const
108     { return sInitialisation; }
109 
110 
111 
112 }   // namespace cpp
113 }   // namespace ary
114 #endif
115