ext/PerlIO/via/via.xs

   1 #define PERL_NO_GET_CONTEXT
   2 #include "EXTERN.h"
   3 #include "perl.h"
   4 #include "XSUB.h"
   5 #ifdef PERLIO_LAYERS
   6
   7 #include "perliol.h"
   8
   9 typedef struct
  10 {
  11  struct _PerlIO base;       /* Base "class" info */
  12  HV *           stash;
  13  SV *           obj;
  14  SV *           var;
  15  SSize_t        cnt;
  16  IO *           io;
  17  SV *           fh;
  18  CV *PUSHED;
  19  CV *POPPED;
  20  CV *OPEN;
  21  CV *FDOPEN;
  22  CV *SYSOPEN;
  23  CV *GETARG;
  24  CV *FILENO;
  25  CV *READ;
  26  CV *WRITE;
  27  CV *FILL;
  28  CV *CLOSE;
  29  CV *SEEK;
  30  CV *TELL;
  31  CV *UNREAD;
  32  CV *FLUSH;
  33  CV *SETLINEBUF;
  34  CV *CLEARERR;
  35  CV *mERROR;
  36  CV *mEOF;
  37  CV *BINMODE;
  38 } PerlIOVia;
  39
  40 #define MYMethod(x) #x,&s->x
  41
  42 CV *
  43 PerlIOVia_fetchmethod(pTHX_ PerlIOVia * s, char *method, CV ** save)
  44 {
  45     GV *gv = gv_fetchmeth(s->stash, method, strlen(method), 0);
  46 #if 0
  47     Perl_warn(aTHX_ "Lookup %s::%s => %p", HvNAME(s->stash), method, gv);
  48 #endif
  49     if (gv) {
  50         return *save = GvCV(gv);
  51     }
  52     else {
  53         return *save = (CV *) - 1;
  54     }
  55 }
  56
  57 /*
  58  * Try and call method, possibly via cached lookup.
  59  * If method does not exist return Nullsv (caller may fallback to another approach
  60  * If method does exist call it with flags passing variable number of args
  61  * Last arg is a "filehandle" to layer below (if present)
  62  * Returns scalar returned by method (if any) otherwise sv_undef
  63  */
  64
  65 SV *
  66 PerlIOVia_method(pTHX_ PerlIO * f, char *method, CV ** save, int flags,
  67                  ...)
  68 {
  69     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
  70     CV *cv =
  71         (*save) ? *save : PerlIOVia_fetchmethod(aTHX_ s, method, save);
  72     SV *result = Nullsv;
  73     va_list ap;
  74     va_start(ap, flags);
  75     if (cv != (CV *) - 1) {
  76         IV count;
  77         dSP;
  78         SV *arg;
  79         PUSHSTACKi(PERLSI_MAGIC);
  80         ENTER;
  81         SPAGAIN;
  82         PUSHMARK(sp);
  83         XPUSHs(s->obj);
  84         while ((arg = va_arg(ap, SV *))) {
  85             XPUSHs(arg);
  86         }
  87         if (*PerlIONext(f)) {
  88             if (!s->fh) {
  89                 GV *gv = newGVgen(HvNAME(s->stash));
  90                 GvIOp(gv) = newIO();
  91                 s->fh = newRV_noinc((SV *) gv);
  92                 s->io = GvIOp(gv);
  93             }
  94             IoIFP(s->io) = PerlIONext(f);
  95             IoOFP(s->io) = PerlIONext(f);
  96             XPUSHs(s->fh);
  97         }
  98         else {
  99             PerlIO_debug("No next\n");
 100             /* FIXME: How should this work for OPEN etc? */
 101         }
 102         PUTBACK;
 103         count = call_sv((SV *) cv, flags);
 104         if (count) {
 105             SPAGAIN;
 106             result = POPs;
 107             PUTBACK;
 108         }
 109         else {
 110             result = &PL_sv_undef;
 111         }
 112         LEAVE;
 113         POPSTACK;
 114     }
 115     va_end(ap);
 116     return result;
 117 }
 118
 119 IV
 120 PerlIOVia_pushed(pTHX_ PerlIO * f, const char *mode, SV * arg,
 121                  PerlIO_funcs * tab)
 122 {
 123     IV code = PerlIOBase_pushed(aTHX_ f, mode, Nullsv, tab);
 124     if (code == 0) {
 125         PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 126         if (!arg) {
 127             if (ckWARN(WARN_LAYER))
 128                 Perl_warner(aTHX_ packWARN(WARN_LAYER),
 129                             "No package specified");
 130             errno = EINVAL;
 131             code = -1;
 132         }
 133         else {
 134             STRLEN pkglen = 0;
 135             char *pkg = SvPV(arg, pkglen);
 136             s->obj = SvREFCNT_inc(arg);
 137             s->stash = gv_stashpvn(pkg, pkglen, FALSE);
 138             if (!s->stash) {
 139                 s->obj =
 140                     newSVpvn(Perl_form(aTHX_ "PerlIO::via::%s", pkg),
 141                              pkglen + 13);
 142                 SvREFCNT_dec(arg);
 143                 s->stash = gv_stashpvn(SvPVX(s->obj), pkglen + 13, FALSE);
 144             }
 145             if (s->stash) {
 146                 char lmode[8];
 147                 SV *modesv;
 148                 SV *result;
 149                 if (!mode) {
 150                     /* binmode() passes NULL - so find out what mode is */
 151                     mode = PerlIO_modestr(f,lmode);
 152                 }
 153                 modesv = sv_2mortal(newSVpvn(mode, strlen(mode)));
 154                 result = PerlIOVia_method(aTHX_ f, MYMethod(PUSHED), G_SCALAR,
 155                                      modesv, Nullsv);
 156                 if (result) {
 157                     if (sv_isobject(result)) {
 158                         s->obj = SvREFCNT_inc(result);
 159                         SvREFCNT_dec(arg);
 160                     }
 161                     else if (SvIV(result) != 0)
 162                         return SvIV(result);
 163                 }
 164                 else {
 165                     goto push_failed;
 166                 }
 167                 if (PerlIOVia_fetchmethod(aTHX_ s, MYMethod(FILL)) ==
 168                     (CV *) - 1)
 169                     PerlIOBase(f)->flags &= ~PERLIO_F_FASTGETS;
 170                 else
 171                     PerlIOBase(f)->flags |= PERLIO_F_FASTGETS;
 172             }
 173             else {
 174                 if (ckWARN(WARN_LAYER))
 175                     Perl_warner(aTHX_ packWARN(WARN_LAYER),
 176                                 "Cannot find package '%.*s'", (int) pkglen,
 177                                 pkg);
 178 push_failed:
 179 #ifdef ENOSYS
 180                 errno = ENOSYS;
 181 #else
 182 #ifdef ENOENT
 183                 errno = ENOENT;
 184 #endif
 185 #endif
 186                 code = -1;
 187             }
 188         }
 189     }
 190     return code;
 191 }
 192
 193 PerlIO *
 194 PerlIOVia_open(pTHX_ PerlIO_funcs * self, PerlIO_list_t * layers,
 195                IV n, const char *mode, int fd, int imode, int perm,
 196                PerlIO * f, int narg, SV ** args)
 197 {
 198     if (!f) {
 199         f = PerlIO_push(aTHX_ PerlIO_allocate(aTHX), self, mode,
 200                         PerlIOArg);
 201     }
 202     else {
 203         /* Reopen */
 204         if (!PerlIO_push(aTHX_ f, self, mode, PerlIOArg))
 205             return NULL;
 206     }
 207     if (f) {
 208         PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 209         SV *result = Nullsv;
 210         if (fd >= 0) {
 211             SV *fdsv = sv_2mortal(newSViv(fd));
 212             result =
 213                 PerlIOVia_method(aTHX_ f, MYMethod(FDOPEN), G_SCALAR, fdsv,
 214                                  Nullsv);
 215         }
 216         else if (narg > 0) {
 217             if (*mode == '#') {
 218                 SV *imodesv = sv_2mortal(newSViv(imode));
 219                 SV *permsv = sv_2mortal(newSViv(perm));
 220                 result =
 221                     PerlIOVia_method(aTHX_ f, MYMethod(SYSOPEN), G_SCALAR,
 222                                      *args, imodesv, permsv, Nullsv);
 223             }
 224             else {
 225                 result =
 226                     PerlIOVia_method(aTHX_ f, MYMethod(OPEN), G_SCALAR,
 227                                      *args, Nullsv);
 228             }
 229         }
 230         if (result) {
 231             if (sv_isobject(result))
 232                 s->obj = SvREFCNT_inc(result);
 233             else if (!SvTRUE(result)) {
 234                 return NULL;
 235             }
 236         }
 237         else {
 238             /* Required open method not present */
 239             PerlIO_funcs *tab = NULL;
 240             IV m = n - 1;
 241             while (m >= 0) {
 242                 PerlIO_funcs *t =
 243                     PerlIO_layer_fetch(aTHX_ layers, m, NULL);
 244                 if (t && t->Open) {
 245                     tab = t;
 246                     break;
 247                 }
 248                 n--;
 249             }
 250             if (tab) {
 251                 if ((*tab->Open) (aTHX_ tab, layers, m, mode, fd, imode,
 252                                   perm, PerlIONext(f), narg, args)) {
 253                     PerlIO_debug("Opened with %s => %p->%p\n", tab->name,
 254                                  PerlIONext(f), *PerlIONext(f));
 255                     if (m + 1 < n) {
 256                         /*
 257                          * More layers above the one that we used to open -
 258                          * apply them now
 259                          */
 260                         if (PerlIO_apply_layera
 261                             (aTHX_ PerlIONext(f), mode, layers, m + 1,
 262                              n) != 0) {
 263                             /* If pushing layers fails close the file */
 264                             PerlIO_close(f);
 265                             f = NULL;
 266                         }
 267                     }
 268                     /* FIXME - Call an OPENED method here ? */
 269                     return f;
 270                 }
 271                 else {
 272                     PerlIO_debug("Open fail %s => %p->%p\n", tab->name,
 273                                  PerlIONext(f), *PerlIONext(f));
 274                     /* Sub-layer open failed */
 275                 }
 276             }
 277             else {
 278                  PerlIO_debug("Nothing to open with");
 279                 /* Nothing to do the open */
 280             }
 281             PerlIO_pop(aTHX_ f);
 282             return NULL;
 283         }
 284     }
 285     return f;
 286 }
 287
 288 IV
 289 PerlIOVia_popped(pTHX_ PerlIO * f)
 290 {
 291     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 292     PerlIOVia_method(aTHX_ f, MYMethod(POPPED), G_VOID, Nullsv);
 293     if (s->var) {
 294         SvREFCNT_dec(s->var);
 295         s->var = Nullsv;
 296     }
 297
 298     if (s->io) {
 299         IoIFP(s->io) = NULL;
 300         IoOFP(s->io) = NULL;
 301     }
 302     if (s->fh) {
 303         SvREFCNT_dec(s->fh);
 304         s->fh = Nullsv;
 305         s->io = NULL;
 306     }
 307     if (s->obj) {
 308         SvREFCNT_dec(s->obj);
 309         s->obj = Nullsv;
 310     }
 311     return 0;
 312 }
 313
 314 IV
 315 PerlIOVia_close(pTHX_ PerlIO * f)
 316 {
 317     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 318     IV code = PerlIOBase_close(aTHX_ f);
 319     SV *result =
 320         PerlIOVia_method(aTHX_ f, MYMethod(CLOSE), G_SCALAR, Nullsv);
 321     if (result && SvIV(result) != 0)
 322         code = SvIV(result);
 323     PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
 324     return code;
 325 }
 326
 327 IV
 328 PerlIOVia_fileno(pTHX_ PerlIO * f)
 329 {
 330     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 331     SV *result =
 332         PerlIOVia_method(aTHX_ f, MYMethod(FILENO), G_SCALAR, Nullsv);
 333     return (result) ? SvIV(result) : PerlIO_fileno(PerlIONext(f));
 334 }
 335
 336 IV
 337 PerlIOVia_binmode(pTHX_ PerlIO * f)
 338 {
 339     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 340     SV *result =
 341         PerlIOVia_method(aTHX_ f, MYMethod(BINMODE), G_SCALAR, Nullsv);
 342     if (!result || !SvOK(result)) {
 343         PerlIO_pop(aTHX_ f);
 344         return 0;
 345     }
 346     return SvIV(result);
 347 }
 348
 349 IV
 350 PerlIOVia_seek(pTHX_ PerlIO * f, Off_t offset, int whence)
 351 {
 352     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 353     SV *offsv = sv_2mortal(sizeof(Off_t) > sizeof(IV)
 354                            ? newSVnv((NV)offset) : newSViv((IV)offset));
 355     SV *whsv = sv_2mortal(newSViv(whence));
 356     SV *result =
 357         PerlIOVia_method(aTHX_ f, MYMethod(SEEK), G_SCALAR, offsv, whsv,
 358                          Nullsv);
 359     return (result) ? SvIV(result) : -1;
 360 }
 361
 362 Off_t
 363 PerlIOVia_tell(pTHX_ PerlIO * f)
 364 {
 365     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 366     SV *result =
 367         PerlIOVia_method(aTHX_ f, MYMethod(TELL), G_SCALAR, Nullsv);
 368     return (result)
 369            ? (SvNOK(result) ? (Off_t)SvNV(result) : (Off_t)SvIV(result))
 370            : (Off_t) - 1;
 371 }
 372
 373 SSize_t
 374 PerlIOVia_unread(pTHX_ PerlIO * f, const void *vbuf, Size_t count)
 375 {
 376     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 377     SV *buf = sv_2mortal(newSVpvn((char *) vbuf, count));
 378     SV *result =
 379         PerlIOVia_method(aTHX_ f, MYMethod(UNREAD), G_SCALAR, buf, Nullsv);
 380     if (result)
 381         return (SSize_t) SvIV(result);
 382     else {
 383         return PerlIOBase_unread(aTHX_ f, vbuf, count);
 384     }
 385 }
 386
 387 SSize_t
 388 PerlIOVia_read(pTHX_ PerlIO * f, void *vbuf, Size_t count)
 389 {
 390     SSize_t rd = 0;
 391     if (PerlIOBase(f)->flags & PERLIO_F_CANREAD) {
 392         if (PerlIOBase(f)->flags & PERLIO_F_FASTGETS) {
 393             rd = PerlIOBase_read(aTHX_ f, vbuf, count);
 394         }
 395         else {
 396             PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 397             SV *buf = sv_2mortal(newSV(count));
 398             SV *n = sv_2mortal(newSViv(count));
 399             SV *result =
 400                 PerlIOVia_method(aTHX_ f, MYMethod(READ), G_SCALAR, buf, n,
 401                                  Nullsv);
 402             if (result) {
 403                 rd = (SSize_t) SvIV(result);
 404                 Move(SvPVX(buf), vbuf, rd, char);
 405                 return rd;
 406             }
 407         }
 408     }
 409     return rd;
 410 }
 411
 412 SSize_t
 413 PerlIOVia_write(pTHX_ PerlIO * f, const void *vbuf, Size_t count)
 414 {
 415     if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
 416         PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 417         SV *buf = newSVpvn((char *) vbuf, count);
 418         SV *result =
 419             PerlIOVia_method(aTHX_ f, MYMethod(WRITE), G_SCALAR, buf,
 420                              Nullsv);
 421         SvREFCNT_dec(buf);
 422         if (result)
 423             return (SSize_t) SvIV(result);
 424         return -1;
 425     }
 426     return 0;
 427 }
 428
 429 IV
 430 PerlIOVia_fill(pTHX_ PerlIO * f)
 431 {
 432     if (PerlIOBase(f)->flags & PERLIO_F_CANREAD) {
 433         PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 434         SV *result =
 435             PerlIOVia_method(aTHX_ f, MYMethod(FILL), G_SCALAR, Nullsv);
 436         if (s->var) {
 437             SvREFCNT_dec(s->var);
 438             s->var = Nullsv;
 439         }
 440         if (result && SvOK(result)) {
 441             STRLEN len = 0;
 442             char *p = SvPV(result, len);
 443             s->var = newSVpvn(p, len);
 444             s->cnt = SvCUR(s->var);
 445             return 0;
 446         }
 447         else
 448             PerlIOBase(f)->flags |= PERLIO_F_EOF;
 449     }
 450     return -1;
 451 }
 452
 453 IV
 454 PerlIOVia_flush(pTHX_ PerlIO * f)
 455 {
 456     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 457     SV *result =
 458         PerlIOVia_method(aTHX_ f, MYMethod(FLUSH), G_SCALAR, Nullsv);
 459     if (s->var && s->cnt > 0) {
 460         SvREFCNT_dec(s->var);
 461         s->var = Nullsv;
 462     }
 463     return (result) ? SvIV(result) : 0;
 464 }
 465
 466 STDCHAR *
 467 PerlIOVia_get_base(pTHX_ PerlIO * f)
 468 {
 469     if (PerlIOBase(f)->flags & PERLIO_F_CANREAD) {
 470         PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 471         if (s->var) {
 472             return (STDCHAR *) SvPVX(s->var);
 473         }
 474     }
 475     return (STDCHAR *) Nullch;
 476 }
 477
 478 STDCHAR *
 479 PerlIOVia_get_ptr(pTHX_ PerlIO * f)
 480 {
 481     if (PerlIOBase(f)->flags & PERLIO_F_CANREAD) {
 482         PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 483         if (s->var) {
 484             STDCHAR *p = (STDCHAR *) (SvEND(s->var) - s->cnt);
 485             return p;
 486         }
 487     }
 488     return (STDCHAR *) Nullch;
 489 }
 490
 491 SSize_t
 492 PerlIOVia_get_cnt(pTHX_ PerlIO * f)
 493 {
 494     if (PerlIOBase(f)->flags & PERLIO_F_CANREAD) {
 495         PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 496         if (s->var) {
 497             return s->cnt;
 498         }
 499     }
 500     return 0;
 501 }
 502
 503 Size_t
 504 PerlIOVia_bufsiz(pTHX_ PerlIO * f)
 505 {
 506     if (PerlIOBase(f)->flags & PERLIO_F_CANREAD) {
 507         PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 508         if (s->var)
 509             return SvCUR(s->var);
 510     }
 511     return 0;
 512 }
 513
 514 void
 515 PerlIOVia_set_ptrcnt(pTHX_ PerlIO * f, STDCHAR * ptr, SSize_t cnt)
 516 {
 517     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 518     s->cnt = cnt;
 519 }
 520
 521 void
 522 PerlIOVia_setlinebuf(pTHX_ PerlIO * f)
 523 {
 524     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 525     PerlIOVia_method(aTHX_ f, MYMethod(SETLINEBUF), G_VOID, Nullsv);
 526     PerlIOBase_setlinebuf(aTHX_ f);
 527 }
 528
 529 void
 530 PerlIOVia_clearerr(pTHX_ PerlIO * f)
 531 {
 532     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 533     PerlIOVia_method(aTHX_ f, MYMethod(CLEARERR), G_VOID, Nullsv);
 534     PerlIOBase_clearerr(aTHX_ f);
 535 }
 536
 537 IV
 538 PerlIOVia_error(pTHX_ PerlIO * f)
 539 {
 540     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 541     SV *result =
 542         PerlIOVia_method(aTHX_ f, "ERROR", &s->mERROR, G_SCALAR, Nullsv);
 543     return (result) ? SvIV(result) : PerlIOBase_error(aTHX_ f);
 544 }
 545
 546 IV
 547 PerlIOVia_eof(pTHX_ PerlIO * f)
 548 {
 549     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 550     SV *result =
 551         PerlIOVia_method(aTHX_ f, "EOF", &s->mEOF, G_SCALAR, Nullsv);
 552     return (result) ? SvIV(result) : PerlIOBase_eof(aTHX_ f);
 553 }
 554
 555 SV *
 556 PerlIOVia_getarg(pTHX_ PerlIO * f, CLONE_PARAMS * param, int flags)
 557 {
 558     PerlIOVia *s = PerlIOSelf(f, PerlIOVia);
 559     return PerlIOVia_method(aTHX_ f, MYMethod(GETARG), G_SCALAR, Nullsv);
 560 }
 561
 562 PerlIO *
 563 PerlIOVia_dup(pTHX_ PerlIO * f, PerlIO * o, CLONE_PARAMS * param,
 564               int flags)
 565 {
 566     if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
 567         /* Most of the fields will lazily set themselves up as needed
 568            stash and obj have been set up by the implied push
 569          */
 570     }
 571     return f;
 572 }
 573
 574
 575
 576 PerlIO_funcs PerlIO_object = {
 577  sizeof(PerlIO_funcs),
 578  "via",
 579  sizeof(PerlIOVia),
 580  PERLIO_K_BUFFERED|PERLIO_K_DESTRUCT,
 581  PerlIOVia_pushed,
 582  PerlIOVia_popped,
 583  PerlIOVia_open, /* NULL, */
 584  PerlIOVia_binmode, /* NULL, */
 585  PerlIOVia_getarg,
 586  PerlIOVia_fileno,
 587  PerlIOVia_dup,
 588  PerlIOVia_read,
 589  PerlIOVia_unread,
 590  PerlIOVia_write,
 591  PerlIOVia_seek,
 592  PerlIOVia_tell,
 593  PerlIOVia_close,
 594  PerlIOVia_flush,
 595  PerlIOVia_fill,
 596  PerlIOVia_eof,
 597  PerlIOVia_error,
 598  PerlIOVia_clearerr,
 599  PerlIOVia_setlinebuf,
 600  PerlIOVia_get_base,
 601  PerlIOVia_bufsiz,
 602  PerlIOVia_get_ptr,
 603  PerlIOVia_get_cnt,
 604  PerlIOVia_set_ptrcnt,
 605 };
 606
 607
 608 #endif /* Layers available */
 609
 610 MODULE = PerlIO::via    PACKAGE = PerlIO::via
 611 PROTOTYPES: ENABLE;
 612
 613 BOOT:
 614 {
 615 #ifdef PERLIO_LAYERS
 616  PerlIO_define_layer(aTHX_ &PerlIO_object);
 617 #endif
 618 }
 619
 620
 621
 622
 623