home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 31 / CDASC_31_1996_juillet_aout.iso / vrac_os2 / sm099c.zip / README.TXT < prev    next >
Text File  |  1996-05-19  |  6KB  |  175 lines
  1. // -------------------------------------------------------------------------
  2. //       File: readme.txt
  3. //       Date: April 05. 1996.
  4. // Written by: Leif-Erik Larsen. Norway.
  5. // -------------------------------------------------------------------------
  6.  
  7.  
  8.  
  9. - - - - - - - - - - - - - - - - - - -
  10.  S O U R C E   M A P P E R   ( S M )
  11. - - - - - - - - - - - - - - - - - - -
  12.  
  13.  
  14.  
  15. General information
  16. ===================
  17.  
  18. This is the "read-me" file for the Source Mapper (SM) program. You should
  19. read this document before you start using SM.
  20.  
  21.  
  22. What is Source Mapper (SM) ?
  23. ============================
  24.  
  25. With SM you can make a useful (human readable) map of your C-style source
  26. codes. You can generate a map of a single sourcefile, or you can have SM
  27. generate a map of a huge project that consists of many source files.
  28.  
  29. The produced map is espesially useful when you need to document the source(s)
  30. of your project. I've also found it helpful when digging into sources written
  31. by others.
  32.  
  33.  
  34. Register your copy
  35. ==================
  36.  
  37. SM is not freeware, but shareware. This means you should pay for it if you
  38. continue to use it after a trial period of 30 days.
  39.  
  40. If you find the program useful please register it. The registration fee is
  41. only USD 20.- or NKR 120.-. After I have received your payment I will send
  42. you a registered copy of the latest version on a 3.5" diskette. So don't
  43. forget to give me your name and address. If you have e-mail access please
  44. let me know your e-address as well.
  45.  
  46.  
  47. How to pay
  48. ==========
  49.  
  50. Check
  51.          Send a personal check in the currency you like (covering the amount
  52.          to be charged).
  53.  
  54. Cash
  55.          If you send cash, please use registered mail.
  56.  
  57. Bank Transfer
  58.          My bank is "Sparebanken NOR" in Norway. Account is 1612.2087763.
  59.          (one-six-one-two-dot-two-zero-eight-seven-seven-six-three).
  60.  
  61.  
  62. Contacting the author
  63. =====================
  64.  
  65. You can contact me either by shipping a traditional mail letter (very slow)
  66. or by transmitting an electronic mail letter (fast - recommended :-).
  67.  
  68. Leif-Erik Larsen
  69. Aasenvegen 32b
  70. 1400 Ski
  71. Norway
  72.  
  73. E-mail: lelarse@ibm.net
  74.  
  75. Feel free to give me any suggestions or comments. I will be happy to hear what
  76. you think about SM, either you like it or not.
  77.  
  78.  
  79. Technical information
  80. =====================
  81.  
  82. SM was compiled by the following compilers.
  83.  
  84. OS/2  : Borland C++ v.2.0 for OS/2.
  85. DOS   : Borland C++ v.3.1 for DOS.
  86. WIN32 : Borland C++ v.4.02 for Windows.
  87. DOS386: GNU C-Compiler v.2.6.3 for DOS (using the go32-v2.exe DOS-extender).
  88. UNIX  : GNU C-Compiler v.2.6.3
  89.  
  90.  
  91. Known bugs and problems
  92. =======================
  93.  
  94. * The tree list of calling sequences may contain branches with dead ends.
  95.   This is not really a bug, but a problem due to the algorithm used by SM
  96.   to generate the tree. It will be fixed before the main release of SM.
  97.  
  98. * The 'cse[]' (column separator) option doesn't work correctly.
  99.  
  100. * SM can't yet handle long filenames (longer than DOS 8.3 filenames)
  101.   correctly. This limitation will be fixed soon. In the meantime you should
  102.   keep your source file names within the stupid limitation of DOS 8.3, even
  103.   if you're using the great HPFS file system of OS/2 or any other modern
  104.   file system that support long filenames.
  105.  
  106.  
  107. Hints and Tips
  108. ==============
  109.  
  110. 1. Remember: SM isn't actually a compiler. It's just a stupid parser that has
  111.    the ability to reqognice most C style code. Therefore, try to write your
  112.    code as structured as possible, containing as few odd statements as
  113.    possible. This is true if you use much preprocessor code, which SM hasn't
  114.    the ability to reqognice as good as it reqognices the true C code.
  115.  
  116. 2. If you get some strange error messages (or map output) during the
  117.    generation of a source map: Try to delete all SM-object files (.smo-files)
  118.    of your project and make the map again. Optionally you can turn the
  119.    'dto[+]' option on (auto delete .smg-files after use) to make sure that
  120.    SM will always use fresh .smg-files.
  121.  
  122. 3. If you get some strange (or maybe even buggy) output from SM, then please
  123.    take a close look at the source code of where the error seems to occour.
  124.    SM has some problems on parse some rare types of syntax. (See paragraph #1.)
  125.  
  126.  
  127. Things to add or fix
  128. ====================
  129.  
  130. * All language dependent information (except text strings) should be user
  131.   configurable. This is true for key words of the C language, graphical
  132.   characters of lines, etc.
  133.  
  134. * Support for redirected input/output (stdin/stdout).
  135.  
  136. * Safe support for long filenames (OS/2, UNIX, etc.)
  137.  
  138. * Added security when creating files. Eventually asking user if it's ok to
  139.   write over an already existing file. This is true in case the file is of a
  140.   type other than the type that SM is about to create.
  141.  
  142. * Adjustable default extention of sources and maps (+ other files).
  143.  
  144. * All error messages should be written to stderr rather than stdout by default.
  145.  
  146. * Option: Automatic convert from tabulator characters to spaces (in sources).
  147.  
  148. * Option: Include/exclude external functions to/from list of calling sequences.
  149.  
  150. * A GUI-shell of where the user can adjust the project and its settings
  151.   simply by drag/drop and click using the mouse.
  152.  
  153.  
  154.  
  155. Warranty
  156. ========
  157.  
  158. Use of this software for any purpose whatsoever constitutes your unqualified
  159. acceptance of the following statements.
  160.  
  161. The author makes no warranty or representation that the software will be
  162. error free. The author disclaims any warranties, either express or implied,
  163. including but not limited to any implied warranty of merchantability or
  164. fitness for any particular purpose.
  165.  
  166. The user agrees to take full responsibility for the selection of and any use
  167. whatsoever made of the software.
  168.  
  169. IN NO EVENT WILL THE AUTHOR BE LIABLE FOR ANY DAMAGES WHATSOEVER (INCLUDING
  170. WITHOUT LIMITATION DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
  171. INTERRUPTION, LOSS OF BUSINESS INFORMATION OR THE LIKE) ARISING OUT OF THE
  172. USE OF, INTERRUPTION IN THE USE OF, OR INABILITY TO USE THIS SOFTWARE, EVEN
  173. IF THE AUTHOR HAS BEEN ADVISED OF ANY POSSIBILITY OR LIKELIHOOD OF SUCH
  174. DAMAGES.
  175.