xref: /aoo42x/main/autodoc/inc/ary/cpp/cp_def.hxx (revision 07a3d7f1)
11c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
31c78a5d6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
41c78a5d6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
51c78a5d6SAndrew Rist  * distributed with this work for additional information
61c78a5d6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
71c78a5d6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
81c78a5d6SAndrew Rist  * "License"); you may not use this file except in compliance
91c78a5d6SAndrew Rist  * with the License.  You may obtain a copy of the License at
101c78a5d6SAndrew Rist  *
111c78a5d6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
121c78a5d6SAndrew Rist  *
131c78a5d6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
141c78a5d6SAndrew Rist  * software distributed under the License is distributed on an
151c78a5d6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
161c78a5d6SAndrew Rist  * KIND, either express or implied.  See the License for the
171c78a5d6SAndrew Rist  * specific language governing permissions and limitations
181c78a5d6SAndrew Rist  * under the License.
191c78a5d6SAndrew Rist  *
201c78a5d6SAndrew Rist  *************************************************************/
211c78a5d6SAndrew Rist 
221c78a5d6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef ARY_CPP_CP_DEF_HXX
25cdf0e10cSrcweir #define ARY_CPP_CP_DEF_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir 
28cdf0e10cSrcweir // USED SERVICES
29cdf0e10cSrcweir 	// BASE CLASSES
30cdf0e10cSrcweir 	// OTHER
31cdf0e10cSrcweir #include <ary/cpp/c_types4cpp.hxx>
32cdf0e10cSrcweir 
33cdf0e10cSrcweir namespace ary
34cdf0e10cSrcweir {
35cdf0e10cSrcweir namespace cpp
36cdf0e10cSrcweir {
37cdf0e10cSrcweir     class Define;
38cdf0e10cSrcweir     class InputContext;
39cdf0e10cSrcweir     class Macro;
40cdf0e10cSrcweir }
41cdf0e10cSrcweir }
42cdf0e10cSrcweir 
43cdf0e10cSrcweir 
44cdf0e10cSrcweir 
45cdf0e10cSrcweir 
46cdf0e10cSrcweir namespace ary
47cdf0e10cSrcweir {
48cdf0e10cSrcweir namespace cpp
49cdf0e10cSrcweir {
50cdf0e10cSrcweir 
51cdf0e10cSrcweir 
52cdf0e10cSrcweir 
53*07a3d7f1SPedro Giffuni /** Access to C++ defines and macros in the repository.
54cdf0e10cSrcweir */
55cdf0e10cSrcweir class DefPilot
56cdf0e10cSrcweir {
57cdf0e10cSrcweir   public:
58cdf0e10cSrcweir     typedef DefsList::const_iterator                DefsIterator;
59cdf0e10cSrcweir 
60cdf0e10cSrcweir 
61cdf0e10cSrcweir 
62cdf0e10cSrcweir     // LIFECYCLE
~DefPilot()63cdf0e10cSrcweir 	virtual             ~DefPilot() {}
64cdf0e10cSrcweir 
65cdf0e10cSrcweir 
66cdf0e10cSrcweir     // OPERATIONS
67cdf0e10cSrcweir 	virtual Define &    Store_Define(
68cdf0e10cSrcweir                             const InputContext& i_rContext,
69cdf0e10cSrcweir 							const String  &     i_sName,
70cdf0e10cSrcweir                             const StringVector &
71cdf0e10cSrcweir                                                 i_rDefinition ) = 0;
72cdf0e10cSrcweir 	virtual Macro &     Store_Macro(
73cdf0e10cSrcweir 							const InputContext& i_rContext,
74cdf0e10cSrcweir 							const String  &     i_sName,
75cdf0e10cSrcweir                             const StringVector &
76cdf0e10cSrcweir                                                 i_rParams,
77cdf0e10cSrcweir                             const StringVector &
78cdf0e10cSrcweir                                                 i_rDefinition ) = 0;
79cdf0e10cSrcweir     // INQUIRY
80cdf0e10cSrcweir     virtual const DefineEntity &
81cdf0e10cSrcweir                         Find_Def(
82cdf0e10cSrcweir                             De_id               i_id ) const = 0;
83cdf0e10cSrcweir     virtual DefsResultList
84cdf0e10cSrcweir                         AllDefines() const = 0;
85cdf0e10cSrcweir     virtual DefsResultList
86cdf0e10cSrcweir                         AllMacros() const = 0;
87cdf0e10cSrcweir };
88cdf0e10cSrcweir 
89cdf0e10cSrcweir 
90cdf0e10cSrcweir 
91cdf0e10cSrcweir 
92cdf0e10cSrcweir 
93cdf0e10cSrcweir }   // namespace cpp
94cdf0e10cSrcweir }   // namespace ary
95cdf0e10cSrcweir #endif
96