home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD2.mdf / c / library / dos / strings / c_string / readme.txt < prev    next >
Encoding:
Text File  |  1986-04-09  |  8.3 KB  |  144 lines
  1.    While this package is for UNIX based C compilers, the source code
  2.    is portable to just about any C compiler with little or no changes.
  3.    The string functions are found in few C compilers and come in
  4.    handy!  The makefile.txt contains the make instructions to build
  5.    a UNIX .a library.  You can use most of the fuctions "stand-alone"
  6.    with only the .h files needed for compiles.    A lot of work went into
  7.    this work by Richard.  Compile and enjoy!
  8.  
  9. >> Also included in this package is cpmstrin.c string library for C.
  10.    This package will also run on just about any C compiler.
  11.  
  12. /*f File   : README
  13.     Author : Richard A. O'Keefe.
  14.     Updated: 1 June 1984.
  15.     Purpose: Explain the new strings package.
  16.  
  17.     The UNIX string libraries (described in the string(3) manual page)
  18. differ from UNIX to UNIX (e.g. strtok is not in V7 or 4.1bsd).    Worse,
  19. the sources are not in the public domain, so that if there is a string
  20. routine which is nearly what you want but not quite you can't  take  a
  21. copy  and  modify it.  And of course C programmers on non-UNIX systems
  22. are at the mercy of their supplier.
  23.  
  24.     This package was designed to let me do reasonable things with  C's
  25. strings  whatever UNIX (V7, PaNiX, UX63, 4.1bsd) I happen to be using.
  26. Everything in the System III manual is here and does just what the  S3
  27. manual  says  it does.  There are also lots of new goodies.  I'm sorry
  28. about the names, but the routines do have to work  on  asphyxiated-at-
  29. birth  systems    which  truncate identifiers.  The convention is that a
  30. routine is called
  31.     str [n] [c] <operation>
  32. If there is an "n", it means that the function takes an (int) "length"
  33. argument, which bounds the number of characters to be moved or    looked
  34. at.  If the function has a "set" argument, a "c" in the name indicates
  35. that  the complement of the set is used.  Functions or variables whose
  36. names start with _ are support routines which aren't really meant  for
  37. general  use.  I don't know what the "p" is doing in "strpbrk", but it
  38. is there in the S3 manual so it's here too.  "istrtok" does not follow
  39. this rule, but with 7 letters what can you do?
  40.  
  41.     I have included new versions of atoi(3) and atol(3) as well.  They
  42. use a new primitive str2int, which takes a pair of bounds and a radix,
  43. and does much more thorough checking than the normal atoi and atol do.
  44. The result returned by atoi & atol is valid if and only if errno == 0.
  45. There is also an output conversion routine int2str, with itoa and ltoa
  46. as interface macros.  Only after writing int2str did I notice that the
  47. str2int routine has no provision for unsigned numbers.    On reflection,
  48. I don't greatly care.   I'm afraid that int2str may depend on your "C"
  49. compiler in unexpected ways.  Do check the code with -S.
  50.  
  51.     Several of these routines have "asm" inclusions conditional on the
  52. VaxAsm option.    These insertions can make the routines which have them
  53. quite a bit faster, but there is a snag.  The VAX architects, for some
  54. reason best known to themselves and their therapists, decided that all
  55. "strings" were shorter than 2^16 bytes.  Even when the length operands
  56. are in 32-bit registers, only 16 bits count.  So the "asm" versions do
  57. not work for long strings.  If you can guarantee that all your strings
  58. will be short, define VaxAsm in the makefile, but in general, and when
  59. using other machines, do not define it.
  60.  
  61.     Thanks to someone on the net who saw the first posting of strings,
  62. and sent me a formatted copy of the System V memory(3C) manual page, I
  63. have been able to include versions of these routines.    The convention
  64. is that they are called
  65.     mem{operation}([dst,] ... , len)
  66. where operation is cpy, cmp, chr, and so on, and len is how many bytes
  67. to move or test.  Note that this is different from the strn functions,
  68.     str{operation}    -- stop when you find a NUL character
  69.     strn{operation} -- stop when len is exhausted or you find NUL
  70.     mem{operation}    -- stop when len is exhausted
  71.     b{operation}    -- stop when len is exhausted
  72. but the b family has different argument orders or different results or
  73. both.  In particular, note that my implementation of bcmp does conform
  74. to the letter of the 4.2bsd manual page, but I decided to make it give
  75. a value I have often wanted, which is not like the value of strcmp. As
  76. the System V manual page is more explicit about the return code memcmp
  77. DOES return a value like strcmp, so you may prefer to use it.  BEWARE:
  78. the "c" in the name mem-c-cpy doesn't mean what it does in the System3
  79. names, it's more like mem-chr-cpy.
  80.  
  81.     To use this library, you need the "strings.a" library file and the
  82. "strings.h" header file.  The other header files are for compiling the
  83. library itself, though if you are hacking extensions you may find them
  84. useful.  General users really shouldn't see them.  I've defined a  few
  85. macros    I find useful in "strings.h"; if you have no need for "index",
  86. "rindex", "streql", and "beql", just edit them    out.   On  the    4.1bsd
  87. system  I  am using, having all these functions 'extern' does not mean
  88. that they will all be loaded; only the ones you call are.  When  using
  89. lesser    systems you may find it necessary to break strings.h up or you
  90. could get by with just adding "extern" declarations for  functions  as
  91. you  need  them.   Note  that  as  many  of these functions have names
  92. matching "standard C library" names (by design, this is  after    all  a
  93. replacement/reimplementation  of part of that library) you may have to
  94. talk the loader into loading this library first.  Again, I've found no
  95. problems on 4.1bsd.
  96.  
  97.     A note on character comparison.  The various UNIX manuals come out
  98. and say explicitly that the *cmp and *chr routines use the computer's
  99. "native" character comparison.    That is, on a PDP-11, VAX-11, and some
  100. other machines, signed character comparison is used, and the byte 0377
  101. will never be located (use -1).   On IBM 370s and many other machines,
  102. unsigned character comparison is used, and the byte -1 can't be found.
  103. (Use 0377.)  If you have occasion to use 8-bit byte values in calls to
  104. *chr functions, it would be nice if the package looked after making it
  105. work portably.    I thought about that, and decided not to do it, as you
  106. might *want* to write VAX code that didn't find 128, and might rely on
  107. the current effect. However, you should be able to use 8-bit values in
  108. a portable fashion if you ask, and that the package DOES do for you.
  109. There is a macro
  110.     int2char(c)
  111. which takes the bottom 8 bits of c on a machine with unsigned character
  112. comparison or sign-extends them on a machine with signed comparison. It
  113. is up to you to use this macro in appropriate places.  It is up to who-
  114. ever installs the package to make sure that the right definition is put
  115. in and the wrong one commented out.
  116.  
  117.     You may wonder at my failure to provide manual pages for this  code.
  118. For  the things in V7, 4.?, or SIII, you should be able to use whichever
  119. manual page came with that system, and anything I might write  would  be
  120. so  like it as to raise suspicions of violating AT&T copyrights.  In the
  121. sources you will find comments which provide far more documentation  for
  122. these  routines  than AT&T ever provided for their strings stuff, I just
  123. don't happen to have put it in nroff -man form.   Had I done so, the *.3
  124. files would have outbulked the .c files!
  125.  
  126.     There is a manual page for the strx family of routines.   It was the
  127. work of Tony Hansen, of AT&T Information Systems Lincroft NJ.  It is not
  128. clear whether I should distribute this manual page or not,  but as these
  129. functions are not likely to documented anywhere else I decided to risk
  130. it.  There is no risk in the *code* however.  His posting to net.sources
  131. arrived at Edinburgh with just the reason for reposting, and the manual
  132. page.  The code is my own work based on his manual page.  Indeed, I had
  133. already written strx[n]mov, using different names.
  134.  
  135. ************************************************************************
  136.     These files are in the public domain.  This includes getopt.c, which
  137. is the work of Henry Spencer, University of Toronto Zoology, who says of
  138. it "None of this software is derived from Bell software. I had no access
  139. to the source for Bell's versions at the time I wrote it.  This software
  140. is hereby explicitly placed in the public domain.  It may  be  used  for
  141. any purpose on any machine by anyone.
  142. ************************************************************************
  143. */
  144.