xref: /aoo42x/main/autodoc/inc/ary/cpp/cp_def.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_CP_DEF_HXX
29*cdf0e10cSrcweir #define ARY_CPP_CP_DEF_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir // USED SERVICES
33*cdf0e10cSrcweir 	// BASE CLASSES
34*cdf0e10cSrcweir 	// OTHER
35*cdf0e10cSrcweir #include <ary/cpp/c_types4cpp.hxx>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir namespace ary
38*cdf0e10cSrcweir {
39*cdf0e10cSrcweir namespace cpp
40*cdf0e10cSrcweir {
41*cdf0e10cSrcweir     class Define;
42*cdf0e10cSrcweir     class InputContext;
43*cdf0e10cSrcweir     class Macro;
44*cdf0e10cSrcweir }
45*cdf0e10cSrcweir }
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir namespace ary
51*cdf0e10cSrcweir {
52*cdf0e10cSrcweir namespace cpp
53*cdf0e10cSrcweir {
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir /** Acess to C++ defines and macros in the repository.
58*cdf0e10cSrcweir */
59*cdf0e10cSrcweir class DefPilot
60*cdf0e10cSrcweir {
61*cdf0e10cSrcweir   public:
62*cdf0e10cSrcweir     typedef DefsList::const_iterator                DefsIterator;
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir     // LIFECYCLE
67*cdf0e10cSrcweir 	virtual             ~DefPilot() {}
68*cdf0e10cSrcweir 
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir     // OPERATIONS
71*cdf0e10cSrcweir 	virtual Define &    Store_Define(
72*cdf0e10cSrcweir                             const InputContext& i_rContext,
73*cdf0e10cSrcweir 							const String  &     i_sName,
74*cdf0e10cSrcweir                             const StringVector &
75*cdf0e10cSrcweir                                                 i_rDefinition ) = 0;
76*cdf0e10cSrcweir 	virtual Macro &     Store_Macro(
77*cdf0e10cSrcweir 							const InputContext& i_rContext,
78*cdf0e10cSrcweir 							const String  &     i_sName,
79*cdf0e10cSrcweir                             const StringVector &
80*cdf0e10cSrcweir                                                 i_rParams,
81*cdf0e10cSrcweir                             const StringVector &
82*cdf0e10cSrcweir                                                 i_rDefinition ) = 0;
83*cdf0e10cSrcweir     // INQUIRY
84*cdf0e10cSrcweir     virtual const DefineEntity &
85*cdf0e10cSrcweir                         Find_Def(
86*cdf0e10cSrcweir                             De_id               i_id ) const = 0;
87*cdf0e10cSrcweir     virtual DefsResultList
88*cdf0e10cSrcweir                         AllDefines() const = 0;
89*cdf0e10cSrcweir     virtual DefsResultList
90*cdf0e10cSrcweir                         AllMacros() const = 0;
91*cdf0e10cSrcweir };
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir 
94*cdf0e10cSrcweir 
95*cdf0e10cSrcweir 
96*cdf0e10cSrcweir 
97*cdf0e10cSrcweir }   // namespace cpp
98*cdf0e10cSrcweir }   // namespace ary
99*cdf0e10cSrcweir #endif
100