home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / new / dev / misc / p2c / src / install < prev    next >
Text File  |  1993-12-21  |  6KB  |  135 lines
  1.  
  2. This directory contains "p2c" version 1.20, a Pascal to C translator.
  3.  
  4. "p2c"  Copyright 1989, 1990, 1991  Free Software Foundation, Inc.
  5.  
  6. Written and maintained by:   Dave Gillespie
  7.                  256-80 Caltech
  8.                  Pasadena CA 91125
  9.                  daveg@csvax.cs.caltech.edu, cit-vax!daveg
  10.  
  11.  
  12. This program is distributed under the terms of the GNU License Agreement.
  13. See the file src/COPYING for details.
  14.  
  15. The GNU License Agreement restrictions do _not_ apply to code generated
  16. by p2c, nor to the p2c run-time files "p2clib.c" and "p2c.h".
  17.  
  18.  
  19.  
  20. QUICK INSTRUCTIONS
  21.  
  22. The top-level Makefile in this directory tree knows how to build
  23. p2c and run it on some example programs.  The compiled p2c will be
  24. "installed" in this directory tree rather than in public directories.
  25. (For a full public installation, see the instructions below.)
  26. Just type "make test" to build p2c and run the examples.
  27.  
  28.  
  29.  
  30. FULL INSTALLATION INSTRUCTIONS
  31.  
  32. For a complete system, you must:
  33.  
  34.    a) Create a home directory for p2c, such as /usr/lib/p2c.  The exact
  35.       location does not matter, as long as p2c knows how to find it.
  36.  
  37.    b) Create an include directory, such as /usr/include/p2c.  If you are
  38.       unable to arrange for an include directory, you can edit sys.p2crc
  39.       so as not to require one, or compile translated code with a
  40.       suitable -I flag.
  41.  
  42.    c) Install the executable "p2c" in /usr/bin or elsewhere on the
  43.       standard search path.
  44.  
  45.    d) Install the run-time library "libp2c.a" in /usr/lib or elsewhere
  46.       on the standard library search path.
  47.  
  48.    e) Install the Unix manual entry "p2c.1" in /usr/man/man1.  If you
  49.       have a "man1.Z" directory instead (for compressed man pages)
  50.       you will have to edit the Makefile to use a "compress" command.
  51.  
  52.    f) Install the necessary files in the p2c home directory.
  53.  
  54. The Makefile is initially set up to create a private version of p2c in
  55. the p2c distribution directory.  Just "cd src" and "make install" to
  56. perform the above steps.  This will place the p2c executable, run-time
  57. library, include directory, and man page in the "home" subdirectory of
  58. the distribution directory.  The man page will be in human-readable form.
  59.  
  60. To compile code that has been translated by this private version of p2c,
  61. use the command:
  62.  
  63.     cc -I. foo.c libp2c.a
  64.  
  65. (assuming "home," i.e., HOMEDIR, is the current directory.)
  66.  
  67. The "examples" subdirectory contains a few sample Pascal programs and
  68. a Makefile to translate and compile them.
  69.  
  70. To install p2c for public use, edit the Makefile to indicate the correct
  71. directory names.  Suggested names are included as comments.  Also change
  72. MANFILE as shown to store the man page in the proper form for the "man"
  73. command.
  74.  
  75.     HOMEDIR      default /usr/lib/p2c       Home directory
  76.     INCDIR       default /usr/include/p2c   Include directory
  77.     BINDIR       default /usr/bin           Directory for "p2c" executable
  78.     LIBDIR       default /usr/lib           Directory for "libp2c.a" library
  79.     MANDIR       default /usr/man/man1      Directory for "p2c.1" manual page
  80.  
  81. Make sure the home and include directories have been created and are
  82. writable, and that the bin, lib, and man directories are writable.
  83. (You may have to be root to do this.)  Recompile "p2c" with another
  84. "make install".  Be sure "trans.c" is recompiled with the new value
  85. of HOMEDIR; you can ensure this by doing "make newhome" before
  86. "make install".  You can always type "make" with no arguments to
  87. compile without installing.
  88.  
  89. HP Pascal Workstation System users will want to copy all of ../HP/include
  90. into the new p2c include directory, and copy all of ../HP/import into
  91. the p2c home directory.  You will have to write emulations for the
  92. functions you use out of these modules.  (The HP directories are
  93. present in the ftp distribution only---they have been omitted from
  94. the shar'd version to save space.)
  95.  
  96. Incomplete interface texts for standard Turbo units are included in
  97. turbo.imp.  Turbo users will have to flesh these out and write emulations
  98. for whatever parts of the Turbo runtime library they need.
  99.  
  100. If you wish to edit various system-wide configuration parameters, it is
  101. better to put them in loc.p2crc than in sys.p2crc.  As an example, on a
  102. Turbo-oriented environment you may wish to add
  103.  
  104.     Language Turbo
  105.  
  106. to the loc.p2crc file to replace the normal default (HP Pascal).
  107.  
  108.  
  109.  
  110. PORTABILITY
  111.  
  112. P2c was originally developed on a homebrew C compiler on the HP Pascal
  113. Workstation operating system.  Current development takes place on HP-UX,
  114. which is System V based.  The translator has also been compiled and used
  115. on Sun-3's, so presumably it is fairly portable among 32-bit Unix machines.
  116.  
  117. Many parts of the code will have to be adjusted in order for p2c to work
  118. on a machine with 16-bit ints.  I have never had reason or opportunity to
  119. track these down since I don't have access to such a machine.  Please note
  120. that code _generated_ by p2c works with either size of int even though p2c
  121. itself does not.
  122.  
  123. If your compiler supports ANSI prototypes, most of the 16-bit portability
  124. problems will go away except for possible %d/%ld sloppiness in sprintf control
  125. strings.  There may be places where p2c tries to cast a pointer into an
  126. int, but I believe all such cases use longs consistently.  You will have
  127. a problem if your long type is not large enough to store a pointer.
  128.  
  129. Because p2c was developed to run under Unix, it is sloppy about memory
  130. allocation.  Some data structures are allocated but never freed.  Profiles
  131. show that the waste is not too great in most cases, but if it is a problem
  132. you may have to write a garbage collector (this shouldn't be too hard if you
  133. only run the collector after translating each procedure).
  134.  
  135.