home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / c / hce.lha / HCE / Readme.doc < prev    next >
Encoding:
Text File  |  1992-09-02  |  15.1 KB  |  336 lines
  1. ***************************************************************************
  2. *                                                                         *
  3. *                           HCE version 1.0                               *
  4. *                 C Compiler envirenment for the Amiga                    *
  5. *                           by Jason Petty.                               *
  6. *                                                                         *
  7. ***************************************************************************
  8.  
  9. /* Original Compiler Copyright.
  10.  * HCC:
  11.  *
  12.  * Copyright (c) 1988,1989,1991 by Sozobon, Limited.  Author: Johann Ruegg
  13.  *
  14.  * Permission is granted to anyone to use this software for any purpose
  15.  * on any computer system, and to redistribute it freely, with the
  16.  * following restrictions:
  17.  * 1) No charge may be made other than reasonable charges for reproduction.
  18.  * 2) Modified versions must be clearly marked as such.
  19.  * 3) The authors are not responsible for any harmful consequences
  20.  *    of using this software, even if they result from defects in it.
  21.  */
  22.  
  23. /* Original Optimizer Copyright.
  24.  * TOP:
  25.  *
  26.  * Copyright (c) 1988,1989,1991 by Sozobon, Limited.  Author: Tony Andrews
  27.  *
  28.  * Permission is granted to anyone to use this software for any purpose
  29.  * on any computer system, and to redistribute it freely, with the
  30.  * following restrictions:
  31.  * 1) No charge may be made other than reasonable charges for reproduction.
  32.  * 2) Modified versions must be clearly marked as such.
  33.  * 3) The authors are not responsible for any harmful consequences
  34.  *    of using this software, even if they result from defects in it.
  35.  */
  36.  
  37. /* Detlef Wuerkners original Copyright:
  38.  *
  39.  * HCC 2.0 Amiga version 1.1 and TOP 2.0 Amiga version 1.1. I declare the 
  40.  * work done by me as Public Domain. Detlef Wuerkner.
  41.  *
  42.  */
  43.  
  44. /* My Copyright.
  45.  * HCE:
  46.  *
  47.  * Copyright (c) 1994. Author: Jason Petty.
  48.  *
  49.  * Permission is granted to anyone to use this software for any purpose
  50.  * on any computer system, and to redistribute it freely, with the
  51.  * following restrictions:
  52.  * 1) No charge may be made other than reasonable charges for reproduction.
  53.  * 2) Modified versions must be clearly marked as such.
  54.  * 3) The authors are not responsible for any harmful consequences
  55.  *    of using this software, even if they result from defects in it.
  56.  */
  57.  
  58. **************************************************************************
  59. *                      REQUIREMENTS-INSTALLATION                         *
  60. **************************************************************************
  61.  
  62. 1) KickStart Release 2.0 or Higher. (A500+ ,A600 ,A1200, ....)
  63. 2) 2MB ram.
  64. 3) or 1MB ram.(This is the absolute minimum and will limit what you can do)
  65.  
  66. note: Two disk drives or a hard drive are required for any serious work, but
  67.       for anyone just wanting to try HCE, a single drive is ok.
  68.  
  69. Installing HCE:
  70. ---------------
  71. To use HCE from the (HCE:) disk it comes on, do the following:
  72.  
  73.    1) Load Workbench
  74.    2) Place the HCE disk into the Internal drive.
  75.    3) Click on its Icon.
  76.    4) Then click on either the HCE_1MB Icon or the HCE_2MB Icon, 
  77.       (don't click the 2MB Icon if your machine only has 1MB!).
  78.    5) If you have 2 disk drives, place the workbench disk into the external
  79.       drive and the HCE disk into the internal drive.
  80.  
  81. To Install HCE to other disks, See the 'Hce.doc' (on the docs and examples
  82.  disk) for details.
  83.  
  84. HCE was developed on an A1200 with two external disk drives, and has not 
  85. been fully tested on any other Amiga.
  86. If HCE fails to load on your machine, please write to me explaining
  87. the reason why. I will try and fix the problem ready for the next release
  88. of HCE.
  89.  
  90. **************************************************************************
  91. *                          CONTENTS                                      *
  92. **************************************************************************
  93.  
  94. HCE          -   Compiler/Editor with source.
  95. TOP          -   Optimizer with source.
  96. A68K         -   Assembler from Fish disk 508.
  97. Blink        -   Linker from Fish disk 508.
  98. C libraries  -   Standard C libraries from fish disk 314.(with source)(ZC)
  99. Header files -   C library header files also from fish disk 314.
  100. begin.o      -   Startup code also from fish disk 314.
  101. Ami.lib      -   Kickstart release 1.3 to 2.04 Version of Amiga.lib,
  102.                  based upon source from 'PDC' release 3.33.(Fish 351)
  103.  
  104. Required for Amiga specific code but not included:
  105. --------------------------------------------------
  106. The Commodore Include files.
  107.  
  108. On requiring information from commodore as to how much and where to 
  109. obtain the Include files the reply was:
  110.  
  111. To obtain the 1.3 Native Developers disk may I suggest you contact
  112. Sharon Rodrigo at our Maidenhead Office (0628) 770088,
  113. or send a cheque to the amount of £25 to:-
  114.  
  115.        Commodore Business Machines UK Ltd
  116.        Commodore House
  117.        The Switchback
  118.        Gardner Road
  119.        Maidenhead
  120.        Berks
  121.        SL6 7XA
  122.  
  123. The disk contains all the C and Assembler Include files,
  124. the Amiga specific Libraries, Autodocs and much more.
  125.  
  126. note: this letter was received over a year ago, and the price of
  127.       the developer disk could have changed.
  128.       If you decide to obtain the Amiga Include files now, you 
  129.       should ask for Includes which cover Kickstart release 2.04,or Higher.
  130.  
  131. If you do not live in the UK then you should try and contact your
  132. National Commodore office.
  133.  
  134. **************************************************************************
  135. *                           SOURCE                                       *
  136. **************************************************************************
  137.  
  138. Source is provided for HCE,TOP,FD2STUBS and the C libraries in compressed
  139. form. To unpack them format two spare floppies called 'LibSrc:' and 'HceSrc:',
  140. copy the 'LibSource.LZH' file from this disk also the LHARC file from this
  141. disk and the 'HceSource.LZH' from the docs and examples disk to the ram disk.
  142. Then type the following:
  143.  
  144.                 RAM:LHARC -x -a -m x HceSource.LZH HceSrc:
  145.  
  146.                 RAM:LHARC -x -a -m x LibSource.LZH LibSrc:
  147.  
  148.  
  149. ***************************************************************************
  150. *         If you have not programmed in C on the Amiga before:            *
  151. ***************************************************************************
  152.  
  153. The C Manual V2.0 by Anders Bjerin can be found on Fish disk 457.
  154. It describes how to work with Screens, Windows, Graphics, Sprites,
  155. and most other areas of amiga programming.
  156. All the examples provided work with HCE, but some may need minor changes.
  157. note: nearly all the examples require the include files mentioned above.
  158.  
  159.  
  160. Literature I`ve bought and found to be very useful:
  161. --------------------------------------------------
  162.  
  163. Amiga C for Beginners:  
  164.                        A Practical guide to learning and using C,
  165.                        language on your Amiga.
  166.                        Topics include:
  167.                                       Beginner`s overview of C.
  168.                                       Writing your first C program.
  169.                                       Special features of the C language.
  170.                                       Important routines in C libraries.
  171.                                       Input and Output using C.
  172.                                       And much more.
  173.  
  174.                        Abicus books.  Author, Dirk Schaun.(around £18)
  175.  
  176. C By Example:
  177.                        The easiest way to learn how to program.
  178.                        This book teaches at three levels: beginning,
  179.                        intermediate, and advanced.
  180.                        Covers nearly all areas of C programming but is
  181.                        not specifically for the amiga computer, more
  182.                        for PC`s. After saying that, the examples provided
  183.                        (many of) work fine with HCE.
  184.  
  185.                        QUE books. Author, Greg Perry.(around £20)
  186.  
  187. Amiga Rom Kernal Reference Manual - Includes and AutoDocs:
  188.  
  189.                                 (Essential for serious programmers)
  190.  
  191.                        Contains:
  192.                                Summaries of the System library functions.
  193.                                Summaries of the System device commands.
  194.                                Summaries of System resource calls.
  195.                                Summaries of amiga,lib functions and source.
  196.                                C language include files.
  197.                                Assembly language include files.
  198.                                Handy charts designed to ease, 
  199.                                debugging and exploring.
  200.  
  201.                        Other Manuals in the series:
  202.                                Amiga User Interface Style Guide
  203.                                Amiga Rom Kernal Reference Manual, Libraries
  204.                                Amiga Rom Kernal Reference Manual, Devices
  205.                                Amiga Hardware Reference Manual
  206.  
  207.                        Amiga Technical Reference Series.
  208.                        Commodore-Amiga, Inc. (£28 - £32)
  209.  
  210. ***************************************************************************
  211. *            What is HCE and why would you want to use it?                *
  212. ***************************************************************************
  213.  
  214. What is HCE?
  215. -------------
  216. HCE first started out as a stand alone text editor for programmers
  217. which was capable of compiling C source codes from within the editor.
  218. This was done by running a PD compiler such as the ZC compiler from the
  219. editor and passing the source code filename. But this had its down sides
  220. such as all error messages would go to the CLI, you had to save the source
  221. code before you could compile it, the compiler did not check memory as
  222. it compiled and would on occasions crash, not very pleasant!.
  223. Then I came across the HCC compiler by Detlef Wuerkner from fish disk 508, 
  224. which came with source and could compile itself!. 
  225. I decided to modify the Compiler and the Editor source codes so as to be
  226. able to combine the two and make a single program, 'HCE'.
  227. It started off with many bugs but eliminated the bad memory management and 
  228. other side effects. 
  229. The program to date is pretty much bug free and has many features some
  230. of which I have mentioned below.
  231.  
  232. Why use HCE?
  233. ------------
  234.  some good points:
  235.                     1) You can modify and test your code without leaving
  236.                        the editor.
  237.                     2) You can mark out and test sections of code.
  238.                     3) You can run your finished program from the editor.
  239.                     3) If an error is encounted the editor will scroll
  240.                        to the area of the offending line automatically.
  241.                     4) You can compile or assemble upto 55 files at a
  242.                        time using Compile Lists. 
  243.                        These are files which end with a '.CL' extension.
  244.                     6) You can also link upto 55 files at a time 
  245.                        using Link Lists.
  246.                        These are files which end with a '.LL' extension.
  247.                     5) It shows what files and how much memory your
  248.                        using during compile.
  249.                     6) Does memory checking and aborts if Low.
  250.                     7) You can make libraries from either FD files, Object
  251.                        files or both.
  252.                     8) The Compiler,Optimizer,Assembler and Linker have
  253.                        their own option screens which use simple 
  254.                        (GadTools) gadgets.
  255.                     9) Can do common file operations such as Rename,
  256.                        Relabel,Assign,MakeDir,Delete,Copy.
  257.                    10) Supports most of the common text editor features,
  258.                        such as Cut,Copy,Insert,Print Block,Find,Replace,
  259.                        goto, and more.
  260.                    11) Allows full screen editing by pressing the escape
  261.                        key.
  262.                    12) Has own preferences screen. You can change and save
  263.                        the pen,paper,markout colour,Compiler/Optimizer/
  264.                        Assembler and Linker options and most other areas 
  265.                        of the program.
  266.                    13) Can compile itself.
  267.                    14) Complete source code is provided.
  268.                    15) And most Importantly, It`s Free!.
  269.  
  270.  some bad points:
  271.                     1) You cannot type beyond the visable windows width.
  272.                     2) There is a maximum file size of 1998 lines.
  273.                     3) There are no type over modes.
  274.                     4) The editor upon loading swallows around 500K
  275.                        of memory.
  276.                     5) The Source to HCE is not portable. Takes advantage
  277.                        of the Amigas Operating System. (Not really a bad
  278.                        point though).
  279.                     5) The Internal Compiler (HCC) is not an ANSI Compiler.
  280.                     6) Requires Kickstart release 2.00 or Higher.
  281.  
  282. ***************************************************************************
  283. *           WRITING COMMERCIAL OR SHAREWARE PROGRAMS WITH HCE             *
  284. ***************************************************************************
  285.  
  286. This distribution does not make use of the CClib.library by Robert 
  287. W. Albrecht Jr, which requires a $50 licence fee for Commercial or 
  288. Shareware programs which use it. The HCC compiler from Fish disk 508
  289. did use it. So if you are a user of HCC and have now decided to use HCE
  290. you can either use the libraries I have provided or to replace them with 
  291. CClib.library.
  292. The libraries I have provided are the original Sozobon C libraries and
  293. have had bug fixes and some enhancements.
  294.  
  295. Programs written using HCE do not require that you pay any licence fees.
  296.  
  297.  
  298. ***************************************************************************
  299. *                            HISTORY                                      *
  300. ***************************************************************************
  301.  
  302. For information on the history of the Sozobon C Compiler, I suggest
  303. you get Fish disk 508. The HCC distribution by Detlef Wuerkner has 
  304. the full history and original Sozobon C documentation.
  305.  
  306.  
  307. ***************************************************************************
  308. *                          IMPROVING HCE                                  *
  309. ***************************************************************************
  310.  
  311. If you find any bugs in HCE I would be most gratefull if you could make
  312. a copy of the 'Bug_Report.doc' , fill it in and send it to me. If it
  313. really was a bug then I will fix it and give your name a mention in the 
  314. next release of HCE.
  315. In order for me to make HCE useful, I need your opinions on what you
  316. consider to be missing from HCE, what needs improving and what things
  317. in general you would like to see in HCE. All opinions gratefully accepted.
  318.  
  319. You could of course improve HCE yourself and send it directly to Fred Fish.
  320. I do not recomend this, it would be better to have a single version of
  321. HCE in the Public Domain rather than 20 or so with minor bug fixes.
  322. If you send the bugs to me I will fix them and give your name a mention
  323. in the next release of HCE.
  324.  
  325. note: If you write to me requiring a reply, you are more likely to get it
  326.       if you enclose an S.S.A.E.
  327.  
  328. Have fun with HCE!
  329.  
  330. Jason Petty
  331. 32 Balder Raod,
  332. Norton,
  333. Stockton-On-Tees,
  334. Cleveland. TS20 1BE.
  335.  
  336.