1// Copyright 2014 The Kyua Authors.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8// * Redistributions of source code must retain the above copyright
9//   notice, this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above copyright
11//   notice, this list of conditions and the following disclaimer in the
12//   documentation and/or other materials provided with the distribution.
13// * Neither the name of Google Inc. nor the names of its contributors
14//   may be used to endorse or promote products derived from this software
15//   without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29/// \file utils/text/regex.hpp
30/// Utilities to build and match regular expressions.
31
32#if !defined(UTILS_TEXT_REGEX_HPP)
33#define UTILS_TEXT_REGEX_HPP
34
35#include "utils/text/regex_fwd.hpp"
36
37#include <cstddef>
38#include <memory>
39
40
41namespace utils {
42namespace text {
43
44
45/// Container for regex match results.
46class regex_matches {
47    struct impl;
48
49    /// Pointer to shared implementation.
50    std::shared_ptr< impl > _pimpl;
51
52    friend class regex;
53    regex_matches(std::shared_ptr< impl >);
54
55public:
56    ~regex_matches(void);
57
58    std::size_t count(void) const;
59    std::string get(const std::size_t) const;
60
61    operator bool(void) const;
62};
63
64
65/// Regular expression compiler and executor.
66///
67/// All regular expressions handled by this class are "extended".
68class regex {
69    struct impl;
70
71    /// Pointer to shared implementation.
72    std::shared_ptr< impl > _pimpl;
73
74    regex(std::shared_ptr< impl >);
75
76public:
77    ~regex(void);
78
79    static regex compile(const std::string&, const std::size_t,
80                         const bool = false);
81    regex_matches match(const std::string&) const;
82};
83
84
85regex_matches match_regex(const std::string&, const std::string&,
86                          const std::size_t, const bool = false);
87
88
89}  // namespace text
90}  // namespace utils
91
92#endif  // !defined(UTILS_TEXT_REGEX_HPP)
93