external/bsd/atf/dist/atf-c++/expand.hpp

   1 //
   2 // Automated Testing Framework (atf)
   3 //
   4 // Copyright (c) 2007, 2008 The NetBSD Foundation, Inc.
   5 // All rights reserved.
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 // 1. Redistributions of source code must retain the above copyright
  11 //    notice, this list of conditions and the following disclaimer.
  12 // 2. Redistributions in binary form must reproduce the above copyright
  13 //    notice, this list of conditions and the following disclaimer in the
  14 //    documentation and/or other materials provided with the distribution.
  15 //
  16 // THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  17 // CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18 // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 // IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 // GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 // IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27 // IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 //
  29
  30 #if !defined(_ATF_CXX_EXPAND_HPP_)
  31 #define _ATF_CXX_EXPAND_HPP_
  32
  33 #include <stdexcept>
  34 #include <string>
  35 #include <vector>
  36
  37 #include <atf-c++/utils.hpp>
  38
  39 namespace atf {
  40 namespace expand {
  41
  42 // ------------------------------------------------------------------------
  43 // The "pattern_error" class.
  44 // ------------------------------------------------------------------------
  45
  46 //!
  47 //! \brief An error class to hold information about bad patterns.
  48 //!
  49 //! The pattern_error class is used to represent an error when parsing
  50 //! or comparing a pattern against a string.
  51 //!
  52 class pattern_error : public std::runtime_error {
  53     struct shared_data {
  54         //!
  55         //! \brief Number of live references to this shared_data.
  56         //!
  57         size_t m_refs;
  58
  59         //!
  60         //! \brief A pointer to the error message.
  61         //!
  62         //! This variable holds a pointer to the error message describing
  63         //! why the pattern failed.  This is a pointer to dynamic memory
  64         //! allocated by the code that constructed this class.
  65         //!
  66         char *m_what;
  67     };
  68     mutable shared_data* m_sd;
  69
  70     //!
  71     //! \brief Assignment operator for pattern_error.
  72     //!
  73     //! This assignment operator is made private to prevent its usage.
  74     //! We cannot modify the parent's message once constructed, so we
  75     //! cannot safely implement this method.
  76     //!
  77     pattern_error& operator=(const pattern_error&);
  78
  79 public:
  80     //!
  81     //! \brief Constructs a new pattern_error.
  82     //!
  83     //! Constructs a new pattern error, to be thrown as an exception,
  84     //! with the given error message.  The error message must be a
  85     //! pointer to dynamically allocated memory, obtained by using the
  86     //! 'new char[...]' construction.
  87     //!
  88     pattern_error(atf::utils::auto_array< char >&);
  89
  90     //!
  91     //! \brief Copy-constructor for pattern_error.
  92     //!
  93     pattern_error(const pattern_error&);
  94
  95     //!
  96     //! \brief Destroys the pattern_error.
  97     //!
  98     //! Destroys the object and releases the memory that was held by the
  99     //! error message given during construction.
 100     //!
 101     ~pattern_error(void) throw();
 102 };
 103
 104 // ------------------------------------------------------------------------
 105 // Free functions.
 106 // ------------------------------------------------------------------------
 107
 108 //!
 109 //! \brief Expands a glob pattern among multiple candidates.
 110 //!
 111 //! Given a glob pattern and a set of candidate strings, checks which of
 112 //! those strings match the glob pattern and returns them.
 113 //!
 114 template< class T >
 115 std::vector< std::string > expand_glob(const std::string& glob,
 116                                        const T& candidates)
 117 {
 118     std::vector< std::string > exps;
 119
 120     for (typename T::const_iterator iter = candidates.begin();
 121          iter != candidates.end(); iter++)
 122         if (matches_glob(glob, *iter))
 123             exps.push_back(*iter);
 124
 125     return exps;
 126 }
 127
 128 //!
 129 //! \brief Checks if the given string is a glob pattern.
 130 //!
 131 //! Returns true if the given string is a glob pattern; i.e. if it contains
 132 //! any character that will be expanded by expand_glob.
 133 //!
 134 bool is_glob(const std::string&);
 135
 136 //!
 137 //! \brief Checks if a given string matches a glob pattern.
 138 //!
 139 //! Given a glob pattern and a string, checks whether the former matches
 140 //! the latter.  Returns a boolean indicating this condition.
 141 //!
 142 bool matches_glob(const std::string&, const std::string&);
 143
 144 } // namespace expand
 145 } // namespace atf
 146
 147 #endif // !defined(_ATF_CXX_EXPAND_HPP_)