summaryrefslogtreecommitdiff
path: root/pcl/pxl/pxsessio.c
blob: 7e648103e17f462892c3089e993de4c9e96e9db9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
/* Copyright (C) 2001-2012 Artifex Software, Inc.
   All Rights Reserved.

   This software is provided AS-IS with no warranty, either express or
   implied.

   This software is distributed under license and may not be copied,
   modified or distributed except as expressly authorized under the terms
   of the license contained in the file LICENSE in this distribution.

   Refer to licensing information at http://www.artifex.com or contact
   Artifex Software, Inc.,  7 Mt. Lassen Drive - Suite A-134, San Rafael,
   CA  94903, U.S.A., +1(415)492-9861, for further information.
*/


/* pxsessio.c */
/* PCL XL session operators */

#include "math_.h"              /* for fabs */
#include "stdio_.h"
#include "string_.h"
#include "pxoper.h"
#include "pxpthr.h"
#include "pxstate.h"
#include "pxfont.h"
#include "pjparse.h"
#include "gschar.h"
#include "gscoord.h"
#include "gserrors.h"           /* for gs_error_undefined */
#include "gspaint.h"
#include "gsparam.h"
#include "gsstate.h"
#include "gxfixed.h"
#include "gxpath.h"             /* for gx_clip_to_rectangle */
#include "gxdcolor.h"
#include "gxpcolor.h"
#include "gxfcache.h"
#include "gxdevice.h"
#include "gxstate.h"
#include "pjtop.h"
#include "pllfont.h"
#include "pxptable.h"
#include "pxvendor.h"
#include "gzstate.h"

/* Imported operators */
px_operator_proc(pxCloseDataSource);
px_operator_proc(pxNewPath);
px_operator_proc(pxPopGS);
px_operator_proc(pxPushGS);
px_operator_proc(pxSetHalftoneMethod);
px_operator_proc(pxSetPageDefaultCTM);

/*
 * Define the known paper sizes and unprintable margins.  For convenience,
 * we define this in terms of 300 dpi pixels, in portrait orientation.  This
 * table should obviously be device-dependent.
 */
#define media_size_scale (72.0 / 300.0)
#define m_default 50, 50, 50, 50
#define m_data(ms_enum, mstr, res, width, height)                        \
    {ms_enum, mstr, width * 300 / (res), height * 300 / (res), m_default},
static px_media_t known_media[] = {
    px_enumerate_media(m_data)
};
#undef m_data
#undef m_default

/* Define the mapping from the Measure enumeration to points. */
static const double measure_to_points[] = pxeMeasure_to_points;

/* ---------------- Internal procedures ---------------- */

/* system paper size string (same as pjl paper size) to pxl enumeration type */
static pxeMediaSize_t
px_paper_string_to_media(pjl_envvar_t * paper_str)
{
    /* table to map pjl paper type strings to pxl enums */
    int i;

    for (i = 0; i < countof(known_media); i++) {
        if (!pjl_compare(paper_str, known_media[i].mname))
            return known_media[i].ms_enum;
    }
    /* not found return letter */
    return eLetterPaper;
}

/* return the default media set up in the XL state */
static px_media_t *
px_get_default_media(px_state_t * pxs)
{
    int i;

    for (i = 0; i < countof(known_media); i++)
        if (known_media[i].ms_enum == pxs->media_size)
            return &known_media[i];
    /* shouldn't get here but just in case we return letter. */
    return &known_media[1];
}

void
px_get_default_media_size(px_state_t * pxs, gs_point * pt)
{
    px_media_t *media = px_get_default_media(pxs);

    pt->x = media->width * media_size_scale;
    pt->y = media->height * media_size_scale;
}

/* Finish putting one device parameter. */
static int
px_put1(gx_device * dev, gs_c_param_list * plist, int ecode)
{
    int code = ecode;

    if (code >= 0) {
        gs_c_param_list_read(plist);
        code = gs_putdeviceparams(dev, (gs_param_list *) plist);
    }
    gs_c_param_list_release(plist);
    return (code == 0 || code == gs_error_undefined ? ecode : code);
}

