mirror of
https://github.com/python/cpython.git
synced 2024-11-25 01:20:47 +01:00
80 lines
2.8 KiB
C
80 lines
2.8 KiB
C
#ifndef Py_STRINGOBJECT_H
|
|
#define Py_STRINGOBJECT_H
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/***********************************************************
|
|
Copyright 1991, 1992, 1993, 1994 by Stichting Mathematisch Centrum,
|
|
Amsterdam, The Netherlands.
|
|
|
|
All Rights Reserved
|
|
|
|
Permission to use, copy, modify, and distribute this software and its
|
|
documentation for any purpose and without fee is hereby granted,
|
|
provided that the above copyright notice appear in all copies and that
|
|
both that copyright notice and this permission notice appear in
|
|
supporting documentation, and that the names of Stichting Mathematisch
|
|
Centrum or CWI not be used in advertising or publicity pertaining to
|
|
distribution of the software without specific, written prior permission.
|
|
|
|
STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
|
|
THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
|
FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
|
|
FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
|
|
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
******************************************************************/
|
|
|
|
/* String object interface */
|
|
|
|
/*
|
|
123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
|
|
|
|
Type stringobject represents a character string. An extra zero byte is
|
|
reserved at the end to ensure it is zero-terminated, but a size is
|
|
present so strings with null bytes in them can be represented. This
|
|
is an immutable object type.
|
|
|
|
There are functions to create new string objects, to test
|
|
an object for string-ness, and to get the
|
|
string value. The latter function returns a null pointer
|
|
if the object is not of the proper type.
|
|
There is a variant that takes an explicit size as well as a
|
|
variant that assumes a zero-terminated string. Note that none of the
|
|
functions should be applied to nil objects.
|
|
*/
|
|
|
|
/* NB The type is revealed here only because it is used in dictobject.c */
|
|
|
|
typedef struct {
|
|
OB_VARHEAD
|
|
#ifdef CACHE_HASH
|
|
long ob_shash;
|
|
#endif
|
|
char ob_sval[1];
|
|
} stringobject;
|
|
|
|
extern DL_IMPORT typeobject Stringtype;
|
|
|
|
#define is_stringobject(op) ((op)->ob_type == &Stringtype)
|
|
|
|
extern object *newsizedstringobject PROTO((char *, int));
|
|
extern object *newstringobject PROTO((char *));
|
|
extern unsigned int getstringsize PROTO((object *));
|
|
extern char *getstringvalue PROTO((object *));
|
|
extern void joinstring PROTO((object **, object *));
|
|
extern void joinstring_decref PROTO((object **, object *));
|
|
extern int resizestring PROTO((object **, int));
|
|
extern object *formatstring PROTO((object *, object *));
|
|
|
|
/* Macro, trading safety for speed */
|
|
#define GETSTRINGVALUE(op) ((op)->ob_sval)
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* !Py_STRINGOBJECT_H */
|