paludis  Version 2.6.0
is_file_with_extension.hh
Go to the documentation of this file.
1 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
2 
3 /*
4  * Copyright (c) 2006, 2007, 2010 Ciaran McCreesh
5  *
6  * This file is part of the Paludis package manager. Paludis is free software;
7  * you can redistribute it and/or modify it under the terms of the GNU General
8  * Public License version 2, as published by the Free Software Foundation.
9  *
10  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU General Public License along with
16  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
17  * Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 
20 #ifndef PALUDIS_GUARD_PALUDIS_IS_FILE_WITH_EXTENSION_HH
21 #define PALUDIS_GUARD_PALUDIS_IS_FILE_WITH_EXTENSION_HH 1
22 
23 #include <paludis/util/fs_path-fwd.hh>
27 #include <functional>
28 #include <string>
29 
30 /** \file
31  * Declarations for the is_file_with_extension function.
32  *
33  * \ingroup g_fs
34  *
35  * \section Examples
36  *
37  * - None at this time.
38  */
39 
40 namespace paludis
41 {
42 
43 #include <paludis/util/is_file_with_extension-se.hh>
44 
45  /**
46  * Options for is_file_with_prefix_extension() and is_file_with_extension().
47  *
48  * \see IsFileWithOption
49  * \see is_file_with_prefix_extension
50  * \see is_file_with_extension
51  * \ingroup g_fs
52  */
54 
55  /**
56  * Return whether an FSPath is a file with a given extension.
57  *
58  * \see is_file_with_prefix_extension()
59  *
60  * \ingroup g_fs
61  */
62  bool is_file_with_extension(const FSPath &, const std::string &, const IsFileWithOptions &) PALUDIS_VISIBLE;
63 
64  /**
65  * Return whether an FSPath is a file with a given prefix and a given
66  * extension prefix.
67  *
68  * \see is_file_with_extension()
69  *
70  * \ingroup g_fs
71  */
72  bool is_file_with_prefix_extension(const FSPath &, const std::string &, const std::string &, const IsFileWithOptions &) PALUDIS_VISIBLE;
73 }
74 
75 #endif
Definition: about_metadata-fwd.hh:23
STL namespace.
bool is_file_with_extension(const FSPath &, const std::string &, const IsFileWithOptions &) PALUDIS_VISIBLE
bool is_file_with_prefix_extension(const FSPath &, const std::string &, const std::string &, const IsFileWithOptions &) PALUDIS_VISIBLE
Definition: options-fwd.hh:34
Definition: fs_path.hh:33
Options< IsFileWithOption > IsFileWithOptions
Definition: is_file_with_extension.hh:53
#define PALUDIS_VISIBLE
Definition: attributes.hh:59