home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / bcpp1611.zip / BCPP / README.1ST < prev    next >
Text File  |  1996-12-18  |  3KB  |  62 lines
  1. -------------------------------------------------------------------------------
  2.                           C(++) Beautifier V1.61
  3.                   Written By Steven De Toni January 1995
  4. -------------------------------------------------------------------------------
  5.                           C(++) Beautifier V1.61.1
  6.                   Modified By Nitin Chandra December 1996
  7.                             (nitin@poboxes.com)
  8. -------------------------------------------------------------------------------
  9. This file briefly describes my hacks <g> to this lovely program
  10. ---------------------------------------------------------------
  11.  
  12. 1. Fixed to use DOS CR/LF, but is there as an option in the config file, so
  13.    it can still be used for LF only if required.
  14.  
  15. 2. Fixed to read the config from the current dir and if not found there, then
  16.    get it from the directory from where the program was started and if still
  17.    absent, then use defaults.
  18.  
  19. 3. Added my style of indenting.
  20.    main()
  21.    {
  22.       if ( xyz )
  23.          {
  24.          }
  25.    }
  26.    Both these can be configured from the config file, for example, you might
  27.    want to indent the function block braces as well.
  28.  
  29. 4. I don't recall where I got this program from, nor do I have all the docs
  30.    for it, but the hacked <g> source is included as well as the original txt
  31.    dox for someone who might want to make this program even better. For
  32.    example the program falters on contructs like:
  33.  
  34.    if ( xyx )
  35.       for ( abc )
  36.          {
  37.          }
  38.  
  39.    it does not correctly indent these cases, but otherwise works great.
  40.  
  41. 5. If you are using Watcom C, there is a slight gotcha here, you *must*
  42.    use the /ei option which tell the compiler to treat enums as ints. Whew
  43.    that was a pesky one since the config structure has a mix of an enum type
  44.    and int and the enum types are cast to (int &) in the code to set option
  45.    on startup which could cause all sorts of problems.
  46.  
  47. 6. The default options in the program are the same as the ones in the config
  48.    file (bcpp.cfg) now which is what I use for my code ( of course :))
  49.  
  50. 7. I have included an OS/2 .Cmd file to compile the different platform
  51.    versions of bcpp and the binaries are included in seperate directories
  52.    as well. Although there is a NT binary included, you are on your own
  53.    there as I have used only the OS/2 and DOS versions, but the source
  54.    should compile for most compilers in case there is a problem.
  55.  
  56. 8. If anyone out there improves on this, please send me a copy as well :)
  57.  
  58. 9. Why this? well....I wanted to make it to ten points :)
  59.  
  60. 10. I can be reached at nitin@poboxes.com in case of any comments, and for
  61.     those of you who really want to know, I'm located in New Delhi, India.
  62.