Coverage Report

Created: 2025-11-16 07:40

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/ghostpdl/pdf/pdf_annot.c
Line
Count
Source
1
/* Copyright (C) 2019-2025 Artifex Software, Inc.
2
   All Rights Reserved.
3
4
   This software is provided AS-IS with no warranty, either express or
5
   implied.
6
7
   This software is distributed under license and may not be copied,
8
   modified or distributed except as expressly authorized under the terms
9
   of the license contained in the file LICENSE in this distribution.
10
11
   Refer to licensing information at http://www.artifex.com or contact
12
   Artifex Software, Inc.,  39 Mesa Street, Suite 108A, San Francisco,
13
   CA 94129, USA, for further information.
14
*/
15
16
/* Annotation handling for the PDF interpreter */
17
18
#include "pdf_int.h"
19
#include "pdf_stack.h"
20
#include "pdf_annot.h"
21
#include "pdf_file.h"
22
#include "pdf_dict.h"
23
#include "pdf_array.h"
24
#include "pdf_loop_detect.h"
25
#include "pdf_colour.h"
26
#include "pdf_trans.h"
27
#include "pdf_font_types.h"
28
#include "pdf_gstate.h"
29
#include "pdf_misc.h"
30
#include "pdf_optcontent.h"
31
#include "pdf_annot.h"
32
#include "pdf_colour.h"
33
#include "pdf_deref.h"
34
#include "pdf_image.h"
35
#include "pdf_mark.h"
36
#include "pdf_font.h"
37
#include "pdf_text.h"
38
39
#include "gspath2.h"
40
#include "gxfarith.h"
41
#include "gxdevsop.h"               /* For special ops */
42
#include "gsstrtok.h"               /* For gs_strtok */
43
#include "gscoord.h"        /* for gs_concat() and others */
44
#include "gsline.h"         /* For gs_setlinejoin() and friends */
45
#include "gsutil.h"        /* For gs_next_ids() */
46
#include "gspaint.h"        /* For gs_fill() and friends */
47
48
/* Detect if there is a BOM at beginning of string */
49
206
#define IS_UTF8(str) (!strcmp((char *)(str), "\xef\xbb\xbf"))
50
52.8k
#define IS_UTF16(str) (!strcmp((char *)(str), "\xfe\xff"))
51
52
typedef int (*annot_func)(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done);
53
54
typedef struct {
55
    const char *subtype;
56
    annot_func func;
57
    bool simpleAP; /* Just Render AP if it exists? (false means more complicated) */
58
} annot_dispatch_t;
59
60
61
typedef int (*annot_LE_func)(pdf_context *ctx, pdf_dict *annot);
62
63
typedef struct {
64
    const char *name;
65
    annot_LE_func func;
66
} annot_LE_dispatch_t;
67
68
typedef int (*annot_preserve_func)(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype);
69
70
typedef struct {
71
    const char *subtype;
72
    annot_preserve_func func;
73
} annot_preserve_dispatch_t;
74
75
static int pdfi_annot_start_transparency(pdf_context *ctx, pdf_dict *annot)
76
9.17k
{
77
9.17k
    int code;
78
79
9.17k
    if (!ctx->page.has_transparency)
80
3.59k
        return 0;
81
82
    /* TODO: ps code does something with /BM which is apparently the Blend Mode,
83
     * but I am not sure that the value is actually used properly.  Look into it.
84
     * (see pdf_draw.ps/startannottransparency)
85
     */
86
5.58k
    code = gs_clippath(ctx->pgs);
87
5.58k
    if (code < 0)
88
0
        return code;
89
5.58k
    code = pdfi_trans_begin_simple_group(ctx, NULL, false, false, false);
90
5.58k
    (void)gs_newpath(ctx->pgs);
91
5.58k
    return code;
92
5.58k
}
93
94
static int pdfi_annot_end_transparency(pdf_context *ctx, pdf_dict *annot)
95
9.16k
{
96
9.16k
    if (!ctx->page.has_transparency)
97
3.59k
        return 0;
98
99
5.57k
    return pdfi_trans_end_simple_group(ctx);
100
9.16k
}
101
102
/* Get width from BS, if it exists
103
 * Default to 1.0 if not
104
 */
105
static int pdfi_annot_get_BS_width(pdf_context *ctx, pdf_dict *annot, double *width)
106
503
{
107
503
    int code;
108
503
    pdf_dict *BS = NULL;
109
110
503
    *width = 1.0;
111
112
503
    code = pdfi_dict_knownget_type(ctx, annot, "BS", PDF_DICT, (pdf_obj **)&BS);
113
503
    if (code <= 0)
114
0
        goto exit;
115
116
503
    code = pdfi_dict_knownget_number(ctx, BS, "W", width);
117
118
503
 exit:
119
503
    pdfi_countdown(BS);
120
503
    return code;
121
503
}
122
123
/* Set both stroke opacity and fill opacity to either CA or ca
124
 * For annotations, the one value seems to control both.
125
 */
126
static int pdfi_annot_opacity(pdf_context *ctx, pdf_dict *annot)
127
1.40k
{
128
1.40k
    int code = 0;
129
1.40k
    double CA;
130
131
    /* CA -- opacity */
132
1.40k
    code = pdfi_dict_knownget_number(ctx, annot, "CA", &CA);
133
1.40k
    if (code > 0) {
134
663
        code = gs_setstrokeconstantalpha(ctx->pgs, CA);
135
663
        if (code < 0) goto exit;
136
663
        code = gs_setfillconstantalpha(ctx->pgs, CA);
137
663
        goto exit;
138
663
    }
139
    /* If CA not found, we also check for 'ca' even though it's not in the spec */
140
743
    code = pdfi_dict_knownget_number(ctx, annot, "ca", &CA);
141
743
    if (code > 0) {
142
0
        code = gs_setstrokeconstantalpha(ctx->pgs, CA);
143
0
        if (code < 0) goto exit;
144
0
        code = gs_setfillconstantalpha(ctx->pgs, CA);
145
0
    }
146
1.40k
 exit:
147
1.40k
    return code;
148
743
}
149
150
/* Apply RD to provided rect */
151
static int pdfi_annot_applyRD(pdf_context *ctx, pdf_dict *annot, gs_rect *rect)
152
2.66k
{
153
2.66k
    int code;
154
2.66k
    pdf_array *RD = NULL;
155
2.66k
    gs_rect rd;
156
157
2.66k
    code = pdfi_dict_knownget_type(ctx, annot, "RD", PDF_ARRAY, (pdf_obj **)&RD);
158
2.66k
    if (code <= 0) goto exit;
159
160
11
    code = pdfi_array_to_gs_rect(ctx, RD, &rd);
161
11
    if (code < 0) goto exit;
162
163
11
    rect->p.x += rd.p.x;
164
11
    rect->p.y += rd.p.y;
165
11
    rect->q.x -= rd.q.x;
166
11
    rect->q.y -= rd.q.y;
167
168
2.66k
 exit:
169
2.66k
    pdfi_countdown(RD);
170
2.66k
    return code;
171
11
}
172
173
static int pdfi_annot_Rect(pdf_context *ctx, pdf_dict *annot, gs_rect *rect)
174
348k
{
175
348k
    int code;
176
348k
    pdf_array *Rect = NULL;
177
178
348k
    code = pdfi_dict_knownget_type(ctx, annot, "Rect", PDF_ARRAY, (pdf_obj **)&Rect);
179
348k
    if (code < 0) goto exit;
180
181
348k
    code = pdfi_array_to_gs_rect(ctx, Rect, rect);
182
348k
    if (code < 0) goto exit;
183
184
347k
    pdfi_normalize_rect(ctx, rect);
185
186
348k
 exit:
187
348k
    pdfi_countdown(Rect);
188
348k
    return code;
189
347k
}
190
191
static int pdfi_annot_position_AP(pdf_context *ctx, pdf_dict *annot, pdf_stream *AP)
192
220k
{
193
220k
    int code = 0;
194
220k
    gs_rect rect;
195
220k
    pdf_array *BBox = NULL;
196
220k
    gs_rect bbox;
197
220k
    pdf_array *Matrix = NULL;
198
220k
    gs_matrix matrix;
199
220k
    double xscale, yscale;
200
220k
    pdf_dict *Annot_dict;
201
202
220k
    code = pdfi_dict_from_obj(ctx, (pdf_obj *)AP, &Annot_dict);
203
220k
    if (code < 0)
204
0
        return code;
205
206
    /* TODO: graphicsbeginpage, textbeginpage
207
     * These should match what was done at the beginning of the page,
208
     * but current implementation has things kind of mixed around.
209
     * Need to figure out exactly what to do.  I'd like it to be one
210
     * function in both places.
211
     * see pdfi_page_render()
212
     */
213
    /* graphicsbeginpage() */
214
    /* textbeginpage() */
215
    /* code = gs_initgraphics(ctx->pgs); */
216
220k
    ctx->text.BlockDepth = 0;
217
    /* TODO: FIXME */
218
219
220k
    code = pdfi_annot_Rect(ctx, annot, &rect);
220
220k
    if (code < 0) goto exit;
221
222
220k
    code = pdfi_dict_knownget_type(ctx, Annot_dict, "BBox", PDF_ARRAY, (pdf_obj **)&BBox);
223
220k
    if (code < 0) goto exit;
224
220k
    code = pdfi_array_to_gs_rect(ctx, BBox, &bbox);
225
220k
    if (code < 0) goto exit;
226
227
220k
    if (bbox.q.x - bbox.p.x == 0.0 || bbox.q.y - bbox.p.y == 0.0) {
228
        /* If the Bounding Box has 0 width or height, then the scaling calculation below will
229
         * end up with a division by zero, causing the CTM to go infinite.
230
         * We handle the broken BBox elsewhere, so for now just discard it, preventing
231
         * us breaking the CTM.
232
         */
233
309
        pdfi_countdown(BBox);
234
309
        BBox = NULL;
235
309
    }
236
237
220k
    code = pdfi_dict_knownget_type(ctx, Annot_dict, "Matrix", PDF_ARRAY, (pdf_obj **)&Matrix);
238
220k
    if (code < 0) goto exit;
239
220k
    code = pdfi_array_to_gs_matrix(ctx, Matrix, &matrix);
240
220k
    if (code < 0) goto exit;
241
242
220k
    xscale = yscale = 1.0;
243
244
220k
    code = gs_translate(ctx->pgs, rect.p.x, rect.p.y);
245
220k
    if (code < 0) goto exit;
246
247
220k
    if (BBox != NULL) {
248
219k
        pdfi_bbox_transform(ctx, &bbox, &matrix);
249
250
        /* Calculate scale factor */
251
219k
        xscale = (rect.q.x - rect.p.x) / (bbox.q.x - bbox.p.x);
252
219k
        yscale = (rect.q.y - rect.p.y) / (bbox.q.y - bbox.p.y);
253
254
219k
        if (xscale * yscale <= 0) {
255
0
            code = pdfi_set_warning_stop(ctx, gs_note_error(gs_error_rangecheck), NULL, W_PDF_ZEROSCALE_ANNOT, "pdfi_annot_position_AP", "ANNOT: Ignoring annotation with scale factor of 0\n");
256
0
            goto exit;
257
0
        }
258
259
        /* Scale it */
260
219k
        code = gs_scale(ctx->pgs, xscale, yscale);
261
219k
        if (code < 0) goto exit;
262
263
        /* Compensate for non-zero origin of BBox */
264
219k
        code = gs_translate(ctx->pgs, -bbox.p.x, -bbox.p.y);
265
219k
        if (code < 0) goto exit;
266
219k
    }
267
268
220k
 exit:
269
220k
    pdfi_countdown(BBox);
270
220k
    pdfi_countdown(Matrix);
271
220k
    return code;
272
220k
}
273
274
/* See pdf_draw.ps/drawwidget (draws the AP for any type of thingy) */
275
static int pdfi_annot_draw_AP(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP)
276
225k
{
277
225k
    int code = 0;
278
279
225k
    if (NormAP == NULL)
280
4.03k
        return 0;
281
221k
    if (pdfi_type_of(NormAP) == PDF_NULL)
282
17.1k
        return 0;
283
204k
    if (pdfi_type_of(NormAP) != PDF_STREAM)
284
0
        return pdfi_set_error_stop(ctx, gs_note_error(gs_error_typecheck), NULL, E_PDF_BAD_ANNOTATION, "pdfi_annot_draw_AP", "");
285
286
204k
    code = pdfi_op_q(ctx);
287
204k
    if (code < 0)
288
0
        return code;
289
290
204k
    code = pdfi_annot_position_AP(ctx, annot, (pdf_stream *)NormAP);
291
204k
    if (code < 0)
292
342
        goto exit;
293
294
    /* Render the annotation */
295
203k
    code = pdfi_do_image_or_form(ctx, NULL, ctx->page.CurrentPageDict, NormAP);
296
297
204k
exit:
298
204k
    (void)pdfi_op_Q(ctx);
299
204k
    return code;
300
203k
}
301
302
static int pdfi_annot_setcolor_key(pdf_context *ctx, pdf_dict *annot, const char *key,
303
                                   bool usedefault, bool *drawit)
304
142k
{
305
142k
    int code = 0;
306
142k
    pdf_array *C = NULL;
307
308
142k
    *drawit = true;
309
310
142k
    code = pdfi_dict_knownget_type(ctx, annot, key, PDF_ARRAY, (pdf_obj **)&C);
311
142k
    if (code < 0) goto exit;
312
313
142k
    if (code == 0) {
314
134k
        if (usedefault)
315
3.64k
            code = pdfi_gs_setgray(ctx, 0);
316
130k
        else
317
130k
            *drawit = false;
318
134k
    } else {
319
8.61k
        if (pdfi_array_size(C) == 0) {
320
19
            code = 0;
321
19
            *drawit = false;
322
8.59k
        } else {
323
8.59k
            code = pdfi_setcolor_from_array(ctx, C);
324
8.59k
        }
325
8.61k
    }
326
327
142k
 exit:
328
142k
    if (code < 0)
329
46
        *drawit = false;
330
142k
    pdfi_countdown(C);
331
142k
    return code;
332
142k
}
333
334
static int pdfi_annot_setinteriorcolor(pdf_context *ctx, pdf_dict *annot, bool usedefault, bool *drawit)
335
939
{
336
939
    return pdfi_annot_setcolor_key(ctx, annot, "IC", usedefault, drawit);
337
939
}
338
339
static int pdfi_annot_setcolor(pdf_context *ctx, pdf_dict *annot, bool usedefault, bool *drawit)
340
11.1k
{
341
11.1k
    return pdfi_annot_setcolor_key(ctx, annot, "C", usedefault, drawit);
342
11.1k
}
343
344
/* Stroke border using current path */
345
static int pdfi_annot_strokeborderpath(pdf_context *ctx, pdf_dict *annot, double width, pdf_array *dash)
346
2.51k
{
347
2.51k
    int code = 0;
348
349
2.51k
    if (width <= 0)
350
0
        return 0;
351
352
2.51k
    code = pdfi_setdash_impl(ctx, dash, 0);
353
2.51k
    if (code < 0) goto exit;
354
2.51k
    code = gs_setlinewidth(ctx->pgs, width);
355
2.51k
    if (code < 0) goto exit;
356
357
2.51k
    code = gs_stroke(ctx->pgs);
358
359
2.51k
 exit:
360
2.51k
    return code;
361
2.51k
}
362
363
/* Fill border path */
364
static int pdfi_annot_fillborderpath(pdf_context *ctx, pdf_dict *annot)
365
764
{
366
764
    int code;
367
764
    bool drawit;
368
369
764
    code = pdfi_gsave(ctx);
370
764
    if (code < 0) return code;
371
372
764
    code = pdfi_annot_opacity(ctx, annot);
373
764
    if (code < 0) goto exit;
374
764
    code = pdfi_annot_setinteriorcolor(ctx, annot, false, &drawit);
375
764
    if (code < 0) goto exit;
376
759
    if (drawit)
377
602
        code = gs_fill(ctx->pgs);
378
379
764
 exit:
380
764
    (void)pdfi_grestore(ctx);
381
764
    return code;
382
759
}
383
384
385
/* Draw a path from a rectangle */
386
static int pdfi_annot_rect_path(pdf_context *ctx, gs_rect *rect)
387
97
{
388
97
    int code;
389
390
97
    code = gs_moveto(ctx->pgs, rect->p.x, rect->p.y);
391
97
    if (code < 0) goto exit;
392
97
    code = gs_lineto(ctx->pgs, rect->q.x, rect->p.y);
393
97
    if (code < 0) goto exit;
394
97
    code = gs_lineto(ctx->pgs, rect->q.x, rect->q.y);
395
97
    if (code < 0) goto exit;
396
97
    code = gs_lineto(ctx->pgs, rect->p.x, rect->q.y);
397
97
    if (code < 0) goto exit;
398
97
    code = gs_closepath(ctx->pgs);
399
400
97
 exit:
401
97
    return code;
402
97
}
403
404
/* Make a rectangle path from Rect (see /re, /normal_re in pdf_ops.ps)
405
 * See also /Square
406
 * Not sure if I have to worry about the /inside_text_re here
407
 */
408
static int pdfi_annot_RectRD_path(pdf_context *ctx, pdf_dict *annot)
409
97
{
410
97
    gs_rect rect;
411
97
    int code;
412
413
97
    code = pdfi_annot_Rect(ctx, annot, &rect);
414
97
    if (code < 0) goto exit;
415
416
97
    code = pdfi_annot_applyRD(ctx, annot, &rect);
417
97
    if (code < 0) goto exit;
418
419
97
    code = pdfi_annot_rect_path(ctx, &rect);
420
421
97
 exit:
422
97
    return code;
423
97
}
424
425
/* Adjust rectangle by specified width */
426
static void pdfi_annot_rect_adjust(pdf_context *ctx, gs_rect *rect, double width)
427
2.16k
{
428
2.16k
    rect->p.x += width;
429
2.16k
    rect->p.y += width;
430
2.16k
    rect->q.x -= width;
431
2.16k
    rect->q.y -= width;
432
2.16k
}
433
434
/* Fill Rect with current color */
435
static int pdfi_annot_fillRect(pdf_context *ctx, pdf_dict *annot)
436
56
{
437
56
    int code;
438
56
    gs_rect rect;
439
440
56
    code = pdfi_gsave(ctx);
441
56
    if (code < 0) return code;
442
443
56
    code = pdfi_annot_Rect(ctx, annot, &rect);
444
56
    if (code < 0) goto exit;
445
446
56
    code = gs_rectclip(ctx->pgs, &rect, 1);
447
56
    if (code < 0) goto exit;
448
449
56
    code = pdfi_annot_applyRD(ctx, annot, &rect);
450
56
    if (code < 0) goto exit;
451
452
56
    code = gs_rectfill(ctx->pgs, &rect, 1);
453
56
    if (code < 0) goto exit;
454
455
56
 exit:
456
56
    (void)pdfi_grestore(ctx);
457
56
    return code;
458
56
}
459
460
/* Stroke border, drawing path from rect */
461
static int pdfi_annot_strokeborder(pdf_context *ctx, pdf_dict *annot, double width, pdf_array *dash)
462
5.88k
{
463
5.88k
    int code = 0;
464
5.88k
    gs_rect rect;
465
466
5.88k
    if (width <= 0)
467
3.72k
        return 0;
468
469
2.16k
    code = pdfi_gsave(ctx);
470
471
2.16k
    code = pdfi_setdash_impl(ctx, dash, 0);
472
2.16k
    if (code < 0) goto exit;
473
474
2.16k
    code = gs_setlinewidth(ctx->pgs, width);
475
2.16k
    if (code < 0) goto exit;
476
477
2.16k
    code = pdfi_annot_Rect(ctx, annot, &rect);
478
2.16k
    if (code < 0) goto exit;
479
480
2.16k
    code = pdfi_annot_applyRD(ctx, annot, &rect);
481
2.16k
    if (code < 0) goto exit;
482
483
484
    /* Stroke the rectangle */
485
    /* Adjust rectangle by the width */
486
2.16k
    pdfi_annot_rect_adjust(ctx, &rect, width/2);
487
2.16k
    code = gs_rectstroke(ctx->pgs, &rect, 1, NULL);
488
489
2.16k
 exit:
490
2.16k
    (void)pdfi_grestore(ctx);
491
2.16k
    return code;
492
2.16k
}
493
494
/* Draw border from a Border array
495
 * Note: Border can be null
496
 */
497
static int pdfi_annot_draw_Border(pdf_context *ctx, pdf_dict *annot, pdf_array *Border, bool usepath)
498
5.92k
{
499
5.92k
    pdf_array *dash = NULL;
500
5.92k
    int code = 0;
501
5.92k
    uint64_t size = 0;
502
5.92k
    double width = 0;
503
504
5.92k
    if (Border)
505
5.88k
        size = pdfi_array_size(Border);
506
5.92k
    if (Border &&  size < 3) {
507
0
        code = pdfi_set_warning_stop(ctx, gs_note_error(gs_error_rangecheck), NULL, W_PDF_ANNOT_ERROR, "pdfi_annot_draw_Border", "WARNING: Annotation Border array invalid");
508
0
        goto exit;
509
0
    }
510
5.92k
    if (!Border) {
511
47
        code = pdfi_array_alloc(ctx, 0, &dash);
512
47
        if (code < 0) goto exit;
513
47
        pdfi_countup(dash);
514
47
        width = 1;
515
5.88k
    } else {
516
5.88k
        if (size > 3) {
517
2
            code = pdfi_array_get_type(ctx, Border, 3, PDF_ARRAY, (pdf_obj **)&dash);
518
2
            if (code < 0) {
519
2
                if ((code = pdfi_set_warning_stop(ctx, code, NULL, W_PDF_ANNOT_ERROR,
520
2
                                 "pdfi_annot_draw_Border", "WARNING: Annotation Border Dash array invalid")) < 0) {
521
0
                    goto exit;
522
0
                }
523
2
                code = pdfi_array_alloc(ctx, 0, &dash);
524
2
                if (code < 0) goto exit;
525
2
                pdfi_countup(dash);
526
2
            }
527
5.87k
        } else {
528
5.87k
            code = pdfi_array_alloc(ctx, 0, &dash);
529
5.87k
            if (code < 0) goto exit;
530
5.87k
            pdfi_countup(dash);
531
5.87k
        }
532
5.88k
        code = pdfi_array_get_number(ctx, Border, 2, &width);
533
5.88k
        if (code < 0) goto exit;
534
5.88k
    }
535
536
    /* At this point we have a dash array (which could be length 0) and a width */
537
5.92k
    if (usepath)
538
213
        code = pdfi_annot_strokeborderpath(ctx, annot, width, dash);
539
5.71k
    else
540
5.71k
        code = pdfi_annot_strokeborder(ctx, annot, width, dash);
541
542
5.92k
 exit:
543
5.92k
    pdfi_countdown(dash);
544
5.92k
    return code;
545
5.92k
}
546
547
/* Draw border from a BS dict */
548
static int pdfi_annot_draw_BS(pdf_context *ctx, pdf_dict *annot, pdf_dict *BS, bool usepath)
549
2.47k
{
550
2.47k
    double W;
551
2.47k
    int code = 0;
552
2.47k
    pdf_name *S = NULL;
553
2.47k
    pdf_array *dash = NULL;
554
555
    /* Get the width */
556
2.47k
    code = pdfi_dict_knownget_number(ctx, BS, "W", &W);
557
2.47k
    if (code < 0) goto exit;
558
2.47k
    if (code == 0)
559
10
        W = 1; /* Default */
560
561
    /* TODO: Some junk about scaling to UserUnit */
562
    /* ... */
563
564
    /* Lookup border style */
565
2.47k
    code = pdfi_dict_knownget_type(ctx, BS, "S", PDF_NAME, (pdf_obj **)&S);
566
2.47k
    if (code < 0) goto exit;
567
568
2.47k
    if (code > 0 && pdfi_name_is(S, "D")) {
569
        /* Handle Dash array */
570
12
        code = pdfi_dict_knownget_type(ctx, BS, "D", PDF_ARRAY, (pdf_obj **)&dash);
571
12
        if (code < 0) goto exit;
572
573
        /* If there is no Dash array, then create one containing a 3 (the default) */
574
12
        if (code == 0) {
575
12
            code = pdfi_array_alloc(ctx, 1, &dash);
576
12
            if (code < 0) goto exit;
577
12
            pdfi_countup(dash);
578
579
12
            code = pdfi_array_put_int(ctx, dash, 0, 3);
580
12
            if (code < 0) goto exit;
581
12
        }
582
2.46k
    } else {
583
        /* Empty array */
584
2.46k
        code = pdfi_array_alloc(ctx, 0, &dash);
585
2.46k
        if (code < 0) goto exit;
586
2.46k
        pdfi_countup(dash);
587
2.46k
    }
588
589
    /* At this point we have a dash array (which could be length 0) and a width */
590
2.47k
    if (usepath)
591
2.29k
        code = pdfi_annot_strokeborderpath(ctx, annot, W, dash);
592
175
    else
593
175
        code = pdfi_annot_strokeborder(ctx, annot, W, dash);
594
595
2.47k
 exit:
596
2.47k
    pdfi_countdown(S);
597
2.47k
    pdfi_countdown(dash);
598
2.47k
    return code;
599
2.47k
}
600
601
/* Draw the border
602
 * This spec seems to be scattered around.  There might be:
603
 *  /Border -- an array of 3-4 elements, where the optional 4th element is a "dash array"
604
 *   (default value: [0 0 1])
605
 *  /BS -- a Border Style dictionary
606
 *  Spec says /Border would be ignored in favor of /BS
607
 *
608
 * usepath -- indicates whether to stroke existing path, or use Rect to draw a path first
609
 */
610
static int pdfi_annot_draw_border(pdf_context *ctx, pdf_dict *annot, bool usepath)
611
8.41k
{
612
8.41k
    int code, code1;
613
8.41k
    pdf_dict *BS = NULL;
614
8.41k
    pdf_array *Border = NULL;
615
616
8.41k
    code = pdfi_dict_knownget_type(ctx, annot, "BS", PDF_DICT, (pdf_obj **)&BS);
617
8.41k
    if (code < 0) goto exit;
618
8.40k
    code = pdfi_dict_knownget_type(ctx, annot, "Border", PDF_ARRAY, (pdf_obj **)&Border);
619
8.40k
    if (code < 0) goto exit;
620
621
8.40k
    code = pdfi_gsave(ctx);
622
8.40k
    if (code < 0) goto exit;
623
624
8.40k
    if (BS) {
625
2.47k
        code = pdfi_annot_draw_BS(ctx, annot, BS, usepath);
626
5.92k
    } else {
627
        /* Note: Border can be null */
628
5.92k
        code = pdfi_annot_draw_Border(ctx, annot, Border, usepath);
629
5.92k
    }
630
8.40k
    code1 = pdfi_grestore(ctx);
631
8.40k
    if (code == 0) code = code1;
632
633
8.41k
 exit:
634
8.41k
    pdfi_countdown(BS);
635
8.41k
    pdfi_countdown(Border);
636
8.41k
    return code;
637
8.40k
}
638
639
/*********** BEGIN Font/Text ***************/
640
641
/* Set font */
642
static int
643
pdfi_annot_set_font(pdf_context *ctx, const char *font, double size)
644
903
{
645
903
    int code = 0;
646
647
903
    if (font != NULL) {
648
903
        code = pdfi_font_set_internal_string(ctx, font, size);
649
903
        if (code < 0) goto exit;
650
903
    }
651
652
903
 exit:
653
903
    return code;
654
903
}
655
656
/* Get value from a field, or its Parents (recursive)
657
 * If no Parent, will also check ctx->AcroForm
658
 * Returns <0 on error, 0 if not found, >0 if found
659
 */
