src/Thesaurus.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Thesaurus.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author John Levon
   8  * \author Jürgen Spitzmüller
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef THESAURUS_H
  14 #define THESAURUS_H
  15
  16 #include "support/docstring.h"
  17 #include "WordLangTuple.h"
  18
  19 #include <map>
  20 #include <vector>
  21
  22 namespace lyx {
  23
  24 /**
  25  * This class provides an interface to whatever thesauri we might support.
  26  */
  27
  28 class Thesaurus
  29 {
  30         /// noncopyable
  31         Thesaurus(Thesaurus const &);
  32         void operator=(Thesaurus const &);
  33 public:
  34         ///
  35         Thesaurus();
  36         ///
  37         ~Thesaurus();
  38
  39         typedef std::map<docstring, std::vector<docstring> > Meanings;
  40
  41         /**
  42          * look up some text in the thesaurus
  43          */
  44         Meanings lookup(WordLangTuple const & wl);
  45         /** check if a thesaurus for a given language \p lang is available
  46          *  (installed and loaded)
  47          */
  48         bool thesaurusAvailable(docstring const & lang) const;
  49         /// check if a thesaurus for a given language \p lang is installed
  50         bool thesaurusInstalled(docstring const & lang) const;
  51
  52 private:
  53         struct Private;
  54         Private * const d;
  55 };
  56
  57 extern Thesaurus thesaurus;
  58
  59
  60 } // namespace lyx
  61
  62 #endif