dindexer/include/dindexer-machinery/indexer.hpp

/* Copyright 2015, Michele Santullo
 * This file is part of "dindexer".
 *
 * "dindexer" is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * "dindexer" is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with "dindexer".  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef idE555EF56730442C1ADDC7B2AE7A9340E
#define idE555EF56730442C1ADDC7B2AE7A9340E

#include <memory>
#include <string>
#include <vector>

#if !defined(NDEBUG)
#	define INDEXER_VERBOSE
#endif

#if defined(WITH_PROGRESS_FEEDBACK)
namespace std {
	class condition_variable;
} //namespace std
#endif

namespace fastf {
	struct FileStats;
} //namespace fastf

namespace dinlib {
	struct Settings;
} //namespace dinlib

namespace din {
	struct FileRecordData;

	class Indexer {
	public:
		Indexer ( void );
		Indexer ( Indexer&& ) = default;
		Indexer ( const Indexer& ) = delete;
		~Indexer ( void ) noexcept;

		bool add_path ( const char* parPath, const fastf::FileStats& parStats );
#if defined(INDEXER_VERBOSE)
		void dump ( void ) const;
#endif

		std::size_t total_items ( void ) const;
		std::string operator[] ( std::size_t parIndex ) const;
#if defined(WITH_PROGRESS_FEEDBACK)
		std::size_t processed_items ( void ) const;
		std::string current_item ( void ) const;
		std::condition_variable& step_notify ( void );
#endif
		void calculate_hash ( void );
		bool empty ( void ) const;
		void ignore_read_errors ( bool parIgnore );
		const std::vector<FileRecordData>& record_data ( void ) const;

	private:
		struct LocalData;

		std::unique_ptr<LocalData> m_local_data;
	};
} //namespace din

#endif