2014-10-05 10:42:40 +00:00
|
|
|
// Copyright (c) 2014, The Monero Project
|
|
|
|
//
|
|
|
|
// All rights reserved.
|
|
|
|
//
|
|
|
|
// Redistribution and use in source and binary forms, with or without modification, are
|
|
|
|
// permitted provided that the following conditions are met:
|
|
|
|
//
|
|
|
|
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
|
|
|
// conditions and the following disclaimer.
|
|
|
|
//
|
|
|
|
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
|
|
|
// of conditions and the following disclaimer in the documentation and/or other
|
|
|
|
// materials provided with the distribution.
|
|
|
|
//
|
|
|
|
// 3. Neither the name of the copyright holder nor the names of its contributors may be
|
|
|
|
// used to endorse or promote products derived from this software without specific
|
|
|
|
// prior written permission.
|
|
|
|
//
|
|
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
|
|
|
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
|
|
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
|
|
|
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
|
|
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
|
|
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
|
|
|
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
2014-10-02 16:05:27 +00:00
|
|
|
/*!
|
|
|
|
* \file language_base.h
|
|
|
|
*
|
|
|
|
* \brief Language Base class for Polymorphism.
|
|
|
|
*/
|
|
|
|
|
2014-10-02 15:44:29 +00:00
|
|
|
#ifndef LANGUAGE_BASE_H
|
|
|
|
#define LANGUAGE_BASE_H
|
|
|
|
|
|
|
|
#include <vector>
|
|
|
|
#include <unordered_map>
|
|
|
|
#include <string>
|
|
|
|
|
2014-10-02 16:05:27 +00:00
|
|
|
/*!
|
|
|
|
* \namespace Language
|
|
|
|
* \brief Mnemonic language related namespace.
|
|
|
|
*/
|
2014-10-02 15:44:29 +00:00
|
|
|
namespace Language
|
|
|
|
{
|
2014-10-03 10:55:44 +00:00
|
|
|
const int unique_prefix_length = 4; /*!< Length of the prefix of all words guaranteed to be unique */
|
|
|
|
/*!
|
|
|
|
* \class Base
|
|
|
|
* \brief A base language class which all languages have to inherit from for
|
|
|
|
* Polymorphism.
|
|
|
|
*/
|
|
|
|
class Base
|
|
|
|
{
|
|
|
|
protected:
|
|
|
|
std::vector<std::string> *word_list; /*!< A pointer to the array of words */
|
|
|
|
std::unordered_map<std::string, uint32_t> *word_map; /*!< hash table to find word's index */
|
|
|
|
std::unordered_map<std::string, uint32_t> *trimmed_word_map; /*!< hash table to find word's trimmed index */
|
|
|
|
std::string language_name; /*!< Name of language */
|
|
|
|
/*!
|
|
|
|
* \brief Populates the word maps after the list is ready.
|
|
|
|
*/
|
|
|
|
void populate_maps()
|
|
|
|
{
|
|
|
|
int ii;
|
|
|
|
std::vector<std::string>::iterator it;
|
|
|
|
for (it = word_list->begin(), ii = 0; it != word_list->end(); it++, ii++)
|
|
|
|
{
|
|
|
|
(*word_map)[*it] = ii;
|
|
|
|
if (it->length() > unique_prefix_length)
|
|
|
|
{
|
|
|
|
(*trimmed_word_map)[it->substr(0, unique_prefix_length)] = ii;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
(*trimmed_word_map)[*it] = ii;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
public:
|
|
|
|
Base()
|
|
|
|
{
|
|
|
|
word_list = new std::vector<std::string>;
|
|
|
|
word_map = new std::unordered_map<std::string, uint32_t>;
|
|
|
|
trimmed_word_map = new std::unordered_map<std::string, uint32_t>;
|
|
|
|
}
|
|
|
|
/*!
|
|
|
|
* \brief Returns a pointer to the word list.
|
|
|
|
* \return A pointer to the word list.
|
|
|
|
*/
|
|
|
|
const std::vector<std::string>& get_word_list() const
|
|
|
|
{
|
|
|
|
return *word_list;
|
|
|
|
}
|
|
|
|
/*!
|
|
|
|
* \brief Returns a pointer to the word map.
|
|
|
|
* \return A pointer to the word map.
|
|
|
|
*/
|
|
|
|
const std::unordered_map<std::string, uint32_t>& get_word_map() const
|
|
|
|
{
|
|
|
|
return *word_map;
|
|
|
|
}
|
|
|
|
/*!
|
|
|
|
* \brief Returns a pointer to the trimmed word map.
|
|
|
|
* \return A pointer to the trimmed word map.
|
|
|
|
*/
|
|
|
|
const std::unordered_map<std::string, uint32_t>& get_trimmed_word_map() const
|
|
|
|
{
|
|
|
|
return *trimmed_word_map;
|
|
|
|
}
|
|
|
|
/*!
|
|
|
|
* \brief Returns the name of the language.
|
|
|
|
* \return Name of the language.
|
|
|
|
*/
|
|
|
|
std::string get_language_name() const
|
|
|
|
{
|
|
|
|
return language_name;
|
|
|
|
}
|
2014-10-05 10:42:40 +00:00
|
|
|
/*!
|
|
|
|
* \brief Returns the number of unique starting characters to be used for matching.
|
|
|
|
* \return Number of unique starting characters.
|
|
|
|
*/
|
|
|
|
std::string get_trim_length() const
|
|
|
|
{
|
|
|
|
return trim_length;
|
|
|
|
}
|
2014-10-03 10:55:44 +00:00
|
|
|
};
|
2014-10-02 15:44:29 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|