660
static int pdfi_form_get_inheritable(pdf_context *ctx, pdf_dict *field, const char *Key,
661
                                     pdf_obj_type type, pdf_obj **o)
662
279k
{
663
279k
    int code = 0;
664
279k
    pdf_dict *Parent = NULL;
665
279k
    bool known = false;
666
667
    /* Check this field */
668
279k
    code = pdfi_dict_knownget_type(ctx, field, Key, type, o);
669
279k
    if (code != 0) goto exit1;
670
671
92.3k
    code = pdfi_loop_detector_mark(ctx);
672
92.3k
    if (code < 0)
673
0
        goto exit;
674
675
    /* Check for Parent. Do not store the dereferenced Parent back to the dictionary
676
     * as this can cause circular references.
677
     */
678
92.3k
    code = pdfi_dict_known(ctx, field, "Parent", &known);
679
92.3k
    if (code >= 0 && known == true)
680
65.2k
    {
681
65.2k
        code = pdfi_dict_get_no_store_R(ctx, field, "Parent", (pdf_obj **)&Parent);
682
65.2k
        if (code < 0)
683
10.4k
            goto exit;
684
685
54.8k
        if (pdfi_type_of(Parent) != PDF_DICT) {
686
127
            if (pdfi_type_of(Parent) == PDF_INDIRECT) {
687
0
                pdf_indirect_ref *o = (pdf_indirect_ref *)Parent;
688
689
0
                code = pdfi_dereference(ctx, o->ref_object_num, o->ref_generation_num, (pdf_obj **)&Parent);
690
0
                pdfi_countdown(o);
691
0
                goto exit;
692
127
            } else {
693
127
                code = gs_note_error(gs_error_typecheck);
694
127
                goto exit;
695
127
            }
696
127
        }
697
54.7k
        code = pdfi_form_get_inheritable(ctx, Parent, Key, type, o);
698
54.7k
        if (code <= 0) {
699
54.6k
            if (ctx->AcroForm)
700
54.3k
                code = pdfi_dict_knownget_type(ctx, ctx->AcroForm, Key, type, o);
701
54.6k
        }
702
54.7k
    } else {
703
        /* No Parent, so check AcroForm, if any */
704
27.0k
        if (ctx->AcroForm)
705
26.6k
            code = pdfi_dict_knownget_type(ctx, ctx->AcroForm, Key, type, o);
706
27.0k
    }
707
708
92.3k
exit:
709
92.3k
    (void)pdfi_loop_detector_cleartomark(ctx);
710
711
279k
exit1:
712
279k
    pdfi_countdown(Parent);
713
279k
    return code;
714
92.3k
}
715
716
/* Get int value from a field, or its Parents (recursive)
717
 * Returns <0 on error, 0 if not found, >0 if found
718
 */
719
static int pdfi_form_get_inheritable_int(pdf_context *ctx, pdf_dict *field, const char *Key,
720
                                         int64_t *val)
721
165k
{
722
165k
    int code = 0;
723
165k
    pdf_num *num = NULL;
724
725
165k
    *val = 0;
726
165k
    code = pdfi_form_get_inheritable(ctx, field, Key, PDF_INT, (pdf_obj **)&num);
727
165k
    if (code < 0) goto exit;
728
729
155k
    if (code > 0)
730
128k
        *val = num->value.i;
731
732
165k
 exit:
733
165k
    pdfi_countdown(num);
734
165k
    return code;
735
155k
}
736
737
/* Scan DA to see if font size is 0, if so make a new DA with font size scaled by gs_rect */
738
static int pdfi_form_modDA(pdf_context *ctx, pdf_string *DA, pdf_string **mod_DA, gs_rect *rect)
739
58.8k
{
740
58.8k
    char *token, *prev_token;
741
58.8k
    char *parse_str = NULL;
742
58.8k
    bool did_mod = false;
743
58.8k
    int code = 0;
744
58.8k
    double size;
745
58.8k
    char size_str[20];
746
58.8k
    char *last;
747
58.8k
    pdf_string *newDA = NULL;
748
749
    /* Make a copy of the string because we are going to destructively parse it */
750
58.8k
    parse_str = (char *)gs_alloc_bytes(ctx->memory, (size_t)DA->length+1, "pdfi_annot_display_text(strbuf)");
751
58.8k
    if (parse_str == NULL) {
752
0
        code = gs_note_error(gs_error_VMerror);
753
0
        goto exit;
754
0
    }
755
58.8k
    memcpy(parse_str, DA->data, DA->length);
756
58.8k
    parse_str[DA->length] = 0; /* Null terminate */
757
758
    /* find the 'Tf' token, if any */
759
58.8k
    token = gs_strtok(parse_str, " ", &last);
760
58.8k
    prev_token = NULL;
761
176k
    while (token != NULL) {
762
176k
        if (!strcmp(token, "Tf"))
763
58.7k
            break;
764
117k
        prev_token = token;
765
117k
        token = gs_strtok(NULL, " ", &last);
766
117k
    }
767
768
    /* See if we found it */
769
58.8k
    if (!token)
770
71
        goto exit;
771
772
    /* See if there was a prev_token and it was "0" */
773
58.7k
    if (!(prev_token && !strcmp(prev_token, "0")))
774
58.7k
        goto exit;
775
776
    /* Case with '<font> 0 Tf', need to calculate correct size */
777
21
    size = (rect->q.y - rect->p.y) * .75; /* empirical from gs code make_tx_da */
778
779
21
    snprintf(size_str, sizeof(size_str), "%g ", size);
780
781
    /* Create a new DA and reassemble the old DA into it */
782
21
    code = pdfi_object_alloc(ctx, PDF_STRING, (size_t)DA->length+strlen(size_str)+1, (pdf_obj **)&newDA);
783
21
    if (code < 0)
784
0
        goto exit;
785
21
    pdfi_countup(newDA);
786
787
21
    strncpy((char *)newDA->data, (char *)DA->data, prev_token-parse_str);
788
21
    strncpy((char *)newDA->data + (prev_token-parse_str), size_str, strlen(size_str)+1);
789
21
    strncpy((char *)newDA->data + strlen((char *)newDA->data), (char *)DA->data + (token - parse_str),
790
21
            DA->length-(token-parse_str));
791
21
    newDA->length = strlen((char *)newDA->data);
792
21
    did_mod = true;
793
794
58.8k
 exit:
795
    /* If didn't need to mod it, just copy the original and get a ref */
796
58.8k
    if (did_mod) {
797
21
        *mod_DA = newDA;
798
58.8k
    } else {
799
58.8k
        *mod_DA = DA;
800
58.8k
        pdfi_countup(DA);
801
58.8k
    }
802
803
58.8k
    if (parse_str)
804
58.8k
        gs_free_object(ctx->memory, parse_str, "pdfi_form_modDA(parse_str)");
805
806
58.8k
    return code;
807
21
}
808
809
/* Process the /DA string by either running it through the interpreter
810
 *  or providing a bunch of defaults
811
 *
812
 * According to the spec, if there is a "<fontname> <size> Tf" in the /DA,
813
 * and the <size> = 0, we autosize it using the annotation's rect.  (see PDF1.7, pages 678-679)
814
 *
815
 * rect -- the annotation's rect, for auto-sizing the font
816
 * is_form -- is this a form, so check inheritable?
817
 */
818
static int pdfi_annot_process_DA(pdf_context *ctx, pdf_dict *page_dict, pdf_dict *annot, gs_rect *rect,
819
                                 bool is_form)
820
58.9k
{
821
58.9k
    int code = 0;
822
58.9k
    pdf_string *DA = NULL;
823
58.9k
    pdf_string *mod_DA = NULL;
824
58.9k
    pdf_dict *resource_dict = annot;  /* dict to use for resources, alias no need to refcnt */
825
58.9k
    pdf_dict *DR = NULL;
826
58.9k
    bool known;
827
828
    /* TODO -- see gs code make_tx_da, need to handle case where we need to set a UTF-16 font */
829
830
58.9k
    if (!page_dict)
831
85
        page_dict = ctx->page.CurrentPageDict;
832
833
58.9k
    if (is_form) {
834
58.8k
        code = pdfi_dict_known(ctx, annot, "DR", &known);
835
58.8k
        if (code < 0) goto exit;
836
        /* If there is no "DR" and no Parent in the annotation, have it use the AcroForm instead
837
         * This is a hack.  May need to use fancier inheritance approach.
838
         */
839
58.8k
        if (!known) {
840
58.8k
            code = pdfi_dict_known(ctx, annot, "Parent", &known);
841
58.8k
            if (code < 0) goto exit;
842
58.8k
            if (!known && ctx->AcroForm != NULL)
843
1.04k
                resource_dict = ctx->AcroForm;
844
58.8k
        }
845
58.8k
        code = pdfi_form_get_inheritable(ctx, annot, "DA", PDF_STRING, (pdf_obj **)&DA);
846
58.8k
    } else {
847
85
        code = pdfi_dict_knownget_type(ctx, annot, "DA", PDF_STRING, (pdf_obj **)&DA);
848
85
    }
849
58.9k
    if (code < 0) goto exit;
850
58.9k
    if (code > 0) {
851
58.9k
        if (is_form) {
852
58.8k
            code = pdfi_form_modDA(ctx, DA, &mod_DA, rect);
853
58.8k
            if (code < 0) goto exit;
854
58.8k
        } else {
855
80
            mod_DA = DA;
856
80
            pdfi_countup(mod_DA);
857
80
        }
858
859
58.9k
        code = pdfi_interpret_inner_content_string(ctx, mod_DA, resource_dict,
860
58.9k
                                                   page_dict, false, "DA");
861
58.9k
        if (code < 0) goto exit;
862
        /* If no font got set, set one */
863
58.9k
        if (pdfi_get_current_pdf_font(ctx) == NULL) {
864
104
            code = pdfi_annot_set_font(ctx, "Helvetica", 12.0);
865
104
            if (code < 0) goto exit;
866
104
        }
867
58.9k
    } else {
868
13
        code = pdfi_gs_setgray(ctx, 0);
869
13
        if (code < 0) goto exit;
870
13
        code = pdfi_annot_set_font(ctx, "Helvetica", 12.0);
871
13
        if (code < 0) goto exit;
872
13
    }
873
874
58.9k
 exit:
875
58.9k
    pdfi_countdown(DR);
876
58.9k
    pdfi_countdown(DA);
877
58.9k
    pdfi_countdown(mod_DA);
878
58.9k
    return code;
879
58.9k
}
880
881
/* Put a string into buffer as a hexstring and return ptr to end of it
882
 * Skip over any BOM that is present.
883
 */
884
static char *pdfi_get_hexstring(pdf_context *ctx, char *outbuf, byte *inbuf, int len)
885
26.3k
{
886
26.3k
    int i;
887
26.3k
    char *ptr;
888
889
26.3k
    i = 0;
890
    /* skip over BOM if it's there */
891
26.3k
    if (IS_UTF16(inbuf)) {
892
0
        i += 2; /* UTF-16 */
893
26.3k
    } else if (IS_UTF16(inbuf)) {
894
0
        i += 3; /* UTF-8 */
895
0
    }
896
897
26.3k
    ptr = outbuf;
898
26.3k
    *ptr++ = '<';
899
55.5k
    for ( ; i<len; i++) {
900
29.2k
        snprintf(ptr, 3, "%02X", *(inbuf+i));
901
29.2k
        ptr += 2;
902
29.2k
    }
903
904
26.3k
    *ptr++ = '>';
905
26.3k
    *ptr = 0;
906
907
26.3k
    return ptr;
908
26.3k
}
909
910
/* Display text at current position (inside BT/ET) */
911
static int
912
pdfi_annot_display_nexttext(pdf_context *ctx, pdf_dict *annot, pdf_string *text)
913
24.1k
{
914
24.1k
    char *strbuf = NULL;
915
24.1k
    size_t buflen = 50 + text->length*2; /* 50 to account for formatting, plus the text itself */
916
24.1k
    int code = 0;
917
24.1k
    char *ptr;
918
919
24.1k
    strbuf = (char *)gs_alloc_bytes(ctx->memory, buflen, "pdfi_annot_display_text(strbuf)");
920
24.1k
    if (strbuf == NULL)
921
0
        return_error(gs_error_VMerror);
922
24.1k
    ptr = pdfi_get_hexstring(ctx, strbuf, text->data, text->length);
923
24.1k
    strncpy(ptr, " Tj", buflen-strlen(strbuf));
924
925
24.1k
    code = pdfi_interpret_inner_content_c_string(ctx, strbuf, annot,
926
24.1k
                                               ctx->page.CurrentPageDict, false, "Annot text Tj");
927
24.1k
    if (code < 0) goto exit;
928
929
24.1k
 exit:
930
24.1k
    if (strbuf)
931
24.1k
        gs_free_object(ctx->memory, strbuf, "pdfi_annot_display_text(strbuf)");
932
24.1k
    return code;
933
24.1k
}
934
935
/* Display text with positioning (inside BT/ET) */
936
static int
937
pdfi_annot_display_text(pdf_context *ctx, pdf_dict *annot, double x, double y, pdf_string *text)
938
2.21k
{
939
2.21k
    char *strbuf = NULL;
940
2.21k
    size_t buflen = 50 + text->length*2; /* 50 to account for formatting, plus the text itself */
941
2.21k
    int code = 0;
942
2.21k
    char *ptr;
943
944
2.21k
    strbuf = (char *)gs_alloc_bytes(ctx->memory, buflen, "pdfi_annot_display_text(strbuf)");
945
2.21k
    if (strbuf == NULL)
946
0
        return_error(gs_error_VMerror);
947
2.21k
    snprintf(strbuf, buflen, "%g %g Td ", x, y);
948
2.21k
    ptr = strbuf + strlen(strbuf);
949
2.21k
    ptr = pdfi_get_hexstring(ctx, ptr, text->data, text->length);
950
2.21k
    strncpy(ptr, " Tj", buflen-strlen(strbuf));
951
952
2.21k
    code = pdfi_interpret_inner_content_c_string(ctx, strbuf, annot,
953
2.21k
                                               ctx->page.CurrentPageDict, false, "Annot text Tj");
954
2.21k
    if (code < 0) goto exit;
955
956
2.21k
 exit:
957
2.21k
    if (strbuf)
958
2.21k
        gs_free_object(ctx->memory, strbuf, "pdfi_annot_display_text(strbuf)");
959
2.21k
    return code;
960
2.21k
}
961
962
/* Get Text height for current font (assumes font is already set, inside BT/ET)
963
 * TODO: See /Tform implementation that uses FontBBox and ScaleMatrix instead
964
 * Maybe use this technique as a backup if those entries aren't available?
965
 */
966
static int
967
pdfi_annot_get_text_height(pdf_context *ctx, double *height)
968
666
{
969
666
    int code;
970
666
    pdf_string *temp_string = NULL;
971
666
    gs_rect bbox;
972
666
    gs_point awidth;
973
974
666
    if (ctx->pgs->PDFfontsize == 0) {
975
0
        *height = 0;
976
0
        return 0;
977
0
    }
978
979
666
    code = pdfi_obj_charstr_to_string(ctx, "Hy", &temp_string);
980
666
    if (code < 0)
981
0
        goto exit;
982
983
    /* Find the bbox of the string "Hy" */
984
666
    code = pdfi_string_bbox(ctx, temp_string, &bbox, &awidth, false);
985
666
    if (code < 0)
986
0
        goto exit;
987
988
666
    *height = bbox.q.y - bbox.p.y;
989
990
666
 exit:
991
666
    pdfi_countdown(temp_string);
992
666
    return code;
993
666
}
994
995
/* Display a simple text string (outside BT/ET) */
996
static int
997
pdfi_annot_display_simple_text(pdf_context *ctx, pdf_dict *annot, double x, double y, pdf_string *text)
998
221
{
999
221
    int code = 0;
1000
221
    int code1 = 0;
1001
1002
221
    code = pdfi_BT(ctx);
1003
221
    if (code < 0)
1004
0
        return code;
1005
1006
221
    code = pdfi_annot_display_text(ctx, annot, x, y, text);
1007
221
    code1 = pdfi_ET(ctx);
1008
221
    if (code == 0) code = code1;
1009
1010
221
    return code;
1011
221
}
1012
1013
/* Display a centered text string (outside BT/ET) */
1014
static int
1015
pdfi_annot_display_centered_text(pdf_context *ctx, pdf_dict *annot, gs_rect *rect, pdf_string *text)
1016
390
{
1017
390
    int code = 0;
1018
390
    int code1 = 0;
1019
390
    gs_rect bbox;
1020
390
    gs_point awidth;
1021
390
    double x, y;
1022
1023
390
    code = pdfi_BT(ctx);
1024
390
    if (code < 0)
1025
0
        return code;
1026
1027
    /* Get width of the string */
1028
390
    code = pdfi_string_bbox(ctx, text, &bbox, &awidth, false);
1029
390
    if (code < 0) goto exit;
1030
1031
    /* Center the title in the box */
1032
390
    x = rect->p.x + ((rect->q.x - rect->p.x) - awidth.x) / 2;
1033
390
    y = rect->q.y - 11;
1034
1035
390
    code = pdfi_annot_display_text(ctx, annot, x, y, text);
1036
390
    if (code < 0) goto exit;
1037
1038
390
 exit:
1039
390
    code1 = pdfi_ET(ctx);
1040
390
    if (code == 0) code = code1;
1041
390
    return code;
1042
390
}
1043
1044
/* Display a string formatted to fit in rect (outside BT/ET)
1045
 *
1046
 * TODO: I am sharing code between the FreeText and field/Tx implementation.
1047
 * The gs code has completely different implementations for these.
1048
 * I am not sure if there are some different assumptions about font encodings?
1049
 * The Tx field can apparently be UTF8 or UTF16, whereas the FreeText implementation just assumed
1050
 * it was ASCII.
1051
 * If you see some weird behavior with character mappings or line breaks, then
1052
 * this might be something to revisit.
1053
 */
1054
static int
1055
pdfi_annot_display_formatted_text(pdf_context *ctx, pdf_dict *annot,
1056
                                  gs_rect *rect, pdf_string *text, bool is_UTF16)
