source: trunk/essentials/dev-lang/python/Doc/api/refcounts.dat@ 3226

# Created by Skip Montanaro <[email protected]>.

# Format:
#       function ':' type ':' [param name] ':' [refcount effect] ':' [comment]
# If the param name slot is empty, that line corresponds to the function's
# return value, otherwise it's the type of the named parameter.

# The first line of a function block gives type/refcount information for the
# function's return value.  Successive lines with the same function name
# correspond to the function's parameter list and appear in the order the
# parameters appear in the function's prototype.

# For readability, each function's lines are surrounded by a blank line.
# The blocks are sorted alphabetically by function name.

# Refcount behavior is given for all PyObject* types: 0 (no change), +1
# (increment) and -1 (decrement).  A blank refcount field indicates the
# parameter or function value is not a PyObject* and is therefore not
# subject to reference counting.  A special case for the value "null"
# (without quotes) is used for functions which return a PyObject* type but
# always return NULL.  This is used by some of the PyErr_*() functions, in
# particular.

# XXX NOTE: the 0/+1/-1 refcount information for arguments is
# confusing!  Much more useful would be to indicate whether the
# function "steals" a reference to the argument or not.  Take for
# example PyList_SetItem(list, i, item).  This lists as a 0 change for
# both the list and the item arguments.  However, in fact it steals a
# reference to the item argument!

# The parameter names are as they appear in the API manual, not the source
# code. 

PyBool_FromLong:PyObject*::+1:
PyBool_FromLong:long:v:0:

PyBuffer_FromObject:PyObject*::+1:
PyBuffer_FromObject:PyObject*:base:+1:
PyBuffer_FromObject:int:offset::
PyBuffer_FromObject:int:size::

PyBuffer_FromReadWriteObject:PyObject*::+1:
PyBuffer_FromReadWriteObject:PyObject*:base:+1:
PyBuffer_FromReadWriteObject:int:offset::
PyBuffer_FromReadWriteObject:int:size::

PyBuffer_FromMemory:PyObject*::+1:
PyBuffer_FromMemory:void*:ptr::
PyBuffer_FromMemory:int:size::

PyBuffer_FromReadWriteMemory:PyObject*::+1:
PyBuffer_FromReadWriteMemory:void*:ptr::
PyBuffer_FromReadWriteMemory:int:size::

PyBuffer_New:PyObject*::+1:
PyBuffer_New:int:size::

PyCObject_AsVoidPtr:void*:::
PyCObject_AsVoidPtr:PyObject*:self:0:

PyCObject_FromVoidPtr:PyObject*::+1:
PyCObject_FromVoidPtr:void*:cobj::
PyCObject_FromVoidPtr::void (* destr)(void* )::

PyCObject_FromVoidPtrAndDesc:PyObject*::+1:
PyCObject_FromVoidPtrAndDesc:void*:cobj::
PyCObject_FromVoidPtrAndDesc:void*:desc::
PyCObject_FromVoidPtrAndDesc:void(*)(void*,void*):destr::

PyCObject_GetDesc:void*:::
PyCObject_GetDesc:PyObject*:self:0:

PyCell_New:PyObject*::+1:
PyCell_New:PyObject*:ob:0:

PyCell_GET:PyObject*::0:
PyCell_GET:PyObject*:ob:0:

PyCell_Get:PyObject*::+1:
PyCell_Get:PyObject*:cell:0:

PyCell_SET:void:::
PyCell_SET:PyObject*:cell:0:
PyCell_SET:PyObject*:value:0:

PyCell_Set:int:::
PyCell_Set:PyObject*:cell:0:
PyCell_Set:PyObject*:value:0:

PyCallIter_New:PyObject*::+1:
PyCallIter_New:PyObject*:callable::
PyCallIter_New:PyObject*:sentinel::

PyCallable_Check:int:::
PyCallable_Check:PyObject*:o:0:

PyComplex_AsCComplex:Py_complex:::
PyComplex_AsCComplex:PyObject*:op:0:

PyComplex_Check:int:::
PyComplex_Check:PyObject*:p:0:

PyComplex_FromCComplex:PyObject*::+1:
PyComplex_FromCComplex::Py_complex v::

PyComplex_FromDoubles:PyObject*::+1:
PyComplex_FromDoubles::double real::
PyComplex_FromDoubles::double imag::

PyComplex_ImagAsDouble:double:::
PyComplex_ImagAsDouble:PyObject*:op:0:

