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
|
/* Copyright (C) 2001-2021 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., 1305 Grant Avenue - Suite 200, Novato,
CA 94945, U.S.A., +1(415)492-9861, for further information.
*/
/* Default implementation of parameter lists */
#include "memory_.h"
#include "string_.h"
#include "gx.h"
#include "gserrors.h"
#include "gsparam.h"
#include "gsstruct.h"
/* Forward references */
typedef union c_param_value_s {
GS_PARAM_VALUE_UNION(gs_c_param_list);
} gs_c_param_value;
/*typedef struct gs_c_param_s gs_c_param; *//* in gsparam.h */
/* Define the GC type for a parameter list. */
private_st_c_param_list();
/* Lengths corresponding to various gs_param_type_xxx types */
const byte gs_param_type_sizes[] = {
GS_PARAM_TYPE_SIZES(sizeof(gs_c_param_list))
};
/* Lengths of *actual* data-containing type pointed to or contained by gs_param_type_xxx's */
const byte gs_param_type_base_sizes[] = {
GS_PARAM_TYPE_BASE_SIZES(0)
};
/*
* Define a parameter list element. We use gs_param_type_any to identify
* elements that have been requested but not yet written. The reading
* procedures must recognize such elements as undefined, and ignore them.
*/
struct gs_c_param_s {
gs_c_param *next;
gs_param_key_t key;
bool free_key;
gs_c_param_value value;
gs_param_type type;
void *alternate_typed_data;
int error;
};
/* GC descriptor and procedures */
gs_private_st_composite(st_c_param, gs_c_param, "gs_c_param",
c_param_enum_ptrs, c_param_reloc_ptrs);
ENUM_PTRS_WITH(c_param_enum_ptrs, gs_c_param *param) {
index -= 3;
switch (param->type) {
/* Only the aggregate types are handled specially. */
case gs_param_type_dict:
case gs_param_type_dict_int_keys:
case gs_param_type_array:
return ENUM_USING(st_c_param_list, ¶m->value.d,
sizeof(param->value.d), index);
default: {
gs_param_typed_value value;
value.value = *(const gs_param_value *)¶m->value;
value.type = param->type;
return gs_param_typed_value_enum_ptrs(mem, &value, sizeof(value), index,
pep, NULL, gcst);
}
}
}
case 0: return ENUM_OBJ(param->next);
case 1: return ENUM_OBJ(param->alternate_typed_data);
case 2:
if (!param->key.persistent) {
gs_const_string key;
key.data = param->key.data;
key.size = param->key.size;
return ENUM_STRING(&key);
} else
return ENUM_OBJ(0); /* keep going */
ENUM_PTRS_END
RELOC_PTRS_WITH(c_param_reloc_ptrs, gs_c_param *param) {
RELOC_VAR(param->next);
RELOC_VAR(param->alternate_typed_data);
if (!param->key.persistent) {
gs_const_string key;
key.data = param->key.data;
key.size = param->key.size;
RELOC_CONST_STRING_VAR(key);
param->key.data = key.data;
}
switch (param->type) {
/* Only the aggregate types are handled specially. */
case gs_param_type_dict:
case gs_param_type_dict_int_keys:
case gs_param_type_array:
RELOC_USING(st_c_param_list, ¶m->value.d, sizeof(param->value.d));
break;
default: {
gs_param_typed_value value;
value.value = *(gs_param_value *)¶m->value;
value.type = param->type;
gs_param_typed_value_reloc_ptrs(&value, sizeof(value), NULL, gcst);
*(gs_param_value *)¶m->value = value.value;
}
}
}
RELOC_PTRS_END
/* ---------------- Utilities ---------------- */
gs_c_param_list *
gs_c_param_list_alloc(gs_memory_t *mem, client_name_t cname)
{
return gs_alloc_struct(mem, gs_c_param_list, &st_c_param_list, cname);
}
static gs_c_param *
c_param_find(const gs_c_param_list *plist, gs_param_name pkey, bool any)
{
gs_c_param *pparam = plist->head;
uint len = strlen(pkey);
for (; pparam != 0; pparam = pparam->next)
if (pparam->key.size == len && !memcmp(pparam->key.data, pkey, len))
return (pparam->type != gs_param_type_any || any ? pparam : 0);
return 0;
}
/* ---------------- Writing parameters to a list ---------------- */
static param_proc_begin_xmit_collection(c_param_begin_write_collection);
static param_proc_end_xmit_collection(c_param_end_write_collection);
static param_proc_xmit_typed(c_param_write_typed);
static param_proc_request(c_param_request);
static param_proc_requested(c_param_requested);
static const gs_param_list_procs c_write_procs =
{
c_param_write_typed,
c_param_begin_write_collection,
c_param_end_write_collection,
NULL, /* get_next_key */
c_param_request,
c_param_requested
};
/* Initialize a list for writing. */
void
gs_c_param_list_write(gs_c_param_list * plist, gs_memory_t * mem)
{
plist->memory = mem;
plist->head = 0;
plist->target = 0; /* not used for writing */
plist->count = 0;
plist->any_requested = false;
plist->persistent_keys = true;
gs_c_param_list_write_more(plist);
}
/* Set the target of a list. Only relevant for reading. */
void
gs_c_param_list_set_target(gs_c_param_list *plist, gs_param_list *target)
{
plist->target = target;
}
/* Re-enable a list for writing, without clearing it. */
/* gs_c_param_list_write must have been called previously. */
void
gs_c_param_list_write_more(gs_c_param_list * plist)
{
plist->procs = &c_write_procs;
plist->coll_type = gs_param_collection_dict_any;
}
/* Release a list. */
void
gs_c_param_list_release(gs_c_param_list * plist)
{
gs_memory_t *mem = plist->memory;
gs_c_param *pparam;
while ((pparam = plist->head) != 0) {
gs_c_param *next = pparam->next;
switch (pparam->type) {
case gs_param_type_dict:
case gs_param_type_dict_int_keys:
case gs_param_type_array:
gs_c_param_list_release(&pparam->value.d);
break;
case gs_param_type_string:
case gs_param_type_name:
case gs_param_type_int_array:
case gs_param_type_float_array:
case gs_param_type_string_array:
case gs_param_type_name_array:
if (!pparam->value.s.persistent)
gs_free_const_object(mem, pparam->value.s.data,
"gs_c_param_list_release data");
break;
default:
break;
}
if (pparam->free_key) {
/* We allocated this, so we must free it. */
gs_free_const_string(mem, pparam->key.data, pparam->key.size,
"gs_c_param_list_release key");
}
gs_free_object(mem, pparam->alternate_typed_data,
"gs_c_param_list_release alternate data");
gs_free_object(mem, pparam,
"gs_c_param_list_release entry");
plist->head = next;
plist->count--;
}
}
/* Add an entry to a list. Doesn't set: value, type, plist->head. */
static gs_c_param *
c_param_add(gs_c_param_list * plist, gs_param_name pkey)
{
gs_c_param *pparam =
gs_alloc_struct(plist->memory, gs_c_param, &st_c_param,
"c_param_add entry");
uint len;
if ((pparam == NULL) || (pkey == NULL))
return NULL;
len = strlen(pkey);
pparam->next = plist->head;
if (!plist->persistent_keys) {
/* We must copy the key. */
byte *str = gs_alloc_string(plist->memory, len, "c_param_add key");
if (str == 0) {
gs_free_object(plist->memory, pparam, "c_param_add entry");
return 0;
}
memcpy(str, pkey, len);
pparam->key.data = str;
pparam->key.persistent = false; /* we will free it */
pparam->free_key = true;
} else {
pparam->key.data = (const byte *)pkey;
pparam->key.persistent = true;
pparam->free_key = false;
}
pparam->key.size = len;
pparam->alternate_typed_data = 0;
pparam->error = 0;
return pparam;
}
/* Write a dynamically typed parameter to a list. */
static int
c_param_write(gs_c_param_list * plist, gs_param_name pkey, void *pvalue,
gs_param_type type)
{
unsigned top_level_sizeof = 0;
unsigned second_level_sizeof = 0;
gs_c_param *pparam = c_param_add(plist, pkey);
if (pparam == 0)
return_error(gs_error_VMerror);
memcpy(&pparam->value, pvalue, gs_param_type_sizes[(int)type]);
pparam->type = type;
/* Need deeper copies of data if it's not persistent */
switch (type) {
gs_param_string const *curr_string;
gs_param_string const *end_string;
case gs_param_type_string_array:
case gs_param_type_name_array:
/* Determine how much mem needed to hold actual string data */
curr_string = pparam->value.sa.data;
end_string = curr_string + pparam->value.sa.size;
for (; curr_string < end_string; ++curr_string)
if (!curr_string->persistent)
second_level_sizeof += curr_string->size;
/* fall thru */
case gs_param_type_string:
case gs_param_type_name:
case gs_param_type_int_array:
case gs_param_type_float_array:
if (!pparam->value.s.persistent) { /* Allocate & copy object pointed to by array or string */
byte *top_level_memory = NULL;
top_level_sizeof =
pparam->value.s.size * gs_param_type_base_sizes[type];
if (top_level_sizeof + second_level_sizeof > 0) {
top_level_memory =
gs_alloc_bytes_immovable(plist->memory,
top_level_sizeof + second_level_sizeof,
"c_param_write data");
if (top_level_memory == 0) {
if (pparam->key.persistent == false) {
gs_free_string(plist->memory, (byte *)(pparam->key.data),
strlen((const char *)(pparam->key.data)), "c_param_add key");
}
gs_free_object(plist->memory, pparam, "c_param_write entry");
return_error(gs_error_VMerror);
}
memcpy(top_level_memory, pparam->value.s.data, top_level_sizeof);
}
pparam->value.s.data = top_level_memory;
/* String/name arrays need to copy actual str data */
if (second_level_sizeof > 0) {
byte *second_level_memory =
top_level_memory + top_level_sizeof;
curr_string = pparam->value.sa.data;
end_string = curr_string + pparam->value.sa.size;
for (; curr_string < end_string; ++curr_string)
if (!curr_string->persistent) {
memcpy(second_level_memory,
curr_string->data, curr_string->size);
((gs_param_string *) curr_string)->data
= second_level_memory;
second_level_memory += curr_string->size;
}
}
}
break;
default:
break;
}
plist->head = pparam;
plist->count++;
return 0;
}
/* Individual writing routines. */
static int
c_param_begin_write_collection(gs_param_list * plist, gs_param_name pkey,
gs_param_dict * pvalue, gs_param_collection_type_t coll_type)
{
gs_c_param_list *const cplist = (gs_c_param_list *)plist;
gs_c_param_list *dlist =
gs_c_param_list_alloc(cplist->memory,
"c_param_begin_write_collection");
if (dlist == 0)
return_error(gs_error_VMerror);
gs_c_param_list_write(dlist, cplist->memory);
dlist->coll_type = coll_type;
pvalue->list = (gs_param_list *) dlist;
return 0;
}
static int
c_param_end_write_collection(gs_param_list * plist, gs_param_name pkey,
gs_param_dict * pvalue)
{
gs_c_param_list *const cplist = (gs_c_param_list *)plist;
gs_c_param_list *dlist = (gs_c_param_list *) pvalue->list;
int code;
code = c_param_write(cplist, pkey, pvalue->list,
(dlist->coll_type == gs_param_collection_dict_int_keys ?
gs_param_type_dict_int_keys :
dlist->coll_type == gs_param_collection_array ?
gs_param_type_array : gs_param_type_dict));
gs_free_object(plist->memory, pvalue->list, "c_param_end_write_collection");
pvalue->list = 0;
return code;
}
static int
c_param_write_typed(gs_param_list * plist, gs_param_name pkey,
gs_param_typed_value * pvalue)
{
gs_c_param_list *const cplist = (gs_c_param_list *)plist;
gs_param_collection_type_t coll_type;
switch (pvalue->type) {
case gs_param_type_dict:
coll_type = gs_param_collection_dict_any;
break;
case gs_param_type_dict_int_keys:
coll_type = gs_param_collection_dict_int_keys;
break;
case gs_param_type_array:
coll_type = gs_param_collection_array;
break;
default:
return c_param_write(cplist, pkey, &pvalue->value, pvalue->type);
}
return c_param_begin_write_collection
(plist, pkey, &pvalue->value.d, coll_type);
}
/* Other procedures */
static int
c_param_request(gs_param_list * plist, gs_param_name pkey)
{
gs_c_param_list *const cplist = (gs_c_param_list *)plist;
gs_c_param *pparam;
cplist->any_requested = true;
if (c_param_find(cplist, pkey, true))
return 0;
pparam = c_param_add(cplist, pkey);
if (pparam == 0)
return_error(gs_error_VMerror);
pparam->type = gs_param_type_any; /* mark as undefined */
cplist->head = pparam;
return 0;
}
static int
c_param_requested(const gs_param_list * plist, gs_param_name pkey)
{
const gs_c_param_list *const cplist = (const gs_c_param_list *)plist;
gs_param_list *target = cplist->target;
int code;
if (!cplist->any_requested)
return (target ? param_requested(target, pkey) : -1);
if (c_param_find(cplist, pkey, true) != 0)
return 1;
if (!target)
return 0;
code = param_requested(target, pkey);
return (code < 0 ? 0 : 1);
}
/* ---------------- Reading from a list to parameters ---------------- */
static param_proc_begin_xmit_collection(c_param_begin_read_collection);
static param_proc_end_xmit_collection(c_param_end_read_collection);
static param_proc_xmit_typed(c_param_read_typed);
static param_proc_next_key(c_param_get_next_key);
static param_proc_get_policy(c_param_read_get_policy);
static param_proc_signal_error(c_param_read_signal_error);
static param_proc_read_signalled_error(c_param_read_signalled_error);
static param_proc_commit(c_param_read_commit);
static const gs_param_list_procs c_read_procs =
{
c_param_read_typed,
c_param_begin_read_collection,
c_param_end_read_collection,
c_param_get_next_key,
NULL, /* request, N/A */
NULL, /* requested, N/A */
c_param_read_get_policy,
c_param_read_signal_error,
c_param_read_commit,
c_param_read_signalled_error
};
/* Switch a list from writing to reading. */
void
gs_c_param_list_read(gs_c_param_list * plist)
{
plist->procs = &c_read_procs;
}
/* Generic routine for reading a parameter from a list. */
static int
c_param_read_typed(gs_param_list * plist, gs_param_name pkey,
gs_param_typed_value * pvalue)
{
gs_c_param_list *const cplist = (gs_c_param_list *)plist;
gs_param_type req_type = pvalue->type;
gs_c_param *pparam = c_param_find(cplist, pkey, false);
int code;
if (pparam == 0)
return (cplist->target ?
param_read_typed(cplist->target, pkey, pvalue) : 1);
pvalue->type = pparam->type;
switch (pvalue->type) {
case gs_param_type_dict:
case gs_param_type_dict_int_keys:
case gs_param_type_array:
gs_c_param_list_read(&pparam->value.d);
pvalue->value.d.list = (gs_param_list *) & pparam->value.d;
pvalue->value.d.size = pparam->value.d.count;
return 0;
default:
break;
}
memcpy(&pvalue->value, &pparam->value,
gs_param_type_sizes[(int)pparam->type]);
code = param_coerce_typed(pvalue, req_type, NULL);
/****** SHOULD LET param_coerce_typed DO THIS ******/
if (code == gs_error_typecheck &&
req_type == gs_param_type_float_array &&
pvalue->type == gs_param_type_int_array
) {
/* Convert int array to float dest */
gs_param_float_array fa;
int element;
fa.size = pparam->value.ia.size;
fa.persistent = false;
if (pparam->alternate_typed_data == 0) {
if ((pparam->alternate_typed_data
= (void *)gs_alloc_bytes_immovable(cplist->memory,
fa.size * sizeof(float),
"gs_c_param_read alternate float array")) == 0)
return_error(gs_error_VMerror);
for (element = 0; element < fa.size; ++element)
((float *)(pparam->alternate_typed_data))[element]
= (float)pparam->value.ia.data[element];
}
fa.data = (float *)pparam->alternate_typed_data;
pvalue->value.fa = fa;
pvalue->type = req_type;
return 0;
}
return code;
}
/* Individual reading routines. */
static int
c_param_begin_read_collection(gs_param_list * plist, gs_param_name pkey,
gs_param_dict * pvalue, gs_param_collection_type_t coll_type)
{
gs_c_param_list *const cplist = (gs_c_param_list *)plist;
gs_c_param *pparam = c_param_find(cplist, pkey, false);
if (pparam == 0)
return
(cplist->target ?
param_begin_read_collection(cplist->target,
pkey, pvalue, coll_type) :
1);
switch (pparam->type) {
case gs_param_type_dict:
if (coll_type != gs_param_collection_dict_any)
return_error(gs_error_typecheck);
break;
case gs_param_type_dict_int_keys:
if (coll_type == gs_param_collection_array)
return_error(gs_error_typecheck);
break;
case gs_param_type_array:
break;
default:
return_error(gs_error_typecheck);
}
gs_c_param_list_read(&pparam->value.d);
pvalue->list = (gs_param_list *) & pparam->value.d;
pvalue->size = pparam->value.d.count;
return 0;
}
static int
c_param_end_read_collection(gs_param_list * plist, gs_param_name pkey,
gs_param_dict * pvalue)
{
return 0;
}
/* Other procedures */
static int /* ret 0 ok, 1 if EOF, or -ve err */
c_param_get_next_key(gs_param_list * plist, gs_param_enumerator_t * penum,
gs_param_key_t * key)
{
gs_c_param_list *const cplist = (gs_c_param_list *)plist;
gs_c_param *pparam =
(penum->pvoid ? ((gs_c_param *) (penum->pvoid))->next :
cplist->head);
if (pparam == 0)
return 1;
penum->pvoid = pparam;
*key = pparam->key;
return 0;
}
static int
c_param_read_get_policy(gs_param_list * plist, gs_param_name pkey)
{
return gs_param_policy_ignore;
}
static int
c_param_read_signal_error(gs_param_list * plist, gs_param_name pkey, int code)
{
gs_c_param_list *const cplist = (gs_c_param_list *)plist;
gs_c_param *pparam = c_param_find(cplist, pkey, false);
if (pparam)
pparam->error = code;
return 0;
}
static int
c_param_read_commit(gs_param_list * plist)
{
return 0;
}
static int
c_param_read_signalled_error(gs_param_list * plist, gs_param_name pkey)
{
gs_c_param_list *const cplist = (gs_c_param_list *)plist;
gs_c_param *pparam = c_param_find(cplist, pkey, false);
return (pparam ? pparam->error : 0);
}
|