1057
463
{
1058
463
    double x;
1059
463
    double lineheight = 0;
1060
463
    double y_start;
1061
463
    double x_start, x_max;
1062
463
    gs_rect bbox;
1063
463
    gs_point awidth; /* Advance width */
1064
463
    int code = 0;
1065
463
    int code1 = 0;
1066
463
    pdf_string *temp_string = NULL;
1067
463
    int i;
1068
463
    byte ch;
1069
463
    bool firstchar = true;
1070
463
    bool linestart = true;
1071
463
    int charlen;
1072
1073
463
    if (is_UTF16)
1074
0
        charlen = 2;
1075
463
    else
1076
463
        charlen = 1;
1077
1078
463
    if (ctx->pgs->PDFfontsize == 0)
1079
0
        return 0;
1080
1081
463
    code = pdfi_BT(ctx);
1082
463
    if (code < 0)
1083
0
        return code;
1084
1085
    /* Allocate a temp string to use, length 1 char */
1086
463
    code = pdfi_object_alloc(ctx, PDF_STRING, charlen, (pdf_obj **)&temp_string);
1087
463
    if (code < 0) goto exit;
1088
463
    pdfi_countup(temp_string);
1089
1090
463
    code = pdfi_annot_get_text_height(ctx, &lineheight);
1091
463
    if (code < 0) goto exit;
1092
1093
463
    y_start = rect->q.y - lineheight;
1094
463
    x_start = rect->p.x;
1095
463
    x_max = rect->q.x;
1096
463
    x = x_start;
1097
1098
26.5k
    for (i=0; i<text->length; i+=charlen) {
1099
26.1k
        int j;
1100
1101
26.1k
        if (linestart) {
1102
893
            x = x_start;
1103
893
        }
1104
1105
52.2k
        for (j = 0; j < charlen; j++) {
1106
26.1k
            ch = text->data[i+j];
1107
26.1k
            temp_string->data[j] = ch;
1108
26.1k
        }
1109
1110
        /* If EOL character encountered, move down to next line */
1111
26.1k
        if (charlen == 1) { /* Can only check this for ASCII font */
1112
26.1k
            if (ch == '\r' || ch == '\n') {
1113
430
                if (linestart == true) {
1114
0
                    pdf_string dummy;
1115
1116
0
                    dummy.length = 0;
1117
0
                    code = pdfi_annot_display_text(ctx, annot, 0, -lineheight, &dummy);
1118
0
                    if (code < 0) goto exit;
1119
0
                }
1120
430
                linestart = true;
1121
430
                continue;
1122
430
            }
1123
26.1k
        }
1124
1125
        /* get size of the character */
1126
25.7k
        code = pdfi_string_bbox(ctx, temp_string, &bbox, &awidth, false);
1127
25.7k
        if (code < 0) goto exit;
1128
1129
25.7k
        if (!linestart && ((x + awidth.x) > x_max)) {
1130
706
            x = x_start;
1131
706
            linestart = true;
1132
706
        }
1133
1134
        /* display the character */
1135
25.7k
        if (firstchar) {
1136
463
            code = pdfi_annot_display_text(ctx, annot, x, y_start, temp_string);
1137
463
            firstchar = false;
1138
25.2k
        } else {
1139
25.2k
            if (linestart)
1140
1.13k
                code = pdfi_annot_display_text(ctx, annot, 0, -lineheight, temp_string);
1141
24.1k
            else
1142
24.1k
                code = pdfi_annot_display_nexttext(ctx, annot, temp_string);
1143
25.2k
        }
1144
25.7k
        if (code < 0) goto exit;
1145
25.7k
        x += awidth.x;
1146
25.7k
        linestart = false;
1147
25.7k
    }
1148
1149
463
 exit:
1150
463
    code1 = pdfi_ET(ctx);
1151
463
    if (code == 0) code = code1;
1152
463
    pdfi_countdown(temp_string);
1153
463
    return code;
1154
463
}
1155
1156
/*********** END Font/Text ***************/
1157
1158
1159
/*********** BEGIN /LE ***************/
1160
1161
/* Draw Butt LE */
1162
static int pdfi_annot_draw_LE_Butt(pdf_context *ctx, pdf_dict *annot)
1163
0
{
1164
0
    int code;
1165
0
    double width;
1166
0
    double seglength;
1167
1168
0
    code = pdfi_annot_get_BS_width(ctx, annot, &width);
1169
0
    if (code < 0) goto exit;
1170
1171
0
    seglength = 3*width;
1172
0
    code = gs_moveto(ctx->pgs, 0, -seglength);
1173
0
    if (code < 0) goto exit;
1174
0
    code = gs_lineto(ctx->pgs, 0, seglength);
1175
0
    if (code < 0) goto exit;
1176
0
    code = pdfi_annot_draw_border(ctx, annot, true);
1177
0
    if (code < 0) goto exit;
1178
1179
0
 exit:
1180
0
    return code;
1181
0
}
1182
1183
/* Draw Circle LE */
1184
static int pdfi_annot_draw_LE_Circle(pdf_context *ctx, pdf_dict *annot)
1185
0
{
1186
0
    double radius;
1187
0
    int code;
1188
0
    double width;
1189
1190
0
    code = pdfi_annot_get_BS_width(ctx, annot, &width);
1191
0
    if (code < 0) goto exit;
1192
1193
0
    code = pdfi_gsave(ctx);
1194
0
    if (code < 0) goto exit;
1195
1196
0
    radius = width * 2.5;
1197
0
    code = gs_moveto(ctx->pgs, radius, 0);
1198
0
    if (code < 0) goto exit_grestore;
1199
0
    code = gs_arc(ctx->pgs, 0, 0, radius, 0, 360);
1200
0
    if (code < 0) goto exit_grestore;
1201
0
    code = pdfi_annot_opacity(ctx, annot);
1202
0
    if (code < 0) goto exit_grestore;
1203
0
    code = pdfi_annot_fillborderpath(ctx, annot);
1204
0
    if (code < 0) goto exit_grestore;
1205
1206
0
    code = pdfi_grestore(ctx);
1207
0
    if (code < 0) goto exit;
1208
1209
0
    radius = width * 3;
1210
0
    code = gs_moveto(ctx->pgs, radius, 0);
1211
0
    if (code < 0) goto exit;
1212
0
    code = gs_arc(ctx->pgs, 0, 0, radius, 0, 360);
1213
0
    if (code < 0) goto exit;
1214
0
    code = pdfi_annot_draw_border(ctx, annot, true);
1215
0
    goto exit;
1216
1217
0
 exit_grestore:
1218
0
    (void)pdfi_grestore(ctx);
1219
0
 exit:
1220
0
    return code;
1221
0
}
1222
1223
/* Draw Diamond LE */
1224
static int pdfi_annot_draw_LE_Diamond(pdf_context *ctx, pdf_dict *annot)
1225
0
{
1226
0
    int code;
1227
0
    double width;
1228
0
    double seglength;
1229
1230
0
    code = pdfi_annot_get_BS_width(ctx, annot, &width);
1231
0
    if (code < 0) goto exit;
1232
1233
0
    code = pdfi_gsave(ctx);
1234
0
    if (code < 0) goto exit;
1235
1236
0
    seglength = width * 2.5;
1237
0
    code = gs_moveto(ctx->pgs, 0, -seglength);
1238
0
    if (code < 0) goto exit_grestore;
1239
0
    code = gs_lineto(ctx->pgs, -seglength, 0);
1240
0
    if (code < 0) goto exit_grestore;
1241
0
    code = gs_lineto(ctx->pgs, 0, seglength);
1242
0
    if (code < 0) goto exit_grestore;
1243
0
    code = gs_lineto(ctx->pgs, seglength, 0);
1244
0
    if (code < 0) goto exit_grestore;
1245
0
    code = gs_closepath(ctx->pgs);
1246
0
    if (code < 0) goto exit_grestore;
1247
0
    code = pdfi_annot_opacity(ctx, annot);
1248
0
    if (code < 0) goto exit_grestore;
1249
0
    code = pdfi_annot_fillborderpath(ctx, annot);
1250
0
    if (code < 0) goto exit_grestore;
1251
1252
0
    code = pdfi_grestore(ctx);
1253
0
    if (code < 0) goto exit;
1254
1255
0
    seglength = width * 3;
1256
0
    code = gs_moveto(ctx->pgs, 0, -seglength);
1257
0
    if (code < 0) goto exit;
1258
0
    code = gs_lineto(ctx->pgs, -seglength, 0);
1259
0
    if (code < 0) goto exit;
1260
0
    code = gs_lineto(ctx->pgs, 0, seglength);
1261
0
    if (code < 0) goto exit;
1262
0
    code = gs_lineto(ctx->pgs, seglength, 0);
1263
0
    if (code < 0) goto exit;
1264
0
    code = gs_closepath(ctx->pgs);
1265
0
    if (code < 0) goto exit;
1266
0
    code = pdfi_annot_draw_border(ctx, annot, true);
1267
0
    goto exit;
1268
1269
0
 exit_grestore:
1270
0
    (void)pdfi_grestore(ctx);
1271
0
 exit:
1272
0
    return code;
1273
0
}
1274
1275
/* Draw Square LE */
1276
static int pdfi_annot_draw_LE_Square(pdf_context *ctx, pdf_dict *annot)
1277
0
{
1278
0
    int code;
1279
0
    double width;
1280
0
    double seglength;
1281
1282
0
    code = pdfi_annot_get_BS_width(ctx, annot, &width);
1283
0
    if (code < 0) goto exit;
1284
1285
0
    code = pdfi_gsave(ctx);
1286
0
    if (code < 0) goto exit;
1287
1288
0
    seglength = width * 2.5;
1289
0
    code = gs_moveto(ctx->pgs, -seglength, -seglength);
1290
0
    if (code < 0) goto exit_grestore;
1291
0
    code = gs_lineto(ctx->pgs, -seglength, seglength);
1292
0
    if (code < 0) goto exit_grestore;
1293
0
    code = gs_lineto(ctx->pgs, seglength, seglength);
1294
0
    if (code < 0) goto exit_grestore;
1295
0
    code = gs_lineto(ctx->pgs, seglength, -seglength);
1296
0
    if (code < 0) goto exit_grestore;
1297
0
    code = gs_closepath(ctx->pgs);
1298
0
    if (code < 0) goto exit_grestore;
1299
0
    code = pdfi_annot_opacity(ctx, annot);
1300
0
    if (code < 0) goto exit_grestore;
1301
0
    code = pdfi_annot_fillborderpath(ctx, annot);
1302
0
    if (code < 0) goto exit_grestore;
1303
1304
0
    code = pdfi_grestore(ctx);
1305
0
    if (code < 0) goto exit;
1306
1307
0
    seglength = width * 3;
1308
0
    code = gs_moveto(ctx->pgs, -seglength, -seglength);
1309
0
    if (code < 0) goto exit;
1310
0
    code = gs_lineto(ctx->pgs, -seglength, seglength);
1311
0
    if (code < 0) goto exit;
1312
0
    code = gs_lineto(ctx->pgs, seglength, seglength);
1313
0
    if (code < 0) goto exit;
1314
0
    code = gs_lineto(ctx->pgs, seglength, -seglength);
1315
0
    if (code < 0) goto exit;
1316
0
    code = gs_closepath(ctx->pgs);
1317
0
    if (code < 0) goto exit;
1318
0
    code = pdfi_annot_draw_border(ctx, annot, true);
1319
0
    goto exit;
1320
1321
0
 exit_grestore:
1322
0
    (void)pdfi_grestore(ctx);
1323
0
 exit:
1324
0
    return code;
1325
0
}
1326
1327
/* Draw Slash LE */
1328
static int pdfi_annot_draw_LE_Slash(pdf_context *ctx, pdf_dict *annot)
1329
0
{
1330
0
    int code;
1331
0
    double width;
1332
0
    double seglength;
1333
1334
0
    code = pdfi_annot_get_BS_width(ctx, annot, &width);
1335
0
    if (code < 0) goto exit;
1336
1337
0
    seglength = 3*width;
1338
0
    code = gs_rotate(ctx->pgs, 330);
1339
0
    if (code < 0) goto exit;
1340
0
    code = gs_moveto(ctx->pgs, 0, -seglength);
1341
0
    if (code < 0) goto exit;
1342
0
    code = gs_lineto(ctx->pgs, 0, seglength);
1343
0
    if (code < 0) goto exit;
1344
0
    code = pdfi_annot_draw_border(ctx, annot, true);
1345
0
    if (code < 0) goto exit;
1346
1347
0
 exit:
1348
0
    return code;
1349
0
}
1350
1351
/* Draw ClosedArrow LE */
1352
static int pdfi_annot_draw_LE_ClosedArrow(pdf_context *ctx, pdf_dict *annot)
1353
501
{
1354
501
    int code;
1355
501
    double width;
1356
501
    double seglen;
1357
1358
501
    code = pdfi_annot_get_BS_width(ctx, annot, &width);
1359
501
    if (code < 0) goto exit;
1360
1361
501
    code = pdfi_gsave(ctx);
1362
501
    if (code < 0) goto exit_grestore;
1363
1364
501
    code = gs_setlinejoin(ctx->pgs, 0);
1365
501
    if (code < 0) goto exit_grestore;
1366
501
    code = gs_moveto(ctx->pgs, -width*6, -width*4);
1367
501
    if (code < 0) goto exit_grestore;
1368
501
    code = gs_lineto(ctx->pgs, -width/1.2, 0);
1369
501
    if (code < 0) goto exit_grestore;
1370
501
    code = gs_lineto(ctx->pgs, -width*6, width*4);
1371
501
    if (code < 0) goto exit_grestore;
1372
501
    code = gs_closepath(ctx->pgs);
1373
501
    if (code < 0) goto exit_grestore;
1374
501
    code = pdfi_annot_draw_border(ctx, annot, true);
1375
501
    if (code < 0) goto exit_grestore;
1376
1377
501
    code = pdfi_grestore(ctx);
1378
501
    if (code < 0) goto exit;
1379
1380
501
    code = gs_translate(ctx->pgs, -1.3*width, 0);
1381
501
    if (code < 0) goto exit;
1382
501
    seglen = width / 2;
1383
501
    code = gs_moveto(ctx->pgs, -seglen*8.4, -seglen*5.9);
1384
501
    if (code < 0) goto exit;
1385
501
    code = gs_lineto(ctx->pgs, -seglen/1.2, 0);
1386
501
    if (code < 0) goto exit;
1387
501
    code = gs_lineto(ctx->pgs, -seglen*8.4, seglen*5.9);
1388
501
    if (code < 0) goto exit;
1389
501
    code = gs_closepath(ctx->pgs);
1390
501
    if (code < 0) goto exit;
1391
501
    code = pdfi_annot_opacity(ctx, annot);
1392
501
    if (code < 0) goto exit;
1393
501
    code = pdfi_annot_fillborderpath(ctx, annot);
1394
501
    goto exit;
1395
1396
0
 exit_grestore:
1397
0
    (void)pdfi_grestore(ctx);
1398
501
 exit:
1399
501
    return code;
1400
0
}
1401
1402
/* Draw OpenArrow LE */
1403
static int pdfi_annot_draw_LE_OpenArrow(pdf_context *ctx, pdf_dict *annot)
1404
2
{
1405
2
    int code;
1406
2
    double width;
1407
1408
2
    code = pdfi_annot_get_BS_width(ctx, annot, &width);
1409
2
    if (code < 0) goto exit;
1410
1411
2
    code = gs_setlinejoin(ctx->pgs, 0);
1412
2
    if (code < 0) goto exit;
1413
1414
2
    code = gs_moveto(ctx->pgs, -width*6, -width*4);
1415
2
    if (code < 0) goto exit;
1416
2
    code = gs_lineto(ctx->pgs, -width/1.2, 0);
1417
2
    if (code < 0) goto exit;
1418
2
    code = gs_lineto(ctx->pgs, -width*6, width*4);
1419
2
    if (code < 0) goto exit;
1420
2
    code = pdfi_annot_draw_border(ctx, annot, true);
1421
2
    if (code < 0) goto exit;
1422
1423
2
 exit:
1424
2
    return code;
1425
2
}
1426
1427
/* Draw RClosedArrow LE */
1428
static int pdfi_annot_draw_LE_RClosedArrow(pdf_context *ctx, pdf_dict *annot)
1429
0
{
1430
0
    int code;
1431
1432
0
    code = gs_rotate(ctx->pgs, 180);
1433
0
    if (code < 0) goto exit;
1434
0
    code = pdfi_annot_draw_LE_ClosedArrow(ctx, annot);
1435
0
    if (code < 0) goto exit;
1436
1437
0
 exit:
1438
0
    return code;
1439
0
}
1440
1441
/* Draw ROpenArrow LE */
1442
static int pdfi_annot_draw_LE_ROpenArrow(pdf_context *ctx, pdf_dict *annot)
1443
0
{
1444
0
    int code;
1445
1446
0
    code = gs_rotate(ctx->pgs, 180);
1447
0
    if (code < 0) goto exit;
1448
0
    code = pdfi_annot_draw_LE_OpenArrow(ctx, annot);
1449
0
    if (code < 0) goto exit;
1450
1451
0
 exit:
1452
0
    return code;
1453
0
}
1454
1455
/* Draw None or null LE (do nothing) */
1456
static int pdfi_annot_draw_LE_None(pdf_context *ctx, pdf_dict *annot)
1457
1.61k
{
1458
1.61k
    return 0;
1459
1.61k
}
1460
1461
annot_LE_dispatch_t annot_LE_dispatch[] = {
1462
    {"Butt", pdfi_annot_draw_LE_Butt},
1463
    {"Circle", pdfi_annot_draw_LE_Circle},
1464
    {"Diamond", pdfi_annot_draw_LE_Diamond},
1465
    {"Slash", pdfi_annot_draw_LE_Slash},
1466
    {"Square", pdfi_annot_draw_LE_Square},
1467
    {"ClosedArrow", pdfi_annot_draw_LE_ClosedArrow},
1468
    {"OpenArrow", pdfi_annot_draw_LE_OpenArrow},
1469
    {"RClosedArrow", pdfi_annot_draw_LE_RClosedArrow},
1470
    {"ROpenArrow", pdfi_annot_draw_LE_ROpenArrow},
1471
    {"None", pdfi_annot_draw_LE_None},
1472
    { NULL, NULL},
1473
};
1474
1475
/* Draw one line ending at (x,y) */
1476
static int pdfi_annot_draw_LE_one(pdf_context *ctx, pdf_dict *annot, pdf_name *LE,
1477
                                  double x, double y, double angle)
1478
2.15k
{
1479
2.15k
    int code;
1480
2.15k
    int code1;
1481
2.15k
    annot_LE_dispatch_t *dispatch_ptr;
1482
1483
2.15k
    code = pdfi_gsave(ctx);
1484
2.15k
    if (code < 0) goto exit1;
1485
1486
2.15k
    code = gs_translate(ctx->pgs, x, y);
1487
2.15k
    code = gs_moveto(ctx->pgs, 0, 0);
1488
2.15k
    code = gs_rotate(ctx->pgs, angle);
1489
1490
    /* Draw the LE */
1491
19.5k
    for (dispatch_ptr = annot_LE_dispatch; dispatch_ptr->name; dispatch_ptr ++) {
1492
19.4k
        if (pdfi_name_is(LE, dispatch_ptr->name)) {
1493
2.11k
            code = dispatch_ptr->func(ctx, annot);
1494
2.11k
            break;
1495
2.11k
        }
1496
19.4k
    }
1497
2.15k
    if (!dispatch_ptr->name) {
1498
36
        char str[100];
1499
36
        memcpy(str, (const char *)LE->data, LE->length < 100 ? LE->length : 99);
1500
36
        str[LE->length < 100 ? LE->length : 99] = '\0';
1501
36
        dbgmprintf1(ctx->memory, "ANNOT: WARNING No handler for LE %s\n", str);
1502
36
    }
1503
1504
2.15k
 exit1:
1505
2.15k
    code1 = pdfi_grestore(ctx);
1506
2.15k
    if (code < 0)
1507
5
        code = code1;
1508
2.15k
    return code;
1509
2.15k
}
1510
1511
/* Draw line endings using LE entry in annotation dictionary
1512
 * Draws one at (x1,y1) and one at (x2,y2)
1513
 * If LE is a name instead of an array, only draws at x2,y2 (but needs x1,y1 for angle)
1514
 *  (defaults to None if not there)
1515
 *
1516
 * which -- tells whether to draw both ends (0) or just the first one (1) or second one (2)
1517
 */
1518
static int pdfi_annot_draw_LE(pdf_context *ctx, pdf_dict *annot,
1519
                              double x1, double y1, double x2, double y2, int which)
1520
2.17k
{
1521
2.17k
    pdf_obj *LE = NULL;
1522
2.17k
    pdf_name *LE1 = NULL;
1523
2.17k
    pdf_name *LE2 = NULL;
1524
2.17k
    double dx, dy;
1525
2.17k
    double angle;
1526
2.17k
    int code;
1527
2.17k
    pdf_obj_type type;
1528
1529
2.17k
    code = pdfi_dict_knownget(ctx, annot, "LE", (pdf_obj **)&LE);
1530
2.17k
    if (code <= 0)
1531
1.07k
        goto exit;
1532
1.09k
    type = pdfi_type_of(LE);
1533
1.09k
    if (type != PDF_ARRAY && type != PDF_NAME) {
1534
0
        code = gs_note_error(gs_error_typecheck);
1535
0
        goto exit;
1536
0
    }
1537
1538
1.09k
    dx = x2 - x1;
1539
1.09k
    dy = y2 - y1;
1540
1.09k
    code = gs_atan2_degrees(dy, dx, &angle);
1541
1.09k
    if (code < 0)
1542
0
        angle = 0;
1543
1544
1.09k
    if (type == PDF_ARRAY) {
1545
1.09k
        code = pdfi_array_get_type(ctx, (pdf_array *)LE, 0, PDF_NAME, (pdf_obj **)&LE1);
1546
1.09k
        if (code < 0) goto exit;
1547
1548
1.09k
        code = pdfi_array_get_type(ctx, (pdf_array *)LE, 1, PDF_NAME, (pdf_obj **)&LE2);
1549
1.09k
        if (code < 0) goto exit;
1550
1.09k
    } else {
1551
0
        LE1 = (pdf_name *)LE;
1552
0
        LE = NULL;
1553
0
    }
1554
1.09k
    if (LE1 && (!which || which == 1)) {
1555
1.07k
        code = pdfi_annot_draw_LE_one(ctx, annot, LE1, x1, y1, angle+180);
1556
1.07k
        if (code < 0) goto exit;
1557
1.07k
    }
1558
1559
1.09k
    if (LE2 && (!which || which == 2)) {
1560
1.07k
        code = pdfi_annot_draw_LE_one(ctx, annot, LE2, x2, y2, angle);
1561
1.07k
        if (code < 0) goto exit;
1562
1.07k
    }
1563
1564
2.17k
 exit:
1565
2.17k
    pdfi_countdown(LE);
1566
2.17k
    pdfi_countdown(LE1);
1567
2.17k
    pdfi_countdown(LE2);
1568
2.17k
    return code;
1569
1.09k
}
1570
/*********** END /LE ***************/
1571
1572
1573
/* Get the Normal AP dictionary/stream, if it exists
1574
 * Not an error if it doesn't exist, it will just be NULL
1575
 */
