home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / pyth_os2.zip / python-1.0.2 / Include / stringobject.h < prev    next >
C/C++ Source or Header  |  1994-04-24  |  3KB  |  80 lines
  1. #ifndef Py_STRINGOBJECT_H
  2. #define Py_STRINGOBJECT_H
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6.  
  7. /***********************************************************
  8. Copyright 1991, 1992, 1993, 1994 by Stichting Mathematisch Centrum,
  9. Amsterdam, The Netherlands.
  10.  
  11.                         All Rights Reserved
  12.  
  13. Permission to use, copy, modify, and distribute this software and its 
  14. documentation for any purpose and without fee is hereby granted, 
  15. provided that the above copyright notice appear in all copies and that
  16. both that copyright notice and this permission notice appear in 
  17. supporting documentation, and that the names of Stichting Mathematisch
  18. Centrum or CWI not be used in advertising or publicity pertaining to
  19. distribution of the software without specific, written prior permission.
  20.  
  21. STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
  22. THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  23. FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
  24. FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  25. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  26. ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  27. OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  28.  
  29. ******************************************************************/
  30.  
  31. /* String object interface */
  32.  
  33. /*
  34. 123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
  35.  
  36. Type stringobject represents a character string.  An extra zero byte is
  37. reserved at the end to ensure it is zero-terminated, but a size is
  38. present so strings with null bytes in them can be represented.  This
  39. is an immutable object type.
  40.  
  41. There are functions to create new string objects, to test
  42. an object for string-ness, and to get the
  43. string value.  The latter function returns a null pointer
  44. if the object is not of the proper type.
  45. There is a variant that takes an explicit size as well as a
  46. variant that assumes a zero-terminated string.  Note that none of the
  47. functions should be applied to nil objects.
  48. */
  49.  
  50. /* NB The type is revealed here only because it is used in dictobject.c */
  51.  
  52. typedef struct {
  53.     OB_VARHEAD
  54. #ifdef CACHE_HASH
  55.     long ob_shash;
  56. #endif
  57.     char ob_sval[1];
  58. } stringobject;
  59.  
  60. extern typeobject Stringtype;
  61.  
  62. #define is_stringobject(op) ((op)->ob_type == &Stringtype)
  63.  
  64. extern object *newsizedstringobject PROTO((char *, int));
  65. extern object *newstringobject PROTO((char *));
  66. extern unsigned int getstringsize PROTO((object *));
  67. extern char *getstringvalue PROTO((object *));
  68. extern void joinstring PROTO((object **, object *));
  69. extern void joinstring_decref PROTO((object **, object *));
  70. extern int resizestring PROTO((object **, int));
  71. extern object *formatstring PROTO((object *, object *));
  72.  
  73. /* Macro, trading safety for speed */
  74. #define GETSTRINGVALUE(op) ((op)->ob_sval)
  75.  
  76. #ifdef __cplusplus
  77. }
  78. #endif
  79. #endif /* !Py_STRINGOBJECT_H */
  80.