[Python-checkins] CVS: python/dist/src/Doc/api api.tex,1.117,1.118

[M.-A. Lemburg]

Update of /cvsroot/python/python/dist/src/Doc/api
In directory usw-pr-cvs1:/tmp/cvs-serv1593/Doc/api

Modified Files:
	api.tex 
Log Message:
This patch originated from an idea by Martin v. Loewis who submitted a
patch for sharing single character Unicode objects. 

Martin's patch had to be reworked in a number of ways to take Unicode
resizing into consideration as well. Here's what the updated patch
implements:

* Single character Unicode strings in the Latin-1 range are shared
  (not only ASCII chars as in Martin's original patch).

* The ASCII and Latin-1 codecs make use of this optimization,
  providing a noticable speedup for single character strings. Most
  Unicode methods can use the optimization as well (by virtue
  of using PyUnicode_FromUnicode()).

* Some code cleanup was done (replacing memcpy with Py_UNICODE_COPY)

* The PyUnicode_Resize() can now also handle the case of resizing
  unicode_empty which previously resulted in an error.

* Modified the internal API _PyUnicode_Resize() and
  the public PyUnicode_Resize() API to handle references to
  shared objects correctly. The _PyUnicode_Resize() signature
  changed due to this.

* Callers of PyUnicode_FromUnicode() may now only modify the Unicode
  object contents of the returned object in case they called the API
  with NULL as content template.

Note that even though this patch passes the regression tests, there
may still be subtle bugs in the sharing code.



Index: api.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/api.tex,v
retrieving revision 1.117
retrieving revision 1.118
diff -C2 -r1.117 -r1.118
*** api.tex	2001/04/13 17:55:02	1.117
--- api.tex	2001/04/23 14:44:21	1.118
***************
*** 2458,2462 ****
  given size. \var{u} may be \NULL{} which causes the contents to be
  undefined. It is the user's responsibility to fill in the needed data.
! The buffer is copied into the new object.
  \end{cfuncdesc}
  
--- 2458,2464 ----
  given size. \var{u} may be \NULL{} which causes the contents to be
  undefined. It is the user's responsibility to fill in the needed data.
! The buffer is copied into the new object. If the buffer is not \NULL{},
! the return value might be a shared object. Therefore, modification of
! the resulting Unicode Object is only allowed when \var{u} is \NULL{}.
  \end{cfuncdesc}