sim/igen/filter.h

   1 /* The IGEN simulator generator for GDB, the GNU Debugger.
   2
   3    Copyright 2002-2023 Free Software Foundation, Inc.
   4
   5    Contributed by Andrew Cagney.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22
  23 /* NB, an empty filter is NULL */
  24 typedef struct _filter filter;
  25
  26
  27 /* parse the list merging any flags into the filter */
  28
  29 extern void filter_parse (filter **filters, const char *filt);
  30
  31
  32 /* add the second filter to the first */
  33
  34 extern void filter_add (filter **filters, const filter *add);
  35
  36
  37
  38 /* returns true if SUB is a strict subset of SUPER.  For an empty set
  39    is a member of any set */
  40
  41 extern int filter_is_subset (const filter *superset, const filter *subset);
  42
  43
  44 /* return true if there is at least one member common to the two
  45    filters */
  46
  47 extern int filter_is_common (const filter *l, const filter *r);
  48
  49
  50 /* returns the index (pos + 1) if the name is in the filter.  */
  51
  52 extern int filter_is_member (const filter *set, const char *flag);
  53
  54
  55 /* returns true if one of the flags is not present in the filter.
  56    === !filter_is_subset (filter_parse (NULL, flags), filters) */
  57 int is_filtered_out (const filter *filters, const char *flags);
  58
  59
  60 /* returns the next member of the filter set that follows MEMBER.
  61    Member does not need to be an elememt of the filter set.  Next of
  62    "" is the first non-empty member */
  63 const char *filter_next (const filter *set, const char *member);
  64
  65
  66
  67 /* for debugging */
  68
  69 extern void dump_filter
  70   (lf *file, const char *prefix, const filter *filt, const char *suffix);