/* Adjust one scale factor to an integral value if we can. */
static double
px_adjust_scale(double value, double extent)
{
    /* If we can make the value an integer with a total error */
    /* of less than 1/2 pixel over the entire page, we do it. */
    double int_value = floor(value + 0.5);

    return (fabs((int_value - value) * extent) < 0.5 ? int_value : value);
}

/* Clean up at the end of a page, but before rendering. */
static void
px_end_page_cleanup(px_state_t * pxs)
{
    px_dict_release(&pxs->page_pattern_dict);
    /* Clean up stray gstate information. */
    while (pxs->pxgs->stack_depth > 0)
        pxPopGS(NULL, pxs);
    /* Pop an extra time to mirror the push in BeginPage. */
    pxs->pxgs->stack_depth++;
    pxPopGS(NULL, pxs);
    pxNewPath(NULL, pxs);
    px_purge_pattern_cache(pxs, ePagePattern);
    pxpcl_pagestatereset();
}

/* Purge all */
static bool
purge_all(const gs_memory_t * mem, cached_char * cc, void *dummy)
{
    return true;
}

/* clears the entire cache */
/* Clean up at the end of a session. */
static void
px_end_session_cleanup(px_state_t * pxs)
{
    if (pxs->data_source_open)
        pxCloseDataSource(NULL, pxs);
    px_purge_character_cache(pxs);
    px_dict_release(&pxs->session_pattern_dict);
    if (gstate_pattern_cache(pxs->pgs)) {
        (gstate_pattern_cache(pxs->pgs)->free_all)
            (gstate_pattern_cache(pxs->pgs));
        gs_free_object(pxs->memory,
                       gstate_pattern_cache(pxs->pgs)->tiles,
                       "px_end_session_cleanup(tiles)");
        gs_free_object(pxs->memory,
                       gstate_pattern_cache(pxs->pgs),
                       "px_end_session_cleanup(struct)");
        {
            gs_gstate *pgs = pxs->pgs;

            while (pgs) {
                gstate_set_pattern_cache(pgs, 0);
                pgs = gs_gstate_saved(pgs);
            }
        }
    }
    /* We believe that streams do *not* persist across sessions.... */
    px_dict_release(&pxs->stream_dict);
    /* delete downloaded fonts on end of session */
    px_dict_release(&pxs->font_dict);
    pxpcl_release();
}

/* ---------------- Non-operator procedures ---------------- */

/* Clean up after an error or UEL. */
void
px_state_cleanup(px_state_t * pxs)
{
    px_end_page_cleanup(pxs);
    px_end_session_cleanup(pxs);
    pxs->have_page = false;
}

void
px_purge_character_cache(px_state_t * pxs)
{
    gx_purge_selected_cached_chars(pxs->font_dir, purge_all, pxs);
}

/* ---------------- Operators ---------------- */

const byte apxBeginSession[] = {
    pxaMeasure, pxaUnitsPerMeasure, 0,
    pxaErrorReport, 0
};
int
pxBeginSession(px_args_t * par, px_state_t * pxs)
{
    pxs->measure = par->pv[0]->value.i;
    pxs->units_per_measure.x = real_value(par->pv[1], 0);
    pxs->units_per_measure.y = real_value(par->pv[1], 1);

    pxs->stream_level = 0;

    if (par->pv[2])
        pxs->error_report = par->pv[2]->value.i;
    else
        pxs->error_report = eNoReporting;
    px_dict_init(&pxs->session_pattern_dict, pxs->memory, px_free_pattern);
    /* Set media parameters to device defaults, in case BeginPage */
    /* doesn't specify valid ones. */
    /* This is obviously device-dependent. */
    /* get the pjl state */
    {
        pjl_envvar_t *pjl_psize = pjl_proc_get_envvar(pxs->pjls, "paper");

        /* NB.  We are not sure about the interaction of pjl's
           wide a4 commands so we don't attempt to implement
           it. */
        /* bool pjl_widea4
           = pjl_proc_compare(pxs->pjls, pjl_proc_get_envvar(pxs->pjls, "widea4"), "no"); */
        int pjl_copies
            =
            pjl_proc_vartoi(pxs->pjls,
                            pjl_proc_get_envvar(pxs->pjls, "copies"));
        bool pjl_duplex =
            pjl_proc_compare(pxs->pjls,
                             pjl_proc_get_envvar(pxs->pjls, "duplex"), "off");
        bool pjl_bindshort =
            pjl_proc_compare(pxs->pjls,
                             pjl_proc_get_envvar(pxs->pjls, "binding"),
                             "longedge");
        bool pjl_manualfeed =
            pjl_proc_compare(pxs->pjls,
                             pjl_proc_get_envvar(pxs->pjls, "manualfeed"),
                             "off");
        pxs->media_size = px_paper_string_to_media(pjl_psize);
        pxs->media_source = (pjl_manualfeed ? eManualFeed : eDefaultSource);
        pxs->duplex = pjl_duplex;
        pxs->duplex_page_mode = (pjl_bindshort ? eDuplexHorizontalBinding :
                                 eDuplexVerticalBinding);
        pxs->duplex_back_side = eFrontMediaSide;
        pxs->copies = pjl_copies;
        pxs->media_destination = eDefaultDestination;
        pxs->media_type = eDefaultType;

        if (!pjl_proc_compare
            (pxs->pjls, pjl_proc_get_envvar(pxs->pjls, "orientation"),
             "LANDSCAPE"))
            pxs->orientation = eLandscapeOrientation;
        if (!pjl_proc_compare
            (pxs->pjls, pjl_proc_get_envvar(pxs->pjls, "orientation"),
             "PORTRAIT"))
            pxs->orientation = ePortraitOrientation;
        /* NB reverse orientations missing */

        /* install the built in fonts */
        if (pl_load_built_in_fonts
            (pjl_proc_fontsource_to_path(pxs->pjls, "I"), pxs->memory,
             &pxs->builtin_font_dict, pxs->font_dir, (int)pxfsInternal,
             true /* use unicode key names */ ) < 0) {
            dmprintf(pxs->memory, "Fatal error - no resident fonts\n");
            return -1;

        }
    }
    return 0;
}

const byte apxEndSession[] = { 0, 0 };
int
pxEndSession(px_args_t * par, px_state_t * pxs)
{
    px_end_session_cleanup(pxs);
    if (pxs->warning_length)
        return_error(errorWarningsReported);
    return 0;
}

const byte apxBeginPage[] = {
    0, pxaOrientation,
    pxaMediaSource, pxaMediaSize, pxaCustomMediaSize, pxaCustomMediaSizeUnits,
    pxaSimplexPageMode, pxaDuplexPageMode, pxaDuplexPageSide,
    pxaMediaDestination, pxaMediaType, pxaPrintableArea, 0
};
int
pxBeginPage(px_args_t * par, px_state_t * pxs)
{
    gs_gstate *pgs = pxs->pgs;
    gx_device *dev = gs_currentdevice(pgs);
    gs_point page_size_pixels;
    gs_matrix points2device;
    bool no_pv_2 = false;

    /* check for 2.1 no parameter special cases */
    {
        int i;
        bool have_params = false;

        for (i = (par->pv[0] == 0 ? 0 : 1);
             i < sizeof(par->pv) / sizeof(par->pv[0]); i++) {
            if (par->pv[i]) {
                have_params = true;
                break;
            }
        }
        if (have_params == false) {
            if (par->pv[0]) {
                int32_t orientation = par->pv[0]->value.i;

                if (orientation < 0 || orientation >= pxeOrientation_next) {
                    px_record_warning("IllegalOrientation", true, pxs);
                    orientation = ePortraitOrientation;
                }
                pxs->orientation = (pxeOrientation_t) orientation;
            }
            goto setd;
        }
    }
    /* Check parameter presence for legal combinations. */
    if (par->pv[2]) {
        if (par->pv[3] || par->pv[4])
            return_error(errorIllegalAttributeCombination);
    } else if (par->pv[3] && par->pv[4]) {
        if (par->pv[2])
            return_error(errorIllegalAttributeCombination);
    } else {
        pxs->pm = px_get_default_media(pxs);
        no_pv_2 = true;
    }
    if (par->pv[5]) {
        if (par->pv[6] || par->pv[7])
            return_error(errorIllegalAttributeCombination);
    } else if (par->pv[6]) {
        if (par->pv[5])
            return_error(errorIllegalAttributeCombination);
    }

    /* Copy parameters to the PCL XL state. */
    /* For some reason, invalid Orientations only produces a warning. */
    if (par->pv[0]) {
        int32_t orientation = par->pv[0]->value.i;

        if (orientation < 0 || orientation >= pxeOrientation_next) {
            px_record_warning("IllegalOrientation", true, pxs);
            orientation = ePortraitOrientation;
        }
        pxs->orientation = (pxeOrientation_t) orientation;
    }

    if (par->pv[1])
        pxs->media_source = par->pv[1]->value.i;
    if (par->pv[2]) {
        /* default to letter */
        pxeMediaSize_t ms_enum = eLetterPaper;
        int i;

        /* could be an array or enumeration */
        if (par->pv[2]->type & pxd_array) {
            /* it's an array, so convert it to the associated
               enumeration */
            byte *str = gs_alloc_string(pxs->memory,
                                        array_value_size(par->pv[2]) + 1,
                                        "pxBeginPage");

            if (str == 0)
                return_error(errorInsufficientMemory);
            /* null terminate */
            memcpy(str, par->pv[2]->value.array.data,
                   array_value_size(par->pv[2]));
            str[array_value_size(par->pv[2])] = '\0';
            ms_enum =
                px_paper_string_to_media( /* NB */ (pjl_envvar_t *) str);
            gs_free_string(pxs->memory, str, array_value_size(par->pv[2]) + 1,
                           "pxBeginPage");

        } else if (par->pv[2]->value.i) {       /* it's an enumeration */
            ms_enum = par->pv[2]->value.i;
        }
        if (ms_enum == eDefaultPaperSize) {
            pxs->pm = px_get_default_media(pxs);
        } else {
            bool found_media = false;

            for (pxs->pm = known_media, i = 0; i < countof(known_media);
                 ++pxs->pm, ++i)
                if (pxs->pm->ms_enum == ms_enum) {
                    found_media = true;
                    break;
                }
            if (!found_media) { /* No match, select default media. */
                pxs->pm = px_get_default_media(pxs);
                px_record_warning("IllegalMediaSize", false, pxs);
            }
        }
      media:pxs->media_size = pxs->pm->ms_enum;
        pxs->media_dims.x = pxs->pm->width * media_size_scale;
        pxs->media_dims.y = pxs->pm->height * media_size_scale;
        pxs->media_height = pxs->pm->height;
        pxs->media_width = pxs->pm->width;
    } else if (no_pv_2) {
        goto media;
    } else {                    /* custom (!par->pv[2]) */
        double scale = measure_to_points[par->pv[4]->value.i];

        pxs->media_dims.x = real_value(par->pv[3], 0) * scale;
        pxs->media_dims.y = real_value(par->pv[3], 1) * scale;
        /*
         * Assume the unprintable margins for custom media are the same
         * as for the default media.  This may not be right.
         */
        pxs->pm = px_get_default_media(pxs);
        pxs->media_height = (short)(pxs->media_dims.y / media_size_scale);
        pxs->media_width = (short)(pxs->media_dims.x / media_size_scale);
    }
    if (par->pv[5]) {
        pxs->duplex = false;
    } else if (par->pv[6]) {
        pxs->duplex = true;
        pxs->duplex_page_mode = par->pv[6]->value.i;
        if (par->pv[7])
            pxs->duplex_back_side = (par->pv[7]->value.i == eBackMediaSide);
    }
    if (par->pv[8])
        pxs->media_destination = par->pv[8]->value.i;
    if (par->pv[9])
        pxs->media_type = par->pv[9]->value.i;

    /* Pass the media parameters to the device. */
  setd:{
        gs_memory_t *mem = pxs->memory;
        gs_c_param_list list;
#define plist ((gs_param_list *)&list)
        gs_param_float_array fa;
        float fv[4];
        int iv;
        bool bv;
        int ecode = 0;
        int code;

        fa.data = fv;
        fa.persistent = false;

        gs_c_param_list_write(&list, mem);
        iv = pxs->orientation;  /* might not be an int */
        param_write_int(plist, "Orientation", &iv);
        ecode = px_put1(dev, &list, ecode);

        gs_c_param_list_write(&list, mem);
        fv[0] = pxs->media_dims.x;
        fv[1] = pxs->media_dims.y;
        fa.size = 2;
        param_write_float_array(plist, ".MediaSize", &fa);
        ecode = px_put1(dev, &list, ecode);
        gs_c_param_list_write(&list, mem);

        iv = pxs->media_source; /* might not be an int */
        if (iv < 0 || iv >= pxeMediaSource_next)
            px_record_warning("IllegalMediaSource", false, pxs);
        else {
            gs_c_param_list_write(&list, mem);
            param_write_int(plist, ".MediaSource", &iv);
            ecode = px_put1(dev, &list, ecode);
        }

        gs_c_param_list_write(&list, mem);
        param_write_bool(plist, "Duplex", &pxs->duplex);
        ecode = px_put1(dev, &list, ecode);

        gs_c_param_list_write(&list, mem);
        bv = pxs->duplex_page_mode == eDuplexHorizontalBinding;
        param_write_bool(plist, "Tumble", &bv);
        ecode = px_put1(dev, &list, ecode);

        gs_c_param_list_write(&list, mem);
        bv = !pxs->duplex_back_side;
        param_write_bool(plist, "FirstSide", &bv);
        ecode = px_put1(dev, &list, ecode);

        gs_c_param_list_write(&list, mem);
        iv = pxs->media_destination;    /* might not be an int */
        param_write_int(plist, ".MediaDestination", &iv);
        ecode = px_put1(dev, &list, ecode);

        gs_c_param_list_write(&list, mem);
        iv = pxs->media_type;   /* might not be an int */
        param_write_int(plist, ".MediaType", &iv);
        ecode = px_put1(dev, &list, ecode);

        /*
         * We aren't sure what to do if the device rejects the parameter
         * value....
         */
        switch (ecode) {
            case 1:
                code = gs_setdevice(pgs, dev);
                if (code < 0)
                    return code;
            case 0:
                break;
            default:
                return_error(errorIllegalAttributeValue);
        }
#undef plist
    }
    {
        int code;

        px_initgraphics(pxs);
        gs_currentmatrix(pgs, &points2device);
        gs_dtransform(pgs, pxs->media_dims.x, pxs->media_dims.y,
                      &page_size_pixels);
        {                       /*
                                 * Put the origin at the upper left corner of the page;
                                 * also account for the orientation.
                                 */
            gs_matrix orient;

            orient.xx = orient.xy = orient.yx = orient.yy =
                orient.tx = orient.ty = 0;
            switch (pxs->orientation) {
                case eDefaultOrientation:
                case ePortraitOrientation:
                    code = gs_translate(pgs, 0.0, pxs->media_dims.y);
                    orient.xx = 1, orient.yy = -1;
                    break;
                case eLandscapeOrientation:
                    code = 0;
                    orient.xy = 1, orient.yx = 1;
                    break;
                case eReversePortrait:
                    code = gs_translate(pgs, pxs->media_dims.x, 0);
                    orient.xx = -1, orient.yy = 1;
                    break;
                case eReverseLandscape:
                    code =
                        gs_translate(pgs, pxs->media_dims.x,
                                     pxs->media_dims.y);
                    orient.xy = -1, orient.yx = -1;
                    break;
                default:       /* can't happen */
                    return_error(errorIllegalAttributeValue);
            }
            if (code < 0 || (code = gs_concat(pgs, &orient)) < 0)
                return code;
        }
        {                       /* Scale according to session parameters. */
            /* If we can make the scale integral safely, we do. */
            double scale = measure_to_points[pxs->measure];
            gs_matrix mat;

            if ((code = gs_scale(pgs, scale / pxs->units_per_measure.x,
                                 scale / pxs->units_per_measure.y)) < 0)
                return code;
            gs_currentmatrix(pgs, &mat);
            mat.xx = px_adjust_scale(mat.xx, page_size_pixels.x);
            mat.xy = px_adjust_scale(mat.xy, page_size_pixels.y);
            mat.yx = px_adjust_scale(mat.yx, page_size_pixels.x);
            mat.yy = px_adjust_scale(mat.yy, page_size_pixels.y);
            gs_setmatrix(pgs, &mat);
            pxs->initial_matrix = mat;
        }
    }
    {                           /*
                                 * Set the default halftone method.  We have to do this here,
                                 * rather than earlier, so that the origin is set correctly.
                                 */
        px_args_t args;
        px_value_t device_matrix;

        memset(args.pv, 0, sizeof(args.pv));
        args.pv[1] = &device_matrix;    /* DeviceMatrix */
        device_matrix.type = pxd_scalar | pxd_ubyte;
        device_matrix.value.i = eDeviceBest;
        pxSetHalftoneMethod(&args, pxs);
    }
    /* Initialize other parts of the PCL XL state. */
    px_dict_init(&pxs->page_pattern_dict, pxs->memory, px_free_pattern);
    gs_erasepage(pgs);
    pxs->have_page = false;
    /* Make sure there is a legitimate halftone installed. */
    {
        int code = px_set_halftone(pxs);

        if (code < 0)
            return code;
    }
    /*
     * Do a gsave so we can be sure to get rid of all page-related
     * state at the end of the page, but make sure PopGS doesn't pop
     * this state from the stack.
     */
    {
        int code = pxPushGS(NULL, pxs);

        if (code < 0)
            return code;
        pxs->pxgs->stack_depth--;
        return code;
    }
}

