home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / cug / softt-2.lbr / BDS.DQC / BDS.DOC
Text File  |  1984-07-05  |  4KB  |  105 lines
  1. .cm comments about the files on this disk
  2. .cm source:  bds.doc
  3. .cm version: December, 1981
  4. .bp 1
  5. .he 'bds.doc''%'
  6. .fo ''-#-''
  7.  
  8. .ul
  9. Primitives
  10.  
  11.    The following files contain the software tools primitives
  12. written in BDS C:
  13.  
  14. TOOLS.H, DATE.BDS, FILE.BDS, RAWFILE.BDS, ARGS.BDS, MISC.BDS,
  15. STORAGE.BDS, STRING.BDS, CONVERT.BDS, SYMTAB.BDS, and
  16. PATTERN.BDS.
  17.  
  18.    The file TOOLS.H contains all global variables and
  19. declarations used by the BDS C version of the software
  20. tools primitives.
  21. This file must be used in ALL programs instead of BDSCIO.H.
  22. This file contains portions of BDSCIO.H and RATDEF.
  23. See the file TOOLS.H for more comments.
  24.  
  25.    The files FILE.BDS, RAWFILE.BDS, ARGS.BDS, MISC.BDS
  26. implement the I/O primitives and I/O redirection.
  27. (MISC.BDS contains some odds and ends.)
  28. I have been using them for several months now with no problems.
  29.  
  30.    The file STORAGE.BDS contains the dynamic storage allocation
  31. primitives.
  32. This file simply calls the BDS C allocation primitives.
  33.  
  34.    The file STRING.BDS contains string manipulation primitives.
  35. Not all the primitives on this file have been debugged.
  36.  
  37.    The file CONVERT.BDS contains various conversion utility
  38. routines.
  39. Not all of the routines on this file have been converted from
  40. RATFOR to BDS C.
  41. The ones that have not been converted are commented out.
  42.  
  43.    The file SYMTAB.BDS contains symbol table creation,
  44. deletion, and lookup routines.
  45. These routines are used by the ROFF program,
  46. but you still might want to
  47. revise them extensively.
  48. There are more comments on the file SYMTAB.BDS.
  49.  
  50.    The file PATTERN.BDS contains pattern-matching and
  51. set manipulation primitives.
  52. None of the primitives on this file have been completely
  53. converted to BDS C and debugged.
  54. Indeed, the primitives on this file are in various stages;
  55. some are mostly RATFOR still while others are mostly BDS C.
  56.  
  57.    The file TOOLIB1.BDS contains most of the library routines
  58. from STDLIB1.BDS and STDLIB2.BDS.
  59. Some of the routines were modified for use with the directed
  60. I/O routines.
  61. Some of the names of routines were changed to avoid conflicts.
  62. Some of the BDS C routines were deleted.
  63. See the comments on the file TOOLIB1.BDS for more details.
  64.  
  65.    The file TOOLIB2.CRL contains the object for all the
  66. BDS C routines which are written in assembly language.
  67. Note that some of the names in this file have been changed.
  68. This file was, of course, created with CLIB.
  69.  
  70.    The file COPY.BDS is a test propram for the primitives.
  71. The file ARGS.BDS also contains a main() function which is
  72. a test of I/O redirection.
  73. The file SYMTAB.BDS contains a main() function which is
  74. a test of the symbol table primitives.
  75.  
  76.    The .SUB files on this disk are SUBMIT files used to
  77. compile or link the primitives.
  78. The file TOOLS.SUB simply compiles all the primitives.
  79.  
  80.    The files LINKARGS.SUB, LINKCOPY.SUB, and SYMLINK.SUB
  81. link the files ARGS.BDS, COPY.BDS, and SYMTAB.BDS.
  82. Note that linking all the primitives together is fairly
  83. complicated at this stage.
  84.  
  85. .ul
  86. Utilities and documentation
  87.  
  88.    The file RAT2C.BDS is a filter which converts RATFOR-style
  89. comments into BDS C style comments.
  90. At present this program is the only tool that I have for
  91. converting RATFOR programs to C program.
  92.  
  93.    The file CONVR2C.DOC tells what has to be done to convert
  94. programs from RATFOR to C.
  95. You may be surprised (or shocked) to see how difficult it is.
  96.  
  97.   The file CHANGES.DOC tells what changes should or could
  98. be made to the primitives.
  99. The contents of this file are only opinions, but I hope
  100. they will form a starting point for future discussions.
  101.  
  102.    The file FILE.DOC tells how the primitives implement
  103. I/O redirection.
  104. Some of this information can also be found on TOOLS.H.
  105.