xref: /aoo42x/main/autodoc/inc/autodoc/filecoli.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 ADC_PARSER_FILECOLI_HXX
29 #define ADC_PARSER_FILECOLI_HXX
30 
31 
32 namespace autodoc
33 {
34 
35 class FileCollector_Ifc
36 {
37   public:
38     // TYPES
39 	typedef StringVector::const_iterator const_iterator;
40 
41 	enum E_SearchMode
42 	{
43 		flat,
44 		recursive
45 	};
46 
47     // LIFECYCLE
48     virtual             ~FileCollector_Ifc() {}
49 
50     // OPERATIONS
51 	virtual uintt       AddFilesFrom(
52 							const char *		i_sRootDir,
53 							const char *		i_sFilter,
54 							E_SearchMode		i_eSearchMode ) = 0;
55 	virtual uintt       AddFile(
56 							const char *		i_sFilePath ) = 0;
57 	virtual void        EraseAll() = 0;
58 
59     // INQUIRY
60 	virtual const_iterator
61                         Begin() const = 0;
62 	virtual const_iterator
63                         End() const = 0;
64 	virtual uintt       Size() const = 0;
65 };
66 
67 
68 } // namespace autodoc
69 
70 
71 #endif
72 
73