[nfc][AppleTables] Rename iterator

[fdeazeve]

Summary

We will soon need different kinds of iterators

llvm/include/llvm/DebugInfo/DWARF/DWARFAcceleratorTable.h

public:
     /// contains such Atom.
     std::optional<DWARFFormValue> lookup(HeaderData::AtomType Atom) const;
 
     friend class AppleAcceleratorTable;
     friend class ValueIterator;
   };
 
   /// An iterator for Entries all having the same string as key.
-  class ValueIterator {
+  class SameNameIterator
+      : public iterator_facade_base<SameNameIterator, std::forward_iterator_tag,
+                                    Entry> {
     Entry Current;
     uint64_t Offset = 0;
 
-    void Next() { Offset += Current.Table.getHashDataEntryLength(); }
-
   public:
     /// Construct a new iterator for the entries at \p DataOffset.
-    ValueIterator(const AppleAcceleratorTable &AccelTable, uint64_t DataOffset);
+    SameNameIterator(const AppleAcceleratorTable &AccelTable,
+                     uint64_t DataOffset);
 
     const Entry &operator*() {
       uint64_t OffsetCopy = Offset;
       Current.extract(&OffsetCopy);
       return Current;
     }
-    ValueIterator &operator++() { Next(); return *this; }
-    friend bool operator==(const ValueIterator &A, const ValueIterator &B) {
-      return A.Offset == B.Offset;
+    SameNameIterator &operator++() {
+      Offset += Current.Table.getHashDataEntryLength();
+      return *this;
     }
-    friend bool operator!=(const ValueIterator &A, const ValueIterator &B) {
-      return !(A == B);
+    friend bool operator==(const SameNameIterator &A,
+                           const SameNameIterator &B) {
+      return A.Offset == B.Offset;
     }
   };
 
   AppleAcceleratorTable(const DWARFDataExtractor &AccelSection,
                         DataExtractor StringSection)
       : DWARFAcceleratorTable(AccelSection, StringSection) {}
 
   Error extract() override;
public:
   /// \returns <DieOffset, DieTag>
   /// DieOffset is the offset into the .debug_info section for the DIE
   /// related to the input hash data offset.
   /// DieTag is the tag of the DIE
   std::pair<uint64_t, dwarf::Tag> readAtoms(uint64_t *HashDataOffset);
   void dump(raw_ostream &OS) const override;
 
   /// Look up all entries in the accelerator table matching \c Key.
-  iterator_range<ValueIterator> equal_range(StringRef Key) const;
+  iterator_range<SameNameIterator> equal_range(StringRef Key) const;
 };
 
 /// .debug_names section consists of one or more units. Each unit starts with a
 /// header, which is followed by a list of compilation units, local and foreign
 /// type units.
 ///
 /// These may be followed by an (optional) hash lookup table, which consists of
 /// an array of buckets and hashes similar to the apple tables above. The only

llvm/lib/DebugInfo/DWARF/DWARFAcceleratorTable.cpp

std::optional<dwarf::Tag> AppleAcceleratorTable::Entry::getTag() const {
   std::optional<DWARFFormValue> Tag = lookup(dwarf::DW_ATOM_die_tag);
   if (!Tag)
     return std::nullopt;
   if (std::optional<uint64_t> Value = Tag->getAsUnsignedConstant())
     return dwarf::Tag(*Value);
   return std::nullopt;
 }
 
-AppleAcceleratorTable::ValueIterator::ValueIterator(
+AppleAcceleratorTable::SameNameIterator::SameNameIterator(
     const AppleAcceleratorTable &AccelTable, uint64_t DataOffset)
-    : Current(AccelTable), Offset(DataOffset) {
-}
+    : Current(AccelTable), Offset(DataOffset) {}
 
-iterator_range<AppleAcceleratorTable::ValueIterator>
+iterator_range<AppleAcceleratorTable::SameNameIterator>
 AppleAcceleratorTable::equal_range(StringRef Key) const {
   const auto EmptyRange =
-      make_range(ValueIterator(*this, 0), ValueIterator(*this, 0));
+      make_range(SameNameIterator(*this, 0), SameNameIterator(*this, 0));
   if (!IsValid)
     return EmptyRange;
 
   // Find the bucket.
   uint32_t SearchHash = djbHash(Key);
   uint32_t BucketIdx = hashToBucketIdx(SearchHash);
   std::optional<uint32_t> HashIdx = idxOfHashInBucket(SearchHash, BucketIdx);
   if (!HashIdx)
AppleAcceleratorTable::equal_range(StringRef Key) const {
   // Valid input and still have strings in this hash.
   while (StrOffset && *StrOffset) {
     std::optional<StringRef> MaybeStr = readStringFromStrSection(*StrOffset);
     std::optional<uint32_t> NumEntries = this->readU32FromAccel(DataOffset);
     if (!MaybeStr || !NumEntries)
       return EmptyRange;
     uint64_t EndOffset = DataOffset + *NumEntries * getHashDataEntryLength();
     if (Key == *MaybeStr)
-      return make_range({*this, DataOffset}, ValueIterator{*this, EndOffset});
+      return make_range({*this, DataOffset},
+                        SameNameIterator{*this, EndOffset});
     DataOffset = EndOffset;
     StrOffset = readStringOffsetAt(DataOffset);
   }
 
   return EmptyRange;
 }
 
 std::optional<uint32_t>