mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-23 18:24:48 +00:00
ee005614a3
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@21080 a592a061-630c-0410-9148-cb99ea01b6c8
97 lines
2.7 KiB
C++
97 lines
2.7 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file Exporter.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
* \author Jean-Marc Lasgouttes
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef EXPORTER_H
|
|
#define EXPORTER_H
|
|
|
|
#include "support/FileName.h"
|
|
|
|
#include <map>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
|
|
namespace lyx {
|
|
|
|
enum CopyStatus {
|
|
SUCCESS,
|
|
FORCE,
|
|
CANCEL
|
|
};
|
|
|
|
|
|
/** copy file \p sourceFile to \p destFile. If \p force is false, the user
|
|
* will be asked before existing files are overwritten.
|
|
* \return
|
|
* - SUCCESS if this file got copied
|
|
* - FORCE if subsequent calls should not ask for confirmation before
|
|
* overwriting files anymore.
|
|
* - CANCEL if the export should be cancelled
|
|
*/
|
|
CopyStatus copyFile(std::string const & format,
|
|
support::FileName const & sourceFile, support::FileName const & destFile,
|
|
std::string const & latexFile, bool force);
|
|
|
|
|
|
class ExportedFile {
|
|
public:
|
|
ExportedFile(support::FileName const &, std::string const &);
|
|
/// absolute name of the source file
|
|
support::FileName sourceName;
|
|
/// final name that the exported file should get (absolute name or
|
|
/// relative to the directory of the master document)
|
|
std::string exportName;
|
|
};
|
|
|
|
|
|
bool operator==(ExportedFile const &, ExportedFile const &);
|
|
|
|
|
|
class ExportData {
|
|
public:
|
|
/** add a referenced file for one format.
|
|
* No inset should ever write any file outside the tempdir.
|
|
* Instead, files that need to be exported have to be registered
|
|
* with this method.
|
|
* Then the exporter mechanism copies them to the right place, asks
|
|
* for confirmation before overwriting existing files etc.
|
|
* \param format format that references the given file
|
|
* \param sourceName source file name. Needs to be absolute
|
|
* \param exportName resulting file name. Can be either absolute
|
|
* or relative to the exported document.
|
|
*/
|
|
void addExternalFile(std::string const & format,
|
|
support::FileName const & sourceName,
|
|
std::string const & exportName);
|
|
/** add a referenced file for one format.
|
|
* The final name is the source file name without path.
|
|
* \param format format that references the given file
|
|
* \param sourceName source file name. Needs to be absolute
|
|
*/
|
|
void addExternalFile(std::string const & format,
|
|
support::FileName const & sourceName);
|
|
/// get referenced files for \p format
|
|
std::vector<ExportedFile> const
|
|
externalFiles(std::string const & format) const;
|
|
private:
|
|
typedef std::map<std::string, std::vector<ExportedFile> > FileMap;
|
|
/** Files that are referenced by the export result in the
|
|
* different formats.
|
|
*/
|
|
FileMap externalfiles;
|
|
};
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|