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