gdb/filename-seen-cache.h

   1 /* Filename-seen cache for the GNU debugger, GDB.
   2
   3    Copyright (C) 1986-2024 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GDB_FILENAME_SEEN_CACHE_H
  21 #define GDB_FILENAME_SEEN_CACHE_H
  22
  23 #include "gdbsupport/unordered_set.h"
  24 #include "filenames.h"
  25
  26 /* Cache to watch for file names already seen.  */
  27
  28 class filename_seen_cache
  29 {
  30 public:
  31   filename_seen_cache () = default;
  32
  33   DISABLE_COPY_AND_ASSIGN (filename_seen_cache);
  34
  35   /* Empty the cache.  */
  36   void clear ()
  37   { m_tab.clear (); }
  38
  39   /* If FILE is not already in the table of files of the cache, add it and
  40      return false; otherwise return true.
  41
  42      NOTE: We don't manage space for FILE, we assume FILE lives as
  43      long as the caller needs.  */
  44   bool seen (const char *file)
  45   { return !m_tab.insert (file).second; }
  46
  47 private:
  48   struct hash
  49   {
  50     std::size_t operator() (const char *s) const noexcept
  51     { return filename_hash (s); }
  52   };
  53
  54   struct eq
  55   {
  56     bool operator() (const char *lhs, const char *rhs) const noexcept
  57     { return filename_eq (lhs, rhs); }
  58   };
  59
  60   /* Table of files seen so far.  */
  61   gdb::unordered_set<const char *, hash, eq> m_tab;
  62 };
  63
  64 #endif /* GDB_FILENAME_SEEN_CACHE_H */