home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_progs / prog_c / check.lzh / CHECK / CHECK.DOC < prev    next >
Encoding:
Text File  |  1991-08-16  |  5.1 KB  |  126 lines
  1.  
  2. Check V1.03 Copyright 1987, 1988 Keith Elbertson. All Rights Reserved.
  3.  
  4.    The Author, Keith Elbertson, grants permission for distribution of the
  5. executable version of CHECK V1.03. The program my be freely distributed
  6. non-commercially, so long as this file accompanies the executable file.
  7.  
  8.                   No fees may be charged for this program.
  9.  
  10.    Permission is not given for distribution for Commercial purposes, without
  11. written consent by the Author. Source code is not available, since it will
  12. be part of a larger commercial product released in the near future.
  13.  
  14.    This is the fourth revision of CHECK. There are no bugs in the program
  15. that I am aware of. If you find any though, please let me know about them
  16. as soon as possible.  I've spent many hours making sure that I squashed them
  17. all but sometimes real tiny ones manage to get away. Also, if you have any
  18. recommendations about other enhancements or changes you would like to see,
  19. drop me a line.
  20.  
  21.    I can be reached on the BBS-ARIA in Pembroke Pines, Fl. 305-435-9837 or
  22. by mail:
  23.  
  24.         Information Cartel, Inc.
  25.         Attn:Keith Elbertson
  26.         P.O. BOX 840535
  27.         Pembroke Pines, Fl. 33084
  28.  
  29. USAGE:
  30.  
  31.    CHECK [flags] Filename
  32.  
  33.       The flags are optional.  With no flags set, Check will run a test of
  34.    the source files control structures, and report what it found. This
  35.    information can be used to locate problems in the programs flow control
  36.    structures before attempting a compile.
  37.  
  38.       If CHECK finds something out of balance, it will put a pointer next to
  39.    that structures report line, to draw attention to the possible problem.
  40.    If nothing has the arrow next to it, you can be fairly sure that
  41.    everything is OK with the programs basic structure. No attempt has been
  42.    made in this version to syntactically check the file.
  43.  
  44.       The best feature of CHECK is that you can view any particular control
  45.    structure(s) by setting that structures flag. Multiple flags can be set
  46.    at a time. Any structure selected will be displayed in inverse video as
  47.    the file is viewed, making it easier to spot the problem. It's much faster
  48.    than looking at plain source code, or trying to figure out what those
  49.    sometimes cryptic compiler error messages mean.
  50.  
  51.       Check will also convert CR/LF to LF only, which is the standard format
  52.    for Amiga files.  This is handy for converting files from other machines.
  53.  
  54.       Flags are set by typing a "-" immediately followed by a number or
  55.    letter. The case of the letter is insignificant.
  56.  
  57.       Example: CHECK -c -d filename
  58.  
  59.    This would cause comments, and double quotes to be displayed in inverse
  60.    video as it was typed to the screen.
  61.  
  62.       Certain flags will not work in conjuction with others. In these cases,
  63.    the first flag set takes priority over the later incompatible one. These
  64.    incompatibilities are pointed out below.
  65.  
  66.    FLAGS:
  67.  
  68.       -A View text enclosed in brackets.
  69.  
  70.       -B View nesting of braces. This depth is displayed by a 3 digit
  71.          number in inverse video to the left of the screen.
  72.  
  73.       -C View text enclosed in comments. This option cannot be used in
  74.          conjunction with the -X option.
  75.  
  76.       -D View strings enclosed in double quotes.
  77.  
  78.       -L Print line numbers in inverse video along with text.
  79.  
  80.       -N Allow nesting of comments. Works with both viewing and stripping.
  81.  
  82.       -O Output to a file instead of the screen. Text of the filename should
  83.          follow the -O without any spaces in between the O and the name.
  84.          Example:
  85.                   CHECK -oram:temp check.c
  86.  
  87.          will send the results of the check to ram:temp.
  88.  
  89.       -P View text enclosed in parenthesis.
  90.  
  91.       -R Check does not normally display results when viewing a file.
  92.          Setting this flag will display the results when done.
  93.  
  94.       -S View strings enclose in single quotes.
  95.  
  96.       -X Strips commented text from the output. This option cannot be used
  97.          in conjunction with the -C option.
  98.  
  99.       -0 Zero/Reset video display to normal. If you used Ctrl-C to stop CHECK
  100.          prematurely, and were left in inverse video mode, this will fix the
  101.          display. CHECK resets the display when it exits normally.
  102.  
  103. HOW TO:
  104.  
  105.    1. First run check on the program to see if all control structures are in
  106.       balance. If everything is in balance, try to compile the code.
  107.  
  108.    2. If something is out-of-balance. Run the check again with the flag(s)
  109.       set that will allow you to view the source code for that type of error.
  110.  
  111.    3. If you can't find an error in the source file, run a check on any
  112.       header files that you have created. Occasionally this is where the
  113.       real error is but shows up as the source file having the error.
  114.  
  115. P.S.
  116.  
  117.    This won't find all of your bugs, but if your code passes a CHECK, you can
  118.    be pretty sure the code is structured properly.
  119.  
  120.    I have gotten plenty of use from CHECK since writting it. I know the time
  121.    it took authoring it were well spent since it has saved me countless hours
  122.    in debugging. I hope you will find CHECK as useful as I have.
  123.  
  124.                                                 Happy Hacking,
  125.                                                 Keith Elbertson
  126.