1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Computational Engine *
* *
* Copyright (c) 1999-2011, Ben Burton *
* For further details contact Ben Burton (bab@debian.org). *
* *
* 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 2 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, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
* MA 02110-1301, USA. *
* *
**************************************************************************/
/* end stub */
/*! \file foreign/pdf.h
* \brief Allows reading and writing PDF documents.
*/
#ifndef __PDF_H
#ifndef __DOXYGEN
#define __PDF_H
#endif
#include "regina-core.h"
namespace regina {
class NPDF;
/**
* \weakgroup foreign
* @{
*/
/**
* Reads a PDF document from the given file. A newly allocated PDF packet
* will be returned; it is the user's responsibility to deallocate this
* when it is finished with.
*
* This routine does not check whether the given file \e looks like a
* PDF document; it simply loads the file contents blindly.
*
* The packet label of the new PDF packet will be left empty.
*
* If the file could not be read, 0 will be returned.
*
* \i18n This routine makes no assumptions about the
* \ref i18n "character encoding" used in the given file \e name, and
* simply passes it through unchanged to low-level C/C++ file I/O routines.
*
* @param filename the filename of the PDF document to read.
* @return a new PDF packet containing the PDF document, or 0 on error.
*/
REGINA_API NPDF* readPDF(const char *filename);
/**
* Writes the given PDF document to the given file.
*
* This routine does not check whether the contents of the given packet
* \e look like a PDF document; it simply writes them blindly to the
* given file.
*
* If the given PDF packet is empty (i.e., does not contain a real block
* of data) then the resulting file will be created but left empty.
*
* \i18n This routine makes no assumptions about the
* \ref i18n "character encoding" used in the given file \e name, and
* simply passes it through unchanged to low-level C/C++ file I/O routines.
*
* @param filename the filename of the PDF document to write.
* @param pdf the PDF packet to write to the given file.
* @return \c true if the export was successful, or \c false otherwise.
*/
REGINA_API bool writePDF(const char* filename, const NPDF& pdf);
/*@}*/
} // namespace regina
#endif
|
