XS::Typemap: Tests for T_INOUT typemap
[perl.git] / ext / XS-Typemap / Typemap.xs
1 /*
2    XS code to test the typemap entries
3
4    Copyright (C) 2001 Tim Jenness.
5    All Rights Reserved
6
7 */
8
9 #define PERL_NO_GET_CONTEXT
10
11 #include "EXTERN.h"   /* std perl include */
12 #include "perl.h"     /* std perl include */
13 #include "XSUB.h"     /* XSUB include */
14
15 /* Prototypes for external functions */
16 FILE * xsfopen( const char * );
17 int xsfclose( FILE * );
18 int xsfprintf( FILE *, const char *);
19
20 /* Type definitions required for the XS typemaps */
21 typedef SV * SVREF; /* T_SVREF */
22 typedef int SysRet; /* T_SYSRET */
23 typedef int Int;    /* T_INT */
24 typedef int intRef; /* T_PTRREF */
25 typedef int intObj; /* T_PTROBJ */
26 typedef int intRefIv; /* T_REF_IV_PTR */
27 typedef int intArray; /* T_ARRAY */
28 typedef int intTINT; /* T_INT */
29 typedef int intTLONG; /* T_LONG */
30 typedef short shortOPQ;   /* T_OPAQUE */
31 typedef int intOpq;   /* T_OPAQUEPTR */
32 typedef unsigned intUnsigned; /* T_U_INT */
33
34 /* A structure to test T_OPAQUEPTR and T_PACKED */
35 struct t_opaqueptr {
36   int a;
37   int b;
38   double c;
39 };
40
41 typedef struct t_opaqueptr astruct;
42 typedef struct t_opaqueptr anotherstruct;
43
44 /* Some static memory for the tests */
45 static I32 xst_anint;
46 static intRef xst_anintref;
47 static intObj xst_anintobj;
48 static intRefIv xst_anintrefiv;
49 static intOpq xst_anintopq;
50
51 /* A different type to refer to for testing the different
52  * AV*, HV*, etc typemaps */
53 typedef AV AV_FIXED;
54 typedef HV HV_FIXED;
55 typedef CV CV_FIXED;
56 typedef SVREF SVREF_FIXED;
57
58 /* Helper functions */
59
60 /* T_ARRAY - allocate some memory */
61 intArray * intArrayPtr( int nelem ) {
62     intArray * array;
63     Newx(array, nelem, intArray);
64     return array;
65 }
66
67 /* test T_PACKED */
68 #define XS_pack_anotherstructPtr(out, in)                  \
69     STMT_START {                                           \
70       HV *hash = newHV();                                  \
71       hv_stores(hash, "a", newSViv((in)->a));              \
72       hv_stores(hash, "b", newSViv((in)->b));              \
73       hv_stores(hash, "c", newSVnv((in)->c));              \
74       sv_setsv((out), sv_2mortal(newRV_noinc((SV*)hash))); \
75     } STMT_END
76
77 STATIC anotherstruct *
78 XS_unpack_anotherstructPtr(SV *in)
79 {
80     dTHX; /* rats, this is expensive */
81     /* this is similar to T_HVREF since we chose to use a hash */
82     HV *inhash;
83     SV **elem;
84     anotherstruct *out;
85     SV *const tmp = in;
86     SvGETMAGIC(tmp);
87     if (SvROK(tmp) && SvTYPE(SvRV(tmp)) == SVt_PVHV)
88        inhash = (HV*)SvRV(tmp);
89     else
90         Perl_croak(aTHX_ "Argument is not a HASH reference");
91
92     /* FIXME dunno if supposed to use perl mallocs here */
93     Newxz(out, 1, anotherstruct);
94
95     elem = hv_fetchs(inhash, "a", 0);
96     if (elem == NULL)
97       Perl_croak(aTHX_ "Shouldn't happen: hv_fetchs returns NULL");
98     out->a = SvIV(*elem);
99
100     elem = hv_fetchs(inhash, "b", 0);
101     if (elem == NULL)
102       Perl_croak(aTHX_ "Shouldn't happen: hv_fetchs returns NULL");
103     out->b = SvIV(*elem);
104
105     elem = hv_fetchs(inhash, "c", 0);
106     if (elem == NULL)
107       Perl_croak(aTHX_ "Shouldn't happen: hv_fetchs returns NULL");
108     out->c = SvNV(*elem);
109
110     return out;
111 }
112
113 /* test T_PACKEDARRAY */
114 #define XS_pack_anotherstructPtrPtr(out, in, cnt)          \
115     STMT_START {                                           \
116       UV i;                                                \
117       AV *ary = newAV();                                   \
118       for (i = 0; i < cnt; ++i) {                          \
119         HV *hash = newHV();                                \
120         hv_stores(hash, "a", newSViv((in)[i]->a));         \
121         hv_stores(hash, "b", newSViv((in)[i]->b));         \
122         hv_stores(hash, "c", newSVnv((in)[i]->c));         \
123         av_push(ary, newRV_noinc((SV*)hash));              \
124       }                                                    \
125       sv_setsv((out), sv_2mortal(newRV_noinc((SV*)ary)));  \
126     } STMT_END
127
128 STATIC anotherstruct **
129 XS_unpack_anotherstructPtrPtr(SV *in)
130 {
131     dTHX; /* rats, this is expensive */
132     /* this is similar to T_HVREF since we chose to use a hash */
133     HV *inhash;
134     AV *inary;
135     SV **elem;
136     anotherstruct **out;
137     UV nitems, i;
138     SV *tmp;
139
140     /* safely deref the input array ref */
141     tmp = in;
142     SvGETMAGIC(tmp);
143     if (SvROK(tmp) && SvTYPE(SvRV(tmp)) == SVt_PVAV)
144        inary = (AV*)SvRV(tmp);
145     else
146         Perl_croak(aTHX_ "Argument is not an ARRAY reference");
147
148     nitems = av_len(inary) + 1;
149
150     /* FIXME dunno if supposed to use perl mallocs here */
151     /* N+1 elements so we know the last one is NULL */
152     Newxz(out, nitems+1, anotherstruct*);
153
154     /* WARNING: in real code, we'd have to Safefree() on exception, but
155      *          since we're testing perl, if we croak() here, stuff is
156      *          rotten anyway! */
157     for (i = 0; i < nitems; ++i) {
158       Newxz(out[i], 1, anotherstruct);
159       elem = av_fetch(inary, i, 0);
160       if (elem == NULL)
161         Perl_croak(aTHX_ "Shouldn't happen: av_fetch returns NULL");
162       tmp = *elem;
163       SvGETMAGIC(tmp);
164       if (SvROK(tmp) && SvTYPE(SvRV(tmp)) == SVt_PVHV)
165          inhash = (HV*)SvRV(tmp);
166       else
167           Perl_croak(aTHX_ "Array element %u is not a HASH reference", i);
168
169       elem = hv_fetchs(inhash, "a", 0);
170       if (elem == NULL)
171         Perl_croak(aTHX_ "Shouldn't happen: hv_fetchs returns NULL");
172       out[i]->a = SvIV(*elem);
173
174       elem = hv_fetchs(inhash, "b", 0);
175       if (elem == NULL)
176         Perl_croak(aTHX_ "Shouldn't happen: hv_fetchs returns NULL");
177       out[i]->b = SvIV(*elem);
178
179       elem = hv_fetchs(inhash, "c", 0);
180       if (elem == NULL)
181         Perl_croak(aTHX_ "Shouldn't happen: hv_fetchs returns NULL");
182       out[i]->c = SvNV(*elem);
183
184     }
185
186     return out;
187 }
188
189 /* no special meaning as far as typemaps are concerned,
190  * just for convenience */
191 void
192 XS_release_anotherstructPtrPtr(anotherstruct **in)
193 {
194   unsigned int i = 0;
195   while (in[i] != NULL)
196     Safefree(in[i++]);
197   Safefree(in);
198 }
199
200
201 MODULE = XS::Typemap   PACKAGE = XS::Typemap
202
203 PROTOTYPES: DISABLE
204
205 TYPEMAP: <<END_OF_TYPEMAP
206
207 # Typemap file for typemap testing
208 # includes bonus typemap entries
209 # Mainly so that all the standard typemaps can be exercised even when
210 # there is not a corresponding type explicitly identified in the standard
211 # typemap
212
213 svtype           T_ENUM
214 intRef *         T_PTRREF
215 intRef           T_IV
216 intObj *         T_PTROBJ
217 intObj           T_IV
218 intRefIv *       T_REF_IV_PTR
219 intRefIv         T_IV
220 intArray *       T_ARRAY
221 intOpq           T_IV
222 intOpq   *       T_OPAQUEPTR
223 intUnsigned      T_U_INT
224 intTINT          T_INT
225 intTLONG         T_LONG
226 shortOPQ         T_OPAQUE
227 shortOPQ *       T_OPAQUEPTR
228 astruct *        T_OPAQUEPTR
229 anotherstruct *  T_PACKED
230 anotherstruct ** T_PACKEDARRAY
231 AV_FIXED *       T_AVREF_REFCOUNT_FIXED
232 HV_FIXED *       T_HVREF_REFCOUNT_FIXED
233 CV_FIXED *       T_CVREF_REFCOUNT_FIXED
234 SVREF_FIXED      T_SVREF_REFCOUNT_FIXED
235
236 END_OF_TYPEMAP
237
238 =head1 TYPEMAPS
239
240 The more you think about interfacing between two languages, the more
241 you'll realize that the majority of programmer effort has to go into
242 converting between the data structures that are native to either of
243 the languages involved. This trumps other matter such as differing
244 calling conventions because the problem space is so much greater.
245 There are simply more ways to shove data into memory than there are
246 ways to implement a function call.
247
248 Perl XS' attempt at a solution to this is the concept of typemaps.
249 At an abstract level, a Perl XS typemap is nothing but a recipe for
250 converting from a certain Perl data structure to a certain C
251 data structure and/or vice versa. Since there can be C types that
252 are sufficiently similar to warrant converting with the same logic,
253 XS typemaps are represented by a unique identifier, called XS type
254 henceforth in this document. You can then tell the XS compiler that
255 multiple C types are to be mapped with the same XS typemap.
256
257 In your XS code, when you define an argument with a C type or when
258 you are using a C<CODE:> and an C<OUTPUT:> section together with a
259 C return type of your XSUB, it'll be the typemapping mechanism that
260 makes this easy.
261
262 =head2 Anatomy of a typemap File
263
264 Traditionally, typemaps needed to be written to a separate file,
265 conventionally called C<typemap>. With ExtUtils::ParseXS (the XS
266 compiler) version 3.00 or better (comes with perl 5.16), typemaps
267 can also be embedded directly into your XS code using a HERE-doc
268 like syntax:
269
270   TYPEMAP: <<HERE
271   ...
272   HERE
273
274 where C<HERE> can be replaced by other identifiers like with normal
275 Perl HERE-docs. All details below about the typemap textual format
276 remain valid.
277
278 A typemap file generally has three sections: The C<TYPEMAP>
279 section is used to associate C types with XS type identifiers.
280 The C<INPUT> section is used to define the typemaps for I<input>
281 into the XSUB from Perl, and the C<OUTPUT> section has the opposite
282 conversion logic for getting data out of an XSUB back into Perl.
283
284 Each section is started by the section name in capital letters on a
285 line of its own. A typemap file implicitly starts in the C<TYPEMAP>
286 section. Each type of section can appear an arbitrary number of times
287 and does not have to appear at all. For example, a typemap file may
288 lack C<INPUT> and C<OUTPUT> sections if all it needs to do is
289 associate additional C types with core XS types like T_PTROBJ.
290 Lines that start with a hash C<#> are considered comments and ignored
291 in the C<TYPEMAP> section, but are considered significant in C<INPUT>
292 and C<OUTPUT>. Blank lines are generally ignored.
293
294 The C<TYPEMAP> section should contain one pair of C type and
295 XS type per line as follows. An example from the core typemap file:
296
297   TYPEMAP
298   # all variants of char* is handled by the T_PV typemap
299   char *          T_PV
300   const char *    T_PV
301   unsigned char * T_PV
302   ...
303
304 The C<INPUT> and C<OUTPUT> sections have identical formats, that is,
305 each unindented line starts a new in- or output map respectively.
306 A new in- or output map must start with the name of the XS type to
307 map on a line by itself, followed by the code that implements it
308 indented on the following lines. Example:
309
310   INPUT
311   T_PV
312     $var = ($type)SvPV_nolen($arg)
313   T_PTR
314     $var = INT2PTR($type,SvIV($arg))
315
316 We'll get to the meaning of those Perlish-looking variables in a
317 little bit.
318
319 Finally, here's an example of the full typemap file for mapping C
320 strings of the C<char *> type to Perl scalars/strings:
321
322   TYPEMAP
323   char *  T_PV
324   
325   INPUT
326   T_PV
327     $var = ($type)SvPV_nolen($arg)
328   
329   OUTPUT
330   T_PV
331     sv_setpv((SV*)$arg, $var);
332
333 =head2 The Role of the typemap File in Your Distribution
334
335 For CPAN distributions, you can assume that the XS types defined by
336 the perl core are already available. Additionally, the core typemap
337 has default XS types for a large number of C types. For example, if
338 you simply return a C<char *> from your XSUB, the core typemap will
339 have this C type associated with the T_PV XS type. That means your
340 C string will be copied into the PV (pointer value) slot of a new scalar
341 that will be returned from your XSUB to to Perl.
342
343 If you're developing a CPAN distribution using XS, you may add your own
344 file called F<typemap> to the distribution. That file may contain
345 typemaps that either map types that are specific to your code or that
346 override the core typemap file's mappings for common C types.
347
348 =head2 Sharing typemaps Between CPAN Distributions
349
350 Starting with ExtUtils::ParseXS version 3.12 (comes with perl 5.16
351 and better), it is rather easy to share typemap code between multiple
352 CPAN distributions. The general idea is to share it as a module that
353 offers a certain API and have the dependent modules declare that as a
354 built-time requirement and import the typemap into the XS. An example
355 of such a typemap-sharing module on CPAN is
356 C<ExtUtils::Typemaps::Basic>. Two steps to getting that module's
357 typemaps available in your code:
358
359 =over 4
360
361 =item *
362
363 Declare C<ExtUtils::Typemaps::Basic> as a built-time dependency
364 in C<Makefile.PL> (use C<BUILD_REQUIRES>), or in your C<Build.PL>
365 (use C<build_requires>).
366
367 =item *
368
369 Include the following line in the XS section of your XS file:
370 (don't break the line)
371
372   INCLUDE_COMMAND: $^X -MExtUtils::Typemaps::Cmd
373                    -e "print embeddable_typemap(q{Basic})"
374
375 =back
376
377 =head2 Full Listing of Core Typemaps
378
379 Each C type is represented by an entry in the typemap file that
380 is responsible for converting perl variables (SV, AV, HV, CV, etc.)
381 to and from that type. The following sections list all XS types
382 that come with perl by default.
383
384 =over 4
385
386 =item T_SV
387
388 This simply passes the C representation of the Perl variable (an SV*)
389 in and out of the XS layer. This can be used if the C code wants
390 to deal directly with the Perl variable.
391
392 =cut
393
394 SV *
395 T_SV( sv )
396   SV * sv
397  CODE:
398   /* create a new sv for return that is a copy of the input
399      do not simply copy the pointer since the SV will be marked
400      mortal by the INPUT typemap when it is pushed back onto the stack */
401   RETVAL = sv_mortalcopy( sv );
402   /* increment the refcount since the default INPUT typemap mortalizes
403      by default and we don't want to decrement the ref count twice
404      by mistake */
405   SvREFCNT_inc(RETVAL);
406  OUTPUT:
407   RETVAL
408
409 =item T_SVREF
410
411 Used to pass in and return a reference to an SV.
412
413 Note that this typemap does not decrement the reference count
414 when returning the reference to an SV*.
415 See also: T_SVREF_REFCOUNT_FIXED
416
417 =cut
418
419 SVREF
420 T_SVREF( svref )
421   SVREF svref
422  CODE:
423   RETVAL = svref;
424  OUTPUT:
425   RETVAL
426
427 =item T_SVREF_FIXED
428
429 Used to pass in and return a reference to an SV.
430 This is a fixed
431 variant of T_SVREF that decrements the refcount appropriately
432 when returning a reference to an SV*. Introduced in perl 5.15.4.
433
434 =cut
435
436 SVREF_FIXED
437 T_SVREF_REFCOUNT_FIXED( svref )
438   SVREF_FIXED svref
439  CODE:
440   SvREFCNT_inc(svref);
441   RETVAL = svref;
442  OUTPUT:
443   RETVAL
444
445 =item T_AVREF
446
447 From the perl level this is a reference to a perl array.
448 From the C level this is a pointer to an AV.
449
450 Note that this typemap does not decrement the reference count
451 when returning an AV*. See also: T_AVREF_REFCOUNT_FIXED
452
453 =cut
454
455 AV *
456 T_AVREF( av )
457   AV * av
458  CODE:
459   RETVAL = av;
460  OUTPUT:
461   RETVAL
462
463 =item T_AVREF_REFCOUNT_FIXED
464
465 From the perl level this is a reference to a perl array.
466 From the C level this is a pointer to an AV. This is a fixed
467 variant of T_AVREF that decrements the refcount appropriately
468 when returning an AV*. Introduced in perl 5.15.4.
469
470 =cut
471
472 AV_FIXED*
473 T_AVREF_REFCOUNT_FIXED( av )
474   AV_FIXED * av
475  CODE:
476   SvREFCNT_inc(av);
477   RETVAL = av;
478  OUTPUT:
479   RETVAL
480
481 =item T_HVREF
482
483 From the perl level this is a reference to a perl hash.
484 From the C level this is a pointer to an HV.
485
486 Note that this typemap does not decrement the reference count
487 when returning an HV*. See also: T_HVREF_REFCOUNT_FIXED
488
489 =cut
490
491 HV *
492 T_HVREF( hv )
493   HV * hv
494  CODE:
495   RETVAL = hv;
496  OUTPUT:
497   RETVAL
498
499 =item T_HVREF_REFCOUNT_FIXED
500
501 From the perl level this is a reference to a perl hash.
502 From the C level this is a pointer to an HV. This is a fixed
503 variant of T_HVREF that decrements the refcount appropriately
504 when returning an HV*. Introduced in perl 5.15.4.
505
506 =cut
507
508 HV_FIXED*
509 T_HVREF_REFCOUNT_FIXED( hv )
510   HV_FIXED * hv
511  CODE:
512   SvREFCNT_inc(hv);
513   RETVAL = hv;
514  OUTPUT:
515   RETVAL
516
517
518 =item T_CVREF
519
520 From the perl level this is a reference to a perl subroutine
521 (e.g. $sub = sub { 1 };). From the C level this is a pointer
522 to a CV.
523
524 Note that this typemap does not decrement the reference count
525 when returning an HV*. See also: T_HVREF_REFCOUNT_FIXED
526
527 =cut
528
529 CV *
530 T_CVREF( cv )
531   CV * cv
532  CODE:
533   RETVAL = cv;
534  OUTPUT:
535   RETVAL
536
537 =item T_CVREF_REFCOUNT_FIXED
538
539 From the perl level this is a reference to a perl subroutine
540 (e.g. $sub = sub { 1 };). From the C level this is a pointer
541 to a CV.
542
543 This is a fixed
544 variant of T_HVREF that decrements the refcount appropriately
545 when returning an HV*. Introduced in perl 5.15.4.
546
547 =cut
548
549 CV_FIXED *
550 T_CVREF_REFCOUNT_FIXED( cv )
551   CV_FIXED * cv
552  CODE:
553   SvREFCNT_inc(cv);
554   RETVAL = cv;
555  OUTPUT:
556   RETVAL
557
558 =item T_SYSRET
559
560 The T_SYSRET typemap is used to process return values from system calls.
561 It is only meaningful when passing values from C to perl (there is
562 no concept of passing a system return value from Perl to C).
563
564 System calls return -1 on error (setting ERRNO with the reason)
565 and (usually) 0 on success. If the return value is -1 this typemap
566 returns C<undef>. If the return value is not -1, this typemap
567 translates a 0 (perl false) to "0 but true" (which
568 is perl true) or returns the value itself, to indicate that the
569 command succeeded.
570
571 The L<POSIX|POSIX> module makes extensive use of this type.
572
573 =cut
574
575 # Test a successful return
576
577 SysRet
578 T_SYSRET_pass()
579  CODE:
580   RETVAL = 0;
581  OUTPUT:
582   RETVAL
583
584 # Test failure
585
586 SysRet
587 T_SYSRET_fail()
588  CODE:
589   RETVAL = -1;
590  OUTPUT:
591   RETVAL
592
593 =item T_UV
594
595 An unsigned integer.
596
597 =cut
598
599 unsigned int
600 T_UV( uv )
601   unsigned int uv
602  CODE:
603   RETVAL = uv;
604  OUTPUT:
605   RETVAL
606
607 =item T_IV
608
609 A signed integer. This is cast to the required integer type when
610 passed to C and converted to an IV when passed back to Perl.
611
612 =cut
613
614 long
615 T_IV( iv )
616   long iv
617  CODE:
618   RETVAL = iv;
619  OUTPUT:
620   RETVAL
621
622 =item T_INT
623
624 A signed integer. This typemap converts the Perl value to a native
625 integer type (the C<int> type on the current platform). When returning
626 the value to perl it is processed in the same way as for T_IV.
627
628 Its behaviour is identical to using an C<int> type in XS with T_IV.
629
630 =cut
631
632 intTINT
633 T_INT( i )
634   intTINT i
635  CODE:
636   RETVAL = i;
637  OUTPUT:
638   RETVAL
639
640 =item T_ENUM
641
642 An enum value. Used to transfer an enum component
643 from C. There is no reason to pass an enum value to C since
644 it is stored as an IV inside perl.
645
646 =cut
647
648 # The test should return the value for SVt_PVHV.
649 # 11 at the present time but we can't not rely on this
650 # for testing purposes.
651
652 svtype
653 T_ENUM()
654  CODE:
655   RETVAL = SVt_PVHV;
656  OUTPUT:
657   RETVAL
658
659 =item T_BOOL
660
661 A boolean type. This can be used to pass true and false values to and
662 from C.
663
664 =cut
665
666 bool
667 T_BOOL( in )
668   bool in
669  CODE:
670   RETVAL = in;
671  OUTPUT:
672   RETVAL
673
674 =item T_U_INT
675
676 This is for unsigned integers. It is equivalent to using T_UV
677 but explicitly casts the variable to type C<unsigned int>.
678 The default type for C<unsigned int> is T_UV.
679
680 =cut
681
682 intUnsigned
683 T_U_INT( uint )
684   intUnsigned uint
685  CODE:
686   RETVAL = uint;
687  OUTPUT:
688   RETVAL
689
690 =item T_SHORT
691
692 Short integers. This is equivalent to T_IV but explicitly casts
693 the return to type C<short>. The default typemap for C<short>
694 is T_IV.
695
696 =cut
697
698 short
699 T_SHORT( s )
700   short s
701  CODE:
702   RETVAL = s;
703  OUTPUT:
704   RETVAL
705
706 =item T_U_SHORT
707
708 Unsigned short integers. This is equivalent to T_UV but explicitly
709 casts the return to type C<unsigned short>. The default typemap for
710 C<unsigned short> is T_UV.
711
712 T_U_SHORT is used for type C<U16> in the standard typemap.
713
714 =cut
715
716 U16
717 T_U_SHORT( in )
718   U16 in
719  CODE:
720   RETVAL = in;
721  OUTPUT:
722   RETVAL
723
724
725 =item T_LONG
726
727 Long integers. This is equivalent to T_IV but explicitly casts
728 the return to type C<long>. The default typemap for C<long>
729 is T_IV.
730
731 =cut
732
733 intTLONG
734 T_LONG( in )
735   intTLONG in
736  CODE:
737   RETVAL = in;
738  OUTPUT:
739   RETVAL
740
741 =item T_U_LONG
742
743 Unsigned long integers. This is equivalent to T_UV but explicitly
744 casts the return to type C<unsigned long>. The default typemap for
745 C<unsigned long> is T_UV.
746
747 T_U_LONG is used for type C<U32> in the standard typemap.
748
749 =cut
750
751 U32
752 T_U_LONG( in )
753   U32 in
754  CODE:
755   RETVAL = in;
756  OUTPUT:
757   RETVAL
758
759 =item T_CHAR
760
761 Single 8-bit characters.
762
763 =cut
764
765 char
766 T_CHAR( in );
767   char in
768  CODE:
769   RETVAL = in;
770  OUTPUT:
771   RETVAL
772
773
774 =item T_U_CHAR
775
776 An unsigned byte.
777
778 =cut
779
780 unsigned char
781 T_U_CHAR( in );
782   unsigned char in
783  CODE:
784   RETVAL = in;
785  OUTPUT:
786   RETVAL
787
788
789 =item T_FLOAT
790
791 A floating point number. This typemap guarantees to return a variable
792 cast to a C<float>.
793
794 =cut
795
796 float
797 T_FLOAT( in )
798   float in
799  CODE:
800   RETVAL = in;
801  OUTPUT:
802   RETVAL
803
804 =item T_NV
805
806 A Perl floating point number. Similar to T_IV and T_UV in that the
807 return type is cast to the requested numeric type rather than
808 to a specific type.
809
810 =cut
811
812 NV
813 T_NV( in )
814   NV in
815  CODE:
816   RETVAL = in;
817  OUTPUT:
818   RETVAL
819
820 =item T_DOUBLE
821
822 A double precision floating point number. This typemap guarantees to
823 return a variable cast to a C<double>.
824
825 =cut
826
827 double
828 T_DOUBLE( in )
829   double in
830  CODE:
831   RETVAL = in;
832  OUTPUT:
833   RETVAL
834
835 =item T_PV
836
837 A string (char *).
838
839 =cut
840
841 char *
842 T_PV( in )
843   char * in
844  CODE:
845   RETVAL = in;
846  OUTPUT:
847   RETVAL
848
849 =item T_PTR
850
851 A memory address (pointer). Typically associated with a C<void *>
852 type.
853
854 =cut
855
856 # Pass in a value. Store the value in some static memory and
857 # then return the pointer
858
859 void *
860 T_PTR_OUT( in )
861   int in;
862  CODE:
863   xst_anint = in;
864   RETVAL = &xst_anint;
865  OUTPUT:
866   RETVAL
867
868 # pass in the pointer and return the value
869
870 int
871 T_PTR_IN( ptr )
872   void * ptr
873  CODE:
874   RETVAL = *(int *)ptr;
875  OUTPUT:
876   RETVAL
877
878 =item T_PTRREF
879
880 Similar to T_PTR except that the pointer is stored in a scalar and the
881 reference to that scalar is returned to the caller. This can be used
882 to hide the actual pointer value from the programmer since it is usually
883 not required directly from within perl.
884
885 The typemap checks that a scalar reference is passed from perl to XS.
886
887 =cut
888
889 # Similar test to T_PTR
890 # Pass in a value. Store the value in some static memory and
891 # then return the pointer
892
893 intRef *
894 T_PTRREF_OUT( in )
895   intRef in;
896  CODE:
897   xst_anintref = in;
898   RETVAL = &xst_anintref;
899  OUTPUT:
900   RETVAL
901
902 # pass in the pointer and return the value
903
904 intRef
905 T_PTRREF_IN( ptr )
906   intRef * ptr
907  CODE:
908   RETVAL = *ptr;
909  OUTPUT:
910   RETVAL
911
912
913
914 =item T_PTROBJ
915
916 Similar to T_PTRREF except that the reference is blessed into a class.
917 This allows the pointer to be used as an object. Most commonly used to
918 deal with C structs. The typemap checks that the perl object passed
919 into the XS routine is of the correct class (or part of a subclass).
920
921 The pointer is blessed into a class that is derived from the name
922 of type of the pointer but with all '*' in the name replaced with
923 'Ptr'.
924
925 =cut
926
927 # Similar test to T_PTRREF
928 # Pass in a value. Store the value in some static memory and
929 # then return the pointer
930
931 intObj *
932 T_PTROBJ_OUT( in )
933   intObj in;
934  CODE:
935   xst_anintobj = in;
936   RETVAL = &xst_anintobj;
937  OUTPUT:
938   RETVAL
939
940 # pass in the pointer and return the value
941
942 MODULE = XS::Typemap  PACKAGE = intObjPtr
943
944 intObj
945 T_PTROBJ_IN( ptr )
946   intObj * ptr
947  CODE:
948   RETVAL = *ptr;
949  OUTPUT:
950   RETVAL
951
952 MODULE = XS::Typemap PACKAGE = XS::Typemap
953
954 =item T_REF_IV_REF
955
956 NOT YET
957
958 =item T_REF_IV_PTR
959
960 Similar to T_PTROBJ in that the pointer is blessed into a scalar object.
961 The difference is that when the object is passed back into XS it must be
962 of the correct type (inheritance is not supported).
963
964 The pointer is blessed into a class that is derived from the name
965 of type of the pointer but with all '*' in the name replaced with
966 'Ptr'.
967
968 =cut
969
970 # Similar test to T_PTROBJ
971 # Pass in a value. Store the value in some static memory and
972 # then return the pointer
973
974 intRefIv *
975 T_REF_IV_PTR_OUT( in )
976   intRefIv in;
977  CODE:
978   xst_anintrefiv = in;
979   RETVAL = &xst_anintrefiv;
980  OUTPUT:
981   RETVAL
982
983 # pass in the pointer and return the value
984
985 MODULE = XS::Typemap  PACKAGE = intRefIvPtr
986
987 intRefIv
988 T_REF_IV_PTR_IN( ptr )
989   intRefIv * ptr
990  CODE:
991   RETVAL = *ptr;
992  OUTPUT:
993   RETVAL
994
995
996 MODULE = XS::Typemap PACKAGE = XS::Typemap
997
998 =item T_PTRDESC
999
1000 NOT YET
1001
1002 =item T_REFREF
1003
1004 Similar to T_PTRREF, except the pointer stored in the referenced scalar
1005 is dereferenced and copied to the output variable. This means that
1006 T_REFREF is to T_PTRREF as T_OPAQUE is to T_OPAQUEPTR. All clear?
1007
1008 Only the INPUT part of this is implemented (Perl to XSUB) and there
1009 are no known users in core or on CPAN.
1010
1011 =cut
1012
1013 =item T_REFOBJ
1014
1015 NOT YET
1016
1017 =item T_OPAQUEPTR
1018
1019 This can be used to store bytes in the string component of the
1020 SV. Here the representation of the data is irrelevant to perl and the
1021 bytes themselves are just stored in the SV. It is assumed that the C
1022 variable is a pointer (the bytes are copied from that memory
1023 location).  If the pointer is pointing to something that is
1024 represented by 8 bytes then those 8 bytes are stored in the SV (and
1025 length() will report a value of 8). This entry is similar to T_OPAQUE.
1026
1027 In principal the unpack() command can be used to convert the bytes
1028 back to a number (if the underlying type is known to be a number).
1029
1030 This entry can be used to store a C structure (the number
1031 of bytes to be copied is calculated using the C C<sizeof> function)
1032 and can be used as an alternative to T_PTRREF without having to worry
1033 about a memory leak (since Perl will clean up the SV).
1034
1035 =cut
1036
1037 intOpq *
1038 T_OPAQUEPTR_IN( val )
1039   intOpq val
1040  CODE:
1041   xst_anintopq = val;
1042   RETVAL = &xst_anintopq;
1043  OUTPUT:
1044   RETVAL
1045
1046 intOpq
1047 T_OPAQUEPTR_OUT( ptr )
1048   intOpq * ptr
1049  CODE:
1050   RETVAL = *ptr;
1051  OUTPUT:
1052   RETVAL
1053
1054 short
1055 T_OPAQUEPTR_OUT_short( ptr )
1056   shortOPQ * ptr
1057  CODE:
1058   RETVAL = *ptr;
1059  OUTPUT:
1060   RETVAL
1061
1062 # Test it with a structure
1063 astruct *
1064 T_OPAQUEPTR_IN_struct( a,b,c )
1065   int a
1066   int b
1067   double c
1068  PREINIT:
1069   struct t_opaqueptr test;
1070  CODE:
1071   test.a = a;
1072   test.b = b;
1073   test.c = c;
1074   RETVAL = &test;
1075  OUTPUT:
1076   RETVAL
1077
1078 void
1079 T_OPAQUEPTR_OUT_struct( test )
1080   astruct * test
1081  PPCODE:
1082   XPUSHs(sv_2mortal(newSViv(test->a)));
1083   XPUSHs(sv_2mortal(newSViv(test->b)));
1084   XPUSHs(sv_2mortal(newSVnv(test->c)));
1085
1086
1087 =item T_OPAQUE
1088
1089 This can be used to store data from non-pointer types in the string
1090 part of an SV. It is similar to T_OPAQUEPTR except that the
1091 typemap retrieves the pointer directly rather than assuming it
1092 is being supplied. For example, if an integer is imported into
1093 Perl using T_OPAQUE rather than T_IV the underlying bytes representing
1094 the integer will be stored in the SV but the actual integer value will not
1095 be available. i.e. The data is opaque to perl.
1096
1097 The data may be retrieved using the C<unpack> function if the
1098 underlying type of the byte stream is known.
1099
1100 T_OPAQUE supports input and output of simple types.
1101 T_OPAQUEPTR can be used to pass these bytes back into C if a pointer
1102 is acceptable.
1103
1104 =cut
1105
1106 shortOPQ
1107 T_OPAQUE_IN( val )
1108   int val
1109  CODE:
1110   RETVAL = (shortOPQ)val;
1111  OUTPUT:
1112   RETVAL
1113
1114 IV
1115 T_OPAQUE_OUT( val )
1116   shortOPQ val
1117  CODE:
1118   RETVAL = (IV)val;
1119  OUTPUT:
1120   RETVAL
1121
1122 =item Implicit array
1123
1124 xsubpp supports a special syntax for returning
1125 packed C arrays to perl. If the XS return type is given as
1126
1127   array(type, nelem)
1128
1129 xsubpp will copy the contents of C<nelem * sizeof(type)> bytes from
1130 RETVAL to an SV and push it onto the stack. This is only really useful
1131 if the number of items to be returned is known at compile time and you
1132 don't mind having a string of bytes in your SV.  Use T_ARRAY to push a
1133 variable number of arguments onto the return stack (they won't be
1134 packed as a single string though).
1135
1136 This is similar to using T_OPAQUEPTR but can be used to process more than
1137 one element.
1138
1139 =cut
1140
1141 array(int,3)
1142 T_OPAQUE_array( a,b,c)
1143   int a
1144   int b
1145   int c
1146  PREINIT:
1147   int array[3];
1148  CODE:
1149   array[0] = a;
1150   array[1] = b;
1151   array[2] = c;
1152   RETVAL = array;
1153  OUTPUT:
1154   RETVAL
1155
1156
1157 =item T_PACKED
1158
1159 Calls user-supplied functions for conversion. For C<OUTPUT>
1160 (XSUB to Perl), a function named C<XS_pack_$ntype> is called
1161 with the output Perl scalar and the C variable to convert from.
1162 C<$ntype> is the normalized C type that is to be mapped to
1163 Perl. Normalized means that all C<*> are replaced by the
1164 string C<Ptr>. The return value of the function is ignored.
1165
1166 Conversely for C<INPUT> (Perl to XSUB) mapping, the
1167 function named C<XS_unpack_$ntype> is called with the input Perl
1168 scalar as argument and the return value is cast to the mapped
1169 C type and assigned to the output C variable.
1170
1171 An example conversion function for a typemapped struct
1172 C<foo_t *> might be:
1173
1174   static void
1175   XS_pack_foo_tPtr(SV *out, foo_t *in)
1176   {
1177     dTHX; /* alas, signature does not include pTHX_ */
1178     HV* hash = newHV();
1179     hv_stores(hash, "int_member", newSViv(in->int_member));
1180     hv_stores(hash, "float_member", newSVnv(in->float_member));
1181     /* ... */
1182
1183     /* mortalize as thy stack is not refcounted */
1184     sv_setsv(out, sv_2mortal(newRV_noinc((SV*)hash)));
1185   }
1186
1187 The conversion from Perl to C is left as an exercise to the reader,
1188 but the prototype would be:
1189
1190   static foo_t *
1191   XS_unpack_foo_tPtr(SV *in);
1192
1193 Instead of an actual C function that has to fetch the thread context
1194 using C<dTHX>, you can define macros of the same name and avoid the
1195 overhead. Also, keep in mind to possibly free the memory allocated by
1196 C<XS_unpack_foo_tPtr>.
1197
1198 =cut
1199
1200 void
1201 T_PACKED_in(in)
1202   anotherstruct *in;
1203  PPCODE:
1204   mXPUSHi(in->a);
1205   mXPUSHi(in->b);
1206   mXPUSHn(in->c);
1207   Safefree(in);
1208   XSRETURN(3);
1209
1210 anotherstruct *
1211 T_PACKED_out(a, b ,c)
1212   int a;
1213   int b;
1214   double c;
1215  CODE:
1216   Newxz(RETVAL, 1, anotherstruct);
1217   RETVAL->a = a;
1218   RETVAL->b = b;
1219   RETVAL->c = c;
1220  OUTPUT: RETVAL
1221  CLEANUP:
1222   Safefree(RETVAL);
1223
1224 =item T_PACKEDARRAY
1225
1226 T_PACKEDARRAY is similar to T_PACKED. In fact, the C<INPUT> (Perl
1227 to XSUB) typemap is indentical, but the C<OUTPUT> typemap passes
1228 an additional argument to the C<XS_pack_$ntype> function. This
1229 third parameter indicates the number of elements in the output
1230 so that the function can handle C arrays sanely. The variable
1231 needs to be declared by the user and must have the name
1232 C<count_$ntype> where C<$ntype> is the normalized C type name
1233 as explained above. The signature of the function would be for
1234 the example above and C<foo_t **>:
1235
1236   static void
1237   XS_pack_foo_tPtrPtr(SV *out, foo_t *in, UV count_foo_tPtrPtr);
1238
1239 The type of the third parameter is arbitrary as far as the typemap
1240 is concerned. It just has to be in line with the declared variable.
1241
1242 Of course, unless you know the number of elements in the
1243 C<sometype **> C array, within your XSUB, the return value from
1244 C<foo_t ** XS_unpack_foo_tPtrPtr(...)> will be hard to decypher.
1245 Since the details are all up to the XS author (the typemap user),
1246 there are several solutions, none of which particularly elegant.
1247 The most commonly seen solution has been to allocate memory for
1248 N+1 pointers and assign C<NULL> to the (N+1)th to facilitate
1249 iteration.
1250
1251 Alternatively, using a customized typemap for your purposes in
1252 the first place is probably preferrable.
1253
1254 =cut
1255
1256 void
1257 T_PACKEDARRAY_in(in)
1258   anotherstruct **in;
1259  PREINIT:
1260   unsigned int i = 0;
1261  PPCODE:
1262   while (in[i] != NULL) {
1263     mXPUSHi(in[i]->a);
1264     mXPUSHi(in[i]->b);
1265     mXPUSHn(in[i]->c);
1266     ++i;
1267   }
1268   XS_release_anotherstructPtrPtr(in);
1269   XSRETURN(3*i);
1270
1271 anotherstruct **
1272 T_PACKEDARRAY_out(...)
1273  PREINIT:
1274   unsigned int i, nstructs, count_anotherstructPtrPtr;
1275  CODE:
1276   if ((items % 3) != 0)
1277     croak("Need nitems divisible by 3");
1278   nstructs = (unsigned int)(items / 3);
1279   count_anotherstructPtrPtr = nstructs;
1280   Newxz(RETVAL, nstructs+1, anotherstruct *);
1281   for (i = 0; i < nstructs; ++i) {
1282     Newxz(RETVAL[i], 1, anotherstruct);
1283     RETVAL[i]->a = SvIV(ST(3*i));
1284     RETVAL[i]->b = SvIV(ST(3*i+1));
1285     RETVAL[i]->c = SvNV(ST(3*i+2));
1286   }
1287  OUTPUT: RETVAL
1288  CLEANUP:
1289   XS_release_anotherstructPtrPtr(RETVAL);
1290
1291 =item T_DATAUNIT
1292
1293 NOT YET
1294
1295 =item T_CALLBACK
1296
1297 NOT YET
1298
1299 =item T_ARRAY
1300
1301 This is used to convert the perl argument list to a C array
1302 and for pushing the contents of a C array onto the perl
1303 argument stack.
1304
1305 The usual calling signature is
1306
1307   @out = array_func( @in );
1308
1309 Any number of arguments can occur in the list before the array but
1310 the input and output arrays must be the last elements in the list.
1311
1312 When used to pass a perl list to C the XS writer must provide a
1313 function (named after the array type but with 'Ptr' substituted for
1314 '*') to allocate the memory required to hold the list. A pointer
1315 should be returned. It is up to the XS writer to free the memory on
1316 exit from the function. The variable C<ix_$var> is set to the number
1317 of elements in the new array.
1318
1319 When returning a C array to Perl the XS writer must provide an integer
1320 variable called C<size_$var> containing the number of elements in the
1321 array. This is used to determine how many elements should be pushed
1322 onto the return argument stack. This is not required on input since
1323 Perl knows how many arguments are on the stack when the routine is
1324 called. Ordinarily this variable would be called C<size_RETVAL>.
1325
1326 Additionally, the type of each element is determined from the type of
1327 the array. If the array uses type C<intArray *> xsubpp will
1328 automatically work out that it contains variables of type C<int> and
1329 use that typemap entry to perform the copy of each element. All
1330 pointer '*' and 'Array' tags are removed from the name to determine
1331 the subtype.
1332
1333 =cut
1334
1335 # Test passes in an integer array and returns it along with
1336 # the number of elements
1337 # Pass in a dummy value to test offsetting
1338
1339 # Problem is that xsubpp does XSRETURN(1) because we arent
1340 # using PPCODE. This means that only the first element
1341 # is returned. KLUGE this by using CLEANUP to return before the
1342 # end.
1343 # Note: I read this as: The "T_ARRAY" typemap is really rather broken,
1344 #       at least for OUTPUT. That is apart from the general design
1345 #       weaknesses. --Steffen
1346
1347 intArray *
1348 T_ARRAY( dummy, array, ... )
1349   int dummy = 0;
1350   intArray * array
1351  PREINIT:
1352   U32 size_RETVAL;
1353  CODE:
1354   dummy += 0; /* Fix -Wall */
1355   size_RETVAL = ix_array;
1356   RETVAL = array;
1357  OUTPUT:
1358   RETVAL
1359  CLEANUP:
1360   Safefree(array);
1361   XSRETURN(size_RETVAL);
1362
1363
1364 =item T_STDIO
1365
1366 This is used for passing perl filehandles to and from C using
1367 C<FILE *> structures.
1368
1369 =cut
1370
1371 FILE *
1372 T_STDIO_open( file )
1373   const char * file
1374  CODE:
1375   RETVAL = xsfopen( file );
1376  OUTPUT:
1377   RETVAL
1378
1379 SysRet
1380 T_STDIO_close( f )
1381   PerlIO * f
1382  PREINIT:
1383   FILE * stream;
1384  CODE:
1385   /* Get the FILE* */
1386   stream = PerlIO_findFILE( f );  
1387   /* Release the FILE* from the PerlIO system so that we do
1388      not close the file twice */
1389   PerlIO_releaseFILE(f,stream);
1390   /* Must release the file before closing it */
1391   RETVAL = xsfclose( stream );
1392  OUTPUT:
1393   RETVAL
1394
1395 int
1396 T_STDIO_print( stream, string )
1397   FILE * stream
1398   const char * string
1399  CODE:
1400   RETVAL = xsfprintf( stream, string );
1401  OUTPUT:
1402   RETVAL
1403
1404
1405 =item T_IN
1406
1407 NOT YET
1408
1409 =item T_INOUT
1410
1411 This is used for passing perl filehandles to and from C using
1412 C<PerlIO *> structures. The file handle can used for reading and
1413 writing.
1414
1415 See L<perliol> for more information on the Perl IO abstraction
1416 layer. Perl must have been built with C<-Duseperlio>.
1417
1418 =cut
1419
1420 PerlIO *
1421 T_INOUT(in)
1422   PerlIO *in;
1423  CODE:
1424   RETVAL = in; /* silly test but better than nothing */
1425  OUTPUT: RETVAL
1426
1427 =item T_OUT
1428
1429 NOT YET
1430
1431 =back
1432
1433 =cut
1434