/**
 * MIT License
 *
 * Copyright (c) 2019-2021 EOS Sw/eden
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef ANTELOPEKEYGEN_COMMON_KEY_SEARCH_H
#define ANTELOPEKEYGEN_COMMON_KEY_SEARCH_H

#include <stdint.h>
#include <string>
#include <libantelope/ec.hpp>
#include <eoskeygen/config.hpp>
#include <eoskeygen/core/dictionary.hpp>
#include <eoskeygen/core/strlist.hpp>

namespace antelopekeygen {

class IKeySearchResult;

class KeySearch
{
public :

	struct result {
		size_t pos; // position where the word was found.
		size_t len; // the length of the word.
	};

public :
	KeySearch();

	void setPrefix(const std::string& prefix);

	// Add a word to search for.
	void addWord(const std::string& str);

	// Add a list of words to search for.
	void addList(const strlist_t& list);

	// get the list of words to search for.
	const strlist_t& getList();

	// Clears the search list.
	void clear();

	// Set callback for search result.
	void setCallback(IKeySearchResult* callback);

#ifdef ANTELOPEKEYGEN_HAVE_THREADS
	// Returns the maximum number of threads
	// reported by the operating system.
	static size_t max_threads();

	// Set the number of threads to use while searching.
	void setThreadCount(size_t num);

	size_t getThreadCount() const;
#endif /* ANTELOPEKEYGEN_HAVE_THREADS */

	// Aborts find() operation if started.
	// This is useful for multithreaded code (like GUI application)
	// If find() is started as a seperate thread. This method could be called
	// from the gui thread if the user presses "cancel" button.
	void abort();

	// Perform a search.
	void find(size_t num_results);

protected :

	// Check if any word in <word_list> appears in <key>'s public key.
	// returns true if a word was found (stored in <result>), false otherwise.
	bool _contains_word(const struct libantelope::ec_keypair* key, struct result& result);

#ifdef ANTELOPEKEYGEN_HAVE_THREADS
	void _thr_proc();

	void _search_mt();
#endif /* ANTELOPEKEYGEN_HAVE_THREADS */

	void _search_linear();

protected :

	// Public key prefix.
	std::string m_prefix;

	// List of words to search for.
	strlist_t m_words;

	// Max keys to search for.
	std::size_t m_max;

	// Current number of keys found.
	std::size_t m_count;

#ifdef ANTELOPEKEYGEN_HAVE_THREADS
	// Number of threads to use.
	size_t m_threads;
#endif /* ANTELOPEKEYGEN_HAVE_THREADS */

	IKeySearchResult* m_callback;
};

} // namespace antelopekeygen

#endif /* ANTELOPEKEYGEN_COMMON_KEY_SEARCH_H */