Mercurial > cpython-lru_cache-weakref
annotate Include/stringobject.h @ 892:11ea669c231e legacy-trunk
Documented new contents of lib5.tex
| author | Guido van Rossum <guido@python.org> |
|---|---|
| date | Wed, 03 Jun 1992 17:56:44 +0000 |
| parents | 164849f56105 |
| children | c4cd0d9d8281 |
| rev | line source |
|---|---|
| 145 | 1 /*********************************************************** |
|
790
164849f56105
Copyright for 1992 added
Guido van Rossum <guido@python.org>
parents:
145
diff
changeset
|
2 Copyright 1991, 1992 by Stichting Mathematisch Centrum, Amsterdam, The |
| 145 | 3 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 | |
| 6 | 25 /* String object interface */ |
| 26 | |
| 27 /* | |
| 28 123456789-123456789-123456789-123456789-123456789-123456789-123456789-12 | |
| 29 | |
| 30 Type stringobject represents a character string. An extra zero byte is | |
| 31 reserved at the end to ensure it is zero-terminated, but a size is | |
| 32 present so strings with null bytes in them can be represented. This | |
| 33 is an immutable object type. | |
| 34 | |
| 35 There are functions to create new string objects, to test | |
| 36 an object for string-ness, and to get the | |
| 37 string value. The latter function returns a null pointer | |
| 38 if the object is not of the proper type. | |
| 39 There is a variant that takes an explicit size as well as a | |
| 40 variant that assumes a zero-terminated string. Note that none of the | |
| 41 functions should be applied to nil objects. | |
| 42 */ | |
| 43 | |
| 44 /* NB The type is revealed here only because it is used in dictobject.c */ | |
| 45 | |
| 46 typedef struct { | |
| 47 OB_VARHEAD | |
| 48 char ob_sval[1]; | |
| 49 } stringobject; | |
| 50 | |
| 51 extern typeobject Stringtype; | |
| 52 | |
| 53 #define is_stringobject(op) ((op)->ob_type == &Stringtype) | |
| 54 | |
| 55 extern object *newsizedstringobject PROTO((char *, int)); | |
| 56 extern object *newstringobject PROTO((char *)); | |
| 57 extern unsigned int getstringsize PROTO((object *)); | |
| 58 extern char *getstringvalue PROTO((object *)); | |
| 59 extern void joinstring PROTO((object **, object *)); | |
| 60 extern int resizestring PROTO((object **, int)); | |
| 61 | |
| 62 /* Macro, trading safety for speed */ | |
| 63 #define GETSTRINGVALUE(op) ((op)->ob_sval) |