Coverage Report

Created: 2026-04-01 07:17

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
195
#define IS_UTF8(str) (!strcmp((char *)(str), "\xef\xbb\xbf"))
50
53.3k
#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
5.90k
{
77
5.90k
    int code;
78
79
5.90k
    if (!ctx->page.has_transparency)
80
2.78k
        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
3.12k
    code = gs_clippath(ctx->pgs);
87
3.12k
    if (code < 0)
88
0
        return code;
89
3.12k
    code = pdfi_trans_begin_simple_group(ctx, NULL, false, false, false);
90
3.12k
    (void)gs_newpath(ctx->pgs);
91
3.12k
    return code;
92
3.12k
}
93
94
static int pdfi_annot_end_transparency(pdf_context *ctx, pdf_dict *annot)
95
5.89k
{
96
5.89k
    if (!ctx->page.has_transparency)
97
2.78k
        return 0;
98
99
3.11k
    return pdfi_trans_end_simple_group(ctx);
100
5.89k
}
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
409
{
107
409
    int code;
108
409
    pdf_dict *BS = NULL;
109
110
409
    *width = 1.0;
111
112
409
    code = pdfi_dict_knownget_type(ctx, annot, "BS", PDF_DICT, (pdf_obj **)&BS);
113
409
    if (code <= 0)
114
0
        goto exit;
115
116
409
    code = pdfi_dict_knownget_number(ctx, BS, "W", width);
117
118
409
 exit:
119
409
    pdfi_countdown(BS);
120
409
    return code;
121
409
}
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.15k
{
128
1.15k
    int code = 0;
129
1.15k
    double CA;
130
131
    /* CA -- opacity */
132
1.15k
    code = pdfi_dict_knownget_number(ctx, annot, "CA", &CA);
133
1.15k
    if (code > 0) {
134
541
        code = gs_setstrokeconstantalpha(ctx->pgs, CA);
135
541
        if (code < 0) goto exit;
136
541
        code = gs_setfillconstantalpha(ctx->pgs, CA);
137
541
        goto exit;
138
541
    }
139
    /* If CA not found, we also check for 'ca' even though it's not in the spec */
140
609
    code = pdfi_dict_knownget_number(ctx, annot, "ca", &CA);
141
609
    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.15k
 exit:
147
1.15k
    return code;
148
609
}
149
150
/* Apply RD to provided rect */
151
static int pdfi_annot_applyRD(pdf_context *ctx, pdf_dict *annot, gs_rect *rect)
152
1.97k
{
153
1.97k
    int code;
154
1.97k
    pdf_array *RD = NULL;
155
1.97k
    gs_rect rd;
156
157
1.97k
    code = pdfi_dict_knownget_type(ctx, annot, "RD", PDF_ARRAY, (pdf_obj **)&RD);
158
1.97k
    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
1.97k
 exit:
169
1.97k
    pdfi_countdown(RD);
170
1.97k
    return code;
171
11
}
172
173
static int pdfi_annot_Rect(pdf_context *ctx, pdf_dict *annot, gs_rect *rect)
174
188k
{
175
188k
    int code;
176
188k
    pdf_array *Rect = NULL;
177
178
188k
    code = pdfi_dict_knownget_type(ctx, annot, "Rect", PDF_ARRAY, (pdf_obj **)&Rect);
179
188k
    if (code < 0) goto exit;
180
181
188k
    code = pdfi_array_to_gs_rect(ctx, Rect, rect);
182
188k
    if (code < 0) goto exit;
183
184
188k
    pdfi_normalize_rect(ctx, rect);
185
186
188k
 exit:
187
188k
    pdfi_countdown(Rect);
188
188k
    return code;
189
188k
}
190
191
static int pdfi_annot_position_AP(pdf_context *ctx, pdf_dict *annot, pdf_stream *AP)
192
152k
{
193
152k
    int code = 0;
194
152k
    gs_rect rect;
195
152k
    pdf_array *BBox = NULL;
196
152k
    gs_rect bbox;
197
152k
    pdf_array *Matrix = NULL;
198
152k
    gs_matrix matrix;
199
152k
    double xscale, yscale;
200
152k
    pdf_dict *Annot_dict;
201
202
152k
    code = pdfi_dict_from_obj(ctx, (pdf_obj *)AP, &Annot_dict);
203
152k
    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
152k
    ctx->text.BlockDepth = 0;
217
    /* TODO: FIXME */
218
219
152k
    code = pdfi_annot_Rect(ctx, annot, &rect);
220
152k
    if (code < 0) goto exit;
221
222
152k
    code = pdfi_dict_knownget_type(ctx, Annot_dict, "BBox", PDF_ARRAY, (pdf_obj **)&BBox);
223
152k
    if (code < 0) goto exit;
224
152k
    code = pdfi_array_to_gs_rect(ctx, BBox, &bbox);
225
152k
    if (code < 0) goto exit;
226
227
152k
    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
127
        pdfi_countdown(BBox);
234
127
        BBox = NULL;
235
127
    }
236
237
152k
    code = pdfi_dict_knownget_type(ctx, Annot_dict, "Matrix", PDF_ARRAY, (pdf_obj **)&Matrix);
238
152k
    if (code < 0) goto exit;
239
152k
    code = pdfi_array_to_gs_matrix(ctx, Matrix, &matrix);
240
152k
    if (code < 0) goto exit;
241
242
152k
    xscale = yscale = 1.0;
243
244
152k
    code = gs_translate(ctx->pgs, rect.p.x, rect.p.y);
245
152k
    if (code < 0) goto exit;
246
247
152k
    if (BBox != NULL) {
248
151k
        pdfi_bbox_transform(ctx, &bbox, &matrix);
249
250
        /* Calculate scale factor */
251
151k
        xscale = (rect.q.x - rect.p.x) / (bbox.q.x - bbox.p.x);
252
151k
        yscale = (rect.q.y - rect.p.y) / (bbox.q.y - bbox.p.y);
253
254
151k
        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
151k
        code = gs_scale(ctx->pgs, xscale, yscale);
261
151k
        if (code < 0) goto exit;
262
263
        /* Compensate for non-zero origin of BBox */
264
151k
        code = gs_translate(ctx->pgs, -bbox.p.x, -bbox.p.y);
265
151k
        if (code < 0) goto exit;
266
151k
    }
267
268
152k
 exit:
269
152k
    pdfi_countdown(BBox);
270
152k
    pdfi_countdown(Matrix);
271
152k
    return code;
272
152k
}
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
148k
{
277
148k
    int code = 0;
278
279
148k
    if (NormAP == NULL)
280
1.99k
        return 0;
281
146k
    if (pdfi_type_of(NormAP) == PDF_NULL)
282
7.48k
        return 0;
283
138k
    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
138k
    code = pdfi_op_q(ctx);
287
138k
    if (code < 0)
288
0
        return code;
289
290
138k
    code = pdfi_annot_position_AP(ctx, annot, (pdf_stream *)NormAP);
291
138k
    if (code < 0)
292
320
        goto exit;
293
294
    /* Render the annotation */
295
138k
    code = pdfi_do_image_or_form(ctx, NULL, ctx->page.CurrentPageDict, NormAP);
296
297
138k
exit:
298
138k
    (void)pdfi_op_Q(ctx);
299
138k
    return code;
300
138k
}
301
302
static int pdfi_annot_setcolor_key(pdf_context *ctx, pdf_dict *annot, const char *key,
303
                                   bool usedefault, bool *drawit)
304
45.0k
{
305
45.0k
    int code = 0;
306
45.0k
    pdf_array *C = NULL;
307
308
45.0k
    *drawit = true;
309
310
45.0k
    code = pdfi_dict_knownget_type(ctx, annot, key, PDF_ARRAY, (pdf_obj **)&C);
311
45.0k
    if (code < 0) goto exit;
312
313
45.0k
    if (code == 0) {
314
38.2k
        if (usedefault)
315
1.75k
            code = pdfi_gs_setgray(ctx, 0);
316
36.5k
        else
317
36.5k
            *drawit = false;
318
38.2k
    } else {
319
6.76k
        if (pdfi_array_size(C) == 0) {
320
21
            code = 0;
321
21
            *drawit = false;
322
6.74k
        } else {
323
6.74k
            code = pdfi_setcolor_from_array(ctx, C);
324
6.74k
        }
325
6.76k
    }
326
327
45.0k
 exit:
328
45.0k
    if (code < 0)
329
44
        *drawit = false;
330
45.0k
    pdfi_countdown(C);
331
45.0k
    return code;
332
45.0k
}
333
334
static int pdfi_annot_setinteriorcolor(pdf_context *ctx, pdf_dict *annot, bool usedefault, bool *drawit)
335
758
{
336
758
    return pdfi_annot_setcolor_key(ctx, annot, "IC", usedefault, drawit);
337
758
}
338
339
static int pdfi_annot_setcolor(pdf_context *ctx, pdf_dict *annot, bool usedefault, bool *drawit)
340
7.59k
{
341
7.59k
    return pdfi_annot_setcolor_key(ctx, annot, "C", usedefault, drawit);
342
7.59k
}
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.04k
{
347
2.04k
    int code = 0;
348
349
2.04k
    if (width <= 0)
350
0
        return 0;
351
352
2.04k
    code = pdfi_setdash_impl(ctx, dash, 0);
353
2.04k
    if (code < 0) goto exit;
354
2.04k
    code = gs_setlinewidth(ctx->pgs, width);
355
2.04k
    if (code < 0) goto exit;
356
357
2.04k
    code = gs_stroke(ctx->pgs);
358
359
2.04k
 exit:
360
2.04k
    return code;
361
2.04k
}
362
363
/* Fill border path */
364
static int pdfi_annot_fillborderpath(pdf_context *ctx, pdf_dict *annot)
365
622
{
366
622
    int code;
367
622
    bool drawit;
368
369
622
    code = pdfi_gsave(ctx);
370
622
    if (code < 0) return code;
371
372
622
    code = pdfi_annot_opacity(ctx, annot);
373
622
    if (code < 0) goto exit;
374
622
    code = pdfi_annot_setinteriorcolor(ctx, annot, false, &drawit);
375
622
    if (code < 0) goto exit;
376
618
    if (drawit)
377
494
        code = gs_fill(ctx->pgs);
378
379
622
 exit:
380
622
    (void)pdfi_grestore(ctx);
381
622
    return code;
382
618
}
383
384
385
/* Draw a path from a rectangle */
386
static int pdfi_annot_rect_path(pdf_context *ctx, gs_rect *rect)
387
76
{
388
76
    int code;
389
390
76
    code = gs_moveto(ctx->pgs, rect->p.x, rect->p.y);
391
76
    if (code < 0) goto exit;
392
76
    code = gs_lineto(ctx->pgs, rect->q.x, rect->p.y);
393
76
    if (code < 0) goto exit;
394
76
    code = gs_lineto(ctx->pgs, rect->q.x, rect->q.y);
395
76
    if (code < 0) goto exit;
396
76
    code = gs_lineto(ctx->pgs, rect->p.x, rect->q.y);
397
76
    if (code < 0) goto exit;
398
76
    code = gs_closepath(ctx->pgs);
399
400
76
 exit:
401
76
    return code;
402
76
}
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
76
{
410
76
    gs_rect rect;
411
76
    int code;
412
413
76
    code = pdfi_annot_Rect(ctx, annot, &rect);
414
76
    if (code < 0) goto exit;
415
416
76
    code = pdfi_annot_applyRD(ctx, annot, &rect);
417
76
    if (code < 0) goto exit;
418
419
76
    code = pdfi_annot_rect_path(ctx, &rect);
420
421
76
 exit:
422
76
    return code;
423
76
}
424
425
/* Adjust rectangle by specified width */
426
static void pdfi_annot_rect_adjust(pdf_context *ctx, gs_rect *rect, double width)
427
1.57k
{
428
1.57k
    rect->p.x += width;
429
1.57k
    rect->p.y += width;
430
1.57k
    rect->q.x -= width;
431
1.57k
    rect->q.y -= width;
432
1.57k
}
433
434
/* Fill Rect with current color */
435
static int pdfi_annot_fillRect(pdf_context *ctx, pdf_dict *annot)
436
45
{
437
45
    int code;
438
45
    gs_rect rect;
439
440
45
    code = pdfi_gsave(ctx);
441
45
    if (code < 0) return code;
442
443
45
    code = pdfi_annot_Rect(ctx, annot, &rect);
444
45
    if (code < 0) goto exit;
445
446
45
    code = gs_rectclip(ctx->pgs, &rect, 1);
447
45
    if (code < 0) goto exit;
448
449
45
    code = pdfi_annot_applyRD(ctx, annot, &rect);
450
45
    if (code < 0) goto exit;
451
452
45
    code = gs_rectfill(ctx->pgs, &rect, 1);
453
45
    if (code < 0) goto exit;
454
455
45
 exit:
456
45
    (void)pdfi_grestore(ctx);
457
45
    return code;
458
45
}
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
3.40k
{
463
3.40k
    int code = 0;
464
3.40k
    gs_rect rect;
465
466
3.40k
    if (width <= 0)
467
1.83k
        return 0;
468
469
1.57k
    code = pdfi_gsave(ctx);
470
471
1.57k
    code = pdfi_setdash_impl(ctx, dash, 0);
472
1.57k
    if (code < 0) goto exit;
473
474
1.57k
    code = gs_setlinewidth(ctx->pgs, width);
475
1.57k
    if (code < 0) goto exit;
476
477
1.57k
    code = pdfi_annot_Rect(ctx, annot, &rect);
478
1.57k
    if (code < 0) goto exit;
479
480
1.57k
    code = pdfi_annot_applyRD(ctx, annot, &rect);
481
1.57k
    if (code < 0) goto exit;
482
483
484
    /* Stroke the rectangle */
485
    /* Adjust rectangle by the width */
486
1.57k
    pdfi_annot_rect_adjust(ctx, &rect, width/2);
487
1.57k
    code = gs_rectstroke(ctx->pgs, &rect, 1, NULL);
488
489
1.57k
 exit:
490
1.57k
    (void)pdfi_grestore(ctx);
491
1.57k
    return code;
492
1.57k
}
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
3.43k
{
499
3.43k
    pdf_array *dash = NULL;
500
3.43k
    int code = 0;
501
3.43k
    uint64_t size = 0;
502
3.43k
    double width = 0;
503
504
3.43k
    if (Border)
505
3.39k
        size = pdfi_array_size(Border);
506
3.43k
    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
3.43k
    if (!Border) {
511
40
        code = pdfi_array_alloc(ctx, 0, &dash);
512
40
        if (code < 0) goto exit;
513
40
        pdfi_countup(dash);
514
40
        width = 1;
515
3.39k
    } else {
516
3.39k
        if (size > 3) {
517
0
            code = pdfi_array_get_type(ctx, Border, 3, PDF_ARRAY, (pdf_obj **)&dash);
518
0
            if (code < 0) {
519
0
                if ((code = pdfi_set_warning_stop(ctx, code, NULL, W_PDF_ANNOT_ERROR,
520
0
                                 "pdfi_annot_draw_Border", "WARNING: Annotation Border Dash array invalid")) < 0) {
521
0
                    goto exit;
522
0
                }
523
0
                code = pdfi_array_alloc(ctx, 0, &dash);
524
0
                if (code < 0) goto exit;
525
0
                pdfi_countup(dash);
526
0
            }
527
3.39k
        } else {
528
3.39k
            code = pdfi_array_alloc(ctx, 0, &dash);
529
3.39k
            if (code < 0) goto exit;
530
3.39k
            pdfi_countup(dash);
531
3.39k
        }
532
3.39k
        code = pdfi_array_get_number(ctx, Border, 2, &width);
533
3.39k
        if (code < 0) goto exit;
534
3.39k
    }
535
536
    /* At this point we have a dash array (which could be length 0) and a width */
537
3.43k
    if (usepath)
538
191
        code = pdfi_annot_strokeborderpath(ctx, annot, width, dash);
539
3.24k
    else
540
3.24k
        code = pdfi_annot_strokeborder(ctx, annot, width, dash);
541
542
3.43k
 exit:
543
3.43k
    pdfi_countdown(dash);
544
3.43k
    return code;
545
3.43k
}
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.01k
{
550
2.01k
    double W;
551
2.01k
    int code = 0;
552
2.01k
    pdf_name *S = NULL;
553
2.01k
    pdf_array *dash = NULL;
554
555
    /* Get the width */
556
2.01k
    code = pdfi_dict_knownget_number(ctx, BS, "W", &W);
557
2.01k
    if (code < 0) goto exit;
558
2.01k
    if (code == 0)
559
7
        W = 1; /* Default */
560
561
    /* TODO: Some junk about scaling to UserUnit */
562
    /* ... */
563
564
    /* Lookup border style */
565
2.01k
    code = pdfi_dict_knownget_type(ctx, BS, "S", PDF_NAME, (pdf_obj **)&S);
566
2.01k
    if (code < 0) goto exit;
567
568
2.01k
    if (code > 0 && pdfi_name_is(S, "D")) {
569
        /* Handle Dash array */
570
9
        code = pdfi_dict_knownget_type(ctx, BS, "D", PDF_ARRAY, (pdf_obj **)&dash);
571
9
        if (code < 0) goto exit;
572
573
        /* If there is no Dash array, then create one containing a 3 (the default) */
574
9
        if (code == 0) {
575
9
            code = pdfi_array_alloc(ctx, 1, &dash);
576
9
            if (code < 0) goto exit;
577
9
            pdfi_countup(dash);
578
579
9
            code = pdfi_array_put_int(ctx, dash, 0, 3);
580
9
            if (code < 0) goto exit;
581
9
        }
582
2.00k
    } else {
583
        /* Empty array */
584
2.00k
        code = pdfi_array_alloc(ctx, 0, &dash);
585
2.00k
        if (code < 0) goto exit;
586
2.00k
        pdfi_countup(dash);
587
2.00k
    }
588
589
    /* At this point we have a dash array (which could be length 0) and a width */
590
2.01k
    if (usepath)
591
1.85k
        code = pdfi_annot_strokeborderpath(ctx, annot, W, dash);
592
153
    else
593
153
        code = pdfi_annot_strokeborder(ctx, annot, W, dash);
594
595
2.01k
 exit:
596
2.01k
    pdfi_countdown(S);
597
2.01k
    pdfi_countdown(dash);
598
2.01k
    return code;
599
2.01k
}
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
5.45k
{
612
5.45k
    int code, code1;
613
5.45k
    pdf_dict *BS = NULL;
614
5.45k
    pdf_array *Border = NULL;
615
616
5.45k
    code = pdfi_dict_knownget_type(ctx, annot, "BS", PDF_DICT, (pdf_obj **)&BS);
617
5.45k
    if (code < 0) goto exit;
618
5.45k
    code = pdfi_dict_knownget_type(ctx, annot, "Border", PDF_ARRAY, (pdf_obj **)&Border);
619
5.45k
    if (code < 0) goto exit;
620
621
5.45k
    code = pdfi_gsave(ctx);
622
5.45k
    if (code < 0) goto exit;
623
624
5.45k
    if (BS) {
625
2.01k
        code = pdfi_annot_draw_BS(ctx, annot, BS, usepath);
626
3.43k
    } else {
627
        /* Note: Border can be null */
628
3.43k
        code = pdfi_annot_draw_Border(ctx, annot, Border, usepath);
629
3.43k
    }
630
5.45k
    code1 = pdfi_grestore(ctx);
631
5.45k
    if (code == 0) code = code1;
632
633
5.45k
 exit:
634
5.45k
    pdfi_countdown(BS);
635
5.45k
    pdfi_countdown(Border);
636
5.45k
    return code;
637
5.45k
}
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
399
{
645
399
    int code = 0;
646
647
399
    if (font != NULL) {
648
399
        code = pdfi_font_set_internal_string(ctx, font, size);
649
399
        if (code < 0) goto exit;
650
399
    }
651
652
399
 exit:
653
399
    return code;
654
399
}
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
73.6k
{
663
73.6k
    int code = 0;
664
73.6k
    pdf_dict *Parent = NULL;
665
73.6k
    bool known = false;
666
667
    /* Check this field */
668
73.6k
    code = pdfi_dict_knownget_type(ctx, field, Key, type, o);
669
73.6k
    if (code != 0) goto exit1;
670
671
26.9k
    code = pdfi_loop_detector_mark(ctx);
672
26.9k
    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
26.9k
    code = pdfi_dict_known(ctx, field, "Parent", &known);
679
26.9k
    if (code >= 0 && known == true)
680
18.5k
    {
681
18.5k
        code = pdfi_dict_get_no_store_R(ctx, field, "Parent", (pdf_obj **)&Parent);
682
18.5k
        if (code < 0)
683
4.13k
            goto exit;
684
685
14.4k
        if (pdfi_type_of(Parent) != PDF_DICT) {
686
238
            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
238
            } else {
693
238
                code = gs_note_error(gs_error_typecheck);
694
238
                goto exit;
695
238
            }
696
238
        }
697
14.1k
        code = pdfi_form_get_inheritable(ctx, Parent, Key, type, o);
698
14.1k
        if (code <= 0) {
699
14.1k
            if (ctx->AcroForm)
700
14.0k
                code = pdfi_dict_knownget_type(ctx, ctx->AcroForm, Key, type, o);
701
14.1k
        }
702
14.1k
    } else {
703
        /* No Parent, so check AcroForm, if any */
704
8.39k
        if (ctx->AcroForm)
705
8.01k
            code = pdfi_dict_knownget_type(ctx, ctx->AcroForm, Key, type, o);
706
8.39k
    }
