xref: /aoo42x/main/autodoc/inc/ary/cpp/c_ce.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_CE_HXX
29*cdf0e10cSrcweir #define ARY_CPP_C_CE_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir // USED SERVICES
33*cdf0e10cSrcweir 	// BASE CLASSES
34*cdf0e10cSrcweir #include <ary/cpp/c_cppentity.hxx>
35*cdf0e10cSrcweir 	// COMPONENTS
36*cdf0e10cSrcweir #include <ary/doc/d_docu.hxx>
37*cdf0e10cSrcweir 	// PARAMETERS
38*cdf0e10cSrcweir #include <ary/cpp/c_types4cpp.hxx>
39*cdf0e10cSrcweir #include <ary/cpp/c_traits.hxx>
40*cdf0e10cSrcweir #include <ary/loc/loc_types4loc.hxx>
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir namespace ary
44*cdf0e10cSrcweir {
45*cdf0e10cSrcweir namespace cpp
46*cdf0e10cSrcweir {
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir typedef loc::Le_id  Lid;
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir /** Represents a C++ code entity.
53*cdf0e10cSrcweir */
54*cdf0e10cSrcweir class CodeEntity : public ary::cpp::CppEntity
55*cdf0e10cSrcweir {
56*cdf0e10cSrcweir   public:
57*cdf0e10cSrcweir     typedef Ce_Traits       traits_t;
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir 	// LIFECYCLE
60*cdf0e10cSrcweir 	virtual			   	~CodeEntity() {}
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir 	// INQUIRY
63*cdf0e10cSrcweir     Ce_id               CeId() const            { return Ce_id(Id()); }
64*cdf0e10cSrcweir 	const String  &     LocalName() const;
65*cdf0e10cSrcweir 	Cid                 Owner() const;
66*cdf0e10cSrcweir 	Lid			        Location() const;
67*cdf0e10cSrcweir     bool                IsVisible() const;
68*cdf0e10cSrcweir 
69*cdf0e10cSrcweir     // ACCESS
70*cdf0e10cSrcweir     void                Set_InVisible()         { bIsVisible = false; }
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir   protected:
73*cdf0e10cSrcweir                         CodeEntity() : bIsVisible(true) {}
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir   private:
76*cdf0e10cSrcweir     // Locals
77*cdf0e10cSrcweir 	virtual const String  &
78*cdf0e10cSrcweir                         inq_LocalName() const = 0;
79*cdf0e10cSrcweir 	virtual Cid         inq_Owner() const = 0;
80*cdf0e10cSrcweir 	virtual Lid			inq_Location() const = 0;
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir 	// DATA
83*cdf0e10cSrcweir 	mutable bool        bIsVisible;
84*cdf0e10cSrcweir };
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir // IMPLEMENTATION
88*cdf0e10cSrcweir inline const String  &
89*cdf0e10cSrcweir CodeEntity::LocalName() const
90*cdf0e10cSrcweir     { return inq_LocalName(); }
91*cdf0e10cSrcweir inline Cid
92*cdf0e10cSrcweir CodeEntity::Owner() const
93*cdf0e10cSrcweir     { return inq_Owner(); }
94*cdf0e10cSrcweir inline Lid
95*cdf0e10cSrcweir CodeEntity::Location() const
96*cdf0e10cSrcweir     { return inq_Location(); }
97*cdf0e10cSrcweir 
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir 
100*cdf0e10cSrcweir 
101*cdf0e10cSrcweir }   // namespace cpp
102*cdf0e10cSrcweir }   // namespace ary
103*cdf0e10cSrcweir #endif
104