xref: /aoo42x/main/autodoc/inc/autodoc/filecoli.hxx (revision 1c78a5d6)
1*1c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*1c78a5d6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*1c78a5d6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*1c78a5d6SAndrew Rist  * distributed with this work for additional information
6*1c78a5d6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*1c78a5d6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*1c78a5d6SAndrew Rist  * "License"); you may not use this file except in compliance
9*1c78a5d6SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*1c78a5d6SAndrew Rist  *
11*1c78a5d6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*1c78a5d6SAndrew Rist  *
13*1c78a5d6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*1c78a5d6SAndrew Rist  * software distributed under the License is distributed on an
15*1c78a5d6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1c78a5d6SAndrew Rist  * KIND, either express or implied.  See the License for the
17*1c78a5d6SAndrew Rist  * specific language governing permissions and limitations
18*1c78a5d6SAndrew Rist  * under the License.
19*1c78a5d6SAndrew Rist  *
20*1c78a5d6SAndrew Rist  *************************************************************/
21*1c78a5d6SAndrew Rist 
22*1c78a5d6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef ADC_PARSER_FILECOLI_HXX
25cdf0e10cSrcweir #define ADC_PARSER_FILECOLI_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir 
28cdf0e10cSrcweir namespace autodoc
29cdf0e10cSrcweir {
30cdf0e10cSrcweir 
31cdf0e10cSrcweir class FileCollector_Ifc
32cdf0e10cSrcweir {
33cdf0e10cSrcweir   public:
34cdf0e10cSrcweir     // TYPES
35cdf0e10cSrcweir 	typedef StringVector::const_iterator const_iterator;
36cdf0e10cSrcweir 
37cdf0e10cSrcweir 	enum E_SearchMode
38cdf0e10cSrcweir 	{
39cdf0e10cSrcweir 		flat,
40cdf0e10cSrcweir 		recursive
41cdf0e10cSrcweir 	};
42cdf0e10cSrcweir 
43cdf0e10cSrcweir     // LIFECYCLE
~FileCollector_Ifc()44cdf0e10cSrcweir     virtual             ~FileCollector_Ifc() {}
45cdf0e10cSrcweir 
46cdf0e10cSrcweir     // OPERATIONS
47cdf0e10cSrcweir 	virtual uintt       AddFilesFrom(
48cdf0e10cSrcweir 							const char *		i_sRootDir,
49cdf0e10cSrcweir 							const char *		i_sFilter,
50cdf0e10cSrcweir 							E_SearchMode		i_eSearchMode ) = 0;
51cdf0e10cSrcweir 	virtual uintt       AddFile(
52cdf0e10cSrcweir 							const char *		i_sFilePath ) = 0;
53cdf0e10cSrcweir 	virtual void        EraseAll() = 0;
54cdf0e10cSrcweir 
55cdf0e10cSrcweir     // INQUIRY
56cdf0e10cSrcweir 	virtual const_iterator
57cdf0e10cSrcweir                         Begin() const = 0;
58cdf0e10cSrcweir 	virtual const_iterator
59cdf0e10cSrcweir                         End() const = 0;
60cdf0e10cSrcweir 	virtual uintt       Size() const = 0;
61cdf0e10cSrcweir };
62cdf0e10cSrcweir 
63cdf0e10cSrcweir 
64cdf0e10cSrcweir } // namespace autodoc
65cdf0e10cSrcweir 
66cdf0e10cSrcweir 
67cdf0e10cSrcweir #endif
68cdf0e10cSrcweir 
69