Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 1 | #ifndef CSTRINGIO_INCLUDED |
| 2 | #define CSTRINGIO_INCLUDED |
| 3 | /* |
| 4 | |
Guido van Rossum | cd8732a | 1997-12-08 15:16:08 +0000 | [diff] [blame] | 5 | cStringIO.h,v 1.4 1997/12/07 14:27:00 jim Exp |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 6 | |
| 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 Rossum | 7999bfb | 1999-01-25 21:36:13 +0000 | [diff] [blame] | 68 | PycString_IMPORT |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 69 | |
| 70 | This would typically be done in your init function. |
| 71 | |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 72 | */ |
| 73 | |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 74 | /* Basic functions to manipulate cStringIO objects from C */ |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 75 | |
Guido van Rossum | 0a73dd5 | 1997-04-09 17:34:28 +0000 | [diff] [blame] | 76 | static struct PycStringIO_CAPI { |
| 77 | |
| 78 | /* Read a string. If the last argument is -1, the remainder will be read. */ |
Tim Peters | dbd9ba6 | 2000-07-09 03:09:57 +0000 | [diff] [blame] | 79 | int(*cread)(PyObject *, char **, int); |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 80 | |
Guido van Rossum | 0a73dd5 | 1997-04-09 17:34:28 +0000 | [diff] [blame] | 81 | /* Read a line */ |
Tim Peters | dbd9ba6 | 2000-07-09 03:09:57 +0000 | [diff] [blame] | 82 | int(*creadline)(PyObject *, char **); |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 83 | |
Guido van Rossum | 0a73dd5 | 1997-04-09 17:34:28 +0000 | [diff] [blame] | 84 | /* Write a string */ |
Tim Peters | dbd9ba6 | 2000-07-09 03:09:57 +0000 | [diff] [blame] | 85 | int(*cwrite)(PyObject *, char *, int); |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 86 | |
Guido van Rossum | 0a73dd5 | 1997-04-09 17:34:28 +0000 | [diff] [blame] | 87 | /* Get the cStringIO object as a Python string */ |
Tim Peters | dbd9ba6 | 2000-07-09 03:09:57 +0000 | [diff] [blame] | 88 | PyObject *(*cgetvalue)(PyObject *); |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 89 | |
Guido van Rossum | 0a73dd5 | 1997-04-09 17:34:28 +0000 | [diff] [blame] | 90 | /* Create a new output object */ |
Tim Peters | dbd9ba6 | 2000-07-09 03:09:57 +0000 | [diff] [blame] | 91 | PyObject *(*NewOutput)(int); |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 92 | |
Guido van Rossum | 0a73dd5 | 1997-04-09 17:34:28 +0000 | [diff] [blame] | 93 | /* Create an input object from a Python string */ |
Tim Peters | dbd9ba6 | 2000-07-09 03:09:57 +0000 | [diff] [blame] | 94 | PyObject *(*NewInput)(PyObject *); |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 95 | |
Guido van Rossum | 0a73dd5 | 1997-04-09 17:34:28 +0000 | [diff] [blame] | 96 | /* 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 Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 102 | |
| 103 | /* These can be used to test if you have one */ |
Guido van Rossum | d81a1ba | 1997-01-06 22:50:12 +0000 | [diff] [blame] | 104 | #define PycStringIO_InputCheck(O) \ |
Guido van Rossum | 0a73dd5 | 1997-04-09 17:34:28 +0000 | [diff] [blame] | 105 | ((O)->ob_type==PycStringIO->InputType) |
Guido van Rossum | d81a1ba | 1997-01-06 22:50:12 +0000 | [diff] [blame] | 106 | #define PycStringIO_OutputCheck(O) \ |
Guido van Rossum | 0a73dd5 | 1997-04-09 17:34:28 +0000 | [diff] [blame] | 107 | ((O)->ob_type==PycStringIO->OutputType) |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 108 | |
Guido van Rossum | f0f3600 | 1998-12-08 13:23:22 +0000 | [diff] [blame] | 109 | static void * |
Thomas Wouters | 7889010 | 2000-07-22 19:25:51 +0000 | [diff] [blame] | 110 | xxxPyCObject_Import(char *module_name, char *name) |
Guido van Rossum | 142eeb8 | 1997-08-13 03:14:41 +0000 | [diff] [blame] | 111 | { |
| 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 Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 128 | #define PycString_IMPORT \ |
Guido van Rossum | 142eeb8 | 1997-08-13 03:14:41 +0000 | [diff] [blame] | 129 | PycStringIO=xxxPyCObject_Import("cStringIO", "cStringIO_CAPI") |
Guido van Rossum | 049cd90 | 1996-12-05 23:30:48 +0000 | [diff] [blame] | 130 | |
| 131 | #endif /* CSTRINGIO_INCLUDED */ |