xref: /netbsd-src/external/bsd/atf/dist/tools/expand.hpp (revision d780102efefa02003390cc43ea410dbd0ebb4a85)
1 //
2 // Automated Testing Framework (atf)
3 //
4 // Copyright (c) 2007 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(TOOLS_EXPAND_HPP)
31 #define TOOLS_EXPAND_HPP
32 
33 #include <string>
34 #include <vector>
35 
36 namespace tools {
37 namespace expand {
38 
39 // ------------------------------------------------------------------------
40 // Free functions.
41 // ------------------------------------------------------------------------
42 
43 //!
44 //! \brief Checks if the given string is a glob pattern.
45 //!
46 //! Returns true if the given string is a glob pattern; i.e. if it contains
47 //! any character that will be expanded by expand_glob.
48 //!
49 bool is_glob(const std::string&);
50 
51 //!
52 //! \brief Checks if a given string matches a glob pattern.
53 //!
54 //! Given a glob pattern and a string, checks whether the former matches
55 //! the latter.  Returns a boolean indicating this condition.
56 //!
57 bool matches_glob(const std::string&, const std::string&);
58 
59 //!
60 //! \brief Expands a glob pattern among multiple candidates.
61 //!
62 //! Given a glob pattern and a set of candidate strings, checks which of
63 //! those strings match the glob pattern and returns them.
64 //!
65 template< class T >
expand_glob(const std::string & glob,const T & candidates)66 std::vector< std::string > expand_glob(const std::string& glob,
67                                        const T& candidates)
68 {
69     std::vector< std::string > exps;
70 
71     for (typename T::const_iterator iter = candidates.begin();
72          iter != candidates.end(); iter++)
73         if (matches_glob(glob, *iter))
74             exps.push_back(*iter);
75 
76     return exps;
77 }
78 
79 } // namespace expand
80 } // namespace tools
81 
82 #endif // !defined(TOOLS_EXPAND_HPP)
83