PyComplex_RealAsDouble:double:::
PyComplex_RealAsDouble:PyObject*:op:0:

PyDate_FromDate:PyObject*::+1:
PyDate_FromDate:int:year::
PyDate_FromDate:int:month::
PyDate_FromDate:int:day::

PyDate_FromTimestamp:PyObject*::+1:
PyDate_FromTimestamp:PyObject*:args:0:

PyDateTime_FromDateAndTime:PyObject*::+1:
PyDateTime_FromDateAndTime:int:year::
PyDateTime_FromDateAndTime:int:month::
PyDateTime_FromDateAndTime:int:day::
PyDateTime_FromDateAndTime:int:hour::
PyDateTime_FromDateAndTime:int:minute::
PyDateTime_FromDateAndTime:int:second::
PyDateTime_FromDateAndTime:int:usecond::

PyDateTime_FromTimestamp:PyObject*::+1:
PyDateTime_FromTimestamp:PyObject*:args:0:

PyDelta_FromDSU:PyObject*::+1:
PyDelta_FromDSU:int:days::
PyDelta_FromDSU:int:seconds::
PyDelta_FromDSU:int:useconds::

PyDescr_NewClassMethod:PyObject*::+1:
PyDescr_NewClassMethod:PyTypeObject*:type::
PyDescr_NewClassMethod:PyMethodDef*:method::

PyDescr_NewGetSet:PyObject*::+1:
PyDescr_NewGetSet:PyTypeObject*:type::
PyDescr_NewGetSet:PyGetSetDef*:getset::

PyDescr_NewMember:PyObject*::+1:
PyDescr_NewMember:PyTypeObject*:type::
PyDescr_NewMember:PyMemberDef*:member::

PyDescr_NewMethod:PyObject*::+1:
PyDescr_NewMethod:PyTypeObject*:type::
PyDescr_NewMethod:PyMethodDef*:meth::

PyDescr_NewWrapper:PyObject*::+1:
PyDescr_NewWrapper:PyTypeObject*:type::
PyDescr_NewWrapper:struct wrapperbase*:base::
PyDescr_NewWrapper:void*:wrapped::

PyDict_Check:int:::
PyDict_Check:PyObject*:p:0:

PyDict_Clear:void:::
PyDict_Clear:PyObject*:p:0:

PyDict_DelItem:int:::
PyDict_DelItem:PyObject*:p:0:
PyDict_DelItem:PyObject*:key:0:

PyDict_DelItemString:int:::
PyDict_DelItemString:PyObject*:p:0:
PyDict_DelItemString:char*:key::

PyDict_GetItem:PyObject*::0:0
PyDict_GetItem:PyObject*:p:0:
PyDict_GetItem:PyObject*:key:0:

PyDict_GetItemString:PyObject*::0:
PyDict_GetItemString:PyObject*:p:0:
PyDict_GetItemString:char*:key::

PyDict_Items:PyObject*::+1:
PyDict_Items:PyObject*:p:0:

PyDict_Keys:PyObject*::+1:
PyDict_Keys:PyObject*:p:0:

PyDict_New:PyObject*::+1:

PyDict_Copy:PyObject*::+1:
PyDict_Copy:PyObject*:p:0:

PyDict_Next:int:::
PyDict_Next:PyObject*:p:0:
PyDict_Next:int:ppos::
PyDict_Next:PyObject**:pkey:0:
PyDict_Next:PyObject**:pvalue:0:

PyDict_SetItem:int:::
PyDict_SetItem:PyObject*:p:0:
PyDict_SetItem:PyObject*:key:+1:
PyDict_SetItem:PyObject*:val:+1:

PyDict_SetItemString:int:::
PyDict_SetItemString:PyObject*:p:0:
PyDict_SetItemString:char*:key::
PyDict_SetItemString:PyObject*:val:+1:

PyDict_Size:int:::
PyDict_Size:PyObject*:p::

PyDict_Values:PyObject*::+1:
PyDict_Values:PyObject*:p:0:

PyDictProxy_New:PyObject*::+1:
PyDictProxy_New:PyObject*:dict:0:

PyErr_BadArgument:int:::

PyErr_BadInternalCall:void:::

PyErr_CheckSignals:int:::

PyErr_Clear:void:::

PyErr_ExceptionMatches:int:::
PyErr_ExceptionMatches:PyObject*:exc:0:

PyErr_Fetch:void:::
PyErr_Fetch:PyObject**:ptype:0:
PyErr_Fetch:PyObject**:pvalue:0:
PyErr_Fetch:PyObject**:ptraceback:0:

PyErr_GivenExceptionMatches:int:::
PyErr_GivenExceptionMatches:PyObject*:given:0:
PyErr_GivenExceptionMatches:PyObject*:exc:0:

PyErr_NewException:PyObject*::+1:
PyErr_NewException:char*:name::
PyErr_NewException:PyObject*:base:0:
PyErr_NewException:PyObject*:dict:0:

PyErr_NoMemory:PyObject*::null:

PyErr_NormalizeException:void:::
PyErr_NormalizeException:PyObject**:exc::???
PyErr_NormalizeException:PyObject**:val::???
PyErr_NormalizeException:PyObject**:tb::???

PyErr_Occurred:PyObject*::0:

PyErr_Print:void:::

PyErr_Restore:void:::
PyErr_Restore:PyObject*:type:-1:
PyErr_Restore:PyObject*:value:-1:
PyErr_Restore:PyObject*:traceback:-1:

PyErr_SetExcFromWindowsErr:PyObject*::null:
PyErr_SetExcFromWindowsErr:PyObject*:type:0:
PyErr_SetExcFromWindowsErr:int:ierr::

PyErr_SetExcFromWindowsErrWithFilename:PyObject*::null:
PyErr_SetExcFromWindowsErrWithFilename:PyObject*:type:0:
PyErr_SetExcFromWindowsErrWithFilename:int:ierr::
PyErr_SetExcFromWindowsErrWithFilename:char*:filename::

PyErr_SetFromErrno:PyObject*::null:
PyErr_SetFromErrno:PyObject*:type:0:

PyErr_SetFromErrnoWithFilename:PyObject*::null:
PyErr_SetFromErrnoWithFilename:PyObject*:type:0:
PyErr_SetFromErrnoWithFilename:char*:filename::

PyErr_SetFromWindowsErr:PyObject*::null:
PyErr_SetFromWindowsErr:int:ierr::

PyErr_SetFromWindowsErrWithFilename:PyObject*::null:
PyErr_SetFromWindowsErrWithFilename:int:ierr::
PyErr_SetFromWindowsErrWithFilename:char*:filename::

PyErr_SetInterrupt:void:::

PyErr_SetNone:void:::
PyErr_SetNone:PyObject*:type:+1:

PyErr_SetObject:void:::
PyErr_SetObject:PyObject*:type:+1:
PyErr_SetObject:PyObject*:value:+1:

PyErr_SetString:void:::
PyErr_SetString:PyObject*:type:+1:
PyErr_SetString:char*:message::

PyErr_Format:PyObject*::null:
PyErr_Format:PyObject*:exception:+1:
PyErr_Format:char*:format::
PyErr_Format::...::

PyErr_Warn:int:::
PyErr_Warn:PyObject*:category:0:
PyErr_Warn:char*:message::

PyErr_WarnEx:int:::
PyErr_WarnEx:PyObject*:category:0:
PyErr_WarnEx:const char*:message::
PyErr_WarnEx:Py_ssize_t:stack_level::

PyEval_AcquireLock:void:::

PyEval_AcquireThread:void:::
PyEval_AcquireThread:PyThreadState*:tstate::

PyEval_InitThreads:void:::

PyEval_ReleaseLock:void:::

PyEval_ReleaseThread:void:::
PyEval_ReleaseThread:PyThreadState*:tstate::

PyEval_RestoreThread:void:::
PyEval_RestoreThread:PyThreadState*:tstate::

PyEval_SaveThread:PyThreadState*:::

PyEval_EvalCode:PyObject*::+1:
PyEval_EvalCode:PyCodeObject*:co:0:
PyEval_EvalCode:PyObject*:globals:0:
PyEval_EvalCode:PyObject*:locals:0:

PyFile_AsFile:FILE*:::
PyFile_AsFile:PyFileObject*:p:0:

PyFile_Check:int:::
PyFile_Check:PyObject*:p:0:

PyFile_FromFile:PyObject*::+1:
PyFile_FromFile:FILE*:fp::
PyFile_FromFile:char*:name::
PyFile_FromFile:char*:mode::
PyFile_FromFile:int(*:close)::

PyFile_FromString:PyObject*::+1:
PyFile_FromString:char*:name::
PyFile_FromString:char*:mode::

PyFile_GetLine:PyObject*::+1:
PyFile_GetLine:PyObject*:p::
PyFile_GetLine:int:n::

PyFile_Name:PyObject*::0:
PyFile_Name:PyObject*:p:0: