File: pps-document-info.h

package info (click to toggle)
papers 49.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 21,044 kB
  • sloc: ansic: 37,728; sh: 197; xml: 127; makefile: 113
file content (197 lines) | stat: -rw-r--r-- 6,738 bytes parent folder | download | duplicates (2)
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Copyright (C) 2000-2003 Marco Pesenti Gritti
 *  Copyright © 2021 Christian Persch
 */

#pragma once

#if !defined(__PPS_PAPERS_DOCUMENT_H_INSIDE__) && !defined(PAPERS_COMPILATION)
#error "Only <papers-document.h> can be included directly."
#endif

#include <glib-object.h>
#include <glib.h>

#include "pps-macros.h"

G_BEGIN_DECLS

typedef struct _PpsDocumentInfo PpsDocumentInfo;
typedef struct _PpsDocumentLicense PpsDocumentLicense;

#define PPS_TYPE_DOCUMENT_INFO (pps_document_info_get_type ())

typedef enum {
	PPS_DOCUMENT_LAYOUT_SINGLE_PAGE,
	PPS_DOCUMENT_LAYOUT_ONE_COLUMN,
	PPS_DOCUMENT_LAYOUT_TWO_COLUMN_LEFT,
	PPS_DOCUMENT_LAYOUT_TWO_COLUMN_RIGHT,
	PPS_DOCUMENT_LAYOUT_TWO_PAGE_LEFT,
	PPS_DOCUMENT_LAYOUT_TWO_PAGE_RIGHT
} PpsDocumentLayout;

typedef enum {
	PPS_DOCUMENT_MODE_NONE,
	PPS_DOCUMENT_MODE_USE_OC,
	PPS_DOCUMENT_MODE_USE_THUMBS,
	PPS_DOCUMENT_MODE_FULL_SCREEN,
	PPS_DOCUMENT_MODE_USE_ATTACHMENTS,
	PPS_DOCUMENT_MODE_PRESENTATION = PPS_DOCUMENT_MODE_FULL_SCREEN /* Will these be different? */
} PpsDocumentMode;

typedef enum {
	PPS_DOCUMENT_CONTAINS_JS_UNKNOWN,
	PPS_DOCUMENT_CONTAINS_JS_NO,
	PPS_DOCUMENT_CONTAINS_JS_YES
} PpsDocumentContainsJS;

typedef enum {
	PPS_DOCUMENT_UI_HINT_HIDE_TOOLBAR = 1 << 0,
	PPS_DOCUMENT_UI_HINT_HIDE_MENUBAR = 1 << 1,
	PPS_DOCUMENT_UI_HINT_HIDE_WINDOWUI = 1 << 2,
	PPS_DOCUMENT_UI_HINT_FIT_WINDOW = 1 << 3,
	PPS_DOCUMENT_UI_HINT_CENTER_WINDOW = 1 << 4,
	PPS_DOCUMENT_UI_HINT_DISPLAY_DOC_TITLE = 1 << 5,
	PPS_DOCUMENT_UI_HINT_DIRECTION_RTL = 1 << 6
} PpsDocumentUIHints;

/* This define is needed because glib-mkenums chokes with multiple lines */
#define _PERMISSIONS_FULL (PPS_DOCUMENT_PERMISSIONS_OK_TO_PRINT | PPS_DOCUMENT_PERMISSIONS_OK_TO_MODIFY | PPS_DOCUMENT_PERMISSIONS_OK_TO_COPY | PPS_DOCUMENT_PERMISSIONS_OK_TO_ADD_NOTES)

typedef enum {
	PPS_DOCUMENT_PERMISSIONS_OK_TO_PRINT = 1 << 0,
	PPS_DOCUMENT_PERMISSIONS_OK_TO_MODIFY = 1 << 1,
	PPS_DOCUMENT_PERMISSIONS_OK_TO_COPY = 1 << 2,
	PPS_DOCUMENT_PERMISSIONS_OK_TO_ADD_NOTES = 1 << 3,
	PPS_DOCUMENT_PERMISSIONS_FULL = _PERMISSIONS_FULL
} PpsDocumentPermissions;

typedef enum {
	PPS_DOCUMENT_INFO_TITLE = 1 << 0,
	PPS_DOCUMENT_INFO_FORMAT = 1 << 1,
	PPS_DOCUMENT_INFO_AUTHOR = 1 << 2,
	PPS_DOCUMENT_INFO_SUBJECT = 1 << 3,
	PPS_DOCUMENT_INFO_KEYWORDS = 1 << 4,
	PPS_DOCUMENT_INFO_LAYOUT = 1 << 5,
	PPS_DOCUMENT_INFO_CREATOR = 1 << 6,
	PPS_DOCUMENT_INFO_PRODUCER = 1 << 7,
	PPS_DOCUMENT_INFO_CREATION_DATETIME = 1 << 8,
	PPS_DOCUMENT_INFO_MOD_DATETIME = 1 << 9,
	PPS_DOCUMENT_INFO_LINEARIZED = 1 << 10,
	PPS_DOCUMENT_INFO_START_MODE = 1 << 11,
	PPS_DOCUMENT_INFO_UI_HINTS = 1 << 12,
	PPS_DOCUMENT_INFO_PERMISSIONS = 1 << 13,
	PPS_DOCUMENT_INFO_N_PAGES = 1 << 14,
	PPS_DOCUMENT_INFO_SECURITY = 1 << 15,
	PPS_DOCUMENT_INFO_PAPER_SIZE = 1 << 16,
	PPS_DOCUMENT_INFO_LICENSE = 1 << 17,
	PPS_DOCUMENT_INFO_CONTAINS_JS = 1 << 18
} PpsDocumentInfoFields;