int
pxBeginPageFromPassthrough(px_state_t * pxs)
{
    int code;
    gs_gstate *pgs = pxs->pgs;
    gs_point page_size_pixels;
    gs_matrix points2device;

    px_initgraphics(pxs);
    gs_currentmatrix(pgs, &points2device);
    gs_dtransform(pgs, pxs->media_dims.x, pxs->media_dims.y,
                  &page_size_pixels);
    {
        /*
         * Put the origin at the upper left corner of the page;
         * also account for the orientation.
         */
        gs_matrix orient;

        orient.xx = orient.xy = orient.yx = orient.yy =
            orient.tx = orient.ty = 0;
        switch (pxs->orientation) {
            case eDefaultOrientation:
            case ePortraitOrientation:
                code = gs_translate(pgs, 0.0, pxs->media_dims.y);
                orient.xx = 1, orient.yy = -1;
                break;
            case eLandscapeOrientation:
                code = 0;
                orient.xy = 1, orient.yx = 1;
                break;
            case eReversePortrait:
                code = gs_translate(pgs, pxs->media_dims.x, 0);
                orient.xx = -1, orient.yy = 1;
                break;
            case eReverseLandscape:
                code =
                    gs_translate(pgs, pxs->media_dims.x, pxs->media_dims.y);
                orient.xy = -1, orient.yx = -1;
                break;
            default:           /* can't happen */
                return_error(errorIllegalAttributeValue);
        }
        if (code < 0 || (code = gs_concat(pgs, &orient)) < 0)
            return code;
    }
    {                           /* Scale according to session parameters. */
        /* If we can make the scale integral safely, we do. */
        double scale = measure_to_points[pxs->measure];
        gs_matrix mat;

        if ((code = gs_scale(pgs, scale / pxs->units_per_measure.x,
                             scale / pxs->units_per_measure.y)) < 0)
            return code;
        gs_currentmatrix(pgs, &mat);
        mat.xx = px_adjust_scale(mat.xx, page_size_pixels.x);
        mat.xy = px_adjust_scale(mat.xy, page_size_pixels.y);
        mat.yx = px_adjust_scale(mat.yx, page_size_pixels.x);
        mat.yy = px_adjust_scale(mat.yy, page_size_pixels.y);
        gs_setmatrix(pgs, &mat);
        pxs->initial_matrix = mat;
    }
    pxs->have_page = true;
    return 0;
}

