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