The only important public class.
More...
#include <dictionary.hxx>
|
auto | load_aff_dic (std::istream &aff, std::istream &dic) -> void |
| Load the dictionary from opened files as iostreams.
|
auto | load_aff_dic (const std::filesystem::path &aff_path) -> void |
| Load the dictionary from file on filesystem.
|
auto | load_aff_dic_internal (const std::filesystem::path &aff_path, std::ostream &err_msg) -> void |
auto | spell (std::string_view word) const -> bool |
| Checks if a given word is correct.
|
auto | suggest (std::string_view word, std::vector< std::string > &out) const -> void |
| Suggests correct words for a given incorrect word.
|
|
static auto | load_from_aff_dic (std::istream &aff, std::istream &dic) -> Dictionary |
| Create a dictionary from opened files as iostreams.
|
static auto | load_from_path (const std::string &file_path_without_extension) -> Dictionary |
| Create a dictionary from files.
|
The only important public class.
◆ load_aff_dic() [1/2]
auto nuspell::v5::Dictionary::load_aff_dic |
( |
const std::filesystem::path & | aff_path | ) |
-> void |
Load the dictionary from file on filesystem.
- Precondition
- Before calling this the dictionary object must be empty e.g default-constructed or assigned with another empty object.
- Parameters
-
aff_path | path to .aff file. The path of .dic is inffered from this. |
- Exceptions
-
◆ load_aff_dic() [2/2]
auto nuspell::v5::Dictionary::load_aff_dic |
( |
std::istream & | aff, |
|
|
std::istream & | dic ) -> void |
Load the dictionary from opened files as iostreams.
- Precondition
- Before calling this the dictionary object must be empty e.g default-constructed or assigned with another empty object.
- Parameters
-
aff | The iostream of the .aff file |
dic | The iostream of the .dic file |
- Exceptions
-
◆ load_from_aff_dic()
auto nuspell::v5::Dictionary::load_from_aff_dic |
( |
std::istream & | aff, |
|
|
std::istream & | dic ) -> Dictionary |
|
static |
Create a dictionary from opened files as iostreams.
Prefer using load_from_path(). Use this if you have a specific use case, like when .aff and .dic are in-memory buffers istringstream.
- Deprecated
- Use new non-static member function load_aff_dic(std::istream&,std::istream&).
- Parameters
-
aff | The iostream of the .aff file |
dic | The iostream of the .dic file |
- Returns
- Dictionary object
- Exceptions
-
◆ load_from_path()
auto nuspell::v5::Dictionary::load_from_path |
( |
const std::string & | file_path_without_extension | ) |
-> Dictionary |
|
static |
◆ spell()
auto nuspell::v5::Dictionary::spell |
( |
std::string_view | word | ) |
const -> bool |
Checks if a given word is correct.
- Parameters
-
- Returns
- true if correct, false otherwise
◆ suggest()
auto nuspell::v5::Dictionary::suggest |
( |
std::string_view | word, |
|
|
std::vector< std::string > & | out ) const -> void |
Suggests correct words for a given incorrect word.
- Parameters
-
[in] | word | incorrect word |
[out] | out | this object will be populated with the suggestions |
The documentation for this class was generated from the following files: