FileNameDisambiguator.h

/*
    Scan Tailor - Interactive post-processing tool for scanned pages.
    Copyright (C)  Joseph Artsimovich <joseph.artsimovich@gmail.com>

    This program 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.

    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef FILENAME_DISAMBIGUATOR_H_
#define FILENAME_DISAMBIGUATOR_H_

#include "NonCopyable.h"
#include "RefCountable.h"
#include <boost/function.hpp>
#include <memory>
#include <set>

class AbstractRelinker;
class QString;
class QDomElement;
class QDomDocument;

/**
 * \brief Associates an integer label with each file path so that
 *        files with the same name but from different directories
 *        have distinctive labels.
 *
 * \note This class is thread-safe.
 */
class FileNameDisambiguator : public RefCountable
{
	DECLARE_NON_COPYABLE(FileNameDisambiguator)
public:
	FileNameDisambiguator();

	/**
	 * \brief Load disambiguation information from XML.
	 */
	FileNameDisambiguator(QDomElement const& disambiguator_el);

	/**
	 * \brief Load disambiguation information from XML with file path unpacking.
	 *
	 * Supplying a file path unpacker allows storing shorthands rather than
	 * full paths in XML.  Unpacker is a functor taking a shorthand and
	 * returning the full path.  If unpacker returns an empty string,
	 * the record will be skipped.
	 */
	FileNameDisambiguator(QDomElement const& disambiguator_el,
		boost::function<QString(QString const&)> const& file_path_unpacker);

	/**
	 * \brief Serialize disambiguation information to XML.
	 */
	QDomElement toXml(
		QDomDocument& doc, QString const& name) const;

	/**
	 * \brief Serialize disambiguation information to XML with file path packing.
	 *
	 * Supplying a file path packer allows storing shorthands rather than
	 * full paths in XML.  Packer is a functor taking a full file path and
	 * returning the corresponding shorthand.  If packer returns an empty string,
	 * the record will be skipped.
	 */
	QDomElement toXml(
		QDomDocument& doc, QString const& name,
		boost::function<QString(QString const&)> const& file_path_packer) const;

	int getLabel(QString const& file_path) const;

	int registerFile(QString const& file_path);

	void performRelinking(AbstractRelinker const& relinker);
private:
	class Impl;

	std::auto_ptr<Impl> m_ptrImpl;
};

#endif