707
708
26.9k
exit:
709
26.9k
    (void)pdfi_loop_detector_cleartomark(ctx);
710
711
73.6k
exit1:
712
73.6k
    pdfi_countdown(Parent);
713
73.6k
    return code;
714
26.9k
}
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
43.4k
{
722
43.4k
    int code = 0;
723
43.4k
    pdf_num *num = NULL;
724
725
43.4k
    *val = 0;
726
43.4k
    code = pdfi_form_get_inheritable(ctx, field, Key, PDF_INT, (pdf_obj **)&num);
727
43.4k
    if (code < 0) goto exit;
728
729
39.7k
    if (code > 0)
730
30.7k
        *val = num->value.i;
731
732
43.4k
 exit:
733
43.4k
    pdfi_countdown(num);
734
43.4k
    return code;
735
39.7k
}
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
15.9k
{
740
15.9k
    char *token, *prev_token;
741
15.9k
    char *parse_str = NULL;
742
15.9k
    bool did_mod = false;
743
15.9k
    int code = 0;
744
15.9k
    double size;
745
15.9k
    char size_str[20];
746
15.9k
    char *last;
747
15.9k
    pdf_string *newDA = NULL;
748
749
    /* Make a copy of the string because we are going to destructively parse it */
750
15.9k
    parse_str = (char *)gs_alloc_bytes(ctx->memory, (size_t)DA->length+1, "pdfi_annot_display_text(strbuf)");
751
15.9k
    if (parse_str == NULL) {
752
0
        code = gs_note_error(gs_error_VMerror);
753
0
        goto exit;
754
0
    }
755
15.9k
    memcpy(parse_str, DA->data, DA->length);
756
15.9k
    parse_str[DA->length] = 0; /* Null terminate */
757
758
    /* find the 'Tf' token, if any */
759
15.9k
    token = gs_strtok(parse_str, " ", &last);
760
15.9k
    prev_token = NULL;
761
47.8k
    while (token != NULL) {
762
47.8k
        if (!strcmp(token, "Tf"))
763
15.8k
            break;
764
31.9k
        prev_token = token;
765
31.9k
        token = gs_strtok(NULL, " ", &last);
766
31.9k
    }
767
768
    /* See if we found it */
769
15.9k
    if (!token)
770
34
        goto exit;
771
772
    /* See if there was a prev_token and it was "0" */
773
15.8k
    if (!(prev_token && !strcmp(prev_token, "0")))
774
15.8k
        goto exit;
775
776
    /* Case with '<font> 0 Tf', need to calculate correct size */
777
17
    size = (rect->q.y - rect->p.y) * .75; /* empirical from gs code make_tx_da */
778
779
17
    snprintf(size_str, sizeof(size_str), "%g ", size);
780
781
    /* Create a new DA and reassemble the old DA into it */
782
17
    code = pdfi_object_alloc(ctx, PDF_STRING, (size_t)DA->length+strlen(size_str)+1, (pdf_obj **)&newDA);
783
17
    if (code < 0)
784
0
        goto exit;
785
17
    pdfi_countup(newDA);
786
787
17
    strncpy((char *)newDA->data, (char *)DA->data, prev_token-parse_str);
788
17
    strncpy((char *)newDA->data + (prev_token-parse_str), size_str, strlen(size_str)+1);
789
17
    strncpy((char *)newDA->data + strlen((char *)newDA->data), (char *)DA->data + (token - parse_str),
790
17
            DA->length-(token-parse_str));
791
17
    newDA->length = strlen((char *)newDA->data);
792
17
    did_mod = true;
793
794
15.9k
 exit:
795
    /* If didn't need to mod it, just copy the original and get a ref */
796
15.9k
    if (did_mod) {
797
17
        *mod_DA = newDA;
798
15.8k
    } else {
799
15.8k
        *mod_DA = DA;
800
15.8k
        pdfi_countup(DA);
801
15.8k
    }
802
803
15.9k
    if (parse_str)
804
15.9k
        gs_free_object(ctx->memory, parse_str, "pdfi_form_modDA(parse_str)");
805
806
15.9k
    return code;
807
17
}
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
16.0k
{
821
16.0k
    int code = 0;
822
16.0k
    pdf_string *DA = NULL;
823
16.0k
    pdf_string *mod_DA = NULL;
824
16.0k
    pdf_dict *resource_dict = annot;  /* dict to use for resources, alias no need to refcnt */
825
16.0k
    pdf_dict *DR = NULL;
826
16.0k
    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
16.0k
    if (!page_dict)
831
74
        page_dict = ctx->page.CurrentPageDict;
832
833
16.0k
    if (is_form) {
834
15.9k
        code = pdfi_dict_known(ctx, annot, "DR", &known);
835
15.9k
        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
15.9k
        if (!known) {
840
15.9k
            code = pdfi_dict_known(ctx, annot, "Parent", &known);
841
15.9k
            if (code < 0) goto exit;
842
15.9k
            if (!known && ctx->AcroForm != NULL)
843
1.10k
                resource_dict = ctx->AcroForm;
844
15.9k
        }
845
15.9k
        code = pdfi_form_get_inheritable(ctx, annot, "DA", PDF_STRING, (pdf_obj **)&DA);
846
15.9k
    } else {
847
74
        code = pdfi_dict_knownget_type(ctx, annot, "DA", PDF_STRING, (pdf_obj **)&DA);
848
74
    }
849
16.0k
    if (code < 0) goto exit;
850
15.9k
    if (code > 0) {
851
15.9k
        if (is_form) {
852
15.9k
            code = pdfi_form_modDA(ctx, DA, &mod_DA, rect);
853
15.9k
            if (code < 0) goto exit;
854
15.9k
        } else {
855
70
            mod_DA = DA;
856
70
            pdfi_countup(mod_DA);
857
70
        }
858
859
15.9k
        code = pdfi_interpret_inner_content_string(ctx, mod_DA, resource_dict,
860
15.9k
                                                   page_dict, false, "DA");
861
15.9k
        if (code < 0) goto exit;
862
        /* If no font got set, set one */
863
15.9k
        if (pdfi_get_current_pdf_font(ctx) == NULL) {
864
79
            code = pdfi_annot_set_font(ctx, "Helvetica", 12.0);
865
79
            if (code < 0) goto exit;
866
79
        }
867
15.9k
    } else {
868
12
        code = pdfi_gs_setgray(ctx, 0);
869
12
        if (code < 0) goto exit;
870
12
        code = pdfi_annot_set_font(ctx, "Helvetica", 12.0);
871
12
        if (code < 0) goto exit;
872
12
    }
873
874
16.0k
 exit:
875
16.0k
    pdfi_countdown(DR);
876
16.0k
    pdfi_countdown(DA);
877
16.0k
    pdfi_countdown(mod_DA);
878
16.0k
    return code;
879
15.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.5k
{
886
26.5k
    int i;
887
26.5k
    char *ptr;
888
889
26.5k
    i = 0;
890
    /* skip over BOM if it's there */
891
26.5k
    if (IS_UTF16(inbuf)) {
892
0
        i += 2; /* UTF-16 */
893
26.5k
    } else if (IS_UTF16(inbuf)) {
894
0
        i += 3; /* UTF-8 */
895
0
    }
896
897
26.5k
    ptr = outbuf;
898
26.5k
    *ptr++ = '<';
899
55.2k
    for ( ; i<len; i++) {
900
28.6k
        snprintf(ptr, 3, "%02X", *(inbuf+i));
901
28.6k
        ptr += 2;
902
28.6k
    }
903
904
26.5k
    *ptr++ = '>';
905
26.5k
    *ptr = 0;
906
907
26.5k
    return ptr;
908
26.5k
}
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.6k
{
914
24.6k
    char *strbuf = NULL;
915
24.6k
    size_t buflen = 50 + text->length*2; /* 50 to account for formatting, plus the text itself */
916
24.6k
    int code = 0;
917
24.6k
    char *ptr;
918
919
24.6k
    strbuf = (char *)gs_alloc_bytes(ctx->memory, buflen, "pdfi_annot_display_text(strbuf)");
920
24.6k
    if (strbuf == NULL)
921
0
        return_error(gs_error_VMerror);
922
24.6k
    ptr = pdfi_get_hexstring(ctx, strbuf, text->data, text->length);
923
24.6k
    strncpy(ptr, " Tj", buflen-strlen(strbuf));
924
925
24.6k
    code = pdfi_interpret_inner_content_c_string(ctx, strbuf, annot,
926
24.6k
                                               ctx->page.CurrentPageDict, false, "Annot text Tj");
927
24.6k
    if (code < 0) goto exit;
928
929
24.6k
 exit:
930
24.6k
    if (strbuf)
931
24.6k
        gs_free_object(ctx->memory, strbuf, "pdfi_annot_display_text(strbuf)");
932
24.6k
    return code;
933
24.6k
}
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
1.95k
{
939
1.95k
    char *strbuf = NULL;
940
1.95k
    size_t buflen = 50 + text->length*2; /* 50 to account for formatting, plus the text itself */
941
1.95k
    int code = 0;
942
1.95k
    char *ptr;
943
944
1.95k
    strbuf = (char *)gs_alloc_bytes(ctx->memory, buflen, "pdfi_annot_display_text(strbuf)");
945
1.95k
    if (strbuf == NULL)
946
0
        return_error(gs_error_VMerror);
947
1.95k
    snprintf(strbuf, buflen, "%g %g Td ", x, y);
948
1.95k
    ptr = strbuf + strlen(strbuf);
949
1.95k
    ptr = pdfi_get_hexstring(ctx, ptr, text->data, text->length);
950
1.95k
    strncpy(ptr, " Tj", buflen-strlen(strbuf));
951
952
1.95k
    code = pdfi_interpret_inner_content_c_string(ctx, strbuf, annot,
953
1.95k
                                               ctx->page.CurrentPageDict, false, "Annot text Tj");
954
1.95k
    if (code < 0) goto exit;
955
956
1.95k
 exit:
957
1.95k
    if (strbuf)
958
1.95k
        gs_free_object(ctx->memory, strbuf, "pdfi_annot_display_text(strbuf)");
959
1.95k
    return code;
960
1.95k
}
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
410
{
969
410
    int code;
970
410
    pdf_string *temp_string = NULL;
971
410
    gs_rect bbox;
972
410
    gs_point awidth;
973
974
410
    if (ctx->pgs->PDFfontsize == 0) {
975
0
        *height = 0;
976
0
        return 0;
977
0
    }
978
979
410
    code = pdfi_obj_charstr_to_string(ctx, "Hy", &temp_string);
980
410
    if (code < 0)
981
0
        goto exit;
982
983
    /* Find the bbox of the string "Hy" */
984
410
    code = pdfi_string_bbox(ctx, temp_string, &bbox, &awidth, false);
985
410
    if (code < 0)
986
0
        goto exit;
987
988
410
    *height = bbox.q.y - bbox.p.y;
989
990
410
 exit:
991
410
    pdfi_countdown(temp_string);
992
410
    return code;
993
410
}
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
211
{
999
211
    int code = 0;
1000
211
    int code1 = 0;
1001
1002
211
    code = pdfi_BT(ctx);
1003
211
    if (code < 0)
1004
0
        return code;
1005
1006
211
    code = pdfi_annot_display_text(ctx, annot, x, y, text);
1007
211
    code1 = pdfi_ET(ctx);
1008
211
    if (code == 0) code = code1;
1009
1010
211
    return code;
1011
211
}
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
150
{
1017
150
    int code = 0;
1018
150
    int code1 = 0;
1019
150
    gs_rect bbox;
1020
150
    gs_point awidth;
1021
150
    double x, y;
1022
1023
150
    code = pdfi_BT(ctx);
1024
150
    if (code < 0)
1025
0
        return code;
1026
1027
    /* Get width of the string */
1028
150
    code = pdfi_string_bbox(ctx, text, &bbox, &awidth, false);
1029
150
    if (code < 0) goto exit;
1030
1031
    /* Center the title in the box */
1032
150
    x = rect->p.x + ((rect->q.x - rect->p.x) - awidth.x) / 2;
1033
150
    y = rect->q.y - 11;
1034
1035
150
    code = pdfi_annot_display_text(ctx, annot, x, y, text);
1036
150
    if (code < 0) goto exit;
1037
1038
150
 exit:
1039
150
    code1 = pdfi_ET(ctx);
1040
150
    if (code == 0) code = code1;
1041
150
    return code;
1042
150
}
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
217
{
1058
217
    double x;
1059
217
    double lineheight = 0;
1060
217
    double y_start;
1061
217
    double x_start, x_max;
1062
217
    gs_rect bbox;
1063
217
    gs_point awidth; /* Advance width */
1064
217
    int code = 0;
1065
217
    int code1 = 0;
1066
217
    pdf_string *temp_string = NULL;
1067
217
    int i;
1068
217
    byte ch;
1069
217
    bool firstchar = true;
1070
217
    bool linestart = true;
1071
217
    int charlen;
1072
1073
217
    if (is_UTF16)
1074
0
        charlen = 2;
1075
217
    else
1076
217
        charlen = 1;
1077
1078
217
    if (ctx->pgs->PDFfontsize == 0)
1079
0
        return 0;
1080
1081
217
    code = pdfi_BT(ctx);
1082
217
    if (code < 0)
1083
0
        return code;
1084
1085
    /* Allocate a temp string to use, length 1 char */
1086
217
    code = pdfi_object_alloc(ctx, PDF_STRING, charlen, (pdf_obj **)&temp_string);
1087
217
    if (code < 0) goto exit;
1088
217
    pdfi_countup(temp_string);
1089
1090
217
    code = pdfi_annot_get_text_height(ctx, &lineheight);
1091
217
    if (code < 0) goto exit;
1092
1093
217
    y_start = rect->q.y - lineheight;
1094
217
    x_start = rect->p.x;
1095
217
    x_max = rect->q.x;
1096
217
    x = x_start;
1097
1098
27.0k
    for (i=0; i<text->length; i+=charlen) {
1099
26.7k
        int j;
1100
1101
26.7k
        if (linestart) {
1102
770
            x = x_start;
1103
770
        }
1104
1105
53.5k
        for (j = 0; j < charlen; j++) {
1106
26.7k
            ch = text->data[i+j];
1107
26.7k
            temp_string->data[j] = ch;
1108
26.7k
        }
1109
1110
        /* If EOL character encountered, move down to next line */
1111
26.7k
        if (charlen == 1) { /* Can only check this for ASCII font */
1112
26.7k
            if (ch == '\r' || ch == '\n') {
1113
553
                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
553
                linestart = true;
1121
553
                continue;
1122
553
            }
1123
26.7k
        }
1124
1125
        /* get size of the character */
1126
26.2k
        code = pdfi_string_bbox(ctx, temp_string, &bbox, &awidth, false);
1127
26.2k
        if (code < 0) goto exit;
1128
1129
26.2k
        if (!linestart && ((x + awidth.x) > x_max)) {
1130
819
            x = x_start;
1131
819
            linestart = true;
1132
819
        }
1133
1134
        /* display the character */
1135
26.2k
        if (firstchar) {
1136
217
            code = pdfi_annot_display_text(ctx, annot, x, y_start, temp_string);
1137
217
            firstchar = false;
1138
26.0k
        } else {
1139
26.0k
            if (linestart)
1140
1.37k
                code = pdfi_annot_display_text(ctx, annot, 0, -lineheight, temp_string);
1141
24.6k
            else
1142
24.6k
                code = pdfi_annot_display_nexttext(ctx, annot, temp_string);
1143
26.0k
        }
1144
26.2k
        if (code < 0) goto exit;
1145
26.2k
        x += awidth.x;
1146
26.2k
        linestart = false;
1147
26.2k
    }
1148
1149
217
 exit:
1150
217
    code1 = pdfi_ET(ctx);
1151
217
    if (code == 0) code = code1;
1152
217
    pdfi_countdown(temp_string);
1153
217
    return code;
1154
217
}
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
409
{
1354
409
    int code;
1355
409
    double width;
1356
409
    double seglen;
1357
1358
409
    code = pdfi_annot_get_BS_width(ctx, annot, &width);
1359
409
    if (code < 0) goto exit;
1360
1361
409
    code = pdfi_gsave(ctx);
1362
409
    if (code < 0) goto exit_grestore;
1363
1364
409
    code = gs_setlinejoin(ctx->pgs, 0);
1365
409
    if (code < 0) goto exit_grestore;
1366
409
    code = gs_moveto(ctx->pgs, -width*6, -width*4);
1367
409
    if (code < 0) goto exit_grestore;
1368
409
    code = gs_lineto(ctx->pgs, -width/1.2, 0);
1369
409
    if (code < 0) goto exit_grestore;
1370
409
    code = gs_lineto(ctx->pgs, -width*6, width*4);
1371
409
    if (code < 0) goto exit_grestore;
1372
409
    code = gs_closepath(ctx->pgs);
1373
409
    if (code < 0) goto exit_grestore;
1374
409
    code = pdfi_annot_draw_border(ctx, annot, true);
1375
409
    if (code < 0) goto exit_grestore;
1376
1377
409
    code = pdfi_grestore(ctx);
1378
409
    if (code < 0) goto exit;
1379
1380
409
    code = gs_translate(ctx->pgs, -1.3*width, 0);
1381
409
    if (code < 0) goto exit;
1382
409
    seglen = width / 2;
1383
409
    code = gs_moveto(ctx->pgs, -seglen*8.4, -seglen*5.9);
1384
409
    if (code < 0) goto exit;
1385
409
    code = gs_lineto(ctx->pgs, -seglen/1.2, 0);
1386
409
    if (code < 0) goto exit;
1387
409
    code = gs_lineto(ctx->pgs, -seglen*8.4, seglen*5.9);
1388
409
    if (code < 0) goto exit;
1389
409
    code = gs_closepath(ctx->pgs);
1390
409
    if (code < 0) goto exit;
1391
409
    code = pdfi_annot_opacity(ctx, annot);
1392
409
    if (code < 0) goto exit;
1393
409
    code = pdfi_annot_fillborderpath(ctx, annot);
1394
409
    goto exit;
1395
1396
0
 exit_grestore:
1397
0
    (void)pdfi_grestore(ctx);
1398
409
 exit:
1399
409
    return code;
1400
0
}
1401
1402
/* Draw OpenArrow LE */
1403
static int pdfi_annot_draw_LE_OpenArrow(pdf_context *ctx, pdf_dict *annot)
1404
0
{
1405
0
    int code;
1406
0
    double width;
1407
1408
0
    code = pdfi_annot_get_BS_width(ctx, annot, &width);
1409
0
    if (code < 0) goto exit;
1410
1411
0
    code = gs_setlinejoin(ctx->pgs, 0);
1412
0
    if (code < 0) goto exit;
1413
1414
0
    code = gs_moveto(ctx->pgs, -width*6, -width*4);
1415
0
    if (code < 0) goto exit;
1416
0
    code = gs_lineto(ctx->pgs, -width/1.2, 0);
1417
0
    if (code < 0) goto exit;
1418
0
    code = gs_lineto(ctx->pgs, -width*6, width*4);
1419
0
    if (code < 0) goto exit;
1420
0
    code = pdfi_annot_draw_border(ctx, annot, true);
1421
0
    if (code < 0) goto exit;
1422
1423
0
 exit:
1424
0
    return code;
1425
0
}
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.34k
{
1458
1.34k
    return 0;
1459
1.34k
}
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
1.78k
{
1479
1.78k
    int code;
1480
1.78k
    int code1;
1481
1.78k
    annot_LE_dispatch_t *dispatch_ptr;
1482
1483
1.78k
    code = pdfi_gsave(ctx);
1484
1.78k
    if (code < 0) goto exit1;
1485
1486
1.78k
    code = gs_translate(ctx->pgs, x, y);
1487
1.78k
    code = gs_moveto(ctx->pgs, 0, 0);
1488
1.78k
    code = gs_rotate(ctx->pgs, angle);
1489
1490
    /* Draw the LE */
1491
16.2k
    for (dispatch_ptr = annot_LE_dispatch; dispatch_ptr->name; dispatch_ptr ++) {
1492
16.2k
        if (pdfi_name_is(LE, dispatch_ptr->name)) {
1493
1.75k
            code = dispatch_ptr->func(ctx, annot);
1494
1.75k
            break;
1495
1.75k
        }
1496
16.2k
    }
1497
1.78k
    if (!dispatch_ptr->name) {
1498
33
        char str[100];
1499
33
        memcpy(str, (const char *)LE->data, LE->length < 100 ? LE->length : 99);
1500
33
        str[LE->length < 100 ? LE->length : 99] = '\0';
1501
33
        dbgmprintf1(ctx->memory, "ANNOT: WARNING No handler for LE %s\n", str);
1502
33
    }
1503
1504
1.78k
 exit1:
1505
1.78k
    code1 = pdfi_grestore(ctx);
1506
1.78k
    if (code < 0)
1507
4
        code = code1;
1508
1.78k
    return code;
1509
1.78k
}
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
1.78k
{
1521
1.78k
    pdf_obj *LE = NULL;
1522
1.78k
    pdf_name *LE1 = NULL;
1523
1.78k
    pdf_name *LE2 = NULL;
1524
1.78k
    double dx, dy;
1525
1.78k
    double angle;
1526
1.78k
    int code;
1527
1.78k
    pdf_obj_type type;
1528
1529
1.78k
    code = pdfi_dict_knownget(ctx, annot, "LE", (pdf_obj **)&LE);
1530
1.78k
    if (code <= 0)
1531
870
        goto exit;
1532
910
    type = pdfi_type_of(LE);
1533
910
    if (type != PDF_ARRAY && type != PDF_NAME) {
1534
0
        code = gs_note_error(gs_error_typecheck);
1535
0
        goto exit;
1536
0
    }
1537
1538
910
    dx = x2 - x1;
1539
910
    dy = y2 - y1;
1540
910
    code = gs_atan2_degrees(dy, dx, &angle);
1541
910
    if (code < 0)
1542
0
        angle = 0;
1543
1544
910
    if (type == PDF_ARRAY) {
1545
910
        code = pdfi_array_get_type(ctx, (pdf_array *)LE, 0, PDF_NAME, (pdf_obj **)&LE1);
1546
910
        if (code < 0) goto exit;
1547
1548
910
        code = pdfi_array_get_type(ctx, (pdf_array *)LE, 1, PDF_NAME, (pdf_obj **)&LE2);
1549
910
        if (code < 0) goto exit;
1550
910
    } else {
1551
0
        LE1 = (pdf_name *)LE;
1552
0
        LE = NULL;
1553
0
    }
1554
903
    if (LE1 && (!which || which == 1)) {
1555
892
        code = pdfi_annot_draw_LE_one(ctx, annot, LE1, x1, y1, angle+180);
1556
892
        if (code < 0) goto exit;
1557
892
    }
1558
1559
903
    if (LE2 && (!which || which == 2)) {
1560
892
        code = pdfi_annot_draw_LE_one(ctx, annot, LE2, x2, y2, angle);
1561
892
        if (code < 0) goto exit;
1562
892
    }
1563
1564
1.78k
 exit:
1565
1.78k
    pdfi_countdown(LE);
1566
1.78k
    pdfi_countdown(LE1);
1567
1.78k
    pdfi_countdown(LE2);
1568
1.78k
    return code;
1569
903
}
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
232k
{
1578
232k
    int code;
1579
232k
    pdf_dict *AP_dict = NULL;
1580
232k
    pdf_stream *AP = NULL;
1581
232k
    pdf_obj *baseAP = NULL;
1582
232k
    pdf_name *AS = NULL;
1583
1584
232k
    *NormAP = NULL;
1585
1586
232k
    code = pdfi_dict_knownget_type(ctx, annot, "AP", PDF_DICT, (pdf_obj **)&AP_dict);
1587
232k
    if (code <= 0) goto exit;
1588
1589
195k
    code = pdfi_dict_knownget(ctx, AP_dict, "N", (pdf_obj **)&baseAP);
1590
195k
    if (code < 0) goto exit;
1591
1592
    /* Look for /R and /D if there was no /N */
1593
150k
    if (code == 0) {
1594
47
        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
47
        code = pdfi_dict_knownget(ctx, AP_dict, "R", (pdf_obj **)&baseAP);
1598
47
        if (code < 0) goto exit;
1599
1600
47
        if (code == 0) {
1601
46
            code = pdfi_dict_knownget(ctx, AP_dict, "D", (pdf_obj **)&baseAP);
1602
46
            if (code < 0) goto exit;
1603
46
        }
1604
47
    }
1605
1606
    /* Nothing found */
1607
150k
    if (code == 0) goto exit;
1608
1609
150k
    switch (pdfi_type_of(baseAP)) {
1610
120k
        case PDF_STREAM:
1611
            /* Use baseAP for the AP */
1612
120k
            AP = (pdf_stream *)baseAP;
1613
120k
            baseAP = NULL;
1614
120k
            break;
1615
29.5k
        case PDF_DICT:
1616
29.5k
            code = pdfi_dict_knownget_type(ctx, annot, "AS", PDF_NAME, (pdf_obj **)&AS);
1617
29.5k
            if (code < 0) goto exit;
1618
29.5k
            if (code == 0) {
1619
469
                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
469
                goto exit;
1621
469
            }
1622
1623
            /* Lookup the AS in the NormAP and use that as the AP */
1624
29.1k
            code = pdfi_dict_get_by_key(ctx, (pdf_dict *)baseAP, AS, (pdf_obj **)&AP);
1625
29.1k
            if (code < 0) {
1626
                /* Apparently this is not an error, just silently don't have an AP */
1627
8.38k
                *NormAP = (pdf_obj *)TOKEN_null;
1628
8.38k
                code = 0;
1629
8.38k
                goto exit;
1630
8.38k
            }
1631
20.7k
            if (pdfi_type_of(AP) != PDF_STREAM) {
1632
75
                code = gs_note_error(gs_error_typecheck);
1633
75
                goto exit;
1634
75
            }
1635
20.6k
            break;
1636
20.6k
        default:
1637
120
            code = gs_error_typecheck;
1638
120
            goto exit;
1639
150k
    }
1640
1641
141k
   *NormAP = (pdf_obj *)AP;
1642
141k
   pdfi_countup(AP);
1643
1644
232k
 exit:
1645
232k
    pdfi_countdown(AP_dict);
1646
232k
    pdfi_countdown(AP);
1647
232k
    pdfi_countdown(AS);
1648
232k
    pdfi_countdown(baseAP);
1649
232k
    return code;
1650
141k
}
1651
1652
static int pdfi_annot_draw_Link(pdf_context *ctx, pdf_dict *annot, pdf_obj *NormAP, bool *render_done)
1653
3.28k
{
1654
3.28k
    int code;
1655
3.28k
    int code1;
1656
3.28k
    bool drawit;
1657
1658
3.28k
    dbgmprintf(ctx->memory, "ANNOT: Drawing Link\n");
1659
1660
3.28k
    code = pdfi_annot_start_transparency(ctx, annot);
1661
3.28k
    if (code < 0)
1662
0
        return code;
1663
1664
3.28k
    code = pdfi_annot_setcolor(ctx, annot, true, &drawit);
1665
3.28k
    if (code < 0) goto exit;
1666
3.28k
    if (!drawit) goto exit;
1667
1668
3.28k
    code = pdfi_annot_draw_border(ctx, annot, false);
1669
3.28k
    if (code < 0) goto exit;
1670
1671
3.28k
    code = pdfi_annot_draw_AP(ctx, annot, NormAP);
1672
1673
3.28k
 exit:
1674
3.28k
    code1 = pdfi_annot_end_transparency(ctx, annot);
1675
3.28k
    if (code == 0) code = code1;
1676
1677
3.28k
    *render_done = true;
1678
3.28k
    return code;
1679
3.28k
}
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
577
{
1693
577
    int code = 0;
1694
577
    pdf_array *points = NULL;
1695
577
    int i;
1696
577
    int num_points;
1697
577
    double x1, y1, x2, y2;
1698
1699
1.08k
    for (i=0; i<pdfi_array_size(InkList); i++) {
1700
577
        int j;
1701
1702
577
        code = pdfi_array_get_type(ctx, InkList, i, PDF_ARRAY, (pdf_obj **)&points);
1703
577
        if (code < 0)
1704
0
            goto exit;
1705
1706
577
        num_points = pdfi_array_size(points);
1707
577
        if (num_points < 2)
1708
0
            goto exit;
1709
1710
577
        code = pdfi_array_get_number(ctx, points, 0, &x1);
1711
577
        if (code < 0) goto exit;
1712
577
        code = pdfi_array_get_number(ctx, points, 1, &y1);
1713
577
        if (code < 0) goto exit;
1714
576
        code = gs_moveto(ctx->pgs, x1, y1);
1715
576
        if (code < 0) goto exit;
1716
576
        if (num_points == 2)
1717
0
            goto stroke;
1718
1719
20.0k
        for (j = 2; j < num_points; j += 2) {
1720
19.4k
            code = pdfi_array_get_number(ctx, points, j, &x2);
1721
19.4k
            if (code < 0) goto exit;
1722
19.4k
            code = pdfi_array_get_number(ctx, points, j+1, &y2);
1723
19.4k
            if (code < 0) goto exit;
1724
19.4k
            code = gs_lineto(ctx->pgs, x2, y2);
1725
19.4k
            if (code < 0) goto exit;
1726
19.4k
        }
1727
1728
506
    stroke:
1729
506
        code = gs_stroke(ctx->pgs);
1730
506
        if (code < 0) goto exit;
1731
506
        pdfi_countdown(points);
1732
506
        points = NULL;
1733
506
    }
1734
1735
577
 exit:
1736
577
    pdfi_countdown(points);
1737
577
    return code;
1738
577
}
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
594
{
1798
594
    int code = 0;
1799
594
    int code1 = 0;
1800
594
    bool drawit;
1801
594
    pdf_array *array = NULL;
1802
1803
594
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
1804
594
    if (code <0 || !drawit)
1805
10
        goto exit1;
1806
1807
584
    code = pdfi_annot_start_transparency(ctx, annot);
1808
584
    if (code < 0) goto exit1;
1809
1810
584
    code = gs_setlinewidth(ctx->pgs, 1);
1811
584
    if (code < 0) goto exit;
1812
584
    code = gs_setlinecap(ctx->pgs, 1);
1813
584
    if (code < 0) goto exit;
1814
584
    code = gs_setlinejoin(ctx->pgs, 1);
1815
584
    if (code < 0) goto exit;
1816
1817
584
    code = pdfi_dict_knownget_type(ctx, annot, "InkList", PDF_ARRAY, (pdf_obj **)&array);
1818
584
    if (code < 0) goto exit;
1819
584
    if (code > 0) {
1820
577
        code = pdfi_annot_draw_InkList(ctx, annot, array);
1821
577
        goto exit;
1822
577
    }
1823
7
    code = pdfi_dict_knownget_type(ctx, annot, "Path", PDF_ARRAY, (pdf_obj **)&array);
1824
7
    if (code < 0) goto exit;
1825
7
    if (code > 0) {
1826
0
        code = pdfi_annot_draw_Path(ctx, annot, array);
1827
0
        goto exit;
1828
0
    }
1829
1830
584
 exit:
1831
584
    code1 = pdfi_annot_end_transparency(ctx, annot);
1832
584
    if (code >= 0)
1833
513
        code = code1;
1834
594
 exit1:
1835
594
    pdfi_countdown(array);
1836
594
    *render_done = true;
1837
594
    return code;
1838
584
}
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
213
{
1860
213
    int code = 0;
1861
213
    double magic = .55228475 - .00045; /* Magic value */
1862
213
    double xrad = width / 2;
1863
213
    double yrad = height / 2;
1864
213
    double xmag = xrad * magic;
1865
213
    double ymag = yrad * magic;
1866
1867
213
    code = gs_moveto(ctx->pgs, -xrad, 0);
1868
213
    if (code < 0) return code;
1869
213
    code = gs_curveto(ctx->pgs, -xrad, ymag, -xmag, yrad, 0, yrad);
1870
213
    if (code < 0) return code;
1871
213
    code = gs_curveto(ctx->pgs, xmag, yrad, xrad, ymag, xrad, 0);
1872
213
    if (code < 0) return code;
1873
213
    code = gs_curveto(ctx->pgs, xrad, -ymag, xmag, -yrad, 0, -yrad);
1874
213
    if (code < 0) return code;
1875
213
    code = gs_curveto(ctx->pgs, -xmag, -yrad, -xrad, -ymag, -xrad, 0);
1876
1877
213
    return code;
1878
213
}
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
213
{
1886
213
    int code = 0;
1887
213
    int code1 = 0;
1888
213
    gs_rect rect;
1889
213
    bool drawit;
1890
213
    double width, height;
1891
1892
213
    code = pdfi_annot_start_transparency(ctx, annot);
1893
213
    if (code < 0) goto exit1;
1894
1895
213
    code = pdfi_annot_Rect(ctx, annot, &rect);
1896
213
    if (code < 0) goto exit;
1897
1898
213
    code = pdfi_annot_applyRD(ctx, annot, &rect);
1899
213
    if (code < 0) goto exit;
1900
1901
    /* Translate to the center of the ellipse */
1902
213
    width = rect.q.x - rect.p.x;
1903
213
    height = rect.q.y - rect.p.y;
1904
213
    code = gs_translate(ctx->pgs, rect.p.x + width/2, rect.p.y + height/2);
1905
213
    if (code < 0) goto exit;
1906
1907
    /* Draw the ellipse */
1908
213
    code = pdfi_annot_drawellipse(ctx, width, height);
1909
213
    if (code < 0) goto exit;
1910
1911
213
    code = pdfi_annot_fillborderpath(ctx, annot);
1912
213
    if (code < 0) goto exit;
1913
1914
213
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
1915
213
    if (code < 0) goto exit;
1916
1917
213
    if (drawit) {
1918
207
        code = pdfi_annot_draw_border(ctx, annot, true);
1919
207
        if (code < 0) goto exit;
1920
207
    }
1921
1922
213
 exit:
1923
213
    code1 = pdfi_annot_end_transparency(ctx, annot);
1924
213
    if (code >= 0)
1925
213
        code = code1;
1926
213
 exit1:
1927
213
    *render_done = true;
1928
213
    return code;
1929
213
}
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
46
{
2073
46
    int code = 0;
2074
46
    int code1 = 0;
2075
46
    gs_rect rect;
2076
46
    double width, height;
2077
46
    pdfi_annot_stamp_type_t *stamp_type;
2078
46
    pdf_name *Name = NULL;
2079
46
    double xscale, yscale;
2080
46
    double angle;
2081
46
    int i;
2082
2083
46
    code = pdfi_annot_start_transparency(ctx, annot);
2084
46
    if (code < 0) goto exit1;
2085
2086
46
    code = pdfi_annot_Rect(ctx, annot, &rect);
2087
46
    if (code < 0) goto exit;
2088
2089
36
    code = pdfi_dict_knownget_type(ctx, annot, "Name", PDF_NAME, (pdf_obj **)&Name);
2090
36
    if (code <= 0) goto exit;
2091
2092
    /* Translate to the center of Rect */
2093
36
    width = rect.q.x - rect.p.x;
2094
36
    height = rect.q.y - rect.p.y;
2095
36
    code = gs_translate(ctx->pgs, rect.p.x + width/2, rect.p.y + height/2);
2096
36
    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
36
    yscale = height / 50.;
2103
36
    xscale = width / 190.;
2104
36
    if (xscale < yscale)
2105
20
        yscale = xscale;
2106
36
    if (yscale <= 0.0)
2107
0
        yscale = 1.0;
2108
36
    code = gs_scale(ctx->pgs, yscale, yscale);
2109
36
    if (code < 0) goto exit;
2110
2111
    /* Search through types and find a match, if no match use Draft */
2112
459
    for (stamp_type = pdfi_annot_stamp_types; stamp_type->type; stamp_type ++) {
2113
432
        if (Name && pdfi_name_is(Name, stamp_type->type))
2114
9
            break;
2115
432
    }
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
36
    if (!stamp_type->type) {
2123
27
        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
27
        goto exit;
2125
27
    }
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
46
 exit:
2156
46
    code1 = pdfi_annot_end_transparency(ctx, annot);
2157
46
    if (code >= 0)
2158
36
        code = code1;
2159
46
 exit1:
2160
46
    pdfi_countdown(Name);
2161
46
    *render_done = true;
2162
46
    return code;
2163
46
}
2164
/*********** END /Stamp ***************/
2165
2166
2167
/* Draw Callout Line (CL) */
2168
static int pdfi_annot_draw_CL(pdf_context *ctx, pdf_dict *annot)
2169
74
{
2170
74
    int code;
2171
74
    pdf_array *CL = NULL;
2172
74
    double array[6];
2173
74
    int length;
2174
2175
74
    code = pdfi_dict_knownget_type(ctx, annot, "CL", PDF_ARRAY, (pdf_obj **)&CL);
2176
74
    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
74
 exit:
2207
74
    pdfi_countdown(CL);
2208
74
    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
74
{
2218
74
    int code = 0;
2219
74
    int code1 = 0;
2220
74
    bool drawbackground;
2221
74
    pdf_dict *BS = NULL;
2222
74
    pdf_string *Contents = NULL;
2223
74
    gs_rect annotrect, modrect;
2224
74
    int64_t Rotate;
2225
2226
74
    *render_done = false;
2227
2228
74
    code = pdfi_annot_start_transparency(ctx, annot);
2229
74
    if (code < 0) goto exit1;
2230
2231
74
    code = pdfi_annot_opacity(ctx, annot);
2232
74
    if (code < 0) goto exit;
2233
2234
74
    code = pdfi_annot_Rect(ctx, annot, &annotrect);
2235
74
    if (code < 0) goto exit;
2236
2237
    /* Set the (background?) color if applicable */
2238
74
    code = pdfi_annot_setcolor(ctx, annot, false, &drawbackground);
2239
74
    if (code < 0) goto exit;
2240
2241
    /* Only draw rectangle if a color was specified */
2242
74
    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
74
    code = pdfi_annot_process_DA(ctx, NULL, annot, &annotrect, false);
2255
74
    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
74
#if 1
2260
    /* TODO: Prefer to do it this way! */
2261
74
    code = pdfi_annot_draw_border(ctx, annot, false);
2262
74
    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
74
    code = pdfi_annot_draw_CL(ctx, annot);
2298
74
    if (code < 0) goto exit;
2299
2300
    /* Modify rect by RD if applicable */
2301
74
    code = pdfi_annot_applyRD(ctx, annot, &annotrect);
2302
74
    if (code < 0) goto exit;
2303
2304
    /* /Rotate */
2305
74
    code = pdfi_dict_get_int_def(ctx, annot, "Rotate", &Rotate, 0);
2306
74
    if (code < 0) goto exit;
2307
2308
74
    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
74
    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
1
    case 90:
2333
1
        code = gs_moveto(ctx->pgs, modrect.p.y, modrect.p.x);
2334
1
        if (code < 0) goto exit;
2335
1
        code = gs_rotate(ctx->pgs, 90.0);
2336
1
        modrect.p.x = annotrect.p.y;
2337
1
        modrect.q.x = annotrect.q.y;
2338
1
        modrect.p.y = -annotrect.q.x;
2339
1
        modrect.q.y = -annotrect.p.x;
2340
1
        break;
2341
73
    case 0:
2342
73
    default:
2343
73
        modrect.p.x += 2;
2344
73
        modrect.p.y += 2;
2345
73
        modrect.q.x -= 2;
2346
73
        modrect.q.y -= 2;
2347
2348
        /* Move to initial position (slightly offset from the corner of the rect) */
2349
73
        code = gs_moveto(ctx->pgs, modrect.p.x, modrect.q.y);
2350
73
        if (code < 0) goto exit;
2351
73
        break;
2352
74
    }
2353
2354
    /* /Contents */
2355
74
    code = pdfi_dict_knownget_type(ctx, annot, "Contents", PDF_STRING, (pdf_obj **)&Contents);
2356
74
    if (code < 0) goto exit;
2357
74
    if (code > 0) {
2358
66
        code = pdfi_annot_display_formatted_text(ctx, annot, &modrect, Contents, false);
2359
66
        if (code < 0) goto exit;
2360
66
    }
2361
2362
74
 exit:
2363
74
    code1 = pdfi_annot_end_transparency(ctx, annot);
2364
74
    if (code >= 0)
2365
74
        code = code1;
2366
74
 exit1:
2367
74
    *render_done = true;
2368
74
    pdfi_countdown(BS);
2369
74
    pdfi_countdown(Contents);
2370
74
    return code;
2371
74
}
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
24
{
2382
24
    int code = 0;
2383
24
    int code1 = 0;
2384
24
    gs_rect rect;
2385
2386
24
    code = pdfi_annot_start_transparency(ctx, annot);
2387
24
    if (code < 0) goto exit1;
2388
2389
24
    code = pdfi_annot_Rect(ctx, annot, &rect);
2390
24
    if (code < 0) goto exit;
2391
24
    code = gs_translate(ctx->pgs, rect.p.x, rect.p.y);
2392
24
    if (code < 0) goto exit;
2393
2394
    /* Draw a page icon (/Note) */
2395
    /* TODO: All the other /Name appearances */
2396
24
    code = gs_translate(ctx->pgs, 0.5, (rect.q.y-rect.p.y)-18.5);
2397
24
    if (code < 0) goto exit;
2398
24
    code = gs_setlinewidth(ctx->pgs, 1.0);
2399
24
    if (code < 0) goto exit;
2400
24
    code = pdfi_gs_setgray(ctx, 0.75);
2401
24
    if (code < 0) goto exit;
2402
24
    code = gs_moveto(ctx->pgs, 0.5, -1);
2403
24
    if (code < 0) goto exit;
2404
24
    code = gs_lineto(ctx->pgs, 10, -1);
2405
24
    if (code < 0) goto exit;
2406
24
    code = gs_lineto(ctx->pgs, 15, 4);
2407
24
    if (code < 0) goto exit;
2408
24
    code = gs_lineto(ctx->pgs, 15, 17.5);
2409
24
    if (code < 0) goto exit;
2410
24
    code = gs_stroke(ctx->pgs);
2411
24
    if (code < 0) goto exit;
2412
2413
24
    code = gs_moveto(ctx->pgs, 0, 0);
2414
24
    if (code < 0) goto exit;
2415
24
    code = gs_lineto(ctx->pgs, 9, 0);
2416
24
    if (code < 0) goto exit;
2417
24
    code = gs_lineto(ctx->pgs, 14, 5);
2418
24
    if (code < 0) goto exit;
2419
24
    code = gs_lineto(ctx->pgs, 14, 18);
2420
24
    if (code < 0) goto exit;
2421
24
    code = gs_lineto(ctx->pgs, 0, 18);
2422
24
    if (code < 0) goto exit;
2423
24
    code = gs_closepath(ctx->pgs);
2424
24
    if (code < 0) goto exit;
2425
2426
24
    code = pdfi_gsave(ctx);
2427
24
    if (code >= 0) {
2428
24
        code = pdfi_gs_setgray(ctx, 0.5);
2429
24
        code = gs_fill(ctx->pgs);
2430
24
        code = pdfi_grestore(ctx);
2431
24
    } else
2432
0
        goto exit;
2433
2434
24
    code = pdfi_gs_setgray(ctx, 0);
2435
24
    if (code < 0) goto exit;
2436
24
    code = gs_stroke(ctx->pgs);
2437
24
    if (code < 0) goto exit;
2438
2439
24
    code = gs_moveto(ctx->pgs, 3, 8);
2440
24
    if (code < 0) goto exit;
2441
24
    code = gs_lineto(ctx->pgs, 7.5, 8);
2442
24
    if (code < 0) goto exit;
2443
24
    code = gs_moveto(ctx->pgs, 3, 11);
2444
24
    if (code < 0) goto exit;
2445
24
    code = gs_lineto(ctx->pgs, 10, 11);
2446
24
    if (code < 0) goto exit;
2447
24
    code = gs_moveto(ctx->pgs, 3, 14);
2448
24
    if (code < 0) goto exit;
2449
24
    code = gs_lineto(ctx->pgs, 10, 14);
2450
24
    if (code < 0) goto exit;
2451
24
    code = gs_moveto(ctx->pgs, 9, 0);
2452
24
    if (code < 0) goto exit;
2453
24
    code = gs_lineto(ctx->pgs, 9, 5);
2454
24
    if (code < 0) goto exit;
2455
24
    code = gs_lineto(ctx->pgs, 14, 5);
2456
24
    if (code < 0) goto exit;
2457
24
    code = gs_stroke(ctx->pgs);
2458
24
    if (code < 0) goto exit;
2459
2460
24
 exit:
2461
24
    code1 = pdfi_annot_end_transparency(ctx, annot);
2462
24
    if (code >= 0)
2463
24
        code = code1;
2464
24
 exit1:
2465
24
    *render_done = true;
2466
24
    return code;
2467
24
}
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
6.48k
{
2485
6.48k
    double x0,x1,x2,x3,y0,y1,y2,y3;
2486
6.48k
    double minx, miny;
2487
6.48k
    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
6.48k
    minx = array[0];
2499
6.48k
    miny = array[1];
2500
6.48k
    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
25.9k
    for (i=2; i<8; i+=2) {
2505
19.4k
        if ((array[i+1] == miny && array[i] < minx) ||  (array[i+1] < miny)) {
2506
            /* Set new min point */
2507
1.30k
            miny = array[i+1];
2508
1.30k
            minx = array[i];
2509
1.30k
            mindex = i;
2510
1.30k
        }
2511
19.4k
    }
2512
2513
    /* Pull out the points such that x0 = minx, y0 = miny, etc */
2514
6.48k
    i = mindex;
2515
6.48k
    x0 = array[i];
2516
6.48k
    y0 = array[i+1];
2517
6.48k
    i += 2;
2518
6.48k
    if (i == 8) i = 0;
2519
6.48k
    x1 = array[i];
2520
6.48k
    y1 = array[i+1];
2521
6.48k
    i += 2;
2522
6.48k
    if (i == 8) i = 0;
2523
6.48k
    x2 = array[i];
2524
6.48k
    y2 = array[i+1];
2525
6.48k
    i += 2;
2526
6.48k
    if (i == 8) i = 0;
2527
6.48k
    x3 = array[i];
2528
6.48k
    y3 = array[i+1];
2529
2530
    /* Make it go counterclockwise by picking lower of these 2 points */
2531
6.48k
    if (y3 < y1) {
2532
222
        y1 = y3;
2533
222
        x1 = x3;
2534
222
    }
2535
2536
    /* Convert into a starting point and two sets of lengths */
2537
6.48k
    *px0 = x0;
2538
6.48k
    *py0 = y0;
2539
6.48k
    *dx1 = x1 - x0;
2540
6.48k
    *dy1 = y1 - y0;
2541
6.48k
    *dx2 = x2 - x0;
2542
6.48k
    *dy2 = y2 - y0;
2543
6.48k
}
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
498
{
2552
498
    int code = 0;
2553
498
    bool drawit;
2554
498
    pdf_array *QuadPoints = NULL;
2555
498
    double array[8];
2556
498
    int size;
2557
498
    int num_quads;
2558
498
    int i;
2559
498
    double x0, y0, dx1, dy1, dx2, dy2;
2560
498
    double linewidth;
2561
2562
498
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
2563
498
    if (code <0 || !drawit)
2564
16
        goto exit;
2565
2566
482
    code = pdfi_dict_knownget_type(ctx, annot, "QuadPoints", PDF_ARRAY, (pdf_obj **)&QuadPoints);
2567
482
    if (code <= 0) goto exit;
2568
2569
482
    size = pdfi_array_size(QuadPoints);
2570
482
    num_quads = size / 8;
2571
2572
6.13k
    for (i=0; i<num_quads; i++) {
2573
5.65k
        code = pdfi_array_to_num_array(ctx, QuadPoints, array, i*8, 8);
2574
5.65k
        if (code < 0) goto exit;
2575
2576
5.64k
        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
5.64k
        linewidth = sqrt((dx2*dx2) + (dy2*dy2)) / 16.;
2582
5.64k
        code = gs_setlinewidth(ctx->pgs, linewidth);
2583
5.64k
        if (code < 0) goto exit;
2584
5.64k
        code = gs_moveto(ctx->pgs, dx2*offset + x0 , dy2*offset + y0);
2585
5.64k
        if (code < 0) goto exit;
2586
5.64k
        code = gs_lineto(ctx->pgs, dx2*offset + x0 + dx1, dy2*offset + y0 + dy1);
2587
5.64k
        if (code < 0) goto exit;
2588
5.64k
        code = gs_stroke(ctx->pgs);
2589
5.64k
        if (code < 0) goto exit;
2590
5.64k
    }
2591
2592
498
 exit:
2593
498
    pdfi_countdown(QuadPoints);
2594
498
    return code;
2595
482
}
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
422
{
2603
422
    *render_done = true;
2604
422
    return pdfi_annot_draw_line_offset(ctx, annot, 3/7.);
2605
422
}
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
76
{
2613
76
    *render_done = true;
2614
76
    return pdfi_annot_draw_line_offset(ctx, annot, 1/7.);
2615
76
}
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
10.7k
{
2623
10.7k
    int code = 0;
2624
10.7k
    double dx, dy;
2625
10.7k
    double xc, yc, r, a1, a2;
2626
2627
10.7k
    dx = x1 - x0;
2628
10.7k
    dy = y1 - y0;
2629
2630
10.7k
    yc = (y1+y0)/2. - 15./16.*dx;
2631
10.7k
    xc = (x1+x0)/2. + 15./16.*dy;
2632
10.7k
    r = sqrt((y1-yc)*(y1-yc) + (x1-xc)*(x1-xc));
2633
10.7k
    code = gs_atan2_degrees(y1-yc, x1-xc, &a1);
2634
10.7k
    if (code < 0)
2635
56
        a1 = 0;
2636
10.7k
    code = gs_atan2_degrees(y0-yc, x0-xc, &a2);
2637
10.7k
    if (code < 0)
2638
56
        a2 = 0;
2639
10.7k
    code = gs_arcn(ctx->pgs, xc, yc, r, a2, a1);
2640
2641
10.7k
    return code;
2642
10.7k
}
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
948
{
2650
948
    int code = 0;
2651
948
    bool drawit;
2652
948
    pdf_array *QuadPoints = NULL;
2653
948
    double array[8];
2654
948
    int size;
2655
948
    int num_quads;
2656
948
    int i;
2657
2658
948
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
2659
948
    if (code <0 || !drawit)
2660
26
        goto exit;
2661
2662
922
    code = gs_setlinecap(ctx->pgs, 1);
2663
922
    if (code < 0) goto exit;
2664
2665
922
    code = pdfi_dict_knownget_type(ctx, annot, "QuadPoints", PDF_ARRAY, (pdf_obj **)&QuadPoints);
2666
922
    if (code <= 0) goto exit;
2667
2668
906
    size = pdfi_array_size(QuadPoints);
2669
906
    num_quads = size / 8;
2670
2671
6.21k
    for (i=0; i<num_quads; i++) {
2672
5.41k
        code = pdfi_array_to_num_array(ctx, QuadPoints, array, i*8, 8);
2673
5.41k
        if (code < 0) goto exit;
2674
2675
5.37k
        code = gs_moveto(ctx->pgs, array[2], array[3]);
2676
5.37k
        if (code < 0) goto exit;
2677
2678
5.37k
        code = pdfi_annot_highlight_arc(ctx, array[2], array[3], array[6], array[7]);
2679
5.37k
        if (code < 0) goto exit;
2680
2681
5.35k
        code = gs_lineto(ctx->pgs, array[4], array[5]);
2682
5.35k
        if (code < 0) goto exit;
2683
2684
5.35k
        code = pdfi_annot_highlight_arc(ctx, array[4], array[5], array[0], array[1]);
2685
5.35k
        if (code < 0) goto exit;
2686
2687
5.31k
        code = gs_closepath(ctx->pgs);
2688
5.31k
        if (code < 0) goto exit;
2689
2690
5.31k
        if (ctx->page.has_transparency) {
2691
5.31k
            code = pdfi_trans_begin_simple_group(ctx, NULL, false, false, false);
2692
5.31k
            if (code < 0) goto exit;
2693
2694
5.31k
            code = gs_setblendmode(ctx->pgs, BLEND_MODE_Multiply);
2695
5.31k
            if (code < 0) {
2696
0
                (void)pdfi_trans_end_simple_group(ctx);
2697
0
                goto exit;
2698
0
            }
2699
5.31k
            code = gs_fill(ctx->pgs);
2700
5.31k
            (void)pdfi_trans_end_simple_group(ctx);
2701
5.31k
            if (code < 0) goto exit;
2702
5.31k
        } 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
5.31k
    }
2710
2711
948
 exit:
2712
948
    pdfi_countdown(QuadPoints);
2713
948
    return code;
2714
906
}
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
336
{
2722
336
    int code = 0;
2723
336
    bool drawit;
2724
336
    pdf_array *QuadPoints = NULL;
2725
336
    double array[8];
2726
336
    int size;
2727
336
    int num_quads;
2728
336
    int i;
2729
336
    double x0, y0, dx1, dy1, dx2, dy2;
2730
336
    double p1, p2, p12;
2731
336
    int count;
2732
336
    bool need_grestore = false;
2733
336
    gs_matrix matrix;
2734
2735
336
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
2736
336
    if (code <0 || !drawit)
2737
6
        goto exit;
2738
2739
330
    code = gs_setlinecap(ctx->pgs, gs_cap_round);
2740
330
    if (code < 0) goto exit;
2741
330
    code = gs_setlinejoin(ctx->pgs, gs_join_round);
2742
330
    if (code < 0) goto exit;
2743
330
    code = gs_setlinewidth(ctx->pgs, 1.0);
2744
330
    if (code < 0) goto exit;
2745
2746
330
    code = pdfi_dict_knownget_type(ctx, annot, "QuadPoints", PDF_ARRAY, (pdf_obj **)&QuadPoints);
2747
330
    if (code <= 0) goto exit;
2748
2749
327
    size = pdfi_array_size(QuadPoints);
2750
327
    num_quads = size / 8;
2751
2752
1.16k
    for (i=0; i<num_quads; i++) {
2753
846
        code = pdfi_array_to_num_array(ctx, QuadPoints, array, i*8, 8);
2754
846
        if (code < 0) goto exit;
2755
2756
833
        code = pdfi_gsave(ctx);
2757
833
        if (code < 0) goto exit;
2758
833
        need_grestore = true;
2759
2760
        /* Make clipping region */
2761
833
        code = gs_moveto(ctx->pgs, array[6], array[7]);
2762
833
        if (code < 0) goto exit;
2763
833
        code = gs_lineto(ctx->pgs, array[4], array[5]);
2764
833
        if (code < 0) goto exit;
2765
833
        code = gs_lineto(ctx->pgs, array[0], array[1]);
2766
833
        if (code < 0) goto exit;
2767
833
        code = gs_lineto(ctx->pgs, array[2], array[3]);
2768
833
        if (code < 0) goto exit;
2769
833
        code = gs_closepath(ctx->pgs);
2770
833
        if (code < 0) goto exit;
2771
833
        code = gs_clip(ctx->pgs);
2772
833
        if (code < 0) goto exit;
2773
833
        code = gs_newpath(ctx->pgs);
2774
833
        if (code < 0) goto exit;
2775
2776
833
        pdfi_annot_quadpoints2basis(ctx, array, &x0, &y0, &dx1, &dy1, &dx2, &dy2);
2777
2778
833
        code = gs_translate(ctx->pgs, x0+dx2/56+dx2/72, y0+dy2/56+dy2/72);
2779
833
        if (code < 0) goto exit;
2780
2781
833
        p2 = sqrt(dx2*dx2 + dy2*dy2);
2782
833
        p1 = sqrt(dx1*dx1 + dy1*dy1);
2783
2784
833
        if (p2 > 0 && p1 > 0) {
2785
828
            p12 = p2 / p1;
2786
2787
828
            count = (int)((1/p12) * 4 + 1);
2788
2789
828
            matrix.xx = dx1 * p12;
2790
828
            matrix.xy = dy1 * p12;
2791
828
            matrix.yx = dx2;
2792
828
            matrix.yy = dy2;
2793
828
            matrix.tx = 0.0;
2794
828
            matrix.ty = 0.0;
2795
828
            code = gs_concat(ctx->pgs, &matrix);
2796
828
            if (code < 0) goto exit;
2797
2798
828
            code = gs_scale(ctx->pgs, 1/40., 1/72.);
2799
828
            if (code < 0) goto exit;
2800
2801
828
            code = gs_moveto(ctx->pgs, 0, 0);
2802
828
            if (code < 0) goto exit;
2803
2804
214k
            while (count >= 0) {
2805
213k
                code = gs_lineto(ctx->pgs, 5, 10);
2806
213k
                if (code < 0) goto exit;
2807
213k
                code = gs_lineto(ctx->pgs, 10, 0);
2808
213k
                if (code < 0) goto exit;
2809
213k
                code = gs_translate(ctx->pgs, 10, 0);
2810
213k
                if (code < 0) goto exit;
2811
2812
213k
                count --;
2813
213k
            }
2814
828
            code = gs_stroke(ctx->pgs);
2815
828
            if (code < 0) goto exit;
2816
828
        }
2817
2818
833
        need_grestore = false;
2819
833
        code = pdfi_grestore(ctx);
2820
833
        if (code < 0) goto exit;
2821
833
    }
2822
2823
336
 exit:
2824
336
    if (need_grestore)
2825
0
        (void)pdfi_grestore(ctx);
2826
336
    pdfi_countdown(QuadPoints);
2827
336
    *render_done = true;
2828
336
    return code;
2829
327
}
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
4.51k
{
2855
4.51k
    int code = 0, code1 = 0;
2856
4.51k
    bool Open = false;
2857
4.51k
    pdf_dict *Parent = NULL;
2858
4.51k
    pdf_string *Contents = NULL;
2859
4.51k
    pdf_string *T = NULL;
2860
4.51k
    bool has_color;
2861
4.51k
    gs_rect rect, rect2;
2862
4.51k
    bool need_grestore = false;
2863
2864
    /* Render only if open */
2865
4.51k
    code = pdfi_dict_get_bool(ctx, annot, "Open", &Open);
2866
4.51k
    if (code < 0 && (code != gs_error_undefined))
2867
0
        goto exit1;
2868
2869
4.51k
    code = 0;
2870
2871
    /* Don't render if not Open */
2872
4.51k
    if (!Open) {
2873
4.35k
        *render_done = true;
2874
4.35k
        goto exit1;
2875
4.35k
    }
2876
2877
    /* Let caller render if there is an AP */
2878
163
    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
163
    *render_done = true;
2885
2886
163
    code = pdfi_annot_start_transparency(ctx, annot);
2887
163
    if (code < 0) goto exit1;
2888
2889
163
    code = gs_setlinewidth(ctx->pgs, 0.05);
2890
2891
163
    code = pdfi_loop_detector_mark(ctx);
2892
163
    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
163
    code = pdfi_dict_knownget_type_no_store_R(ctx, annot, "Parent", PDF_DICT, (pdf_obj **)&Parent);
2901
163
    if (code < 0) goto exit;
2902
151
    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
151
    (void)pdfi_loop_detector_cleartomark(ctx);
2907
2908
151
    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
151
    code = pdfi_annot_setcolor(ctx, Parent, false, &has_color);
2916
151
    if (code < 0) goto exit;
2917
2918
    /* Set a default color if nothing specified */
2919
151
    if (!has_color) {
2920
2
        code = pdfi_gs_setrgbcolor(ctx, 1.0, 1.0, 0);
2921
2
        if (code < 0) goto exit;
2922
2
    }
2923
2924
151
    code = pdfi_annot_Rect(ctx, annot, &rect);
2925
151
    if (code < 0) goto exit;
2926
2927
    /* Draw big box (the frame around the /Contents) */
2928
151
    code = pdfi_gsave(ctx);
2929
151
    if (code < 0) goto exit;
2930
151
    need_grestore = true;
2931
151
    code = pdfi_gs_setgray(ctx, 1);
2932
151
    if (code < 0) goto exit;
2933
151
    code = gs_rectfill(ctx->pgs, &rect, 1);
2934
151
    if (code < 0) goto exit;
2935
151
    code = pdfi_gs_setgray(ctx, 0);
2936
151
    if (code < 0) goto exit;
2937
151
    code = gs_rectstroke(ctx->pgs, &rect, 1, NULL);
2938
151
    if (code < 0) goto exit;
2939
151
    code = pdfi_grestore(ctx);
2940
151
    need_grestore = false;
2941
151
    if (code < 0) goto exit;
2942
2943
    /* Display /Contents in Helvetica */
2944
151
    code = pdfi_dict_knownget_type(ctx, Parent, "Contents", PDF_STRING, (pdf_obj **)&Contents);
2945
151
    if (code < 0) goto exit;
2946
151
    if (code > 0) {
2947
149
        gs_rect text_rect;
2948
2949
149
        code = pdfi_gsave(ctx);
2950
149
        if (code < 0) goto exit;
2951
149
        need_grestore = true;
2952
149
        code = pdfi_gs_setgray(ctx, 0);
2953
149
        if (code < 0) goto exit;
2954
2955
149
        text_rect.p.x = rect.p.x + 3;
2956
149
        text_rect.q.x = rect.q.x - 3;
2957
149
        text_rect.p.y = rect.p.y + 3;
2958
149
        text_rect.q.y = rect.q.y - 18;
2959
2960
149
        code = pdfi_annot_set_font(ctx, "Helvetica", 9);
2961
149
        if (code < 0) goto exit;
2962
2963
149
        code = pdfi_annot_display_formatted_text(ctx, annot, &text_rect, Contents, false);
2964
149
        if (code < 0) goto exit;
2965
2966
149
        code = pdfi_grestore(ctx);
2967
149
        need_grestore = false;
2968
149
        if (code < 0) goto exit;
2969
149
    }
2970
2971
    /* Draw small, thin box (the frame around the top /T text) */
2972
151
    rect2.p.x = rect.p.x;
2973
151
    rect2.p.y = rect.q.y - 15;
2974
151
    rect2.q.x = rect.q.x;
2975
151
    rect2.q.y = rect.p.y + (rect.q.y - rect.p.y);
2976
2977
151
    code = gs_rectfill(ctx->pgs, &rect2, 1);
2978
151
    if (code < 0) goto exit;
2979
151
    code = pdfi_gs_setgray(ctx, 0);
2980
151
    if (code < 0) goto exit;
2981
151
    code = gs_rectstroke(ctx->pgs, &rect2, 1, NULL);
2982
151
    if (code < 0) goto exit;
2983
2984
    /* Display /T in Helvetica */
2985
151
    code = pdfi_dict_knownget_type(ctx, Parent, "T", PDF_STRING, (pdf_obj **)&T);
2986
151
    if (code < 0) goto exit;
2987
151
    if (code > 0) {
2988
150
        code = pdfi_annot_set_font(ctx, "Helvetica", 9);
2989
150
        if (code < 0) goto exit;
2990
2991
150
        code = pdfi_annot_display_centered_text(ctx, annot, &rect, T);
2992
150
        if (code < 0) goto exit;
2993
2994
150
    }
2995
2996
163
 exit:
2997
163
    if (need_grestore) {
2998
0
        code1= pdfi_grestore(ctx);
2999
0
        if (code == 0) code = code1;
3000
0
    }
3001
163
    code1 = pdfi_annot_end_transparency(ctx, annot);
3002
163
    if (code == 0) code = code1;
3003
4.51k
 exit1:
3004
4.51k
    pdfi_countdown(Parent);
3005
4.51k
    pdfi_countdown(Contents);
3006
4.51k
    pdfi_countdown(T);
3007
4.51k
    return code;
3008
163
}
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
953
{
3016
953
    int code = 0;
3017
953
    int code1 = 0;
3018
953
    gs_rect lrect;
3019
953
    pdf_array *L = NULL;
3020
953
    bool drawit;
3021
3022
953
    code = pdfi_annot_start_transparency(ctx, annot);
3023
953
    if (code < 0) goto exit1;
3024
3025
953
    code = pdfi_dict_knownget_type(ctx, annot, "L", PDF_ARRAY, (pdf_obj **)&L);
3026
953
    if (code < 0) goto exit;
3027
3028
953
    code = pdfi_array_to_gs_rect(ctx, L, &lrect);
3029
953
    if (code < 0) goto exit;
3030
3031
947
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3032
947
    if (code < 0) goto exit;
3033
3034
    /* Handle LE */
3035
946
    code = pdfi_annot_draw_LE(ctx, annot, lrect.p.x, lrect.p.y, lrect.q.x, lrect.q.y, 0);
3036
946
    if (code < 0) goto exit;
3037
3038
    /* Draw the actual line */
3039
939
    code = gs_moveto(ctx->pgs, lrect.p.x, lrect.p.y);
3040
939
    if (code < 0) goto exit;
3041
939
    code = gs_lineto(ctx->pgs, lrect.q.x, lrect.q.y);
3042
939
    if (code < 0) goto exit;
3043
939
    code = pdfi_annot_draw_border(ctx, annot, true);
3044
939
    if (code < 0) goto exit;
3045
3046
953
 exit:
3047
953
    code1 = pdfi_annot_end_transparency(ctx, annot);
3048
953
    if (code >= 0)
3049
934
        code = code1;
3050
953
 exit1:
3051
953
    *render_done = true;
3052
953
    pdfi_countdown(L);
3053
953
    return code;
3054
953
}
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
441
{
3059
441
    int code = 0;
3060
441
    int i;
3061
3062
2.36k
    for (i=0; i<pdfi_array_size(Vertices); i+=2) {
3063
1.93k
        double x,y;
3064
3065
1.93k
        code = pdfi_array_get_number(ctx, Vertices, i, &x);
3066
1.93k
        if (code < 0) goto exit;
3067
1.93k
        code = pdfi_array_get_number(ctx, Vertices, i+1, &y);
3068
1.93k
        if (code < 0) goto exit;
3069
3070
1.92k
        if (i == 0) {
3071
441
            code = gs_moveto(ctx->pgs, x, y);
3072
441
            if (code < 0) goto exit;
3073
1.48k
        } else {
3074
1.48k
            code = gs_lineto(ctx->pgs, x, y);
3075
1.48k
            if (code < 0) goto exit;
3076
1.48k
        }
3077
1.92k
    }
3078
3079
441
 exit:
3080
441
    return code;
3081
441
}
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
430
{
3090
430
    int code = 0;
3091
430
    int code1 = 0;
3092
430
    pdf_array *Vertices = NULL, *Path = NULL, *Line = NULL;
3093
430
    bool drawit;
3094
430
    int size;
3095
430
    double x1, y1, x2, y2, x3, y3, ends[8];
3096
430
    bool Vertices_known = false, Path_known = false;
3097
3098
430
    code = pdfi_annot_start_transparency(ctx, annot);
3099
430
    if (code < 0) goto exit1;
3100
3101
430
    code = pdfi_dict_known(ctx, annot, "Vertices", &Vertices_known);
3102
430
    if (code < 0) goto exit1;
3103
430
    code = pdfi_dict_known(ctx, annot, "Path", &Path_known);
3104
430
    if (code < 0) goto exit1;
3105
3106
430
    code = pdfi_gsave(ctx);
3107
430
    if (code < 0) goto exit1;
3108
3109
    /* If both are known, or neither are known, then there is a problem */
3110
430
    if (Vertices_known == Path_known) {
3111
4
        code = gs_note_error(gs_error_undefined);
3112
4
        goto exit;
3113
4
    }
3114
3115
426
    if (Vertices_known) {
3116
426
        code = pdfi_dict_get_type(ctx, annot, "Vertices", PDF_ARRAY, (pdf_obj **)&Vertices);
3117
426
        if (code < 0) goto exit;
3118
3119
426
        size = pdfi_array_size(Vertices);
3120
426
        if (size == 0) {
3121
0
            code = 0;
3122
0
            goto exit;
3123
0
        }
3124
426
        code = pdfi_annot_path_array(ctx, annot, Vertices);
3125
426
        if (code < 0) goto exit1;
3126
3127
417
        code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3128
417
        if (code < 0) goto exit;
3129
3130
417
        code = pdfi_annot_draw_border(ctx, annot, true);
3131
417
        if (code < 0) goto exit;
3132
3133
417
        if (size >= 4) {
3134
417
            code = pdfi_array_get_number(ctx, Vertices, 0, &x1);
3135
417
            if (code < 0) goto exit;
3136
417
            code = pdfi_array_get_number(ctx, Vertices, 1, &y1);
3137
417
            if (code < 0) goto exit;
3138
417
            code = pdfi_array_get_number(ctx, Vertices, 2, &x2);
3139
417
            if (code < 0) goto exit;
3140
417
            code = pdfi_array_get_number(ctx, Vertices, 3, &y2);
3141
417
            if (code < 0) goto exit;
3142
417
            code = pdfi_annot_draw_LE(ctx, annot, x1, y1, x2, y2, 1);
3143
417
            if (code < 0) goto exit;
3144
3145
417
            code = pdfi_array_get_number(ctx, Vertices, size-4, &x1);
3146
417
            if (code < 0) goto exit;
3147
417
            code = pdfi_array_get_number(ctx, Vertices, size-3, &y1);
3148
417
            if (code < 0) goto exit;
3149
417
            code = pdfi_array_get_number(ctx, Vertices, size-2, &x2);
3150
417
            if (code < 0) goto exit;
3151
417
            code = pdfi_array_get_number(ctx, Vertices, size-1, &y2);
3152
417
            if (code < 0) goto exit;
3153
417
            code = pdfi_annot_draw_LE(ctx, annot, x1, y1, x2, y2, 2);
3154
417
            if (code < 0) goto exit;
3155
417
        }
3156
417
    } 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
421
 exit:
3265
421
    code1 = pdfi_annot_end_transparency(ctx, annot);
3266
421
    if (code >= 0)
3267
417
        code = code1;
3268
421
    code1 = pdfi_grestore(ctx);
3269
421
    if (code >= 0) code = code1;
3270
3271
430
 exit1:
3272
430
    *render_done = true;
3273
430
    pdfi_countdown(Line);
3274
430
    pdfi_countdown(Vertices);
3275
430
    pdfi_countdown(Path);
3276
430
    return code;
3277
421
}
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
15
{
3285
15
    int code = 0;
3286
15
    int code1 = 0;
3287
15
    pdf_array *Vertices = NULL;
3288
15
    bool drawit;
3289
3290
15
    code = pdfi_annot_start_transparency(ctx, annot);
3291
15
    if (code < 0) goto exit1;
3292
3293
15
    code = pdfi_dict_knownget_type(ctx, annot, "Vertices", PDF_ARRAY, (pdf_obj **)&Vertices);
3294
15
    if (code <= 0) goto exit;
3295
3296
15
    code = pdfi_annot_path_array(ctx, annot, Vertices);
3297
15
    if (code < 0) goto exit1;
3298
3299
15
    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
15
    code = pdfi_annot_setinteriorcolor(ctx, annot, false, &drawit);
3306
15
    if (code < 0) goto exit;
3307
15
    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
15
    code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3314
15
    if (code < 0) goto exit;
3315
15
    if (drawit) {
3316
15
        code = pdfi_annot_draw_border(ctx, annot, true);
3317
15
        if (code < 0) goto exit;
3318
15
    }
3319
3320
15
 exit:
3321
15
    code1 = pdfi_annot_end_transparency(ctx, annot);
3322
15
    if (code >= 0)
3323
15
        code = code1;
3324
15
 exit1:
3325
15
    *render_done = true;
3326
15
    pdfi_countdown(Vertices);
3327
15
    return code;
3328
15
}
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
121
{
3336
121
    int code = 0;
3337
121
    int code1 = 0;
3338
121
    bool drawit;
3339
3340
121
    code = pdfi_annot_start_transparency(ctx, annot);
3341
121
    if (code < 0) goto exit1;
3342
3343
121
    code = pdfi_annot_setinteriorcolor(ctx, annot, false, &drawit);
3344
121
    if (code < 0) goto exit;
3345
121
    if (drawit) {
3346
45
        code = pdfi_annot_opacity(ctx, annot);
3347
45
        if (code < 0) goto exit;
3348
45
        code = pdfi_annot_fillRect(ctx, annot);
3349
45
        if (code < 0) goto exit;
3350
3351
45
        code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3352
45
        if (code < 0) goto exit;
3353
3354
45
        if (drawit) {
3355
45
            code = pdfi_annot_draw_border(ctx, annot, false);
3356
45
            if (code < 0) goto exit;
3357
45
        }
3358
76
    } else {
3359
76
        code = pdfi_annot_RectRD_path(ctx, annot);
3360
76
        if (code < 0) goto exit;
3361
3362
76
        code = pdfi_annot_setcolor(ctx, annot, false, &drawit);
3363
76
        if (code < 0) goto exit;
3364
3365
67
        if (drawit) {
3366
67
            code = pdfi_annot_draw_border(ctx, annot, true);
3367
67
            if (code < 0) goto exit;
3368
67
        }
3369
67
    }
3370
3371
121
 exit:
3372
121
    code1 = pdfi_annot_end_transparency(ctx, annot);
3373
121
    if (code >= 0)
3374
112
        code = code1;
3375
121
 exit1:
3376
121
    *render_done = true;
3377
121
    return code;
3378
121
}
3379
3380
static int pdfi_annot_render_MK_box(pdf_context *ctx, pdf_dict *annot, pdf_dict *MK)
3381
18.4k
{
3382
18.4k
    int code = 0;
3383
18.4k
    bool drawit = false;
3384
18.4k
    gs_rect rect;
3385
18.4k
    bool need_grestore = false;
3386
3387
    /* Basically just render the rectangle around the widget for now */
3388
18.4k
    code = pdfi_annot_Rect(ctx, annot, &rect);
3389
18.4k
    if (code < 0) goto exit;
3390
3391
18.3k
    code = pdfi_gsave(ctx);
3392
18.3k
    if (code < 0) goto exit;
3393
18.3k
    need_grestore = true;
3394
18.3k
    code = pdfi_annot_setcolor_key(ctx, MK, "BG", false, &drawit);
3395
18.3k
    if (code < 0) goto exit;
3396
18.3k
    if (drawit)
3397
231
        code = gs_rectfill(ctx->pgs, &rect, 1);
3398
18.3k
    if (code < 0) goto exit;
3399
18.3k
    need_grestore = false;
3400
18.3k
    code = pdfi_grestore(ctx);
3401
18.3k
    if (code < 0) goto exit;
3402
3403
18.3k
    code = pdfi_gsave(ctx);
3404
18.3k
    if (code < 0) goto exit;
3405
18.3k
    need_grestore = true;
3406
18.3k
    code = pdfi_annot_setcolor_key(ctx, MK, "BC", false, &drawit);
3407
18.3k
    if (code < 0) goto exit;
3408
18.3k
    if (drawit)
3409
310
        code = gs_rectstroke(ctx->pgs, &rect, 1, NULL);
3410
18.3k
    if (code < 0) goto exit;
3411
18.3k
    need_grestore = false;
3412
18.3k
    code = pdfi_grestore(ctx);
3413
18.3k
    if (code < 0) goto exit;
3414
3415
    /* TODO: Stuff with can-regenerate-ap ?? */
3416
3417
18.4k
 exit:
3418
18.4k
    if (need_grestore)
3419
0
        (void)pdfi_grestore(ctx);
3420
18.4k
    return code;
3421
18.3k
}
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
208
{
3447
208
    int code;
3448
#ifdef DEBUG
3449
    bool Radio = false;
3450
    bool Pushbutton = false;
3451
#endif
3452
208
    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
208
    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
208
    code = pdfi_form_get_inheritable_int(ctx, field, "Ff", &value);
3464
208
    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
208
 exit:
3476
208
    return 0;
3477
208
}
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
195
{
3482
195
    bool did_mod = false;
3483
195
    int code = 0;
3484
195
    int skip = 0;
3485
195
    pdf_string *newV = NULL;
3486
3487
195
    *is_UTF16 = false;
3488
3489
195
    if (IS_UTF8(V->data)) {
3490
0
        skip = 3;
3491
195
    } else if (IS_UTF16(V->data)) {
3492
7
        skip = 2;
3493
7
        *is_UTF16 = true;
3494
7
    }
3495
3496
195
    if (skip == 0)
3497
188
        goto exit;
3498
3499
    /* Create a new V that skips over the BOM */
3500
7
    code = pdfi_object_alloc(ctx, PDF_STRING, V->length-skip, (pdf_obj **)&newV);
3501
7
    if (code < 0)
3502
0
        goto exit;
3503
7
    pdfi_countup(newV);
3504
3505
7
    memcpy(newV->data, V->data+skip, newV->length);
3506
7
    did_mod = true;
3507
3508
195
 exit:
3509
    /* If didn't need to mod it, just copy the original and get a ref */
3510
195
    if (did_mod) {
3511
7
        *mod_V = newV;
3512
188
    } else {
3513
188
        *mod_V = V;
3514
188
        pdfi_countup(V);
3515
188
    }
3516
195
    return code;
3517
7
}
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
193
{
3523
193
    int code = 0;
3524
193
    gs_rect modrect;
3525
193
    double lineheight = 0;
3526
193
    gs_rect bbox;
3527
193
    gs_point awidth;
3528
193
    double y_adjust = 0.0f, x_adjust = 0.0f;
3529
3530
193
    modrect = *rect; /* structure copy */
3531
3532
193
    code = pdfi_annot_get_text_height(ctx, &lineheight);
3533
193
    if (code < 0) goto exit;
3534
3535
    /* text placement adjustments */
3536
193
    switch (Q) {
3537
193
    case 0: /* Left-justified */
3538
193
        x_adjust = 2; /* empirical value */
3539
193
        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
193
    }
3553
3554
    /* Center vertically */
3555
193
    y_adjust = ((rect->q.y - rect->p.y) - lineheight) / 2;
3556
3557
193
    modrect.p.x += x_adjust;
3558
193
    modrect.p.y += y_adjust;
3559
193
    modrect.p.y += (lineheight + 6.) / 10.; /* empirical */
3560
3561
193
    code = pdfi_annot_display_simple_text(ctx, annot, modrect.p.x, modrect.p.y, V);
3562
193
    if (code < 0) goto exit;
3563
193
 exit:
3564
193
    return code;
3565
193
}
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
2
{
3571
2
    int code = 0;
3572
2
    gs_rect modrect;
3573
3574
2
    modrect = *rect; /* structure copy */
3575
    /* empirical tweaks */
3576
2
    modrect.p.x += 2;
3577
2
    modrect.p.y += 2;
3578
2
    modrect.q.x -= 2;
3579
2
    modrect.q.y -= 2;
3580
3581
2
    code = pdfi_annot_display_formatted_text(ctx, annot, &modrect, V, is_UTF16);
3582
2
    if (code < 0) goto exit;
3583
3584
2
 exit:
3585
2
    return code;
3586
2
}
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
195
{
3605
195
    int code = 0;
3606
195
    pdf_string *modV = NULL;
3607
195
    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
195
    code = pdfi_form_modV(ctx, V, &modV, &is_UTF16);
3615
195
    if (code < 0) goto exit;
3616
3617
195
    if (Ff & PDFI_FORM_FF_MULTILINE) {
3618
2
        code = pdfi_form_Tx_multiline(ctx, annot, rect, modV, Ff, Q, is_UTF16);
3619
193
    } else if (Ff & PDFI_FORM_FF_COMB) {
3620
0
        code = pdfi_form_Tx_comb(ctx, annot, rect, modV, Ff, Q, MaxLen, is_UTF16);
3621
193
    } else {
3622
193
        code = pdfi_form_Tx_simple(ctx, annot, rect, modV, Ff, Q, is_UTF16);
3623
193
    }
3624
3625
195
 exit:
3626
195
    pdfi_countdown(modV);
3627
195
    return code;
3628
195
}
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
15.9k
{
3634
15.9k
    int code = 0;
3635
15.9k
    pdf_string *V = NULL;
3636
15.9k
    gs_rect annotrect;
3637
15.9k
    int64_t Ff;
3638
15.9k
    int64_t MaxLen;
3639
15.9k
    int64_t Q;
3640
3641
15.9k
    code = pdfi_annot_Rect(ctx, annot, &annotrect);
3642
15.9k
    if (code < 0) goto exit;
3643
3644
    /* Set DA (Default Appearance)
3645
     * This will generally set a color and font.
3646
     */
3647
15.9k
    code = pdfi_annot_process_DA(ctx, annot, annot, &annotrect, true);
3648
15.9k
    if (code < 0) goto exit;
3649
3650
15.9k
    code = pdfi_form_get_inheritable_int(ctx, annot, "Ff", &Ff);
3651
15.9k
    if (code < 0) goto exit;
3652
3653
15.1k
    code = pdfi_form_get_inheritable_int(ctx, annot, "MaxLen", &MaxLen);
3654
15.1k
    if (code < 0) goto exit;
3655
3656
12.1k
    code = pdfi_form_get_inheritable_int(ctx, annot, "Q", &Q);
3657
12.1k
    if (code < 0) goto exit;
3658
3659
12.1k
    code = pdfi_dict_knownget_type(ctx, annot, "V", PDF_STRING, (pdf_obj **)&V);
3660
12.1k
    if (code < 0) goto exit;
3661
12.1k
    if (code > 0) {
3662
195
        code = pdfi_form_display_Tx(ctx, annot, &annotrect, V, Ff, Q, MaxLen);
3663
195
        if (code < 0) goto exit;
3664
195
    }
3665
3666
15.9k
 exit:
3667
15.9k
    pdfi_countdown(V);
3668
15.9k
    return code;
3669
12.1k
}
3670
3671
/* draw field Tx */
3672
static int pdfi_form_draw_Tx(pdf_context *ctx, pdf_dict *annot, pdf_obj *AP)
3673
15.8k
{
3674
15.8k
    if (AP != NULL)
3675
0
        return pdfi_annot_draw_AP(ctx, annot, AP);
3676
3677
15.8k
    return pdfi_form_draw_Tx_Ch(ctx, annot);
3678
15.8k
}
3679
3680
/* draw field Ch */
3681
static int pdfi_form_draw_Ch(pdf_context *ctx, pdf_dict *field, pdf_obj *AP)
3682
118
{
3683
118
    if (!ctx->NeedAppearances && AP != NULL)
3684
0
        return pdfi_annot_draw_AP(ctx, field, AP);
3685
3686
118
    return pdfi_form_draw_Tx_Ch(ctx, field);
3687
118
}
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
16.1k
{
3715
16.1k
    int code;
3716
3717
16.1k
    if (pdfi_name_is(FT, "Btn")) {
3718
208
        code = pdfi_form_draw_Btn(ctx, field, AP);
3719
15.9k
    } else if (pdfi_name_is(FT, "Tx")) {
3720
15.8k
        code = pdfi_form_draw_Tx(ctx, field, AP);
3721
15.8k
    } else if (pdfi_name_is(FT, "Ch")) {
3722
118
        code = pdfi_form_draw_Ch(ctx, field, AP);
3723
118
    } else if (pdfi_name_is(FT, "Sig")) {
3724
0
        code = pdfi_form_draw_Sig(ctx, field, AP);
3725
16
    } else {
3726
16
        errprintf(ctx->memory, "*** WARNING unknown field FT ignored\n");
3727
        /* TODO: Handle warning better */
3728
16
        code = 0;
3729
16
    }
3730
3731
16.1k
    return code;
3732
16.1k
}
3733
3734
/* Render Widget with no AP
3735
 */
3736
static int pdfi_annot_render_Widget(pdf_context *ctx, pdf_dict *annot)
3737
19.1k
{
3738
19.1k
    int code = 0;
3739
19.1k
    pdf_dict *MK = NULL;
3740
19.1k
    pdf_name *FT = NULL;
3741
3742
    /* Render box around the widget using MK */
3743
19.1k
    code = pdfi_dict_knownget_type(ctx, annot, "MK", PDF_DICT, (pdf_obj **)&MK);
3744
19.1k
    if (code < 0) goto exit;
3745
19.1k
    if (code > 0) {
3746
18.4k
        code = pdfi_annot_render_MK_box(ctx, annot, MK);
3747
18.4k
        if (code < 0) goto exit;
3748
18.4k
    }
3749
3750
    /* Render the other contents */
3751
19.0k
    code = pdfi_dict_knownget_type(ctx, annot, "FT", PDF_NAME, (pdf_obj **)&FT);
3752
19.0k
    if (code < 0) goto exit;
3753
19.0k
    if (code > 0) {
3754
16.1k
        code = pdfi_annot_render_field(ctx, annot, FT, NULL);
3755
16.1k
        if (code < 0) goto exit;
3756
16.1k
    }
3757
3758
19.1k
 exit:
3759
19.1k
    pdfi_countdown(FT);
3760
19.1k
    pdfi_countdown(MK);
3761
19.1k
    return code;
3762
19.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
80.3k
{
3767
80.3k
    int code = 0;
3768
80.3k
    bool found_T = false;
3769
80.3k
    bool found_FT = false, known = false;
3770
80.3k
    pdf_obj *T = NULL;
3771
80.3k
    pdf_obj *FT = NULL;
3772
80.3k
    pdf_dict *Parent = NULL;
3773
80.3k
    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
80.3k
    code = pdfi_loop_detector_mark(ctx);
3791
80.3k
    if (code < 0)
3792
0
        goto exit;
3793
3794
80.3k
    currdict = annot;
3795
80.3k
    pdfi_countup(currdict);
3796
107k
    while (true) {
3797
107k
        if (currdict->object_num != 0) {
3798
107k
            code = pdfi_loop_detector_add_object(ctx, currdict->object_num);
3799
107k
            if (code < 0)
3800
0
                break;
3801
107k
        }
3802
3803
107k
        code = pdfi_dict_knownget(ctx, currdict, "T", &T);
3804
107k
        if (code < 0) goto exit;
3805
107k
        if (code > 0) {
3806
76.7k
            found_T = true;
3807
76.7k
            pdfi_countdown(T);
3808
76.7k
            T = NULL;
3809
76.7k
            if (found_FT)
3810
230
                break;
3811
76.7k
        }
3812
107k
        code = pdfi_dict_knownget(ctx, currdict, "FT", &FT);
3813
107k
        if (code < 0) goto exit;
3814
107k
        if (code > 0) {
3815
76.8k
            found_FT = true;
3816
76.8k
            pdfi_countdown(FT);
3817
76.8k
            FT = NULL;
3818
76.8k
            if (found_T)
3819
76.4k
                break;
3820
76.8k
        }
3821
        /* Check for Parent. Do not store the dereferenced Parent back to the dictionary
3822
         * as this can cause circular references.
3823
         */
3824
31.2k
        code = pdfi_dict_known(ctx, currdict, "Parent", &known);
3825
31.2k
        if (code >= 0 && known == true)
3826
29.6k
        {
3827
29.6k
            code = pdfi_dict_get_no_store_R(ctx, currdict, "Parent", (pdf_obj **)&Parent);
3828
29.6k
            if (code < 0) {
3829
1.76k
                (void)pdfi_loop_detector_cleartomark(ctx);
3830
1.76k
                goto exit;
3831
1.76k
            }
3832
27.8k
            if (pdfi_type_of(Parent) != PDF_DICT) {
3833
260
                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
260
                } else {
3841
260
                    break;
3842
260
                }
3843
260
            }
3844
27.6k
            pdfi_countdown(currdict);
3845
27.6k
            currdict = Parent;
3846
27.6k
            Parent = NULL;
3847
27.6k
        } else
3848
1.59k
            break;
3849
31.2k
    }
3850
3851
78.5k
    (void)pdfi_loop_detector_cleartomark(ctx);
3852
3853
78.5k
    code = 0;
3854
78.5k
    if (!found_T || !found_FT) {
3855
1.85k
        *render_done = true;
3856
1.85k
        outprintf(ctx->memory, "**** Warning: A Widget annotation dictionary lacks either the FT or T key.\n");
3857
1.85k
        outprintf(ctx->memory, "              Acrobat ignores such annoataions, annotation will not be rendered.\n");
3858
1.85k
        outprintf(ctx->memory, "              Output may not be as expected.\n");
3859
1.85k
        goto exit;
3860
1.85k
    }
3861
3862
76.7k
    if (NormAP) {
3863
        /* Let caller render it */
3864
57.5k
        *render_done = false;
3865
57.5k
        goto exit;
3866
57.5k
    }
3867
3868
    /* No AP, try to render the Widget ourselves */
3869
19.1k
    code = pdfi_annot_render_Widget(ctx, annot);
3870
19.1k
    *render_done = true;
3871
3872
80.3k
 exit:
3873
80.3k
    pdfi_countdown(Parent);
3874
80.3k
    pdfi_countdown(currdict);
3875
80.3k
    return code;
3876
19.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
5
{
3881
5
    int code = 0;
3882
5
    pdf_name *Subtype = NULL;
3883
5
    char str[100];
3884
3885
5
    code = pdfi_dict_get_type(ctx, annot, "Subtype", PDF_NAME, (pdf_obj **)&Subtype);
3886
5
    if (code < 0) goto exit;
3887
3888
5
    memcpy(str, (const char *)Subtype->data, Subtype->length < 100 ? Subtype->length : 99);
3889
5
    str[Subtype->length < 100 ? Subtype->length : 99] = '\0';
3890
5
    dbgmprintf1(ctx->memory, "ANNOT: No AP, default appearance for Subtype %s Not Implemented\n", str);
3891
3892
5
 exit:
3893
5
    *render_done = false;
3894
5
    pdfi_countdown(Subtype);
3895
5
    return code;
3896
5
}
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
401k
{
3951
401k
    int code;
3952
401k
    bool is_3D = false;
3953
401k
    bool is_visible = true;
3954
401k
    int64_t F;
3955
3956
401k
    if (pdfi_name_is(subtype, "3D"))
3957
0
        is_3D = true;
3958
3959
401k
    code = pdfi_dict_get_int(ctx, annot, "F", &F);
3960
401k
    if (code < 0)
3961
44.3k
        F = 0;
3962
3963
401k
    if ((F & 0x2) != 0) { /* Bit 2 -- Hidden */
3964
124k
        is_visible = false; /* Hidden */
3965
124k
        goto exit;
3966
124k
    }
3967
3968
277k
    if (ctx->args.printed) {
3969
        /* Even if Print flag (bit 3) is off, will print if 3D */
3970
277k
        is_visible = ((F & 0x4) != 0) || is_3D;
3971
277k
    } else {
3972
        /* Not NoView (bit 6) */
3973
0
        is_visible = (F & 0x20) == 0;
3974
0
    }
3975
3976
401k
 exit:
3977
401k
    return is_visible;
3978
277k
}
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
232k
{
3985
232k
    char **ptr;
3986
3987
    /* True if no list */
3988
232k
    if (!ctx->args.showannottypes)
3989
232k
        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
57.9k
{
4008
57.9k
    char **ptr;
4009
4010
    /* True if no list */
4011
57.9k
    if (!ctx->args.preserveannottypes)
4012
57.9k
        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
401k
{
4028
401k
    pdf_obj *NormAP = NULL;
4029
401k
    int code = 0;
4030
401k
    annot_dispatch_t *dispatch_ptr;
4031
401k
    bool render_done = true;
4032
4033
    /* See if annotation is visible */
4034
401k
    if (!pdfi_annot_visible(ctx, annot, subtype))
4035
168k
        goto exit;
4036
4037
    /* See if we are rendering this type of annotation */
4038
232k
    if (!pdfi_annot_check_type(ctx, subtype))
4039
0
        goto exit;
4040
4041
    /* Get the Normal AP, if it exists */
4042
232k
    code = pdfi_annot_get_NormAP(ctx, annot, &NormAP);
4043
232k
    if (code < 0) goto exit;
4044
4045
179k
    code = pdfi_gsave(ctx);
4046
179k
    if (code < 0) goto exit;
4047
4048
    /* Draw the annotation */
4049
2.63M
    for (dispatch_ptr = annot_dispatch; dispatch_ptr->subtype; dispatch_ptr ++) {
4050
2.63M
        if (pdfi_name_is(subtype, dispatch_ptr->subtype)) {
4051
179k
            if (NormAP && dispatch_ptr->simpleAP)
4052
87.2k
                render_done = false;
4053
92.3k
            else
4054
92.3k
                code = dispatch_ptr->func(ctx, annot, NormAP, &render_done);
4055
179k
            break;
4056
179k
        }
4057
2.63M
    }
4058
179k
    if (!dispatch_ptr->subtype) {
4059
181
        char str[100];
4060
181
        memcpy(str, (const char *)subtype->data, subtype->length < 100 ? subtype->length : 99);
4061
181
        str[subtype->length < 100 ? subtype->length : 99] = '\0';
4062
181
        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
181
        render_done = false;
4066
181
    }
4067
4068
179k
    if (!render_done)
4069
144k
        code = pdfi_annot_draw_AP(ctx, annot, NormAP);
4070
4071
179k
    (void)pdfi_grestore(ctx);
4072
4073
401k
 exit:
4074
401k
    pdfi_countdown(NormAP);
4075
401k
    return code;
4076
179k
}
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
13.5k
{
4086
13.5k
    int size = 40;
4087
13.5k
    char *buf;
4088
13.5k
    gs_id counter = gs_next_ids(ctx->memory, 1);
4089
4090
13.5k
    buf = (char *)gs_alloc_bytes(ctx->memory, size, "pdfi_annot_preserve_nextformlabel(buf)");
4091
13.5k
    if (buf == NULL)
4092
0
        return_error(gs_error_VMerror);
4093
13.5k
    snprintf(buf, size, "{FN%ld}", counter);
4094
13.5k
    *len = strlen(buf);
4095
13.5k
    *data = (byte *)buf;
4096
13.5k
    return 0;
4097
13.5k
}
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
547
{
4114
547
    int code = 0;
4115
547
    pdf_array *QP = NULL;
4116
547
    gx_device *device = gs_currentdevice(ctx->pgs);
4117
547
    gs_matrix devmatrix, ctm, matrix;
4118
547
    uint64_t arraysize, index;
4119
547
    double old_x, old_y;
4120
547
    gs_point point;
4121
4122
547
    code = pdfi_dict_get(ctx, annot, "QuadPoints", (pdf_obj **)&QP);
4123
547
    if (code < 0) goto exit;
4124
4125
547
    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
547
    arraysize = pdfi_array_size(QP);
4134
547
    if (arraysize % 8 != 0) {
4135
        /* TODO: Flag a warning -- must be sets of 8 values (4 points) */
4136
5
        code = gs_note_error(gs_error_syntaxerror);
4137
5
        goto exit;
4138
5
    }
4139
4140
4141
    /* Get device matrix and adjust by default 72.0 (no idea, just following PS code...) */
4142
542
    devmatrix.xx = 72.0 / device->HWResolution[0];
4143
542
    devmatrix.xy = 0;
4144
542
    devmatrix.yx = 0;
4145
542
    devmatrix.yy = 72.0 / device->HWResolution[1];
4146
542
    devmatrix.tx = 0;
4147
542
    devmatrix.ty = 0;
4148
4149
    /* Get the CTM */
4150
542
    gs_currentmatrix(ctx->pgs, &ctm);
4151
4152
    /* Get matrix to adjust the QuadPoints */
4153
542
    code = gs_matrix_multiply(&ctm, &devmatrix, &matrix);
4154
542
    if (code < 0) goto exit;
4155
4156
    /* Transform all the points by the calculated matrix */
4157
5.17k
    for (index = 0; index < arraysize; index += 2) {
4158
4.63k
        code = pdfi_array_get_number(ctx, QP, index, &old_x);
4159
4.63k
        if (code < 0) goto exit;
4160
4.63k
        code = pdfi_array_get_number(ctx, QP, index+1, &old_y);
4161
4.63k
        if (code < 0) goto exit;
4162
4163
4.63k
        code = gs_point_transform(old_x, old_y, &matrix, &point);
4164
4.63k
        if (code < 0) goto exit;
4165
4166
4.63k
        code = pdfi_array_put_real(ctx, QP, index, point.x);
4167
4.63k
        if (code < 0) goto exit;
4168
4.63k
        code = pdfi_array_put_real(ctx, QP, index+1, point.y);
4169
4.63k
        if (code < 0) goto exit;
4170
4.63k
    }
4171
4172
4173
547
 exit:
4174
547
    pdfi_countdown(QP);
4175
547
    return code;
4176
542
}
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
21.9k
{
4184
21.9k
    int code = 0;
4185
21.9k
    pdf_dict *AP = NULL;
4186
21.9k
    uint64_t index;
4187
21.9k
    pdf_name *Key = NULL;
4188
21.9k
    pdf_indirect_ref *Value = NULL;
4189
21.9k
    byte *labeldata = NULL;
4190
21.9k
    int labellen;
4191
21.9k
    int form_id;
4192
21.9k
    gx_device *device = gs_currentdevice(ctx->pgs);
4193
21.9k
    bool found_ap = false; /* found at least one AP stream? */
4194
21.9k
    pdf_obj *object = NULL;
4195
4196
21.9k
    code = pdfi_dict_get(ctx, annot, "AP", (pdf_obj **)&AP);
4197
21.9k
    if (code < 0) goto exit;
4198
4199
21.1k
    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
21.0k
    code = pdfi_dict_key_first(ctx, AP, (pdf_obj **)&Key, &index);
4206
21.0k
    while (code >= 0) {
4207
21.0k
        found_ap = true;
4208
21.0k
        code = pdfi_dict_get_no_deref(ctx, AP, Key, (pdf_obj **)&Value);
4209
21.0k
        if (code < 0) goto exit;
4210
4211
        /* Handle indirect object */
4212
21.0k
        if (pdfi_type_of(Value) != PDF_INDIRECT)
4213
10
            goto loop_continue;
4214
4215
        /* Dereference it */
4216
21.0k
        code = pdfi_dereference(ctx, Value->ref_object_num, Value->ref_generation_num, &object);
4217
21.0k
        if (code < 0) goto exit;
4218
4219
13.6k
        if (pdfi_type_of(object) == PDF_STREAM) {
4220
            /* Get a form label */
4221
13.5k
            code = pdfi_annot_preserve_nextformlabel(ctx, &labeldata, &labellen);
4222
13.5k
            if (code < 0) goto exit;
4223
4224
            /* Notify the driver of the label name */
4225
13.5k
            code = (*dev_proc(device, dev_spec_op))
4226
13.5k
                (device, gxdso_pdf_form_name, labeldata, labellen);
4227
4228
13.5k
            code = pdfi_op_q(ctx);
4229
13.5k
            if (code < 0)
4230
0
                goto exit;
4231
4232
13.5k
            code = pdfi_annot_position_AP(ctx, annot, (pdf_stream *)object);
4233
            /* Draw the high-level form */
4234
13.5k
            code = pdfi_do_highlevel_form(ctx, ctx->page.CurrentPageDict, (pdf_stream *)object);
4235
13.5k
            (void)pdfi_op_Q(ctx);
4236
13.5k
            if (code < 0) goto exit;
4237
4238
            /* Get the object number (form_id) of the high level form */
4239
13.5k
            code = (*dev_proc(device, dev_spec_op))
4240
13.5k
                (device, gxdso_get_form_ID, &form_id, sizeof(int));
4241
4242
            /* Save the highlevel form info for pdfi_obj_indirect_str() */
4243
13.5k
            Value->highlevel_object_num = form_id;
4244
13.5k
            Value->is_highlevelform = true;
4245
4246
13.5k
        }
4247
4248
13.6k
    loop_continue:
4249
13.6k
        pdfi_countdown(Key);
4250
13.6k
        Key = NULL;
4251
13.6k
        pdfi_countdown(Value);
4252
13.6k
        Value = NULL;
4253
13.6k
        pdfi_countdown(object);
4254
13.6k
        object = NULL;
4255
13.6k
        gs_free_object(ctx->memory, labeldata, "pdfi_annot_preserve_modAP(labeldata)");
4256
13.6k
        labeldata = NULL;
4257
4258
13.6k
        code = pdfi_dict_key_next(ctx, AP, (pdf_obj **)&Key, &index);
4259
13.6k
        if (code == gs_error_undefined) {
4260
13.6k
            code = 0;
4261
13.6k
            break;
4262
13.6k
        }
4263
13.6k
    }
4264
13.6k
    if (code < 0) goto exit;
4265
4266
21.9k
 exit:
4267
    /* If there was no AP found, then delete the key completely.
4268
     * (Bug697951.pdf)
4269
     */
4270
21.9k
    if (!found_ap) {
4271
        /* TODO: Flag a warning for broken file? */
4272
904
        code = pdfi_dict_delete_pair(ctx, annot, AP_key);
4273
904
    }
4274
4275
21.9k
    if (labeldata)
4276
2
        gs_free_object(ctx->memory, labeldata, "pdfi_annot_preserve_modAP(labeldata)");
4277
21.9k
    pdfi_countdown(AP);
4278
21.9k
    pdfi_countdown(Key);
4279
21.9k
    pdfi_countdown(Value);
4280
21.9k
    pdfi_countdown(object);
4281
21.9k
    return code;
4282
13.6k
}
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
377k
{
4389
377k
    int i = 0;
4390
4391
6.75M
    for (i = 0; i < sizeof(PermittedKeys) / sizeof (const char *); i++) {
4392
6.70M
        if (pdfi_name_is(Key, PermittedKeys[i]))
4393
327k
            return 1;
4394
6.70M
    }
4395
49.4k
    return 0;
4396
377k
}
4397
4398
static int pdfi_annot_preserve_mark(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4399
50.4k
{
4400
50.4k
    int code = 0;
4401
50.4k
    gs_matrix ctm;
4402
50.4k
    pdf_dict *tempdict = NULL;
4403
50.4k
    uint64_t dictsize;
4404
50.4k
    uint64_t index;
4405
50.4k
    pdf_name *Key = NULL;
4406
50.4k
    pdf_obj *Value = NULL;
4407
50.4k
    bool resolve = false;
4408
4409
    /* Create a temporary copy of the annot dict */
4410
50.4k
    dictsize = pdfi_dict_entries(annot);
4411
50.4k
    code = pdfi_dict_alloc(ctx, dictsize, &tempdict);
4412
50.4k
    if (code < 0) goto exit;
4413
50.4k
    pdfi_countup(tempdict);
4414
50.4k
    code = pdfi_dict_copy(ctx, tempdict, annot);
4415
50.4k
    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
50.4k
    code = pdfi_dict_key_first(ctx, annot, (pdf_obj **)&Key, &index);
4424
377k
    while (code >= 0) {
4425
377k
        resolve = false;
4426
4427
377k
        if (!isKnownKey(ctx, Key)) {
4428
49.4k
            code = pdfi_dict_delete_pair(ctx, tempdict, Key);
4429
49.4k
            if (code < 0) goto exit;
4430
327k
        } else {
4431
327k
            if (pdfi_name_is(Key, "AP")) {
4432
                /* Special handling for AP -- have fun! */
4433
21.9k
                code = pdfi_annot_preserve_modAP(ctx, tempdict, Key);
4434
21.9k
                if (code < 0) goto exit;
4435
305k
            } else if (pdfi_name_is(Key, "QuadPoints")) {
4436
547
                code = pdfi_annot_preserve_modQP(ctx, tempdict, Key);
4437
547
                if (code < 0) goto exit;
4438
305k
            } else if (pdfi_name_is(Key, "A")) {
4439
7.26k
                code = pdfi_pdfmark_modA(ctx, tempdict);
4440
7.26k
                if (code < 0) goto exit;
4441
298k
            } else if (pdfi_name_is(Key, "Dest")) {
4442
18
                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
18
                code = pdfi_pdfmark_modDest(ctx, tempdict);
4448
18
                if (code < 0) goto exit;
4449
298k
            } 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
298k
            } else if (pdfi_name_is(Key, "Sound") || pdfi_name_is(Key, "Movie")) {
4460
0
                resolve = false;
4461
298k
            } else {
4462
298k
                resolve = true;
4463
298k
            }
4464
327k
        }
4465
369k
        if (resolve) {
4466
298k
            code = pdfi_dict_get_by_key(ctx, annot, (const pdf_name *)Key, &Value);
4467
298k
            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
298k
            code = pdfi_resolve_indirect_loop_detect(ctx, (pdf_obj *)annot, Value, false);
4476
298k
            if (code < 0) goto exit;
4477
298k
        }
4478
4479
369k
        pdfi_countdown(Key);
4480
369k
        Key = NULL;
4481
369k
        pdfi_countdown(Value);
4482
369k
        Value = NULL;
4483
4484
369k
        code = pdfi_dict_key_next(ctx, annot, (pdf_obj **)&Key, &index);
4485
369k
        if (code == gs_error_undefined) {
4486
42.3k
            code = 0;
4487
42.3k
            break;
4488
42.3k
        }
4489
369k
    }
4490
42.3k
    if (code < 0) goto exit;
4491
4492
    /* Do pdfmark from the tempdict */
4493
42.3k
    gs_currentmatrix(ctx->pgs, &ctm);
4494
4495
42.3k
    if (pdfi_name_is(subtype, "Link"))
4496
6.62k
        code = pdfi_pdfmark_from_dict(ctx, tempdict, &ctm, "LNK");
4497
35.7k
    else
4498
35.7k
        code = pdfi_pdfmark_from_dict(ctx, tempdict, &ctm, "ANN");
4499
42.3k
    if (code < 0) goto exit;
4500
4501
50.4k
 exit:
4502
50.4k
    pdfi_countdown(tempdict);
4503
50.4k
    pdfi_countdown(Key);
4504
50.4k
    pdfi_countdown(Value);
4505
50.4k
    return code;
4506
42.3k
}
4507
4508
static int pdfi_annot_preserve_default(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4509
43.1k
{
4510
43.1k
    return pdfi_annot_preserve_mark(ctx, annot, subtype);
4511
43.1k
}
4512
4513
static int pdfi_annot_preserve_Link(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4514
7.28k
{
4515
7.28k
    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
7.28k
    code = pdfi_annot_preserve_mark(ctx, annot, subtype);
4522
7.28k
    return code;
4523
7.28k
}
4524
4525
static int pdfi_annot_preserve_Widget(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4526
7.40k
{
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
7.40k
    return pdfi_annot_draw(ctx, annot, subtype);
4537
7.40k
}
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
    {"Sound", pdfi_annot_preserve_default},
4556
    {"Square", pdfi_annot_preserve_default},
4557
    {"Squiggly", pdfi_annot_preserve_default},
4558
    {"StrikeOut", pdfi_annot_preserve_default},
4559
    {"Underline", pdfi_annot_preserve_default},
4560
    {"Stamp", pdfi_annot_preserve_default},
4561
    {"Text", pdfi_annot_preserve_default},
4562
    {"TrapNet", pdfi_annot_preserve_default},
4563
    { NULL, NULL},
4564
};
4565
4566
static int pdfi_annot_preserve(pdf_context *ctx, pdf_dict *annot, pdf_name *subtype)
4567
57.9k
{
4568
57.9k
    int code = 0;
4569
57.9k
    annot_preserve_dispatch_t *dispatch_ptr;
4570
4571
    /* If not preserving this subtype, draw it instead */
4572
57.9k
    if (!pdfi_annot_preserve_type(ctx, subtype))
4573
0
        return pdfi_annot_draw(ctx, annot, subtype);
4574
4575
    /* Handle the annotation */
4576
532k
    for (dispatch_ptr = annot_preserve_dispatch; dispatch_ptr->subtype; dispatch_ptr ++) {
4577
532k
        if (pdfi_name_is(subtype, dispatch_ptr->subtype)) {
4578
57.8k
            code = dispatch_ptr->func(ctx, annot, subtype);
4579
57.8k
            break;
4580
57.8k
        }
4581
532k
    }
4582
4583
    /* If there is no handler, just draw it */
4584
    /* NOTE: gs does a drawwidget here instead (?) */
4585
57.9k
    if (!dispatch_ptr->subtype)
4586
92
        code = pdfi_annot_draw(ctx, annot, subtype);
4587
4588
57.9k
    return code;
4589
57.9k
}
4590
4591
static int pdfi_annot_handle(pdf_context *ctx, pdf_dict *annot)
4592
452k
{
4593
452k
    int code = 0;
4594
452k
    pdf_name *Subtype = NULL;
4595
4596
452k
    code = pdfi_dict_get_type(ctx, annot, "Subtype", PDF_NAME, (pdf_obj **)&Subtype);
4597
452k
    if (code != 0) {
4598
        /* TODO: Set warning flag */
4599
995
        dbgmprintf(ctx->memory, "WARNING: Ignoring annotation with missing Subtype\n");
4600
995
        code = 0;
4601
995
        goto exit;
4602
995
    }
4603
4604
451k
    if (ctx->args.preserveannots && ctx->device_state.annotations_preserved)
4605
57.9k
        code = pdfi_annot_preserve(ctx, annot, Subtype);
4606
393k
    else
4607
393k
        code = pdfi_annot_draw(ctx, annot, Subtype);
4608
4609
452k
 exit:
4610
452k
    pdfi_countdown(Subtype);
4611
452k
    if (code < 0) {
4612
67.2k
        code = pdfi_set_error_stop(ctx, code, NULL, E_PDF_BAD_ANNOTATION, "pdfi_annot_handle", "Error handling annotation");
4613
67.2k
    }
4614
452k
    return code;
4615
451k
}
4616
4617
int pdfi_do_annotations(pdf_context *ctx, pdf_dict *page_dict)
4618
104k
{
4619
104k
    int code = 0;
4620
104k
    pdf_array *Annots = NULL;
4621
104k
    pdf_dict *annot = NULL;
4622
104k
    int i;
4623
4624
104k
    if (!ctx->args.showannots)
4625
0
        return 0;
4626
4627
104k
    code = pdfi_dict_knownget_type(ctx, page_dict, "Annots", PDF_ARRAY, (pdf_obj **)&Annots);
4628
104k
    if (code <= 0)
4629
79.0k
        return code;
4630
4631
554k
    for (i = 0; i < pdfi_array_size(Annots); i++) {
4632
528k
        code = pdfi_array_get_type(ctx, Annots, i, PDF_DICT, (pdf_obj **)&annot);
4633
528k
        if (code < 0) {
4634
76.0k
            if ((code = pdfi_set_warning_stop(ctx, code, NULL, W_PDF_ANNOT_BAD_TYPE, "pdfi_do_annotations", "")) < 0)
4635
0
                goto exit;
4636
76.0k
            continue;
4637
76.0k
        }
4638
452k
        code = pdfi_annot_handle(ctx, annot);
4639
452k
        if (code < 0 &&
4640
2
           ((code = pdfi_set_error_stop(ctx, code, NULL, E_PDF_BAD_ANNOTATION, "pdfi_annot_handle", "Error handling annotation")) < 0)) {
4641
2
            goto exit;
4642
2
        }
4643
452k
        pdfi_countdown(annot);
4644
452k
        annot = NULL;
4645
452k
    }
4646
4647
25.5k
 exit:
4648
25.5k
    pdfi_countdown(annot);
4649
25.5k
    pdfi_countdown(Annots);
4650
25.5k
    return code;
4651
25.5k
}
4652
4653
/* draw terminal field */
4654
static int pdfi_form_draw_terminal(pdf_context *ctx, pdf_dict *Page, pdf_dict *field)
4655
0
{
4656
0
    int code = 0;
4657
0
    pdf_indirect_ref *P = NULL;
4658
0
    pdf_name *FT = NULL;
4659
0
    pdf_obj *AP = NULL;
4660
4661
    /* See if the field goes on this page */
4662
    /* NOTE: We know the "P" is an indirect ref, so just fetch it that way.
4663
     * If we fetch the actual object, it will result in a cyclical reference in the cache
4664
     * that causes a memory leak, so don't do that.
4665
     * (The cyclical reference is because the object containing P is actually inside P)
4666
     */
4667
0
    code = pdfi_dict_get_ref(ctx, field, "P", &P);
4668
0
    if (code < 0) {
4669
0
        if (code == gs_error_undefined)
4670
0
            code = 0;
4671
0
        goto exit;
4672
0
    }
4673
4674
0
    if (P->ref_object_num != Page->object_num) {
4675
        /* Not this page */
4676
0
        code = 0;
4677
0
        goto exit;
4678
0
    }
4679
4680
    /* Render the field */
4681
4682
    /* NOTE: The spec says the FT is inheritable, implying it might be present in
4683
     * a Parent and not explicitly in a Child.  The gs implementation doesn't seem
4684
     * to handle this case, but I am going to go ahead and handle it.  We will figure
4685
     * out if this causes diffs later, if ever...
4686
     */
4687
0
    code = pdfi_form_get_inheritable(ctx, field, "FT", PDF_NAME, (pdf_obj **)&FT);
4688
0
    if (code <= 0) goto exit;
4689
4690
0
    code = pdfi_annot_get_NormAP(ctx, field, &AP);
4691
0
    if (code < 0) goto exit;
4692
4693
0
    code = pdfi_annot_render_field(ctx, field, FT, AP);
4694
0
    if (code < 0) goto exit;
4695
4696
0
 exit:
4697
0
    pdfi_countdown(FT);
4698
0
    pdfi_countdown(P);
4699
0
    pdfi_countdown(AP);
4700
0
    return code;
4701
0
}
4702
4703
/* From pdf_draw.ps/draw_form_field():
4704
% We distinguish 4 types of nodes on the form field tree:
4705
%  - non-terminal field - has a kid that refers to the parent (or anywhere else)
4706
%  - terminal field with separate widget annotations - has a kid that doesn't have a parent
4707
%  - terminal field with a merged widget annotation - has no kids
4708
%  - widget annotation - has /Subtype and /Rect
4709
%
4710
% The recursive enumeration of the form fields doesn't descend into widget annotations.
4711
*/
4712
static int pdfi_form_draw_field(pdf_context *ctx, pdf_dict *Page, pdf_dict *field)
4713
0
{
4714
0
    int code = 0;
4715
0
    pdf_array *Kids = NULL;
4716
0
    pdf_dict *child = NULL;
4717
0
    pdf_dict *Parent = NULL;
4718
0
    int i;
4719
4720
0
    code = pdfi_dict_knownget_type(ctx, field, "Kids", PDF_ARRAY, (pdf_obj **)&Kids);
4721
0
    if (code < 0) goto exit;
4722
0
    if (code == 0) {
4723
0
        code = pdfi_form_draw_terminal(ctx, Page, field);
4724
0
        goto exit;
4725
0
    }
4726
4727
    /* Handle Kids */
4728
0
    if (pdfi_array_size(Kids) <= 0) {
4729
0
        code = pdfi_set_error_stop(ctx, gs_note_error(gs_error_undefined), NULL, E_PDF_EMPTY_FORM_KIDS, "pdfi_form_draw_field", "");
4730
0
        goto exit;
4731
0
    }
4732
4733
    /* Check first child to see if it has a parent */
4734
0
    code = pdfi_array_get_type(ctx, Kids, 0, PDF_DICT, (pdf_obj **)&child);
4735
0
    if (code < 0) goto exit;
4736
0
    code = pdfi_dict_knownget_type(ctx, child, "Parent", PDF_DICT, (pdf_obj **)&Parent);
4737
0
    if (code < 0) goto exit;
4738
4739
    /* If kid has no parent, then treat this as terminal field */
4740
0
    if (code == 0) {
4741
        /* TODO: This case isn't tested because no examples available.
4742
         * I think it's only relevant for Btn, and not sure if it
4743
         * should be dealt with here or in Btn routine.
4744
         */
4745
0
        code = pdfi_form_draw_terminal(ctx, Page, field);
4746
0
        goto exit;
4747
0
    }
4748
4749
0
    pdfi_countdown(child);
4750
0
    child = NULL;
4751
    /* Render the Kids (recursive) */
4752
0
    for (i=0; i<pdfi_array_size(Kids); i++) {
4753
0
        code = pdfi_array_get_type(ctx, Kids, i, PDF_DICT, (pdf_obj **)&child);
4754
0
        if (code < 0) goto exit;
4755
4756
0
        code = pdfi_form_draw_field(ctx, Page, child);
4757
0
        if (code < 0) goto exit;
4758
4759
0
        pdfi_countdown(child);
4760
0
        child = NULL;
4761
0
    }
4762
4763
0
 exit:
4764
0
    pdfi_countdown(child);
4765
0
    pdfi_countdown(Kids);
4766
0
    pdfi_countdown(Parent);
4767
0
    return code;
4768
0
}
4769
4770
int pdfi_do_acroform(pdf_context *ctx, pdf_dict *page_dict)
4771
104k
{
4772
104k
    int code = 0;
4773
104k
    pdf_array *Fields = NULL;
4774
104k
    pdf_dict *field = NULL;
4775
104k
    int i;
4776
4777
104k
    if (!ctx->args.showacroform)
4778
104k
        return 0;
4779
4780
0
    if (!ctx->AcroForm)
4781
0
        return 0;
4782
4783
0
    code = pdfi_dict_knownget_type(ctx, ctx->AcroForm, "Fields", PDF_ARRAY, (pdf_obj **)&Fields);
4784
0
    if (code <= 0)
4785
0
        goto exit;
4786
4787
0
    for (i=0; i<pdfi_array_size(Fields); i++) {
4788
0
        code = pdfi_array_get_type(ctx, Fields, i, PDF_DICT, (pdf_obj **)&field);
4789
0
        if (code < 0)
4790
0
            continue;
4791
0
        code = pdfi_form_draw_field(ctx, page_dict, field);
4792
0
        if (code < 0)
4793
0
            goto exit;
4794
0
        pdfi_countdown(field);
4795
0
        field = NULL;
4796
0
    }
4797
4798
0
 exit:
4799
0
    pdfi_countdown(field);
4800
0
    pdfi_countdown(Fields);
4801
0
    return code;
4802
0
}