home *** CD-ROM | disk | FTP | other *** search
/ PC World 2001 April / PCWorld_2001-04_cd.bin / Software / TemaCD / webclean / !!!python!!! / BeOpen-Python-2.0.exe / CODECS.H < prev    next >
Encoding:
C/C++ Source or Header  |  2000-08-03  |  3.4 KB  |  124 lines
  1. #ifndef Py_CODECREGISTRY_H
  2. #define Py_CODECREGISTRY_H
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6.  
  7. /* ------------------------------------------------------------------------
  8.  
  9.    Python Codec Registry and support functions
  10.  
  11.  
  12. Written by Marc-Andre Lemburg (mal@lemburg.com).
  13.  
  14. Copyright (c) Corporation for National Research Initiatives.
  15.  
  16.    ------------------------------------------------------------------------ */
  17.  
  18. /* Register a new codec search function.
  19.  
  20.    As side effect, this tries to load the encodings package, if not
  21.    yet done, to make sure that it is always first in the list of
  22.    search functions.
  23.  
  24.    The search_function's refcount is incremented by this function. */
  25.  
  26. extern DL_IMPORT(int) PyCodec_Register(
  27.        PyObject *search_function
  28.        );
  29.  
  30. /* Codec register lookup API.
  31.  
  32.    Looks up the given encoding and returns a tuple (encoder, decoder,
  33.    stream reader, stream writer) of functions which implement the
  34.    different aspects of processing the encoding.
  35.  
  36.    The encoding string is looked up converted to all lower-case
  37.    characters. This makes encodings looked up through this mechanism
  38.    effectively case-insensitive.
  39.  
  40.    If no codec is found, a KeyError is set and NULL returned. 
  41.  
  42.    As side effect, this tries to load the encodings package, if not
  43.    yet done. This is part of the lazy load strategy for the encodings
  44.    package.
  45.  
  46.  */
  47.  
  48. extern DL_IMPORT(PyObject *) _PyCodec_Lookup(
  49.        const char *encoding
  50.        );
  51.  
  52. /* Generic codec based encoding API.
  53.  
  54.    object is passed through the encoder function found for the given
  55.    encoding using the error handling method defined by errors. errors
  56.    may be NULL to use the default method defined for the codec.
  57.    
  58.    Raises a LookupError in case no encoder can be found.
  59.  
  60.  */
  61.  
  62. extern DL_IMPORT(PyObject *) PyCodec_Encode(
  63.        PyObject *object,
  64.        const char *encoding,
  65.        const char *errors
  66.        );
  67.  
  68. /* Generic codec based decoding API.
  69.  
  70.    object is passed through the decoder function found for the given
  71.    encoding using the error handling method defined by errors. errors
  72.    may be NULL to use the default method defined for the codec.
  73.    
  74.    Raises a LookupError in case no encoder can be found.
  75.  
  76.  */
  77.  
  78. extern DL_IMPORT(PyObject *) PyCodec_Decode(
  79.        PyObject *object,
  80.        const char *encoding,
  81.        const char *errors
  82.        );
  83.  
  84. /* --- Codec Lookup APIs -------------------------------------------------- 
  85.  
  86.    All APIs return a codec object with incremented refcount and are
  87.    based on _PyCodec_Lookup().  The same comments w/r to the encoding
  88.    name also apply to these APIs.
  89.  
  90. */
  91.  
  92. /* Get an encoder function for the given encoding. */
  93.  
  94. extern DL_IMPORT(PyObject *) PyCodec_Encoder(
  95.        const char *encoding
  96.        );
  97.  
  98. /* Get a decoder function for the given encoding. */
  99.  
  100. extern DL_IMPORT(PyObject *) PyCodec_Decoder(
  101.        const char *encoding
  102.        );
  103.  
  104. /* Get a StreamReader factory function for the given encoding. */
  105.  
  106. extern DL_IMPORT(PyObject *) PyCodec_StreamReader(
  107.        const char *encoding,
  108.        PyObject *stream,
  109.        const char *errors
  110.        );
  111.  
  112. /* Get a StreamWriter factory function for the given encoding. */
  113.  
  114. extern DL_IMPORT(PyObject *) PyCodec_StreamWriter(
  115.        const char *encoding,
  116.        PyObject *stream,
  117.        const char *errors
  118.        );
  119.  
  120. #ifdef __cplusplus
  121. }
  122. #endif
  123. #endif /* !Py_CODECREGISTRY_H */
  124.