diff options
| author | Tom Tromey <tom@tromey.com> | 2022-04-16 13:58:34 -0600 |
|---|---|---|
| committer | Tom Tromey <tom@tromey.com> | 2022-04-16 13:58:34 -0600 |
| commit | 3c8184c43d179e03473805f4f82cbbb3eba751f4 (patch) | |
| tree | 8e2e2837b89afa6a49d18ed43ae2ac88795c70b9 | |
| parent | 3beda815bdd784aa51255fab86dd505dae460bd1 (diff) | |
| download | gdb-3c8184c43d179e03473805f4f82cbbb3eba751f4.zip gdb-3c8184c43d179e03473805f4f82cbbb3eba751f4.tar.gz gdb-3c8184c43d179e03473805f4f82cbbb3eba751f4.tar.bz2 | |
Add comments to dwarf2/abbrev-cache.h
This patch started when I noticed that the unordered_set include
wasn't needed in abbrev-cache.h. (That was probably leftover from
some earlier implementation of the class.) Then, I noticed that the
class itself was under-commented. This patch fixes both issues.
| -rw-r--r-- | gdb/dwarf2/abbrev-cache.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/gdb/dwarf2/abbrev-cache.h b/gdb/dwarf2/abbrev-cache.h index 7af28cd..d729eb9 100644 --- a/gdb/dwarf2/abbrev-cache.h +++ b/gdb/dwarf2/abbrev-cache.h @@ -21,15 +21,18 @@ #define GDB_DWARF2_ABBREV_CACHE_H #include "dwarf2/abbrev.h" -#include <unordered_set> #include "gdbtypes.h" +/* An abbrev cache holds abbrev tables for easier reuse. */ class abbrev_cache { public: abbrev_cache (); DISABLE_COPY_AND_ASSIGN (abbrev_cache); + /* Find an abbrev table coming from the abbrev section SECTION at + offset OFFSET. Return the table, or nullptr if it has not yet + been registered. */ abbrev_table *find (struct dwarf2_section_info *section, sect_offset offset) { search_key key = { section, offset }; @@ -38,6 +41,11 @@ public: to_underlying (offset)); } + /* Add TABLE to this cache. Ownership of TABLE is transferred to + the cache. Note that a table at a given section+offset may only + be registered once -- a violation of this will cause an assert. + To avoid this, call the 'find' method first, to see if the table + has already been read. */ void add (abbrev_table_up table); private: |