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