home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume10 / genman.awk / strloc.man < prev   
Encoding:
Text File  |  1990-02-16  |  2.2 KB  |  82 lines
  1.  
  2. STRLOC.H(c++)                       BASE                        STRLOC.H(c++) 
  3.  
  4.                                                                  Feb 14, 1990
  5.  
  6. DESCRIPTION
  7.   The strloc class is a class for managing strings.
  8.   It uses reference counts on copy operations.
  9.  
  10. CLASS strloc
  11.  
  12.   Public members
  13.      strloc( const char *str= 0 );
  14.      strloc( strloc & );
  15.      ~strloc();
  16.      strloc & operator=( strloc & );
  17.      strloc & operator=( const char * );
  18.      void operator+=( const char * );
  19.      const char *ptr();
  20.      int len();
  21.      friend int operator==( const strloc &x, const char *s );
  22.      friend int operator==( const char *s, const strloc &x );
  23.      friend int operator==( const strloc &x, const strloc &y );
  24.      friend int operator!=( const strloc &x, const char *s );
  25.      friend int operator!=( const char *s, const strloc &x );
  26.      friend int operator!=( const strloc &x, const strloc &y );
  27.  
  28.   Private members
  29.      strloc_data *st_com;
  30.         Pointer to character string struct.
  31.  
  32.  
  33. DEFINED MACROS
  34.      UTIL_STRLOC_H
  35.  
  36. INCLUDED FILES
  37.      <strings.hxx>
  38.  
  39. STRUCTURES
  40.   strloc_data
  41.      {
  42.      char *std_ptr;         pointer to string
  43.      int   std_refcnt;      reference count
  44.      };
  45.  
  46. SOURCE FILES
  47.      strloc.cxx
  48.      strloc.h
  49.  
  50. SUMMARY
  51.   strloc::strloc( const char *newstr )
  52.      Normal constructor.
  53.      Passed a pointer to a character string it copies it
  54.      to new memory and sets the reference count to 1.
  55.  
  56.   strloc::strloc( strloc &orig )
  57.      Constructor called when strloc a= b.
  58.      "this" is "a" and "orig" is a pointer to "b".
  59.  
  60.   strloc::~strloc()
  61.      Destructor for the strloc class.
  62.      The refernce count is decrimented and when it goes to
  63.      zero the string is deleted.
  64.  
  65.   strloc & strloc::operator=( strloc &rvalue )
  66.      Implements copy function.
  67.      Frees up old string and copies a pointer to the new one.
  68.  
  69.   strloc & strloc::operator=( const char *newstr )
  70.      Implements set function: strloc a; a= "foo";
  71.      Frees up old string and copies a pointer to the new one.
  72.  
  73.   void strloc::operator+=( const char *string )
  74.      Appends the specified string onto the end of the current string.
  75.  
  76.   inline const char *strloc::ptr()
  77.      Returns the pointer to the string.
  78.  
  79.   inline int strloc::len()
  80.      Returns the length of the string.
  81.  
  82.