1 // Copyright (C) 2019 Google LLC 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 #ifndef ICING_INDEX_TERM_PROPERTY_ID_H_ 16 #define ICING_INDEX_TERM_PROPERTY_ID_H_ 17 18 #include <cstdint> 19 20 #include "icing/legacy/index/icing-dynamic-trie.h" 21 #include "icing/store/namespace-id.h" 22 23 namespace icing { 24 namespace lib { 25 26 // A property in IcingDynamicTrie represents some attribute of the terms, e.g. 27 // whether the terms have prefix hit sections. A property id is something 28 // defined by the index to keep track of what properties the terms have. This 29 // class provides functions to get all the property ids we use in the index 30 // lexicon. 31 32 // Returns the id of term property 'HasPrefixHits'. 33 uint32_t GetHasHitsInPrefixSectionPropertyId(); 34 35 // Returns the id of term property 'HasNoExactHits'. 36 uint32_t GetHasNoExactHitsPropertyId(); 37 38 // Returns the id of term property 'HasNamespaceX'. We have one property id for 39 // each namespace id. 40 // TODO(b/153091745): This approach requires one property bitmap per namespace 41 // id, which doesn't scale well. Try to optimize the space usage. 42 uint32_t GetNamespacePropertyId(NamespaceId namespace_id); 43 44 } // namespace lib 45 } // namespace icing 46 47 #endif // ICING_INDEX_TERM_PROPERTY_ID_H_ 48