1/* Portable <regex.h>.
2   Copyright (C) 2000-2023 Free Software Foundation, Inc.
3
4   This file is part of GDB.
5
6   This program is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 3 of the License, or
9   (at your option) any later version.
10
11   This program is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19#ifndef GDB_REGEX_H
20#define GDB_REGEX_H 1
21
22# include "xregex.h"
23
24/* A compiled regex.  This is mainly a wrapper around regex_t.  The
25   the constructor throws on regcomp error and the destructor is
26   responsible for calling regfree.  The former means that it's not
27   possible to create an instance of compiled_regex that isn't
28   compiled, hence the name.  */
29class compiled_regex
30{
31public:
32  /* Compile a regexp and throw an exception on error, including
33     MESSAGE.  REGEX and MESSAGE must not be NULL.  */
34  compiled_regex (const char *regex, int cflags,
35		  const char *message)
36    ATTRIBUTE_NONNULL (2) ATTRIBUTE_NONNULL (4);
37
38  ~compiled_regex ();
39
40  DISABLE_COPY_AND_ASSIGN (compiled_regex);
41
42  /* Wrapper around ::regexec.  */
43  int exec (const char *string,
44	    size_t nmatch, regmatch_t pmatch[],
45	    int eflags) const;
46
47  /* Wrapper around ::re_search.  (Not const because re_search's
48     regex_t parameter isn't either.)  */
49  int search (const char *string, int size, int startpos,
50	      int range, struct re_registers *regs);
51
52private:
53  /* The compiled pattern.  */
54  regex_t m_pattern;
55};
56
57#endif /* not GDB_REGEX_H */
58