1576
static int pdfi_annot_get_NormAP(pdf_context *ctx, pdf_dict *annot, pdf_obj **NormAP)
1577
377k
{
1578
377k
    int code;
1579
377k
    pdf_dict *AP_dict = NULL;
1580
377k
    pdf_stream *AP = NULL;
1581
377k
    pdf_obj *baseAP = NULL;
1582
377k
    pdf_name *AS = NULL;
1583
1584
377k
    *NormAP = NULL;
1585
1586
377k
    code = pdfi_dict_knownget_type(ctx, annot, "AP", PDF_DICT, (pdf_obj **)&AP_dict);
1587
377k
    if (code <= 0) goto exit;
1588
1589
284k
    code = pdfi_dict_knownget(ctx, AP_dict, "N", (pdf_obj **)&baseAP);
1590
284k
    if (code < 0) goto exit;
1591
1592
    /* Look for /R and /D if there was no /N */
1593
227k
    if (code == 0) {
1594
51
        if ((code = pdfi_set_warning_stop(ctx, gs_note_error(gs_error_undefined), NULL, W_PDF_ANNOT_AP_ERROR, "pdfi_annot_get_NormAP", "*** Error: Annotation (AP) lacks the mandatory normal (N) appearance")) < 0)
1595
0
            goto exit;
1596
1597
51
        code = pdfi_dict_knownget(ctx, AP_dict, "R", (pdf_obj **)&baseAP);
1598
51
        if (code < 0) goto exit;
1599
1600
51
        if (code == 0) {
1601
49
            code = pdfi_dict_knownget(ctx, AP_dict, "D", (pdf_obj **)&baseAP);
1602
49
            if (code < 0) goto exit;
1603
49
        }
1604
51
    }
1605
1606
    /* Nothing found */
1607
227k
    if (code == 0) goto exit;
1608
1609
227k
    switch (pdfi_type_of(baseAP)) {
1610
181k
        case PDF_STREAM:
1611
            /* Use baseAP for the AP */
1612
181k
            AP = (pdf_stream *)baseAP;
1613
181k
            baseAP = NULL;
1614
181k
            break;
1615
46.1k
        case PDF_DICT:
1616
46.1k
            code = pdfi_dict_knownget_type(ctx, annot, "AS", PDF_NAME, (pdf_obj **)&AS);
1617
46.1k
            if (code < 0) goto exit;
1618
46.1k
            if (code == 0) {
1619
622
                code = pdfi_set_warning_stop(ctx, gs_note_error(gs_error_undefined), NULL, W_PDF_ANNOT_AP_ERROR, "pdfi_annot_get_NormAP", "WARNING Annotation has non-stream AP but no AS.  Don't know what to render");
1620
622
                goto exit;
1621
622
            }
1622
1623
            /* Lookup the AS in the NormAP and use that as the AP */
1624
45.5k
            code = pdfi_dict_get_by_key(ctx, (pdf_dict *)baseAP, AS, (pdf_obj **)&AP);
1625
45.5k
            if (code < 0) {
1626
                /* Apparently this is not an error, just silently don't have an AP */
1627
18.4k
                *NormAP = (pdf_obj *)TOKEN_null;
1628
18.4k
                code = 0;
1629
18.4k
                goto exit;
1630
18.4k
            }
1631
27.0k
            if (pdfi_type_of(AP) != PDF_STREAM) {
1632
89
                code = gs_note_error(gs_error_typecheck);
1633
89
                goto exit;
1634
89
            }
1635
26.9k
            break;
1636
26.9k
        default:
1637
151
            code = gs_error_typecheck;
1638
151
            goto exit;
1639
227k
    }
1640
1641
208k
   *NormAP = (pdf_obj *)AP;
1642
208k
   pdfi_countup(AP);
1643
1644
377k
 exit:
1645
377k
    pdfi_countdown(AP_dict);
1646
377k
    pdfi_countdown(AP);
1647
377k
    pdfi_countdown(AS);
1648
377k
    pdfi_countdown(baseAP);
1649
377k
    return code;
1650
208k
}
1651
1652
static int pdfi_annot_draw_Link(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
1653
5.75k
{
1654
5.75k
    int code;
1655
5.75k
    int code1;
1656
5.75k
    bool drawit;
1657
1658
5.75k
    dbgmprintf(ctx->memory, "ANNOT: Drawing Link\n");
1659
1660
5.75k
    code = pdfi_annot_start_transparency(ctx, annot);
1661
5.75k
    if (code < 0)
1662
0
        return code;
1663
1664
5.75k
    code = pdfi_annot_setcolor(ctx, annot, true, &drawit);
1665
5.75k
    if (code < 0) goto exit;
1666
5.75k
    if (!drawit) goto exit;
1667
1668
5.75k
    code = pdfi_annot_draw_border(ctx, annot, false);
1669
5.75k
    if (code < 0) goto exit;
1670
1671
5.74k
    code = pdfi_annot_draw_AP(ctx, annot, NormAP);
1672
1673
5.75k
 exit:
1674
5.75k
    code1 = pdfi_annot_end_transparency(ctx, annot);
1675
5.75k
    if (code == 0) code = code1;
1676
1677
5.75k
    *render_done = true;
1678
5.75k
    return code;
1679
5.74k
}
1680
1681
/* Draw a path from an InkList
1682
 * see zpdfops.c/zpdfinkpath()
1683
 *
1684
 * Construct a smooth path passing though a number of points  on the stack
1685
 * for PDF ink annotations. The program is based on a very simple method of
1686
 * smoothing polygons by Maxim Shemanarev.
1687
 * http://www.antigrain.com/research/bezier_interpolation/
1688
 *
1689
 * InkList is array of arrays, each representing a stroked path
1690
 */
1691
static int pdfi_annot_draw_InkList(pdf_context *ctx, pdf_dict *annot, pdf_array *InkList)
1692
701
{
1693
701
    int code = 0;
1694
701
    pdf_array *points = NULL;
1695
701
    int i;
1696
701
    int num_points;
1697
701
    double x1, y1, x2, y2;
1698
1699
1.32k
    for (i=0; i<pdfi_array_size(InkList); i++) {
1700
705
        int j;
1701
1702
705
        code = pdfi_array_get_type(ctx, InkList, i, PDF_ARRAY, (pdf_obj **)&points);
1703
705
        if (code < 0)
1704
4
            goto exit;
1705
1706
701
        num_points = pdfi_array_size(points);
1707
701
        if (num_points < 2)
1708
0
            goto exit;
1709
1710
701
        code = pdfi_array_get_number(ctx, points, 0, &x1);
1711
701
        if (code < 0) goto exit;
1712
701
        code = pdfi_array_get_number(ctx, points, 1, &y1);
1713
701
        if (code < 0) goto exit;
1714
699
        code = gs_moveto(ctx->pgs, x1, y1);
1715
699
        if (code < 0) goto exit;
1716
699
        if (num_points == 2)
1717
0
            goto stroke;
1718
1719
24.5k
        for (j = 2; j < num_points; j += 2) {
1720
23.9k
            code = pdfi_array_get_number(ctx, points, j, &x2);
1721
23.9k
            if (code < 0) goto exit;
1722
23.8k
            code = pdfi_array_get_number(ctx, points, j+1, &y2);
1723
23.8k
            if (code < 0) goto exit;
1724
23.8k
            code = gs_lineto(ctx->pgs, x2, y2);
1725
23.8k
            if (code < 0) goto exit;
1726
23.8k
        }
1727
1728
619
    stroke:
1729
619
        code = gs_stroke(ctx->pgs);
1730
619
        if (code < 0) goto exit;
1731
619
        pdfi_countdown(points);
1732
619
        points = NULL;
1733
619
    }
1734
1735
701
 exit:
1736
701
    pdfi_countdown(points);
1737
701
    return code;
1738
701
}
1739
1740
/* Draw a path from a Path array (see 2.0 spec 12.5.6.13)
1741
 * Path is array of arrays.
1742
 * First array is 2 args for moveto
1743
 * The rest of the arrays are either 2 args for lineto or 6 args for curveto
1744
 */
1745
static int pdfi_annot_draw_Path(pdf_context *ctx, pdf_dict *annot, pdf_array *Path)
1746
0
{
1747
0
    int code = 0;
1748
0
    pdf_array *points = NULL;
1749
0
    double array[6];
1750
0
    int i;
1751
0
    int num_points;
1752
1753
0
    for (i=0; i<pdfi_array_size(Path); i++) {
1754
0
        code = pdfi_array_get_type(ctx, Path, i, PDF_ARRAY, (pdf_obj **)&points);
1755
0
        if (code < 0)
1756
0
            goto exit;
1757
1758
0
        num_points = pdfi_array_size(points);
1759
0
        if (num_points != 2 && num_points != 6) {
1760
0
            code = gs_note_error(gs_error_rangecheck);
1761
0
            goto exit;
1762
0
        }
1763
1764
0
        code = pdfi_array_to_num_array(ctx, points, array, 0, num_points);
1765
0
        if (code < 0) goto exit;
1766
1767
0
        if (i == 0) {
1768
0
            code = gs_moveto(ctx->pgs, array[0], array[1]);
1769
0
            if (code < 0) goto exit;
1770
0
        } else {
1771
0
            if (num_points == 2) {
1772
0
                code = gs_lineto(ctx->pgs, array[0], array[1]);
1773
0
                if (code < 0) goto exit;
1774
0
            } else {
1775
0
                code = gs_curveto(ctx->pgs, array[0], array[1],
1776
0
                                  array[2], array[3], array[4], array[5]);
1777
0
                if (code < 0) goto exit;
1778
0
            }
1779
0
        }
1780
1781
0
        pdfi_countdown(points);
1782
0
        points = NULL;
1783
0
    }
1784
1785
0
    code = pdfi_annot_draw_border(ctx, annot, true);
1786
1787
0
 exit:
1788
0
    pdfi_countdown(points);
1789
0
    return code;
1790
0
}
1791
1792
/* Generate appearance (see pdf_draw.ps/Ink
1793
 *
1794
 * If there was an AP it was already handled.
1795
 */
1796
static int pdfi_annot_draw_Ink(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
1797
725
{
1798
725
    int code = 0;
1799
725
    int code1 = 0;
1800
725
    bool drawit;
1801
725
    pdf_array *array = NULL;
1802
1803
725
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
1804
725
    if (code <0 || !drawit)
1805
11
        goto exit1;
1806
1807
714
    code = pdfi_annot_start_transparency(ctx, annot);
1808
714
    if (code < 0) goto exit1;
1809
1810
714
    code = gs_setlinewidth(ctx->pgs, 1);
1811
714
    if (code < 0) goto exit;
1812
714
    code = gs_setlinecap(ctx->pgs, 1);
1813
714
    if (code < 0) goto exit;
1814
714
    code = gs_setlinejoin(ctx->pgs, 1);
1815
714
    if (code < 0) goto exit;
1816
1817
714
    code = pdfi_dict_knownget_type(ctx, annot, "InkList", PDF_ARRAY, (pdf_obj **)&array);
1818
714
    if (code < 0) goto exit;
1819
714
    if (code > 0) {
1820
701
        code = pdfi_annot_draw_InkList(ctx, annot, array);
1821
701
        goto exit;
1822
701
    }
1823
13
    code = pdfi_dict_knownget_type(ctx, annot, "Path", PDF_ARRAY, (pdf_obj **)&array);
1824
13
    if (code < 0) goto exit;
1825
13
    if (code > 0) {
1826
0
        code = pdfi_annot_draw_Path(ctx, annot, array);
1827
0
        goto exit;
1828
0
    }
1829
1830
714
 exit:
1831
714
    code1 = pdfi_annot_end_transparency(ctx, annot);
1832
714
    if (code >= 0)
1833
628
        code = code1;
1834
725
 exit1:
1835
725
    pdfi_countdown(array);
1836
725
    *render_done = true;
1837
725
    return code;
1838
714
}
1839
1840
/* from pdf_draw.ps/drawellipse
1841
 * "Don Lancaster's code for drawing an ellipse"
1842
 * https://www.tinaja.com/glib/ellipse4.pdf
1843
 *
1844
/magic 0.55228475 0.00045 sub store  % improved value
1845
/drawellipse {
1846
2 div /yrad exch store
1847
2 div /xrad exch store
1848
/xmag xrad magic mul store
1849
/ymag yrad magic mul store xrad
1850
neg 0 moveto
1851
xrad neg ymag xmag neg yrad 0 yrad curveto
1852
xmag  yrad xrad ymag xrad 0 curveto
1853
xrad ymag neg  xmag yrad neg 0  yrad neg curveto
1854
xmag neg yrad neg xrad neg ymag neg xrad neg  0 curveto
1855
} bind def
1856
1857
 */
1858
static int pdfi_annot_drawellipse(pdf_context *ctx, double width, double height)
1859
263
{
1860
263
    int code = 0;
1861
263
    double magic = .55228475 - .00045; /* Magic value */
1862
263
    double xrad = width / 2;
1863
263
    double yrad = height / 2;
1864
263
    double xmag = xrad * magic;
1865
263
    double ymag = yrad * magic;
1866
1867
263
    code = gs_moveto(ctx->pgs, -xrad, 0);
1868
263
    if (code < 0) return code;
1869
263
    code = gs_curveto(ctx->pgs, -xrad, ymag, -xmag, yrad, 0, yrad);
1870
263
    if (code < 0) return code;
1871
263
    code = gs_curveto(ctx->pgs, xmag, yrad, xrad, ymag, xrad, 0);
1872
263
    if (code < 0) return code;
1873
263
    code = gs_curveto(ctx->pgs, xrad, -ymag, xmag, -yrad, 0, -yrad);
1874
263
    if (code < 0) return code;
1875
263
    code = gs_curveto(ctx->pgs, -xmag, -yrad, -xrad, -ymag, -xrad, 0);
1876
1877
263
    return code;
1878
263
}
1879
1880
/* Generate appearance (see pdf_draw.ps/Circle)
1881
 *
1882
 * If there was an AP it was already handled.
1883
 */
1884
static int pdfi_annot_draw_Circle(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
1885
263
{
1886
263
    int code = 0;
1887
263
    int code1 = 0;
1888
263
    gs_rect rect;
1889
263
    bool drawit;
1890
263
    double width, height;
1891
1892
263
    code = pdfi_annot_start_transparency(ctx, annot);
1893
263
    if (code < 0) goto exit1;
1894
1895
263
    code = pdfi_annot_Rect(ctx, annot, &rect);
1896
263
    if (code < 0) goto exit;
1897
1898
263
    code = pdfi_annot_applyRD(ctx, annot, &rect);
1899
263
    if (code < 0) goto exit;
1900
1901
    /* Translate to the center of the ellipse */
1902
263
    width = rect.q.x - rect.p.x;
1903
263
    height = rect.q.y - rect.p.y;
1904
263
    code = gs_translate(ctx->pgs, rect.p.x + width/2, rect.p.y + height/2);
1905
263
    if (code < 0) goto exit;
1906
1907
    /* Draw the ellipse */
1908
263
    code = pdfi_annot_drawellipse(ctx, width, height);
1909
263
    if (code < 0) goto exit;
1910
1911
263
    code = pdfi_annot_fillborderpath(ctx, annot);
1912
263
    if (code < 0) goto exit;
1913
1914
263
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
1915
263
    if (code < 0) goto exit;
1916
1917
263
    if (drawit) {
1918
258
        code = pdfi_annot_draw_border(ctx, annot, true);
1919
258
        if (code < 0) goto exit;
1920
258
    }
1921
1922
263
 exit:
1923
263
    code1 = pdfi_annot_end_transparency(ctx, annot);
1924
263
    if (code >= 0)
1925
263
        code = code1;
1926
263
 exit1:
1927
263
    *render_done = true;
1928
263
    return code;
1929
263
}
1930
1931
1932
/*********** BEGIN /Stamp ***************/
1933
typedef struct {
1934
    double r,g,b;
1935
} pdfi_annot_stamp_rgb_t;
1936
1937
#define STAMP_RED {0xef/255.,0x40/255.,0x23/255.}
1938
#define STAMP_GREEN {0x2f/255.,0xae/255.,0x49/255.}
1939
#define STAMP_BLUE {0x00/255.,0x72/255.,0xbc/255.}
1940
1941
typedef struct {
1942
    const char *text;
1943
    double y;
1944
    double h;
1945
} pdfi_annot_stamp_text_t;
1946
1947
typedef struct {
1948
    const char *type;
1949
    pdfi_annot_stamp_rgb_t rgb;
1950
    pdfi_annot_stamp_text_t text[2];
1951
} pdfi_annot_stamp_type_t;
1952
1953
#define STAMP_1LINE(text,y,h) {{text,y,h},{0}}
1954
#define STAMP_2LINE(text,y,h,text2,y2,h2) {{text,y,h},{text2,y2,h2}}
1955
1956
static pdfi_annot_stamp_type_t pdfi_annot_stamp_types[] = {
1957
    {"Approved", STAMP_GREEN, STAMP_1LINE("APPROVED", 13, 30)},
1958
    {"AsIs", STAMP_RED, STAMP_1LINE("AS IS", 13, 30)},
1959
    {"Confidential", STAMP_RED, STAMP_1LINE("CONFIDENTIAL", 17, 20)},
1960
    {"Departmental", STAMP_BLUE, STAMP_1LINE("DEPARTMENTAL", 17, 20)},
1961
    {"Draft", STAMP_RED, STAMP_1LINE("DRAFT", 13, 30)},
1962
    {"Experimental", STAMP_BLUE, STAMP_1LINE("EXPERIMENTAL", 17, 20)},
1963
    {"Expired", STAMP_RED, STAMP_1LINE("EXPIRED", 13, 30)},
1964
    {"Final", STAMP_RED, STAMP_1LINE("FINAL", 13, 30)},
1965
    {"ForComment", STAMP_GREEN, STAMP_1LINE("FOR COMMENT", 17, 20)},
1966
    {"ForPublicRelease", STAMP_GREEN, STAMP_2LINE("FOR PUBLIC",26,18,"RELEASE",8.5,18)},
1967
    {"NotApproved", STAMP_RED, STAMP_1LINE("NOT APPROVED", 17, 20)},
1968
    {"NotForPublicRelease", STAMP_RED, STAMP_2LINE("NOT FOR",26,18,"PUBLIC RELEASE",8.5,18)},
1969
    {"Sold", STAMP_BLUE, STAMP_1LINE("SOLD", 13, 30)},
1970
    {"TopSecret", STAMP_RED, STAMP_1LINE("TOP SECRET", 14, 26)},
1971
    {0}
1972
};
1973
/* Use "Draft" if not found, make sure this value is correct if above array changes */
1974
#define STAMP_DRAFT_INDEX 4
1975
1976
/* Draw the frame for the stamp.  This is taken straight form the PS code. */
1977
static int pdfi_annot_draw_stamp_frame(pdf_context *ctx)
1978
18
{
1979
18
    int code;
1980
1981
18
    code = gs_moveto(ctx->pgs, 6.0, 0.0);
1982
18
    if (code < 0) goto exit;
1983
18
    code = gs_arcto(ctx->pgs, 190, 0, 190, 6, 6, 0);
1984
18
    if (code < 0) goto exit;
1985
18
    code = gs_arcto(ctx->pgs, 190, 47, 184, 47, 6, 0);
1986
18
    if (code < 0) goto exit;
1987
18
    code = gs_arcto(ctx->pgs, 0, 47, 0, 41, 6, 0);
1988
18
    if (code < 0) goto exit;
1989
18
    code = gs_arcto(ctx->pgs, 0, 0, 6, 0, 6, 0);
1990
18
    if (code < 0) goto exit;
1991
18
    code = gs_closepath(ctx->pgs);
1992
18
    if (code < 0) goto exit;
1993
1994
18
    code = gs_moveto(ctx->pgs, 10, 4);
1995
18
    if (code < 0) goto exit;
1996
18
    code = gs_arcto(ctx->pgs, 185, 4, 185, 9, 5, 0);
1997
18
    if (code < 0) goto exit;
1998
18
    code = gs_arcto(ctx->pgs, 185, 43, 180, 43, 5, 0);
1999
18
    if (code < 0) goto exit;
2000
18
    code = gs_arcto(ctx->pgs, 5, 43, 5, 38, 5, 0);
2001
18
    if (code < 0) goto exit;
2002
18
    code = gs_arcto(ctx->pgs, 5, 4, 9, 4, 5, 0);
2003
18
    if (code < 0) goto exit;
2004
18
    code = gs_closepath(ctx->pgs);
2005
18
    if (code < 0) goto exit;
2006
18
    code = gs_eofill(ctx->pgs);
2007
18
    if (code < 0) goto exit;
2008
2009
18
 exit:
2010
18
    return code;
2011
18
}
2012
2013
/* draw text for stamp */
2014
static int pdfi_annot_draw_stamp_text(pdf_context *ctx, pdf_dict *annot, gs_rect *rect,
2015
                                      pdfi_annot_stamp_text_t *text)
2016
18
{
2017
18
    int code = 0;
2018
18
    int code1 = 0;
2019
18
    pdf_string *string = NULL;
2020
18
    gs_rect bbox;
2021
18
    gs_point awidth;
2022
18
    double x,y;
2023
2024
18
    if (!text->text)
2025
9
        return 0;
2026
2027
9
    code = pdfi_BT(ctx);
2028
9
    if (code < 0)
2029
0
        return code;
2030
2031
9
    code = pdfi_annot_set_font(ctx, "Times-Bold", text->h);
2032
9
    if (code < 0) goto exit;
2033
2034
9
    code = pdfi_obj_charstr_to_string(ctx, text->text, &string);
2035
9
    if (code < 0) goto exit;
2036
2037
2038
    /* At this point the graphics state is slightly rotated and current position
2039
     * is at the lower left corner of the stamp's box.
2040
     * The math here matches what the gs code does, so it's kind of confusing.
2041
     */
2042
    /* Get width of the string */
2043
9
    code = pdfi_string_bbox(ctx, string, &bbox, &awidth, false);
2044
9
    if (code < 0) goto exit;
2045
2046
    /* Calculate offset from corner (95 is hard-coded value based on size of the stamp I think) */
2047
9
    x = 95 - (bbox.q.x-bbox.p.x)/2; /* hard-coded value taken from gs code */
2048
9
    y = text->y;
2049
2050
9
    code = pdfi_gsave(ctx);
2051
9
    code = pdfi_gs_setgray(ctx, .75);
2052
9
    code = pdfi_annot_display_simple_text(ctx, annot, x+1, y-1, string);
2053
9
    if (code < 0) goto exit;
2054
9
    code = pdfi_grestore(ctx);
2055
2056
9
    code = pdfi_annot_display_simple_text(ctx, annot, x, y, string);
2057
9
    if (code < 0) goto exit;
2058
2059
9
 exit:
2060
9
    code1 = pdfi_ET(ctx);
2061
9
    if (code == 0) code = code1;
2062
9
    pdfi_countdown(string);
2063
9
    return 0;
2064
9
}
2065
2066
/* Generate appearance (see pdf_draw.ps/Stamp)
2067
 *
2068
 * If there was an AP it was already handled.
2069
 * For testing, see tests_private/pdf/PDF_1.7_FTS/fts_32_3204.pdf
2070
 */
2071
static int pdfi_annot_draw_Stamp(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
2072
51
{
2073
51
    int code = 0;
2074
51
    int code1 = 0;
2075
51
    gs_rect rect;
2076
51
    double width, height;
2077
51
    pdfi_annot_stamp_type_t *stamp_type;
2078
51
    pdf_name *Name = NULL;
2079
51
    double xscale, yscale;
2080
51
    double angle;
2081
51
    int i;
2082
2083
51
    code = pdfi_annot_start_transparency(ctx, annot);
2084
51
    if (code < 0) goto exit1;
2085
2086
51
    code = pdfi_annot_Rect(ctx, annot, &rect);
2087
51
    if (code < 0) goto exit;
2088
2089
37
    code = pdfi_dict_knownget_type(ctx, annot, "Name", PDF_NAME, (pdf_obj **)&Name);
2090
37
    if (code <= 0) goto exit;
2091
2092
    /* Translate to the center of Rect */
2093
37
    width = rect.q.x - rect.p.x;
2094
37
    height = rect.q.y - rect.p.y;
2095
37
    code = gs_translate(ctx->pgs, rect.p.x + width/2, rect.p.y + height/2);
2096
37
    if (code < 0) goto exit;
2097
2098
    /* This math comes from the PS code.  I assume the values are related to
2099
       the h and y values in the various Stamp type data.
2100
    */
2101
    /* Scale by the minimum of the two ratios, but make sure it's not 0 */
2102
37
    yscale = height / 50.;
2103
37
    xscale = width / 190.;
2104
37
    if (xscale < yscale)
2105
19
        yscale = xscale;
2106
37
    if (yscale <= 0.0)
2107
0
        yscale = 1.0;
2108
37
    code = gs_scale(ctx->pgs, yscale, yscale);
2109
37
    if (code < 0) goto exit;
2110
2111
    /* Search through types and find a match, if no match use Draft */
2112
489
    for (stamp_type = pdfi_annot_stamp_types; stamp_type->type; stamp_type ++) {
2113
461
        if (Name && pdfi_name_is(Name, stamp_type->type))
2114
9
            break;
2115
461
    }
2116
2117
    /* TODO: There are a bunch of Stamp Names built into AR that are not part of
2118
     * the spec.  Since we don't know about them, we will just display nothing.
2119
     * Example: the "Faces" stamps, such as FacesZippy
2120
     * See file tests_private/pdf/uploads/annots-noAP.pdf
2121
     */
2122
37
    if (!stamp_type->type) {
2123
28
        code = pdfi_set_warning_stop(ctx, gs_note_error(gs_error_undefined), NULL, W_PDF_ANNOT_ERROR, "pdfi_annot_draw_Stamp", "WARNING: Annotation: No AP, unknown Stamp Name, omitting");
2124
28
        goto exit;
2125
28
    }
2126
2127
    /* Draw the frame */
2128
9
    code = pdfi_gs_setrgbcolor(ctx, stamp_type->rgb.r, stamp_type->rgb.g,
2129
9
                               stamp_type->rgb.b);
2130
9
    if (code < 0) goto exit;
2131
2132
9
    code = gs_translate(ctx->pgs, -95, -25);
2133
9
    if (code < 0) goto exit;
2134
9
    code = gs_atan2_degrees(2.0, 190.0, &angle);
2135
9
    if (code < 0) goto exit;
2136
9
    code = gs_rotate(ctx->pgs, angle);
2137
9
    if (code < 0) goto exit;
2138
2139
    /* Draw frame in gray */
2140
9
    code = pdfi_gsave(ctx);
2141
9
    code = gs_translate(ctx->pgs, 1, -1);
2142
9
    code = pdfi_gs_setgray(ctx, 0.75);
2143
9
    code = pdfi_annot_draw_stamp_frame(ctx);
2144
9
    code = pdfi_grestore(ctx);
2145
2146
    /* Draw frame colored */
2147
9
    code = pdfi_annot_draw_stamp_frame(ctx);
2148
2149
    /* Draw the text */
2150
27
    for (i=0; i<2; i++) {
2151
18
        code = pdfi_annot_draw_stamp_text(ctx, annot, &rect, &stamp_type->text[i]);
2152
18
        if (code < 0) goto exit;
2153
18
    }
2154
2155
51
 exit:
2156
51
    code1 = pdfi_annot_end_transparency(ctx, annot);
2157
51
    if (code >= 0)
2158
37
        code = code1;
2159
51
 exit1:
2160
51
    pdfi_countdown(Name);
2161
51
    *render_done = true;
2162
51
    return code;
2163
51
}
2164
/*********** END /Stamp ***************/
2165
2166
2167
/* Draw Callout Line (CL) */
2168
static int pdfi_annot_draw_CL(pdf_context *ctx, pdf_dict *annot)
2169
84
{
2170
84
    int code;
2171
84
    pdf_array *CL = NULL;
2172
84
    double array[6];
2173
84
    int length;
2174
2175
84
    code = pdfi_dict_knownget_type(ctx, annot, "CL", PDF_ARRAY, (pdf_obj **)&CL);
2176
84
    if (code <= 0) goto exit;
2177
2178
0
    length = pdfi_array_size(CL);
2179
2180
0
    if (length != 4 && length != 6) {
2181
0
        code = gs_note_error(gs_error_syntaxerror);
2182
0
        goto exit;
2183
0
    }
2184
2185
0
    code = pdfi_array_to_num_array(ctx, CL, array, 0, length);
2186
0
    if (code < 0) goto exit;
2187
2188
    /* Draw the line */
2189
0
    code = gs_moveto(ctx->pgs, array[0], array[1]);
2190
0
    if (code < 0) goto exit;
2191
0
    code = gs_lineto(ctx->pgs, array[2], array[3]);
2192
0
    if (code < 0) goto exit;
2193
0
    if (length == 6) {
2194
0
        code = gs_lineto(ctx->pgs, array[4], array[5]);
2195
0
        if (code < 0) goto exit;
2196
0
    }
2197
0
    code = gs_stroke(ctx->pgs);
2198
2199
    /* Line ending
2200
     * NOTE: This renders a different arrow than the gs code, but I used the
2201
     * same LE code I used elsewhere, which is clearly better.  So there will be diffs...
2202
     */
2203
0
    code = pdfi_annot_draw_LE(ctx, annot, array[0], array[1], array[2], array[3], 1);
2204
0
    if (code < 0) goto exit;
2205
2206
84
 exit:
2207
84
    pdfi_countdown(CL);
2208
84
    return code;
2209
0
}
2210
2211
/* FreeText -- Draw text with border around it.
2212
 *
2213
 * See pdf_draw.ps/FreeText
2214
 * If there was an AP it was already handled
2215
 */
2216
static int pdfi_annot_draw_FreeText(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
2217
85
{
2218
85
    int code = 0;
2219
85
    int code1 = 0;
2220
85
    bool drawbackground;
2221
85
    pdf_dict *BS = NULL;
2222
85
    pdf_string *Contents = NULL;
2223
85
    gs_rect annotrect, modrect;
2224
85
    int64_t Rotate;
2225
2226
85
    *render_done = false;
2227
2228
85
    code = pdfi_annot_start_transparency(ctx, annot);
2229
85
    if (code < 0) goto exit1;
2230
2231
85
    code = pdfi_annot_opacity(ctx, annot);
2232
85
    if (code < 0) goto exit;
2233
2234
85
    code = pdfi_annot_Rect(ctx, annot, &annotrect);
2235
85
    if (code < 0) goto exit;
2236
2237
    /* Set the (background?) color if applicable */
2238
85
    code = pdfi_annot_setcolor(ctx, annot, false, &drawbackground);
2239
85
    if (code < 0) goto exit;
2240
2241
    /* Only draw rectangle if a color was specified */
2242
85
    if (drawbackground) {
2243
0
        code = pdfi_annot_fillRect(ctx, annot);
2244
0
        if (code < 0) goto exit;
2245
0
    }
2246
2247
    /* Set DA (Default Appearance)
2248
     * This will generally set a color and font.
2249
     *
2250
     * TODO: Unclear if this is supposed to also determine the color
2251
     * of the border box, but it seems like it does in gs, so we set the DA
2252
     * before drawing the border, like gs does.
2253
     */
2254
85
    code = pdfi_annot_process_DA(ctx, NULL, annot, &annotrect, false);
2255
85
    if (code < 0) goto exit;
2256
2257
    /* Draw border around text */
2258
    /* TODO: gs-compatible implementation is commented out.  Would rather just delete it... */
2259
85
#if 1
2260
    /* TODO: Prefer to do it this way! */
2261
85
    code = pdfi_annot_draw_border(ctx, annot, false);
2262
85
    if (code < 0) goto exit;
2263
#else
2264
    /* NOTE: I would really like to just call pdfi_annot_draw_border()
2265
     * without checking for BS, but the implementation in gs is subtly different (see below)
2266
     * and I want to make it possible to bmpcmp.
2267
     */
2268
    code = pdfi_dict_knownget_type(ctx, annot, "BS", PDF_DICT, (pdf_obj **)&BS);
2269
    if (code < 0) goto exit;
2270
    if (BS) {
2271
        code = pdfi_annot_draw_border(ctx, annot, false);
2272
        if (code < 0) goto exit;
2273
    } else {
2274
        gs_rect rect;
2275
2276
        /* Draw our own border */
2277
        code = pdfi_gs_setgray(ctx, 0);
2278
        if (code < 0) goto exit;
2279
2280
        /* NOTE: This is almost identical to pdfi_annot_strokeborder() with a width=1.0
2281
         * except it adjusts the rectangle by 1.0 instead of 0.5.
2282
         * Should probably just call that function, but I want to match gs implementation
2283
         * exactly for bmpcmp purposes.
2284
         */
2285
        code = gs_setlinewidth(ctx->pgs, 1);
2286
        if (code < 0) goto exit;
2287
2288
        code = pdfi_annot_Rect(ctx, annot, &rect);
2289
        if (code < 0) goto exit;
2290
2291
        pdfi_annot_rect_adjust(ctx, &rect, 1);
2292
        code = gs_rectstroke(ctx->pgs, &rect, 1, NULL);
2293
        if (code < 0) goto exit;
2294
    }
2295
#endif
2296
2297
84
    code = pdfi_annot_draw_CL(ctx, annot);
2298
84
    if (code < 0) goto exit;
2299
2300
    /* Modify rect by RD if applicable */
2301
84
    code = pdfi_annot_applyRD(ctx, annot, &annotrect);
2302
84
    if (code < 0) goto exit;
2303
2304
    /* /Rotate */
2305
84
    code = pdfi_dict_get_int_def(ctx, annot, "Rotate", &Rotate, 0);
2306
84
    if (code < 0) goto exit;
2307
2308
84
    modrect = annotrect; /* structure copy */
2309
    /* TODO: I think this can all be done in a generic way using gs_transform() but it
2310
     * makes my head explode...
2311
     */
2312
84
    switch(Rotate) {
2313
0
    case 270:
2314
0
        code = gs_moveto(ctx->pgs, modrect.q.y, modrect.q.x);
2315
0
        if (code < 0) goto exit;
2316
0
        code = gs_rotate(ctx->pgs, 270.0);
2317
0
        modrect.p.x = -annotrect.q.y;
2318
0
        modrect.q.x = -annotrect.p.y;
2319
0
        modrect.p.y = annotrect.p.x;
2320
0
        modrect.q.y = annotrect.q.x;
2321
0
        break;
2322
0
    case 180:
2323
0
        code = gs_moveto(ctx->pgs, modrect.q.x, modrect.p.y);
2324
0
        if (code < 0) goto exit;
2325
0
        code = gs_rotate(ctx->pgs, 180.0);
2326
0
        modrect.p.x = -annotrect.q.x;
2327
0
        modrect.q.x = -annotrect.p.x;
2328
0
        modrect.p.y = -annotrect.q.y;
2329
0
        modrect.q.y = -annotrect.p.y;
2330
0
        break;
2331
0
        break;
2332
2
    case 90:
2333
2
        code = gs_moveto(ctx->pgs, modrect.p.y, modrect.p.x);
2334
2
        if (code < 0) goto exit;
2335
2
        code = gs_rotate(ctx->pgs, 90.0);
2336
2
        modrect.p.x = annotrect.p.y;
2337
2
        modrect.q.x = annotrect.q.y;
2338
2
        modrect.p.y = -annotrect.q.x;
2339
2
        modrect.q.y = -annotrect.p.x;
2340
2
        break;
2341
82
    case 0:
2342
82
    default:
2343
82
        modrect.p.x += 2;
2344
82
        modrect.p.y += 2;
2345
82
        modrect.q.x -= 2;
2346
82
        modrect.q.y -= 2;
2347
2348
        /* Move to initial position (slightly offset from the corner of the rect) */
2349
82
        code = gs_moveto(ctx->pgs, modrect.p.x, modrect.q.y);
2350
82
        if (code < 0) goto exit;
2351
82
        break;
2352
84
    }
2353
2354
    /* /Contents */
2355
84
    code = pdfi_dict_knownget_type(ctx, annot, "Contents", PDF_STRING, (pdf_obj **)&Contents);
2356
84
    if (code < 0) goto exit;
2357
84
    if (code > 0) {
2358
73
        code = pdfi_annot_display_formatted_text(ctx, annot, &modrect, Contents, false);
2359
73
        if (code < 0) goto exit;
2360
73
    }
2361
2362
85
 exit:
2363
85
    code1 = pdfi_annot_end_transparency(ctx, annot);
2364
85
    if (code >= 0)
2365
84
        code = code1;
2366
85
 exit1:
2367
85
    *render_done = true;
2368
85
    pdfi_countdown(BS);
2369
85
    pdfi_countdown(Contents);
2370
85
    return code;
2371
85
}
2372
2373
/* Generate appearance (see pdf_draw.ps/Text)
2374
 * This draws the default "Note" thingy which looks like a little page.
2375
 * TODO: Spec lists a whole bunch of different /Name with different appearances that we don't handle.
2376
 * See page 1 of tests_private/pdf/sumatra/annotations_without_appearance_streams.pdf
2377
 *
2378
 * If there was an AP it was already handled.
2379
 */
2380
static int pdfi_annot_draw_Text(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
2381
34
{
2382
34
    int code = 0;
2383
34
    int code1 = 0;
2384
34
    gs_rect rect;
2385
2386
34
    code = pdfi_annot_start_transparency(ctx, annot);
2387
34
    if (code < 0) goto exit1;
2388
2389
34
    code = pdfi_annot_Rect(ctx, annot, &rect);
2390
34
    if (code < 0) goto exit;
2391
34
    code = gs_translate(ctx->pgs, rect.p.x, rect.p.y);
2392
34
    if (code < 0) goto exit;
2393
2394
    /* Draw a page icon (/Note) */
2395
    /* TODO: All the other /Name appearances */
2396
34
    code = gs_translate(ctx->pgs, 0.5, (rect.q.y-rect.p.y)-18.5);
2397
34
    if (code < 0) goto exit;
2398
34
    code = gs_setlinewidth(ctx->pgs, 1.0);
2399
34
    if (code < 0) goto exit;
2400
34
    code = pdfi_gs_setgray(ctx, 0.75);
2401
34
    if (code < 0) goto exit;
2402
34
    code = gs_moveto(ctx->pgs, 0.5, -1);
2403
34
    if (code < 0) goto exit;
2404
34
    code = gs_lineto(ctx->pgs, 10, -1);
2405
34
    if (code < 0) goto exit;
2406
34
    code = gs_lineto(ctx->pgs, 15, 4);
2407
34
    if (code < 0) goto exit;
2408
34
    code = gs_lineto(ctx->pgs, 15, 17.5);
2409
34
    if (code < 0) goto exit;
2410
34
    code = gs_stroke(ctx->pgs);
2411
34
    if (code < 0) goto exit;
2412
2413
34
    code = gs_moveto(ctx->pgs, 0, 0);
2414
34
    if (code < 0) goto exit;
2415
34
    code = gs_lineto(ctx->pgs, 9, 0);
2416
34
    if (code < 0) goto exit;
2417
34
    code = gs_lineto(ctx->pgs, 14, 5);
2418
34
    if (code < 0) goto exit;
2419
34
    code = gs_lineto(ctx->pgs, 14, 18);
2420
34
    if (code < 0) goto exit;
2421
34
    code = gs_lineto(ctx->pgs, 0, 18);
2422
34
    if (code < 0) goto exit;
2423
34
    code = gs_closepath(ctx->pgs);
2424
34
    if (code < 0) goto exit;
2425
2426
34
    code = pdfi_gsave(ctx);
2427
34
    if (code >= 0) {
2428
34
        code = pdfi_gs_setgray(ctx, 0.5);
2429
34
        code = gs_fill(ctx->pgs);
2430
34
        code = pdfi_grestore(ctx);
2431
34
    } else
2432
0
        goto exit;
2433
2434
34
    code = pdfi_gs_setgray(ctx, 0);
2435
34
    if (code < 0) goto exit;
2436
34
    code = gs_stroke(ctx->pgs);
2437
34
    if (code < 0) goto exit;
2438
2439
34
    code = gs_moveto(ctx->pgs, 3, 8);
2440
34
    if (code < 0) goto exit;
2441
34
    code = gs_lineto(ctx->pgs, 7.5, 8);
2442
34
    if (code < 0) goto exit;
2443
34
    code = gs_moveto(ctx->pgs, 3, 11);
2444
34
    if (code < 0) goto exit;
2445
34
    code = gs_lineto(ctx->pgs, 10, 11);
2446
34
    if (code < 0) goto exit;
2447
34
    code = gs_moveto(ctx->pgs, 3, 14);
2448
34
    if (code < 0) goto exit;
2449
34
    code = gs_lineto(ctx->pgs, 10, 14);
2450
34
    if (code < 0) goto exit;
2451
34
    code = gs_moveto(ctx->pgs, 9, 0);
2452
34
    if (code < 0) goto exit;
2453
34
    code = gs_lineto(ctx->pgs, 9, 5);
2454
34
    if (code < 0) goto exit;
2455
34
    code = gs_lineto(ctx->pgs, 14, 5);
2456
34
    if (code < 0) goto exit;
2457
34
    code = gs_stroke(ctx->pgs);
2458
34
    if (code < 0) goto exit;
2459
2460
34
 exit:
2461
34
    code1 = pdfi_annot_end_transparency(ctx, annot);
2462
34
    if (code >= 0)
2463
34
        code = code1;
2464
34
 exit1:
2465
34
    *render_done = true;
2466
34
    return code;
2467
34
}
2468
2469
/* Converts array of 4 points to a basis and 2 dimensions (6 values altogether)
2470
 *    x0 y0 x1 y1 x2 y2 x3 y3 -> x0 y0 x1-x0 y1-y0 x2-x0 y2-y0
2471
 *
2472
 *  ^
2473
 *  |
2474
 *  * (x2,y2)    * (x3,y3)
2475
 *  |
2476
 *  |
2477
 *  *------------*->
2478
 *  (x0,y0)      (x1,y1)
2479
 */
2480
static void pdfi_annot_quadpoints2basis(pdf_context *ctx, double *array,
2481
                                        double *px0, double *py0,
2482
                                        double *dx1, double *dy1,
2483
                                        double *dx2, double *dy2)
2484
7.63k
{
2485
7.63k
    double x0,x1,x2,x3,y0,y1,y2,y3;
2486
7.63k
    double minx, miny;
2487
7.63k
    int i, mindex;
2488
2489
    /* comment from the PS code
2490
    % The text is oriented with respect to the vertex with the smallest
2491
    % y value (or the leftmost of those, if there are two such vertices)
2492
    % (x0, y0) and the next vertex in a counterclockwise direction
2493
    % (x1, y1), regardless of whether these are the first two points in
2494
    % the QuadPoints array.
2495
    */
2496
2497
    /* starting min point */
2498
7.63k
    minx = array[0];
2499
7.63k
    miny = array[1];
2500
7.63k
    mindex = 0;
2501
    /* This finds the index of the point with miny and if there were two points with same
2502
     * miny, it finds the one with minx
2503
     */
2504
30.5k
    for (i=2; i<8; i+=2) {
2505
22.9k
        if ((array[i+1] == miny && array[i] < minx) ||  (array[i+1] < miny)) {
2506
            /* Set new min point */
2507
1.33k
            miny = array[i+1];
2508
1.33k
            minx = array[i];
2509
1.33k
            mindex = i;
2510
1.33k
        }
2511
22.9k
    }
2512
2513
    /* Pull out the points such that x0 = minx, y0 = miny, etc */
2514
7.63k
    i = mindex;
2515
7.63k
    x0 = array[i];
2516
7.63k
    y0 = array[i+1];
2517
7.63k
    i += 2;
2518
7.63k
    if (i == 8) i = 0;
2519
7.63k
    x1 = array[i];
2520
7.63k
    y1 = array[i+1];
2521
7.63k
    i += 2;
2522
7.63k
    if (i == 8) i = 0;
2523
7.63k
    x2 = array[i];
2524
7.63k
    y2 = array[i+1];
2525
7.63k
    i += 2;
2526
7.63k
    if (i == 8) i = 0;
2527
7.63k
    x3 = array[i];
2528
7.63k
    y3 = array[i+1];
2529
2530
    /* Make it go counterclockwise by picking lower of these 2 points */
2531
7.63k
    if (y3 < y1) {
2532
230
        y1 = y3;
2533
230
        x1 = x3;
2534
230
    }
2535
2536
    /* Convert into a starting point and two sets of lengths */
2537
7.63k
    *px0 = x0;
2538
7.63k
    *py0 = y0;
2539
7.63k
    *dx1 = x1 - x0;
2540
7.63k
    *dy1 = y1 - y0;
2541
7.63k
    *dx2 = x2 - x0;
2542
7.63k
    *dy2 = y2 - y0;
2543
7.63k
}
2544
2545
/* Generate appearance for Underline or StrikeOut (see pdf_draw.ps/Underline and Strikeout)
2546
 *
2547
 * offset -- how far above the QuadPoints box bottom to draw the line
2548
 *
2549
 */
2550
static int pdfi_annot_draw_line_offset(pdf_context *ctx, pdf_dict *annot, double offset)
2551
603
{
2552
603
    int code = 0;
2553
603
    bool drawit;
2554
603
    pdf_array *QuadPoints = NULL;
2555
603
    double array[8];
2556
603
    int size;
2557
603
    int num_quads;
2558
603
    int i;
2559
603
    double x0, y0, dx1, dy1, dx2, dy2;
2560
603
    double linewidth;
2561
2562
603
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
2563
603
    if (code <0 || !drawit)
2564
18
        goto exit;
2565
2566
585
    code = pdfi_dict_knownget_type(ctx, annot, "QuadPoints", PDF_ARRAY, (pdf_obj **)&QuadPoints);
2567
585
    if (code <= 0) goto exit;
2568
2569
583
    size = pdfi_array_size(QuadPoints);
2570
583
    num_quads = size / 8;
2571
2572
7.41k
    for (i=0; i<num_quads; i++) {
2573
6.84k
        code = pdfi_array_to_num_array(ctx, QuadPoints, array, i*8, 8);
2574
6.84k
        if (code < 0) goto exit;
2575
2576
6.83k
        pdfi_annot_quadpoints2basis(ctx, array, &x0, &y0, &dx1, &dy1, &dx2, &dy2);
2577
2578
        /* Acrobat draws the line at offset-ratio of the box width from the bottom of the box
2579
         * and 1/16 thick of the box width.  /Rect is ignored.
2580
         */
2581
6.83k
        linewidth = sqrt((dx2*dx2) + (dy2*dy2)) / 16.;
2582
6.83k
        code = gs_setlinewidth(ctx->pgs, linewidth);
2583
6.83k
        if (code < 0) goto exit;
2584
6.83k
        code = gs_moveto(ctx->pgs, dx2*offset + x0 , dy2*offset + y0);
2585
6.83k
        if (code < 0) goto exit;
2586
6.83k
        code = gs_lineto(ctx->pgs, dx2*offset + x0 + dx1, dy2*offset + y0 + dy1);
2587
6.83k
        if (code < 0) goto exit;
2588
6.83k
        code = gs_stroke(ctx->pgs);
2589
6.83k
        if (code < 0) goto exit;
2590
6.83k
    }
2591
2592
603
 exit:
2593
603
    pdfi_countdown(QuadPoints);
2594
603
    return code;
2595
583
}
2596
2597
/* Generate appearance (see pdf_draw.ps/StrikeOut)
2598
 *
2599
 * If there was an AP it was already handled.
2600
 */
2601
static int pdfi_annot_draw_StrikeOut(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
2602
514
{
2603
514
    *render_done = true;
2604
514
    return pdfi_annot_draw_line_offset(ctx, annot, 3/7.);
2605
514
}
2606
2607
/* Generate appearance (see pdf_draw.ps/Underline)
2608
 *
2609
 * If there was an AP it was already handled.
2610
 */
2611
static int pdfi_annot_draw_Underline(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
2612
89
{
2613
89
    *render_done = true;
2614
89
    return pdfi_annot_draw_line_offset(ctx, annot, 1/7.);
2615
89
}
2616
2617
/* Connect 2 points with an arc that has max distance from the line segment to the arc
2618
 * equal to 1/4 of the radius.
2619
 */
2620
static int pdfi_annot_highlight_arc(pdf_context *ctx, double x0, double y0,
2621
                                    double x1, double y1)
2622
12.8k
{
2623
12.8k
    int code = 0;
2624
12.8k
    double dx, dy;
2625
12.8k
    double xc, yc, r, a1, a2;
2626
2627
12.8k
    dx = x1 - x0;
2628
12.8k
    dy = y1 - y0;
2629
2630
12.8k
    yc = (y1+y0)/2. - 15./16.*dx;
2631
12.8k
    xc = (x1+x0)/2. + 15./16.*dy;
2632
12.8k
    r = sqrt((y1-yc)*(y1-yc) + (x1-xc)*(x1-xc));
2633
12.8k
    code = gs_atan2_degrees(y1-yc, x1-xc, &a1);
2634
12.8k
    if (code < 0)
2635
84
        a1 = 0;
2636
12.8k
    code = gs_atan2_degrees(y0-yc, x0-xc, &a2);
2637
12.8k
    if (code < 0)
2638
84
        a2 = 0;
2639
12.8k
    code = gs_arcn(ctx->pgs, xc, yc, r, a2, a1);
2640
2641
12.8k
    return code;
2642
12.8k
}
2643
2644
/* Generate appearance (see pdf_draw.ps/Highlight)
2645
 *
2646
 * If there was an AP it was already handled.
2647
 */
2648
static int pdfi_annot_draw_Highlight(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
2649
1.17k
{
2650
1.17k
    int code = 0;
2651
1.17k
    bool drawit;
2652
1.17k
    pdf_array *QuadPoints = NULL;
2653
1.17k
    double array[8];
2654
1.17k
    int size;
2655
1.17k
    int num_quads;
2656
1.17k
    int i;
2657
2658
1.17k
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
2659
1.17k
    if (code <0 || !drawit)
2660
26
        goto exit;
2661
2662
1.14k
    code = gs_setlinecap(ctx->pgs, 1);
2663
1.14k
    if (code < 0) goto exit;
2664
2665
1.14k
    code = pdfi_dict_knownget_type(ctx, annot, "QuadPoints", PDF_ARRAY, (pdf_obj **)&QuadPoints);
2666
1.14k
    if (code <= 0) goto exit;
2667
2668
1.13k
    size = pdfi_array_size(QuadPoints);
2669
1.13k
    num_quads = size / 8;
2670
2671
7.48k
    for (i=0; i<num_quads; i++) {
2672
6.47k
        code = pdfi_array_to_num_array(ctx, QuadPoints, array, i*8, 8);
2673
6.47k
        if (code < 0) goto exit;
2674
2675
6.43k
        code = gs_moveto(ctx->pgs, array[2], array[3]);
2676
6.43k
        if (code < 0) goto exit;
2677
2678
6.43k
        code = pdfi_annot_highlight_arc(ctx, array[2], array[3], array[6], array[7]);
2679
6.43k
        if (code < 0) goto exit;
2680
2681
6.40k
        code = gs_lineto(ctx->pgs, array[4], array[5]);
2682
6.40k
        if (code < 0) goto exit;
2683
2684
6.40k
        code = pdfi_annot_highlight_arc(ctx, array[4], array[5], array[0], array[1]);
2685
6.40k
        if (code < 0) goto exit;
2686
2687
6.35k
        code = gs_closepath(ctx->pgs);
2688
6.35k
        if (code < 0) goto exit;
2689
2690
6.35k
        if (ctx->page.has_transparency) {
2691
6.35k
            code = pdfi_trans_begin_simple_group(ctx, NULL, false, false, false);
2692
6.35k
            if (code < 0) goto exit;
2693
2694
6.35k
            code = gs_setblendmode(ctx->pgs, BLEND_MODE_Multiply);
2695
6.35k
            if (code < 0) {
2696
0
                (void)pdfi_trans_end_simple_group(ctx);
2697
0
                goto exit;
2698
0
            }
2699
6.35k
            code = gs_fill(ctx->pgs);
2700
6.35k
            (void)pdfi_trans_end_simple_group(ctx);
2701
6.35k
            if (code < 0) goto exit;
2702
6.35k
        } else {
2703
0
            code = gs_stroke(ctx->pgs);
2704
0
            if (code < 0) goto exit;
2705
2706
0
            code = gs_newpath(ctx->pgs);
2707
0
            if (code < 0) goto exit;
2708
0
        }
2709
6.35k
    }
2710
2711
1.17k
 exit:
2712
1.17k
    pdfi_countdown(QuadPoints);
2713
1.17k
    return code;
2714
1.13k
}
2715
2716
/* Generate appearance (see pdf_draw.ps/Squiggly)
2717
 *
2718
 * If there was an AP it was already handled.
2719
 */
2720
static int pdfi_annot_draw_Squiggly(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
2721
334
{
2722
334
    int code = 0;
2723
334
    bool drawit;
2724
334
    pdf_array *QuadPoints = NULL;
2725
334
    double array[8];
2726
334
    int size;
2727
334
    int num_quads;
2728
334
    int i;
2729
334
    double x0, y0, dx1, dy1, dx2, dy2;
2730
334
    double p1, p2, p12;
2731
334
    int count;
2732
334
    bool need_grestore = false;
2733
334
    gs_matrix matrix;
2734
2735
334
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
2736
334
    if (code <0 || !drawit)
2737
9
        goto exit;
2738
2739
325
    code = gs_setlinecap(ctx->pgs, gs_cap_round);
2740
325
    if (code < 0) goto exit;
2741
325
    code = gs_setlinejoin(ctx->pgs, gs_join_round);
2742
325
    if (code < 0) goto exit;
2743
325
    code = gs_setlinewidth(ctx->pgs, 1.0);
2744
325
    if (code < 0) goto exit;
2745
2746
325
    code = pdfi_dict_knownget_type(ctx, annot, "QuadPoints", PDF_ARRAY, (pdf_obj **)&QuadPoints);
2747
325
    if (code <= 0) goto exit;
2748
2749
320
    size = pdfi_array_size(QuadPoints);
2750
320
    num_quads = size / 8;
2751
2752
1.12k
    for (i=0; i<num_quads; i++) {
2753
818
        code = pdfi_array_to_num_array(ctx, QuadPoints, array, i*8, 8);
2754
818
        if (code < 0) goto exit;
2755
2756
805
        code = pdfi_gsave(ctx);
2757
805
        if (code < 0) goto exit;
2758
805
        need_grestore = true;
2759
2760
        /* Make clipping region */
2761
805
        code = gs_moveto(ctx->pgs, array[6], array[7]);
2762
805
        if (code < 0) goto exit;
2763
805
        code = gs_lineto(ctx->pgs, array[4], array[5]);
2764
805
        if (code < 0) goto exit;
2765
805
        code = gs_lineto(ctx->pgs, array[0], array[1]);
2766
805
        if (code < 0) goto exit;
2767
805
        code = gs_lineto(ctx->pgs, array[2], array[3]);
2768
805
        if (code < 0) goto exit;
2769
805
        code = gs_closepath(ctx->pgs);
2770
805
        if (code < 0) goto exit;
2771
805
        code = gs_clip(ctx->pgs);
2772
805
        if (code < 0) goto exit;
2773
805
        code = gs_newpath(ctx->pgs);
2774
805
        if (code < 0) goto exit;
2775
2776
805
        pdfi_annot_quadpoints2basis(ctx, array, &x0, &y0, &dx1, &dy1, &dx2, &dy2);
2777
2778
805
        code = gs_translate(ctx->pgs, x0+dx2/56+dx2/72, y0+dy2/56+dy2/72);
2779
805
        if (code < 0) goto exit;
2780
2781
805
        p2 = sqrt(dx2*dx2 + dy2*dy2);
2782
805
        p1 = sqrt(dx1*dx1 + dy1*dy1);
2783
2784
805
        if (p2 > 0 && p1 > 0) {
2785
800
            p12 = p2 / p1;
2786
2787
800
            count = (int)((1/p12) * 4 + 1);
2788
2789
800
            matrix.xx = dx1 * p12;
2790
800
            matrix.xy = dy1 * p12;
2791
800
            matrix.yx = dx2;
2792
800
            matrix.yy = dy2;
2793
800
            matrix.tx = 0.0;
2794
800
            matrix.ty = 0.0;
2795
800
            code = gs_concat(ctx->pgs, &matrix);
2796
800
            if (code < 0) goto exit;
2797
2798
800
            code = gs_scale(ctx->pgs, 1/40., 1/72.);
2799
800
            if (code < 0) goto exit;
2800
2801
800
            code = gs_moveto(ctx->pgs, 0, 0);
2802
800
            if (code < 0) goto exit;
2803
2804
235k
            while (count >= 0) {
2805
234k
                code = gs_lineto(ctx->pgs, 5, 10);
2806
234k
                if (code < 0) goto exit;
2807
234k
                code = gs_lineto(ctx->pgs, 10, 0);
2808
234k
                if (code < 0) goto exit;
2809
234k
                code = gs_translate(ctx->pgs, 10, 0);
2810
234k
                if (code < 0) goto exit;
2811
2812
234k
                count --;
2813
234k
            }
2814
800
            code = gs_stroke(ctx->pgs);
2815
800
            if (code < 0) goto exit;
2816
800
        }
2817
2818
805
        need_grestore = false;
2819
805
        code = pdfi_grestore(ctx);
2820
805
        if (code < 0) goto exit;
2821
805
    }
2822
2823
334
 exit:
2824
334
    if (need_grestore)
2825
0
        (void)pdfi_grestore(ctx);
2826
334
    pdfi_countdown(QuadPoints);
2827
334
    *render_done = true;
2828
334
    return code;
2829
320
}
2830
2831
/* Generate appearance (see pdf_draw.ps/Redact)
2832
 *
2833
 * If there was an AP it was already handled.
2834
 */
2835
static int pdfi_annot_draw_Redact(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
2836
0
{
2837
    /* comment from PS code:
2838
    %% Redact annotations are part of a process, a Redact annotation is only present
2839
    %% until the content is removed, before that the content should be present and
2840
    %% I believe we should print it. So take no action for Redact annotations if they
2841
    %% have no appearance.
2842
    */
2843
    /* Render nothing, don't print warning */
2844
0
    *render_done = true;
2845
0
    return 0;
2846
0
}
2847
2848
/* Handle PopUp (see pdf_draw.ps/Popup)
2849
 * Renders only if /Open=true
2850
 *
2851
 * If there's an AP, caller will handle it on return
2852
 */
2853
static int pdfi_annot_draw_Popup(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
2854
8.91k
{
2855
8.91k
    int code = 0, code1 = 0;
2856
8.91k
    bool Open = false;
2857
8.91k
    pdf_dict *Parent = NULL;
2858
8.91k
    pdf_string *Contents = NULL;
2859
8.91k
    pdf_string *T = NULL;
2860
8.91k
    bool has_color;
2861
8.91k
    gs_rect rect, rect2;
2862
8.91k
    bool need_grestore = false;
2863
2864
    /* Render only if open */
2865
8.91k
    code = pdfi_dict_get_bool(ctx, annot, "Open", &Open);
2866
8.91k
    if (code < 0 && (code != gs_error_undefined))
2867
0
        goto exit1;
2868
2869
8.91k
    code = 0;
2870
2871
    /* Don't render if not Open */
2872
8.91k
    if (!Open) {
2873
8.49k
        *render_done = true;
2874
8.49k
        goto exit1;
2875
8.49k
    }
2876
2877
    /* Let caller render if there is an AP */
2878
416
    if (NormAP) {
2879
0
        *render_done = false;
2880
0
        goto exit1;
2881
0
    }
2882
2883
    /* regardless what happens next, tell caller we rendered it */
2884
416
    *render_done = true;
2885
2886
416
    code = pdfi_annot_start_transparency(ctx, annot);
2887
416
    if (code < 0) goto exit1;
2888
2889
416
    code = gs_setlinewidth(ctx->pgs, 0.05);
2890
2891
416
    code = pdfi_loop_detector_mark(ctx);
2892
416
    if (code < 0)
2893
0
        goto exit;
2894
2895
    /* Use Parent to get color */
2896
    /* We must not store the derferenced Parent in the Annot, because the Parent is (or might be)
2897
     * the Page dictionary, which contains the Annots array. If we replace the indirect reference
2898
     * to Parent in the Annot then we end up with a circular reference and leak both objects.
2899
     */
2900
416
    code = pdfi_dict_knownget_type_no_store_R(ctx, annot, "Parent", PDF_DICT, (pdf_obj **)&Parent);
2901
416
    if (code < 0) goto exit;
2902
392
    if (code == 0) {
2903
0
        code = pdfi_dict_knownget_type_no_store_R(ctx, annot, "P", PDF_DICT, (pdf_obj **)&Parent);
2904
0
        if (code < 0) goto exit;
2905
0
    }
2906
392
    (void)pdfi_loop_detector_cleartomark(ctx);
2907
2908
392
    if (code == 0) {
2909
        /* If no parent, we will use the annotation itself */
2910
0
        Parent = annot;
2911
0
        pdfi_countup(Parent);
2912
0
    }
2913
2914
    /* Set color if there is one specified */
2915
392
    code = pdfi_annot_setcolor(ctx, Parent, false, &has_color);
2916
392
    if (code < 0) goto exit;
2917
2918
    /* Set a default color if nothing specified */
2919
392
    if (!has_color) {
2920
5
        code = pdfi_gs_setrgbcolor(ctx, 1.0, 1.0, 0);
2921
5
        if (code < 0) goto exit;
2922
5
    }
2923
2924
392
    code = pdfi_annot_Rect(ctx, annot, &rect);
2925
392
    if (code < 0) goto exit;
2926
2927
    /* Draw big box (the frame around the /Contents) */
2928
392
    code = pdfi_gsave(ctx);
2929
392
    if (code < 0) goto exit;
2930
392
    need_grestore = true;
2931
392
    code = pdfi_gs_setgray(ctx, 1);
2932
392
    if (code < 0) goto exit;
2933
392
    code = gs_rectfill(ctx->pgs, &rect, 1);
2934
392
    if (code < 0) goto exit;
2935
392
    code = pdfi_gs_setgray(ctx, 0);
2936
392
    if (code < 0) goto exit;
2937
392
    code = gs_rectstroke(ctx->pgs, &rect, 1, NULL);
2938
392
    if (code < 0) goto exit;
2939
392
    code = pdfi_grestore(ctx);
2940
392
    need_grestore = false;
2941
392
    if (code < 0) goto exit;
2942
2943
    /* Display /Contents in Helvetica */
2944
392
    code = pdfi_dict_knownget_type(ctx, Parent, "Contents", PDF_STRING, (pdf_obj **)&Contents);
2945
392
    if (code < 0) goto exit;
2946
392
    if (code > 0) {
2947
387
        gs_rect text_rect;
2948
2949
387
        code = pdfi_gsave(ctx);
2950
387
        if (code < 0) goto exit;
2951
387
        need_grestore = true;
2952
387
        code = pdfi_gs_setgray(ctx, 0);
2953
387
        if (code < 0) goto exit;
2954
2955
387
        text_rect.p.x = rect.p.x + 3;
2956
387
        text_rect.q.x = rect.q.x - 3;
2957
387
        text_rect.p.y = rect.p.y + 3;
2958
387
        text_rect.q.y = rect.q.y - 18;
2959
2960
387
        code = pdfi_annot_set_font(ctx, "Helvetica", 9);
2961
387
        if (code < 0) goto exit;
2962
2963
387
        code = pdfi_annot_display_formatted_text(ctx, annot, &text_rect, Contents, false);
2964
387
        if (code < 0) goto exit;
2965
2966
387
        code = pdfi_grestore(ctx);
2967
387
        need_grestore = false;
2968
387
        if (code < 0) goto exit;
2969
387
    }
2970
2971
    /* Draw small, thin box (the frame around the top /T text) */
2972
392
    rect2.p.x = rect.p.x;
2973
392
    rect2.p.y = rect.q.y - 15;
2974
392
    rect2.q.x = rect.q.x;
2975
392
    rect2.q.y = rect.p.y + (rect.q.y - rect.p.y);
2976
2977
392
    code = gs_rectfill(ctx->pgs, &rect2, 1);
2978
392
    if (code < 0) goto exit;
2979
392
    code = pdfi_gs_setgray(ctx, 0);
2980
392
    if (code < 0) goto exit;
2981
392
    code = gs_rectstroke(ctx->pgs, &rect2, 1, NULL);
2982
392
    if (code < 0) goto exit;
2983
2984
    /* Display /T in Helvetica */
2985
392
    code = pdfi_dict_knownget_type(ctx, Parent, "T", PDF_STRING, (pdf_obj **)&T);
2986
392
    if (code < 0) goto exit;
2987
392
    if (code > 0) {
2988
390
        code = pdfi_annot_set_font(ctx, "Helvetica", 9);
2989
390
        if (code < 0) goto exit;
2990
2991
390
        code = pdfi_annot_display_centered_text(ctx, annot, &rect, T);
2992
390
        if (code < 0) goto exit;
2993
2994
390
    }
2995
2996
416
 exit:
2997
416
    if (need_grestore) {
2998
0
        code1= pdfi_grestore(ctx);
2999
0
        if (code == 0) code = code1;
3000
0
    }
3001
416
    code1 = pdfi_annot_end_transparency(ctx, annot);
3002
416
    if (code == 0) code = code1;
3003
8.91k
 exit1:
3004
8.91k
    pdfi_countdown(Parent);
3005
8.91k
    pdfi_countdown(Contents);
3006
8.91k
    pdfi_countdown(T);
3007
8.91k
    return code;
3008
416
}
3009
3010
/* Generate appearance (see pdf_draw.ps/Line)
3011
 *
3012
 * If there was an AP it was already handled.
3013
 */
3014
static int pdfi_annot_draw_Line(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
3015
1.15k
{
3016
1.15k
    int code = 0;
3017
1.15k
    int code1 = 0;
3018
1.15k
    gs_rect lrect;
3019
1.15k
    pdf_array *L = NULL;
3020
1.15k
    bool drawit;
3021
3022
1.15k
    code = pdfi_annot_start_transparency(ctx, annot);
3023
1.15k
    if (code < 0) goto exit1;
3024
3025
1.15k
    code = pdfi_dict_knownget_type(ctx, annot, "L", PDF_ARRAY, (pdf_obj **)&L);
3026
1.15k
    if (code < 0) goto exit;
3027
3028
1.15k
    code = pdfi_array_to_gs_rect(ctx, L, &lrect);
3029
1.15k
    if (code < 0) goto exit;
3030
3031
1.14k
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3032
1.14k
    if (code < 0) goto exit;
3033
3034
    /* Handle LE */
3035
1.14k
    code = pdfi_annot_draw_LE(ctx, annot, lrect.p.x, lrect.p.y, lrect.q.x, lrect.q.y, 0);
3036
1.14k
    if (code < 0) goto exit;
3037
3038
    /* Draw the actual line */
3039
1.13k
    code = gs_moveto(ctx->pgs, lrect.p.x, lrect.p.y);
3040
1.13k
    if (code < 0) goto exit;
3041
1.13k
    code = gs_lineto(ctx->pgs, lrect.q.x, lrect.q.y);
3042
1.13k
    if (code < 0) goto exit;
3043
1.13k
    code = pdfi_annot_draw_border(ctx, annot, true);
3044
1.13k
    if (code < 0) goto exit;
3045
3046
1.15k
 exit:
3047
1.15k
    code1 = pdfi_annot_end_transparency(ctx, annot);
3048
1.15k
    if (code >= 0)
3049
1.12k
        code = code1;
3050
1.15k
 exit1:
3051
1.15k
    *render_done = true;
3052
1.15k
    pdfi_countdown(L);
3053
1.15k
    return code;
3054
1.15k
}
3055
3056
/* Create a path from an array of points */
3057
static int pdfi_annot_path_array(pdf_context *ctx, pdf_dict *annot, pdf_array *Vertices)
3058
543
{
3059
543
    int code = 0;
3060
543
    int i;
3061
3062
2.92k
    for (i=0; i<pdfi_array_size(Vertices); i+=2) {
3063
2.38k
        double x,y;
3064
3065
2.38k
        code = pdfi_array_get_number(ctx, Vertices, i, &x);
3066
2.38k
        if (code < 0) goto exit;
3067
2.38k
        code = pdfi_array_get_number(ctx, Vertices, i+1, &y);
3068
2.38k
        if (code < 0) goto exit;
3069
3070
2.38k
        if (i == 0) {
3071
543
            code = gs_moveto(ctx->pgs, x, y);
3072
543
            if (code < 0) goto exit;
3073
1.83k
        } else {
3074
1.83k
            code = gs_lineto(ctx->pgs, x, y);
3075
1.83k
            if (code < 0) goto exit;
3076
1.83k
        }
3077
2.38k
    }
3078
3079
543
 exit:
3080
543
    return code;
3081
543
}
3082
3083
/* Generate appearance (see pdf_draw.ps/PolyLine)
3084
 * NOTE: as of 5-7-20, the gs implementation of this is actually broken
3085
 *
3086
 * If there was an AP it was already handled.
3087
 */
3088
static int pdfi_annot_draw_PolyLine(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
3089
524
{
3090
524
    int code = 0;
3091
524
    int code1 = 0;
3092
524
    pdf_array *Vertices = NULL, *Path = NULL, *Line = NULL;
3093
524
    bool drawit;
3094
524
    int size;
3095
524
    double x1, y1, x2, y2, x3, y3, ends[8];
3096
524
    bool Vertices_known = false, Path_known = false;
3097
3098
524
    code = pdfi_annot_start_transparency(ctx, annot);
3099
524
    if (code < 0) goto exit1;
3100
3101
524
    code = pdfi_dict_known(ctx, annot, "Vertices", &Vertices_known);
3102
524
    if (code < 0) goto exit1;
3103
524
    code = pdfi_dict_known(ctx, annot, "Path", &Path_known);
3104
524
    if (code < 0) goto exit1;
3105
3106
524
    code = pdfi_gsave(ctx);
3107
524
    if (code < 0) goto exit1;
3108
3109
    /* If both are known, or neither are known, then there is a problem */
3110
524
    if (Vertices_known == Path_known) {
3111
3
        code = gs_note_error(gs_error_undefined);
3112
3
        goto exit;
3113
3
    }
3114
3115
521
    if (Vertices_known) {
3116
521
        code = pdfi_dict_get_type(ctx, annot, "Vertices", PDF_ARRAY, (pdf_obj **)&Vertices);
3117
521
        if (code < 0) goto exit;
3118
3119
521
        size = pdfi_array_size(Vertices);
3120
521
        if (size == 0) {
3121
0
            code = 0;
3122
0
            goto exit;
3123
0
        }
3124
521
        code = pdfi_annot_path_array(ctx, annot, Vertices);
3125
521
        if (code < 0) goto exit1;
3126
3127
512
        code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3128
512
        if (code < 0) goto exit;
3129
3130
512
        code = pdfi_annot_draw_border(ctx, annot, true);
3131
512
        if (code < 0) goto exit;
3132
3133
512
        if (size >= 4) {
3134
512
            code = pdfi_array_get_number(ctx, Vertices, 0, &x1);
3135
512
            if (code < 0) goto exit;
3136
512
            code = pdfi_array_get_number(ctx, Vertices, 1, &y1);
3137
512
            if (code < 0) goto exit;
3138
512
            code = pdfi_array_get_number(ctx, Vertices, 2, &x2);
3139
512
            if (code < 0) goto exit;
3140
512
            code = pdfi_array_get_number(ctx, Vertices, 3, &y2);
3141
512
            if (code < 0) goto exit;
3142
512
            code = pdfi_annot_draw_LE(ctx, annot, x1, y1, x2, y2, 1);
3143
512
            if (code < 0) goto exit;
3144
3145
512
            code = pdfi_array_get_number(ctx, Vertices, size-4, &x1);
3146
512
            if (code < 0) goto exit;
3147
512
            code = pdfi_array_get_number(ctx, Vertices, size-3, &y1);
3148
512
            if (code < 0) goto exit;
3149
512
            code = pdfi_array_get_number(ctx, Vertices, size-2, &x2);
3150
512
            if (code < 0) goto exit;
3151
512
            code = pdfi_array_get_number(ctx, Vertices, size-1, &y2);
3152
512
            if (code < 0) goto exit;
3153
512
            code = pdfi_annot_draw_LE(ctx, annot, x1, y1, x2, y2, 2);
3154
512
            if (code < 0) goto exit;
3155
512
        }
3156
512
    } else {
3157
0
        int i = 0;
3158
0
        int state = 0;
3159
3160
0
        memset(ends, 0x00, 8 * sizeof(double));
3161
0
        code = pdfi_dict_get_type(ctx, annot, "Path", PDF_ARRAY, (pdf_obj **)&Path);
3162
0
        if (code < 0) goto exit;
3163
3164
0
        if (pdfi_array_size(Path) < 2)
3165
0
            goto exit;
3166
3167
0
        code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3168
0
        if (code < 0) goto exit;
3169
3170
0
        code = pdfi_annot_draw_border(ctx, annot, true);
3171
0
        if (code < 0) goto exit;
3172
3173
0
        for (i = 0; i < pdfi_array_size(Path); i++) {
3174
0
            code = pdfi_array_get_type(ctx, Path, i, PDF_ARRAY, (pdf_obj **)&Line);
3175
0
            if (code < 0)
3176
0
                goto exit;
3177
0
            switch(pdfi_array_size(Line)) {
3178
0
                case 2:
3179
0
                    code = pdfi_array_get_number(ctx, Line, 0, &x1);
3180
0
                    if (code < 0)
3181
0
                        goto exit;
3182
0
                    code = pdfi_array_get_number(ctx, Line, 1, &y1);
3183
0
                    if (code < 0)
3184
0
                        goto exit;
3185
0
                    if (state == 0) {
3186
0
                        state = 1;
3187
0
                        code = gs_moveto(ctx->pgs, x1, y1);
3188
0
                        ends[0] = ends[4] = x1;
3189
0
                        ends[1] = ends[5] = y1;
3190
0
                    } else {
3191
0
                        if (state == 1) {
3192
0
                            ends[2] = ends[6] = x1;
3193
0
                            ends[3] = ends[7] = y1;
3194
0
                            state = 2;
3195
0
                        } else {
3196
0
                            ends[4] = ends[6];
3197
0
                            ends[5] = ends[7];
3198
0
                            ends[6] = x1;
3199
0
                            ends[7] = y1;
3200
0
                        }
3201
0
                        code = gs_lineto(ctx->pgs, x1, y1);
3202
0
                    }
3203
0
                    pdfi_countdown(Line);
3204
0
                    Line = NULL;
3205
0
                    break;
3206
0
                case 6:
3207
0
                    code = pdfi_array_get_number(ctx, Line, 0, &x1);
3208
0
                    if (code < 0)
3209
0
                        goto exit;
3210
0
                    code = pdfi_array_get_number(ctx, Line, 1, &y1);
3211
0
                    if (code < 0)
3212
0
                        goto exit;
3213
0
                    code = pdfi_array_get_number(ctx, Line, 2, &x2);
3214
0
                    if (code < 0)
3215
0
                        goto exit;
3216
0
                    code = pdfi_array_get_number(ctx, Line, 3, &y2);
3217
0
                    if (code < 0)
3218
0
                        goto exit;
3219
0
                    code = pdfi_array_get_number(ctx, Line, 4, &x3);
3220
0
                    if (code < 0)
3221
0
                        goto exit;
3222
0
                    code = pdfi_array_get_number(ctx, Line, 5, &y3);
3223
0
                    if (code < 0)
3224
0
                        goto exit;
3225
0
                    if (state == 1) {
3226
0
                        ends[2] = x1;
3227
0
                        ends[3] = y1;
3228
0
                        ends[4] = x2;
3229
0
                        ends[5] = y2;
3230
0
                        ends[6] = x3;
3231
0
                        ends[7] = y3;
3232
0
                        state = 2;
3233
0
                    }
3234
0
                    ends[4] = x2;
3235
0
                    ends[5] = y2;
3236
0
                    ends[6] = x3;
3237
0
                    ends[7] = y3;
3238
0
                    code = gs_curveto(ctx->pgs, x1, y1, x2, y2, x3, y3);
3239
0
                    pdfi_countdown(Line);
3240
0
                    Line = NULL;
3241
0
                    break;
3242
0
                default:
3243
0
                    pdfi_countdown(Line);
3244
0
                    Line = NULL;
3245
0
                    code = gs_note_error(gs_error_rangecheck);
3246
0
                    break;
3247
0
            }
3248
0
            if (code < 0)
3249
0
                break;
3250
0
        }
3251
0
        if (code < 0)
3252
0
            goto exit;
3253
3254
0
        code = gs_stroke(ctx->pgs);
3255
0
        if (code < 0)
3256
0
            goto exit;
3257
3258
0
        code = pdfi_annot_draw_LE(ctx, annot, ends[0], ends[1], ends[2], ends[3], 1);
3259
0
        if (code < 0)
3260
0
            goto exit;
3261
0
        code = pdfi_annot_draw_LE(ctx, annot, ends[4], ends[5], ends[6], ends[7], 2);
3262
0
    }
3263
3264
515
 exit:
3265
515
    code1 = pdfi_annot_end_transparency(ctx, annot);
3266
515
    if (code >= 0)
3267
512
        code = code1;
3268
515
    code1 = pdfi_grestore(ctx);
3269
515
    if (code >= 0) code = code1;
3270
3271
524
 exit1:
3272
524
    *render_done = true;
3273
524
    pdfi_countdown(Line);
3274
524
    pdfi_countdown(Vertices);
3275
524
    pdfi_countdown(Path);
3276
524
    return code;
3277
515
}
3278
3279
/* Generate appearance (see pdf_draw.ps/Polygon)
3280
 *
3281
 * If there was an AP it was already handled.
3282
 */
3283
static int pdfi_annot_draw_Polygon(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
3284
22
{
3285
22
    int code = 0;
3286
22
    int code1 = 0;
3287
22
    pdf_array *Vertices = NULL;
3288
22
    bool drawit;
3289
3290
22
    code = pdfi_annot_start_transparency(ctx, annot);
3291
22
    if (code < 0) goto exit1;
3292
3293
22
    code = pdfi_dict_knownget_type(ctx, annot, "Vertices", PDF_ARRAY, (pdf_obj **)&Vertices);
3294
22
    if (code <= 0) goto exit;
3295
3296
22
    code = pdfi_annot_path_array(ctx, annot, Vertices);
3297
22
    if (code < 0) goto exit1;
3298
3299
22
    code = gs_closepath(ctx->pgs);
3300
3301
    /* NOTE: The logic here seems a bit wonky.  Why only set opacity if there was a fill?
3302
     * Anyway, it is based on the ps code (pdf_draw.ps/Polygon).
3303
     * Maybe can be improved.
3304
     */
3305
22
    code = pdfi_annot_setinteriorcolor(ctx, annot, false, &drawit);
3306
22
    if (code < 0) goto exit;
3307
22
    if (drawit) {
3308
0
        code = pdfi_annot_fillborderpath(ctx, annot);
3309
0
        if (code < 0) goto exit;
3310
0
        code = pdfi_annot_opacity(ctx, annot); /* TODO: Why only on this path? */
3311
0
        if (code < 0) goto exit;
3312
0
    }
3313
22
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3314
22
    if (code < 0) goto exit;
3315
22
    if (drawit) {
3316
22
        code = pdfi_annot_draw_border(ctx, annot, true);
3317
22
        if (code < 0) goto exit;
3318
22
    }
3319
3320
22
 exit:
3321
22
    code1 = pdfi_annot_end_transparency(ctx, annot);
3322
22
    if (code >= 0)
3323
22
        code = code1;
3324
22
 exit1:
3325
22
    *render_done = true;
3326
22
    pdfi_countdown(Vertices);
3327
22
    return code;
3328
22
}
3329
3330
/* Generate appearance (see pdf_draw.ps/Square)
3331
 *
3332
 * If there was an AP it was already handled.
3333
 */
3334
static int pdfi_annot_draw_Square(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
3335
153
{
3336
153
    int code = 0;
3337
153
    int code1 = 0;
3338
153
    bool drawit;
3339
3340
153
    code = pdfi_annot_start_transparency(ctx, annot);
3341
153
    if (code < 0) goto exit1;
3342
3343
153
    code = pdfi_annot_setinteriorcolor(ctx, annot, false, &drawit);
3344
153
    if (code < 0) goto exit;
3345
153
    if (drawit) {
3346
56
        code = pdfi_annot_opacity(ctx, annot);
3347
56
        if (code < 0) goto exit;
3348
56
        code = pdfi_annot_fillRect(ctx, annot);
3349
56
        if (code < 0) goto exit;
3350
3351
56
        code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3352
56
        if (code < 0) goto exit;
3353
3354
56
        if (drawit) {
3355
56
            code = pdfi_annot_draw_border(ctx, annot, false);
3356
56
            if (code < 0) goto exit;
3357
56
        }
3358
97
    } else {
3359
97
        code = pdfi_annot_RectRD_path(ctx, annot);
3360
97
        if (code < 0) goto exit;
3361
3362
97
        code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3363
97
        if (code < 0) goto exit;
3364
3365
88
        if (drawit) {
3366
88
            code = pdfi_annot_draw_border(ctx, annot, true);
3367
88
            if (code < 0) goto exit;
3368
88
        }
3369
88
    }
3370
3371
153
 exit:
3372
153
    code1 = pdfi_annot_end_transparency(ctx, annot);
3373
153
    if (code >= 0)
3374
143
        code = code1;
3375
153
 exit1:
3376
153
    *render_done = true;
3377
153
    return code;
3378
153
}
3379
3380
static int pdfi_annot_render_MK_box(pdf_context *ctx, pdf_dict *annot, pdf_dict *MK)
3381
65.5k
{
3382
65.5k
    int code = 0;
3383
65.5k
    bool drawit = false;
3384
65.5k
    gs_rect rect;
3385
65.5k
    bool need_grestore = false;
3386
3387
    /* Basically just render the rectangle around the widget for now */
3388
65.5k
    code = pdfi_annot_Rect(ctx, annot, &rect);
3389
65.5k
    if (code < 0) goto exit;
3390
3391
65.4k
    code = pdfi_gsave(ctx);
3392
65.4k
    if (code < 0) goto exit;
3393
65.4k
    need_grestore = true;
3394
65.4k
    code = pdfi_annot_setcolor_key(ctx, MK, "BG", false, &drawit);
3395
65.4k
    if (code < 0) goto exit;
3396
65.4k
    if (drawit)
3397
251
        code = gs_rectfill(ctx->pgs, &rect, 1);
3398
65.4k
    if (code < 0) goto exit;
3399
65.4k
    need_grestore = false;
3400
65.4k
    code = pdfi_grestore(ctx);
3401
65.4k
    if (code < 0) goto exit;
3402
3403
65.4k
    code = pdfi_gsave(ctx);
3404
65.4k
    if (code < 0) goto exit;
3405
65.4k
    need_grestore = true;
3406
65.4k
    code = pdfi_annot_setcolor_key(ctx, MK, "BC", false, &drawit);
3407
65.4k
    if (code < 0) goto exit;
3408
65.4k
    if (drawit)
3409
353
        code = gs_rectstroke(ctx->pgs, &rect, 1, NULL);
3410
65.4k
    if (code < 0) goto exit;
3411
65.4k
    need_grestore = false;
3412
65.4k
    code = pdfi_grestore(ctx);
3413
65.4k
    if (code < 0) goto exit;
3414
3415
    /* TODO: Stuff with can-regenerate-ap ?? */
3416
3417
65.5k
 exit:
3418
65.5k
    if (need_grestore)
3419
0
        (void)pdfi_grestore(ctx);
3420
65.5k
    return code;
3421
65.4k
}
3422
3423
typedef enum {
3424
    PDFI_FORM_FF_READONLY = 1, /* Bit 1 */
3425
    PDFI_FORM_FF_REQUIRED = 1 << 1, /* Bit 2 */
3426
    PDFI_FORM_FF_NOEXPORT = 1 << 2, /* Bit 3 */
3427
    PDFI_FORM_FF_MULTILINE = 1 << 12, /* Bit 13 */
3428
    PDFI_FORM_FF_PASSWORD = 1 << 13, /* Bit 14 */
3429
    PDFI_FORM_FF_NOTOGGLETOOFF = 1 << 14, /* Bit 15 */
3430
    PDFI_FORM_FF_RADIO = 1 << 15, /* Bit 16 */
3431
    PDFI_FORM_FF_PUSHBUTTON = 1 << 16, /* Bit 17 */
3432
    PDFI_FORM_FF_COMBO = 1 << 17, /* Bit 18 */
3433
    PDFI_FORM_FF_EDIT = 1 << 18, /* Bit 19 */
3434
    PDFI_FORM_FF_SORT = 1 << 19, /* Bit 20 */
3435
    PDFI_FORM_FF_FILESELECT = 1 << 20, /* Bit 21 */
3436
    PDFI_FORM_FF_MULTISELECT = 1 << 21, /* Bit 22 */
3437
    PDFI_FORM_FF_DONOTSPELLCHECK = 1 << 22, /* Bit 23 */
3438
    PDFI_FORM_FF_DONOTSCROLL = 1 << 23, /* Bit 24 */
3439
    PDFI_FORM_FF_COMB = 1 << 24, /* Bit 25 */
3440
    PDFI_FORM_FF_RICHTEXT = 1 << 25, /* Bit 26 */ /* also PDFI_FORM_FF_RADIOSINUNISON */
3441
    PDFI_FORM_FF_COMMITONSELCHANGE = 1 << 26, /* Bit 27 */
3442
} pdfi_form_Ff;
3443
3444
/* draw field Btn */
3445
static int pdfi_form_draw_Btn(pdf_context *ctx, pdf_dict *field, pdf_obj *AP)
3446
240
{
3447
240
    int code;
3448
#ifdef DEBUG
3449
    bool Radio = false;
3450
    bool Pushbutton = false;
3451
#endif
3452
240
    int64_t value;
3453
3454
    /* TODO: There can be Kids array. I think it should be handled in caller.
3455
     * Need an example...
3456
     */
3457
240
    if (AP != NULL) {
3458
0
        code = pdfi_annot_draw_AP(ctx, field, AP);
3459
0
        goto exit;
3460
0
    }
3461
3462
    /* Get Ff field (default is 0) */
3463
240
    code = pdfi_form_get_inheritable_int(ctx, field, "Ff", &value);
3464
240
    if (code < 0) goto exit;
3465
3466
#ifdef DEBUG
3467
    Radio = value & PDFI_FORM_FF_RADIO;
3468
    Pushbutton = value & PDFI_FORM_FF_PUSHBUTTON;
3469
3470
    dbgprintf("WARNING: AcroForm field 'Btn' with no AP not implemented.\n");
3471
    dbgprintf2("       : Radio = %s, Pushbutton = %s.\n",
3472
              Radio ? "TRUE" : "FALSE", Pushbutton ? "TRUE" : "FALSE");
3473
#endif
3474
3475
240
 exit:
3476
240
    return 0;
3477
240
}
3478
3479
/* Modify V from Tx widget to skip past the BOM and indicate if UTF-16 was found */
3480
static int pdfi_form_modV(pdf_context *ctx, pdf_string *V, pdf_string **mod_V, bool *is_UTF16)
3481
206
{
3482
206
    bool did_mod = false;
3483
206
    int code = 0;
3484
206
    int skip = 0;
3485
206
    pdf_string *newV = NULL;
3486
3487
206
    *is_UTF16 = false;
3488
3489
206
    if (IS_UTF8(V->data)) {
3490
0
        skip = 3;
3491
206
    } else if (IS_UTF16(V->data)) {
3492
11
        skip = 2;
3493
11
        *is_UTF16 = true;
3494
11
    }
3495
3496
206
    if (skip == 0)
3497
195
        goto exit;
3498
3499
    /* Create a new V that skips over the BOM */
3500
11
    code = pdfi_object_alloc(ctx, PDF_STRING, V->length-skip, (pdf_obj **)&newV);
3501
11
    if (code < 0)
3502
0
        goto exit;
3503
11
    pdfi_countup(newV);
3504
3505
11
    memcpy(newV->data, V->data+skip, newV->length);
3506
11
    did_mod = true;
3507
3508
206
 exit:
3509
    /* If didn't need to mod it, just copy the original and get a ref */
3510
206
    if (did_mod) {
3511
11
        *mod_V = newV;
3512
195
    } else {
3513
195
        *mod_V = V;
3514
195
        pdfi_countup(V);
3515
195
    }
3516
206
    return code;
3517
11
}
3518
3519
/* Display simple text (no multiline or comb) */
3520
static int pdfi_form_Tx_simple(pdf_context *ctx, pdf_dict *annot, gs_rect *rect, pdf_string *V,
3521
                               int64_t Ff, int64_t Q, bool is_UTF16)
3522
203
{
3523
203
    int code = 0;
3524
203
    gs_rect modrect;
3525
203
    double lineheight = 0;
3526
203
    gs_rect bbox;
3527
203
    gs_point awidth;
3528
203
    double y_adjust = 0.0f, x_adjust = 0.0f;
3529
3530
203
    modrect = *rect; /* structure copy */
3531
3532
203
    code = pdfi_annot_get_text_height(ctx, &lineheight);
3533
203
    if (code < 0) goto exit;
3534
3535
    /* text placement adjustments */
3536
203
    switch (Q) {
3537
203
    case 0: /* Left-justified */
3538
203
        x_adjust = 2; /* empirical value */
3539
203
        break;
3540
0
    case 1: /* Centered */
3541
        /* Get width of the string */
3542
0
        code = pdfi_string_bbox(ctx, V, &bbox, &awidth, false);
3543
0
        if (code < 0) goto exit;
3544
0
        x_adjust = ((rect->q.x - rect->p.x) - awidth.x) / 2;
3545
0
        break;
3546
0
    case 2: /* Right-justified */
3547
        /* Get width of the string */
3548
0
        code = pdfi_string_bbox(ctx, V, &bbox, &awidth, false);
3549
0
        if (code < 0) goto exit;
3550
0
        x_adjust = rect->q.x - awidth.x;
3551
0
        break;
3552
203
    }
3553
3554
    /* Center vertically */
3555
203
    y_adjust = ((rect->q.y - rect->p.y) - lineheight) / 2;
3556
3557
203
    modrect.p.x += x_adjust;
3558
203
    modrect.p.y += y_adjust;
3559
203
    modrect.p.y += (lineheight + 6.) / 10.; /* empirical */
3560
3561
203
    code = pdfi_annot_display_simple_text(ctx, annot, modrect.p.x, modrect.p.y, V);
3562
203
    if (code < 0) goto exit;
3563
203
 exit:
3564
203
    return code;
3565
203
}
3566
3567
/* Display text from Tx MULTILINE */
3568
static int pdfi_form_Tx_multiline(pdf_context *ctx, pdf_dict *annot, gs_rect *rect, pdf_string *V,
3569
                                  int64_t Ff, int64_t Q, bool is_UTF16)
3570
3
{
3571
3
    int code = 0;
3572
3
    gs_rect modrect;
3573
3574
3
    modrect = *rect; /* structure copy */
3575
    /* empirical tweaks */
3576
3
    modrect.p.x += 2;
3577
3
    modrect.p.y += 2;
3578
3
    modrect.q.x -= 2;
3579
3
    modrect.q.y -= 2;
3580
3581
3
    code = pdfi_annot_display_formatted_text(ctx, annot, &modrect, V, is_UTF16);
3582
3
    if (code < 0) goto exit;
3583
3584
3
 exit:
3585
3
    return code;
3586
3
}
3587
3588
3589
/* Display text from Tx COMB */
3590
static int pdfi_form_Tx_comb(pdf_context *ctx, pdf_dict *annot, gs_rect *rect, pdf_string *V,
3591
                             int64_t Ff, int64_t Q, int64_t MaxLen, bool is_UTF16)
3592
0
{
3593
0
    int code = 0;
3594
3595
    /* TODO: Implement... Need a sample that uses COMB! */
3596
0
    code = pdfi_form_Tx_simple(ctx, annot, rect, V, Ff, Q, is_UTF16);
3597
0
    return code;
3598
0
}
3599
3600
3601
/* Display text from Tx in a field or widget */
3602
static int pdfi_form_display_Tx(pdf_context *ctx, pdf_dict *annot, gs_rect *rect, pdf_string *V,
3603
                                  int64_t Ff, int64_t Q, int64_t MaxLen)
3604
206
{
3605
206
    int code = 0;
3606
206
    pdf_string *modV = NULL;
3607
206
    bool is_UTF16;
3608
3609
    /* TODO: If we wanted to preserve this for pdfwrite, we would have to generate
3610
     * a stream for the AP.  See PDF1.7 spec, Variable Text (page 677).
3611
     */
3612
3613
    /* Get modified V that skips the BOM, if any */
3614
206
    code = pdfi_form_modV(ctx, V, &modV, &is_UTF16);
3615
206
    if (code < 0) goto exit;
3616
3617
206
    if (Ff & PDFI_FORM_FF_MULTILINE) {
3618
3
        code = pdfi_form_Tx_multiline(ctx, annot, rect, modV, Ff, Q, is_UTF16);
3619
203
    } else if (Ff & PDFI_FORM_FF_COMB) {
3620
0
        code = pdfi_form_Tx_comb(ctx, annot, rect, modV, Ff, Q, MaxLen, is_UTF16);
3621
203
    } else {
3622
203
        code = pdfi_form_Tx_simple(ctx, annot, rect, modV, Ff, Q, is_UTF16);
3623
203
    }
3624
3625
206
 exit:
3626
206
    pdfi_countdown(modV);
3627
206
    return code;
3628
206
}
3629
3630
3631
/* At least for now, Tx and Ch are handled the same */
3632
static int pdfi_form_draw_Tx_Ch(pdf_context *ctx, pdf_dict *annot)
3633
58.8k
{
3634
58.8k
    int code = 0;
3635
58.8k
    pdf_string *V = NULL;
3636
58.8k
    gs_rect annotrect;
3637
58.8k
    int64_t Ff;
3638
58.8k
    int64_t MaxLen;
3639
58.8k
    int64_t Q;
3640
3641
58.8k
    code = pdfi_annot_Rect(ctx, annot, &annotrect);
3642
58.8k
    if (code < 0) goto exit;
3643
3644
    /* Set DA (Default Appearance)
3645
     * This will generally set a color and font.
3646
     */
3647
58.8k
    code = pdfi_annot_process_DA(ctx, annot, annot, &annotrect, true);
3648
58.8k
    if (code < 0) goto exit;
3649
3650
58.8k
    code = pdfi_form_get_inheritable_int(ctx, annot, "Ff", &Ff);
3651
58.8k
    if (code < 0) goto exit;
3652
3653
57.3k
    code = pdfi_form_get_inheritable_int(ctx, annot, "MaxLen", &MaxLen);
3654
57.3k
    if (code < 0) goto exit;
3655
3656
49.2k
    code = pdfi_form_get_inheritable_int(ctx, annot, "Q", &Q);
3657
49.2k
    if (code < 0) goto exit;
3658
3659
49.1k
    code = pdfi_dict_knownget_type(ctx, annot, "V", PDF_STRING, (pdf_obj **)&V);
3660
49.1k
    if (code < 0) goto exit;
3661
49.1k
    if (code > 0) {
3662
206
        code = pdfi_form_display_Tx(ctx, annot, &annotrect, V, Ff, Q, MaxLen);
3663
206
        if (code < 0) goto exit;
3664
206
    }
3665
3666
58.8k
 exit:
3667
58.8k
    pdfi_countdown(V);
3668
58.8k
    return code;
3669
49.1k
}
3670
3671
/* draw field Tx */
3672
static int pdfi_form_draw_Tx(pdf_context *ctx, pdf_dict *annot, pdf_obj *AP)
3673
58.7k
{
3674
58.7k
    if (AP != NULL)
3675
0
        return pdfi_annot_draw_AP(ctx, annot, AP);
3676
3677
58.7k
    return pdfi_form_draw_Tx_Ch(ctx, annot);
3678
58.7k
}
3679
3680
/* draw field Ch */
3681
static int pdfi_form_draw_Ch(pdf_context *ctx, pdf_dict *field, pdf_obj *AP)
3682
138
{
3683
138
    if (!ctx->NeedAppearances && AP != NULL)
3684
0
        return pdfi_annot_draw_AP(ctx, field, AP);
3685
3686
138
    return pdfi_form_draw_Tx_Ch(ctx, field);
3687
138
}
3688
3689
/* draw field Sig */
3690
static int pdfi_form_draw_Sig(pdf_context *ctx, pdf_dict *field, pdf_obj *AP)
3691
0
{
3692
0
    int code = 0;
3693
3694
0
    if (!ctx->NeedAppearances && AP != NULL)
3695
0
        return pdfi_annot_draw_AP(ctx, field, AP);
3696
3697
0
    dbgprintf("WARNING: AcroForm field 'Sig' with no AP not implemented.\n");
3698
3699
0
    return code;
3700
0
}
3701
3702
/* TODO: The spec handles "regenerate appearance", which it does by generating
3703
 * a new AP stream for the field, and then rendering it as a form.
3704
 * The gs code does try to handle this case.
3705
 * For now I am just going to generate the data inline, without building it as a Form/Stream.
3706
 * If we have want to preserve the AP (i.e. for pdfwrite device, generate the AP and include
3707
 * it in the output, rather than just rendering it into the output) then this needs to change.
3708
 * Currently gs doesn't try to preserve AcroForms, so we aren't losing any functionality by
3709
 * not doing this.  But it is a place for a future enhancement.
3710
 *
3711
 * See also, the comment on pdfi_annot_preserve_Widget().
3712
 */
3713
static int pdfi_annot_render_field(pdf_context *ctx, pdf_dict *field, pdf_name *FT, pdf_obj *AP)
3714
59.1k
{
3715
59.1k
    int code;
3716
3717
59.1k
    if (pdfi_name_is(FT, "Btn")) {
3718
240
        code = pdfi_form_draw_Btn(ctx, field, AP);
3719
58.8k
    } else if (pdfi_name_is(FT, "Tx")) {
3720
58.7k
        code = pdfi_form_draw_Tx(ctx, field, AP);
3721
58.7k
    } else if (pdfi_name_is(FT, "Ch")) {
3722
138
        code = pdfi_form_draw_Ch(ctx, field, AP);
3723
138
    } else if (pdfi_name_is(FT, "Sig")) {
3724
0
        code = pdfi_form_draw_Sig(ctx, field, AP);
3725
15
    } else {
3726
15
        errprintf(ctx->memory, "*** WARNING unknown field FT ignored\n");
3727
        /* TODO: Handle warning better */
3728
15
        code = 0;
3729
15
    }
3730
3731
59.1k
    return code;
3732
59.1k
}
3733
3734
/* Render Widget with no AP
3735
 */
3736
static int pdfi_annot_render_Widget(pdf_context *ctx, pdf_dict *annot)
3737
66.1k
{
3738
66.1k
    int code = 0;
3739
66.1k
    pdf_dict *MK = NULL;
3740
66.1k
    pdf_name *FT = NULL;
3741
3742
    /* Render box around the widget using MK */
3743
66.1k
    code = pdfi_dict_knownget_type(ctx, annot, "MK", PDF_DICT, (pdf_obj **)&MK);
3744
66.1k
    if (code < 0) goto exit;
3745
66.1k
    if (code > 0) {
3746
65.5k
        code = pdfi_annot_render_MK_box(ctx, annot, MK);
3747
65.5k
        if (code < 0) goto exit;
3748
65.5k
    }
3749
3750
    /* Render the other contents */
3751
66.0k
    code = pdfi_dict_knownget_type(ctx, annot, "FT", PDF_NAME, (pdf_obj **)&FT);
3752
66.0k
    if (code < 0) goto exit;
3753
66.0k
    if (code > 0) {
3754
59.1k
        code = pdfi_annot_render_field(ctx, annot, FT, NULL);
3755
59.1k
        if (code < 0) goto exit;
3756
59.1k
    }
3757
3758
66.1k
 exit:
3759
66.1k
    pdfi_countdown(FT);
3760
66.1k
    pdfi_countdown(MK);
3761
66.1k
    return code;
3762
66.0k
}
3763
3764
/* Draws a thing of type /Widget */
3765
static int pdfi_annot_draw_Widget(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
3766
169k
{
3767
169k
    int code = 0;
3768
169k
    bool found_T = false;
3769
169k
    bool found_FT = false, known = false;
3770
169k
    pdf_obj *T = NULL;
3771
169k
    pdf_obj *FT = NULL;
3772
169k
    pdf_dict *Parent = NULL;
3773
169k
    pdf_dict *currdict = NULL;
3774
3775
    /* From pdf_draw.ps/drawwidget:
3776
  % Acrobat doesn't draw Widget annotations unles they have both /FT
3777
  % (which is defined as required) and /T keys present. Annoyingly
3778
  % these can either be inherited from the Form Definition Field
3779
  % dictionary (via the AcroForm tree) or present directly in the
3780
  % annotation, so we need to check the annotation to make sure its
3781
  % a Widget, then follow any /Parent key up to the root node
3782
  % extracting and storing any FT or T keys as we go (we only care if
3783
  % these are present, their value is immaterial). If after all that
3784
  % both keys are not present, then we don't draw the annotation.
3785
    */
3786
3787
    /* TODO: See top part of pdf_draw.ps/drawwidget
3788
     * check for /FT and /T and stuff
3789
     */
3790
169k
    code = pdfi_loop_detector_mark(ctx);
3791
169k
    if (code < 0)
3792
0
        goto exit;
3793
3794
169k
    currdict = annot;
3795
169k
    pdfi_countup(currdict);
3796
216k
    while (true) {
3797
216k
        if (currdict->object_num != 0) {
3798
216k
            code = pdfi_loop_detector_add_object(ctx, currdict->object_num);
3799
216k
            if (code < 0)
3800
0
                break;
3801
216k
        }
3802
3803
216k
        code = pdfi_dict_knownget(ctx, currdict, "T", &T);
3804
216k
        if (code < 0) goto exit;
3805
216k
        if (code > 0) {
3806
163k
            found_T = true;
3807
163k
            pdfi_countdown(T);
3808
163k
            T = NULL;
3809
163k
            if (found_FT)
3810
218
                break;
3811
163k
        }
3812
215k
        code = pdfi_dict_knownget(ctx, currdict, "FT", &FT);
3813
215k
        if (code < 0) goto exit;
3814
215k
        if (code > 0) {
3815
163k
            found_FT = true;
3816
163k
            pdfi_countdown(FT);
3817
163k
            FT = NULL;
3818
163k
            if (found_T)
3819
163k
                break;
3820
163k
        }
3821
        /* Check for Parent. Do not store the dereferenced Parent back to the dictionary
3822
         * as this can cause circular references.
3823
         */
3824
52.3k
        code = pdfi_dict_known(ctx, currdict, "Parent", &known);
3825
52.3k
        if (code >= 0 && known == true)
3826
49.3k
        {
3827
49.3k
            code = pdfi_dict_get_no_store_R(ctx, currdict, "Parent", (pdf_obj **)&Parent);
3828
49.3k
            if (code < 0) {
3829
2.32k
                (void)pdfi_loop_detector_cleartomark(ctx);
3830
2.32k
                goto exit;
3831
2.32k
            }
3832
47.0k
            if (pdfi_type_of(Parent) != PDF_DICT) {
3833
346
                if (pdfi_type_of(Parent) == PDF_INDIRECT) {
3834
0
                    pdf_indirect_ref *o = (pdf_indirect_ref *)Parent;
3835
3836
0
                    code = pdfi_dereference(ctx, o->ref_object_num, o->ref_generation_num, (pdf_obj **)&Parent);
3837
0
                    pdfi_countdown(o);
3838
0
                    if (code < 0)
3839
0
                        break;
3840
346
                } else {
3841
346
                    break;
3842
346
                }
3843
346
            }
3844
46.6k
            pdfi_countdown(currdict);
3845
46.6k
            currdict = Parent;
3846
46.6k
            Parent = NULL;
3847
46.6k
        } else
3848
2.96k
            break;
3849
52.3k
    }
3850
3851
167k
    (void)pdfi_loop_detector_cleartomark(ctx);
3852
3853
167k
    code = 0;
3854
167k
    if (!found_T || !found_FT) {
3855
3.31k
        *render_done = true;
3856
3.31k
        outprintf(ctx->memory, "**** Warning: A Widget annotation dictionary lacks either the FT or T key.\n");
3857
3.31k
        outprintf(ctx->memory, "              Acrobat ignores such annoataions, annotation will not be rendered.\n");
3858
3.31k
        outprintf(ctx->memory, "              Output may not be as expected.\n");
3859
3.31k
        goto exit;
3860
3.31k
    }
3861
3862
163k
    if (NormAP) {
3863
        /* Let caller render it */
3864
97.5k
        *render_done = false;
3865
97.5k
        goto exit;
3866
97.5k
    }
3867
3868
    /* No AP, try to render the Widget ourselves */
3869
66.1k
    code = pdfi_annot_render_Widget(ctx, annot);
3870
66.1k
    *render_done = true;
3871
3872
169k
 exit:
3873
169k
    pdfi_countdown(Parent);
3874
169k
    pdfi_countdown(currdict);
3875
169k
    return code;
3876
66.1k
}
3877
3878
/* Handle Annotations that are not implemented */
3879
static int pdfi_annot_draw_NotImplemented(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
3880
6
{
3881
6
    int code = 0;
3882
6
    pdf_name *Subtype = NULL;
3883
6
    char str[100];
3884
3885
6
    code = pdfi_dict_get_type(ctx, annot, "Subtype", PDF_NAME, (pdf_obj **)&Subtype);
3886
6
    if (code < 0) goto exit;
3887
3888
6
    memcpy(str, (const char *)Subtype->data, Subtype->length < 100 ? Subtype->length : 99);
3889
6
    str[Subtype->length < 100 ? Subtype->length : 99] = '\0';
3890
6
    dbgmprintf1(ctx->memory, "ANNOT: No AP, default appearance for Subtype %s Not Implemented\n", str);
3891
3892
6
 exit:
3893
6
    *render_done = false;
3894
6
    pdfi_countdown(Subtype);
3895
6
    return code;
3896
6
}
3897
3898
annot_dispatch_t annot_dispatch[] = {
3899
    /* These are in the same order as the PDF 2.0 spec 12.5.6.1 */
3900
    {"Text", pdfi_annot_draw_Text, true},
3901
    {"Link", pdfi_annot_draw_Link, false},
3902
    {"FreeText", pdfi_annot_draw_FreeText, true},
3903
    {"Line", pdfi_annot_draw_Line, true},
3904
    {"Square", pdfi_annot_draw_Square, true},
3905
    {"Circle", pdfi_annot_draw_Circle, true},
3906
    {"Polygon", pdfi_annot_draw_Polygon, true},
3907
    {"PolyLine", pdfi_annot_draw_PolyLine, true},
3908
    {"Highlight", pdfi_annot_draw_Highlight, true},
3909
    {"Underline", pdfi_annot_draw_Underline, true},
3910
    {"Squiggly", pdfi_annot_draw_Squiggly, true},
3911
    {"StrikeOut", pdfi_annot_draw_StrikeOut, true},
3912
    {"Caret", pdfi_annot_draw_NotImplemented, true},
3913
    {"Stamp", pdfi_annot_draw_Stamp, true},
3914
    {"Ink", pdfi_annot_draw_Ink, true},
3915
    {"Popup", pdfi_annot_draw_Popup, false},
3916
    {"FileAttachment", pdfi_annot_draw_NotImplemented, true},
3917
    {"Sound", pdfi_annot_draw_NotImplemented, true},
3918
    {"Movie", pdfi_annot_draw_NotImplemented, true},
3919
    {"Screen", pdfi_annot_draw_NotImplemented, true},
3920
    {"Widget", pdfi_annot_draw_Widget, false},
3921
    {"PrinterMark", pdfi_annot_draw_NotImplemented, true},
3922
    {"TrapNet", pdfi_annot_draw_NotImplemented, true},
3923
    {"Watermark", pdfi_annot_draw_NotImplemented, true},
3924
    {"3D", pdfi_annot_draw_NotImplemented, true},
3925
    {"Redact", pdfi_annot_draw_Redact, true},
3926
    {"Projection", pdfi_annot_draw_NotImplemented, true},
3927
    {"RichMedia", pdfi_annot_draw_NotImplemented, true},
3928
    { NULL, NULL},
3929
};
3930
3931
/* Check if annotation is visible
3932
 * (from ps code:)
3933
%
3934
%   The PDF annotation F (flags) integer is bit encoded.
3935
%   Bit 1 (LSB) Invisible:  1 --> Do not display if no handler.
3936
%         Note:  We have no handlers but we ignore this bit.
3937
%   Bit 2 Hidden:  1 --> Do not display.  We will not display if this bit is set.
3938
%   Bit 3 Print:  1 --> Display if printing.  We will display if this bit set
3939
%         (and not hidden) and Printed is true
3940
%   Bit 4 NoZoom:  1 --> Do not zoom annotation even if image is zoomed.
3941
%   Bit 5 NoRotate:  1 --> Do not rotate annotation even if image is rotated.
3942
%   Bit 6 NoView:  0 --> Display if this is a 'viewer'.  We will display
3943
%         if this bit is not set (and not hidden) and Printed is false
3944
%   Bit 7 Read Only - 1 --> No interaction.  We ignore this bit
3945
%
3946
%   AR8 and AR9 print 3D annotations even if Print flag is off. Bug 691486.
3947
%
3948
*/
3949
static bool pdfi_annot_visible(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
3950
602k
{
3951
602k
    int code;
3952
602k
    bool is_3D = false;
3953
602k
    bool is_visible = true;
3954
602k
    int64_t F;
3955
3956
602k
    if (pdfi_name_is(subtype, "3D"))
3957
0
        is_3D = true;
3958
3959
602k
    code = pdfi_dict_get_int(ctx, annot, "F", &F);
3960
602k
    if (code < 0)
3961
59.9k
        F = 0;
3962
3963
602k
    if ((F & 0x2) != 0) { /* Bit 2 -- Hidden */
3964
164k
        is_visible = false; /* Hidden */
3965
164k
        goto exit;
3966
164k
    }
3967
3968
437k
    if (ctx->args.printed) {
3969
        /* Even if Print flag (bit 3) is off, will print if 3D */
3970
437k
        is_visible = ((F & 0x4) != 0) || is_3D;
3971
437k
    } else {
3972
        /* Not NoView (bit 6) */
3973
0
        is_visible = (F & 0x20) == 0;
3974
0
    }
3975
3976
602k
 exit:
3977
602k
    return is_visible;
3978
437k
}
3979
3980
/* Check to see if subtype is on the ShowAnnotTypes list
3981
 * Defaults to true if there is no list
3982
 */
3983
static bool pdfi_annot_check_type(pdf_context *ctx, pdf_name *subtype)
3984
377k
{
3985
377k
    char **ptr;
3986
3987
    /* True if no list */
3988
377k
    if (!ctx->args.showannottypes)
3989
377k
        return true;
3990
3991
    /* Null terminated list, return true if subtype is on the list */
3992
0
    ptr = ctx->args.showannottypes;
3993
0
    while (*ptr) {
3994
0
        char *str = *ptr;
3995
0
        if (pdfi_name_is(subtype, str))
3996
0
            return true;
3997
0
        ptr ++;
3998
0
    }
3999
    /* List exists, but subtype is not on it */
4000
0
    return false;
4001
0
}
4002
4003
/* Check to see if subtype is on the PreserveAnnotTypes list
4004
 * Defaults to true if there is no list
4005
 */
4006
static bool pdfi_annot_preserve_type(pdf_context *ctx, pdf_name *subtype)
4007
76.2k
{
4008
76.2k
    char **ptr;
4009
4010
    /* True if no list */
4011
76.2k
    if (!ctx->args.preserveannottypes)
4012
76.2k
        return true;
4013
4014
    /* Null terminated list, return true if subtype is on the list */
4015
0
    ptr = ctx->args.preserveannottypes;
4016
0
    while (*ptr) {
4017
0
        char *str = *ptr;
4018
0
        if (pdfi_name_is(subtype, str))
4019
0
            return true;
4020
0
        ptr ++;
4021
0
    }
4022
    /* List exists, but subtype is not on it */
4023
0
    return false;
4024
0
}
4025
4026
static int pdfi_annot_draw(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4027
602k
{
4028
602k
    pdf_obj *NormAP = NULL;
4029
602k
    int code = 0;
4030
602k
    annot_dispatch_t *dispatch_ptr;
4031
602k
    bool render_done = true;
4032
4033
    /* See if annotation is visible */
4034
602k
    if (!pdfi_annot_visible(ctx, annot, subtype))
4035
224k
        goto exit;
4036
4037
    /* See if we are rendering this type of annotation */
4038
377k
    if (!pdfi_annot_check_type(ctx, subtype))
4039
0
        goto exit;
4040
4041
    /* Get the Normal AP, if it exists */
4042
377k
    code = pdfi_annot_get_NormAP(ctx, annot, &NormAP);
4043
377k
    if (code < 0) goto exit;
4044
4045
311k
    code = pdfi_gsave(ctx);
4046
311k
    if (code < 0) goto exit;
4047
4048
    /* Draw the annotation */
4049
4.90M
    for (dispatch_ptr = annot_dispatch; dispatch_ptr->subtype; dispatch_ptr ++) {
4050
4.90M
        if (pdfi_name_is(subtype, dispatch_ptr->subtype)) {
4051
311k
            if (NormAP && dispatch_ptr->simpleAP)
4052
122k
                render_done = false;
4053
189k
            else
4054
189k
                code = dispatch_ptr->func(ctx, annot, NormAP, &render_done);
4055
311k
            break;
4056
311k
        }
4057
4.90M
    }
4058
311k
    if (!dispatch_ptr->subtype) {
4059
179
        char str[100];
4060
179
        memcpy(str, (const char *)subtype->data, subtype->length < 100 ? subtype->length : 99);
4061
179
        str[subtype->length < 100 ? subtype->length : 99] = '\0';
4062
179
        dbgmprintf1(ctx->memory, "ANNOT: No handler for subtype %s\n", str);
4063
4064
        /* Not necessarily an error? We can just render the AP if there is one */
4065
179
        render_done = false;
4066
179
    }
4067
4068
311k
    if (!render_done)
4069
219k
        code = pdfi_annot_draw_AP(ctx, annot, NormAP);
4070
4071
311k
    (void)pdfi_grestore(ctx);
4072
4073
602k
 exit:
4074
602k
    pdfi_countdown(NormAP);
4075
602k
    return code;
4076
311k
}
4077
4078
/* Create a string containing form label
4079
 * I don't think the format actually matters, though it probably needs to be unique
4080
 * Just use a counter to ensure uniqueness
4081
 *
4082
 * Format: {FormName%d}
4083
 */
4084
static int pdfi_annot_preserve_nextformlabel(pdf_context *ctx, byte **data, int *len)
4085
16.2k
{
4086
16.2k
    int size = 40;
4087
16.2k
    char *buf;
4088
16.2k
    gs_id counter = gs_next_ids(ctx->memory, 1);
4089
4090
16.2k
    buf = (char *)gs_alloc_bytes(ctx->memory, size, "pdfi_annot_preserve_nextformlabel(buf)");
4091
16.2k
    if (buf == NULL)
4092
0
        return_error(gs_error_VMerror);
4093
16.2k
    snprintf(buf, size, "{FN%ld}", counter);
4094
16.2k
    *len = strlen(buf);
4095
16.2k
    *data = (byte *)buf;
4096
16.2k
    return 0;
4097
16.2k
}
4098
4099
/* Modify the QuadPoints array to correct for some BS in the pdfwrite driver.
4100
 * comment from gs code (pdf_draw.ps/ApplyCMTToQuadPoints()):
4101
  %% Nasty hackery here really. We need to undo the HWResolution scaling which
4102
  %% is done by pdfwrite. Default is 720 dpi, so 0.1. We also need to make
4103
  %% sure that any translation of the page (because its been rotated for example)
4104
  %% is also modified by the requisite amount. SO we ned to calculate a matrix
4105
  %% which does the scaling and concatenate it with the current matrix.
4106
  %% Do this inside a gsave/grestore pair to avoid side effects!
4107
 *
4108
 * TODO: In practice, when I was debugging this code I found that it does nothing
4109
 * useful, since the matrice it calculates is essentially the identity matrix.
4110
 * I am not sure under what circumstance it is needed?
4111
 */
4112
static int pdfi_annot_preserve_modQP(pdf_context *ctx, pdf_dict *annot, pdf_name *QP_key)
4113
635
{
4114
635
    int code = 0;
4115
635
    pdf_array *QP = NULL;
4116
635
    gx_device *device = gs_currentdevice(ctx->pgs);
4117
635
    gs_matrix devmatrix, ctm, matrix;
4118
635
    uint64_t arraysize, index;
4119
635
    double old_x, old_y;
4120
635
    gs_point point;
4121
4122
635
    code = pdfi_dict_get(ctx, annot, "QuadPoints", (pdf_obj **)&QP);
4123
635
    if (code < 0) goto exit;
4124
4125
635
    if (pdfi_type_of(QP) != PDF_ARRAY) {
4126
        /* Invalid QuadPoints, just delete it because I dunno what to do...
4127
         * TODO: Should flag a warning here
4128
         */
4129
0
        code = pdfi_dict_delete_pair(ctx, annot, QP_key);
4130
0
        goto exit;
4131
0
    }
4132
4133
635
    arraysize = pdfi_array_size(QP);
4134
635
    if (arraysize % 8 != 0) {
4135
        /* TODO: Flag a warning -- must be sets of 8 values (4 points) */
4136
8
        code = gs_note_error(gs_error_syntaxerror);
4137
8
        goto exit;
4138
8
    }
4139
4140
4141
    /* Get device matrix and adjust by default 72.0 (no idea, just following PS code...) */
4142
627
    devmatrix.xx = 72.0 / device->HWResolution[0];
4143
627
    devmatrix.xy = 0;
4144
627
    devmatrix.yx = 0;
4145
627
    devmatrix.yy = 72.0 / device->HWResolution[1];
4146
627
    devmatrix.tx = 0;
4147
627
    devmatrix.ty = 0;
4148
4149
    /* Get the CTM */
4150
627
    gs_currentmatrix(ctx->pgs, &ctm);
4151
4152
    /* Get matrix to adjust the QuadPoints */
4153
627
    code = gs_matrix_multiply(&ctm, &devmatrix, &matrix);
4154
627
    if (code < 0) goto exit;
4155
4156
    /* Transform all the points by the calculated matrix */
4157
7.85k
    for (index = 0; index < arraysize; index += 2) {
4158
7.23k
        code = pdfi_array_get_number(ctx, QP, index, &old_x);
4159
7.23k
        if (code < 0) goto exit;
4160
7.23k
        code = pdfi_array_get_number(ctx, QP, index+1, &old_y);
4161
7.23k
        if (code < 0) goto exit;
4162
4163
7.23k
        code = gs_point_transform(old_x, old_y, &matrix, &point);
4164
7.23k
        if (code < 0) goto exit;
4165
4166
7.23k
        code = pdfi_array_put_real(ctx, QP, index, point.x);
4167
7.23k
        if (code < 0) goto exit;
4168
7.23k
        code = pdfi_array_put_real(ctx, QP, index+1, point.y);
4169
7.23k
        if (code < 0) goto exit;
4170
7.23k
    }
4171
4172
4173
635
 exit:
4174
635
    pdfi_countdown(QP);
4175
635
    return code;
4176
627
}
4177
4178
/* Build a high level form for the AP and replace it with an indirect reference
4179
 *
4180
 * There can multiple AP in the dictionary, so do all of them.
4181
 */
4182
static int pdfi_annot_preserve_modAP(pdf_context *ctx, pdf_dict *annot, pdf_name *AP_key)
4183
25.2k
{
4184
25.2k
    int code = 0;
4185
25.2k
    pdf_dict *AP = NULL;
4186
25.2k
    uint64_t index;
4187
25.2k
    pdf_name *Key = NULL;
4188
25.2k
    pdf_indirect_ref *Value = NULL;
4189
25.2k
    byte *labeldata = NULL;
4190
25.2k
    int labellen;
4191
25.2k
    int form_id;
4192
25.2k
    gx_device *device = gs_currentdevice(ctx->pgs);
4193
25.2k
    bool found_ap = false; /* found at least one AP stream? */
4194
25.2k
    pdf_obj *object = NULL;
4195
4196
25.2k
    code = pdfi_dict_get(ctx, annot, "AP", (pdf_obj **)&AP);
4197
25.2k
    if (code < 0) goto exit;
4198
4199
24.3k
    if (pdfi_type_of(AP) != PDF_DICT) {
4200
        /* This is an invalid AP, we will flag and delete it below */
4201
95
        found_ap = false;
4202
95
        goto exit;
4203
95
    }
4204
4205
24.2k
    code = pdfi_dict_key_first(ctx, AP, (pdf_obj **)&Key, &index);
4206
24.2k
    while (code >= 0) {
4207
24.2k
        found_ap = true;
4208
24.2k
        code = pdfi_dict_get_no_deref(ctx, AP, Key, (pdf_obj **)&Value);
4209
24.2k
        if (code < 0) goto exit;
4210
4211
        /* Handle indirect object */
4212
24.2k
        if (pdfi_type_of(Value) != PDF_INDIRECT)
4213
8
            goto loop_continue;
4214
4215
        /* Dereference it */
4216
24.2k
        code = pdfi_dereference(ctx, Value->ref_object_num, Value->ref_generation_num, &object);
4217
24.2k
        if (code < 0) goto exit;
4218
4219
16.2k
        if (pdfi_type_of(object) == PDF_STREAM) {
4220
            /* Get a form label */
4221
16.2k
            code = pdfi_annot_preserve_nextformlabel(ctx, &labeldata, &labellen);
4222
16.2k
            if (code < 0) goto exit;
4223
4224
            /* Notify the driver of the label name */
4225
16.2k
            code = (*dev_proc(device, dev_spec_op))
4226
16.2k
                (device, gxdso_pdf_form_name, labeldata, labellen);
4227
4228
16.2k
            code = pdfi_op_q(ctx);
4229
16.2k
            if (code < 0)
4230
0
                goto exit;
4231
4232
16.2k
            code = pdfi_annot_position_AP(ctx, annot, (pdf_stream *)object);
4233
            /* Draw the high-level form */
4234
16.2k
            code = pdfi_do_highlevel_form(ctx, ctx->page.CurrentPageDict, (pdf_stream *)object);
4235
16.2k
            (void)pdfi_op_Q(ctx);
4236
16.2k
            if (code < 0) goto exit;
4237
4238
            /* Get the object number (form_id) of the high level form */
4239
16.2k
            code = (*dev_proc(device, dev_spec_op))
4240
16.2k
                (device, gxdso_get_form_ID, &form_id, sizeof(int));
4241
4242
            /* Save the highlevel form info for pdfi_obj_indirect_str() */
4243
16.2k
            Value->highlevel_object_num = form_id;
4244
16.2k
            Value->is_highlevelform = true;
4245
4246
16.2k
        }
4247
4248
16.2k
    loop_continue:
4249
16.2k
        pdfi_countdown(Key);
4250
16.2k
        Key = NULL;
4251
16.2k
        pdfi_countdown(Value);
4252
16.2k
        Value = NULL;
4253
16.2k
        pdfi_countdown(object);
4254
16.2k
        object = NULL;
4255
16.2k
        gs_free_object(ctx->memory, labeldata, "pdfi_annot_preserve_modAP(labeldata)");
4256
16.2k
        labeldata = NULL;
4257
4258
16.2k
        code = pdfi_dict_key_next(ctx, AP, (pdf_obj **)&Key, &index);
4259
16.2k
        if (code == gs_error_undefined) {
4260
16.2k
            code = 0;
4261
16.2k
            break;
4262
16.2k
        }
4263
16.2k
    }
4264
16.2k
    if (code < 0) goto exit;
4265
4266
25.2k
 exit:
4267
    /* If there was no AP found, then delete the key completely.
4268
     * (Bug697951.pdf)
4269
     */
4270
25.2k
    if (!found_ap) {
4271
        /* TODO: Flag a warning for broken file? */
4272
1.00k
        code = pdfi_dict_delete_pair(ctx, annot, AP_key);
4273
1.00k
    }
4274
4275
25.2k
    if (labeldata)
4276
4
        gs_free_object(ctx->memory, labeldata, "pdfi_annot_preserve_modAP(labeldata)");
4277
25.2k
    pdfi_countdown(AP);
4278
25.2k
    pdfi_countdown(Key);
4279
25.2k
    pdfi_countdown(Value);
4280
25.2k
    pdfi_countdown(object);
4281
25.2k
    return code;
4282
16.2k
}
4283
4284
/* Make a temporary copy of the annotation dict with some fields left out or
4285
 * modified, then do a pdfmark on it
4286
 */
4287
4288
const char *PermittedKeys[] = {
4289
    /* These keys are valid for all annotation types, we specifically do not allow /P or /Parent */
4290
    "Type",
4291
    "Subtype",
4292
    "Rect",
4293
    "Contents",
4294
    "NM",
4295
    "M",
4296
    "F",
4297
    "AP",
4298
    "AS",
4299
    "Border",
4300
    "C",
4301
    "StructParent",
4302
    "OC",
4303
    "AF",
4304
    "ca",
4305
    "CA",
4306
    "BM",
4307
    "Lang",
4308
    /* Keys by annotation type (some are common to more than one type, only one entry per key) */
4309
    /* Markup Annotations we specifically do not permit RT, IRT or Popup */
4310
    "T",
4311
    "RC",
4312
    "CreationDate",
4313
    "Subj",
4314
    "IT",
4315
    "ExData",
4316
    /* Text annotations */
4317
    "Open",
4318
    "Name",
4319
    "State",
4320
    "StateModel",
4321
    /* This isn't specified as being allowed, but Acrobat does something with it, so we need to preserve it */
4322
    "Rotate",
4323
    /* Link annotations */
4324
    "A",
4325
    "Dest",
4326
    "H",
4327
    "PA",
4328
    "QuadPoints",
4329
    /* FreeText annotations */
4330
    "DA",
4331
    "Q",
4332
    "DS",
4333
    "CL",
4334
    "IT",
4335
    "BE",
4336
    "RD",
4337
    "BS",
4338
    "LE",
4339
    /* Line Annotations */
4340
    "L",
4341
    "LE",
4342
    "IC",
4343
    "LL",
4344
    "LLE",
4345
    "Cap",
4346
    "LLO",
4347
    "CP",
4348
    "Measure",
4349
    "CO",
4350
    /* Square and Circle annotations */
4351
    "Path",
4352
    /* Polygon and PolyLine annotations */
4353
    "Vertices",
4354
    /* Text Markup annotations */
4355
    /* Caret annotations */
4356
    "Sy",
4357
    /* Rubber Stamp annotations */
4358
    /* Ink annotations */
4359
    "InkList",
4360
    /* Popup annotations */
4361
    "Open",
4362
    /* File attachment annotation */
4363
    "FS",
4364
    /* Sound annotations */
4365
    "Sound",
4366
    /* Movie annotations */
4367
    "Movie",
4368
    /* Screen annotations */
4369
    "MK",
4370
    "AA",
4371
    /* We don't handle Widget annotations as annotations, we draw them */
4372
    /* Printer's Mark annotations */
4373
    /* Trap Network annotations */
4374
    /* Watermark annotations */
4375
    "FixedPrint",
4376
    "Matrix",
4377
    "H",
4378
    "V",
4379
    /* Redaction annotations */
4380
    "RO",
4381
    "OverlayText",
4382
    "Repeat",
4383
    /* Projection annotations */
4384
    /* 3D and RichMedia annotations */
4385
};
4386
4387
static int isKnownKey(pdf_context *ctx, pdf_name *Key)
4388
449k
{
4389
449k
    int i = 0;
4390
4391
8.01M
    for (i = 0; i < sizeof(PermittedKeys) / sizeof (const char *); i++) {
4392
7.95M
        if (pdfi_name_is(Key, PermittedKeys[i]))
4393
391k
            return 1;
4394
7.95M
    }
4395
58.0k
    return 0;
4396
449k
}
4397
4398
static int pdfi_annot_preserve_mark(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4399
59.6k
{
4400
59.6k
    int code = 0;
4401
59.6k
    gs_matrix ctm;
4402
59.6k
    pdf_dict *tempdict = NULL;
4403
59.6k
    uint64_t dictsize;
4404
59.6k
    uint64_t index;
4405
59.6k
    pdf_name *Key = NULL;
4406
59.6k
    pdf_obj *Value = NULL;
4407
59.6k
    bool resolve = false;
4408
4409
    /* Create a temporary copy of the annot dict */
4410
59.6k
    dictsize = pdfi_dict_entries(annot);
4411
59.6k
    code = pdfi_dict_alloc(ctx, dictsize, &tempdict);
4412
59.6k
    if (code < 0) goto exit;
4413
59.6k
    pdfi_countup(tempdict);
4414
59.6k
    code = pdfi_dict_copy(ctx, tempdict, annot);
4415
59.6k
    if (code < 0) goto exit;
4416
4417
4418
     /* see also: 'loadannot' in gs code */
4419
    /* Go through the dict, deleting and modifying some entries
4420
     * Note that I am iterating through the original dict because I will
4421
     * be deleting some keys from tempdict and the iterators wouldn't work right.
4422
     */
4423
59.6k
    code = pdfi_dict_key_first(ctx, annot, (pdf_obj **)&Key, &index);
4424
449k
    while (code >= 0) {
4425
449k
        resolve = false;
4426
4427
449k
        if (!isKnownKey(ctx, Key)) {
4428
58.0k
            code = pdfi_dict_delete_pair(ctx, tempdict, Key);
4429
58.0k
            if (code < 0) goto exit;
4430
391k
        } else {
4431
391k
            if (pdfi_name_is(Key, "AP")) {
4432
                /* Special handling for AP -- have fun! */
4433
25.2k
                code = pdfi_annot_preserve_modAP(ctx, tempdict, Key);
4434
25.2k
                if (code < 0) goto exit;
4435
366k
            } else if (pdfi_name_is(Key, "QuadPoints")) {
4436
635
                code = pdfi_annot_preserve_modQP(ctx, tempdict, Key);
4437
635
                if (code < 0) goto exit;
4438
365k
            } else if (pdfi_name_is(Key, "A")) {
4439
9.49k
                code = pdfi_pdfmark_modA(ctx, tempdict);
4440
9.49k
                if (code < 0) goto exit;
4441
356k
            } else if (pdfi_name_is(Key, "Dest")) {
4442
284
                if (ctx->args.no_pdfmark_dests) {
4443
                    /* If omitting dests, such as for multi-page output, then omit this whole annotation */
4444
0
                    code = 0;
4445
0
                    goto exit;
4446
0
                }
4447
284
                code = pdfi_pdfmark_modDest(ctx, tempdict);
4448
284
                if (code < 0) goto exit;
4449
355k
            } else if (pdfi_name_is(Key, "StructTreeRoot")) {
4450
                /* TODO: Bug691785 has Link annots with /StructTreeRoot
4451
                 * It is super-circular, and causes issues.
4452
                 * GS code only adds in certain values for Link so it doesn't
4453
                 * run into a problem.  I am just going to delete it.
4454
                 * There should be a better solution to handle circular stuff
4455
                 * generically.
4456
                 */
4457
0
                code = pdfi_dict_delete_pair(ctx, tempdict, Key);
4458
0
                if (code < 0) goto exit;
4459
355k
            } else if (pdfi_name_is(Key, "Sound") || pdfi_name_is(Key, "Movie")) {
4460
0
                resolve = false;
4461
355k
            } else {
4462
355k
                resolve = true;
4463
355k
            }
4464
391k
        }
4465
440k
        if (resolve) {
4466
355k
            code = pdfi_dict_get_by_key(ctx, annot, (const pdf_name *)Key, &Value);
4467
355k
            if (code < 0) goto exit;
4468
4469
            /* Pre-resolve indirect references of any arrays/dicts
4470
             * TODO: I am doing this because the gs code does it, but I
4471
             * noticed it only goes down one level, not recursively through
4472
             * everything.  I am not sure what the point is in that case.
4473
             * For now, also doing only one level.
4474
             */
4475
355k
            code = pdfi_resolve_indirect_loop_detect(ctx, (pdf_obj *)annot, Value, false);
4476
355k
            if (code < 0) goto exit;
4477
355k
        }
4478
4479
440k
        pdfi_countdown(Key);
4480
440k
        Key = NULL;
4481
440k
        pdfi_countdown(Value);
4482
440k
        Value = NULL;
4483
4484
440k
        code = pdfi_dict_key_next(ctx, annot, (pdf_obj **)&Key, &index);
4485
440k
        if (code == gs_error_undefined) {
4486
50.3k
            code = 0;
4487
50.3k
            break;
4488
50.3k
        }
4489
440k
    }
4490
50.3k
    if (code < 0) goto exit;
4491
4492
    /* Do pdfmark from the tempdict */
4493
50.3k
    gs_currentmatrix(ctx->pgs, &ctm);
4494
4495
50.3k
    if (pdfi_name_is(subtype, "Link"))
4496
8.57k
        code = pdfi_pdfmark_from_dict(ctx, tempdict, &ctm, "LNK");
4497
41.7k
    else
4498
41.7k
        code = pdfi_pdfmark_from_dict(ctx, tempdict, &ctm, "ANN");
4499
50.3k
    if (code < 0) goto exit;
4500
4501
59.6k
 exit:
4502
59.6k
    pdfi_countdown(tempdict);
4503
59.6k
    pdfi_countdown(Key);
4504
59.6k
    pdfi_countdown(Value);
4505
59.6k
    return code;
4506
50.3k
}
4507
4508
static int pdfi_annot_preserve_default(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4509
49.8k
{
4510
49.8k
    return pdfi_annot_preserve_mark(ctx, annot, subtype);
4511
49.8k
}
4512
4513
static int pdfi_annot_preserve_Link(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4514
9.78k
{
4515
9.78k
    int code = 0;
4516
4517
    /* TODO: The gs code does a whole bunch of stuff I don't understand yet.
4518
     * I think doing the default behavior might work in most cases?
4519
     * See: pdf_draw.ps/preserveannottypes dict/Link()
4520
     */
4521
9.78k
    code = pdfi_annot_preserve_mark(ctx, annot, subtype);
4522
9.78k
    return code;
4523
9.78k
}
4524
4525
static int pdfi_annot_preserve_Widget(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4526
16.4k
{
4527
    /* According to the gs implementation:
4528
%% Widget annotations are only used with AcroForms, and since we don't preserve AcroForms
4529
%% we don't want to preserve widget annotations either, because the consumer of the new
4530
%% PDF won't know what values they should take. So we draw widget annotations instead. If we
4531
%% ever preserve AcroForms then we should alter this to preserve Widgets as well.
4532
     *
4533
     * TODO: See also, comment on pdfi_annot_render_field().
4534
     */
4535
4536
16.4k
    return pdfi_annot_draw(ctx, annot, subtype);
4537
16.4k
}
4538
4539
/* TODO: When I started writing this, I thought these handlers were necessary because
4540
 * the PS code has a bunch of special cases.  As it turns out, I think it could easily have
4541
 * been done without the handlers.   Maybe they should be taken out...
4542
 */
4543
annot_preserve_dispatch_t annot_preserve_dispatch[] = {
4544
    {"Link", pdfi_annot_preserve_Link},
4545
    {"Widget", pdfi_annot_preserve_Widget},
4546
    {"Circle", pdfi_annot_preserve_default},
4547
    {"FileAttachment", pdfi_annot_preserve_default},
4548
    {"FreeText", pdfi_annot_preserve_default},
4549
    {"Highlight", pdfi_annot_preserve_default},
4550
    {"Ink", pdfi_annot_preserve_default},
4551
    {"Line", pdfi_annot_preserve_default},
4552
    {"Movie", pdfi_annot_preserve_default},
4553
    {"PolyLine", pdfi_annot_preserve_default},
4554
    {"Popup", pdfi_annot_preserve_default},
4555
    /*    {"Screen", pdfi_annot_preserve_default},  /* TODO: fts_07_0709.pdf */
4556
    {"Sound", pdfi_annot_preserve_default},
4557
    {"Square", pdfi_annot_preserve_default},
4558
    {"Squiggly", pdfi_annot_preserve_default},
4559
    {"StrikeOut", pdfi_annot_preserve_default},
4560
    {"Underline", pdfi_annot_preserve_default},
4561
    {"Stamp", pdfi_annot_preserve_default},
4562
    {"Text", pdfi_annot_preserve_default},
4563
    {"TrapNet", pdfi_annot_preserve_default},
4564
    { NULL, NULL},
4565
};
4566
4567
static int pdfi_annot_preserve(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4568
76.2k
{
4569
76.2k
    int code = 0;
4570
76.2k
    annot_preserve_dispatch_t *dispatch_ptr;
4571
4572
    /* If not preserving this subtype, draw it instead */
4573
76.2k
    if (!pdfi_annot_preserve_type(ctx, subtype))
4574
0
        return pdfi_annot_draw(ctx, annot, subtype);
4575
4576
    /* Handle the annotation */
4577
633k
    for (dispatch_ptr = annot_preserve_dispatch; dispatch_ptr->subtype; dispatch_ptr ++) {
4578
633k
        if (pdfi_name_is(subtype, dispatch_ptr->subtype)) {
4579
76.0k
            code = dispatch_ptr->func(ctx, annot, subtype);
4580
76.0k
            break;
4581
76.0k
        }
4582
633k
    }
4583
4584
    /* If there is no handler, just draw it */
4585
    /* NOTE: gs does a drawwidget here instead (?) */
4586
76.2k
    if (!dispatch_ptr->subtype)
4587
114
        code = pdfi_annot_draw(ctx, annot, subtype);
4588
4589
76.2k
    return code;
4590
76.2k
}
4591
4592
static int pdfi_annot_handle(pdf_context *ctx, pdf_dict *annot)
4593
663k
{
4594
663k
    int code = 0;
4595
663k
    pdf_name *Subtype = NULL;
4596
4597
663k
    code = pdfi_dict_get_type(ctx, annot, "Subtype", PDF_NAME, (pdf_obj **)&Subtype);
4598
663k
    if (code != 0) {
4599
        /* TODO: Set warning flag */
4600
1.41k
        dbgmprintf(ctx->memory, "WARNING: Ignoring annotation with missing Subtype\n");
4601
1.41k
        code = 0;
4602
1.41k
        goto exit;
4603
1.41k
    }
4604
4605
661k
    if (ctx->args.preserveannots && ctx->device_state.annotations_preserved)
4606
76.2k
        code = pdfi_annot_preserve(ctx, annot, Subtype);
4607
585k
    else
4608
585k
        code = pdfi_annot_draw(ctx, annot, Subtype);
4609
4610
663k
 exit:
4611
663k
    pdfi_countdown(Subtype);
4612
663k
    if (code < 0) {
4613
88.1k
        code = pdfi_set_error_stop(ctx, code, NULL, E_PDF_BAD_ANNOTATION, "pdfi_annot_handle", "Error handling annotation");
4614
88.1k
    }
4615
663k
    return code;
4616
661k
}
4617
4618
int pdfi_do_annotations(pdf_context *ctx, pdf_dict *page_dict)
4619
136k
{
4620
136k
    int code = 0;
4621
136k
    pdf_array *Annots = NULL;
4622
136k
    pdf_dict *annot = NULL;
4623
136k
    int i;
4624
4625
136k
    if (!ctx->args.showannots)
4626
0
        return 0;
4627
4628
136k
    code = pdfi_dict_knownget_type(ctx, page_dict, "Annots", PDF_ARRAY, (pdf_obj **)&Annots);
4629
136k
    if (code <= 0)
4630
102k
        return code;
4631
4632
800k
    for (i = 0; i < pdfi_array_size(Annots); i++) {
4633
766k
        code = pdfi_array_get_type(ctx, Annots, i, PDF_DICT, (pdf_obj **)&annot);
4634
766k
        if (code < 0) {
4635
102k
            if ((code = pdfi_set_warning_stop(ctx, code, NULL, W_PDF_ANNOT_BAD_TYPE, "pdfi_do_annotations", "")) < 0)
4636
0
                goto exit;
4637
102k
            continue;
4638
102k
        }
4639
663k
        code = pdfi_annot_handle(ctx, annot);
4640
663k
        if (code < 0 &&
4641
2
           ((code = pdfi_set_error_stop(ctx, code, NULL, E_PDF_BAD_ANNOTATION, "pdfi_annot_handle", "Error handling annotation")) < 0)) {
4642
2
            goto exit;
4643
2
        }
4644
663k
        pdfi_countdown(annot);
4645
663k
        annot = NULL;
4646
663k
    }
4647
4648
34.4k
 exit:
4649
34.4k
    pdfi_countdown(annot);
4650
34.4k
    pdfi_countdown(Annots);
4651
34.4k
    return code;
4652
34.4k
}
4653
4654
/* draw terminal field */
4655
static int pdfi_form_draw_terminal(pdf_context *ctx, pdf_dict *Page, pdf_dict *field)
4656
0
{
4657
0
    int code = 0;
4658
0
    pdf_indirect_ref *P = NULL;
4659
0
    pdf_name *FT = NULL;
4660
0
    pdf_obj *AP = NULL;
4661
4662
    /* See if the field goes on this page */
4663
    /* NOTE: We know the "P" is an indirect ref, so just fetch it that way.
4664
     * If we fetch the actual object, it will result in a cyclical reference in the cache
4665
     * that causes a memory leak, so don't do that.
4666
     * (The cyclical reference is because the object containing P is actually inside P)
4667
     */
4668
0
    code = pdfi_dict_get_ref(ctx, field, "P", &P);
4669
0
    if (code < 0) {
4670
0
        if (code == gs_error_undefined)
4671
0
            code = 0;
4672
0
        goto exit;
4673
0
    }
4674
4675
0
    if (P->ref_object_num != Page->object_num) {
4676
        /* Not this page */
4677
0
        code = 0;
4678
0
        goto exit;
4679
0
    }
4680
4681
    /* Render the field */
4682
4683
    /* NOTE: The spec says the FT is inheritable, implying it might be present in
4684
     * a Parent and not explicitly in a Child.  The gs implementation doesn't seem
4685
     * to handle this case, but I am going to go ahead and handle it.  We will figure
4686
     * out if this causes diffs later, if ever...
4687
     */
4688
0
    code = pdfi_form_get_inheritable(ctx, field, "FT", PDF_NAME, (pdf_obj **)&FT);
4689
0
    if (code <= 0) goto exit;
4690
4691
0
    code = pdfi_annot_get_NormAP(ctx, field, &AP);
4692
0
    if (code < 0) goto exit;
4693
4694
0
    code = pdfi_annot_render_field(ctx, field, FT, AP);
4695
0
    if (code < 0) goto exit;
4696
4697
0
 exit:
4698
0
    pdfi_countdown(FT);
4699
0
    pdfi_countdown(P);
4700
0
    pdfi_countdown(AP);
4701
0
    return code;
4702
0
}
4703
4704
/* From pdf_draw.ps/draw_form_field():
4705
% We distinguish 4 types of nodes on the form field tree:
4706
%  - non-terminal field - has a kid that refers to the parent (or anywhere else)
4707
%  - terminal field with separate widget annotations - has a kid that doesn't have a parent
4708
%  - terminal field with a merged widget annotation - has no kids
4709
%  - widget annotation - has /Subtype and /Rect
4710
%
4711
% The recursive enumeration of the form fields doesn't descend into widget annotations.
4712
*/
4713
static int pdfi_form_draw_field(pdf_context *ctx, pdf_dict *Page, pdf_dict *field)
4714
0
{
4715
0
    int code = 0;
4716
0
    pdf_array *Kids = NULL;
4717
0
    pdf_dict *child = NULL;
4718
0
    pdf_dict *Parent = NULL;
4719
0
    int i;
4720
4721
0
    code = pdfi_dict_knownget_type(ctx, field, "Kids", PDF_ARRAY, (pdf_obj **)&Kids);
4722
0
    if (code < 0) goto exit;
4723
0
    if (code == 0) {
4724
0
        code = pdfi_form_draw_terminal(ctx, Page, field);
4725
0
        goto exit;
4726
0
    }
4727
4728
    /* Handle Kids */
4729
0
    if (pdfi_array_size(Kids) <= 0) {
4730
0
        code = pdfi_set_error_stop(ctx, gs_note_error(gs_error_undefined), NULL, E_PDF_EMPTY_FORM_KIDS, "pdfi_form_draw_field", "");
4731
0
        goto exit;
4732
0
    }
4733
4734
    /* Check first child to see if it has a parent */
4735
0
    code = pdfi_array_get_type(ctx, Kids, 0, PDF_DICT, (pdf_obj **)&child);
4736
0
    if (code < 0) goto exit;
4737
0
    code = pdfi_dict_knownget_type(ctx, child, "Parent", PDF_DICT, (pdf_obj **)&Parent);
4738
0
    if (code < 0) goto exit;
4739
4740
    /* If kid has no parent, then treat this as terminal field */
4741
0
    if (code == 0) {
4742
        /* TODO: This case isn't tested because no examples available.
4743
         * I think it's only relevant for Btn, and not sure if it
4744
         * should be dealt with here or in Btn routine.
4745
         */
4746
0
        code = pdfi_form_draw_terminal(ctx, Page, field);
4747
0
        goto exit;
4748
0
    }
4749
4750
0
    pdfi_countdown(child);
4751
0
    child = NULL;
4752
    /* Render the Kids (recursive) */
4753
0
    for (i=0; i<pdfi_array_size(Kids); i++) {
4754
0
        code = pdfi_array_get_type(ctx, Kids, i, PDF_DICT, (pdf_obj **)&child);
4755
0
        if (code < 0) goto exit;
4756
4757
0
        code = pdfi_form_draw_field(ctx, Page, child);
4758
0
        if (code < 0) goto exit;
4759
4760
0
        pdfi_countdown(child);
4761
0
        child = NULL;
4762
0
    }
4763
4764
0
 exit:
4765
0
    pdfi_countdown(child);
4766
0
    pdfi_countdown(Kids);
4767
0
    pdfi_countdown(Parent);
4768
0
    return code;
4769
0
}
4770
4771
int pdfi_do_acroform(pdf_context *ctx, pdf_dict *page_dict)
4772
136k
{
4773
136k
    int code = 0;
4774
136k
    pdf_array *Fields = NULL;
4775
136k
    pdf_dict *field = NULL;
4776
136k
    int i;
4777
4778
136k
    if (!ctx->args.showacroform)
4779
136k
        return 0;
4780
4781
0
    if (!ctx->AcroForm)
4782
0
        return 0;
4783
4784
0
    code = pdfi_dict_knownget_type(ctx, ctx->AcroForm, "Fields", PDF_ARRAY, (pdf_obj **)&Fields);
4785
0
    if (code <= 0)
4786
0
        goto exit;
4787
4788
0
    for (i=0; i<pdfi_array_size(Fields); i++) {
4789
0
        code = pdfi_array_get_type(ctx, Fields, i, PDF_DICT, (pdf_obj **)&field);
4790
0
        if (code < 0)
4791
0
            continue;
4792
0
        code = pdfi_form_draw_field(ctx, page_dict, field);
4793
0
        if (code < 0)
4794
0
            goto exit;
4795
0
        pdfi_countdown(field);
4796
0
        field = NULL;
4797
0
    }
4798
4799
0
 exit:
4800
0
    pdfi_countdown(field);
4801
0
    pdfi_countdown(Fields);
4802
0
    return code;
4803
0
}