From 2d23d5bf2efcea655b22e0ee4dd7cf6554a94c85 Mon Sep 17 00:00:00 2001 From: Fredrik Lundh Date: Sat, 27 May 2006 10:05:10 +0000 Subject: needforspeed: more stringlib refactoring --- Objects/stringlib/README.txt | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'Objects/stringlib/README.txt') diff --git a/Objects/stringlib/README.txt b/Objects/stringlib/README.txt index 051197c36f..82a877465a 100644 --- a/Objects/stringlib/README.txt +++ b/Objects/stringlib/README.txt @@ -3,3 +3,32 @@ possibly other modules, in a not too distant future). the stuff in here is included into relevant places; see the individual source files for details. + +-------------------------------------------------------------------- +the following defines used by the different modules: + +STRINGLIB_CHAR + + the type used to hold a character (char or Py_UNICODE) + +STRINGLIB_EMPTY + + a PyObject representing the empty string + +int STRINGLIB_CMP(STRINGLIB_CHAR*, STRINGLIB_CHAR*, Py_ssize_t) + + compares two strings. returns 0 if they match, and non-zero if not. + +Py_ssize_t STRINGLIB_LEN(PyObject*) + + returns the length of the given string object (which must be of the + right type) + +PyObject* STRINGLIB_NEW(STRINGLIB_CHAR*, Py_ssize_t) + + creates a new string object + +STRINGLIB_CHAR* STRINGLIB_STR(PyObject*) + + returns the pointer to the character data for the given string + object (which must be of the right type) -- cgit v1.2.1