.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PERLAPIO 1"
.TH PERLAPIO 1 "2005-04-10" "DocFr" "User Contributed Perl Documentation"
.SH "NOM"
.IX Header "NOM"
perlapio \- Interface d'abstraction des E/S internes à Perl
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& PerlIO *PerlIO_stdin(void);
\& PerlIO *PerlIO_stdout(void);
\& PerlIO *PerlIO_stderr(void);
.Ve
.PP
.Vb 2
\& PerlIO *PerlIO_open(const char *,const char *);
\& int PerlIO_close(PerlIO *);
.Ve
.PP
.Vb 7
\& int PerlIO_stdoutf(const char *,...)
\& int PerlIO_puts(PerlIO *,const char *);
\& int PerlIO_putc(PerlIO *,int);
\& int PerlIO_write(PerlIO *,const void *,size_t);
\& int PerlIO_printf(PerlIO *, const char *,...);
\& int PerlIO_vprintf(PerlIO *, const char *, va_list);
\& int PerlIO_flush(PerlIO *);
.Ve
.PP
.Vb 3
\& int PerlIO_eof(PerlIO *);
\& int PerlIO_error(PerlIO *);
\& void PerlIO_clearerr(PerlIO *);
.Ve
.PP
.Vb 3
\& int PerlIO_getc(PerlIO *);
\& int PerlIO_ungetc(PerlIO *,int);
\& int PerlIO_read(PerlIO *,void *,size_t);
.Ve
.PP
.Vb 6
\& int PerlIO_fileno(PerlIO *);
\& PerlIO *PerlIO_fdopen(int, const char *);
\& PerlIO *PerlIO_importFILE(FILE *, int flags);
\& FILE *PerlIO_exportFILE(PerlIO *, int flags);
\& FILE *PerlIO_findFILE(PerlIO *);
\& void PerlIO_releaseFILE(PerlIO *,FILE *);
.Ve
.PP
.Vb 1
\& void PerlIO_setlinebuf(PerlIO *);
.Ve
.PP
.Vb 5
\& long PerlIO_tell(PerlIO *);
\& int PerlIO_seek(PerlIO *,off_t,int);
\& int PerlIO_getpos(PerlIO *,Fpos_t *)
\& int PerlIO_setpos(PerlIO *,Fpos_t *)
\& void PerlIO_rewind(PerlIO *);
.Ve
.PP
.Vb 4
\& int PerlIO_has_base(PerlIO *);
\& int PerlIO_has_cntptr(PerlIO *);
\& int PerlIO_fast_gets(PerlIO *);
\& int PerlIO_canset_cnt(PerlIO *);
.Ve
.PP
.Vb 6
\& char *PerlIO_get_ptr(PerlIO *);
\& int PerlIO_get_cnt(PerlIO *);
\& void PerlIO_set_cnt(PerlIO *,int);
\& void PerlIO_set_ptrcnt(PerlIO *,char *,int);
\& char *PerlIO_get_base(PerlIO *);
\& int PerlIO_get_bufsiz(PerlIO *);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Les sources de Perl doivent utiliser les fonctions listées ci-dessus à la
place de celles définies dans l'en\-tête \fIstdio.h\fR de l'\s-1ANSI\s0 C. Les en\-têtes
de perl les remplacent par le mécanisme d'entrée\-sortie selectionné lors de
l'exécution de Configure en utilisant des \f(CW\*(C`#define\*(C'\fR.
.PP
Ces fonctions sont calquées sur celles de \fIsdio.h\fR, mais pour certaines,
l'ordre des paramètres a été réorganisé.
.IP "\fBPerlIO *\fR" 4
.IX Item "PerlIO *"
Remplace \s-1FILE\s0 *. Comme \s-1FILE\s0 * , il doit être traité comme un type opaque
(c'est probablement prudent de le considérer comme un pointeur sur quelque
chose).
.IP "\fB\f(BIPerlIO_stdin()\fB\fR, \fB\f(BIPerlIO_stdout()\fB\fR, \fB\f(BIPerlIO_stderr()\fB\fR" 4
.IX Item "PerlIO_stdin(), PerlIO_stdout(), PerlIO_stderr()"
À utiliser à la place de \f(CW\*(C`stdin\*(C'\fR, \f(CW\*(C`stdout\*(C'\fR, \f(CW\*(C`stderr\*(C'\fR. Elles ressemblent à
des «\ appels de fonctions\ » plutôt qu'à des variables pour que ce
soit plus facile d'en faire des appels de fonctions si la plate-forme ne peut
exporter des données vers des modules chargés, ou si (par exemple) des
«\ threads\ » différents peuvent avoir des valeurs différentes.
.IP "\fBPerlIO_open(path, mode)\fR, \fBPerlIO_fdopen(fd,mode)\fR" 4
.IX Item "PerlIO_open(path, mode), PerlIO_fdopen(fd,mode)"
Correspondent à \fIfopen()\fR/\fIfdopen()\fR et utilise les mêmes arguments.
.IP "\fBPerlIO_printf(f,fmt,...)\fR, \fBPerlIO_vprintf(f,fmt,a)\fR" 4
.IX Item "PerlIO_printf(f,fmt,...), PerlIO_vprintf(f,fmt,a)"
Équivalent à \fIfprintf()\fR/\fIvfprintf()\fR .
.IP "\fBPerlIO_stdoutf(fmt,...)\fR" 4
.IX Item "PerlIO_stdoutf(fmt,...)"
Équivalent à \fIprintf()\fR. printf est #defined à cette fonction, donc il est (pour
le moment) légal d'utiliser \f(CW\*(C`printf(fmt,...)\*(C'\fR dans les sources perl.
.IP "\fBPerlIO_read(f,buf,compteur)\fR, \fBPerlIO_write(f,buf,compteur)\fR" 4
.IX Item "PerlIO_read(f,buf,compteur), PerlIO_write(f,buf,compteur)"
Correspondent à fread () et fwrite (). Attention, les arguments sont
différents, Il y a seulement un «\ compteur\ » et le fichier f est
en premier.
.IP "\fBPerlIO_close(f)\fR" 4
.IX Item "PerlIO_close(f)"
.PD 0
.IP "\fBPerlIO_puts(f,s)\fR, \fBPerlIO_putc(f,c)\fR" 4
.IX Item "PerlIO_puts(f,s), PerlIO_putc(f,c)"
.PD
Correspondent à \fIfputs()\fR et \fIfputc()\fR. Attention, les arguments ont été
réorganisés pour que le fichier soit en premier.
.IP "\fBPerlIO_ungetc(f,c)\fR" 4
.IX Item "PerlIO_ungetc(f,c)"
Correspond à \fIungetc()\fR. Attention, les arguments ont été réorganisé pour que
le fichier soit en premier.
.IP "\fBPerlIO_getc(f)\fR" 4
.IX Item "PerlIO_getc(f)"
Correspond à \fIgetc()\fR.
.IP "\fBPerlIO_eof(f)\fR" 4
.IX Item "PerlIO_eof(f)"
Correspond à \fIfeof()\fR.
.IP "\fBPerlIO_error(f)\fR" 4
.IX Item "PerlIO_error(f)"
Correspond à \fIferror()\fR.
.IP "\fBPerlIO_fileno(f)\fR" 4
.IX Item "PerlIO_fileno(f)"
Correspond à \fIfileno()\fR. Attention, sur certaines plates\-formes, la définition
de «\ fileno\ » peut ne pas correspondre à celle d'Unix.
.IP "\fBPerlIO_clearerr(f)\fR" 4
.IX Item "PerlIO_clearerr(f)"
Correspond à \fIclearerr()\fR, c.\-à\-d., retire les drapeaux «\ eof\ » et
«\ error\ » pour le «\ flux\ ».
.IP "\fBPerlIO_flush(f)\fR" 4
.IX Item "PerlIO_flush(f)"
Correspond à \fIfflush()\fR.
.IP "\fBPerlIO_tell(f)\fR" 4
.IX Item "PerlIO_tell(f)"
Correspond à \fIftell()\fR.
.IP "\fBPerlIO_seek(f,o,w)\fR" 4
.IX Item "PerlIO_seek(f,o,w)"
Correspond à \fIfseek()\fR.
.IP "\fBPerlIO_getpos(f,p)\fR, \fBPerlIO_setpos(f,p)\fR" 4
.IX Item "PerlIO_getpos(f,p), PerlIO_setpos(f,p)"
Correspondent à \fIfgetpos()\fR et \fIfsetpos()\fR. Si la plate-forme ne dispose pas de
ces fonctions, elles sont implémentées à l'aide de \fIPerlIO_tell()\fR et
\&\fIPerlIO_seek()\fR.
.IP "\fBPerlIO_rewind(f)\fR" 4
.IX Item "PerlIO_rewind(f)"
Correspond à \fIrewind()\fR. Note\ : elle peut être définie à l'aide de
\&\fIPerlIO_seek()\fR.
.IP "\fB\f(BIPerlIO_tmpfile()\fB\fR" 4
.IX Item "PerlIO_tmpfile()"
Correspond à \fItmpfile()\fR, c.\-à\-d., retourne un PerlIO anonyme qui sera
automatiquement effacé lors de sa fermeture.
.Sh "Co-existence avec stdio"
.IX Subsection "Co-existence avec stdio"
Il existe un support de la coexistence de PerlIO avec stdio. Évidemment, si
PerlIO est implémenté à l'aide de stdio, il n'y aucun problème. Mais si perlio
est implémenté au-dessus de sfio (par exemple) il doit exister des mécanismes
permettant de créer un \s-1FILE\s0 * qui peut être passé aux fonctions de
bibliothèques qui utilisent stdio.
.IP "\fBPerlIO_importFILE(f,flags)\fR" 4
.IX Item "PerlIO_importFILE(f,flags)"
Permet d'obtenir un PerlIO * à partir d'un \s-1FILE\s0 *. Peut nécessiter plus
d'arguments, interface en cours de réécriture.
.IP "\fBPerlIO_exportFILE(f,flags)\fR" 4
.IX Item "PerlIO_exportFILE(f,flags)"
À partir d'un PerlIO * renvoie un \s-1FILE\s0 * pouvant être donné à du code devant
être compilé et linké avec \fIstdio.h\fR de l'\s-1ANSI\s0 C.
.Sp
Le fait qu'un \s-1FILE\s0 * a été «\ exporté\ » est enregistré, et peut
affecter de futures opérations sur le PerlIO * original. PerlIO *.
.IP "\fBPerlIO_findFILE(f)\fR" 4
.IX Item "PerlIO_findFILE(f)"
Retourne un \s-1FILE\s0 * prédément «\ exporté\ » (s'il existe). Ceci est
un bouche-trou jusqu'à ce que l'interface soit complètement définie.
.IP "\fBPerlIO_releaseFILE(p,f)\fR" 4
.IX Item "PerlIO_releaseFILE(p,f)"
L'appel à PerlIO_releaseFILE informe PerlIO que le \s-1FILE\s0 * ne sera plus
utilisé. Il est alors retiré de la liste des \s-1FILE\s0 * «\ exporté\ »,
et le PerlIO * associé retrouve son comportement normal.
.IP "\fBPerlIO_setlinebuf(f)\fR" 4
.IX Item "PerlIO_setlinebuf(f)"
Correspond à \fIsetlinebuf()\fR. Son utilisation est dépréciée en attendant une
décision sur son sort. (Le noyau de Perl l'utilise \fIuniquement\fR lors du
dump\ ; cela n'a rien à voir avec le vidage automatique $|.)
.PP
En plus de l'\s-1API\s0 utilisateur décrite précédement, il existe une interface
d'«\ implémentation\ » qui permet à Perl d'accèder aux structures
internes de PerlIO. Les appels suivants correspondent aux diverses macros
FILE_xxx déterminées par Configure. Cette section n'a d'intérêt que pour ceux
qui sont concerné par un descriptif détaillé de comportement du noyau perl ou
qui implémentent un \s-1MAPPING\s0 PerlIO.
.IP "\fBPerlIO_has_cntptr(f)\fR" 4
.IX Item "PerlIO_has_cntptr(f)"
L'implémentation peut retourner un pointeur vers la position courante dans le
«\ buffer\ » et le nombre d'octets disponibles dans le buffer.
.IP "\fBPerlIO_get_ptr(f)\fR" 4
.IX Item "PerlIO_get_ptr(f)"
Retourne un pointeur vers le prochain octet du buffer à lire.
.IP "\fBPerlIO_get_cnt(f)\fR" 4
.IX Item "PerlIO_get_cnt(f)"
Retourne le nombre d'octets du buffer restant à lire.
.IP "\fBPerlIO_canset_cnt(f)\fR" 4
.IX Item "PerlIO_canset_cnt(f)"
L'implémentation peut ajuster son idée sur le nombre d'octets dans le buffer.
.IP "\fBPerlIO_fast_gets(f)\fR" 4
.IX Item "PerlIO_fast_gets(f)"
L'implémentation a toutes les interfaces nécessaire pour permetre au code
rapide de perl d'utiliser le mécanisme <\s-1FILE\s0> .
.Sp
.Vb 3
\& PerlIO_fast_gets(f) = PerlIO_has_cntptr(f) && \e
\& PerlIO_canset_cnt(f) && \e
\& `Can set pointer into buffer'
.Ve
.IP "\fBPerlIO_set_ptrcnt(f,p,c)\fR" 4
.IX Item "PerlIO_set_ptrcnt(f,p,c)"
Place le pointeur dans le buffer et remplace le nombre d'octets encore dans le
buffer. Doit être utilisé seulement pour positionner le pointeur à l'intérieur
de la plage impliquée par un appel précédent à \f(CW\*(C`PerlIO_get_ptr\*(C'\fR et
\&\f(CW\*(C`PerlIO_get_cnt\*(C'\fR.
.IP "\fBPerlIO_set_cnt(f,c)\fR" 4
.IX Item "PerlIO_set_cnt(f,c)"
Obscure \- force le nombre d'octets dans le buffer. Déprécié. Utilisé
uniquement dans doio.c pour forcer un compteur <\-1 à \-1. Deviendra peut\-être
PerlIO_set_empty ou similaire. Cet appel peut éventuellement ne rien faire si
«\ compteur\ » est déduit d'un pointeur et d'une
«\ limite\ ».
.IP "\fBPerlIO_has_base(f)\fR" 4
.IX Item "PerlIO_has_base(f)"
L'implémentation a un buffer, et peut retourner un pointeur vers celui-ci
ainsi que sa taille. Utilisé par perl pour les tests \fB\-T\fR / \fB\-B\fR. Les
autres usages seraient très obscurs...
.IP "\fBPerlIO_get_base(f)\fR" 4
.IX Item "PerlIO_get_base(f)"
Retourne le \fIdébut\fR du buffer.
.IP "\fBPerlIO_get_bufsiz(f)\fR" 4
.IX Item "PerlIO_get_bufsiz(f)"
Retourne la \fItaille totale\fR du buffer.
.SH "TRADUCTION"
.IX Header "TRADUCTION"
.Sh "Version"
.IX Subsection "Version"
Cette traduction française correspond à la version anglaise distribuée avec
perl 5.005_02. Pour en savoir plus concernant ces traductions, consultez
.
.Sh "Traducteurs"
.IX Subsection "Traducteurs"
Marc Carmier
.Sh "Relecture"
.IX Subsection "Relecture"
Gérard Delafond.