-
Notifications
You must be signed in to change notification settings - Fork 138
/
api.c
713 lines (554 loc) · 20.1 KB
/
api.c
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
/*
Copyright (C) 2010-2012, Parrot Foundation.
=head1 NAME
src/embed/api.c - The Parrot embedding interface
=head1 DESCRIPTION
This file implements functions of the Parrot embedding interface.
=head2 Functions
=over 4
=cut
*/
#include "parrot/parrot.h"
#include "parrot/runcore_api.h"
#include "parrot/api.h"
#include "embed_private.h"
/* HEADERIZER HFILE: include/parrot/api.h */
/*
=item C<Parrot_Int Parrot_api_get_result(Parrot_PMC interp_pmc, Parrot_Int
*is_error, Parrot_PMC *exception, Parrot_Int *exit_code, Parrot_String *errmsg)>
Gets the results of the last API function call and stores the results in
C<is_error>, C<exception>, C<exit_code> and C<errmsg>. This function returns
a true value if this call is successful and false value otherwise. The stored
information is as follows:
C<is_error> a true value if an unhandled exception was thrown or the program
terminated with an error condition and a false value otherwise.
C<exception> the last exception thrown, PMCNULL if none.
C<exit_code> the exit code of the running program, if it expected to exit
now. C<0> for no error.
C<errmsg> contains an string with the last error message if any,
C<STRINGNULL> if none.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_get_result(Parrot_PMC interp_pmc, ARGOUT(Parrot_Int *is_error),
ARGOUT(Parrot_PMC *exception), ARGOUT(Parrot_Int *exit_code),
ARGOUT(Parrot_String *errmsg))
{
ASSERT_ARGS(Parrot_api_get_result)
EMBED_API_CALLIN(interp_pmc, interp)
*exit_code = interp->exit_code;
*exception = interp->final_exception;
if (PMC_IS_NULL(*exception)) {
*is_error = 0;
*errmsg = STRINGNULL;
}
else {
STRING * const severity_str = Parrot_str_new(interp, "severity", 0);
const INTVAL severity = VTABLE_get_integer_keyed_str(interp, *exception, severity_str);
*is_error = (severity != EXCEPT_exit);
*errmsg = VTABLE_get_string(interp, *exception);
}
interp->final_exception = PMCNULL;
interp->exit_code = 0;
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_get_exception_backtrace(Parrot_PMC interp_pmc,
Parrot_PMC exception, Parrot_String *bt)>
Gets the backtrace of the interpreter's call chain for the given exception
C<exception> and stores the results in string C<bt>. This function returns a
true value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_get_exception_backtrace(Parrot_PMC interp_pmc,
Parrot_PMC exception, ARGOUT(Parrot_String *bt))
{
ASSERT_ARGS(Parrot_api_get_exception_backtrace)
EMBED_API_CALLIN(interp_pmc, interp)
if (PMC_IS_NULL(exception))
*bt = STRINGNULL;
else
*bt = Parrot_ex_build_complete_backtrace_string(interp, exception);
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_make_interpreter(Parrot_PMC parent, Parrot_Int
flags, Parrot_Init_Args *args, Parrot_PMC *interp)>
Creates a new interpreter and stores it in C<interp>. It takes three optional
parameters the new interpreter's C<flags>, the initialization paremeters C<args>
and the C<parent> interpreter. This function returns a true value if this call
is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_make_interpreter(Parrot_PMC parent, Parrot_Int flags,
ARGIN_NULLOK(Parrot_Init_Args *args), ARGOUT(Parrot_PMC *interp))
{
ASSERT_ARGS(Parrot_api_make_interpreter)
int alt_stacktop;
Parrot_Interp interp_raw;
Parrot_GC_Init_Args gc_args;
const Parrot_Interp parent_raw = PMC_IS_NULL(parent) ? NULL : GET_RAW_INTERP(parent);
Parrot_jump_buff env;
interp_raw = Parrot_interp_allocate_interpreter(parent_raw, flags);
if (setjmp(env)) {
interp_raw->api_jmp_buf = NULL;
*interp = NULL;
return !interp_raw->exit_code;
}
else {
interp_raw->api_jmp_buf = &env;
if (args) {
gc_args.stacktop = args->stacktop
? args->stacktop : &alt_stacktop;
gc_args.system = args->gc_system;
gc_args.nursery_size = args->gc_nursery_size;
gc_args.dynamic_threshold = args->gc_dynamic_threshold;
gc_args.min_threshold = args->gc_min_threshold;
if (args->hash_seed)
interp_raw->hash_seed = args->hash_seed;
}
else {
memset(&gc_args, 0, sizeof (Parrot_GC_Init_Args));
gc_args.stacktop = &alt_stacktop;
}
Parrot_interp_initialize_interpreter(interp_raw, &gc_args);
*interp = VTABLE_get_pmc_keyed_int(
interp_raw, interp_raw->iglobals, (Parrot_Int)IGLOBALS_INTERPRETER);
}
interp_raw->api_jmp_buf = NULL;
return !PMC_IS_NULL(*interp);
}
/*
=item C<Parrot_Int Parrot_api_set_runcore(Parrot_PMC interp_pmc, const char *
corename, Parrot_UInt trace)>
Sets the C<interp_pmc>'s bytecode running core, the core is specified by the
C<corename>. This function returns a true value if this call is successful and
false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_set_runcore(Parrot_PMC interp_pmc, ARGIN(const char * corename),
Parrot_UInt trace)
{
ASSERT_ARGS(Parrot_api_set_runcore)
EMBED_API_CALLIN(interp_pmc, interp)
if (trace) {
Interp_trace_SET(interp, PARROT_TRACE_OPS_FLAG);
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "slow"));
}
else {
if (STREQ(corename, "slow") || STREQ(corename, "bounds"))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "slow"));
else if (STREQ(corename, "fast") || STREQ(corename, "jit") || STREQ(corename, "function"))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "fast"));
else if (STREQ(corename, "subprof_sub"))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "subprof_sub"));
else if (STREQ(corename, "subprof_hll") || STREQ(corename, "subprof"))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "subprof_hll"));
else if (STREQ(corename, "subprof_ops"))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "subprof_ops"));
else if (STREQ(corename, "exec"))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "exec"));
else if (STREQ(corename, "trace"))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "slow"));
else if (STREQ(corename, "profiling"))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "profiling"));
else if (STREQ(corename, "gcdebug"))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "gcdebug"));
else
Parrot_ex_throw_from_c_args(interp, NULL, 1, "Invalid runcore type %s", corename);
}
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_debug_flag(Parrot_PMC interp_pmc, Parrot_Int
flags, Parrot_Int set)>
Sets/Unsets the C<interp_pmc>'s debug flags. If C<set> is in a true value debug
flags are set otherwise debug flags are cleared. This function returns a true
value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_debug_flag(Parrot_PMC interp_pmc, Parrot_Int flags, Parrot_Int set)
{
ASSERT_ARGS(Parrot_api_debug_flag)
EMBED_API_CALLIN(interp_pmc, interp)
if (set)
interp->debug_flags |= flags;
else
interp->debug_flags &= ~flags;
EMBED_API_CALLOUT(interp_pmc, interp);
}
/*
=item C<Parrot_Int Parrot_api_flag(Parrot_PMC interp_pmc, Parrot_Int flags,
Parrot_Int set)>
Set/Unset the C<interp_pmc>'s general flags. If C<set> is in a true value general
flags are set otherwise passed flags are cleared. This function returns a true
value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_flag(Parrot_PMC interp_pmc, Parrot_Int flags, Parrot_Int set)
{
ASSERT_ARGS(Parrot_api_flag)
EMBED_API_CALLIN(interp_pmc, interp)
if (set) {
Interp_flags_SET(interp, flags);
if (flags & (PARROT_BOUNDS_FLAG | PARROT_PROFILE_FLAG))
Parrot_runcore_switch(interp, Parrot_str_new_constant(interp, "slow"));
}
else
Interp_flags_CLEAR(interp, flags);
EMBED_API_CALLOUT(interp_pmc, interp);
}
/*
=item C<Parrot_Int Parrot_api_set_executable_name(Parrot_PMC interp_pmc, const
char *name)>
Sets the executable name for the C<interp_pmc> interpreter. This function returns
a true value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_set_executable_name(Parrot_PMC interp_pmc, ARGIN(const char *name))
{
ASSERT_ARGS(Parrot_api_set_executable_name)
EMBED_API_CALLIN(interp_pmc, interp)
STRING * const name_str = Parrot_str_from_platform_cstring(interp, name);
PMC * const name_pmc = Parrot_pmc_new(interp, enum_class_String);
VTABLE_set_string_native(interp, name_pmc, name_str);
VTABLE_set_pmc_keyed_int(interp, interp->iglobals, IGLOBALS_EXECUTABLE,
name_pmc);
EMBED_API_CALLOUT(interp_pmc, interp);
}
/*
=item C<Parrot_Int Parrot_api_destroy_interpreter(Parrot_PMC interp_pmc)>
Destroys the C<interp_pmc> interpreter, freeing the memory structures allocated
for it. This function returns a true value if this call is successful and false
value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_destroy_interpreter(Parrot_PMC interp_pmc)
{
ASSERT_ARGS(Parrot_api_destroy_interpreter)
Parrot_jump_buff env;
if (setjmp(env)) {
/* We can't check for potential errors because the interpreter
* might have been destroyed. */
return 1;
}
else {
Interp * const interp = GET_INTERP(interp_pmc);
void * _oldtop = interp->lo_var_ptr;
if (_oldtop == NULL)
interp->lo_var_ptr = &_oldtop;
interp->api_jmp_buf = &env;
Parrot_x_execute_on_exit_handlers(interp, 0);
Parrot_interp_destroy(interp);
return 1;
}
}
/*
=item C<Parrot_Int Parrot_api_set_warnings(Parrot_PMC interp_pmc, Parrot_Int
flags)>
Enables C<inter_pmc>'s warning messages the type of warning information to be
print out is specified by C<flags>. This function returns a true value if this
call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_set_warnings(Parrot_PMC interp_pmc, Parrot_Int flags)
{
ASSERT_ARGS(Parrot_api_set_warnings)
EMBED_API_CALLIN(interp_pmc, interp)
/* Activates the given warnings. (Macro from warnings.h.) */
PARROT_WARNINGS_on(interp, flags);
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_add_library_search_path(Parrot_PMC interp_pmc,
const char *path)>
Adds C<path> to the C<inter_pmc>'s library search path list. This function
returns a true value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_add_library_search_path(Parrot_PMC interp_pmc,
ARGIN(const char *path))
{
ASSERT_ARGS(Parrot_api_add_library_search_path)
EMBED_API_CALLIN(interp_pmc, interp)
Parrot_lib_add_path_from_cstring(interp, path, PARROT_LIB_PATH_LIBRARY);
/* EXPERIMENTAL. This line has been added experimentally because it is a
missing feature, and it may go away at any time without warning. */
Parrot_lib_add_path_from_cstring(interp, path, PARROT_LIB_PATH_LANG);
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_add_include_search_path(Parrot_PMC interp_pmc,
const char *path)>
Adds C<path> to the C<inter_pmc>'s include search path list. This function
returns a true value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_add_include_search_path(Parrot_PMC interp_pmc,
ARGIN(const char *path))
{
ASSERT_ARGS(Parrot_api_add_include_search_path)
EMBED_API_CALLIN(interp_pmc, interp)
Parrot_lib_add_path_from_cstring(interp, path, PARROT_LIB_PATH_INCLUDE);
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_add_dynext_search_path(Parrot_PMC interp_pmc,
const char *path)>
Adds C<path> to the C<inter_pmc>'s dynext search path list. This function
returns a true value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_add_dynext_search_path(Parrot_PMC interp_pmc,
ARGIN(const char *path))
{
ASSERT_ARGS(Parrot_api_add_dynext_search_path)
EMBED_API_CALLIN(interp_pmc, interp)
Parrot_lib_add_path_from_cstring(interp, path, PARROT_LIB_PATH_DYNEXT);
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_set_stdhandle(Parrot_PMC interp_pmc, Parrot_PMC
handle, Parrot_Int fileno, Parrot_PMC *old_handle)>
Set one of the C<interp_pmc>'s standard IO PMCs. The handle PMC C<handle> is
an IO-type PMC (such as FileHandle or StringHandle). The fileno is one of
C<0> for stdin, C<1> for stdout and C<2> for stderr. Other values are not
(currently) allowed. The previous PMC for that handle is returned as
C<old_handle>. This function returns a true value if this call is successful
and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_set_stdhandle(Parrot_PMC interp_pmc, Parrot_PMC handle,
Parrot_Int fileno, ARGOUT(Parrot_PMC *old_handle))
{
ASSERT_ARGS(Parrot_api_set_stdhandle)
EMBED_API_CALLIN(interp_pmc, interp)
switch (fileno) {
case PIO_STDIN_FILENO:
case PIO_STDOUT_FILENO:
case PIO_STDERR_FILENO:
*old_handle = Parrot_io_stdhandle(interp, fileno, handle);
break;
default:
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Cannot set new handle %d. Must be one of 0, 1 or 2", fileno);
}
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_get_runtime_path(Parrot_PMC interp_pmc,
Parrot_String *runtime)>
Stores in C<runtime> the C<interp_pmc>'s running path. This function returns a
true value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_get_runtime_path(Parrot_PMC interp_pmc,
ARGOUT(Parrot_String *runtime))
{
ASSERT_ARGS(Parrot_api_get_runtime_path)
EMBED_API_CALLIN(interp_pmc, interp)
*runtime = Parrot_get_runtime_path(interp);
EMBED_API_CALLOUT(interp_pmc, interp);
}
/*
=item C<Parrot_Int Parrot_api_set_configuration_hash(Parrot_PMC interp_pmc,
Parrot_PMC confighash)>
Sets the C<interp_pmc>'s configuration hash passed in C<confighash>. This
function returns a true value if this call is successful and false value
otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_set_configuration_hash(Parrot_PMC interp_pmc, Parrot_PMC confighash)
{
ASSERT_ARGS(Parrot_api_set_configuration_hash)
EMBED_API_CALLIN(interp_pmc, interp)
Parrot_set_config_hash_pmc(interp, confighash);
Parrot_lib_update_paths_from_config_hash(interp);
EMBED_API_CALLOUT(interp_pmc, interp);
}
/*
=item C<Parrot_Int Parrot_api_load_language(Parrot_PMC interp_pmc, Parrot_String
lang)>
Loads the HLL compiler libraries for C<lang> into the C<interp_pmc>. This
function returns a true value if this call is successful and false value
otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_load_language(Parrot_PMC interp_pmc, ARGIN(Parrot_String lang))
{
ASSERT_ARGS(Parrot_api_load_language)
EMBED_API_CALLIN(interp_pmc, interp)
Parrot_load_language(interp, lang);
EMBED_API_CALLOUT(interp_pmc, interp);
}
/*
=item C<Parrot_Int Parrot_api_get_compiler(Parrot_PMC interp_pmc, Parrot_String
type, Parrot_PMC *compiler)>
Gets the compiler PMC and stores it in C<compiler>. This function returns a true
value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_get_compiler(Parrot_PMC interp_pmc, ARGIN(Parrot_String type),
ARGOUT(Parrot_PMC *compiler))
{
ASSERT_ARGS(Parrot_api_get_compiler)
EMBED_API_CALLIN(interp_pmc, interp)
*compiler = Parrot_interp_get_compiler(interp, type);
if (PMC_IS_NULL(*compiler))
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Cannot find compiler '%Ss'", type);
EMBED_API_CALLOUT(interp_pmc, interp);
}
/*
=item C<Parrot_Int Parrot_api_set_compiler(Parrot_PMC interp_pmc, Parrot_String
type, Parrot_PMC compiler)>
Sets the C<compiler> object for the C<type> files. This function returns a true
value if this call is successful and false value otherwise.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_set_compiler(Parrot_PMC interp_pmc, ARGIN(Parrot_String type),
ARGIN(Parrot_PMC compiler))
{
ASSERT_ARGS(Parrot_api_set_compiler)
EMBED_API_CALLIN(interp_pmc, interp)
Parrot_interp_set_compiler(interp, type, compiler);
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_toggle_gc(Parrot_PMC interp_pmc, Parrot_Int on)>
Turn Parrot's GC on or off.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_toggle_gc(Parrot_PMC interp_pmc, Parrot_Int on)
{
ASSERT_ARGS(Parrot_api_toggle_gc)
EMBED_API_CALLIN(interp_pmc, interp)
if (on) {
Parrot_unblock_GC_mark(interp);
Parrot_unblock_GC_sweep(interp);
}
else {
Parrot_block_GC_mark(interp);
Parrot_block_GC_sweep(interp);
}
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_reset_call_signature(Parrot_PMC interp_pmc,
Parrot_PMC ctx)>
Reset the call signature
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_reset_call_signature(Parrot_PMC interp_pmc, ARGMOD(Parrot_PMC ctx))
{
ASSERT_ARGS(Parrot_api_reset_call_signature)
EMBED_API_CALLIN(interp_pmc, interp)
STRING * const callcontext = Parrot_str_new(interp, "CallContext", 0);
if (!VTABLE_isa(interp, ctx, callcontext))
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"Not a valid CallContext");
VTABLE_morph(interp, ctx, PMCNULL);
EMBED_API_CALLOUT(interp_pmc, interp)
}
/*
=item C<Parrot_Int Parrot_api_wrap_pointer(Parrot_PMC interp_pmc, void *ptr,
Parrot_Int size, Parrot_PMC *pmc)>
Wrap a user data pointer into a Ptr PMC for passing into Parrot. This PMC
is designed such that Parrot will treat the pointer as being opaque and will
not attempt to dereference, examine, or manipulate it at all.
Optionally a C<size> parameter can be passed. If C<size> is greater than zero,
the size information will be included with the pointer for later use. If
C<size> is less than or equal to zero, it will be ignored and will not be
included in the PMC object.
=item C<Parrot_Int Parrot_api_unwrap_pointer(Parrot_PMC interp_pmc, Parrot_PMC
pmc, void ** ptr, Parrot_Int * size)>
Return a pointer from a PMC. This is typically used in conjunction with
C<Parrot_api_wrap_pointer> to return the original wrapped pointer value from
the PMC. Used with other PMC types besides C<Ptr> or C<PtrBuf> will have
undefined results, and should not be used or relied upon.
If the pointer was stored with size information, C<size> will contain that
size value. Otherwise, C<size> will be -1.
Notice that this function does not destroy or alter the data PMC.
=cut
*/
PARROT_API
Parrot_Int
Parrot_api_wrap_pointer(Parrot_PMC interp_pmc, ARGIN_NULLOK(void *ptr),
Parrot_Int size, ARGOUT(Parrot_PMC *pmc))
{
ASSERT_ARGS(Parrot_api_wrap_pointer)
EMBED_API_CALLIN(interp_pmc, interp)
PMC * ptr_pmc = NULL;
if (size > 0) {
ptr_pmc = Parrot_pmc_new(interp, enum_class_PtrBuf);
VTABLE_set_integer_native(interp, ptr_pmc, size);
}
else
ptr_pmc = Parrot_pmc_new(interp, enum_class_Ptr);
VTABLE_set_pointer(interp, ptr_pmc, ptr);
*pmc = ptr_pmc;
EMBED_API_CALLOUT(interp_pmc, interp)
}
PARROT_API
Parrot_Int
Parrot_api_unwrap_pointer(Parrot_PMC interp_pmc, Parrot_PMC pmc,
ARGOUT(void ** ptr), ARGOUT(Parrot_Int * size))
{
ASSERT_ARGS(Parrot_api_unwrap_pointer)
EMBED_API_CALLIN(interp_pmc, interp)
*ptr = VTABLE_get_pointer(interp, pmc);
if (pmc->vtable->base_type == enum_class_PtrBuf)
*size = VTABLE_get_integer(interp, pmc);
else
*size = -1;
EMBED_API_CALLOUT(interp_pmc, interp);
}
/*
=back
=cut
*/
/*
* Local variables:
* c-file-style: "parrot"
* End:
* vim: expandtab shiftwidth=4 cinoptions='\:2=2' :
*/