mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-04 22:32:19 +00:00
196 lines
5.7 KiB
C++
196 lines
5.7 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file Mover.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Angus Leeming
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef MOVER_H
|
|
#define MOVER_H
|
|
|
|
#include <map>
|
|
#include <string>
|
|
|
|
|
|
namespace lyx {
|
|
|
|
namespace support { class FileName; }
|
|
|
|
/**
|
|
* Utility to copy a file of a specified format from one place to another.
|
|
* This base class simply invokes the command support::copy().
|
|
*/
|
|
class Mover
|
|
{
|
|
public:
|
|
virtual ~Mover() {}
|
|
Mover(Mover &&) = default;
|
|
Mover & operator=(Mover &&) = default;
|
|
Mover(Mover const &) = default;
|
|
Mover & operator=(Mover const &) = default;
|
|
|
|
Mover() = default;
|
|
|
|
/** Copy file @c from to @c to.
|
|
* This version should be used to copy files from the original
|
|
* location to the temporary directory.
|
|
* \returns true if successful.
|
|
*/
|
|
bool
|
|
copy(support::FileName const & from, support::FileName const & to) const;
|
|
|
|
/** Copy file @c from to @c to.
|
|
* \see SpecialisedMover::SpecialisedMover() for an explanation of
|
|
* @c latex.
|
|
* This version should be used to copy files from the temporary
|
|
* directory to the export location, since @c to and @c latex may
|
|
* not be equal in this case.
|
|
* \returns true if successful.
|
|
* NOTE: Although this routine simply calls do_copy() and
|
|
* Mover::do_copy() does not itself make any use of the @c latex argument,
|
|
* SpecialisedMover overrides do_copy(), so SpecialisedMover::copy(), which
|
|
* is just Mover::copy(), calls SpecialisedMover::do_copy(), and the @c latex
|
|
* argument IS in that case used.
|
|
*/
|
|
bool
|
|
copy(support::FileName const & from, support::FileName const & to,
|
|
std::string const & latex) const
|
|
{
|
|
return do_copy(from, to, latex);
|
|
}
|
|
|
|
/** Rename file @c from as @c to.
|
|
* This version should be used to move files from the original
|
|
* location to the temporary directory.
|
|
* \returns true if successful.
|
|
*/
|
|
bool
|
|
rename(support::FileName const & from, support::FileName const & to) const;
|
|
|
|
/** Rename file @c from as @c to.
|
|
* \see SpecialisedMover::SpecialisedMover() for an explanation of
|
|
* @c latex.
|
|
* This version should be used to move files from the temporary
|
|
* directory to the export location, since @c to and @c latex may
|
|
* not be equal in this case.
|
|
* \returns true if successful.
|
|
*/
|
|
bool
|
|
rename(support::FileName const & from, support::FileName const & to,
|
|
std::string const & latex) const
|
|
{
|
|
return do_rename(from, to, latex);
|
|
}
|
|
|
|
protected:
|
|
virtual bool
|
|
do_copy(support::FileName const & from, support::FileName const & to,
|
|
std::string const &) const;
|
|
|
|
virtual bool
|
|
do_rename(support::FileName const & from, support::FileName const & to,
|
|
std::string const &) const;
|
|
};
|
|
|
|
|
|
/**
|
|
* Specialisation of the Mover concept that uses an external command
|
|
* to copy a file.
|
|
*
|
|
* For example, an Xfig .fig file can contain references to external
|
|
* picture files. If such a reference has a relative path, then the
|
|
* copied .fig file will require a transformation of the picture file
|
|
* reference if it is to be found by Xfig.
|
|
*
|
|
* So, in this case, we need three arguments:
|
|
* (i) @c from the location of the file to be moved
|
|
* (ii) @c to the location to which it should be moved
|
|
* (iii) @c latex the identifier that should be used in the sort of
|
|
* transformation just mentioned.
|
|
*/
|
|
class SpecialisedMover : public Mover
|
|
{
|
|
public:
|
|
SpecialisedMover() = default;
|
|
|
|
/** @c command should be of the form
|
|
* <code>
|
|
* python $$s/scripts/fig_copy.py $$i $$o $$l
|
|
* </code>
|
|
* where $$s is a placeholder for the lyx support directory,
|
|
* $$i is a placeholder for the name of the file to be moved,
|
|
* $$o is a placeholder for the name of the file after moving,
|
|
* $$l is a placeholder for the latex argument, as explained above.
|
|
* $$o and $$l can only differ if the file is copied from the temporary
|
|
* directory to the export location. If it is copied from the original
|
|
* location to the temporary directory, they are the same, so $$l may be
|
|
* ignored in this case, as it is in the Mover baseclass.
|
|
*/
|
|
SpecialisedMover(std::string const & command)
|
|
: command_(command) {}
|
|
|
|
/// The template used to launch the external command.
|
|
std::string const & command() const { return command_; }
|
|
|
|
private:
|
|
bool do_copy(support::FileName const & from, support::FileName const & to,
|
|
std::string const & latex) const override;
|
|
|
|
bool do_rename(support::FileName const & from, support::FileName const & to,
|
|
std::string const & latex) const override;
|
|
|
|
std::string command_;
|
|
};
|
|
|
|
|
|
/**
|
|
* Manage the store of (Mover)s.
|
|
*/
|
|
class Movers
|
|
{
|
|
public:
|
|
/** Register a specialised @c command to be used to copy a file
|
|
* of format @c fmt.
|
|
*/
|
|
void set(std::string const & fmt, std::string const & command);
|
|
|
|
/// @c returns the Mover registered for format @c fmt.
|
|
Mover const & operator()(std::string const & fmt) const;
|
|
|
|
/** @returns the command template if @c fmt 'finds' a
|
|
* SpecialisedMover. Otherwise, returns an empty string.
|
|
*/
|
|
std::string const command(std::string const & fmt) const;
|
|
|
|
private:
|
|
typedef std::map<std::string, SpecialisedMover> SpecialsMap;
|
|
|
|
public:
|
|
typedef SpecialsMap::const_iterator const_iterator;
|
|
const_iterator begin() const { return specials_.begin(); }
|
|
const_iterator end() const { return specials_.end(); }
|
|
|
|
private:
|
|
Mover default_;
|
|
SpecialsMap specials_;
|
|
};
|
|
|
|
|
|
extern Movers & theMovers();
|
|
/// @c returns the Mover registered for format @c fmt.
|
|
extern Mover const & getMover(std::string const & fmt);
|
|
/** Register a specialised @c command to be used to copy a file
|
|
* of format @c fmt.
|
|
*/
|
|
extern void setMover(std::string const & fmt, std::string const & command);
|
|
extern Movers & theSystemMovers();
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif // MOVER_H
|