mirror of https://github.com/JakubMelka/PDF4QT.git
87 lines
3.2 KiB
C++
87 lines
3.2 KiB
C++
// Copyright (C) 2020-2021 Jakub Melka
|
|
//
|
|
// This file is part of PDF4QT.
|
|
//
|
|
// PDF4QT is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// with the written consent of the copyright owner, any later version.
|
|
//
|
|
// PDF4QT 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 Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with PDF4QT. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
#ifndef PDFDOCUMENTWRITER_H
|
|
#define PDFDOCUMENTWRITER_H
|
|
|
|
#include "pdfdocument.h"
|
|
#include "pdfprogress.h"
|
|
#include "pdfutils.h"
|
|
|
|
#include <QIODevice>
|
|
|
|
namespace pdf
|
|
{
|
|
|
|
/// Class used for writing PDF documents to the desired target device (or file,
|
|
/// buffer, etc.). If writing is not successful, then error message is returned.
|
|
class PDF4QTLIBSHARED_EXPORT PDFDocumentWriter
|
|
{
|
|
Q_DECLARE_TR_FUNCTIONS(pdf::PDFDocumentWriter)
|
|
|
|
public:
|
|
explicit inline PDFDocumentWriter(PDFProgress* progress) :
|
|
m_progress(progress)
|
|
{
|
|
|
|
}
|
|
|
|
/// Writes document to the file. If \p safeWrite is true, then document is first
|
|
/// written to the temporary file, and then renamed to original file name atomically,
|
|
/// so no data can be lost on, for example, power failure. If it is not possible to
|
|
/// create temporary file, then writing operation will attempt to write to the file
|
|
/// directly.
|
|
/// \param fileName File name
|
|
/// \param document Document
|
|
/// \param safeWrite Write document to the temporary file and then rename
|
|
PDFOperationResult write(const QString& fileName, const PDFDocument* document, bool safeWrite);
|
|
|
|
/// Write document to the output device. Device must be writable (i.e. opened
|
|
/// for writing).
|
|
/// \param device Output device
|
|
/// \param document Document
|
|
PDFOperationResult write(QIODevice* device, const PDFDocument* document);
|
|
|
|
/// Calculates document file size, as if it is written to the disk.
|
|
/// No file is accessed by this function; document is written
|
|
/// to fake stream, which counts operations. If error occurs, and
|
|
/// size can't be determined, then -1 is returned.
|
|
/// \param document Document
|
|
static qint64 getDocumentFileSize(const PDFDocument* document);
|
|
|
|
/// Calculates size estimate of an object. If object is null, then zero is returned.
|
|
/// \param document Document
|
|
/// \param reference Reference
|
|
static qint64 getObjectSize(const PDFDocument* document, PDFObjectReference reference);
|
|
|
|
/// Writes an object to byte array, without object header/footer
|
|
/// \param object Object to be written
|
|
static QByteArray getSerializedObject(const PDFObject& object);
|
|
|
|
private:
|
|
static void writeCRLF(QIODevice* device);
|
|
static void writeObjectHeader(QIODevice* device, PDFObjectReference reference);
|
|
static void writeObjectFooter(QIODevice* device);
|
|
|
|
/// Progress indicator
|
|
PDFProgress* m_progress;
|
|
};
|
|
|
|
} // namespace pdf
|
|
|
|
#endif // PDFDOCUMENTWRITER_H
|