home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 June / PCWorld_2005-06_cd.bin / software / vyzkuste / firewally / firewally.exe / framework-2.3.exe / stringobject.h < prev    next >
C/C++ Source or Header  |  2003-12-30  |  6KB  |  175 lines
  1.  
  2. /* String object interface */
  3.  
  4. #ifndef Py_STRINGOBJECT_H
  5. #define Py_STRINGOBJECT_H
  6. #ifdef __cplusplus
  7. extern "C" {
  8. #endif
  9.  
  10. #include <stdarg.h>
  11.  
  12. /*
  13. Type PyStringObject represents a character string.  An extra zero byte is
  14. reserved at the end to ensure it is zero-terminated, but a size is
  15. present so strings with null bytes in them can be represented.  This
  16. is an immutable object type.
  17.  
  18. There are functions to create new string objects, to test
  19. an object for string-ness, and to get the
  20. string value.  The latter function returns a null pointer
  21. if the object is not of the proper type.
  22. There is a variant that takes an explicit size as well as a
  23. variant that assumes a zero-terminated string.  Note that none of the
  24. functions should be applied to nil objects.
  25. */
  26.  
  27. /* Caching the hash (ob_shash) saves recalculation of a string's hash value.
  28.    Interning strings (ob_sstate) tries to ensure that only one string
  29.    object with a given value exists, so equality tests can be one pointer
  30.    comparison.  This is generally restricted to strings that "look like"
  31.    Python identifiers, although the intern() builtin can be used to force
  32.    interning of any string.
  33.    Together, these sped the interpreter by up to 20%. */
  34.  
  35. typedef struct {
  36.     PyObject_VAR_HEAD
  37.     long ob_shash;
  38.     int ob_sstate;
  39.     char ob_sval[1];
  40. } PyStringObject;
  41.  
  42. #define SSTATE_NOT_INTERNED 0
  43. #define SSTATE_INTERNED_MORTAL 1
  44. #define SSTATE_INTERNED_IMMORTAL 2
  45.  
  46. PyAPI_DATA(PyTypeObject) PyBaseString_Type;
  47. PyAPI_DATA(PyTypeObject) PyString_Type;
  48.  
  49. #define PyString_Check(op) PyObject_TypeCheck(op, &PyString_Type)
  50. #define PyString_CheckExact(op) ((op)->ob_type == &PyString_Type)
  51.  
  52. PyAPI_FUNC(PyObject *) PyString_FromStringAndSize(const char *, int);
  53. PyAPI_FUNC(PyObject *) PyString_FromString(const char *);
  54. PyAPI_FUNC(PyObject *) PyString_FromFormatV(const char*, va_list)
  55.                 Py_GCC_ATTRIBUTE((format(printf, 1, 0)));
  56. PyAPI_FUNC(PyObject *) PyString_FromFormat(const char*, ...)
  57.                 Py_GCC_ATTRIBUTE((format(printf, 1, 2)));
  58. PyAPI_FUNC(int) PyString_Size(PyObject *);
  59. PyAPI_FUNC(char *) PyString_AsString(PyObject *);
  60. PyAPI_FUNC(PyObject *) PyString_Repr(PyObject *, int);
  61. PyAPI_FUNC(void) PyString_Concat(PyObject **, PyObject *);
  62. PyAPI_FUNC(void) PyString_ConcatAndDel(PyObject **, PyObject *);
  63. PyAPI_FUNC(int) _PyString_Resize(PyObject **, int);
  64. PyAPI_FUNC(int) _PyString_Eq(PyObject *, PyObject*);
  65. PyAPI_FUNC(PyObject *) PyString_Format(PyObject *, PyObject *);
  66. PyAPI_FUNC(PyObject *) _PyString_FormatLong(PyObject*, int, int,
  67.                           int, char**, int*);
  68. PyAPI_FUNC(PyObject *) PyString_DecodeEscape(const char *, int, 
  69.                            const char *, int,
  70.                            const char *);
  71.  
  72. PyAPI_FUNC(void) PyString_InternInPlace(PyObject **);
  73. PyAPI_FUNC(void) PyString_InternImmortal(PyObject **);
  74. PyAPI_FUNC(PyObject *) PyString_InternFromString(const char *);
  75. PyAPI_FUNC(void) _Py_ReleaseInternedStrings(void);
  76.  
  77. /* Use only if you know it's a string */
  78. #define PyString_CHECK_INTERNED(op) (((PyStringObject *)(op))->ob_sstate)
  79.  
  80. /* Macro, trading safety for speed */
  81. #define PyString_AS_STRING(op) (((PyStringObject *)(op))->ob_sval)
  82. #define PyString_GET_SIZE(op)  (((PyStringObject *)(op))->ob_size)
  83.  
  84. /* _PyString_Join(sep, x) is like sep.join(x).  sep must be PyStringObject*,
  85.    x must be an iterable object. */
  86. PyAPI_FUNC(PyObject *) _PyString_Join(PyObject *sep, PyObject *x);
  87.  
  88. /* --- Generic Codecs ----------------------------------------------------- */
  89.  
  90. /* Create an object by decoding the encoded string s of the
  91.    given size. */
  92.  
  93. PyAPI_FUNC(PyObject*) PyString_Decode(
  94.     const char *s,              /* encoded string */
  95.     int size,                   /* size of buffer */
  96.     const char *encoding,       /* encoding */
  97.     const char *errors          /* error handling */
  98.     );
  99.  
  100. /* Encodes a char buffer of the given size and returns a 
  101.    Python object. */
  102.  
  103. PyAPI_FUNC(PyObject*) PyString_Encode(
  104.     const char *s,              /* string char buffer */
  105.     int size,                   /* number of chars to encode */
  106.     const char *encoding,       /* encoding */
  107.     const char *errors          /* error handling */
  108.     );
  109.  
  110. /* Encodes a string object and returns the result as Python 
  111.    object. */
  112.  
  113. PyAPI_FUNC(PyObject*) PyString_AsEncodedObject(
  114.     PyObject *str,         /* string object */
  115.     const char *encoding,    /* encoding */
  116.     const char *errors        /* error handling */
  117.     );
  118.  
  119. /* Encodes a string object and returns the result as Python string
  120.    object.   
  121.    
  122.    If the codec returns an Unicode object, the object is converted
  123.    back to a string using the default encoding.
  124.  
  125.    DEPRECATED - use PyString_AsEncodedObject() instead. */
  126.  
  127. PyAPI_FUNC(PyObject*) PyString_AsEncodedString(
  128.     PyObject *str,         /* string object */
  129.     const char *encoding,    /* encoding */
  130.     const char *errors        /* error handling */
  131.     );
  132.  
  133. /* Decodes a string object and returns the result as Python 
  134.    object. */
  135.  
  136. PyAPI_FUNC(PyObject*) PyString_AsDecodedObject(
  137.     PyObject *str,         /* string object */
  138.     const char *encoding,    /* encoding */
  139.     const char *errors        /* error handling */
  140.     );
  141.  
  142. /* Decodes a string object and returns the result as Python string
  143.    object.  
  144.    
  145.    If the codec returns an Unicode object, the object is converted
  146.    back to a string using the default encoding.
  147.  
  148.    DEPRECATED - use PyString_AsDecodedObject() instead. */
  149.  
  150. PyAPI_FUNC(PyObject*) PyString_AsDecodedString(
  151.     PyObject *str,         /* string object */
  152.     const char *encoding,    /* encoding */
  153.     const char *errors        /* error handling */
  154.     );
  155.  
  156. /* Provides access to the internal data buffer and size of a string
  157.    object or the default encoded version of an Unicode object. Passing
  158.    NULL as *len parameter will force the string buffer to be
  159.    0-terminated (passing a string with embedded NULL characters will
  160.    cause an exception).  */
  161.  
  162. PyAPI_FUNC(int) PyString_AsStringAndSize(
  163.     register PyObject *obj,    /* string or Unicode object */
  164.     register char **s,        /* pointer to buffer variable */
  165.     register int *len        /* pointer to length variable or NULL
  166.                    (only possible for 0-terminated
  167.                    strings) */
  168.     );
  169.     
  170.  
  171. #ifdef __cplusplus
  172. }
  173. #endif
  174. #endif /* !Py_STRINGOBJECT_H */
  175.