const byte apxEndPage[] = {
    0,
    pxaPageCopies, 0
};
int
pxEndPage(px_args_t * par, px_state_t * pxs)
{
    px_end_page_cleanup(pxs);
    (*pxs->end_page) (pxs, (par->pv[0] ? par->pv[0]->value.i : pxs->copies),
                      1);
    pxs->have_page = false;
    if (pxs->duplex)
        pxs->duplex_back_side = !pxs->duplex_back_side;
    else
        pxs->duplex_back_side = false;
    return 0;
}
/* The default end-page procedure just calls the device procedure. */
int
px_default_end_page(px_state_t * pxs, int num_copies, int flush)
{
    return gs_output_page(pxs->pgs, num_copies, flush);
}

const byte apxVendorUnique[] = {
    pxaVUExtension, 0, pxaVUDataLength, pxaVUAttr1, pxaVUAttr2, pxaVUAttr3,
    pxaVUAttr4, pxaVUAttr5, pxaVUAttr6, pxaSourceWidth, pxaSourceHeight,
    pxaStartLine, pxaBlockHeight, 0
};

/** we do NOTHING with the vendor unique command.
 * it is undocumented, but appears that it contains the sames color commands as the
 * XL 2.1 spec.  This is based on only finding it in hpclj 4500 driver output.
 * of course HP denys that the 4500 supports XL.
 */
int
pxVendorUnique(px_args_t * par, px_state_t * pxs)
{
    int code = 0;

    switch (par->pv[0]->value.i) {
	case 0x68704000:
	    /* hpijs's usage is non-conformant to spec */
	    if (!pxs->data_source_open) {
		pxs->data_source_open = true;
		pxs->data_source_big_endian = false;
	    }
	    return pxJR3BeginImage(par, pxs);
	    break;
	case 0x68704001:
	    return pxJR3ReadImage(par, pxs);
	    break;
	case 0x68704002:
	    return pxJR3EndImage(par, pxs);
	    break;
	case 0x68704003:	/* JR3ExecStream/VUDownloadDeviceTable */
	case 0x04107068:	/* HP_ColorSmartRGB */
	case 0x68702005:	/* HP_SelectTrayBinByString */
	case 0x68702006:	/* EnterFRMode */
	case 0x68702011:	/* FRExtension */
	    /* 1001 - 1004: PAINT_SETCOLORTREATMENT, PAINT_SETHALFTONEMETHOD, PAINT_DOWNLOADCOLORTABLE, ColorSmartRGB
	       2001, 2002, 2004: MEDIA_SELECTMEDIASOURCE, MEDIA_SELECTMEDIAFINISH, , SetInternalLUT
	       2101:             JR_OPENDATASOURCE
	       3000 - 301E:      hp_MET
	     */
	default:
	    break;
    }
    if (par->pv[1]) {
        ulong len = par->pv[1]->value.i;
        ulong copy = min(len - par->source.position,
                         par->source.available);
	dprintf2("Unprocessed VendorUnique Extension %08X (%d)\n",
		 par->pv[0]->value.i,
		 (par->pv[4] ? par->pv[4]->
		  value.i : -1 /* as good as any */ ));
        par->source.data += copy;
        par->source.available -= copy;
        par->source.position += copy;
        if (par->source.position == len)
            code = 0;
        else
            code = pxNeedData;
    }
    return code;
}

const byte apxComment[] = {
    0,
    pxaCommentData, 0
};
int
pxComment(px_args_t * par, px_state_t * pxs)
{
    return 0;
}

const byte apxOpenDataSource[] = {
    pxaSourceType, pxaDataOrg, 0, 0
};
int
pxOpenDataSource(px_args_t * par, px_state_t * pxs)
{
    if (pxs->data_source_open)
        return_error(errorDataSourceNotClosed);
    pxs->data_source_open = true;
    pxs->data_source_big_endian = par->pv[1]->value.i == eBinaryHighByteFirst;
    return 0;
}

const byte apxCloseDataSource[] = { 0, 0 };
int
pxCloseDataSource(px_args_t * par, px_state_t * pxs)
{
    pxs->data_source_open = false;
    return 0;
}