You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
237 lines
9.0 KiB
237 lines
9.0 KiB
/* /////////////////////////////////////////////////////////////////////////
|
|
* File: unixstl/filesystem/functionals.hpp
|
|
*
|
|
* Purpose: A number of useful functionals .
|
|
*
|
|
* Created: 2nd November 2003
|
|
* Updated: 10th August 2009
|
|
*
|
|
* Home: http://stlsoft.org/
|
|
*
|
|
* Copyright (c) 2003-2009, Matthew Wilson and Synesis Software
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* - Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
* - Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
* - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
|
|
* any contributors may be used to endorse or promote products derived from
|
|
* this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
|
|
/** \file unixstl/filesystem/functionals.hpp
|
|
*
|
|
* \brief [C++ only] Definition of filesystem function classes, including
|
|
* unixstl::path_compare and unixstl::path_exists
|
|
* (\ref group__library__filesystem "File System" Library).
|
|
*/
|
|
|
|
#ifndef UNIXSTL_INCL_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_FUNCTIONALS
|
|
#define UNIXSTL_INCL_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_FUNCTIONALS
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
# define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_FUNCTIONALS_MAJOR 4
|
|
# define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_FUNCTIONALS_MINOR 1
|
|
# define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_FUNCTIONALS_REVISION 2
|
|
# define UNIXSTL_VER_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_FUNCTIONALS_EDIT 48
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Includes
|
|
*/
|
|
|
|
#ifndef UNIXSTL_INCL_UNIXSTL_H_UNIXSTL
|
|
# include <unixstl/unixstl.h>
|
|
#endif /* !UNIXSTL_INCL_UNIXSTL_H_UNIXSTL */
|
|
#ifndef STLSOFT_INCL_STLSOFT_SHIMS_ACCESS_HPP_STRING
|
|
# include <stlsoft/shims/access/string.hpp>
|
|
#endif /* !STLSOFT_INCL_STLSOFT_SHIMS_ACCESS_HPP_STRING */
|
|
#ifndef UNIXSTL_INCL_UNIXSTL_SHIMS_ACCESS_HPP_STRING
|
|
# include <unixstl/shims/access/string.hpp>
|
|
#endif /* !UNIXSTL_INCL_UNIXSTL_SHIMS_ACCESS_HPP_STRING */
|
|
#ifndef UNIXSTL_INCL_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS
|
|
# include <unixstl/filesystem/filesystem_traits.hpp>
|
|
#endif /* !UNIXSTL_INCL_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_TRAITS */
|
|
#ifndef UNIXSTL_INCL_UNIXSTL_FILESYSTEM_HPP_FILE_PATH_BUFFER
|
|
# include <unixstl/filesystem/file_path_buffer.hpp>
|
|
#endif /* !UNIXSTL_INCL_UNIXSTL_FILESYSTEM_HPP_FILE_PATH_BUFFER */
|
|
#ifndef _UNIXSTL_FUNCTIONALS_NO_STD
|
|
# include <functional>
|
|
#else /* ? _UNIXSTL_FUNCTIONALS_NO_STD */
|
|
# error Now need to write that std_binary_function stuff!!
|
|
#endif /* _UNIXSTL_FUNCTIONALS_NO_STD */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Namespace
|
|
*/
|
|
|
|
#ifndef _UNIXSTL_NO_NAMESPACE
|
|
# if defined(_STLSOFT_NO_NAMESPACE) || \
|
|
defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
|
|
/* There is no stlsoft namespace, so must define ::unixstl */
|
|
namespace unixstl
|
|
{
|
|
# else
|
|
/* Define stlsoft::unixstl_project */
|
|
|
|
namespace stlsoft
|
|
{
|
|
|
|
namespace unixstl_project
|
|
{
|
|
|
|
# endif /* _STLSOFT_NO_NAMESPACE */
|
|
#endif /* !_UNIXSTL_NO_NAMESPACE */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Classes
|
|
*/
|
|
|
|
/** \brief A function class that compares two file-system paths
|
|
*
|
|
* \ingroup group__library__filesystem
|
|
*/
|
|
template <ss_typename_param_k C>
|
|
// [[synesis:class:function-class:binary-predicate: path_compare<T<C>>]]
|
|
struct path_compare
|
|
: public unixstl_ns_qual_std(binary_function)<C const*, C const*, us_bool_t>
|
|
{
|
|
public:
|
|
/// \brief The character type
|
|
typedef C char_type;
|
|
private:
|
|
typedef unixstl_ns_qual_std(binary_function)<C const*, C const*, us_bool_t> parent_class_type;
|
|
public:
|
|
/// \brief The first argument type
|
|
typedef ss_typename_type_k parent_class_type::first_argument_type first_argument_type;
|
|
/// \brief The second argument type
|
|
typedef ss_typename_type_k parent_class_type::second_argument_type second_argument_type;
|
|
/// \brief The result type
|
|
typedef ss_typename_type_k parent_class_type::result_type result_type;
|
|
/// \brief The traits type
|
|
typedef filesystem_traits<C> traits_type;
|
|
/// \brief The current parameterisation of the type
|
|
typedef path_compare<C> class_type;
|
|
|
|
public:
|
|
/// \brief Function call, compares \c s1 with \c s2
|
|
///
|
|
/// \note The comparison is determined by evaluation the full-paths of both \c s1 and \c s2
|
|
#ifdef STLSOFT_CF_MEMBER_TEMPLATE_FUNCTION_SUPPORT
|
|
template <ss_typename_param_k T1, ss_typename_param_k T2>
|
|
result_type operator ()(T1 const& s1, T2 const& s2)
|
|
#else /* ? STLSOFT_CF_MEMBER_TEMPLATE_FUNCTION_SUPPORT */
|
|
result_type operator ()(first_argument_type s1, second_argument_type s2)
|
|
#endif /* STLSOFT_CF_MEMBER_TEMPLATE_FUNCTION_SUPPORT */
|
|
{
|
|
return compare_(stlsoft_ns_qual(c_str_ptr)(s1), stlsoft_ns_qual(c_str_ptr)(s2));
|
|
}
|
|
|
|
// Implementation
|
|
private:
|
|
result_type compare_(char_type const* s1, char_type const* s2)
|
|
{
|
|
basic_file_path_buffer<char_type> path1;
|
|
basic_file_path_buffer<char_type> path2;
|
|
|
|
if( !traits_type::get_full_path_name(s1, path1.size(), &path1[0]) ||
|
|
!traits_type::get_full_path_name(s2, path2.size(), &path2[0]))
|
|
{
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
traits_type::remove_dir_end(&path1[0]);
|
|
traits_type::remove_dir_end(&path2[0]);
|
|
|
|
s1 = path1.c_str();
|
|
s2 = path2.c_str();
|
|
|
|
return 0 == traits_type::str_compare(s1, s2);
|
|
}
|
|
}
|
|
};
|
|
|
|
/** \brief Predicate that indicates whether a given path exists
|
|
*
|
|
* \ingroup group__library__filesystem
|
|
*
|
|
* \note Does not expand environment variables in the argument passed to
|
|
* the function call operator
|
|
*
|
|
* \param C The character type
|
|
* \param A The argument type; defaults to C const*
|
|
*/
|
|
template< ss_typename_param_k C
|
|
, ss_typename_param_k A = C const*
|
|
>
|
|
// [[synesis:class:function-class:unary-predicate: path_exists<T<C>, T<A>>]]
|
|
struct path_exists
|
|
: public unixstl_ns_qual_std(unary_function)<A, us_bool_t>
|
|
{
|
|
private:
|
|
typedef unixstl_ns_qual_std(unary_function)<A, us_bool_t> parent_class_type;
|
|
typedef filesystem_traits<C> traits_type;
|
|
public:
|
|
/// \brief The character type
|
|
typedef C char_type;
|
|
/// \brief The argument type
|
|
typedef A argument_type;
|
|
/// \brief The current parameterisation of the type
|
|
typedef path_exists<C, A> class_type;
|
|
|
|
public:
|
|
#ifdef STLSOFT_CF_MEMBER_TEMPLATE_FUNCTION_SUPPORT
|
|
template <ss_typename_param_k S>
|
|
us_bool_t operator ()(S const& s) const
|
|
#else /* ? STLSOFT_CF_MEMBER_TEMPLATE_FUNCTION_SUPPORT */
|
|
us_bool_t operator ()(argument_type s) const
|
|
#endif /* STLSOFT_CF_MEMBER_TEMPLATE_FUNCTION_SUPPORT */
|
|
{
|
|
return traits_type::file_exists(stlsoft_ns_qual(c_str_ptr)(s));
|
|
}
|
|
};
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
// Unit-testing
|
|
|
|
#ifdef STLSOFT_UNITTEST
|
|
# include "./unittest/functionals_unittest_.h"
|
|
#endif /* STLSOFT_UNITTEST */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#ifndef _UNIXSTL_NO_NAMESPACE
|
|
# if defined(_STLSOFT_NO_NAMESPACE) || \
|
|
defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
|
|
} // namespace unixstl
|
|
# else
|
|
} // namespace unixstl_project
|
|
} // namespace stlsoft
|
|
# endif /* _STLSOFT_NO_NAMESPACE */
|
|
#endif /* !_UNIXSTL_NO_NAMESPACE */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#endif /* UNIXSTL_INCL_UNIXSTL_FILESYSTEM_HPP_FILESYSTEM_FUNCTIONALS */
|
|
|
|
/* ///////////////////////////// end of file //////////////////////////// */
|