home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / pyth_os2.zip / python-1.0.2 / Objects / fileobject.c < prev    next >
C/C++ Source or Header  |  1994-05-04  |  14KB  |  782 lines
  1. /***********************************************************
  2. Copyright 1991, 1992, 1993, 1994 by Stichting Mathematisch Centrum,
  3. Amsterdam, The Netherlands.
  4.  
  5.                         All Rights Reserved
  6.  
  7. Permission to use, copy, modify, and distribute this software and its 
  8. documentation for any purpose and without fee is hereby granted, 
  9. provided that the above copyright notice appear in all copies and that
  10. both that copyright notice and this permission notice appear in 
  11. supporting documentation, and that the names of Stichting Mathematisch
  12. Centrum or CWI not be used in advertising or publicity pertaining to
  13. distribution of the software without specific, written prior permission.
  14.  
  15. STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
  16. THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  17. FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
  18. FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  19. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  20. ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  21. OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  22.  
  23. ******************************************************************/
  24.  
  25. /* File object implementation */
  26.  
  27. #include "allobjects.h"
  28. #include "modsupport.h"
  29. #include "structmember.h"
  30. #include "ceval.h"
  31.  
  32. #define BUF(v) GETSTRINGVALUE((stringobject *)v)
  33.  
  34. #include <errno.h>
  35.  
  36. typedef struct {
  37.     OB_HEAD
  38.     FILE *f_fp;
  39.     object *f_name;
  40.     object *f_mode;
  41.     int (*f_close) PROTO((FILE *));
  42.     int f_softspace; /* Flag used by 'print' command */
  43. } fileobject;
  44.  
  45. FILE *
  46. getfilefile(f)
  47.     object *f;
  48. {
  49.     if (f == NULL || !is_fileobject(f))
  50.         return NULL;
  51.     else
  52.         return ((fileobject *)f)->f_fp;
  53. }
  54.  
  55. object *
  56. getfilename(f)
  57.     object *f;
  58. {
  59.     if (f == NULL || !is_fileobject(f))
  60.         return NULL;
  61.     else
  62.         return ((fileobject *)f)->f_name;
  63. }
  64.  
  65. object *
  66. newopenfileobject(fp, name, mode, close)
  67.     FILE *fp;
  68.     char *name;
  69.     char *mode;
  70.     int (*close) FPROTO((FILE *));
  71. {
  72.     fileobject *f = NEWOBJ(fileobject, &Filetype);
  73.     if (f == NULL)
  74.         return NULL;
  75.     f->f_fp = NULL;
  76.     f->f_name = newstringobject(name);
  77.     f->f_mode = newstringobject(mode);
  78.     f->f_close = close;
  79.     f->f_softspace = 0;
  80.     if (f->f_name == NULL || f->f_mode == NULL) {
  81.         DECREF(f);
  82.         return NULL;
  83.     }
  84.     f->f_fp = fp;
  85.     return (object *) f;
  86. }
  87.  
  88. object *
  89. newfileobject(name, mode)
  90.     char *name, *mode;
  91. {
  92.     extern int fclose PROTO((FILE *));
  93.     fileobject *f;
  94.     f = (fileobject *) newopenfileobject((FILE *)NULL, name, mode, fclose);
  95.     if (f == NULL)
  96.         return NULL;
  97. #ifdef USE_FOPENRF
  98.     if (*mode == '*') {
  99.         FILE *fopenRF();
  100.         f->f_fp = fopenRF(name, mode+1);
  101.     }
  102.     else
  103. #endif
  104.     {
  105.         BGN_SAVE
  106.         f->f_fp = fopen(name, mode);
  107.         END_SAVE
  108.     }
  109.     if (f->f_fp == NULL) {
  110.         err_errno(IOError);
  111.         DECREF(f);
  112.         return NULL;
  113.     }
  114.     return (object *)f;
  115. }
  116.  
  117. void
  118. setfilebufsize(f, bufsize)
  119.     object *f;
  120.     int bufsize;
  121. {
  122.     if (bufsize >= 0) {
  123. #ifdef HAVE_SETVBUF
  124.         int type;
  125.         switch (bufsize) {
  126.         case 0:
  127.             type = _IONBF;
  128.             break;
  129.         case 1:
  130.             type = _IOLBF;
  131.             bufsize = BUFSIZ;
  132.             break;
  133.         default:
  134.             type = _IOFBF;
  135.         }
  136.         setvbuf(((fileobject *)f)->f_fp, (char *)NULL, type, bufsize);
  137. #endif /* HAVE_SETVBUF */
  138.     }
  139. }
  140.  
  141. static object *
  142. err_closed()
  143. {
  144.     err_setstr(ValueError, "I/O operation on closed file");
  145.     return NULL;
  146. }
  147.  
  148. /* Methods */
  149.  
  150. static void
  151. file_dealloc(f)
  152.     fileobject *f;
  153. {
  154.     if (f->f_fp != NULL && f->f_close != NULL) {
  155.         BGN_SAVE
  156.         (*f->f_close)(f->f_fp);
  157.         END_SAVE
  158.     }
  159.     if (f->f_name != NULL)
  160.         DECREF(f->f_name);
  161.     if (f->f_mode != NULL)
  162.         DECREF(f->f_mode);
  163.     free((char *)f);
  164. }
  165.  
  166. static object *
  167. file_repr(f)
  168.     fileobject *f;
  169. {
  170.     char buf[300];
  171.     sprintf(buf, "<%s file '%.256s', mode '%.10s' at %lx>",
  172.         f->f_fp == NULL ? "closed" : "open",
  173.         getstringvalue(f->f_name),
  174.         getstringvalue(f->f_mode),
  175.         (long)f);
  176.     return newstringobject(buf);
  177. }
  178.  
  179. static object *
  180. file_close(f, args)
  181.     fileobject *f;
  182.     object *args;
  183. {
  184.     int sts = 0;
  185.     if (!getnoarg(args))
  186.         return NULL;
  187.     if (f->f_fp != NULL) {
  188.         if (f->f_close != NULL) {
  189.             BGN_SAVE
  190.             errno = 0;
  191.             sts = (*f->f_close)(f->f_fp);
  192.             END_SAVE
  193.         }
  194.         f->f_fp = NULL;
  195.     }
  196.     if (sts == EOF)
  197.         return err_errno(IOError);
  198.     if (sts != 0)
  199.         return newintobject((long)sts);
  200.     INCREF(None);
  201.     return None;
  202. }
  203.  
  204. static object *
  205. file_seek(f, args)
  206.     fileobject *f;
  207.     object *args;
  208. {
  209.     long offset;
  210.     int whence;
  211.     int ret;
  212.     
  213.     if (f->f_fp == NULL)
  214.         return err_closed();
  215.     whence = 0;
  216.     if (!getargs(args, "l", &offset)) {
  217.         err_clear();
  218.         if (!getargs(args, "(li)", &offset, &whence))
  219.             return NULL;
  220.     }
  221.     BGN_SAVE
  222.     errno = 0;
  223.     ret = fseek(f->f_fp, offset, whence);
  224.     END_SAVE
  225.     if (ret != 0) {
  226.         err_errno(IOError);
  227.         clearerr(f->f_fp);
  228.         return NULL;
  229.     }
  230.     INCREF(None);
  231.     return None;
  232. }
  233.  
  234. static object *
  235. file_tell(f, args)
  236.     fileobject *f;
  237.     object *args;
  238. {
  239.     long offset;
  240.     if (f->f_fp == NULL)
  241.         return err_closed();
  242.     if (!getnoarg(args))
  243.         return NULL;
  244.     BGN_SAVE
  245.     errno = 0;
  246.     offset = ftell(f->f_fp);
  247.     END_SAVE
  248.     if (offset == -1L) {
  249.         err_errno(IOError);
  250.         clearerr(f->f_fp);
  251.         return NULL;
  252.     }
  253.     return newintobject(offset);
  254. }
  255.  
  256. static object *
  257. file_fileno(f, args)
  258.     fileobject *f;
  259.     object *args;
  260. {
  261.     if (f->f_fp == NULL)
  262.         return err_closed();
  263.     if (!getnoarg(args))
  264.         return NULL;
  265.     return newintobject((long) fileno(f->f_fp));
  266. }
  267.  
  268. static object *
  269. file_flush(f, args)
  270.     fileobject *f;
  271.     object *args;
  272. {
  273.     int res;
  274.     
  275.     if (f->f_fp == NULL)
  276.         return err_closed();
  277.     if (!getnoarg(args))
  278.         return NULL;
  279.     BGN_SAVE
  280.     errno = 0;
  281.     res = fflush(f->f_fp);
  282.     END_SAVE
  283.     if (res != 0) {
  284.         err_errno(IOError);
  285.         clearerr(f->f_fp);
  286.         return NULL;
  287.     }
  288.     INCREF(None);
  289.     return None;
  290. }
  291.  
  292. static object *
  293. file_isatty(f, args)
  294.     fileobject *f;
  295.     object *args;
  296. {
  297.     long res;
  298.     if (f->f_fp == NULL)
  299.         return err_closed();
  300.     if (!getnoarg(args))
  301.         return NULL;
  302.     BGN_SAVE
  303.     res = isatty((int)fileno(f->f_fp));
  304.     END_SAVE
  305.     return newintobject(res);
  306. }
  307.  
  308. static object *
  309. file_read(f, args)
  310.     fileobject *f;
  311.     object *args;
  312. {
  313.     int n, n1, n2, n3;
  314.     object *v;
  315.     
  316.     if (f->f_fp == NULL)
  317.         return err_closed();
  318.     if (args == NULL) {
  319.         n = 0;
  320.         if (n < 0) {
  321.             err_setstr(ValueError, "negative read count");
  322.             return NULL;
  323.         }
  324.     }
  325.     else if (!getargs(args, "i", &n))
  326.         return NULL;
  327.     
  328.     n2 = n != 0 ? n : BUFSIZ;
  329.     v = newsizedstringobject((char *)NULL, n2);
  330.     if (v == NULL)
  331.         return NULL;
  332.     n1 = 0;
  333.     BGN_SAVE
  334.     for (;;) {
  335.         n3 = fread(BUF(v)+n1, 1, n2-n1, f->f_fp);
  336.         /* XXX Error check? */
  337.         if (n3 == 0)
  338.             break;
  339.         n1 += n3;
  340.         if (n1 == n)
  341.             break;
  342.         if (n == 0) {
  343.             n2 = n1 + BUFSIZ;
  344.             RET_SAVE
  345.             if (resizestring(&v, n2) < 0)
  346.                 return NULL;
  347.             RES_SAVE
  348.         }
  349.     }
  350.     END_SAVE
  351.     if (n1 != n2)
  352.         resizestring(&v, n1);
  353.     return v;
  354. }
  355.  
  356. /* Internal routine to get a line.
  357.    Size argument interpretation:
  358.    > 0: max length;
  359.    = 0: read arbitrary line;
  360.    < 0: strip trailing '\n', raise EOFError if EOF reached immediately
  361. */
  362.  
  363. static object *
  364. getline(f, n)
  365.     fileobject *f;
  366.     int n;
  367. {
  368.     register FILE *fp;
  369.     register int c;
  370.     register char *buf, *end;
  371.     int n1, n2;
  372.     object *v;
  373.  
  374.     fp = f->f_fp;
  375.     n2 = n > 0 ? n : 100;
  376.     v = newsizedstringobject((char *)NULL, n2);
  377.     if (v == NULL)
  378.         return NULL;
  379.     buf = BUF(v);
  380.     end = buf + n2;
  381.  
  382.     BGN_SAVE
  383.     for (;;) {
  384.         if ((c = getc(fp)) == EOF) {
  385.             clearerr(fp);
  386.             if (intrcheck()) {
  387.                 RET_SAVE
  388.                 DECREF(v);
  389.                 err_set(KeyboardInterrupt);
  390.                 return NULL;
  391.             }
  392.             if (n < 0 && buf == BUF(v)) {
  393.                 RET_SAVE
  394.                 DECREF(v);
  395.                 err_setstr(EOFError,
  396.                        "EOF when reading a line");
  397.                 return NULL;
  398.             }
  399.             break;
  400.         }
  401.         if ((*buf++ = c) == '\n') {
  402.             if (n < 0)
  403.                 buf--;
  404.             break;
  405.         }
  406.         if (buf == end) {
  407.             if (n > 0)
  408.                 break;
  409.             n1 = n2;
  410.             n2 += 1000;
  411.             RET_SAVE
  412.             if (resizestring(&v, n2) < 0)
  413.                 return NULL;
  414.             RES_SAVE
  415.             buf = BUF(v) + n1;
  416.             end = BUF(v) + n2;
  417.         }
  418.     }
  419.     END_SAVE
  420.  
  421.     n1 = buf - BUF(v);
  422.     if (n1 != n2)
  423.         resizestring(&v, n1);
  424.     return v;
  425. }
  426.  
  427. /* External C interface */
  428.  
  429. object *
  430. filegetline(f, n)
  431.     object *f;
  432.     int n;
  433. {
  434.     if (f == NULL) {
  435.         err_badcall();
  436.         return NULL;
  437.     }
  438.     if (!is_fileobject(f)) {
  439.         object *reader;
  440.         object *args;
  441.         object *result;
  442.         reader = getattr(f, "readline");
  443.         if (reader == NULL)
  444.             return NULL;
  445.         if (n <= 0)
  446.             args = mkvalue("()");
  447.         else
  448.             args = mkvalue("(i)", n);
  449.         if (args == NULL) {
  450.             DECREF(reader);
  451.             return NULL;
  452.         }
  453.         result = call_object(reader, args);
  454.         DECREF(reader);
  455.         DECREF(args);
  456.         if (result != NULL && !is_stringobject(result)) {
  457.             DECREF(result);
  458.             result = NULL;
  459.             err_setstr(TypeError,
  460.                    "object.readline() returned non-string");
  461.         }
  462.         if (n < 0 && result != NULL) {
  463.             char *s = getstringvalue(result);
  464.             int len = getstringsize(result);
  465.             if (len == 0) {
  466.                 DECREF(result);
  467.                 result = NULL;
  468.                 err_setstr(EOFError,
  469.                        "EOF when reading a line");
  470.             }
  471.             else if (s[len-1] == '\n') {
  472.                 if (result->ob_refcnt == 1)
  473.                     resizestring(&result, len-1);
  474.                 else {
  475.                     object *v;
  476.                     v = newsizedstringobject(s, len-1);
  477.                     DECREF(result);
  478.                     result = v;
  479.                 }
  480.             }
  481.         }
  482.         return result;
  483.     }
  484.     if (((fileobject*)f)->f_fp == NULL)
  485.         return err_closed();
  486.     return getline((fileobject *)f, n);
  487. }
  488.  
  489. /* Python method */
  490.  
  491. static object *
  492. file_readline(f, args)
  493.     fileobject *f;
  494.     object *args;
  495. {
  496.     int n;
  497.  
  498.     if (f->f_fp == NULL)
  499.         return err_closed();
  500.     if (args == NULL)
  501.         n = 0; /* Unlimited */
  502.     else {
  503.         if (!getintarg(args, &n))
  504.             return NULL;
  505.         if (n < 0) {
  506.             err_setstr(ValueError, "negative readline count");
  507.             return NULL;
  508.         }
  509.     }
  510.  
  511.     return getline(f, n);
  512. }
  513.  
  514. static object *
  515. file_readlines(f, args)
  516.     fileobject *f;
  517.     object *args;
  518. {
  519.     object *list;
  520.     object *line;
  521.  
  522.     if (f->f_fp == NULL)
  523.         return err_closed();
  524.     if (!getnoarg(args))
  525.         return NULL;
  526.     if ((list = newlistobject(0)) == NULL)
  527.         return NULL;
  528.     for (;;) {
  529.         line = getline(f, 0);
  530.         if (line != NULL && getstringsize(line) == 0) {
  531.             DECREF(line);
  532.             break;
  533.         }
  534.         if (line == NULL || addlistitem(list, line) != 0) {
  535.             DECREF(list);
  536.             XDECREF(line);
  537.             return NULL;
  538.         }
  539.         DECREF(line);
  540.     }
  541.     return list;
  542. }
  543.  
  544. static object *
  545. file_write(f, args)
  546.     fileobject *f;
  547.     object *args;
  548. {
  549.     char *s;
  550.     int n, n2;
  551.     if (f->f_fp == NULL)
  552.         return err_closed();
  553.     if (!getargs(args, "s#", &s, &n))
  554.         return NULL;
  555.     f->f_softspace = 0;
  556.     BGN_SAVE
  557.     errno = 0;
  558.     n2 = fwrite(s, 1, n, f->f_fp);
  559.     END_SAVE
  560.     if (n2 != n) {
  561.         err_errno(IOError);
  562.         clearerr(f->f_fp);
  563.         return NULL;
  564.     }
  565.     INCREF(None);
  566.     return None;
  567. }
  568.  
  569. static object *
  570. file_writelines(f, args)
  571.     fileobject *f;
  572.     object *args;
  573. {
  574.     int i, n;
  575.     if (f->f_fp == NULL)
  576.         return err_closed();
  577.     if (args == NULL || !is_listobject(args)) {
  578.         err_setstr(TypeError,
  579.                "writelines() requires list of strings");
  580.         return NULL;
  581.     }
  582.     n = getlistsize(args);
  583.     f->f_softspace = 0;
  584.     BGN_SAVE
  585.     errno = 0;
  586.     for (i = 0; i < n; i++) {
  587.         object *line = getlistitem(args, i);
  588.         int len;
  589.         int nwritten;
  590.         if (!is_stringobject(line)) {
  591.             RET_SAVE
  592.             err_setstr(TypeError,
  593.                    "writelines() requires list of strings");
  594.             return NULL;
  595.         }
  596.         len = getstringsize(line);
  597.         nwritten = fwrite(getstringvalue(line), 1, len, f->f_fp);
  598.         if (nwritten != len) {
  599.             RET_SAVE
  600.             err_errno(IOError);
  601.             clearerr(f->f_fp);
  602.             return NULL;
  603.         }
  604.     }
  605.     END_SAVE
  606.     INCREF(None);
  607.     return None;
  608. }
  609.  
  610. static struct methodlist file_methods[] = {
  611.     {"close",    (method)file_close},
  612.     {"flush",    (method)file_flush},
  613.     {"fileno",    (method)file_fileno},
  614.     {"isatty",    (method)file_isatty},
  615.     {"read",    (method)file_read},
  616.     {"readline",    (method)file_readline},
  617.     {"readlines",    (method)file_readlines},
  618.     {"seek",    (method)file_seek},
  619.     {"tell",    (method)file_tell},
  620.     {"write",    (method)file_write},
  621.     {"writelines",    (method)file_writelines},
  622.     {NULL,        NULL}        /* sentinel */
  623. };
  624.  
  625. #define OFF(x) offsetof(fileobject, x)
  626.  
  627. static struct memberlist file_memberlist[] = {
  628.     {"softspace",    T_INT,        OFF(f_softspace)},
  629.     {"mode",    T_OBJECT,    OFF(f_mode),    RO},
  630.     {"name",    T_OBJECT,    OFF(f_name),    RO},
  631.     /* getattr(f, "closed") is implemented without this table */
  632.     {"closed",    T_INT,        0,        RO},
  633.     {NULL}    /* Sentinel */
  634. };
  635.  
  636. static object *
  637. file_getattr(f, name)
  638.     fileobject *f;
  639.     char *name;
  640. {
  641.     object *res;
  642.  
  643.     res = findmethod(file_methods, (object *)f, name);
  644.     if (res != NULL)
  645.         return res;
  646.     err_clear();
  647.     if (strcmp(name, "closed") == 0)
  648.         return newintobject((long)(f->f_fp == 0));
  649.     return getmember((char *)f, file_memberlist, name);
  650. }
  651.  
  652. static int
  653. file_setattr(f, name, v)
  654.     fileobject *f;
  655.     char *name;
  656.     object *v;
  657. {
  658.     if (v == NULL) {
  659.         err_setstr(AttributeError, "can't delete file attributes");
  660.         return -1;
  661.     }
  662.     return setmember((char *)f, file_memberlist, name, v);
  663. }
  664.  
  665. typeobject Filetype = {
  666.     OB_HEAD_INIT(&Typetype)
  667.     0,
  668.     "file",
  669.     sizeof(fileobject),
  670.     0,
  671.     (destructor)file_dealloc, /*tp_dealloc*/
  672.     0,        /*tp_print*/
  673.     (getattrfunc)file_getattr, /*tp_getattr*/
  674.     (setattrfunc)file_setattr, /*tp_setattr*/
  675.     0,        /*tp_compare*/
  676.     (reprfunc)file_repr, /*tp_repr*/
  677. };
  678.  
  679. /* Interface for the 'soft space' between print items. */
  680.  
  681. int
  682. softspace(f, newflag)
  683.     object *f;
  684.     int newflag;
  685. {
  686.     int oldflag = 0;
  687.     if (f == NULL) {
  688.         /* Do nothing */
  689.     }
  690.     else if (is_fileobject(f)) {
  691.         oldflag = ((fileobject *)f)->f_softspace;
  692.         ((fileobject *)f)->f_softspace = newflag;
  693.     }
  694.     else {
  695.         object *v;
  696.         v = getattr(f, "softspace");
  697.         if (v == NULL)
  698.             err_clear();
  699.         else {
  700.             if (is_intobject(v))
  701.                 oldflag = getintvalue(v);
  702.             DECREF(v);
  703.         }
  704.         v = newintobject((long)newflag);
  705.         if (v == NULL)
  706.             err_clear();
  707.         else {
  708.             if (setattr(f, "softspace", v) != 0)
  709.                 err_clear();
  710.             DECREF(v);
  711.         }
  712.     }
  713.     return oldflag;
  714. }
  715.  
  716. /* Interfaces to write objects/strings to file-like objects */
  717.  
  718. int
  719. writeobject(v, f, flags)
  720.     object *v;
  721.     object *f;
  722.     int flags;
  723. {
  724.     object *writer, *value, *result;
  725.     if (f == NULL) {
  726.         err_setstr(TypeError, "writeobject with NULL file");
  727.         return -1;
  728.     }
  729.     else if (is_fileobject(f)) {
  730.         FILE *fp = getfilefile(f);
  731.         if (fp == NULL) {
  732.             err_closed();
  733.             return -1;
  734.         }
  735.         return printobject(v, fp, flags);
  736.     }
  737.     writer = getattr(f, "write");
  738.     if (writer == NULL)
  739.         return -1;
  740.     if (flags & PRINT_RAW)
  741.         value = strobject(v);
  742.     else
  743.         value = reprobject(v);
  744.     if (value == NULL) {
  745.         DECREF(writer);
  746.         return -1;
  747.     }
  748.     result = call_object(writer, value);
  749.     DECREF(writer);
  750.     DECREF(value);
  751.     if (result == NULL)
  752.         return -1;
  753.     DECREF(result);
  754.     return 0;
  755. }
  756.  
  757. void
  758. writestring(s, f)
  759.     char *s;
  760.     object *f;
  761. {
  762.     if (f == NULL) {
  763.         /* Do nothing */
  764.     }
  765.     else if (is_fileobject(f)) {
  766.         FILE *fp = getfilefile(f);
  767.         if (fp != NULL)
  768.             fputs(s, fp);
  769.     }
  770.     else if (!err_occurred()) {
  771.         object *v = newstringobject(s);
  772.         if (v == NULL) {
  773.             err_clear();
  774.         }
  775.         else {
  776.             if (writeobject(v, f, PRINT_RAW) != 0)
  777.                 err_clear();
  778.             DECREF(v);
  779.         }
  780.     }
  781. }
  782.