xref: /aoo42x/main/autodoc/inc/ary/cpp/c_de.hxx (revision cdf0e10c)
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_DE_HXX
29*cdf0e10cSrcweir #define ARY_CPP_C_DE_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir // USED SERVICES
34*cdf0e10cSrcweir 	// BASE CLASSES
35*cdf0e10cSrcweir #include <ary/cpp/c_cppentity.hxx>
36*cdf0e10cSrcweir 	// OTHER
37*cdf0e10cSrcweir #include <ary/loc/loc_types4loc.hxx>
38*cdf0e10cSrcweir #include <ary/cpp/c_traits.hxx>
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir namespace ary
44*cdf0e10cSrcweir {
45*cdf0e10cSrcweir namespace cpp
46*cdf0e10cSrcweir {
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir /** Describes a C/C++ #define statement. May be a define or a macro, for which
50*cdf0e10cSrcweir     two cases the two different constructors are to be used.
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir     This class is used by cpp::PreProcessor.
53*cdf0e10cSrcweir */
54*cdf0e10cSrcweir class DefineEntity : public ary::cpp::CppEntity
55*cdf0e10cSrcweir {
56*cdf0e10cSrcweir   public:
57*cdf0e10cSrcweir     typedef Def_Traits       traits_t;
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir     virtual             ~DefineEntity() {}
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir     // INQUIRY
62*cdf0e10cSrcweir     De_id               DefId() const           { return De_id(Id()); }
63*cdf0e10cSrcweir     const String  &     LocalName() const;
64*cdf0e10cSrcweir 	loc::Le_id			Location() const;
65*cdf0e10cSrcweir     const StringVector &
66*cdf0e10cSrcweir                         DefinitionText() const;
67*cdf0e10cSrcweir     // ACCESS
68*cdf0e10cSrcweir   protected:
69*cdf0e10cSrcweir                         DefineEntity(
70*cdf0e10cSrcweir                             const String  &     i_name,
71*cdf0e10cSrcweir                             loc::Le_id          i_declaringFile );
72*cdf0e10cSrcweir   private:
73*cdf0e10cSrcweir     // Locals
74*cdf0e10cSrcweir     virtual const StringVector &
75*cdf0e10cSrcweir                         inq_DefinitionText() const = 0;
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir     // DATA
78*cdf0e10cSrcweir     String              sName;
79*cdf0e10cSrcweir     loc::Le_id          nLocation;
80*cdf0e10cSrcweir };
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir // IMPLEMENTATION
86*cdf0e10cSrcweir inline const String  &
87*cdf0e10cSrcweir DefineEntity::LocalName() const
88*cdf0e10cSrcweir     { return sName; }
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir inline loc::Le_id
91*cdf0e10cSrcweir DefineEntity::Location() const
92*cdf0e10cSrcweir     { return nLocation; }
93*cdf0e10cSrcweir 
94*cdf0e10cSrcweir inline const StringVector &
95*cdf0e10cSrcweir DefineEntity::DefinitionText() const
96*cdf0e10cSrcweir     { return inq_DefinitionText(); }
97*cdf0e10cSrcweir 
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir 
100*cdf0e10cSrcweir 
101*cdf0e10cSrcweir 
102*cdf0e10cSrcweir }   // end namespace cpp
103*cdf0e10cSrcweir }   // end namespace ary
104*cdf0e10cSrcweir #endif
105