blob: a4b4ea654106eed0fac2cd6099badaa8f44317a4 [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_STRINGOBJECT_H
2#define Py_STRINGOBJECT_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumf70e43a1991-02-19 12:39:46 +00007/***********************************************************
Guido van Rossume5372401993-03-16 12:15:04 +00008Copyright 1991, 1992, 1993 by Stichting Mathematisch Centrum,
9Amsterdam, The Netherlands.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000010
11 All Rights Reserved
12
13Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
15provided that the above copyright notice appear in all copies and that
16both that copyright notice and this permission notice appear in
17supporting documentation, and that the names of Stichting Mathematisch
18Centrum or CWI not be used in advertising or publicity pertaining to
19distribution of the software without specific, written prior permission.
20
21STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
22THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
23FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
24FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
25WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
26ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
27OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
28
29******************************************************************/
30
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031/* String object interface */
32
33/*
34123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
35
36Type stringobject represents a character string. An extra zero byte is
37reserved at the end to ensure it is zero-terminated, but a size is
38present so strings with null bytes in them can be represented. This
39is an immutable object type.
40
41There are functions to create new string objects, to test
42an object for string-ness, and to get the
43string value. The latter function returns a null pointer
44if the object is not of the proper type.
45There is a variant that takes an explicit size as well as a
46variant that assumes a zero-terminated string. Note that none of the
47functions should be applied to nil objects.
48*/
49
50/* NB The type is revealed here only because it is used in dictobject.c */
51
52typedef struct {
53 OB_VARHEAD
54 char ob_sval[1];
55} stringobject;
56
57extern typeobject Stringtype;
58
59#define is_stringobject(op) ((op)->ob_type == &Stringtype)
60
61extern object *newsizedstringobject PROTO((char *, int));
62extern object *newstringobject PROTO((char *));
63extern unsigned int getstringsize PROTO((object *));
64extern char *getstringvalue PROTO((object *));
65extern void joinstring PROTO((object **, object *));
66extern int resizestring PROTO((object **, int));
Guido van Rossume5372401993-03-16 12:15:04 +000067extern object *formatstring PROTO((object *, object *));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000068
69/* Macro, trading safety for speed */
70#define GETSTRINGVALUE(op) ((op)->ob_sval)
Guido van Rossuma3309961993-07-28 09:05:47 +000071
72#ifdef __cplusplus
73}
74#endif
75#endif /* !Py_STRINGOBJECT_H */