Changeset 247767 in webkit

Timestamp:

Jul 23, 2019 9:29:14 PM (5 years ago)

Author:

keith_miller@apple.com

Message:

Add cheat sheet comment for HashMap/Set iterator/AddResult
​https://bugs.webkit.org/show_bug.cgi?id=200061

Reviewed by Saam Barati.

• wtf/HashMap.h:
• wtf/HashSet.h:

Location:

trunk/Source/WTF

Files:

• ChangeLog (modified) (1 diff)
• wtf/HashMap.h (modified) (2 diffs)
• wtf/HashSet.h (modified) (1 diff)

trunk/Source/WTF/ChangeLog

@@ +1 @@
+2019-07-23  Keith Miller  <keith_miller@apple.com>
+
+        Add cheat sheet comment for HashMap/Set iterator/AddResult
+        https://bugs.webkit.org/show_bug.cgi?id=200061
+
+        Reviewed by Saam Barati.
+
+        * wtf/HashMap.h:
+        * wtf/HashSet.h:
+
 2019-07-23  Keith Rollin  <krollin@apple.com>
 

trunk/Source/WTF/wtf/HashMap.h

@@ -66 +66 @@
 
 public:
+    /*
+     * Since figuring out the entries of an iterator is confusing, here is a cheat sheet:
+     * const KeyType& key = iterator->key;
+     * ValueType& value = iterator->value;
+     */
     using iterator = HashTableIteratorAdapter<HashTableType, KeyValuePairType>;
     using const_iterator = HashTableConstIteratorAdapter<HashTableType, KeyValuePairType>;
@@ -74 +79 @@
     using ValuesConstIteratorRange = SizedIteratorRange<HashMap, typename const_iterator::Values>;
 
+    /*
+     * Since figuring out the entries of an AddResult is confusing, here is a cheat sheet:
+     * iterator iter = addResult.iterator;
+     * bool isNewEntry = addResult.isNewEntry;
+     */
     using AddResult = typename HashTableType::AddResult;
 

trunk/Source/WTF/wtf/HashSet.h

@@ -46 +46 @@
 
 public:
+    /*
+     * Since figuring out the entries of an iterator is confusing, here is a cheat sheet:
+     * const KeyType& key = iterator->key;
+     */
     typedef HashTableConstIteratorAdapter<HashTableType, ValueType> iterator;
     typedef HashTableConstIteratorAdapter<HashTableType, ValueType> const_iterator;
+
+    /*
+     * Since figuring out the entries of an AddResult is confusing, here is a cheat sheet:
+     * iterator iter = addResult.iterator;
+     * bool isNewEntry = addResult.isNewEntry;
+     */
     typedef typename HashTableType::AddResult AddResult;