-
Notifications
You must be signed in to change notification settings - Fork 143
/
options.go
497 lines (452 loc) · 21.3 KB
/
options.go
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
package wkhtmltopdf
import (
"fmt"
"reflect"
)
const opt = "--"
// A list of options that can be set from code to make it easier to see which options are available
type globalOptions struct {
CookieJar stringOption // Read and write cookies from and to the supplied cookie jar file
Copies uintOption // Number of copies to print into the pdf file (default 1)
Dpi uintOption // Change the dpi explicitly (this has no effect on X11 based systems)
ExtendedHelp boolOption // Display more extensive help, detailing less common command switches
Grayscale boolOption // PDF will be generated in grayscale
Help boolOption // Display help
HTMLDoc boolOption // Output program html help
ImageDpi uintOption // When embedding images scale them down to this dpi (default 600)
ImageQuality uintOption // When jpeg compressing images use this quality (default 94)
License boolOption // Output license information and exit
LogLevel stringOption // Set log level to: none, error, warn or info (default info)
LowQuality boolOption // Generates lower quality pdf/ps. Useful to shrink the result document space
ManPage boolOption // Output program man page
MarginBottom uintOption // Set the page bottom margin in centimeters
MarginBottomUnit stringOption // Set the page bottom margin with a unit
MarginLeft uintOption // Set the page left margin (default 10mm)
MarginLeftUnit stringOption // Set the page left margin with a unit
MarginRight uintOption // Set the page right margin (default 10mm)
MarginRightUnit stringOption // Set the page right margin with a unit
MarginTop uintOption // Set the page top margin
MarginTopUnit stringOption // Set the page top margin with a unit
NoCollate boolOption // Do not collate when printing multiple copies (default collate)
NoPdfCompression boolOption // Do not use lossless compression on pdf objects
Orientation stringOption // Set orientation to Landscape or Portrait (default Portrait)
PageHeight uintOption // Page height
PageHeightUnit stringOption // Page height with a unit
PageSize stringOption // Set paper size to: A4, Letter, etc. (default A4)
PageWidth uintOption // Page width
PageWidthUnit stringOption // Page width with a unit
Quiet boolOption // Be less verbose
ReadArgsFromStdin boolOption // Read command line arguments from stdin
Readme boolOption // Output program readme
Title stringOption // The title of the generated pdf file (The title of the first document is used if not specified)
Version boolOption // Output version information and exit
}
func (gopt *globalOptions) Args() []string {
return optsToArgs(gopt)
}
type outlineOptions struct {
DumpDefaultTocXsl boolOption // Dump the default TOC xsl style sheet to stdout
DumpOutline stringOption // Dump the outline to a file
NoOutline boolOption // Do not put an outline into the pdf
OutlineDepth uintOption // Set the depth of the outline (default 4)
}
func (oopt *outlineOptions) Args() []string {
return optsToArgs(oopt)
}
type pageOptions struct {
Allow sliceOption // Allow the file or files from the specified folder to be loaded (repeatable)
BypassProxyFor sliceOption // Bypass proxy for host
CacheDir stringOption // Web cache directory
CheckboxCheckedSvg stringOption // Use this SVG file when rendering checked checkboxes
CheckboxSvg stringOption // Use this SVG file when rendering unchecked checkboxes
Cookie mapOption // Set an additional cookie (repeatable), value should be url encoded
CustomHeader mapOption // Set an additional HTTP header (repeatable)
CustomHeaderPropagation boolOption // Add HTTP headers specified by --custom-header for each resource request
DebugJavascript boolOption // Show javascript debugging output
DefaultHeader boolOption // Add a default header, with the name of the page to the left, and the page number to the right, this is short for: --header-left='[webpage]' --header-right='[page]/[toPage]' --top 2cm --header-line
DisableExternalLinks boolOption // Do not make links to remote web pages
DisableInternalLinks boolOption // Do not make local links
DisableJavascript boolOption // Do not allow web pages to run javascript
DisableLocalFileAccess boolOption // Do not allowed conversion of a local file to read in other local files, unless explicitly allowed with --allow
DisableSmartShrinking boolOption // Disable the intelligent shrinking strategy used by WebKit that makes the pixel/dpi ratio none constant
EnableForms boolOption // Turn HTML form fields into pdf form fields
EnableLocalFileAccess boolOption // Allowed conversion of a local file to read in other local files
EnablePlugins boolOption // Enable installed plugins (plugins will likely not work)
EnableTocBackLinks boolOption // Link from section header to toc
Encoding stringOption // Set the default text encoding, for input
ExcludeFromOutline boolOption // Do not include the page in the table of contents and outlines
JavascriptDelay uintOption // Wait some milliseconds for javascript finish (default 200)
KeepRelativeLinks boolOption // Keep relative external links as relative external links
LoadErrorHandling stringOption // Specify how to handle pages that fail to load: abort, ignore or skip (default abort)
LoadMediaErrorHandling stringOption // Specify how to handle media files that fail to load: abort, ignore or skip (default ignore)
MinimumFontSize uintOption // Minimum font size
NoBackground boolOption // Do not print background
NoCustomHeaderPropagation boolOption // Do not add HTTP headers specified by --custom-header for each resource request
NoImages boolOption // Do not load or print images
NoStopSlowScripts boolOption // Do not Stop slow running javascripts
PageOffset uintOption // Set the starting page number (default 0)
Password stringOption // HTTP Authentication password
Post mapOption // Add an additional post field (repeatable)
PostFile mapOption // Post an additional file (repeatable)
PrintMediaType boolOption // Use print media-type instead of screen
Proxy stringOption // Use a proxy
ProxyHostnameLookup boolOption // Use the proxy for resolving hostnames
RadiobuttonCheckedSvg stringOption // Use this SVG file when rendering checked radiobuttons
RadiobuttonSvg stringOption // Use this SVG file when rendering unchecked radiobuttons
RunScript sliceOption // Run this additional javascript after the page is done loading (repeatable)
SslCrtPath stringOption // Path to the ssl client cert public key in OpenSSL PEM format, optionally followed by intermediate ca and trusted certs
SslKeyPassword stringOption // Password to ssl client cert private key
SslKeyPath stringOption // Path to ssl client cert private key in OpenSSL PEM format
Username stringOption // HTTP Authentication username
UserStyleSheet stringOption // Specify a user style sheet, to load with every page
ViewportSize stringOption // Set viewport size if you have custom scrollbars or css attribute overflow to emulate window size
WindowStatus stringOption // Wait until window.status is equal to this string before rendering page
Zoom floatOption // Use this zoom factor (default 1)
}
func (popt *pageOptions) Args() []string {
return optsToArgs(popt)
}
type headerAndFooterOptions struct {
FooterCenter stringOption // Centered footer text
FooterFontName stringOption // Set footer font name (default Arial)
FooterFontSize uintOption // Set footer font size (default 12)
FooterHTML stringOption // Adds a html footer
FooterLeft stringOption // Left aligned footer text
FooterLine boolOption // Display line above the footer
FooterRight stringOption // Right aligned footer text
FooterSpacing floatOption // Spacing between footer and content in mm (default 0)
HeaderCenter stringOption // Centered header text
HeaderFontName stringOption // Set header font name (default Arial)
HeaderFontSize uintOption // Set header font size (default 12)
HeaderHTML stringOption // Adds a html header
HeaderLeft stringOption // Left aligned header text
HeaderLine boolOption // Display line below the header
HeaderRight stringOption // Right aligned header text
HeaderSpacing floatOption // Spacing between header and content in mm (default 0)
Replace mapOption // Replace [name] with value in header and footer (repeatable)
}
func (hopt *headerAndFooterOptions) Args() []string {
return optsToArgs(hopt)
}
type tocOptions struct {
DisableDottedLines boolOption // Do not use dotted lines in the toc
DisableTocLinks boolOption // Do not link from toc to sections
TocHeaderText stringOption // The header text of the toc (default Table of Contents)
TocLevelIndentation uintOption // For each level of headings in the toc indent by this length (default 1em)
TocTextSizeShrink floatOption // For each level of headings in the toc the font is scaled by this factor
XslStyleSheet stringOption // Use the supplied xsl style sheet for printing the table of content
}
func (topt *tocOptions) Args() []string {
return optsToArgs(topt)
}
type argParser interface {
Parse() []string // Used in the cmd call
}
type stringOption struct {
option string
value string
}
func (so stringOption) Parse() []string {
args := make([]string, 0)
if so.value == "" {
return args
}
args = append(args, opt+so.option)
args = append(args, so.value)
return args
}
func (so *stringOption) Set(value string) {
so.value = value
}
func (so *stringOption) Unset() {
so.value = ""
}
type sliceOption struct {
option string
value []string
}
func (so sliceOption) Parse() []string {
args := make([]string, 0)
if len(so.value) == 0 {
return args
}
for _, v := range so.value {
args = append(args, opt+so.option)
args = append(args, v)
}
return args
}
func (so *sliceOption) Set(value string) {
so.value = append(so.value, value)
}
func (so *sliceOption) Unset() {
so.value = nil
}
type mapOption struct {
option string
value map[string]string
}
func (mo mapOption) Parse() []string {
args := make([]string, 0)
if mo.value == nil || len(mo.value) == 0 {
return args
}
for k, v := range mo.value {
args = append(args, opt+mo.option)
args = append(args, k)
args = append(args, v)
}
return args
}
func (mo *mapOption) Set(key, value string) {
if mo.value == nil {
mo.value = make(map[string]string)
}
mo.value[key] = value
}
func (mo *mapOption) Unset() {
mo.value = nil
}
type uintOption struct {
option string
value uint
isSet bool
}
func (io uintOption) Parse() []string {
args := make([]string, 0)
if io.isSet == false {
return args
}
args = append(args, opt+io.option)
args = append(args, fmt.Sprintf("%d", io.value))
return args
}
func (io *uintOption) Set(value uint) {
io.isSet = true
io.value = value
}
func (io *uintOption) Unset() {
io.isSet = false
}
type floatOption struct {
option string
value float64
isSet bool
}
func (fo floatOption) Parse() []string {
args := make([]string, 0)
if fo.isSet == false {
return args
}
args = append(args, opt+fo.option)
args = append(args, fmt.Sprintf("%.3f", fo.value))
return args
}
func (fo *floatOption) Set(value float64) {
fo.isSet = true
fo.value = value
}
func (fo *floatOption) Unset() {
fo.isSet = false
}
type boolOption struct {
option string
value bool
}
func (bo boolOption) Parse() []string {
if bo.value {
return []string{opt + bo.option}
}
return []string{}
}
func (bo *boolOption) Set(value bool) {
bo.value = value
}
func (bo *boolOption) Unset() {
bo.value = false
}
func newGlobalOptions() globalOptions {
return globalOptions{
CookieJar: stringOption{option: "cookie-jar"},
Copies: uintOption{option: "copies"},
Dpi: uintOption{option: "dpi"},
ExtendedHelp: boolOption{option: "extended-help"},
Grayscale: boolOption{option: "grayscale"},
Help: boolOption{option: "help"},
HTMLDoc: boolOption{option: "htmldoc"},
ImageDpi: uintOption{option: "image-dpi"},
ImageQuality: uintOption{option: "image-quality"},
License: boolOption{option: "license"},
LogLevel: stringOption{option: "log-level"},
LowQuality: boolOption{option: "lowquality"},
ManPage: boolOption{option: "manpage"},
MarginBottom: uintOption{option: "margin-bottom"},
MarginBottomUnit: stringOption{option: "margin-bottom"},
MarginLeft: uintOption{option: "margin-left"},
MarginLeftUnit: stringOption{option: "margin-left"},
MarginRight: uintOption{option: "margin-right"},
MarginRightUnit: stringOption{option: "margin-right"},
MarginTop: uintOption{option: "margin-top"},
MarginTopUnit: stringOption{option: "margin-top"},
NoCollate: boolOption{option: "no-collate"},
NoPdfCompression: boolOption{option: "no-pdf-compression"},
Orientation: stringOption{option: "orientation"},
PageHeight: uintOption{option: "page-height"},
PageHeightUnit: stringOption{option: "page-height"},
PageSize: stringOption{option: "page-size"},
PageWidth: uintOption{option: "page-width"},
PageWidthUnit: stringOption{option: "page-width"},
Quiet: boolOption{option: "quiet"},
ReadArgsFromStdin: boolOption{option: "read-args-from-stdin"},
Readme: boolOption{option: "readme"},
Title: stringOption{option: "title"},
Version: boolOption{option: "version"},
}
}
func newOutlineOptions() outlineOptions {
return outlineOptions{
DumpDefaultTocXsl: boolOption{option: "dump-default-toc-xsl"},
DumpOutline: stringOption{option: "dump-outline"},
NoOutline: boolOption{option: "no-outline"},
OutlineDepth: uintOption{option: "outline-depth"},
}
}
func newPageOptions() pageOptions {
return pageOptions{
Allow: sliceOption{option: "allow"},
BypassProxyFor: sliceOption{option: "bypass-proxy-for"},
CacheDir: stringOption{option: "cache-dir"},
CheckboxCheckedSvg: stringOption{option: "checkbox-checked-svg"},
CheckboxSvg: stringOption{option: "checkbox-svg"},
Cookie: mapOption{option: "cookie"},
CustomHeader: mapOption{option: "custom-header"},
CustomHeaderPropagation: boolOption{option: "custom-header-propagation"},
DebugJavascript: boolOption{option: "debug-javascript"},
DefaultHeader: boolOption{option: "default-header"},
DisableExternalLinks: boolOption{option: "disable-external-links"},
DisableInternalLinks: boolOption{option: "disable-internal-links"},
DisableJavascript: boolOption{option: "disable-javascript"},
DisableLocalFileAccess: boolOption{option: "disable-local-file-access"},
DisableSmartShrinking: boolOption{option: "disable-smart-shrinking"},
EnableForms: boolOption{option: "enable-forms"},
EnableLocalFileAccess: boolOption{option: "enable-local-file-access"},
EnablePlugins: boolOption{option: "enable-plugins"},
EnableTocBackLinks: boolOption{option: "enable-toc-back-links"},
Encoding: stringOption{option: "encoding"},
ExcludeFromOutline: boolOption{option: "exclude-from-outline"},
JavascriptDelay: uintOption{option: "javascript-delay"},
KeepRelativeLinks: boolOption{option: "keep-relative-links"},
LoadErrorHandling: stringOption{option: "load-error-handling"},
LoadMediaErrorHandling: stringOption{option: "load-media-error-handling"},
MinimumFontSize: uintOption{option: "minimum-font-size"},
NoBackground: boolOption{option: "no-background"},
NoCustomHeaderPropagation: boolOption{option: "no-custom-header-propagation"},
NoImages: boolOption{option: "no-images"},
NoStopSlowScripts: boolOption{option: "no-stop-slow-scripts"},
PageOffset: uintOption{option: "page-offset"},
Password: stringOption{option: "password"},
Post: mapOption{option: "post"},
PostFile: mapOption{option: "post-file"},
PrintMediaType: boolOption{option: "print-media-type"},
Proxy: stringOption{option: "proxy"},
ProxyHostnameLookup: boolOption{option: "proxy-hostname-lookup"},
RadiobuttonCheckedSvg: stringOption{option: "radiobutton-checked-svg"},
RadiobuttonSvg: stringOption{option: "radiobutton-svg"},
RunScript: sliceOption{option: "run-script"},
SslCrtPath: stringOption{option: "ssl-crt-path"},
SslKeyPassword: stringOption{option: "ssl-key-password"},
SslKeyPath: stringOption{option: "ssl-key-path"},
Username: stringOption{option: "username"},
UserStyleSheet: stringOption{option: "user-style-sheet"},
ViewportSize: stringOption{option: "viewport-size"},
WindowStatus: stringOption{option: "window-status"},
Zoom: floatOption{option: "zoom"},
}
}
func newHeaderAndFooterOptions() headerAndFooterOptions {
return headerAndFooterOptions{
FooterCenter: stringOption{option: "footer-center"},
FooterFontName: stringOption{option: "footer-font-name"},
FooterFontSize: uintOption{option: "footer-font-size"},
FooterHTML: stringOption{option: "footer-html"},
FooterLeft: stringOption{option: "footer-left"},
FooterLine: boolOption{option: "footer-line"},
FooterRight: stringOption{option: "footer-right"},
FooterSpacing: floatOption{option: "footer-spacing"},
HeaderCenter: stringOption{option: "header-center"},
HeaderFontName: stringOption{option: "header-font-name"},
HeaderFontSize: uintOption{option: "header-font-size"},
HeaderHTML: stringOption{option: "header-html"},
HeaderLeft: stringOption{option: "header-left"},
HeaderLine: boolOption{option: "header-line"},
HeaderRight: stringOption{option: "header-right"},
HeaderSpacing: floatOption{option: "header-spacing"},
Replace: mapOption{option: "replace"},
}
}
func newTocOptions() tocOptions {
return tocOptions{
DisableDottedLines: boolOption{option: "disable-dotted-lines"},
DisableTocLinks: boolOption{option: "disable-toc-links"},
TocHeaderText: stringOption{option: "toc-header-text"},
TocLevelIndentation: uintOption{option: "toc-level-indentation"},
TocTextSizeShrink: floatOption{option: "toc-text-size-shrink"},
XslStyleSheet: stringOption{option: "xsl-style-sheet"},
}
}
func optsToArgs(opts interface{}) []string {
args := make([]string, 0)
rv := reflect.Indirect(reflect.ValueOf(opts))
if rv.Kind() != reflect.Struct {
return args
}
for i := 0; i < rv.NumField(); i++ {
prsr, ok := rv.Field(i).Interface().(argParser)
if ok {
s := prsr.Parse()
if len(s) > 0 {
args = append(args, s...)
}
}
}
return args
}
// Constants for orientation modes
const (
OrientationLandscape = "Landscape" // Landscape mode
OrientationPortrait = "Portrait" // Portrait mode
)
// Constants for page sizes
const (
PageSizeA0 = "A0" // 841 x 1189 mm
PageSizeA1 = "A1" // 594 x 841 mm
PageSizeA2 = "A2" // 420 x 594 mm
PageSizeA3 = "A3" // 297 x 420 mm
PageSizeA4 = "A4" // 210 x 297 mm, 8.26
PageSizeA5 = "A5" // 148 x 210 mm
PageSizeA6 = "A6" // 105 x 148 mm
PageSizeA7 = "A7" // 74 x 105 mm
PageSizeA8 = "A8" // 52 x 74 mm
PageSizeA9 = "A9" // 37 x 52 mm
PageSizeB0 = "B0" // 1000 x 1414 mm
PageSizeB1 = "B1" // 707 x 1000 mm
PageSizeB10 = "B10" // 31 x 44 mm
PageSizeB2 = "B2" // 500 x 707 mm
PageSizeB3 = "B3" // 353 x 500 mm
PageSizeB4 = "B4" // 250 x 353 mm
PageSizeB5 = "B5" // 176 x 250 mm, 6.93
PageSizeB6 = "B6" // 125 x 176 mm
PageSizeB7 = "B7" // 88 x 125 mm
PageSizeB8 = "B8" // 62 x 88 mm
PageSizeB9 = "B9" // 33 x 62 mm
PageSizeC5E = "C5E" // 163 x 229 mm
PageSizeComm10E = "Comm10E" // 105 x 241 mm, U.S. Common 10 Envelope
PageSizeCustom = "Custom" // Unknown, or a user defined size.
PageSizeDLE = "DLE" // 110 x 220 mm
PageSizeExecutive = "Executive" // 7.5 x 10 inches, 190.5 x 254 mm
PageSizeFolio = "Folio" // 210 x 330 mm
PageSizeLedger = "Ledger" // 431.8 x 279.4 mm
PageSizeLegal = "Legal" // 8.5 x 14 inches, 215.9 x 355.6 mm
PageSizeLetter = "Letter" // 8.5 x 11 inches, 215.9 x 279.4 mm
PageSizeTabloid = "Tabloid" // 279.4 x 431.8 mm
)