cpython/Objects/stringlib
Victor Stinner ad73674283
gh-107603: Argument Clinic: Only include pycore_gc.h if needed (#108726)
Argument Clinic now only includes pycore_gc.h if PyGC_Head is needed,
and only includes pycore_runtime.h if _Py_ID() is needed.

* Add 'condition' optional argument to Clinic.add_include().
* deprecate_keyword_use() includes pycore_runtime.h when using
  the _PyID() function.
* Fix rendering of includes: comments start at the column 35.
* Mark PC/clinic/_wmimodule.cpp.h and
  "Objects/stringlib/clinic/*.h.h" header files as generated in
  .gitattributes.

Effects:

* 42 header files generated by AC no longer include the internal C
  API, instead of 4 header files before. For example,
  Modules/clinic/_abc.c.h no longer includes the internal C API.
* Fix _testclinic_depr.c.h: it now always includes pycore_runtime.h
  to get _Py_ID().
2023-08-31 23:42:34 +02:00
..
clinic gh-107603: Argument Clinic: Only include pycore_gc.h if needed (#108726) 2023-08-31 23:42:34 +02:00
README.txt gh-105156: Cleanup usage of old Py_UNICODE type (#105158) 2023-06-01 07:18:09 +00:00
asciilib.h gh-93033: Use wmemchr in stringlib (GH-93034) 2022-05-24 10:45:31 +09:00
codecs.h gh-92536: Remove PyUnicode_READY() calls (#105210) 2023-06-02 01:33:17 +02:00
count.h gh-97982: Remove asciilib_count() (#98164) 2022-10-11 17:59:58 +02:00
ctype.h
eq.h gh-89653: PEP 670: Convert PyUnicode_KIND() macro to function (#92705) 2022-05-13 11:49:56 +02:00
fastsearch.h gh-94808: improve comments and coverage of fastsearch.h (GH-96760) 2022-09-13 14:25:10 -04:00
find.h
find_max_char.h bpo-43179: Generalise alignment for optimised string routines (GH-24624) 2021-03-31 12:12:39 +02:00
join.h gh-99300: Use Py_NewRef() in Objects/ directory (#99354) 2022-11-10 23:58:07 +01:00
localeutil.h gh-89653: Use int type for Unicode kind (#92704) 2022-05-13 12:41:05 +02:00
partition.h bpo-40521: Make empty Unicode string per interpreter (GH-21096) 2020-06-24 00:10:40 +02:00
replace.h gh-93033: Use wmemchr in stringlib (GH-93034) 2022-05-24 10:45:31 +09:00
split.h bpo-46670: Define all macros for stringlib (GH-31176) 2022-02-07 01:26:58 +01:00
stringdefs.h gh-93033: Use wmemchr in stringlib (GH-93034) 2022-05-24 10:45:31 +09:00
stringlib_find_two_way_notes.txt gh-94808: improve comments and coverage of fastsearch.h (GH-96760) 2022-09-13 14:25:10 -04:00
transmogrify.h gh-99300: Use Py_NewRef() in Objects/ directory (#99354) 2022-11-10 23:58:07 +01:00
ucs1lib.h gh-93033: Use wmemchr in stringlib (GH-93034) 2022-05-24 10:45:31 +09:00
ucs2lib.h gh-93033: Use wmemchr in stringlib (GH-93034) 2022-05-24 10:45:31 +09:00
ucs4lib.h gh-93033: Use wmemchr in stringlib (GH-93034) 2022-05-24 10:45:31 +09:00
undef.h gh-93033: Use wmemchr in stringlib (GH-93034) 2022-05-24 10:45:31 +09:00
unicode_format.h gh-106320: Add pycore_complexobject.h header file (#106339) 2023-07-02 21:19:59 +00:00

README.txt

bits shared by the bytesobject and unicodeobject implementations (and
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, Py_UCS1, Py_UCS2 or Py_UCS4)

STRINGLIB_GET_EMPTY()

    returns a PyObject representing the empty string, only to be used if
    STRINGLIB_MUTABLE is 0. It must not be NULL.

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)

int STRINGLIB_CHECK_EXACT(PyObject *)

    returns true if the object is an instance of our type, not a subclass

STRINGLIB_MUTABLE

    must be 0 or 1 to tell the cpp macros in stringlib code if the object
    being operated on is mutable or not