struct _PpsDocumentInfo {
	char *title;
	char *format; /* eg, "pdf-1.5" */
	char *author;
	char *subject;
	char *keywords;
	char *creator;
	char *producer;
	char *linearized;
	char *security;
	GDateTime *creation_datetime;
	GDateTime *modified_datetime;
	PpsDocumentLayout layout;
	PpsDocumentMode mode;
	guint ui_hints;
	guint permissions;
	int n_pages;
	double paper_height;
	double paper_width;
	PpsDocumentLicense *license;
	PpsDocumentContainsJS contains_js; /* wheter it contains any javascript */

	/* Mask of all the valid fields */
	guint fields_mask;
};

PPS_PUBLIC
GType pps_document_info_get_type (void) G_GNUC_CONST;
PPS_PUBLIC
PpsDocumentInfo *pps_document_info_new (void);
PPS_PUBLIC
PpsDocumentInfo *pps_document_info_copy (const PpsDocumentInfo *info);
PPS_PUBLIC
void pps_document_info_free (PpsDocumentInfo *info);
PPS_PUBLIC
GDateTime *pps_document_info_get_created_datetime (const PpsDocumentInfo *info);
PPS_PUBLIC
GDateTime *pps_document_info_get_modified_datetime (const PpsDocumentInfo *info);
PPS_PUBLIC
char *pps_document_info_regular_paper_size (const PpsDocumentInfo *info);
PPS_PUBLIC
gboolean pps_document_info_pages (const PpsDocumentInfo *info, gint *pages);
PPS_PUBLIC
gboolean pps_document_info_contains_js (const PpsDocumentInfo *info, PpsDocumentContainsJS *contains_js);
PPS_PUBLIC
gboolean pps_document_info_permissions (const PpsDocumentInfo *info, PpsDocumentPermissions *permissions);
PPS_PUBLIC
gboolean pps_document_info_start_mode (const PpsDocumentInfo *info, PpsDocumentMode *mode);
PPS_PUBLIC
gboolean pps_document_info_license (const PpsDocumentInfo *info, PpsDocumentLicense **license);
PPS_PUBLIC
gboolean pps_document_info_title (const PpsDocumentInfo *info, gchar **title);
PPS_PUBLIC
gboolean pps_document_info_format (const PpsDocumentInfo *info, gchar **format);
PPS_PUBLIC
gboolean pps_document_info_author (const PpsDocumentInfo *info, gchar **author);
PPS_PUBLIC
gboolean pps_document_info_subject (const PpsDocumentInfo *info, gchar **subject);
PPS_PUBLIC
gboolean pps_document_info_keywords (const PpsDocumentInfo *info, gchar **keywords);
PPS_PUBLIC
gboolean pps_document_info_creator (const PpsDocumentInfo *info, gchar **creator);
PPS_PUBLIC
gboolean pps_document_info_producer (const PpsDocumentInfo *info, gchar **producer);
PPS_PUBLIC
gboolean pps_document_info_linearized (const PpsDocumentInfo *info, gchar **linearized);
PPS_PUBLIC
gboolean pps_document_info_security (const PpsDocumentInfo *info, gchar **security);

PPS_PRIVATE
void pps_document_info_take_created_datetime (PpsDocumentInfo *info,
                                              GDateTime *datetime);
PPS_PRIVATE
void pps_document_info_take_modified_datetime (PpsDocumentInfo *info,
                                               GDateTime *datetime);
PPS_PRIVATE
gboolean pps_document_info_set_from_xmp (PpsDocumentInfo *info,
                                         const char *xmp,
                                         gssize size);

/* PpsDocumentLicense */
#define PPS_TYPE_DOCUMENT_LICENSE (pps_document_license_get_type ())
struct _PpsDocumentLicense {
	gchar *text;
	gchar *uri;
	gchar *web_statement;
};
PPS_PUBLIC
GType pps_document_license_get_type (void) G_GNUC_CONST;
PPS_PUBLIC
PpsDocumentLicense *pps_document_license_new (void);
PPS_PUBLIC
PpsDocumentLicense *pps_document_license_copy (PpsDocumentLicense *license);
PPS_PUBLIC
void pps_document_license_free (PpsDocumentLicense *license);
PPS_PUBLIC
const gchar *pps_document_license_get_text (PpsDocumentLicense *license);
PPS_PUBLIC
const gchar *pps_document_license_get_uri (PpsDocumentLicense *license);
PPS_PUBLIC
const gchar *pps_document_license_get_web_statement (PpsDocumentLicense *license);

G_END_DECLS

/* Automatic Cleanup */
G_DEFINE_AUTOPTR_CLEANUP_FUNC (PpsDocumentInfo, pps_document_info_free)