.. _program_listing_file_include_zim_suggestion.h:

Program Listing for File suggestion.h
=====================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_zim_suggestion.h>` (``include/zim/suggestion.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /*
    * Copyright (C) 2021 Maneesh P M <manu.pm55@gmail.com>
    * Copyright (C) 2017-2021 Matthieu Gautier <mgautier@kymeria.fr>
    * Copyright (C) 2007 Tommi Maekitalo
    *
    * This program is free software; you can redistribute it and/or
    * modify it under the terms of the GNU General Public License as
    * published by the Free Software Foundation; either version 2 of the
    * License, or (at your option) any later version.
    *
    * This program is distributed in the hope that it will be useful, but
    * is provided AS IS, WITHOUT ANY WARRANTY; without even the implied
    * warranty of MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, and
    * NON-INFRINGEMENT.  See the GNU General Public License for more details.
    *
    * You should have received a copy of the GNU General Public License
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
    *
    */
   
   #ifndef ZIM_SUGGESTION_H
   #define ZIM_SUGGESTION_H
   
   #include "suggestion_iterator.h"
   #include "archive.h"
   
   #if defined(LIBZIM_WITH_XAPIAN)
   namespace Xapian {
     class Enquire;
     class MSet;
   };
   #endif
   
   namespace zim
   {
   
   class SuggestionSearcher;
   class SuggestionSearch;
   class SuggestionIterator;
   class SuggestionDataBase;
   
   class LIBZIM_API SuggestionSearcher
   {
     public:
       explicit SuggestionSearcher(const Archive& archive);
   
       SuggestionSearcher(const SuggestionSearcher& other);
       SuggestionSearcher& operator=(const SuggestionSearcher& other);
       SuggestionSearcher(SuggestionSearcher&& other);
       SuggestionSearcher& operator=(SuggestionSearcher&& other);
       ~SuggestionSearcher();
   
       SuggestionSearch suggest(const std::string& query);
   
       void setVerbose(bool verbose);
   
     private: // methods
       void initDatabase();
   
     private: // data
       std::shared_ptr<SuggestionDataBase> mp_internalDb;
       Archive m_archive;
       bool m_verbose;
   };
   
   class LIBZIM_API SuggestionSearch
   {
       public:
           SuggestionSearch(SuggestionSearch&& s);
           SuggestionSearch& operator=(SuggestionSearch&& s);
           ~SuggestionSearch();
   
           const SuggestionResultSet getResults(int start, int maxResults) const;
   
           int getEstimatedMatches() const;
   
       private: // methods
           SuggestionSearch(std::shared_ptr<SuggestionDataBase> p_internalDb, const std::string& query);
   
       private: // data
            std::shared_ptr<SuggestionDataBase> mp_internalDb;
            std::string m_query;
   
     friend class SuggestionSearcher;
   
   #ifdef ZIM_PRIVATE
       public:
           // Close Xapian db to force range based search
           const void forceRangeSuggestion();
   #endif
   
   // Xapian based methods and data
   #if defined(LIBZIM_WITH_XAPIAN)
       private: // Xapian based methods
           Xapian::Enquire& getEnquire() const;
   
       private: // Xapian based data
           mutable std::unique_ptr<Xapian::Enquire> mp_enquire;
   #endif  // LIBZIM_WITH_XAPIAN
   };
   
   class LIBZIM_API SuggestionResultSet
   {
     public: // types
       typedef SuggestionIterator iterator;
   
     public: // functions
       iterator begin() const;
   
       iterator end() const;
   
       int size() const;
   
     private: // types
       typedef Archive::EntryRange<EntryOrder::titleOrder> EntryRange;
       typedef std::shared_ptr<SuggestionDataBase> SuggestionDBPtr;
   
     private: // functions
       explicit SuggestionResultSet(EntryRange entryRange);
   
     private: // data
       SuggestionDBPtr mp_internalDb;
       std::shared_ptr<EntryRange> mp_entryRange;
   
     friend class SuggestionSearch;
   
   // Xapian based methods and data
   #if defined(LIBZIM_WITH_XAPIAN)
   
     private: // Xapian based methods
       SuggestionResultSet(SuggestionDBPtr p_internalDb, Xapian::MSet&& mset);
   
     private: // Xapian based data
       std::shared_ptr<Xapian::MSet> mp_mset;
   
   #endif  // LIBZIM_WITH_XAPIAN
   };
   
   } // namespace zim
   
   #endif // ZIM_SUGGESTION_H