xref: /aosp_15_r20/art/libdexfile/dex/class_iterator.h (revision 795d594fd825385562da6b089ea9b2033f3abf5a)
1*795d594fSAndroid Build Coastguard Worker /*
2*795d594fSAndroid Build Coastguard Worker  * Copyright (C) 2018 The Android Open Source Project
3*795d594fSAndroid Build Coastguard Worker  *
4*795d594fSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*795d594fSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*795d594fSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*795d594fSAndroid Build Coastguard Worker  *
8*795d594fSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*795d594fSAndroid Build Coastguard Worker  *
10*795d594fSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*795d594fSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*795d594fSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*795d594fSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*795d594fSAndroid Build Coastguard Worker  * limitations under the License.
15*795d594fSAndroid Build Coastguard Worker  */
16*795d594fSAndroid Build Coastguard Worker 
17*795d594fSAndroid Build Coastguard Worker #ifndef ART_LIBDEXFILE_DEX_CLASS_ITERATOR_H_
18*795d594fSAndroid Build Coastguard Worker #define ART_LIBDEXFILE_DEX_CLASS_ITERATOR_H_
19*795d594fSAndroid Build Coastguard Worker 
20*795d594fSAndroid Build Coastguard Worker #include <android-base/logging.h>
21*795d594fSAndroid Build Coastguard Worker 
22*795d594fSAndroid Build Coastguard Worker namespace art {
23*795d594fSAndroid Build Coastguard Worker 
24*795d594fSAndroid Build Coastguard Worker class ClassAccessor;
25*795d594fSAndroid Build Coastguard Worker class ClassIterator;
26*795d594fSAndroid Build Coastguard Worker class DexFile;
27*795d594fSAndroid Build Coastguard Worker 
28*795d594fSAndroid Build Coastguard Worker // Holder class, used to construct ClassAccessors.
29*795d594fSAndroid Build Coastguard Worker class ClassIteratorData {
30*795d594fSAndroid Build Coastguard Worker  public:
ClassIteratorData(const DexFile & dex_file,uint32_t class_def_idx)31*795d594fSAndroid Build Coastguard Worker   ClassIteratorData(const DexFile& dex_file, uint32_t class_def_idx)
32*795d594fSAndroid Build Coastguard Worker       : dex_file_(dex_file),
33*795d594fSAndroid Build Coastguard Worker         class_def_idx_(class_def_idx) {}
34*795d594fSAndroid Build Coastguard Worker 
35*795d594fSAndroid Build Coastguard Worker  private:
36*795d594fSAndroid Build Coastguard Worker   const DexFile& dex_file_;
37*795d594fSAndroid Build Coastguard Worker   uint32_t class_def_idx_ = 0u;
38*795d594fSAndroid Build Coastguard Worker 
39*795d594fSAndroid Build Coastguard Worker   friend class ClassAccessor;
40*795d594fSAndroid Build Coastguard Worker   friend class ClassIterator;
41*795d594fSAndroid Build Coastguard Worker };
42*795d594fSAndroid Build Coastguard Worker 
43*795d594fSAndroid Build Coastguard Worker // Iterator for visiting classes in a Dex file.
44*795d594fSAndroid Build Coastguard Worker class ClassIterator {
45*795d594fSAndroid Build Coastguard Worker  public:
46*795d594fSAndroid Build Coastguard Worker   using iterator_category = std::forward_iterator_tag;
47*795d594fSAndroid Build Coastguard Worker   using value_type = ClassIteratorData;
48*795d594fSAndroid Build Coastguard Worker   using difference_type = ptrdiff_t;
49*795d594fSAndroid Build Coastguard Worker   using pointer = void;
50*795d594fSAndroid Build Coastguard Worker   using reference = void;
51*795d594fSAndroid Build Coastguard Worker 
ClassIterator(const DexFile & dex_file,uint32_t class_def_idx)52*795d594fSAndroid Build Coastguard Worker   ClassIterator(const DexFile& dex_file, uint32_t class_def_idx)
53*795d594fSAndroid Build Coastguard Worker       : data_(dex_file, class_def_idx) {}
54*795d594fSAndroid Build Coastguard Worker 
55*795d594fSAndroid Build Coastguard Worker   // Value after modification.
56*795d594fSAndroid Build Coastguard Worker   ClassIterator& operator++() {
57*795d594fSAndroid Build Coastguard Worker     ++data_.class_def_idx_;
58*795d594fSAndroid Build Coastguard Worker     return *this;
59*795d594fSAndroid Build Coastguard Worker   }
60*795d594fSAndroid Build Coastguard Worker 
61*795d594fSAndroid Build Coastguard Worker   // Value before modification.
62*795d594fSAndroid Build Coastguard Worker   ClassIterator operator++(int) {
63*795d594fSAndroid Build Coastguard Worker     ClassIterator temp = *this;
64*795d594fSAndroid Build Coastguard Worker     ++*this;
65*795d594fSAndroid Build Coastguard Worker     return temp;
66*795d594fSAndroid Build Coastguard Worker   }
67*795d594fSAndroid Build Coastguard Worker 
68*795d594fSAndroid Build Coastguard Worker   const value_type& operator*() const {
69*795d594fSAndroid Build Coastguard Worker     return data_;
70*795d594fSAndroid Build Coastguard Worker   }
71*795d594fSAndroid Build Coastguard Worker 
72*795d594fSAndroid Build Coastguard Worker   bool operator==(const ClassIterator& rhs) const {
73*795d594fSAndroid Build Coastguard Worker     DCHECK_EQ(&data_.dex_file_, &rhs.data_.dex_file_) << "Comparing different dex files.";
74*795d594fSAndroid Build Coastguard Worker     return data_.class_def_idx_ == rhs.data_.class_def_idx_;
75*795d594fSAndroid Build Coastguard Worker   }
76*795d594fSAndroid Build Coastguard Worker 
77*795d594fSAndroid Build Coastguard Worker   bool operator!=(const ClassIterator& rhs) const {
78*795d594fSAndroid Build Coastguard Worker     return !(*this == rhs);
79*795d594fSAndroid Build Coastguard Worker   }
80*795d594fSAndroid Build Coastguard Worker 
81*795d594fSAndroid Build Coastguard Worker   bool operator<(const ClassIterator& rhs) const {
82*795d594fSAndroid Build Coastguard Worker     DCHECK_EQ(&data_.dex_file_, &rhs.data_.dex_file_) << "Comparing different dex files.";
83*795d594fSAndroid Build Coastguard Worker     return data_.class_def_idx_ < rhs.data_.class_def_idx_;
84*795d594fSAndroid Build Coastguard Worker   }
85*795d594fSAndroid Build Coastguard Worker 
86*795d594fSAndroid Build Coastguard Worker   bool operator>(const ClassIterator& rhs) const {
87*795d594fSAndroid Build Coastguard Worker     return rhs < *this;
88*795d594fSAndroid Build Coastguard Worker   }
89*795d594fSAndroid Build Coastguard Worker 
90*795d594fSAndroid Build Coastguard Worker   bool operator<=(const ClassIterator& rhs) const {
91*795d594fSAndroid Build Coastguard Worker     return !(rhs < *this);
92*795d594fSAndroid Build Coastguard Worker   }
93*795d594fSAndroid Build Coastguard Worker 
94*795d594fSAndroid Build Coastguard Worker   bool operator>=(const ClassIterator& rhs) const {
95*795d594fSAndroid Build Coastguard Worker     return !(*this < rhs);
96*795d594fSAndroid Build Coastguard Worker   }
97*795d594fSAndroid Build Coastguard Worker 
98*795d594fSAndroid Build Coastguard Worker  protected:
99*795d594fSAndroid Build Coastguard Worker   ClassIteratorData data_;
100*795d594fSAndroid Build Coastguard Worker };
101*795d594fSAndroid Build Coastguard Worker 
102*795d594fSAndroid Build Coastguard Worker }  // namespace art
103*795d594fSAndroid Build Coastguard Worker 
104*795d594fSAndroid Build Coastguard Worker #endif  // ART_LIBDEXFILE_DEX_CLASS_ITERATOR_H_
105