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