Repo created

libs/indexer/categories_index.hpp

@@ -0,0 +1,71 @@
+#pragma once
+
+#include "categories_holder.hpp"
+
+#include "base/mem_trie.hpp"
+
+#include <string>
+#include <vector>
+
+namespace indexer
+{
+// This class is used to simplify searches of categories by
+// synonyms to their names (in various languages).
+// An example usage is helping a user who is trying to add
+// a new feature with our editor.
+// All category data is taken from data/categories.txt.
+// All types returned are those from classificator.
+class CategoriesIndex
+{
+  DISALLOW_COPY(CategoriesIndex);
+
+public:
+  using Category = CategoriesHolder::Category;
+
+  CategoriesIndex() : m_catHolder(&GetDefaultCategories()) {}
+
+  explicit CategoriesIndex(CategoriesHolder const & catHolder) : m_catHolder(&catHolder) {}
+
+  CategoriesIndex(CategoriesIndex &&) = default;
+  CategoriesIndex & operator=(CategoriesIndex &&) = default;
+
+  // Adds all categories that match |type|. Only synonyms
+  // in language |lang| are added. See indexer/categories_holder.cpp
+  // for language enumeration.
+  void AddCategoryByTypeAndLang(uint32_t type, int8_t lang);
+
+  // Adds all categories that match |type|. All known synonyms
+  // are added.
+  void AddCategoryByTypeAllLangs(uint32_t type);
+
+  // Adds all categories from data/classificator.txt. Only
+  // names in language |lang| are added.
+  void AddAllCategoriesInLang(int8_t lang);
+
+  // Adds all categories from data/classificator.txt.
+  void AddAllCategoriesInAllLangs();
+
+  // Returns all categories that have |query| as a substring. Note
+  // that all synonyms for a category are contained in a returned
+  // value even if only one language was used when adding this
+  // category's name to index.
+  // Beware weird results when query is a malformed UTF-8 string.
+  void GetCategories(std::string const & query, std::vector<Category> & result) const;
+
+  // Returns all types that match to categories that have |query| as substring.
+  // Beware weird results when query is a malformed UTF-8 string.
+  // Note: no types are returned if the query is empty.
+  void GetAssociatedTypes(std::string const & query, std::vector<uint32_t> & result) const;
+
+#ifdef DEBUG
+  inline size_t GetNumTrieNodes() const { return m_trie.GetNumNodes(); }
+#endif
+
+private:
+  // There is a raw pointer instead of const reference
+  // here because this class may be used from Objectvie-C
+  // so a default constructor is needed.
+  CategoriesHolder const * m_catHolder = nullptr;
+  base::MemTrie<std::string, base::VectorValues<uint32_t>> m_trie;
+};
+}  // namespace indexer