3 perliol - C API for Perl's implementation of IO in Layers.
7 /* Defining a layer ... */
12 This document describes the behavior and implementation of the PerlIO
13 abstraction described in L<perlapio> when C<USE_PERLIO> is defined.
15 =head2 History and Background
17 The PerlIO abstraction was introduced in perl5.003_02 but languished as
18 just an abstraction until perl5.7.0. However during that time a number
19 of perl extensions switched to using it, so the API is mostly fixed to
20 maintain (source) compatibility.
22 The aim of the implementation is to provide the PerlIO API in a flexible
23 and platform neutral manner. It is also a trial of an "Object Oriented
24 C, with vtables" approach which may be applied to Raku.
26 =head2 Basic Structure
28 PerlIO is a stack of layers.
30 The low levels of the stack work with the low-level operating system
31 calls (file descriptors in C) getting bytes in and out, the higher
32 layers of the stack buffer, filter, and otherwise manipulate the I/O,
33 and return characters (or bytes) to Perl. Terms I<above> and I<below>
34 are used to refer to the relative positioning of the stack layers.
36 A layer contains a "vtable", the table of I/O operations (at C level
37 a table of function pointers), and status flags. The functions in the
38 vtable implement operations like "open", "read", and "write".
40 When I/O, for example "read", is requested, the request goes from Perl
41 first down the stack using "read" functions of each layer, then at the
42 bottom the input is requested from the operating system services, then
43 the result is returned up the stack, finally being interpreted as Perl
46 The requests do not necessarily go always all the way down to the
47 operating system: that's where PerlIO buffering comes into play.
49 When you do an open() and specify extra PerlIO layers to be deployed,
50 the layers you specify are "pushed" on top of the already existing
51 default stack. One way to see it is that "operating system is
52 on the left" and "Perl is on the right".
54 What exact layers are in this default stack depends on a lot of
55 things: your operating system, Perl version, Perl compile time
56 configuration, and Perl runtime configuration. See L<PerlIO>,
57 L<perlrun/PERLIO>, and L<open> for more information.
59 binmode() operates similarly to open(): by default the specified
60 layers are pushed on top of the existing stack.
62 However, note that even as the specified layers are "pushed on top"
63 for open() and binmode(), this doesn't mean that the effects are
64 limited to the "top": PerlIO layers can be very 'active' and inspect
65 and affect layers also deeper in the stack. As an example there
66 is a layer called "raw" which repeatedly "pops" layers until
67 it reaches the first layer that has declared itself capable of
68 handling binary data. The "pushed" layers are processed in left-to-right
71 sysopen() operates (unsurprisingly) at a lower level in the stack than
72 open(). For example in Unix or Unix-like systems sysopen() operates
73 directly at the level of file descriptors: in the terms of PerlIO
74 layers, it uses only the "unix" layer, which is a rather thin wrapper
75 on top of the Unix file descriptors.
77 =head2 Layers vs Disciplines
79 Initial discussion of the ability to modify IO streams behaviour used
80 the term "discipline" for the entities which were added. This came (I
81 believe) from the use of the term in "sfio", which in turn borrowed it
82 from "line disciplines" on Unix terminals. However, this document (and
83 the C code) uses the term "layer".
85 This is, I hope, a natural term given the implementation, and should
86 avoid connotations that are inherent in earlier uses of "discipline"
87 for things which are rather different.
89 =head2 Data Structures
91 The basic data structure is a PerlIOl:
93 typedef struct _PerlIO PerlIOl;
94 typedef struct _PerlIO_funcs PerlIO_funcs;
95 typedef PerlIOl *PerlIO;
99 PerlIOl * next; /* Lower layer */
100 PerlIO_funcs * tab; /* Functions for this layer */
101 U32 flags; /* Various flags for state */
104 A C<PerlIOl *> is a pointer to the struct, and the I<application>
105 level C<PerlIO *> is a pointer to a C<PerlIOl *> - i.e. a pointer
106 to a pointer to the struct. This allows the application level C<PerlIO *>
107 to remain constant while the actual C<PerlIOl *> underneath
108 changes. (Compare perl's C<SV *> which remains constant while its
109 C<sv_any> field changes as the scalar's type changes.) An IO stream is
110 then in general represented as a pointer to this linked-list of
113 It should be noted that because of the double indirection in a C<PerlIO *>,
114 a C<< &(perlio->next) >> "is" a C<PerlIO *>, and so to some degree
115 at least one layer can use the "standard" API on the next layer down.
117 A "layer" is composed of two parts:
123 The functions and attributes of the "layer class".
127 The per-instance data for a particular handle.
131 =head2 Functions and Attributes
133 The functions and attributes are accessed via the "tab" (for table)
134 member of C<PerlIOl>. The functions (methods of the layer "class") are
135 fixed, and are defined by the C<PerlIO_funcs> type. They are broadly the
136 same as the public C<PerlIO_xxxxx> functions:
144 IV (*Pushed)(pTHX_ PerlIO *f,
148 IV (*Popped)(pTHX_ PerlIO *f);
149 PerlIO * (*Open)(pTHX_ PerlIO_funcs *tab,
150 PerlIO_list_t *layers, IV n,
152 int fd, int imode, int perm,
154 int narg, SV **args);
155 IV (*Binmode)(pTHX_ PerlIO *f);
156 SV * (*Getarg)(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
157 IV (*Fileno)(pTHX_ PerlIO *f);
158 PerlIO * (*Dup)(pTHX_ PerlIO *f,
162 /* Unix-like functions - cf sfio line disciplines */
163 SSize_t (*Read)(pTHX_ PerlIO *f, void *vbuf, Size_t count);
164 SSize_t (*Unread)(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
165 SSize_t (*Write)(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
166 IV (*Seek)(pTHX_ PerlIO *f, Off_t offset, int whence);
167 Off_t (*Tell)(pTHX_ PerlIO *f);
168 IV (*Close)(pTHX_ PerlIO *f);
169 /* Stdio-like buffered IO functions */
170 IV (*Flush)(pTHX_ PerlIO *f);
171 IV (*Fill)(pTHX_ PerlIO *f);
172 IV (*Eof)(pTHX_ PerlIO *f);
173 IV (*Error)(pTHX_ PerlIO *f);
174 void (*Clearerr)(pTHX_ PerlIO *f);
175 void (*Setlinebuf)(pTHX_ PerlIO *f);
176 /* Perl's snooping functions */
177 STDCHAR * (*Get_base)(pTHX_ PerlIO *f);
178 Size_t (*Get_bufsiz)(pTHX_ PerlIO *f);
179 STDCHAR * (*Get_ptr)(pTHX_ PerlIO *f);
180 SSize_t (*Get_cnt)(pTHX_ PerlIO *f);
181 void (*Set_ptrcnt)(pTHX_ PerlIO *f,STDCHAR *ptr,SSize_t cnt);
184 The first few members of the struct give a function table size for
185 compatibility check "name" for the layer, the size to C<malloc> for the per-instance data,
186 and some flags which are attributes of the class as whole (such as whether it is a buffering
187 layer), then follow the functions which fall into four basic groups:
193 Opening and setup functions
201 Stdio class buffering options.
205 Functions to support Perl's traditional "fast" access to the buffer.
209 A layer does not have to implement all the functions, but the whole
210 table has to be present. Unimplemented slots can be NULL (which will
211 result in an error when called) or can be filled in with stubs to
212 "inherit" behaviour from a "base class". This "inheritance" is fixed
213 for all instances of the layer, but as the layer chooses which stubs
214 to populate the table, limited "multiple inheritance" is possible.
216 =head2 Per-instance Data
218 The per-instance data are held in memory beyond the basic PerlIOl
219 struct, by making a PerlIOl the first member of the layer's struct
224 struct _PerlIO base; /* Base "class" info */
225 STDCHAR * buf; /* Start of buffer */
226 STDCHAR * end; /* End of valid part of buffer */
227 STDCHAR * ptr; /* Current position in buffer */
228 Off_t posn; /* Offset of buf into the file */
229 Size_t bufsiz; /* Real size of buffer */
230 IV oneword; /* Emergency buffer */
233 In this way (as for perl's scalars) a pointer to a PerlIOBuf can be
234 treated as a pointer to a PerlIOl.
236 =head2 Layers in action.
240 +-----------+ +----------+ +--------+
241 PerlIO ->| |--->| next |--->| NULL |
242 +-----------+ +----------+ +--------+
243 | | | buffer | | fd |
244 +-----------+ | | +--------+
248 The above attempts to show how the layer scheme works in a simple case.
249 The application's C<PerlIO *> points to an entry in the table(s)
250 representing open (allocated) handles. For example the first three slots
251 in the table correspond to C<stdin>,C<stdout> and C<stderr>. The table
252 in turn points to the current "top" layer for the handle - in this case
253 an instance of the generic buffering layer "perlio". That layer in turn
254 points to the next layer down - in this case the low-level "unix" layer.
256 The above is roughly equivalent to a "stdio" buffered stream, but with
257 much more flexibility:
263 If Unix level C<read>/C<write>/C<lseek> is not appropriate for (say)
264 sockets then the "unix" layer can be replaced (at open time or even
265 dynamically) with a "socket" layer.
269 Different handles can have different buffering schemes. The "top"
270 layer could be the "mmap" layer if reading disk files was quicker
271 using C<mmap> than C<read>. An "unbuffered" stream can be implemented
272 simply by not having a buffer layer.
276 Extra layers can be inserted to process the data as it flows through.
277 This was the driving need for including the scheme in perl 5.7.0+ - we
278 needed a mechanism to allow data to be translated between perl's
279 internal encoding (conceptually at least Unicode as UTF-8), and the
280 "native" format used by the system. This is provided by the
281 ":encoding(xxxx)" layer which typically sits above the buffering layer.
285 A layer can be added that does "\n" to CRLF translation. This layer
286 can be used on any platform, not just those that normally do such
291 =head2 Per-instance flag bits
293 The generic flag bits are a hybrid of C<O_XXXXX> style flags deduced
294 from the mode string passed to C<PerlIO_open()>, and state bits for
295 typical buffer layers.
303 =item PERLIO_F_CANWRITE
305 Writes are permitted, i.e. opened as "w" or "r+" or "a", etc.
307 =item PERLIO_F_CANREAD
309 Reads are permitted i.e. opened "r" or "w+" (or even "a+" - ick).
313 An error has occurred (for C<PerlIO_error()>).
315 =item PERLIO_F_TRUNCATE
317 Truncate file suggested by open mode.
319 =item PERLIO_F_APPEND
321 All writes should be appends.
325 Layer is performing Win32-like "\n" mapped to CR,LF for output and CR,LF
326 mapped to "\n" for input. Normally the provided "crlf" layer is the only
327 layer that need bother about this. C<PerlIO_binmode()> will mess with this
328 flag rather than add/remove layers if the C<PERLIO_K_CANCRLF> bit is set
329 for the layers class.
333 Data written to this layer should be UTF-8 encoded; data provided
334 by this layer should be considered UTF-8 encoded. Can be set on any layer
335 by ":utf8" dummy layer. Also set on ":encoding" layer.
339 Layer is unbuffered - i.e. write to next layer down should occur for
340 each write to this layer.
344 The buffer for this layer currently holds data written to it but not sent
349 The buffer for this layer currently holds unconsumed data read from
352 =item PERLIO_F_LINEBUF
354 Layer is line buffered. Write data should be passed to next layer down
355 whenever a "\n" is seen. Any data beyond the "\n" should then be
360 File has been C<unlink()>ed, or should be deleted on C<close()>.
366 =item PERLIO_F_FASTGETS
368 This instance of this layer supports the "fast C<gets>" interface.
369 Normally set based on C<PERLIO_K_FASTGETS> for the class and by the
370 existence of the function(s) in the table. However a class that
371 normally provides that interface may need to avoid it on a
372 particular instance. The "pending" layer needs to do this when
373 it is pushed above a layer which does not support the interface.
374 (Perl's C<sv_gets()> does not expect the streams fast C<gets> behaviour
375 to change during one "get".)
377 =for apidoc Amnh||PERLIO_F_APPEND
378 =for apidoc_item || PERLIO_F_CANREAD
379 =for apidoc_item ||PERLIO_F_CANWRITE
380 =for apidoc_item ||PERLIO_F_CRLF
381 =for apidoc_item ||PERLIO_F_EOF
382 =for apidoc_item ||PERLIO_F_ERROR
383 =for apidoc_item ||PERLIO_F_FASTGETS
384 =for apidoc_item ||PERLIO_F_LINEBUF
385 =for apidoc_item ||PERLIO_F_OPEN
386 =for apidoc_item ||PERLIO_F_RDBUF
387 =for apidoc_item ||PERLIO_F_TEMP
388 =for apidoc_item ||PERLIO_F_TRUNCATE
389 =for apidoc_item ||PERLIO_F_UNBUF
390 =for apidoc_item ||PERLIO_F_UTF8
391 =for apidoc_item ||PERLIO_F_WRBUF
395 =head2 Methods in Detail
403 Size of the function table. This is compared against the value PerlIO
404 code "knows" as a compatibility check. Future versions I<may> be able
405 to tolerate layers compiled against an old version of the headers.
411 The name of the layer whose open() method Perl should invoke on
412 open(). For example if the layer is called APR, you will call:
414 open $fh, ">:APR", ...
416 and Perl knows that it has to invoke the PerlIOAPR_open() method
417 implemented by the APR layer.
423 The size of the per-instance data structure, e.g.:
427 If this field is zero then C<PerlIO_pushed> does not malloc anything
428 and assumes layer's Pushed function will do any required layer stack
429 manipulation - used to avoid malloc/free overhead for dummy layers.
430 If the field is non-zero it must be at least the size of C<PerlIOl>,
431 C<PerlIO_pushed> will allocate memory for the layer's data structures
432 and link new layer onto the stream's stack. (If the layer's Pushed
433 method returns an error indication the layer is popped again.)
441 =item * PERLIO_K_BUFFERED
443 The layer is buffered.
447 The layer is acceptable to have in a binmode(FH) stack - i.e. it does not
448 (or will configure itself not to) transform bytes passing through it.
450 =item * PERLIO_K_CANCRLF
452 Layer can translate between "\n" and CRLF line ends.
454 =item * PERLIO_K_FASTGETS
456 Layer allows buffer snooping.
458 =item * PERLIO_K_MULTIARG
460 Used when the layer's open() accepts more arguments than usual. The
461 extra arguments should come not before the C<MODE> argument. When this
462 flag is used it's up to the layer to validate the args.
464 =for apidoc Amnh|| PERLIO_K_BUFFERED
465 =for apidoc_item || PERLIO_K_CANCRLF
466 =for apidoc_item || PERLIO_K_FASTGETS
467 =for apidoc_item || PERLIO_K_MULTIARG
468 =for apidoc_item || PERLIO_K_RAW
474 IV (*Pushed)(pTHX_ PerlIO *f,const char *mode, SV *arg);
476 The only absolutely mandatory method. Called when the layer is pushed
477 onto the stack. The C<mode> argument may be NULL if this occurs
478 post-open. The C<arg> will be non-C<NULL> if an argument string was
479 passed. In most cases this should call C<PerlIOBase_pushed()> to
480 convert C<mode> into the appropriate C<PERLIO_F_XXXXX> flags in
481 addition to any actions the layer itself takes. If a layer is not
482 expecting an argument it need neither save the one passed to it, nor
483 provide C<Getarg()> (it could perhaps C<Perl_warn> that the argument
486 Returns 0 on success. On failure returns -1 and should set errno.
490 IV (*Popped)(pTHX_ PerlIO *f);
492 Called when the layer is popped from the stack. A layer will normally
493 be popped after C<Close()> is called. But a layer can be popped
494 without being closed if the program is dynamically managing layers on
495 the stream. In such cases C<Popped()> should free any resources
496 (buffers, translation tables, ...) not held directly in the layer's
497 struct. It should also C<Unread()> any unconsumed data that has been
498 read and buffered from the layer below back to that layer, so that it
499 can be re-provided to what ever is now above.
501 Returns 0 on success and failure. If C<Popped()> returns I<true> then
502 I<perlio.c> assumes that either the layer has popped itself, or the
503 layer is super special and needs to be retained for other reasons.
504 In most cases it should return I<false>.
508 PerlIO * (*Open)(...);
510 The C<Open()> method has lots of arguments because it combines the
511 functions of perl's C<open>, C<PerlIO_open>, perl's C<sysopen>,
512 C<PerlIO_fdopen> and C<PerlIO_reopen>. The full prototype is as
515 PerlIO * (*Open)(pTHX_ PerlIO_funcs *tab,
516 PerlIO_list_t *layers, IV n,
518 int fd, int imode, int perm,
520 int narg, SV **args);
522 Open should (perhaps indirectly) call C<PerlIO_allocate()> to allocate
523 a slot in the table and associate it with the layers information for
524 the opened file, by calling C<PerlIO_push>. The I<layers> is an
525 array of all the layers destined for the C<PerlIO *>, and any
526 arguments passed to them, I<n> is the index into that array of the
527 layer being called. The macro C<PerlIOArg> will return a (possibly
528 C<NULL>) SV * for the argument passed to the layer.
530 Where a layer opens or takes ownership of a file descriptor, that layer is
531 responsible for getting the file descriptor's close-on-exec flag into the
532 correct state. The flag should be clear for a file descriptor numbered
533 less than or equal to C<PL_maxsysfd>, and set for any file descriptor
534 numbered higher. For thread safety, when a layer opens a new file
535 descriptor it should if possible open it with the close-on-exec flag
538 =for apidoc Amnh||PL_maxsysfd
540 The I<mode> string is an "C<fopen()>-like" string which would match
541 the regular expression C</^[I#]?[rwa]\+?[bt]?$/>.
543 The C<'I'> prefix is used during creation of C<stdin>..C<stderr> via
544 special C<PerlIO_fdopen> calls; the C<'#'> prefix means that this is
545 C<sysopen> and that I<imode> and I<perm> should be passed to
546 C<PerlLIO_open3>; C<'r'> means B<r>ead, C<'w'> means B<w>rite and
547 C<'a'> means B<a>ppend. The C<'+'> suffix means that both reading and
548 writing/appending are permitted. The C<'b'> suffix means file should
549 be binary, and C<'t'> means it is text. (Almost all layers should do
550 the IO in binary mode, and ignore the b/t bits. The C<:crlf> layer
551 should be pushed to handle the distinction.)
553 If I<old> is not C<NULL> then this is a C<PerlIO_reopen>. Perl itself
554 does not use this (yet?) and semantics are a little vague.
556 If I<fd> not negative then it is the numeric file descriptor I<fd>,
557 which will be open in a manner compatible with the supplied mode
558 string, the call is thus equivalent to C<PerlIO_fdopen>. In this case
559 I<nargs> will be zero.
560 The file descriptor may have the close-on-exec flag either set or clear;
561 it is the responsibility of the layer that takes ownership of it to get
562 the flag into the correct state.
564 If I<nargs> is greater than zero then it gives the number of arguments
565 passed to C<open>, otherwise it will be 1 if for example
566 C<PerlIO_open> was called. In simple cases SvPV_nolen(*args) is the
569 If a layer provides C<Open()> it should normally call the C<Open()>
570 method of next layer down (if any) and then push itself on top if that
571 succeeds. C<PerlIOBase_open> is provided to do exactly that, so in
572 most cases you don't have to write your own C<Open()> method. If this
573 method is not defined, other layers may have difficulty pushing
574 themselves on top of it during open.
576 If C<PerlIO_push> was performed and open has failed, it must
577 C<PerlIO_pop> itself, since if it's not, the layer won't be removed
578 and may cause bad problems.
580 Returns C<NULL> on failure.
584 IV (*Binmode)(pTHX_ PerlIO *f);
586 Optional. Used when C<:raw> layer is pushed (explicitly or as a result
587 of binmode(FH)). If not present layer will be popped. If present
588 should configure layer as binary (or pop itself) and return 0.
589 If it returns -1 for error C<binmode> will fail with layer
594 SV * (*Getarg)(pTHX_ PerlIO *f,
595 CLONE_PARAMS *param, int flags);
597 Optional. If present should return an SV * representing the string
598 argument passed to the layer when it was
599 pushed. e.g. ":encoding(ascii)" would return an SvPV with value
600 "ascii". (I<param> and I<flags> arguments can be ignored in most
603 C<Dup> uses C<Getarg> to retrieve the argument originally passed to
604 C<Pushed>, so you must implement this function if your layer has an
605 extra argument to C<Pushed> and will ever be C<Dup>ed.
609 IV (*Fileno)(pTHX_ PerlIO *f);
611 Returns the Unix/Posix numeric file descriptor for the handle. Normally
612 C<PerlIOBase_fileno()> (which just asks next layer down) will suffice
615 Returns -1 on error, which is considered to include the case where the
616 layer cannot provide such a file descriptor.
620 PerlIO * (*Dup)(pTHX_ PerlIO *f, PerlIO *o,
621 CLONE_PARAMS *param, int flags);
623 XXX: Needs more docs.
625 Used as part of the "clone" process when a thread is spawned (in which
626 case param will be non-NULL) and when a stream is being duplicated via
629 Similar to C<Open>, returns PerlIO* on success, C<NULL> on failure.
633 SSize_t (*Read)(pTHX_ PerlIO *f, void *vbuf, Size_t count);
635 Basic read operation.
637 Typically will call C<Fill> and manipulate pointers (possibly via the
638 API). C<PerlIOBuf_read()> may be suitable for derived classes which
639 provide "fast gets" methods.
641 Returns actual bytes read, or -1 on an error.
645 SSize_t (*Unread)(pTHX_ PerlIO *f,
646 const void *vbuf, Size_t count);
648 A superset of stdio's C<ungetc()>. Should arrange for future reads to
649 see the bytes in C<vbuf>. If there is no obviously better implementation
650 then C<PerlIOBase_unread()> provides the function by pushing a "fake"
651 "pending" layer above the calling layer.
653 Returns the number of unread chars.
657 SSize_t (*Write)(PerlIO *f, const void *vbuf, Size_t count);
659 Basic write operation.
661 Returns bytes written or -1 on an error.
665 IV (*Seek)(pTHX_ PerlIO *f, Off_t offset, int whence);
667 Position the file pointer. Should normally call its own C<Flush>
668 method and then the C<Seek> method of next layer down.
670 Returns 0 on success, -1 on failure.
674 Off_t (*Tell)(pTHX_ PerlIO *f);
676 Return the file pointer. May be based on layers cached concept of
677 position to avoid overhead.
679 Returns -1 on failure to get the file pointer.
683 IV (*Close)(pTHX_ PerlIO *f);
685 Close the stream. Should normally call C<PerlIOBase_close()> to flush
686 itself and close layers below, and then deallocate any data structures
687 (buffers, translation tables, ...) not held directly in the data
690 Returns 0 on success, -1 on failure.
694 IV (*Flush)(pTHX_ PerlIO *f);
696 Should make stream's state consistent with layers below. That is, any
697 buffered write data should be written, and file position of lower layers
698 adjusted for data read from below but not actually consumed.
699 (Should perhaps C<Unread()> such data to the lower layer.)
701 Returns 0 on success, -1 on failure.
705 IV (*Fill)(pTHX_ PerlIO *f);
707 The buffer for this layer should be filled (for read) from layer
708 below. When you "subclass" PerlIOBuf layer, you want to use its
709 I<_read> method and to supply your own fill method, which fills the
712 Returns 0 on success, -1 on failure.
716 IV (*Eof)(pTHX_ PerlIO *f);
718 Return end-of-file indicator. C<PerlIOBase_eof()> is normally sufficient.
720 Returns 0 on end-of-file, 1 if not end-of-file, -1 on error.
724 IV (*Error)(pTHX_ PerlIO *f);
726 Return error indicator. C<PerlIOBase_error()> is normally sufficient.
728 Returns 1 if there is an error (usually when C<PERLIO_F_ERROR> is set),
733 void (*Clearerr)(pTHX_ PerlIO *f);
735 Clear end-of-file and error indicators. Should call C<PerlIOBase_clearerr()>
736 to set the C<PERLIO_F_XXXXX> flags, which may suffice.
740 void (*Setlinebuf)(pTHX_ PerlIO *f);
742 Mark the stream as line buffered. C<PerlIOBase_setlinebuf()> sets the
743 PERLIO_F_LINEBUF flag and is normally sufficient.
747 STDCHAR * (*Get_base)(pTHX_ PerlIO *f);
749 Allocate (if not already done so) the read buffer for this layer and
750 return pointer to it. Return NULL on failure.
754 Size_t (*Get_bufsiz)(pTHX_ PerlIO *f);
756 Return the number of bytes that last C<Fill()> put in the buffer.
760 STDCHAR * (*Get_ptr)(pTHX_ PerlIO *f);
762 Return the current read pointer relative to this layer's buffer.
766 SSize_t (*Get_cnt)(pTHX_ PerlIO *f);
768 Return the number of bytes left to be read in the current buffer.
772 void (*Set_ptrcnt)(pTHX_ PerlIO *f,
773 STDCHAR *ptr, SSize_t cnt);
775 Adjust the read pointer and count of bytes to match C<ptr> and/or C<cnt>.
776 The application (or layer above) must ensure they are consistent.
777 (Checking is allowed by the paranoid.)
783 To ask for the next layer down use PerlIONext(PerlIO *f).
785 To check that a PerlIO* is valid use PerlIOValid(PerlIO *f). (All
786 this does is really just to check that the pointer is non-NULL and
787 that the pointer behind that is non-NULL.)
789 PerlIOBase(PerlIO *f) returns the "Base" pointer, or in other words,
790 the C<PerlIOl*> pointer.
792 PerlIOSelf(PerlIO* f, type) return the PerlIOBase cast to a type.
794 Perl_PerlIO_or_Base(PerlIO* f, callback, base, failure, args) either
795 calls the I<callback> from the functions of the layer I<f> (just by
796 the name of the IO function, like "Read") with the I<args>, or if
797 there is no such callback, calls the I<base> version of the callback
798 with the same args, or if the f is invalid, set errno to EBADF and
801 Perl_PerlIO_or_fail(PerlIO* f, callback, failure, args) either calls
802 the I<callback> of the functions of the layer I<f> with the I<args>,
803 or if there is no such callback, set errno to EINVAL. Or if the f is
804 invalid, set errno to EBADF and return I<failure>.
806 Perl_PerlIO_or_Base_void(PerlIO* f, callback, base, args) either calls
807 the I<callback> of the functions of the layer I<f> with the I<args>,
808 or if there is no such callback, calls the I<base> version of the
809 callback with the same args, or if the f is invalid, set errno to
812 Perl_PerlIO_or_fail_void(PerlIO* f, callback, args) either calls the
813 I<callback> of the functions of the layer I<f> with the I<args>, or if
814 there is no such callback, set errno to EINVAL. Or if the f is
815 invalid, set errno to EBADF.
817 =head2 Implementing PerlIO Layers
819 If you find the implementation document unclear or not sufficient,
820 look at the existing PerlIO layer implementations, which include:
824 =item * C implementations
826 The F<perlio.c> and F<perliol.h> in the Perl core implement the
827 "unix", "perlio", "stdio", "crlf", "utf8", "byte", "raw", "pending"
828 layers, and also the "mmap" and "win32" layers if applicable.
829 (The "win32" is currently unfinished and unused, to see what is used
830 instead in Win32, see L<PerlIO/"Querying the layers of filehandles"> .)
832 PerlIO::encoding, PerlIO::scalar, PerlIO::via in the Perl core.
834 PerlIO::gzip and APR::PerlIO (mod_perl 2.0) on CPAN.
836 =item * Perl implementations
838 PerlIO::via::QuotedPrint in the Perl core and PerlIO::via::* on CPAN.
842 If you are creating a PerlIO layer, you may want to be lazy, in other
843 words, implement only the methods that interest you. The other methods
844 you can either replace with the "blank" methods
849 (which do nothing, and return zero and -1, respectively) or for
850 certain methods you may assume a default behaviour by using a NULL
851 method. The Open method looks for help in the 'parent' layer.
852 The following table summarizes the behaviour:
854 method behaviour with NULL
856 Clearerr PerlIOBase_clearerr
857 Close PerlIOBase_close
860 Error PerlIOBase_error
861 Fileno PerlIOBase_fileno
876 Setlinebuf PerlIOBase_setlinebuf
878 Unread PerlIOBase_unread
881 FAILURE Set errno (to EINVAL in Unixish, to LIB$_INVARG in VMS)
882 and return -1 (for numeric return values) or NULL (for
884 INHERITED Inherited from the layer below
885 SUCCESS Return 0 (for numeric return values) or a pointer
889 The file C<perlio.c> provides the following layers:
895 A basic non-buffered layer which calls Unix/POSIX C<read()>, C<write()>,
896 C<lseek()>, C<close()>. No buffering. Even on platforms that distinguish
897 between O_TEXT and O_BINARY this layer is always O_BINARY.
901 A very complete generic buffering layer which provides the whole of
902 PerlIO API. It is also intended to be used as a "base class" for other
903 layers. (For example its C<Read()> method is implemented in terms of
904 the C<Get_cnt()>/C<Get_ptr()>/C<Set_ptrcnt()> methods).
906 "perlio" over "unix" provides a complete replacement for stdio as seen
907 via PerlIO API. This is the default for USE_PERLIO when system's stdio
908 does not permit perl's "fast gets" access, and which do not
909 distinguish between C<O_TEXT> and C<O_BINARY>.
913 A layer which provides the PerlIO API via the layer scheme, but
914 implements it by calling system's stdio. This is (currently) the default
915 if system's stdio provides sufficient access to allow perl's "fast gets"
916 access and which do not distinguish between C<O_TEXT> and C<O_BINARY>.
920 A layer derived using "perlio" as a base class. It provides Win32-like
921 "\n" to CR,LF translation. Can either be applied above "perlio" or serve
922 as the buffer layer itself. "crlf" over "unix" is the default if system
923 distinguishes between C<O_TEXT> and C<O_BINARY> opens. (At some point
924 "unix" will be replaced by a "native" Win32 IO layer on that platform,
925 as Win32's read/write layer has various drawbacks.) The "crlf" layer is
926 a reasonable model for a layer which transforms data in some way.
930 If Configure detects C<mmap()> functions this layer is provided (with
931 "perlio" as a "base") which does "read" operations by mmap()ing the
932 file. Performance improvement is marginal on modern systems, so it is
933 mainly there as a proof of concept. It is likely to be unbundled from
934 the core at some point. The "mmap" layer is a reasonable model for a
935 minimalist "derived" layer.
939 An "internal" derivative of "perlio" which can be used to provide
940 Unread() function for layers which have no buffer or cannot be
941 bothered. (Basically this layer's C<Fill()> pops itself off the stack
942 and so resumes reading from layer below.)
946 A dummy layer which never exists on the layer stack. Instead when
947 "pushed" it actually pops the stack removing itself, it then calls
948 Binmode function table entry on all the layers in the stack - normally
949 this (via PerlIOBase_binmode) removes any layers which do not have
950 C<PERLIO_K_RAW> bit set. Layers can modify that behaviour by defining
951 their own Binmode entry.
955 Another dummy layer. When pushed it pops itself and sets the
956 C<PERLIO_F_UTF8> flag on the layer which was (and now is once more)
957 the top of the stack.
961 In addition F<perlio.c> also provides a number of C<PerlIOBase_xxxx()>
962 functions which are intended to be used in the table slots of classes
963 which do not need to do anything special for a particular method.
965 =head2 Extension Layers
967 Layers can be made available by extension modules. When an unknown layer
968 is encountered the PerlIO code will perform the equivalent of :
972 Where I<layer> is the unknown layer. F<PerlIO.pm> will then attempt to:
974 require PerlIO::layer;
976 If after that process the layer is still not defined then the C<open>
979 The following extension layers are bundled with perl:
987 makes this layer available, although F<PerlIO.pm> "knows" where to
988 find it. It is an example of a layer which takes an argument as it is
991 open( $fh, "<:encoding(iso-8859-7)", $pathname );
995 Provides support for reading data from and writing data to a scalar.
997 open( $fh, "+<:scalar", \$scalar );
999 When a handle is so opened, then reads get bytes from the string value
1000 of I<$scalar>, and writes change the value. In both cases the position
1001 in I<$scalar> starts as zero but can be altered via C<seek>, and
1002 determined via C<tell>.
1004 Please note that this layer is implied when calling open() thus:
1006 open( $fh, "+<", \$scalar );
1010 Provided to allow layers to be implemented as Perl code. For instance:
1012 use PerlIO::via::StripHTML;
1013 open( my $fh, "<:via(StripHTML)", "index.html" );
1015 See L<PerlIO::via> for details.
1021 Things that need to be done to improve this document.
1027 Explain how to make a valid fh without going through open()(i.e. apply
1028 a layer). For example if the file is not opened through perl, but we
1029 want to get back a fh, like it was opened by Perl.
1031 How PerlIO_apply_layera fits in, where its docs, was it made public?
1033 Currently the example could be something like this:
1035 PerlIO *foo_to_PerlIO(pTHX_ char *mode, ...)
1037 char *mode; /* "w", "r", etc */
1038 const char *layers = ":APR"; /* the layer name */
1039 PerlIO *f = PerlIO_allocate(aTHX);
1044 PerlIO_apply_layers(aTHX_ f, mode, layers);
1047 PerlIOAPR *st = PerlIOSelf(f, PerlIOAPR);
1048 /* fill in the st struct, as in _open() */
1050 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
1059 fix/add the documentation in places marked as XXX.
1063 The handling of errors by the layer is not specified. e.g. when $!
1064 should be set explicitly, when the error handling should be just
1065 delegated to the top layer.
1067 Probably give some hints on using SETERRNO() or pointers to where they
1072 I think it would help to give some concrete examples to make it easier
1073 to understand the API. Of course I agree that the API has to be
1074 concise, but since there is no second document that is more of a
1075 guide, I think that it'd make it easier to start with the doc which is
1076 an API, but has examples in it in places where things are unclear, to
1077 a person who is not a PerlIO guru (yet).