blob: 8aff2e32eb15c5e9d8f61b0ec9b9b78fe3fb5376 [file] [log] [blame]
Guido van Rossum049cd901996-12-05 23:30:48 +00001#ifndef CSTRINGIO_INCLUDED
2#define CSTRINGIO_INCLUDED
3/*
4
Guido van Rossumcd8732a1997-12-08 15:16:08 +00005 cStringIO.h,v 1.4 1997/12/07 14:27:00 jim Exp
Guido van Rossum049cd901996-12-05 23:30:48 +00006
7 cStringIO C API
8
9 Copyright
10
11 Copyright 1996 Digital Creations, L.C., 910 Princess Anne
12 Street, Suite 300, Fredericksburg, Virginia 22401 U.S.A. All
13 rights reserved. Copyright in this software is owned by DCLC,
14 unless otherwise indicated. Permission to use, copy and
15 distribute this software is hereby granted, provided that the
16 above copyright notice appear in all copies and that both that
17 copyright notice and this permission notice appear. Note that
18 any product, process or technology described in this software
19 may be the subject of other Intellectual Property rights
20 reserved by Digital Creations, L.C. and are not licensed
21 hereunder.
22
23 Trademarks
24
25 Digital Creations & DCLC, are trademarks of Digital Creations, L.C..
26 All other trademarks are owned by their respective companies.
27
28 No Warranty
29
30 The software is provided "as is" without warranty of any kind,
31 either express or implied, including, but not limited to, the
32 implied warranties of merchantability, fitness for a particular
33 purpose, or non-infringement. This software could include
34 technical inaccuracies or typographical errors. Changes are
35 periodically made to the software; these changes will be
36 incorporated in new editions of the software. DCLC may make
37 improvements and/or changes in this software at any time
38 without notice.
39
40 Limitation Of Liability
41
42 In no event will DCLC be liable for direct, indirect, special,
43 incidental, economic, cover, or consequential damages arising
44 out of the use of or inability to use this software even if
45 advised of the possibility of such damages. Some states do not
46 allow the exclusion or limitation of implied warranties or
47 limitation of liability for incidental or consequential
48 damages, so the above limitation or exclusion may not apply to
49 you.
50
51 If you have questions regarding this software,
52 contact:
53
54 info@digicool.com
55 Digital Creations L.C.
56
57 (540) 371-6909
58
59
60 This header provides access to cStringIO objects from C.
61 Functions are provided for calling cStringIO objects and
62 macros are provided for testing whether you have cStringIO
63 objects.
64
65 Before calling any of the functions or macros, you must initialize
66 the routines with:
67
Guido van Rossum7999bfb1999-01-25 21:36:13 +000068 PycString_IMPORT
Guido van Rossum049cd901996-12-05 23:30:48 +000069
70 This would typically be done in your init function.
71
Guido van Rossum049cd901996-12-05 23:30:48 +000072*/
73
Thomas Wouters7e474022000-07-16 12:04:32 +000074/* Basic functions to manipulate cStringIO objects from C */
Guido van Rossum049cd901996-12-05 23:30:48 +000075
Guido van Rossum0a73dd51997-04-09 17:34:28 +000076static struct PycStringIO_CAPI {
77
78 /* Read a string. If the last argument is -1, the remainder will be read. */
Tim Petersdbd9ba62000-07-09 03:09:57 +000079 int(*cread)(PyObject *, char **, int);
Guido van Rossum049cd901996-12-05 23:30:48 +000080
Guido van Rossum0a73dd51997-04-09 17:34:28 +000081 /* Read a line */
Tim Petersdbd9ba62000-07-09 03:09:57 +000082 int(*creadline)(PyObject *, char **);
Guido van Rossum049cd901996-12-05 23:30:48 +000083
Guido van Rossum0a73dd51997-04-09 17:34:28 +000084 /* Write a string */
Tim Petersdbd9ba62000-07-09 03:09:57 +000085 int(*cwrite)(PyObject *, char *, int);
Guido van Rossum049cd901996-12-05 23:30:48 +000086
Guido van Rossum0a73dd51997-04-09 17:34:28 +000087 /* Get the cStringIO object as a Python string */
Tim Petersdbd9ba62000-07-09 03:09:57 +000088 PyObject *(*cgetvalue)(PyObject *);
Guido van Rossum049cd901996-12-05 23:30:48 +000089
Guido van Rossum0a73dd51997-04-09 17:34:28 +000090 /* Create a new output object */
Tim Petersdbd9ba62000-07-09 03:09:57 +000091 PyObject *(*NewOutput)(int);
Guido van Rossum049cd901996-12-05 23:30:48 +000092
Guido van Rossum0a73dd51997-04-09 17:34:28 +000093 /* Create an input object from a Python string */
Tim Petersdbd9ba62000-07-09 03:09:57 +000094 PyObject *(*NewInput)(PyObject *);
Guido van Rossum049cd901996-12-05 23:30:48 +000095
Guido van Rossum0a73dd51997-04-09 17:34:28 +000096 /* The Python types for cStringIO input and output objects.
97 Note that you can do input on an output object.
98 */
99 PyTypeObject *InputType, *OutputType;
100
101} * PycStringIO = NULL;
Guido van Rossum049cd901996-12-05 23:30:48 +0000102
103/* These can be used to test if you have one */
Guido van Rossumd81a1ba1997-01-06 22:50:12 +0000104#define PycStringIO_InputCheck(O) \
Guido van Rossum0a73dd51997-04-09 17:34:28 +0000105 ((O)->ob_type==PycStringIO->InputType)
Guido van Rossumd81a1ba1997-01-06 22:50:12 +0000106#define PycStringIO_OutputCheck(O) \
Guido van Rossum0a73dd51997-04-09 17:34:28 +0000107 ((O)->ob_type==PycStringIO->OutputType)
Guido van Rossum049cd901996-12-05 23:30:48 +0000108
Guido van Rossumf0f36001998-12-08 13:23:22 +0000109static void *
Thomas Wouters78890102000-07-22 19:25:51 +0000110xxxPyCObject_Import(char *module_name, char *name)
Guido van Rossum142eeb81997-08-13 03:14:41 +0000111{
112 PyObject *m, *c;
113 void *r=NULL;
114
115 if((m=PyImport_ImportModule(module_name)))
116 {
117 if((c=PyObject_GetAttrString(m,name)))
118 {
119 r=PyCObject_AsVoidPtr(c);
120 Py_DECREF(c);
121 }
122 Py_DECREF(m);
123 }
124
125 return r;
126}
127
Guido van Rossum049cd901996-12-05 23:30:48 +0000128#define PycString_IMPORT \
Guido van Rossum142eeb81997-08-13 03:14:41 +0000129 PycStringIO=xxxPyCObject_Import("cStringIO", "cStringIO_CAPI")
Guido van Rossum049cd901996-12-05 23:30:48 +0000130
131#endif /* CSTRINGIO_INCLUDED */