lingucomponent/source/languageguessing/simpleguesser.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_LINGUCOMPONENT_SOURCE_LANGUAGEGUESSING_SIMPLEGUESSER_HXX
  20 #define INCLUDED_LINGUCOMPONENT_SOURCE_LANGUAGEGUESSING_SIMPLEGUESSER_HXX
  21
  22 #include <string.h>
  23 #include <string>
  24 #include <cstdlib>
  25 #include <vector>
  26 #include "guess.hxx"
  27
  28 #define MAX_STRING_LENGTH_TO_ANALYSE 200
  29
  30 using namespace std;
  31
  32 class SimpleGuesser final {
  33 public:
  34     /**inits the object with conf file "./conf.txt"*/
  35     SimpleGuesser();
  36
  37     /**
  38      * @param SimpleGuesser& sg the other guesser
  39      */
  40     SimpleGuesser& operator=(const SimpleGuesser& sg);
  41
  42     /**
  43      * destroy the object
  44      */
  45     ~SimpleGuesser();
  46
  47     /**
  48      * Analyze a text and return the most probable languages of the text
  49      * @param char* text is the text to analyze
  50      * @return the list of guess
  51      */
  52     vector<Guess> GuessLanguage(const char* text);
  53
  54     /**
  55      * Analyze a text and return the most probable language of the text
  56      * @param char* text is the text to analyze
  57      * @return the guess (containing language)
  58      */
  59     Guess GuessPrimaryLanguage(const char* text);
  60
  61     /**
  62      * List all available languages (possibly to be in guesses)
  63      * @return the list of languages
  64      */
  65     vector<Guess> GetAvailableLanguages();
  66
  67     /**
  68      * List all languages (possibly in guesses or not)
  69      * @return the list of languages
  70      */
  71     vector<Guess> GetAllManagedLanguages();
  72
  73     /**
  74      * List all Unavailable languages (disable for any reason)
  75      * @return the list of languages
  76      */
  77     vector<Guess> GetUnavailableLanguages();
  78
  79     /**
  80      * Mark a language enabled
  81      * @param string lang the language to enable (build like language-COUNTRY-encoding)
  82      */
  83     void EnableLanguage(const string& lang);
  84
  85     /**
  86      * Mark a language disabled
  87      * @param string lang the language to disable (build like language-COUNTRY-encoding)
  88      */
  89     void DisableLanguage(const string& lang);
  90
  91     /**
  92      * Load a new DB of fingerprints
  93      * @param const char* thePathOfConfFile self explaining
  94      * @param const char* prefix is the path where the directory which contains fingerprint files is stored
  95     */
  96     void SetDBPath(const char* thePathOfConfFile, const char* prefix);
  97
  98 private:
  99
 100     //Where typical fingerprints (n-gram tables) are stored
 101     void* h;
 102
 103     //Is used to select languages into the fingerprints DB, the mask is used to indicate if we want enabled disabled or both
 104     vector<Guess> GetManagedLanguages(const char mask);
 105
 106     //Like getManagedLanguages, this function enable or disable a language and it depends of the mask
 107     void XableLanguage(const string& lang, char mask);
 108 };
 109
 110 #endif
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */