5 #include "structmember.h"
7 PyDoc_STRVAR(cStringIO_module_documentation
,
8 "A simple fast partial StringIO replacement.\n"
10 "This module provides a simple useful replacement for\n"
11 "the StringIO module that is written in C. It does not provide the\n"
12 "full generality of StringIO, but it provides enough for most\n"
13 "applications and is especially useful in conjunction with the\n"
18 " from cStringIO import StringIO\n"
20 " an_output_stream=StringIO()\n"
21 " an_output_stream.write(some_stuff)\n"
23 " value=an_output_stream.getvalue()\n"
25 " an_input_stream=StringIO(a_string)\n"
26 " spam=an_input_stream.readline()\n"
27 " spam=an_input_stream.read(5)\n"
28 " an_input_stream.seek(0) # OK, start over\n"
29 " spam=an_input_stream.read() # and read it all\n"
31 "If someone else wants to provide a more complete implementation,\n"
34 "cStringIO.c,v 1.29 1999/06/15 14:10:27 jim Exp\n");
36 /* Declaration for file-like objects that manage data as strings
38 The IOobject type should be though of as a common base type for
39 Iobjects, which provide input (read-only) StringIO objects and
40 Oobjects, which provide read-write objects. Most of the methods
41 depend only on common data.
47 Py_ssize_t pos
, string_size
;
50 #define IOOOBJECT(O) ((IOobject*)(O))
52 /* Declarations for objects of type StringO */
54 typedef struct { /* Subtype of IOobject */
57 Py_ssize_t pos
, string_size
;
63 /* Declarations for objects of type StringI */
65 typedef struct { /* Subtype of IOobject */
68 Py_ssize_t pos
, string_size
;
69 /* We store a reference to the object here in order to keep
70 the buffer alive during the lifetime of the Iobject. */
74 /* IOobject (common) methods */
76 PyDoc_STRVAR(IO_flush__doc__
, "flush(): does nothing.");
79 IO__opencheck(IOobject
*self
) {
81 PyErr_SetString(PyExc_ValueError
,
82 "I/O operation on closed file");
89 IO_get_closed(IOobject
*self
, void *closure
)
91 PyObject
*result
= Py_False
;
93 if (self
->buf
== NULL
)
99 static PyGetSetDef file_getsetlist
[] = {
100 {"closed", (getter
)IO_get_closed
, NULL
, "True if the file is closed"},
105 IO_flush(IOobject
*self
, PyObject
*unused
) {
107 if (!IO__opencheck(self
)) return NULL
;
113 PyDoc_STRVAR(IO_getval__doc__
,
114 "getvalue([use_pos]) -- Get the string value."
116 "If use_pos is specified and is a true value, then the string returned\n"
117 "will include only the text up to the current file position.\n");
120 IO_cgetval(PyObject
*self
) {
121 if (!IO__opencheck(IOOOBJECT(self
))) return NULL
;
122 return PyString_FromStringAndSize(((IOobject
*)self
)->buf
,
123 ((IOobject
*)self
)->pos
);
127 IO_getval(IOobject
*self
, PyObject
*args
) {
128 PyObject
*use_pos
=Py_None
;
131 if (!IO__opencheck(self
)) return NULL
;
132 if (!PyArg_UnpackTuple(args
,"getval", 0, 1,&use_pos
)) return NULL
;
134 if (PyObject_IsTrue(use_pos
)) {
136 if (s
> self
->string_size
) s
=self
->string_size
;
140 return PyString_FromStringAndSize(self
->buf
, s
);
143 PyDoc_STRVAR(IO_isatty__doc__
, "isatty(): always returns 0");
146 IO_isatty(IOobject
*self
, PyObject
*unused
) {
147 if (!IO__opencheck(self
)) return NULL
;
152 PyDoc_STRVAR(IO_read__doc__
,
153 "read([s]) -- Read s characters, or the rest of the string");
156 IO_cread(PyObject
*self
, char **output
, Py_ssize_t n
) {
159 if (!IO__opencheck(IOOOBJECT(self
))) return -1;
160 l
= ((IOobject
*)self
)->string_size
- ((IOobject
*)self
)->pos
;
161 if (n
< 0 || n
> l
) {
166 *output
=((IOobject
*)self
)->buf
+ ((IOobject
*)self
)->pos
;
167 ((IOobject
*)self
)->pos
+= n
;
172 IO_read(IOobject
*self
, PyObject
*args
) {
176 if (!PyArg_ParseTuple(args
, "|n:read", &n
)) return NULL
;
178 if ( (n
=IO_cread((PyObject
*)self
,&output
,n
)) < 0) return NULL
;
180 return PyString_FromStringAndSize(output
, n
);
183 PyDoc_STRVAR(IO_readline__doc__
, "readline() -- Read one line");
186 IO_creadline(PyObject
*self
, char **output
) {
190 if (!IO__opencheck(IOOOBJECT(self
))) return -1;
192 for (n
= ((IOobject
*)self
)->buf
+ ((IOobject
*)self
)->pos
,
193 s
= ((IOobject
*)self
)->buf
+ ((IOobject
*)self
)->string_size
;
194 n
< s
&& *n
!= '\n'; n
++);
197 *output
=((IOobject
*)self
)->buf
+ ((IOobject
*)self
)->pos
;
198 l
= n
- ((IOobject
*)self
)->buf
- ((IOobject
*)self
)->pos
;
199 assert(((IOobject
*)self
)->pos
+ l
< INT_MAX
);
200 ((IOobject
*)self
)->pos
+= (int)l
;
205 IO_readline(IOobject
*self
, PyObject
*args
) {
210 if (!PyArg_ParseTuple(args
, "|i:readline", &m
)) return NULL
;
212 if( (n
=IO_creadline((PyObject
*)self
,&output
)) < 0) return NULL
;
213 if (m
>= 0 && m
< n
) {
218 return PyString_FromStringAndSize(output
, n
);
221 PyDoc_STRVAR(IO_readlines__doc__
, "readlines() -- Read all lines");
224 IO_readlines(IOobject
*self
, PyObject
*args
) {
227 PyObject
*result
, *line
;
228 int hint
= 0, length
= 0;
230 if (!PyArg_ParseTuple(args
, "|i:readlines", &hint
)) return NULL
;
232 result
= PyList_New(0);
237 if ( (n
= IO_creadline((PyObject
*)self
,&output
)) < 0)
241 line
= PyString_FromStringAndSize (output
, n
);
244 if (PyList_Append (result
, line
) == -1) {
250 if (hint
> 0 && length
>= hint
)
259 PyDoc_STRVAR(IO_reset__doc__
,
260 "reset() -- Reset the file position to the beginning");
263 IO_reset(IOobject
*self
, PyObject
*unused
) {
265 if (!IO__opencheck(self
)) return NULL
;
273 PyDoc_STRVAR(IO_tell__doc__
, "tell() -- get the current position.");
276 IO_tell(IOobject
*self
, PyObject
*unused
) {
278 if (!IO__opencheck(self
)) return NULL
;
280 return PyInt_FromSsize_t(self
->pos
);
283 PyDoc_STRVAR(IO_truncate__doc__
,
284 "truncate(): truncate the file at the current position.");
287 IO_truncate(IOobject
*self
, PyObject
*args
) {
290 if (!IO__opencheck(self
)) return NULL
;
291 if (!PyArg_ParseTuple(args
, "|n:truncate", &pos
)) return NULL
;
292 if (pos
< 0) pos
= self
->pos
;
294 if (self
->string_size
> pos
) self
->string_size
= pos
;
295 self
->pos
= self
->string_size
;
302 IO_iternext(Iobject
*self
)
305 next
= IO_readline((IOobject
*)self
, NULL
);
308 if (!PyString_GET_SIZE(next
)) {
310 PyErr_SetNone(PyExc_StopIteration
);
319 /* Read-write object methods */
321 PyDoc_STRVAR(O_seek__doc__
,
322 "seek(position) -- set the current position\n"
323 "seek(position, mode) -- mode 0: absolute; 1: relative; 2: relative to EOF");
326 O_seek(Oobject
*self
, PyObject
*args
) {
330 if (!IO__opencheck(IOOOBJECT(self
))) return NULL
;
331 if (!PyArg_ParseTuple(args
, "n|i:seek", &position
, &mode
))
335 position
+= self
->string_size
;
337 else if (mode
== 1) {
338 position
+= self
->pos
;
341 if (position
> self
->buf_size
) {
343 if (self
->buf_size
<= position
) self
->buf_size
=position
+1;
344 self
->buf
= (char*) realloc(self
->buf
,self
->buf_size
);
346 self
->buf_size
=self
->pos
=0;
347 return PyErr_NoMemory();
350 else if (position
< 0) position
=0;
354 while (--position
>= self
->string_size
) self
->buf
[position
]=0;
360 PyDoc_STRVAR(O_write__doc__
,
361 "write(s) -- Write a string to the file"
362 "\n\nNote (hack:) writing None resets the buffer");
366 O_cwrite(PyObject
*self
, const char *c
, Py_ssize_t l
) {
370 if (!IO__opencheck(IOOOBJECT(self
))) return -1;
371 oself
= (Oobject
*)self
;
374 if (newl
>= oself
->buf_size
) {
375 oself
->buf_size
*= 2;
376 if (oself
->buf_size
<= newl
) {
377 assert(newl
+ 1 < INT_MAX
);
378 oself
->buf_size
= (int)(newl
+1);
380 oself
->buf
= (char*)realloc(oself
->buf
, oself
->buf_size
);
382 PyErr_SetString(PyExc_MemoryError
,"out of memory");
383 oself
->buf_size
= oself
->pos
= 0;
388 memcpy(oself
->buf
+oself
->pos
,c
,l
);
390 assert(oself
->pos
+ l
< INT_MAX
);
391 oself
->pos
+= (int)l
;
393 if (oself
->string_size
< oself
->pos
) {
394 oself
->string_size
= oself
->pos
;
401 O_write(Oobject
*self
, PyObject
*args
) {
405 if (!PyArg_ParseTuple(args
, "t#:write", &c
, &l
)) return NULL
;
407 if (O_cwrite((PyObject
*)self
,c
,l
) < 0) return NULL
;
413 PyDoc_STRVAR(O_close__doc__
, "close(): explicitly release resources held.");
416 O_close(Oobject
*self
, PyObject
*unused
) {
417 if (self
->buf
!= NULL
) free(self
->buf
);
420 self
->pos
= self
->string_size
= self
->buf_size
= 0;
426 PyDoc_STRVAR(O_writelines__doc__
,
427 "writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
429 "Note that newlines are not added. The sequence can be any iterable object\n"
430 "producing strings. This is equivalent to calling write() for each string.");
432 O_writelines(Oobject
*self
, PyObject
*args
) {
435 it
= PyObject_GetIter(args
);
438 while ((s
= PyIter_Next(it
)) != NULL
) {
441 if (PyString_AsStringAndSize(s
, &c
, &n
) == -1) {
446 if (O_cwrite((PyObject
*)self
, c
, n
) == -1) {
456 /* See if PyIter_Next failed */
457 if (PyErr_Occurred())
462 static struct PyMethodDef O_methods
[] = {
463 /* Common methods: */
464 {"flush", (PyCFunction
)IO_flush
, METH_NOARGS
, IO_flush__doc__
},
465 {"getvalue", (PyCFunction
)IO_getval
, METH_VARARGS
, IO_getval__doc__
},
466 {"isatty", (PyCFunction
)IO_isatty
, METH_NOARGS
, IO_isatty__doc__
},
467 {"read", (PyCFunction
)IO_read
, METH_VARARGS
, IO_read__doc__
},
468 {"readline", (PyCFunction
)IO_readline
, METH_VARARGS
, IO_readline__doc__
},
469 {"readlines", (PyCFunction
)IO_readlines
,METH_VARARGS
, IO_readlines__doc__
},
470 {"reset", (PyCFunction
)IO_reset
, METH_NOARGS
, IO_reset__doc__
},
471 {"tell", (PyCFunction
)IO_tell
, METH_NOARGS
, IO_tell__doc__
},
472 {"truncate", (PyCFunction
)IO_truncate
, METH_VARARGS
, IO_truncate__doc__
},
474 /* Read-write StringIO specific methods: */
475 {"close", (PyCFunction
)O_close
, METH_NOARGS
, O_close__doc__
},
476 {"seek", (PyCFunction
)O_seek
, METH_VARARGS
, O_seek__doc__
},
477 {"write", (PyCFunction
)O_write
, METH_VARARGS
, O_write__doc__
},
478 {"writelines", (PyCFunction
)O_writelines
, METH_O
, O_writelines__doc__
},
479 {NULL
, NULL
} /* sentinel */
482 static PyMemberDef O_memberlist
[] = {
483 {"softspace", T_INT
, offsetof(Oobject
, softspace
), 0,
484 "flag indicating that a space needs to be printed; used by print"},
485 /* getattr(f, "closed") is implemented without this table */
486 {NULL
} /* Sentinel */
490 O_dealloc(Oobject
*self
) {
491 if (self
->buf
!= NULL
)
496 PyDoc_STRVAR(Otype__doc__
, "Simple type for output to strings.");
498 static PyTypeObject Otype
= {
499 PyObject_HEAD_INIT(NULL
)
501 "cStringIO.StringO", /*tp_name*/
502 sizeof(Oobject
), /*tp_basicsize*/
505 (destructor
)O_dealloc
, /*tp_dealloc*/
512 0, /*tp_as_sequence*/
520 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
521 Otype__doc__
, /*tp_doc */
524 0, /*tp_richcompare */
525 0, /*tp_weaklistoffset */
526 PyObject_SelfIter
, /*tp_iter */
527 (iternextfunc
)IO_iternext
, /*tp_iternext */
528 O_methods
, /*tp_methods */
529 O_memberlist
, /*tp_members */
530 file_getsetlist
, /*tp_getset */
534 newOobject(int size
) {
537 self
= PyObject_New(Oobject
, &Otype
);
541 self
->string_size
= 0;
544 self
->buf
= (char *)malloc(size
);
546 PyErr_SetString(PyExc_MemoryError
,"out of memory");
553 return (PyObject
*)self
;
556 /* End of code for StringO objects */
557 /* -------------------------------------------------------- */
560 I_close(Iobject
*self
, PyObject
*unused
) {
561 Py_XDECREF(self
->pbuf
);
565 self
->pos
= self
->string_size
= 0;
572 I_seek(Iobject
*self
, PyObject
*args
) {
576 if (!IO__opencheck(IOOOBJECT(self
))) return NULL
;
577 if (!PyArg_ParseTuple(args
, "n|i:seek", &position
, &mode
))
580 if (mode
== 2) position
+= self
->string_size
;
581 else if (mode
== 1) position
+= self
->pos
;
583 if (position
< 0) position
=0;
591 static struct PyMethodDef I_methods
[] = {
592 /* Common methods: */
593 {"flush", (PyCFunction
)IO_flush
, METH_NOARGS
, IO_flush__doc__
},
594 {"getvalue", (PyCFunction
)IO_getval
, METH_VARARGS
, IO_getval__doc__
},
595 {"isatty", (PyCFunction
)IO_isatty
, METH_NOARGS
, IO_isatty__doc__
},
596 {"read", (PyCFunction
)IO_read
, METH_VARARGS
, IO_read__doc__
},
597 {"readline", (PyCFunction
)IO_readline
, METH_VARARGS
, IO_readline__doc__
},
598 {"readlines", (PyCFunction
)IO_readlines
,METH_VARARGS
, IO_readlines__doc__
},
599 {"reset", (PyCFunction
)IO_reset
, METH_NOARGS
, IO_reset__doc__
},
600 {"tell", (PyCFunction
)IO_tell
, METH_NOARGS
, IO_tell__doc__
},
601 {"truncate", (PyCFunction
)IO_truncate
, METH_VARARGS
, IO_truncate__doc__
},
603 /* Read-only StringIO specific methods: */
604 {"close", (PyCFunction
)I_close
, METH_NOARGS
, O_close__doc__
},
605 {"seek", (PyCFunction
)I_seek
, METH_VARARGS
, O_seek__doc__
},
610 I_dealloc(Iobject
*self
) {
611 Py_XDECREF(self
->pbuf
);
616 PyDoc_STRVAR(Itype__doc__
,
617 "Simple type for treating strings as input file streams");
619 static PyTypeObject Itype
= {
620 PyObject_HEAD_INIT(NULL
)
622 "cStringIO.StringI", /*tp_name*/
623 sizeof(Iobject
), /*tp_basicsize*/
626 (destructor
)I_dealloc
, /*tp_dealloc*/
633 0, /*tp_as_sequence*/
640 0, /* tp_as_buffer */
641 Py_TPFLAGS_DEFAULT
, /* tp_flags */
642 Itype__doc__
, /* tp_doc */
645 0, /* tp_richcompare */
646 0, /* tp_weaklistoffset */
647 PyObject_SelfIter
, /* tp_iter */
648 (iternextfunc
)IO_iternext
, /* tp_iternext */
649 I_methods
, /* tp_methods */
651 file_getsetlist
, /* tp_getset */
655 newIobject(PyObject
*s
) {
660 if (PyObject_AsReadBuffer(s
, (const void **)&buf
, &size
)) {
661 PyErr_Format(PyExc_TypeError
, "expected read buffer, %.200s found",
662 s
->ob_type
->tp_name
);
665 self
= PyObject_New(Iobject
, &Itype
);
666 if (!self
) return NULL
;
669 self
->string_size
=size
;
673 return (PyObject
*)self
;
676 /* End of code for StringI objects */
677 /* -------------------------------------------------------- */
680 PyDoc_STRVAR(IO_StringIO__doc__
,
681 "StringIO([s]) -- Return a StringIO-like stream for reading or writing");
684 IO_StringIO(PyObject
*self
, PyObject
*args
) {
687 if (!PyArg_UnpackTuple(args
, "StringIO", 0, 1, &s
)) return NULL
;
689 if (s
) return newIobject(s
);
690 return newOobject(128);
693 /* List of methods defined in the module */
695 static struct PyMethodDef IO_methods
[] = {
696 {"StringIO", (PyCFunction
)IO_StringIO
,
697 METH_VARARGS
, IO_StringIO__doc__
},
698 {NULL
, NULL
} /* sentinel */
702 /* Initialization function for the module (*must* be called initcStringIO) */
704 static struct PycStringIO_CAPI CAPI
= {
715 #ifndef PyMODINIT_FUNC /* declarations for DLL import/export */
716 #define PyMODINIT_FUNC void
719 initcStringIO(void) {
723 /* Create the module and add the functions */
724 m
= Py_InitModule4("cStringIO", IO_methods
,
725 cStringIO_module_documentation
,
726 (PyObject
*)NULL
,PYTHON_API_VERSION
);
727 if (m
== NULL
) return;
729 /* Add some symbolic constants to the module */
730 d
= PyModule_GetDict(m
);
733 Itype
.ob_type
=&PyType_Type
;
734 Otype
.ob_type
=&PyType_Type
;
735 if (PyType_Ready(&Otype
) < 0) return;
736 if (PyType_Ready(&Itype
) < 0) return;
737 PyDict_SetItemString(d
,"cStringIO_CAPI",
738 v
= PyCObject_FromVoidPtr(&CAPI
,NULL
));
742 PyDict_SetItemString(d
,"InputType", (PyObject
*)&Itype
);
743 PyDict_SetItemString(d
,"OutputType", (PyObject
*)&Otype
);
745 /* Maybe make certain warnings go away */
746 if (0) PycString_IMPORT
;