WPDocument.h Source File documentation

WPDocument.h
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2/* libwpd
3 * Version: MPL 2.0 / LGPLv2.1+
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * Major Contributor(s):
10 * Copyright (C) 2003-2005 William Lachance (wrlach@gmail.com)
11 * Copyright (C) 2003 Marc Maurer (uwog@uwog.net)
12 *
13 * For minor contributions see the git repository.
14 *
15 * Alternatively, the contents of this file may be used under the terms
16 * of the GNU Lesser General Public License Version 2.1 or later
17 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
18 * applicable instead of those above.
19 *
20 * For further information visit http://libwpd.sourceforge.net
21 */
22
23/* "This product is not manufactured, approved, or supported by
24 * Corel Corporation or Corel Corporation Limited."
25 */
26
27#ifndef WPDOCUMENT_H
28#define WPDOCUMENT_H
29
30#ifdef DLL_EXPORT
31#ifdef LIBWPD_BUILD
32#define WPDAPI __declspec(dllexport)
33#else
34#define WPDAPI __declspec(dllimport)
35#endif
36#else // !DLL_EXPORT
37#ifdef LIBWPD_VISIBILITY
38#define WPDAPI __attribute__((visibility("default")))
39#else
40#define WPDAPI
41#endif
42#endif
43
44#include <librevenge/librevenge.h>
45
46namespace libwpd
47{
48
49/* The "WPD_CONFIDENCE_NONE=0" must not be removed for the type detection to work well */
50 enum WPDConfidence { WPD_CONFIDENCE_NONE=0, WPD_CONFIDENCE_UNSUPPORTED_ENCRYPTION, WPD_CONFIDENCE_SUPPORTED_ENCRYPTION, WPD_CONFIDENCE_EXCELLENT };
51 enum WPDResult { WPD_OK, WPD_FILE_ACCESS_ERROR, WPD_PARSE_ERROR, WPD_UNSUPPORTED_ENCRYPTION_ERROR, WPD_PASSWORD_MISSMATCH_ERROR, WPD_OLE_ERROR, WPD_UNKNOWN_ERROR };
52 enum WPDPasswordMatch { WPD_PASSWORD_MATCH_NONE, WPD_PASSWORD_MATCH_DONTKNOW, WPD_PASSWORD_MATCH_OK };
53 enum WPDFileFormat { WPD_FILE_FORMAT_WP6, WPD_FILE_FORMAT_WP5, WPD_FILE_FORMAT_WP42, WPD_FILE_FORMAT_WP3, WPD_FILE_FORMAT_WP1, WPD_FILE_FORMAT_UNKNOWN };
54
59
60 class WPDocument
61{
62public:
63 static WPDAPI WPDConfidence isFileFormatSupported(librevenge::RVNGInputStream *input);
64 static WPDAPI WPDPasswordMatch verifyPassword(librevenge::RVNGInputStream *input, const char *password);
65 static WPDAPI WPDResult parse(librevenge::RVNGInputStream *input, librevenge::RVNGTextInterface *documentInterface, const char *password);
66 static WPDAPI WPDResult parseSubDocument(librevenge::RVNGInputStream *input, librevenge::RVNGTextInterface *documentInterface, WPDFileFormat fileFormat);
67};
68
69} // namespace libwpd
70
71#endif /* WPDOCUMENT_H */
72/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
WPDAPI
#define WPDAPI
Definition WPDocument.h:40
libwpd::WPDocument
This class provides all the functions an application would need to parse WordPerfect documents.
Definition WPDocument.h:61
libwpd::WPDocument::parse
static WPDAPI WPDResult parse(librevenge::RVNGInputStream *input, librevenge::RVNGTextInterface *documentInterface, const char *password)
Parses the input stream content.
Definition WPDocument.cpp:223
libwpd::WPDocument::isFileFormatSupported
static WPDAPI WPDConfidence isFileFormatSupported(librevenge::RVNGInputStream *input)
Analyzes the content of an input stream to see if it can be parsed.
Definition WPDocument.cpp:66
libwpd::WPDocument::verifyPassword
static WPDAPI WPDPasswordMatch verifyPassword(librevenge::RVNGInputStream *input, const char *password)
Checks whether the given password was used to encrypt the document.
Definition WPDocument.cpp:156
libwpd::WPDocument::parseSubDocument
static WPDAPI WPDResult parseSubDocument(librevenge::RVNGInputStream *input, librevenge::RVNGTextInterface *documentInterface, WPDFileFormat fileFormat)
Definition WPDocument.cpp:361
libwpd
Definition libwpd_internal.h:56
libwpd::WPDConfidence
WPDConfidence
Definition WPDocument.h:50
libwpd::WPD_CONFIDENCE_NONE
@ WPD_CONFIDENCE_NONE
Definition WPDocument.h:50
libwpd::WPD_CONFIDENCE_SUPPORTED_ENCRYPTION
@ WPD_CONFIDENCE_SUPPORTED_ENCRYPTION
Definition WPDocument.h:50
libwpd::WPD_CONFIDENCE_EXCELLENT
@ WPD_CONFIDENCE_EXCELLENT
Definition WPDocument.h:50
libwpd::WPD_CONFIDENCE_UNSUPPORTED_ENCRYPTION
@ WPD_CONFIDENCE_UNSUPPORTED_ENCRYPTION
Definition WPDocument.h:50
libwpd::WPDResult
WPDResult
Definition WPDocument.h:51
libwpd::WPD_OLE_ERROR
@ WPD_OLE_ERROR
Definition WPDocument.h:51
libwpd::WPD_OK
@ WPD_OK
Definition WPDocument.h:51
libwpd::WPD_UNSUPPORTED_ENCRYPTION_ERROR
@ WPD_UNSUPPORTED_ENCRYPTION_ERROR
Definition WPDocument.h:51
libwpd::WPD_UNKNOWN_ERROR
@ WPD_UNKNOWN_ERROR
Definition WPDocument.h:51
libwpd::WPD_FILE_ACCESS_ERROR
@ WPD_FILE_ACCESS_ERROR
Definition WPDocument.h:51
libwpd::WPD_PARSE_ERROR
@ WPD_PARSE_ERROR
Definition WPDocument.h:51
libwpd::WPD_PASSWORD_MISSMATCH_ERROR
@ WPD_PASSWORD_MISSMATCH_ERROR
Definition WPDocument.h:51
libwpd::WPDPasswordMatch
WPDPasswordMatch
Definition WPDocument.h:52
libwpd::WPD_PASSWORD_MATCH_OK
@ WPD_PASSWORD_MATCH_OK
Definition WPDocument.h:52
libwpd::WPD_PASSWORD_MATCH_DONTKNOW
@ WPD_PASSWORD_MATCH_DONTKNOW
Definition WPDocument.h:52
libwpd::WPD_PASSWORD_MATCH_NONE
@ WPD_PASSWORD_MATCH_NONE
Definition WPDocument.h:52
libwpd::WPDFileFormat
WPDFileFormat
Definition WPDocument.h:53
libwpd::WPD_FILE_FORMAT_WP6
@ WPD_FILE_FORMAT_WP6
Definition WPDocument.h:53
libwpd::WPD_FILE_FORMAT_WP5
@ WPD_FILE_FORMAT_WP5
Definition WPDocument.h:53
libwpd::WPD_FILE_FORMAT_WP42
@ WPD_FILE_FORMAT_WP42
Definition WPDocument.h:53
libwpd::WPD_FILE_FORMAT_UNKNOWN
@ WPD_FILE_FORMAT_UNKNOWN
Definition WPDocument.h:53
libwpd::WPD_FILE_FORMAT_WP3
@ WPD_FILE_FORMAT_WP3
Definition WPDocument.h:53
libwpd::WPD_FILE_FORMAT_WP1
@ WPD_FILE_FORMAT_WP1
Definition WPDocument.h:53