xref: /minix3/external/bsd/atf/dist/tools/expand.hpp (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1*0a6a1f1dSLionel Sambuc //
2*0a6a1f1dSLionel Sambuc // Automated Testing Framework (atf)
3*0a6a1f1dSLionel Sambuc //
4*0a6a1f1dSLionel Sambuc // Copyright (c) 2007 The NetBSD Foundation, Inc.
5*0a6a1f1dSLionel Sambuc // All rights reserved.
6*0a6a1f1dSLionel Sambuc //
7*0a6a1f1dSLionel Sambuc // Redistribution and use in source and binary forms, with or without
8*0a6a1f1dSLionel Sambuc // modification, are permitted provided that the following conditions
9*0a6a1f1dSLionel Sambuc // are met:
10*0a6a1f1dSLionel Sambuc // 1. Redistributions of source code must retain the above copyright
11*0a6a1f1dSLionel Sambuc //    notice, this list of conditions and the following disclaimer.
12*0a6a1f1dSLionel Sambuc // 2. Redistributions in binary form must reproduce the above copyright
13*0a6a1f1dSLionel Sambuc //    notice, this list of conditions and the following disclaimer in the
14*0a6a1f1dSLionel Sambuc //    documentation and/or other materials provided with the distribution.
15*0a6a1f1dSLionel Sambuc //
16*0a6a1f1dSLionel Sambuc // THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
17*0a6a1f1dSLionel Sambuc // CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
18*0a6a1f1dSLionel Sambuc // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19*0a6a1f1dSLionel Sambuc // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20*0a6a1f1dSLionel Sambuc // IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
21*0a6a1f1dSLionel Sambuc // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22*0a6a1f1dSLionel Sambuc // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23*0a6a1f1dSLionel Sambuc // GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24*0a6a1f1dSLionel Sambuc // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25*0a6a1f1dSLionel Sambuc // IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26*0a6a1f1dSLionel Sambuc // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27*0a6a1f1dSLionel Sambuc // IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*0a6a1f1dSLionel Sambuc //
29*0a6a1f1dSLionel Sambuc 
30*0a6a1f1dSLionel Sambuc #if !defined(TOOLS_EXPAND_HPP)
31*0a6a1f1dSLionel Sambuc #define TOOLS_EXPAND_HPP
32*0a6a1f1dSLionel Sambuc 
33*0a6a1f1dSLionel Sambuc #include <string>
34*0a6a1f1dSLionel Sambuc #include <vector>
35*0a6a1f1dSLionel Sambuc 
36*0a6a1f1dSLionel Sambuc namespace tools {
37*0a6a1f1dSLionel Sambuc namespace expand {
38*0a6a1f1dSLionel Sambuc 
39*0a6a1f1dSLionel Sambuc // ------------------------------------------------------------------------
40*0a6a1f1dSLionel Sambuc // Free functions.
41*0a6a1f1dSLionel Sambuc // ------------------------------------------------------------------------
42*0a6a1f1dSLionel Sambuc 
43*0a6a1f1dSLionel Sambuc //!
44*0a6a1f1dSLionel Sambuc //! \brief Checks if the given string is a glob pattern.
45*0a6a1f1dSLionel Sambuc //!
46*0a6a1f1dSLionel Sambuc //! Returns true if the given string is a glob pattern; i.e. if it contains
47*0a6a1f1dSLionel Sambuc //! any character that will be expanded by expand_glob.
48*0a6a1f1dSLionel Sambuc //!
49*0a6a1f1dSLionel Sambuc bool is_glob(const std::string&);
50*0a6a1f1dSLionel Sambuc 
51*0a6a1f1dSLionel Sambuc //!
52*0a6a1f1dSLionel Sambuc //! \brief Checks if a given string matches a glob pattern.
53*0a6a1f1dSLionel Sambuc //!
54*0a6a1f1dSLionel Sambuc //! Given a glob pattern and a string, checks whether the former matches
55*0a6a1f1dSLionel Sambuc //! the latter.  Returns a boolean indicating this condition.
56*0a6a1f1dSLionel Sambuc //!
57*0a6a1f1dSLionel Sambuc bool matches_glob(const std::string&, const std::string&);
58*0a6a1f1dSLionel Sambuc 
59*0a6a1f1dSLionel Sambuc //!
60*0a6a1f1dSLionel Sambuc //! \brief Expands a glob pattern among multiple candidates.
61*0a6a1f1dSLionel Sambuc //!
62*0a6a1f1dSLionel Sambuc //! Given a glob pattern and a set of candidate strings, checks which of
63*0a6a1f1dSLionel Sambuc //! those strings match the glob pattern and returns them.
64*0a6a1f1dSLionel Sambuc //!
65*0a6a1f1dSLionel Sambuc template< class T >
expand_glob(const std::string & glob,const T & candidates)66*0a6a1f1dSLionel Sambuc std::vector< std::string > expand_glob(const std::string& glob,
67*0a6a1f1dSLionel Sambuc                                        const T& candidates)
68*0a6a1f1dSLionel Sambuc {
69*0a6a1f1dSLionel Sambuc     std::vector< std::string > exps;
70*0a6a1f1dSLionel Sambuc 
71*0a6a1f1dSLionel Sambuc     for (typename T::const_iterator iter = candidates.begin();
72*0a6a1f1dSLionel Sambuc          iter != candidates.end(); iter++)
73*0a6a1f1dSLionel Sambuc         if (matches_glob(glob, *iter))
74*0a6a1f1dSLionel Sambuc             exps.push_back(*iter);
75*0a6a1f1dSLionel Sambuc 
76*0a6a1f1dSLionel Sambuc     return exps;
77*0a6a1f1dSLionel Sambuc }
78*0a6a1f1dSLionel Sambuc 
79*0a6a1f1dSLionel Sambuc } // namespace expand
80*0a6a1f1dSLionel Sambuc } // namespace tools
81*0a6a1f1dSLionel Sambuc 
82*0a6a1f1dSLionel Sambuc #endif // !defined(TOOLS_EXPAND_HPP)
83