00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */ 00002 00003 /* 00004 * Copyright (c) 2006, 2007 Ciaran McCreesh 00005 * 00006 * This file is part of the Paludis package manager. Paludis is free software; 00007 * you can redistribute it and/or modify it under the terms of the GNU General 00008 * Public License version 2, as published by the Free Software Foundation. 00009 * 00010 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY 00011 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00012 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 00013 * details. 00014 * 00015 * You should have received a copy of the GNU General Public License along with 00016 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple 00017 * Place, Suite 330, Boston, MA 02111-1307 USA 00018 */ 00019 00020 #ifndef PALUDIS_GUARD_PALUDIS_IS_FILE_WITH_EXTENSION_HH 00021 #define PALUDIS_GUARD_PALUDIS_IS_FILE_WITH_EXTENSION_HH 1 00022 00023 #include <paludis/util/fs_entry.hh> 00024 #include <paludis/util/options.hh> 00025 #include <functional> 00026 #include <string> 00027 00028 /** \file 00029 * Declarations for the is_file_with_extension function. 00030 * 00031 * \ingroup g_fs 00032 * 00033 * \section Examples 00034 * 00035 * - None at this time. 00036 */ 00037 00038 namespace paludis 00039 { 00040 00041 #include <paludis/util/is_file_with_extension-se.hh> 00042 00043 /** 00044 * Options for is_file_with_prefix_extension() and is_file_with_extension(). 00045 * 00046 * \see IsFileWithOption 00047 * \see is_file_with_prefix_extension 00048 * \see is_file_with_extension 00049 * \ingroup g_fs 00050 */ 00051 typedef Options<IsFileWithOption> IsFileWithOptions; 00052 00053 /** 00054 * Return whether an FSEntry is a file with a given extension. 00055 * 00056 * \see is_file_with_prefix_extension() 00057 * 00058 * \ingroup g_fs 00059 */ 00060 bool is_file_with_extension(const FSEntry &, const std::string &, const IsFileWithOptions &) PALUDIS_VISIBLE; 00061 00062 /** 00063 * Return whether an FSEntry is a file with a given prefix and a given 00064 * extension prefix. 00065 * 00066 * \see is_file_with_extension() 00067 * 00068 * \ingroup g_fs 00069 */ 00070 bool is_file_with_prefix_extension(const FSEntry &, const std::string &, const std::string &, const IsFileWithOptions &) PALUDIS_VISIBLE; 00071 } 00072 00073 #endif