home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 February / Chip_2000-02_cd.bin / zkuste / freesoft / freepascal / user.txt < prev   
Encoding:
Text File  |  1999-12-19  |  181.9 KB  |  5,357 lines
  1. Free Pascal :
  2. Users' manual
  3.  
  4.                         Users' manual for Free Pascal, version 0.99.12
  5.                                                                    1.6
  6.                                                             July 1999
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16. Micha¿el Van Canneyt
  17. Florian Kl¿ampfl
  18.  
  19.  
  20.  
  21. Contents
  22.  
  23. 1 Introduction                                                                         4
  24.   1.1 About this document . . . . . . . . . . . . . . . . . . . . . . . . . . .        4
  25.   1.2 About the compiler . . . . . . . . . . . . . . . . . . . . . . . . . . . .       4
  26.   1.3 Getting more information. . . . . . . . . . . . . . . . . . . . . . . . .        5
  27.  
  28. 2 Installing the compiler                                                              6
  29.   2.1 Before Installation : Requirements . . . . . . . . . . . . . . . . . . .         6
  30.        System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . .       6
  31.        Software requirements . . . . . . . . . . . . . . . . . . . . . . . . . .       6
  32.   2.2 Installing the compiler. . . . . . . . . . . . . . . . . . . . . . . . . . .     6
  33.        Installing under DOS . . . . . . . . . . . . . . . . . . . . . . . . . . .      7
  34.        Installing under Linux . . . . . . . . . . . . . . . . . . . . . . . . . .      7
  35.   2.3 Optional configuration steps . . . . . . . . . . . . . . . . . . . . . . . 10
  36.   2.4 Testing the compiler . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
  37.  
  38. 3 Compiler usage                                                                      12
  39.   3.1 File searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
  40.        Command line files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
  41.        Unit files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
  42.   3.2 Include files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
  43.   3.3 Object files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
  44.        Configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
  45.   3.4 Compiling a program . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
  46.   3.5 Compiling a unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
  47.   3.6 Creating an executable for GO32V1 and PMODE/DJ targets . . . . 16
  48.        GO32V1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
  49.        PMODE/DJ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
  50.   3.7 Reducing the size of your program . . . . . . . . . . . . . . . . . . . 17
  51.  
  52. 4 Compiling problems                                                                  18
  53.   4.1 General problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
  54.   4.2 Problems you may encounter under DOS . . . . . . . . . . . . . . . 18
  55.  
  56.                                           1
  57.  
  58.  
  59.  
  60.                                                                        CONTENTS
  61.  
  62.  
  63. 5 Compiler configuration                                                          19
  64.   5.1 Using the command-line options . . . . . . . . . . . . . . . . . . . . 19
  65.        General options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
  66.        Options for getting feedback . . . . . . . . . . . . . . . . . . . . . . . 20
  67.        Options concerning files and directories . . . . . . . . . . . . . . . . 20
  68.        Options controlling the kind of output. . . . . . . . . . . . . . . . . . 21
  69.        Options concerning the sources (language options) . . . . . . . . . . 23
  70.   5.2 Using the configuration file . . . . . . . . . . . . . . . . . . . . . . . 24
  71.        #IFDEF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
  72.        #IFNDEF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
  73.        #ELSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
  74.        #ENDIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
  75.        #DEFINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
  76.        #UNDEF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
  77.        #WRITE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
  78.        #INCLUDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
  79.        #SECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
  80.   5.3 Variable substitution in paths . . . . . . . . . . . . . . . . . . . . . . 28
  81.  
  82. 6 Porting Turbo Pascal Code                                                       29
  83.   6.1 Things that will not work . . . . . . . . . . . . . . . . . . . . . . . . 29
  84.   6.2 Things which are extra . . . . . . . . . . . . . . . . . . . . . . . . . . 30
  85.   6.3 Turbo Pascal compatibility mode . . . . . . . . . . . . . . . . . . . . 32
  86.  
  87. 7 Utilities and units that come with Free Pascal                                  34
  88.   7.1 Supplied programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
  89.        ppudump program . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
  90.        Demo programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
  91.        Documentation Example programs . . . . . . . . . . . . . . . . . . . 35
  92.        ppumove program . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
  93.        ptop - Pascal source beautifier . . . . . . . . . . . . . . . . . . . . . . 36
  94.   7.2 Supplied units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
  95.        Under DOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
  96.        Under Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
  97.  
  98. 8 Debugging your Programs                                                         42
  99.   8.1 Compiling your program with debugger support . . . . . . . . . . . . 42
  100.   8.2 Using gdb to debug your program . . . . . . . . . . . . . . . . . . . . 43
  101.   8.3 Caveats when debugging with gdb . . . . . . . . . . . . . . . . . . . 44
  102.   8.4 Support for gprof, the gnu profiler . . . . . . . . . . . . . . . . . . 45
  103.  
  104.  
  105.  
  106.                                          2
  107.  
  108.  
  109.  
  110.                                                                         CONTENTS
  111.  
  112.  
  113. 9 CGI programming in Free Pascal                                                   46
  114.   9.1 Getting your data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
  115.        Data coming through standard input. . . . . . . . . . . . . . . . . . 47
  116.        Data passed through an environment variable . . . . . . . . . . . . . 48
  117.   9.2 Producing output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
  118.   9.3 I'm under Windows, what now ? . . . . . . . . . . . . . . . . . . . . 51
  119.  
  120. A Alphabetical listing of command-line options                                     52
  121.  
  122. B Alphabetical list of reserved words                                              55
  123.  
  124. C Compiler messages                                                                56
  125.   C.1 General compiler messages . . . . . . . . . . . . . . . . . . . . . . . . 56
  126.   C.2 Scanner messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
  127.   C.3 Parser messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
  128.   C.4 Type checking errors . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
  129.   C.5 Symbol handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
  130.   C.6 Code generator messages . . . . . . . . . . . . . . . . . . . . . . . . . 74
  131.   C.7 Unit loading messages. . . . . . . . . . . . . . . . . . . . . . . . . . . 76
  132.   C.8 Command-line handling errors . . . . . . . . . . . . . . . . . . . . . 78
  133.   C.9 Assembler reader errors. . . . . . . . . . . . . . . . . . . . . . . . . . 79
  134.        General assembler errors . . . . . . . . . . . . . . . . . . . . . . . . . 79
  135.        I386 specific errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
  136.        m68k specific errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
  137.  
  138. D Run time errors                                                                  85
  139.  
  140. E The Floating Point Coprocessor emulator                                          88
  141.  
  142. F A sample gdb.ini file                                                            90
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.                                          3
  161.  
  162.  
  163.  
  164. Chapter 1
  165.  
  166. Introduction
  167.  
  168. 1.1 About this document
  169.  
  170. This is the user's manual for Free Pascal. It describes the installation and use of
  171. the Free Pascal compiler on the di erent supported platforms. It does not attempt
  172. to give an exhaustive list of all supported commands, nor a definition of the Pascal
  173. language. Look at the Reference guide for these things. For a description of the
  174. possibilities and the inner workings of the compiler, see the Programmers' guide. In
  175. the appendices of this document you will find lists of reserved words and compiler
  176. error messages (with descriptions).
  177. This document describes the compiler as it is/functions at the time of writing. Since
  178. the compiler is under continuous development, some of the things described here
  179. may be outdated. In case of doubt, consult the README files, distributed with the
  180. compiler. The README files are, in case of conflict with this manual, authoritative.
  181.  
  182.  
  183. 1.2 About the compiler
  184.  
  185. Free Pascal is a 32-bit compiler for the i386 and m68k processors1. Currently, it
  186. supports 6 operating systems:
  187.  
  188.    * dos
  189.  
  190.    * linux
  191.  
  192.    * Atari (version 0.99.5 only)
  193.  
  194.    * Amiga (version 0.99.5 only)
  195.  
  196.    * Windows NT
  197.  
  198.    * os/2 (using the EMX package, so it also works on DOS/Windows)
  199.  
  200. and work is in progress to port it to other platforms (notably, FreeBSD).
  201. Free Pascal is designed to be, as much as possible, source compatible with Turbo
  202. Pascal 7.0 and Delphi 4 (although this goal is not yet attained), but it also en-
  203. hances these languages with elements like function overloading. And, unlike these
  204. ancestors, it supports multiple platforms.
  205.   1Work is being done on a port to ALPHA Architecture
  206.  
  207.  
  208.                                            4
  209.  
  210.  
  211.  
  212.                                           1.3. GETTING MORE INFORMATION.
  213.  
  214.  
  215. It also di ers from them in the sense that you cannot use compiled units from one
  216. system for the other.
  217. Also, at the time of writing, there is no Integrated Development Environment (IDE)
  218. available for Free Pascal. This gap will, hopefully, be filled in the future.
  219. Free Pascal consists of three parts :
  220.  
  221.   1. The compiler program itself.
  222.  
  223.   2. The Run-Time Library (RTL).
  224.  
  225.   3. Utility programs and units.
  226.  
  227. Of these you only need the first two, in order to be able to use the compiler. In
  228. this document, we describe the use of the compiler. The RTL is described in the
  229. Reference guide.
  230.  
  231.  
  232. 1.3 Getting more information.
  233.  
  234. If the documentation doesn't give an answer to your questions, you can obtain more
  235. information on the Internet, on the following addresses:
  236.  
  237.    * http://tfdec1.fys.kuleuven.ac.be/ michael/fpc/fpc.html is the main site. It
  238.       contains also useful mail addresses and links to other places. It also contains
  239.       the instructions for inscribing to the mailing-list.
  240.  
  241.    * http://www.brain.uni-freiburg.de/ klaus/fpc/fpc.html is a mirror of the main
  242.       Free Pascal information site.
  243.  
  244. Both places can be used to download the Free Pascal distribution, although you
  245. can probably find them on other places also.
  246. Finally, if you think something should be added to this manual (entirely possible),
  247. please do not hesitate and contact me at michael@tfdec1.fys.kuleuven.ac.be .
  248. Let's get on with something useful.
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.                                            5
  269.  
  270.  
  271.  
  272. Chapter 2
  273.  
  274. Installing the compiler
  275.  
  276. 2.1 Before Installation : Requirements
  277.  
  278. System requirements
  279. The compiler needs at least the following hardware:
  280.  
  281.   1. An I386 or higher processor. A coprocessor is not required, although it will
  282.      slow down your program's performance if you do floating point calculations.
  283.   2. 2 Mb of free memory. Under dos, if you use DPMI memory management,
  284.      such as under Windows, you will need at least 16 Mb.
  285.   3. At least 500 Kb. free disk space.
  286.  
  287.  
  288. Software requirements
  289. Under DOS
  290.  
  291. The dos distribution contains all the files you need to run the compiler and compile
  292. pascal programs.
  293.  
  294. Under Linux
  295.  
  296. Under linux you need to have the following programs installed :
  297.  
  298.   1. gnu as, the gnu assembler.
  299.   2. gnu ld, the gnu linker.
  300.   3. Optionally (but highly recommended) : gnu make. For easy recompiling of
  301.      the compiler and Run-Time Library, this is needed.
  302.  
  303. Other than that, Free Pascal should run on almost any I386 linux system.
  304.  
  305.  
  306. 2.2 Installing the compiler.
  307.  
  308. The installation of Free Pascal is easy, but is platform-dependent. We discuss the
  309. process for each platform separately.
  310.  
  311.                                           6
  312.  
  313.  
  314.  
  315.                                                 2.2. INSTALLING THE COMPILER.
  316.  
  317.  
  318. Installing under DOS
  319. Mandatory installation steps.
  320.  
  321. First, you must get the latest distribution files of Free Pascal. They come as zip
  322. files, which you must unzip first, or you can download the compiler as a series
  323. of separate files. This is especially useful if you have a slow connection, but it is
  324. also nice if you want to install only some pats of the compiler distribution. The
  325. distribution zip file contains an installation program INSTALL.EXE. You must run
  326. this program to install the compiler.
  327. The screen of the installation program looks like figure 2.1.
  328. The program allows you to select:
  329.  
  330.    * What components you wish to install. e.g do you want the sources or not, do
  331.      you want docs or not. Items that you didn't download when downloading as
  332.      separate files, will not be enabled, i.e. you can't select them.
  333.    * Where you want to install (the default location is C:\PP).
  334.  
  335. In order to run Free Pascal from any directory on your system, you must extend
  336. your path variable to contain the C:\PP\BIN directory. Usually this is done in the
  337. AUTOEXEC.BAT file. It should look something like this :
  338.  
  339.   SET PATH=%PATH%;C:\PP\BIN
  340.  
  341. (Again, assuming that you installed in the default location).
  342. If you want to use the graphic drivers you must modify the environment variable
  343. GO32. Instructions for doing this can be found in the documentation of the Graph
  344. unit, at the InitGraph procedure.
  345.  
  346. Optional Installation: The coprocessor emulation
  347.  
  348. For people who have an older CPU type, without math coprocessor (i387) it is
  349. necessary to install a coprocessor emulation, since Free Pascal uses the coprocessor
  350. to do all floating point operations.
  351. The installation of the coprocessor emulation is handled by the installation program
  352. (INSTALL.EXE). However,
  353.  
  354.  
  355. Installing under Linux
  356. Mandatory installation steps.
  357.  
  358. The linux distribution of Free Pascal comes in three forms:
  359.  
  360.    * a tar.gz version, also available as seperate files.
  361.    * a .rpm (Red Hat Package Manager) version, and
  362.    * a .deb (debian) version.
  363.  
  364. All of these packages contain a ELF version of the compiler binaries and units. the
  365. older aout binaries are no longer distributed, although you still can use the comiler
  366. on an aout system if you recompile it.
  367. If you use the .rpm format, installation is limited to
  368.  
  369.                                            7
  370.  
  371.  
  372.  
  373.                          2.2. INSTALLING THE COMPILER.
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381. Figure 2.1: The dos install program screen.
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.                     8
  428.  
  429.  
  430.  
  431.                                                    2.2. INSTALLING THE COMPILER.
  432.  
  433.  
  434. rpm -i fpc-pascal-XXX.rpm
  435.  
  436. (XXX is the version number of the .rpm file)
  437. If you use debian, installation is limited to
  438.  
  439. dpkg -i fpc-XXX.deb
  440.  
  441. Here again, XXX is the version number of the .deb file.
  442. You need root access to install these packages. The .tar file allows you to do an
  443. installation if you don't have root permissions.
  444. When downloading the .tar file, or the separate files, installation is more interac-
  445. tive.
  446. In case you downloaded the .tar file, you should first untar the file, in some directory
  447. where you have write permission, using the following command:
  448.  
  449. tar -xvf fpc.tar
  450.  
  451. We supposed here that you downloaded the file fpc.tar somewhere from the Internet.
  452. (The real filename will have some version number in it, which we omit here for
  453. clarity.)
  454. When the file is untarred, you will be left with more archive files, and an install
  455. program: an installation shell script.
  456. If you downloaded the files as separate files, you should at least download the
  457. install.sh script, and the libraries (in libs.tar.gz).
  458. To install Free Pascal, all that you need to do now is give the following command:
  459.  
  460. ./install.sh
  461.  
  462. And then you must answer some questions. They're very simple, they're mainly
  463. concerned with 2 things :
  464.  
  465.    1. Places where you can install di erent things.
  466.  
  467.    2. Deciding if you want to install certain components (such as sources and demo
  468.          programs).
  469.  
  470. The script will automatically detect which components are present and can be
  471. installed. It will only o er to install what has been found. because of this feature,
  472. you must keep the original names when downloading, since the script expects this.
  473. If you run the installation script as the root user, you can just accept all installation
  474. defaults. If you don't run as root, you must take care to supply the installation
  475. program with directory names where you have write permission, as it will attempt
  476. to create the directories you specify. In principle, you can install it wherever you
  477. want, though.
  478. At the end of installation, the installation program will generate a configuration
  479. file for the Free Pascal compiler which reflects the settings that you chose. It will
  480. install this file in the /etc directory, (if you are not installing as root, this will fail),
  481. and in the directory where you installed the libraries.
  482. If you want the Free Pascal compiler to use this configuration file, it must be present
  483. in /etc, or you can set the environment variable PPC CONFIG PATH. Under csh, you
  484. can do this by adding a
  485.  
  486.                                               9
  487.  
  488.  
  489.  
  490.                                         2.3. OPTIONAL CONFIGURATION STEPS
  491.  
  492.  
  493. setenv PPC_CONFIG_PATH /usr/lib/ppc/0.99.1
  494.  
  495. line to your .login file in your home directory. (see also the next section)
  496.  
  497.  
  498. 2.3 Optional configuration steps
  499.  
  500. You may wish to set some environment variables. The Free Pascal compiler recog-
  501. nizes the following variables :
  502.  
  503.    * PPC_EXEC_PATH contains the directory where 'as' and 'ld' are. (default /usr/bin)
  504.  
  505.    * PPC_GCCLIB_PATH contains the directory where libgcc.a is (no default). This
  506.       if for linux only.
  507.  
  508.    * PPC_CONFIG_PATH specifies an alternate path to find ppc386.cfg (default under
  509.       linux is /etc)
  510.  
  511.    * PPC_ERROR_FILE specifies the path and name of the error-definition file. (de-
  512.       fault /usr/lib/fpc/errorE.msg)
  513.  
  514. These locations are, however, set in the sample configuration file which is built at
  515. the end of the installation process, except for the PPC_CONFIG_PATH variable, which
  516. you must set if you didn't install things in the default places.
  517.  
  518. finally
  519.  
  520. Also distributed in Free Pascal is a README file. It contains the latest instructions
  521. for installing Free Pascal, and should always be read first.
  522.  
  523.  
  524. 2.4 Testing the compiler
  525.  
  526. After the installation is completed and the environment variables are set as described
  527. above, your first program can be compiled.
  528. Included in the Free Pascal distribution are some demonstration programs, showing
  529. what the compiler can do. You can test if the compiler functions correctly by trying
  530. to compile these programs.
  531. The compiler is called
  532.  
  533.    * PPC386.EXE under dos, and
  534.  
  535.    * ppc386 under linux
  536.  
  537. To compile a program (e.g demo\hello.pp) simply type :
  538.  
  539.   ppc386 hello
  540.  
  541. at the command prompt. If you don't have a configuration file, then you may need
  542. to tell the compiler where it can find the units, for instance as follows:
  543.  
  544. ppc386 -Upc:\pp\rtl\dos\go32v2 hello
  545.  
  546. under dos, and under linux you could type
  547.  
  548.                                            10
  549.  
  550.  
  551.  
  552.                                                   2.4. TESTING THE COMPILER
  553.  
  554.  
  555. ppc386 -Up/usr/lib/fpc/0.99.7/linuxunits hello
  556.  
  557. This is, of course, assuming that you installed under C:\PP or /usr/lib/fpc/0.99.7,
  558. respectively.
  559. If you got no error messages, the compiler has generated an executable called hello
  560. (no extension) under linux, and a file hello.exe under dos.
  561. To execute the program, simply type :
  562.  
  563.   hello
  564.  
  565. If all went well, you should see the following friendly greeting:
  566.  
  567. Hello world
  568.  
  569. In the dos case, this friendly greeting may be preceded by some ugly message from
  570. the GO32 extender program. This unfriendly behavior can be switched o  by setting
  571. the GO32 environment variable.
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.                                           11
  608.  
  609.  
  610.  
  611. Chapter 3
  612.  
  613. Compiler usage
  614.  
  615. Here we describe the essentials to compile a program and a unit. We also describe
  616. how to make a stand-alone executable of the compiled program under dos. For
  617. more advanced uses of the compiler, see the section on configuring the compiler,
  618. and the Programmers' guide.
  619. The examples in this section suppose that you have a ppc386.cfg which is set up
  620. correctly, and which contains at least the path setting for the RTL units. In principle
  621. this file is generated by the installation program. You may have to check that it is
  622. in the correct place (see section 5.2 for more information on this).
  623.  
  624.  
  625. 3.1 File searching
  626.  
  627. Before you start compiling a program or a series of units, it is important to know
  628. where the compiler looks for its source files and other files. In this section we discuss
  629. this, and we indicate how to influence this.
  630. Remark: The use of slashes (/) and backslashes (\) as directory separators is ir-
  631. relevant, the compiler will convert to whatever character is used on the current
  632. operating system. Examples will be given using slashes, since this avoids problems
  633. on linux.
  634.  
  635.  
  636. Command line files
  637. The file that you specify on the command line, such as in
  638.  
  639. ppc386 foo.pp
  640.  
  641. will be looked for ONLY in the current directory. If you specify a directory in the
  642. filename, then the compiler will look in that directory:
  643.  
  644. ppc386 subdir/foo.pp
  645.  
  646. will look for foo.pp in the subdirectory subdir of the current directory.
  647. Under linux, the name of this file is case sensitive, under other operating systems
  648. (dos, Windows NT, os/2) this is not the case.
  649.  
  650.  
  651.  
  652.                                            12
  653.  
  654.  
  655.  
  656.                                                                3.2. INCLUDE FILES
  657.  
  658.  
  659. Unit files
  660. When you compile a unit or program that needs other units, the compiler will look
  661. for compiled versions of these units in the following way:
  662.  
  663.    1. It will look in the current directory.
  664.  
  665.    2. It will look in the directory where the compiler binary is. (not under linux)
  666.  
  667.    3. It will look in all the directories specified in the unit search path.
  668.  
  669. You can add a directory to the unit search path with the -Up or -Fu options (See
  670. ??, See 5.1). Every occurrence of one of those options will append a directory to
  671. the unit search path.
  672. On linux, the compiler will first convert the filename of a unit to all-lowercase. This
  673. is necessary, since Pascal is case-independent, and the statements Uses Unit1; or
  674. uses unit1; should have the same e ect. Also, unit names that are longer than
  675. 8 characters will first be looked for with their full length. If the unit is not found
  676. with this name, the name will be truncated to 8 characters, and the compiler will
  677. look again in the same directories, but with the truncated name.
  678. For instance, suppose that the file foo.pp needs the unit bar. Then the command
  679.  
  680. ppc386 -Up.. -Upunits foo.pp
  681.  
  682. will tell the compiler to look for the unit bar in the following places:
  683.  
  684.    1. In the current directory.
  685.  
  686.    2. In the directory where the compile binary is (not under linux).
  687.  
  688.    3. In the parent directory of the current directory.
  689.  
  690.    4. In the subdirectory units of the current directory
  691.  
  692. If the compiler finds the unit it needs, it will look for the source file of this unit in
  693. the same directory where it found the unit. If it finds the source of the unit, then
  694. it will compare the file times. If the source file was modified more recent than the
  695. unit file, the compiler will attempt to recompile the unit with this source file.
  696. If the compiler doesn't find a compiled version of the unit, or when the -B option
  697. is specified, then the compiler will look in the same manner for the unit source file,
  698. and attempt to recompile it.
  699. It is recommended to set the unit search path in the configuration file ppc386.cfg.
  700. If you do this, you don't need to specify the unit search path on the command-line
  701. every time you want to compile something.
  702.  
  703.  
  704. 3.2 Include files
  705.  
  706. If you include files in your source with the {$I filename} directive, the compiler
  707. will look for it in the following places:
  708.  
  709.    1. It will look in the path specified in the incude file name.
  710.  
  711.    2. It will look in the directory where the current source file is.
  712.  
  713.  
  714.                                              13
  715.  
  716.  
  717.  
  718.                                                                      3.3. OBJECT FILES
  719.  
  720.  
  721.    3. it will look in all directories specified in the include file search path.
  722.  
  723. You can add files to the include file search path with the -I (See 5.1) option.
  724. As an example, consider the following include statement in a file units/foo.pp:
  725.  
  726.  
  727. {$i ../bar.inc}
  728.  
  729.  
  730. Then the following command :
  731.  
  732. ppc386 -Iincfiles units/foo.pp
  733.  
  734. will cause the compiler to look in the following directories for bar.inc:
  735.  
  736.    1. the parent directory of the current directory
  737.  
  738.    2. the units subdirectory of the current directory
  739.  
  740.    3. the incfiles directory of the current directory.
  741.  
  742.  
  743. 3.3 Object files
  744.  
  745. When you link to object files (using the {$L file.o} directive, the compiler will
  746. look for this file in the same way as it looks for include files:
  747.  
  748.    1. It will look in the path specified in the object file name.
  749.  
  750.    2. It will look in the directory where the current source file is.
  751.  
  752.    3. it will look in all directories specified in the object file search path.
  753.  
  754. You can add files to the object file search path with the -Fo (See 5.1) option.
  755.  
  756.  
  757. Configuration file
  758. Unless you specify the -n (See 5.1) option, the compiler will look for a configuration
  759. file ppc386.cfg in the following places:
  760.  
  761.    * Under linux
  762.  
  763.         1. The current directory.
  764.         2. In your home directory, it looks for .ppc386.cfg.
  765.         3. The directory specified in the environment variable PPC CONFIG PATH,
  766.            and if it's not set under /etc.
  767.  
  768.    * Under all other OSes:
  769.  
  770.         1. The current directory.
  771.         2. If it is set, the directory specified in the environment variable. PPC CONFIG PATH.
  772.         3. The directory where the compiler is.
  773.  
  774.  
  775.                                               14
  776.  
  777.  
  778.  
  779.                                                      3.4. COMPILING A PROGRAM
  780.  
  781.  
  782. 3.4 Compiling a program
  783.  
  784. Compiling a program is very simple. Assuming that you have a program source in
  785. the file prog.pp, you can compile this with the following command:
  786.  
  787.   ppc386 [options] prog.pp
  788.  
  789. The square brackets [ ] indicate that what is between them is optional.
  790. If your program file has the .pp or .pas extension, you can omit this on the command
  791. line, e.g. in the previous example you could have typed:
  792.  
  793.   ppc386 [options] prog
  794.  
  795. If all went well, the compiler will produce an executable, or, for version 1 of the
  796. dos extender, a file which can be converted to an executable.
  797. Unless you are using dos and version 1 of the dos extender, the file you obtained
  798. is the executable. You can execute it straight away, you don't need to do anything
  799. else. Under version 1 of the dos extender, additional processing is required. See
  800. section 3.6 on how to create an executable in this case.
  801. You will notice that there is also another file in your directory, with extensions .o.
  802. This contains the object file for your program. If you compiled a program, you
  803. can delete the object file (.o), but not if you compiled a unit. Then the object file
  804. contains the code of the unit, and will be linked in any program that uses the unit
  805. you compiled, so you shouldn't remove it.
  806.  
  807.  
  808. 3.5 Compiling a unit
  809.  
  810. Compiling a unit is not essentially di erent from compiling a program. The di er-
  811. ence is mainly that the linker isn't called in this case.
  812. To compile a unit in the file foo.pp, just type :
  813.  
  814.   ppc386 foo
  815.  
  816. Recall the remark about file extensions in the previous section.
  817. When all went well, you will be left with 2 (two) unit files:
  818.  
  819.   1. foo.ppu This is the file describing the unit you just compiled.
  820.  
  821.   2. foo.o This file contains the actual code of the unit. This file will eventually
  822.       end up in the executables.
  823.  
  824. Both files are needed if you plan to use the unit for some programs. So don't delete
  825. them. If you want to distribute the unit, you must provide both the .ppu and .o
  826. file. One is useless without the other.
  827. Remark: Under linux, a unit source file must have a lowercase filename. Since
  828. Pascal is case independent, you can specify the names of units in the uses clause in
  829. either case. To get a unique filename, the Free Pascal compiler changes the name
  830. of the unit to all lowercase when looking for unit files.
  831. The compiler produces lowercase files, so your unit will be found, even if your source
  832. file has uppercase letters in it. Only when the compiler tries to recompile the unit,
  833. it will not find your source because of the uppercase letters.
  834.  
  835.                                            15
  836.  
  837.  
  838.  
  839.              3.6. CREATING AN EXECUTABLE FOR GO32V1 AND PMODE/DJ
  840.                                                                         TARGETS
  841.  
  842. 3.6 Creating an executable for GO32V1 and PMODE/DJ
  843.              targets
  844.  
  845. The GO32V1 platform is o cially no longer supported, so this section is of interest
  846. only to people who wish to make go32V1 binaries anyway.
  847.  
  848.  
  849. GO32V1
  850. When compiling under dos, GO32V2 is the default target. However, if you use
  851. go32V1 (using the -TGO32V1 switch), the compilation process leaves you with a file
  852. which you cannot execute right away. There are 2 things you can do when compiling
  853. has finished.
  854. The first thing is to use the dos extender from D.J. Delorie to execute your program
  855. :
  856.  
  857.      go32 prog
  858.  
  859. This is fine for testing, but if you want to use a program regularly, it would be
  860. easier if you could just type the program name, i.e.
  861.  
  862.      prog
  863.  
  864. This can be accomplished by making a dos executable of your compiled program.
  865. There two ways to create a dos executable (under dos only):
  866.  
  867.      1. if the GO32.EXE is already installed on the computers where the program
  868.        should run, you must only copy a program called STUB.EXE at the begin
  869.        of the AOUT file. This is accomplished with the AOUT2EXE.EXE program.
  870.        which comes with the compiler:
  871.  
  872.        AOUT2EXE PROG
  873.  
  874.        and you get a dos executable which loads the GO32.EXE automatically. the
  875.        GO32.EXE executable must be in current directory or be in a directory in the
  876.        PATH variable.
  877.      2. The second way to create a dos executable is to put GO32.EXE at the begin-
  878.        ning of the AOUT file. To do this, at the command prompt, type :
  879.  
  880.        COPY /B GO32.EXE+PROG PROG.EXE
  881.  
  882.        (assuming Free Pascal created a file called PROG, of course.) This becomes
  883.        then a stand-alone executable for dos, which doesn't need the GO32.EXE on
  884.        the machine where it should run.
  885.  
  886.  
  887. PMODE/DJ
  888. You can also use the PMODE/DJ extender to run your Free Pascal applications. To
  889. make an executable which works with the PMODE extender, you can simply create
  890. an GO32V2 executable (the default), and then convert it to a PMODE executable
  891. with the following two extra commands:
  892.  
  893.      1. First, strip the GO32V2 header of the executable:
  894.  
  895.                                            16
  896.  
  897.  
  898.  
  899.                               3.7. REDUCING THE SIZE OF YOUR PROGRAM
  900.  
  901.  
  902.      EXE2COFF PROG.EXE
  903.  
  904.      (we suppose that PROG.EXE is the program generated by the compilation
  905.      process.
  906.  
  907.   2. Secondly, add the PMODE stub:
  908.  
  909.      COPY /B PMODSTUB.EXE+PROG PROG.EXE
  910.  
  911.      If the PMODSTUB.EXE file isn't in your local directory, you need to supply
  912.      the whole path to it.
  913.  
  914. That's it. No additional steps are needed to create a PMODE extender executable.
  915. Be aware, though, that the PMODE extender doesn't support virtual memory, so
  916. if you're short on memory, you may run unto trouble. Also, o cially there is not
  917. support for the PMODE/DJ extender. It just happens that the compiler and some
  918. of the programs it generates, run under this extender too.
  919.  
  920.  
  921. 3.7 Reducing the size of your program
  922.  
  923. When you created your program, it is possible to reduce its size. This is possible,
  924. because the compiler leaves a lot of information in the program which, strictly
  925. speaking, isn't required for the execution of it. The surplus of information can be
  926. removed with a small program called strip. It comes with the GO32 development
  927. environment under dos, and is standard on linux machines where you can do
  928. development. The usage is simple. Just type
  929.  
  930. strip prog
  931.  
  932. On the command line, and the strip program will remove all unnecessary information
  933. from your program. This can lead to size reductions of up to 30 %.
  934. remark: in the Win32 32 version, strip is called stripw
  935. You can use the -Xs switch to let the compiler do this stripping automatically at
  936. program compile time (the switch has no e ect when compiling units).
  937. Another technique to reduce the size of a program is to use smartlinking. Normally,
  938. units (including the system unit) are linked in as a whole. It is however possible to
  939. compile units such that the can be smartlinked. This means that only the functions
  940. and procedures are linked in your program, leaving out any unnecessary code. This
  941. technique is described in full in the programmers guide.
  942.  
  943.  
  944.  
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.  
  954.  
  955.                                          17
  956.  
  957.  
  958.  
  959. Chapter 4
  960.  
  961. Compiling problems
  962.  
  963. 4.1 General problems
  964.  
  965.  * IO-error -2 at ... : Under linux you can get this message at compiler
  966.    startup. It means typically that the compiler doesn't find the error definitions
  967.    file. You can correct this mistake with the -Fr option under linux. (See 5.1)
  968.  
  969.  * Error : File not found : xxx or Error: couldn't compile unit xxx:
  970.    This typically happens when your unit path isn't set correctly. Remember
  971.    that the compiler looks for units only in the current directory, and in the
  972.    directory where the compiler itself is. If you want it to look somewhere else
  973.    too, you must explicitly tell it to do so using the -Up option (See ??). Or you
  974.    must set op a configuration file.
  975.  
  976.  
  977. 4.2 Problems you may encounter under DOS
  978.  
  979.  * No space in environment.
  980.    An error message like this can occur, if you call SET_PP.BAT in the AU-
  981.    TOEXEC.BAT.
  982.    To solve this problem, you must extend your environment memory. To do
  983.    this, search a line in the CONFIG.SYS like
  984.  
  985.    SHELL=C:\DOS\COMMAND.COM
  986.  
  987.    and change it to the following:
  988.  
  989.    SHELL=C:\DOS\COMMAND.COM /E:1024
  990.  
  991.    You may just need to specify a higher value, if this parameter is already set.
  992.  
  993.  * Coprocessor missing
  994.    If the compiler writes a message that there is no coprocessor, install the co-
  995.    processor emulation.
  996.  
  997.  * Not enough DPMI memory
  998.    If you want to use the compiler with DPMI you must have at least 7-8 MB free
  999.    DPMI memory, but 16 Mb is a more realistic amount.
  1000.  
  1001.  
  1002.                                         18
  1003.  
  1004.  
  1005.  
  1006. Chapter 5
  1007.  
  1008. Compiler configuration
  1009.  
  1010. The output of the compiler can be controlled in many ways. This can be done
  1011. essentially in two distinct ways:
  1012.  
  1013.    * Using command-line options.
  1014.  
  1015.    * Using the configuration file: ppc386.cfg.
  1016.  
  1017. The compiler first reads the configuration file. Only then the command line options
  1018. are checked. This creates the possibility to set some basic options in the configura-
  1019. tion file, and at the same time you can still set some specific options when compiling
  1020. some unit or program. First we list the command line options, and then we explain
  1021. how to specify the command line options in the configuration file. When reading
  1022. this, keep in mind that the options are case sensitive. While this is customary for
  1023. linux, it isn't under dos.
  1024.  
  1025.  
  1026. 5.1 Using the command-line options
  1027.  
  1028. The available options for version 0.99.10 of the compiler are listed by category (see
  1029. appendix A for a listing as generated by the compiler):
  1030.  
  1031.  
  1032. General options
  1033. -h if you specify this option, the compiler outputs a list of all options, and exits
  1034.      after that.
  1035.  
  1036. -? idem as -h, waiting after every screenfull for the enter key.
  1037.  
  1038. -i This option tells the compiler to print the copyright information. You can give
  1039.      it an option, as -ixxx where xxx can be one of the following:
  1040.  
  1041.      D : Returns the compiler date.
  1042.      V : Returns the compiler version.
  1043.      SO : Returns the compiler OS.
  1044.      SP : Returns the compiler processor.
  1045.      TO : Returns the target OS.
  1046.      TP : Returns the target Processor.
  1047.  
  1048.                                           19
  1049.  
  1050.  
  1051.  
  1052.                                           5.1. USING THE COMMAND-LINE OPTIONS
  1053.  
  1054.  
  1055. -l This option tells the compiler to print the Free Pascal logo on standard output.
  1056.      It also gives you the Free Pascal version number.
  1057.  
  1058. -n Tells the compiler not to read default the configuration file. You can still pass
  1059.      a configuration file with the @ option.
  1060.  
  1061.  
  1062. Options for getting feedback
  1063. -vxxx Be verbose. xxx is a combination of the following :
  1064.  
  1065.         * e : Tells the compiler to show only errors. This option is on by default.
  1066.         * i : Tells the compiler to show some general information.
  1067.         * w : Tells the compiler to issue warnings.
  1068.         * n : Tells the compiler to issue notes.
  1069.         * h : Tells the compiler to issue hints.
  1070.         * l : Tells the compiler to show the line numbers as it processes a file.
  1071.                Numbers are shown per 100.
  1072.         * u : Tells the compiler to print the names of the files it opens.
  1073.         * t : Tells the compiler to print the names of the files it tries to open.
  1074.         * p : Tells the compiler to print the names of procedures and functions as
  1075.                it is processing them.
  1076.         * c : Tells the compiler to warn you when it processes a conditional.
  1077.         * m : Tells the compiler to write which macros are defined.
  1078.         * d : Tells the compiler to write other debugging info.
  1079.         * a : Tells the compiler to write all possible info. (this is the same as
  1080.                specifying all options)
  1081.         * 0 : Tells the compiler to write no messages. This is useful when you
  1082.                want to override the default setting in the configuration file.
  1083.         * b : Tells the compiler to show all procedure declarations if an overloaded
  1084.                function error occurs.
  1085.         * x : Tells the compiler to output some executable info (for Win32 platform
  1086.                only).
  1087.         * r : Rhide/GCC compatibility mode: formats the errors di erently, so
  1088.                they are understood by RHIDE.
  1089.  
  1090.  
  1091. Options concerning files and directories
  1092. -exxx xxx specifies the directory where the compiler can find the executables as
  1093.      (the assembler) and ld (the compiler).
  1094.  
  1095. -FD same as -e.
  1096.  
  1097. -Fexxx This option tells the compiler to write errors, etc. to the file in xxx.
  1098.  
  1099. -Flxxx Adds xxx to the library searching path, and is passed to the linker.
  1100.  
  1101. -FLxxx (linux only) Tells the compiler to use xxx as the dynamic linker. Default
  1102.      this is /lib/ld-linux.so.2, or lib/ld-linux.so.1, depending on which one is found
  1103.      first.
  1104.  
  1105.  
  1106.                                               20
  1107.  
  1108.  
  1109.  
  1110.                                     5.1. USING THE COMMAND-LINE OPTIONS
  1111.  
  1112.  
  1113. -Foxxx Adds xxx to the object file path. This path is used when looking for files
  1114.       that need to be linked in.
  1115.  
  1116. -Frxxx xxx specifies the file which contain the compiler messages. Default the
  1117.       compiler ahs built-in messages. Specifying this option will override the default
  1118.       messages.
  1119.  
  1120. -Fuxxx Add xxx to the unit path. Units are loaded from the current directory if
  1121.       they exist, and then in the unit path. You must always supply the unit path
  1122.       to the system unit.
  1123.  
  1124. -FUxxx Tells the compiler to write units in directory xxx instead of the current
  1125.       directory.
  1126.  
  1127. -Ixxx Add xxx to the include file search path. This path is used when looking for
  1128.       include files. This option is obsolite, use -Fi instead.
  1129.  
  1130. -P uses pipes instead of files when assembling. This may speed up the compiler
  1131.       on os/2 and linux. Only with assemblers (such as gnu as) that support
  1132.       piping...
  1133.  
  1134.  
  1135. Options controlling the kind of output.
  1136. for more information on these options, see also Programmers' guide
  1137.  
  1138. -a Tells the compiler not to delete the assembler files it generates (not when using
  1139.       the internal assembler). This also counts for the (possibly) generated batch
  1140.       script.
  1141.  
  1142. -al Tells the compiler to include the sourcecode lines in the assembler file as com-
  1143.       ments. This feature is still experimental, and should be used with caution.
  1144.  
  1145. -ar tells the compiler to list register allocation and release info in the assembler file.
  1146.       This is primarily intended for debugging the code generated bythe compiler.
  1147.  
  1148. -at tells the compiler to list information about temporary allocations and deallo-
  1149.       cations in the assembler file.
  1150.  
  1151. -Axxx specifies what kind of assembler should be generated . Here xxx is one of
  1152.       the following :
  1153.  
  1154.          * o : A unix co  object file, using the gnu assembler as.
  1155.          * nasmco  : a co  file using the nasm assembler.
  1156.          * nasmelf : a ELF32 file (linux only) using the nasm assembler.
  1157.          * nasmonj : a obj file using the nasm assembler.
  1158.          * masm : An obj file using the Microsoft masm assembler.
  1159.          * tasm : An obj file using the Borland tasm assembler.
  1160.  
  1161. -B tells the compiler to re-compile all used units, even if the unit sources didn't
  1162.       change since the last compilation.
  1163.  
  1164. -b tells the compiler to generate browser info. This information can be used by
  1165.       an Integrated Development Environment (IDE) to provide information on
  1166.       classes, objects, procedures, types and variables in a unit.
  1167.  
  1168. -bl is the same as -b but also generates information about local variables, types
  1169.       and procedures.
  1170.  
  1171.                                             21
  1172.  
  1173.  
  1174.  
  1175.                                      5.1. USING THE COMMAND-LINE OPTIONS
  1176.  
  1177.  
  1178. -CD Create a dynamic library. This is used to transform units into dynamically
  1179.      linkable libraries on linux.
  1180.  
  1181. -Chxxx Reserves xxx bytes heap. xxx should be between 1024 and 67107840.
  1182.  
  1183. -Ci Generate Input/Output checking code. In case some input/output code of your
  1184.      program returns an error status, the program will exit with a run-time error.
  1185.      Which error is generated depends on the I/O error.
  1186.  
  1187. -Cn Omit the linking stage.
  1188.  
  1189. -Co Generate Integer overflow checking code. In case of integer errors, a run-time
  1190.      error will be generated by your program.
  1191.  
  1192. -Cr Generate Range checking code. In case your program acesses an array element
  1193.      with an invalid index, or if it increases an enumerated type beyond it's scope,
  1194.      a run-time error will be generated.
  1195.  
  1196. -Csxxx Set stack size to xxx.
  1197.  
  1198. -CS Create static library.
  1199.  
  1200. -Ct generate stack checking code. In case your program performs a faulty stack
  1201.      operation, a run-rime error will be generated.
  1202.  
  1203. -Cx Use smartlinking when compiling and linking units. smartlinking will only
  1204.      link in the code parts that are actually needed by the program. All unused
  1205.      code is left out. This can lead to substantially smaller binaries.
  1206.  
  1207. -dxxx Define the symbol name xxx. This can be used to conditionally compile
  1208.      parts of your code.
  1209.  
  1210.  -E Same as -Cn.
  1211.  
  1212. -g Generate debugging information for debugging with gdb
  1213.  
  1214. -gg idem as -g.
  1215.  
  1216. -gd generate debugging info for dbx.
  1217.  
  1218. -gh use the heaptrc unit (see Unit reference).
  1219.  
  1220. -Oxxx optimize the compiler's output; xxx can have one of the following values :
  1221.  
  1222.      g optimize for size, try to generate smaller code.
  1223.      G optimize for time, try to generate faster code (default).
  1224.      r keep certain variables in registers (experimental, use with caution).
  1225.      u Uncertain optimizations
  1226.      1 Level 1 optimizations (quick optimizations).
  1227.      2 Level 2 optimizations (-O1 plus some slower optimizations).
  1228.      3 Level 3 optimizations (-O2 plus -Ou).
  1229.      Pn (Intel only) Specify processor: n can be one of
  1230.           1 optimize for 386/486
  1231.           2 optimize for Pentium/PentiumMMX (tm)
  1232.           3 optimizations for PentiumPro/PII/Cyrix 6x86/K6 (tm)
  1233.  
  1234.      The exact e ect of these e ects can be found in the Programmers' guide.
  1235.  
  1236.                                          22
  1237.  
  1238.  
  1239.  
  1240.                                        5.1. USING THE COMMAND-LINE OPTIONS
  1241.  
  1242.  
  1243. -oxxx Tells the compiler to use xxx as the name of the output file (executable).
  1244.      Only with programs.
  1245.  
  1246. -pg Generate profiler code for gprof.
  1247.  
  1248. -s Tells the compiler not to call the assembler and linker. Instead, the compiler
  1249.      writes a script, PPAS.BAT under dos, or ppas.sh under linux, which can
  1250.      then be executed to produce an executable. This can be used to speed up the
  1251.      compiling process or to debug the compiler's output.
  1252.  
  1253. -Txxx Specifies the target operating system. xxx can be one of the following:
  1254.  
  1255.         * GO32V1 : dos and version 1 of the DJ DELORIE extender (no longer
  1256.            maintained).
  1257.         * GO32V2 : dos and version 2 of the DJ DELORIE extender.
  1258.         * LINUX : linux.
  1259.         * OS2 : OS/2 (2.x) using the EMX extender.
  1260.         * WIN32 : Windows 32 bit.
  1261.  
  1262. -uxxx undefine the symbol xxx. This is the opposite of the -d option.
  1263.  
  1264. -uxxx Undefine symbol xxx.
  1265.  
  1266. -Xx executable options. This tells the compiler what kind of executable should be
  1267.      generated. the parameter x can be one of the following:
  1268.  
  1269.         * c : (linux only) Link with the C library. You should only use this when
  1270.            you start to port Free Pascal to another operating system.
  1271.         * D : Link with dynamic libraries (defines the FPC LINK DYNAMIC symbol)
  1272.         * s : Strip the symbols from the executable.
  1273.         * S : Link with static libraries (defines the FPC LINK STATIC symbol)
  1274.  
  1275.  
  1276. Options concerning the sources (language options)
  1277. for more information on these options, see also Programmers' guide
  1278.  
  1279. -Rxxx Specifies what kind of assembler you use in your asm assembler code blocks.
  1280.      Here xxx is one of the following:
  1281.  
  1282.      att asm blocks contain AT&T-style assembler. This is the default style.
  1283.      intel asm blocks contain Intel-style assembler.
  1284.      direct asm blocks should be copied as-is in the assembler, only replacing
  1285.            certain variables. file.
  1286.  
  1287. -S2 Switch on Delphi 2 extensions. This is di erent from -Sd because some Free
  1288.      Pascal constructs are still available to you.
  1289.  
  1290. -Sc Support C-style operators, i.e. *=, +=, /= and -=.
  1291.  
  1292. -Sd Tells the compiler to be Delphi compatible. This is more strict than the -S2
  1293.      option, since some fpc extensions are switched o .
  1294.  
  1295. -Se The compiler stops after the first error. Normally, the compiler tries to continue
  1296.      compiling after an error, until 50 errors are reached, or a fatal error is reached,
  1297.      and then it stops. With this switch, the compiler will stop after the first error.
  1298.  
  1299.                                            23
  1300.  
  1301.  
  1302.  
  1303.                                        5.2. USING THE CONFIGURATION FILE
  1304.  
  1305.  
  1306. -Sg Support the label and goto commands. By default these are not supported.
  1307.       You must also specify this option if you use labels in assembler statements.
  1308.       (if you use the AT&T style assember)
  1309.  
  1310. -Sh Use ansistrings by default for strings. If this keyword is specified, the compiler
  1311.       will interpret the string keyword as a ansistring. Otherwise it is supposed
  1312.       to be a short strings (TP style).
  1313.  
  1314. -Si Support C++ style INLINE.
  1315.  
  1316. -Sm Support C-style macros.
  1317.  
  1318. -So Try to be Borland TP 7.0 compatible (no function overloading etc.).
  1319.  
  1320. -Sp Try to be gpc (gnu pascal compiler) compatible.
  1321.  
  1322. -Ss The name of constructors must be init, and the name of destructors should
  1323.       be done.
  1324.  
  1325. -St Allow the static keyword in objects.
  1326.  
  1327. -Un Do not check the unit name. Normally, the unit name is the same as the
  1328.       filename. This option allows both to be di erent.
  1329.  
  1330. -Us Compile a system unit. This option causes the compiler to define only some
  1331.       very basic types.
  1332.  
  1333.  
  1334. 5.2 Using the configuration file
  1335.  
  1336. Using the configuration file ppc386.cfg is an alternative to command line options.
  1337. When a configuration file is found, it is read, and the lines in it are treated like you
  1338. typed them on the command line. They are treated before the options that you
  1339. type on the command line.
  1340. You can specify comments in the configuration file with the # sign. Everything from
  1341. the # on will be ignored.
  1342. The compiler looks for the ppc386.cfg file in the following places :
  1343.  
  1344.    * Under linux
  1345.  
  1346.         1. The current directory.
  1347.         2. In your home directory, it looks for .ppc386.cfg.
  1348.         3. The directory specified in the environment variable PPC CONFIG PATH,
  1349.            and if it's not set under /etc.
  1350.  
  1351.    * Under all other OSes:
  1352.  
  1353.         1. The current directory.
  1354.         2. If it is set, the directory specified in the environment variable. PPC CONFIG PATH.
  1355.         3. The directory where the compiler is.
  1356.  
  1357. When the compiler has finished reading the configuration file, it continues to treat
  1358. the command line options.
  1359. One of the command-line options allows you to specify a second configuration file:
  1360. Specifying @foo on the command line will open file foo, and read further options
  1361.  
  1362.  
  1363.                                               24
  1364.  
  1365.  
  1366.  
  1367.                                       5.2. USING THE CONFIGURATION FILE
  1368.  
  1369.  
  1370. from there. When the compiler has finished reading this file, it continues to process
  1371. the command line.
  1372. The configuration file allows some kind of preprocessing. It understands the follow-
  1373. ing directives, which you should place on the first column of a line :
  1374.  
  1375. #IFDEF
  1376. #IFNDEF
  1377. #ELSE
  1378. #ENDIF
  1379. #DEFINE
  1380. #UNDEF
  1381. #WRITE
  1382. #INCLUDE
  1383. #SECTION
  1384.  
  1385. They work the same way as their {$...} counterparts in Pascal.
  1386. What follows is a description of the di erent directives.
  1387.  
  1388.  
  1389. #IFDEF
  1390. Syntax:
  1391.  
  1392. #IFDEF name
  1393.  
  1394. Lines following #IFDEF are skipped read if the keyword name following it is not
  1395. defined.
  1396. They are read until the keywords #ELSE or #ENDIF are encountered, after which
  1397. normal processing is resumed.
  1398. Example :
  1399.  
  1400. #IFDEF VER0_99_5
  1401. -Up/usr/lib/fpc/0.99.5/linuxunits
  1402. #ENDIF
  1403.  
  1404. In the above example, /usr/lib/fpc/0.99.5/linuxunits will be added to the path if
  1405. you're compiling with version 0.99.5 of the compiler.
  1406.  
  1407.  
  1408. #IFNDEF
  1409. Syntax:
  1410.  
  1411. #IFNDEF name
  1412.  
  1413. Lines following #IFDEF are skipped read if the keyword name following it is defined.
  1414. They are read until the keywords #ELSE or #ENDIF are encountered, after which
  1415. normal processing is resumed.
  1416. Example :
  1417.  
  1418.                                          25
  1419.  
  1420.  
  1421.  
  1422.                                       5.2. USING THE CONFIGURATION FILE
  1423.  
  1424.  
  1425. #IFNDEF VER0_99_5
  1426. -Up/usr/lib/fpc/0.99.6/linuxunits
  1427. #ENDIF
  1428.  
  1429. In the above example, /usr/lib/fpc/0.99.6/linuxunits will be added to the path if
  1430. you're NOT compiling with version 0.99.5 of the compiler.
  1431.  
  1432.  
  1433. #ELSE
  1434. Syntax:
  1435.  
  1436. #ELSE
  1437.  
  1438. #ELSE can be specified after a #IFDEF or #IFNDEF directive as an alternative. Lines
  1439. following #ELSE are skipped read if the preceding #IFDEF #IFNDEF was accepted.
  1440. They are skipped until the keyword #ENDIF is encountered, after which normal
  1441. processing is resumed.
  1442. Example :
  1443.  
  1444. #IFDEF VER0_99_5
  1445. -Up/usr/lib/fpc/0.99.6/linuxunits
  1446. #ELSE
  1447. -Up/usr/lib/fpc/0.99.5/linuxunits
  1448. #ENDIF
  1449.  
  1450. In the above example, /usr/lib/fpc/0.99.5/linuxunits will be added to the path if
  1451. you're compiling with version 0.99.5 of the compiler, otherwise /usr/lib/fpc/0.99.6/linuxunits
  1452. will be added to the path.
  1453.  
  1454.  
  1455. #ENDIF
  1456. Syntax:
  1457.  
  1458. #ENDIF
  1459.  
  1460. #ENDIF marks the end of a block that started with #IF(N)DEF, possibly with an
  1461. #ELSE between it.
  1462.  
  1463.  
  1464. #DEFINE
  1465. Syntax:
  1466.  
  1467. #DEFINE name
  1468.  
  1469. #DEFINE defines a new keyword. This has the same e ect as a -dname command-line
  1470. option.
  1471.  
  1472.  
  1473. #UNDEF
  1474. Syntax:
  1475.  
  1476. #UNDEF name
  1477.  
  1478. #UNDEF un-defines a keyword if it existed. This has the same e ect as a -uname
  1479. command-line option.
  1480.  
  1481.                                          26
  1482.  
  1483.  
  1484.  
  1485.                                            5.2. USING THE CONFIGURATION FILE
  1486.  
  1487.  
  1488. #WRITE
  1489. Syntax:
  1490.  
  1491. #WRITE Message Text
  1492.  
  1493. #WRITE writes Message Text to the screen. This can be useful to display warnings
  1494. if certain options are set.
  1495. Example:
  1496.  
  1497. #IFDEF DEBUG
  1498. #WRITE Setting debugging ON...
  1499. -g
  1500. #ENDIF
  1501.  
  1502. if DEBUG is defined, this will produce a line
  1503.  
  1504. Setting debugging ON...
  1505.  
  1506. and will then switch on debugging information in the compiler.
  1507.  
  1508.  
  1509. #INCLUDE
  1510. Syntax:
  1511.  
  1512. #INCLUDE filename
  1513.  
  1514. #INCLUDE instructs the compiler to read the contents of filename before continuing
  1515. to process options in the current file.
  1516. This can be useful if you want to have a particular configuration file for a project
  1517. (or, under linux, in your home directory), but still want to have the global options
  1518. that are set in a global configuration file.
  1519. Example:
  1520.  
  1521. #IFDEF LINUX
  1522.       #INCLUDE /etc/ppc386.cfg
  1523. #ELSE
  1524.       #IFDEF GO32V2
  1525.         #INCLUDE c:\pp\bin\ppc386.cfg
  1526.       #ENDIF
  1527. #ENDIF
  1528.  
  1529. This will include /etc/ppc386.cfg if you're on a linux machine, and will include
  1530. c:\pp\bin\ppc386.cfg on a dos machine.
  1531.  
  1532.  
  1533. #SECTION
  1534. Syntax:
  1535.  
  1536. #SECTION name
  1537.  
  1538. The #SECTION directive acts as a #IFDEF directive, only it doesn't require an #ENDIF
  1539. directive. the special name COMMON always exists, i.e. lines following #SECTION
  1540. COMMON are always read.
  1541.  
  1542.                                              27
  1543.  
  1544.  
  1545.  
  1546.                                     5.3. VARIABLE SUBSTITUTION IN PATHS
  1547.  
  1548.  
  1549. 5.3 Variable substitution in paths
  1550.  
  1551. To avoid having to edit your configuration files too often, the compiler allows you
  1552. to specify the following variables in the paths that you feed to the compiler:
  1553.  
  1554. FPCVER is replaced by the compiler's full version string.
  1555.  
  1556. FPCDATE is replaced by the compiler's date.
  1557.  
  1558. FPCTARGET is replaced by the compiler's target CPU (deprecated).
  1559.  
  1560. FPCCPU is also replaced by the compiler's target CPU.
  1561.  
  1562. TARGET is replaced by the compiler's target OS.(deprecated)
  1563.  
  1564. FPCOS is replaced by the compiler's target OS.
  1565.  
  1566. To have these variables subsituted, just insert them with a $ prepended, as follows:
  1567.  
  1568. -Fu/usr/lib/fpc/$FPCVER/rtl/$FPCOS
  1569.  
  1570. This is equivalent to
  1571.  
  1572. -Fu/usr/lib/fpc/0.99.12a/rtl/linux
  1573.  
  1574. If the compiler version is 0.99.12a and the target os is linux.
  1575. These replacemens are valid on the command-line and also in the configuration file.
  1576. On the linux command-line, you must be careful to escape the $ since otherwise the
  1577. shell will expand the variable for you, which may have undesired e ects.
  1578.  
  1579.  
  1580.  
  1581.  
  1582.  
  1583.  
  1584.  
  1585.  
  1586.  
  1587.  
  1588.  
  1589.  
  1590.  
  1591.  
  1592.  
  1593.  
  1594.  
  1595.  
  1596.  
  1597.  
  1598.  
  1599.  
  1600.  
  1601.  
  1602.  
  1603.                                          28
  1604.  
  1605.  
  1606.  
  1607. Chapter 6
  1608.  
  1609. Porting Turbo Pascal Code
  1610.  
  1611. Free Pascal was designed to resemble Turbo Pascal as closely as possible. There
  1612. are, of course, restrictions. Some of these are due to the fact that Free Pascal is a
  1613. 32-bit compiler. Other restrictions result from the fact that Free Pascal works on
  1614. more than one operating system.
  1615. In general we can say that if you keep your program code close to ANSI Pascal, you
  1616. will have no problems porting from Turbo Pascal, or even Delphi, to Free Pascal.
  1617. To a large extent, the constructs defined by Turbo Pascal are supported. This is
  1618. even more so if you use the -So or -S2 switches.
  1619. In the following sections we will list the Turbo Pascal constructs which are not
  1620. supported in Free Pascal, and we will list in what ways Free Pascal extends the
  1621. Turbo Pascal language.
  1622.  
  1623.  
  1624. 6.1 Things that will not work
  1625.  
  1626. Here we give a list of things which are defined/allowed in Turbo Pascal, but which
  1627. are not supported by Free Pascal. Where possible, we indicate the reason.
  1628.  
  1629.   1. Parameter lists of previously defined functions and procedures must match
  1630.      exactly. The reason for this is the function overloading mechanism of Free
  1631.      Pascal. (however, the -So switch solves this. See 5.1)
  1632.  
  1633.   2. (* ... *) as comment delimiters are not allowed in versions older than
  1634.      0.9.1. This can easily be remedied with a grown-up editor.
  1635.  
  1636.   3. The MEM, MEMW, MEML and PORT variables for memory and port access are not
  1637.      available in the system unit. This is due to the operating system. Under dos,
  1638.      the extender unit (GO32.PPU) implements the mem constuct. under linux,
  1639.      the ports unit implements such a construct.
  1640.  
  1641.   4. PROTECTED, PUBLIC, PUBLISHED, TRY, FINALLY, EXCEPT, RAISE are reserved
  1642.      words. This means you cannot create procedures or variables with the same
  1643.      name. While they are not reserved words in Turbo Pascal, they are in Delphi.
  1644.      Using the -So switch will solve this problem if you want to compile Turbo
  1645.      Pascal code that uses these words.
  1646.  
  1647.   5. The reserved words FAR, NEAR are ignored. This is because Free Pascal is a
  1648.      32 bit compiler, so they're obsolete.
  1649.  
  1650.  
  1651.                                          29
  1652.  
  1653.  
  1654.  
  1655.                                                6.2. THINGS WHICH ARE EXTRA
  1656.  
  1657.  
  1658.   6. INTERRUPT only will work on a DOS machine.
  1659.  
  1660.   7. Boolean expressions are only evaluated until their result is completely deter-
  1661.      mined. The rest of the expression will be ignored.
  1662.  
  1663.   8. By default the compiler uses AT&T assembler syntax. This is mainly because
  1664.      Free Pascal uses gnu as. However other assembler forms are available, Pro-
  1665.      grammers' guide.
  1666.  
  1667.   9. Turbo Vision is not available.
  1668.  
  1669.  10. The 'overlay' unit is not available. It also isn't necessary, since Free Pascal is
  1670.      a 32 bit compiler, so program size shouldn't be a point.
  1671.  
  1672.  11. There are more reserved words. (see appendix B for a list of all reserved
  1673.      words.)
  1674.  
  1675.  12. The command-line parameters of the compiler are di erent.
  1676.  
  1677.  13. Compiler switches and directives are mostly the same, but some extra exist.
  1678.  
  1679.  14. Units are not binary compatible.
  1680.  
  1681.  
  1682. 6.2 Things which are extra
  1683.  
  1684. Here we give a list of things which are possible in Free Pascal, but which didn't
  1685. exist in Turbo Pascal or Delphi.
  1686.  
  1687.   1. There are more reserved words. (see appendix B for a list of all reserved
  1688.      words.)
  1689.  
  1690.   2. Functions can also return complex types, such as records and arrays.
  1691.  
  1692.   3. You can handle function results in the function itself, as a variable. Example
  1693.  
  1694.      function a : longint;
  1695.  
  1696.      begin
  1697.          a:=12;
  1698.          while a>4 do
  1699.               begin
  1700.                  {...}
  1701.               end;
  1702.      end;
  1703.  
  1704.      The example above would work with TP, but the compiler would assume that
  1705.      the a>4 is a recursive call. To do a recursive call in this you must append ()
  1706.      behind the function name:
  1707.  
  1708.      function a : longint;
  1709.  
  1710.      begin
  1711.          a:=12;
  1712.          { this is the recursive call }
  1713.          if a()>4 then
  1714.               begin
  1715.  
  1716.                                          30
  1717.  
  1718.  
  1719.  
  1720.                                            6.2. THINGS WHICH ARE EXTRA
  1721.  
  1722.  
  1723.               {...}
  1724.            end;
  1725.   end;
  1726.  
  1727. 4. There is partial support of Delphi constructs. (see the Programmers' guide
  1728.   for more information on this).
  1729.  
  1730. 5. The exit call accepts a return value for functions.
  1731.  
  1732.   function a : longint;
  1733.  
  1734.   begin
  1735.       a:=12;
  1736.       if a>4 then
  1737.            begin
  1738.               exit(a*67); {function result upon exit is a*67 }
  1739.            end;
  1740.   end;
  1741.  
  1742. 6. Free Pascal supports function overloading. That is, you can define many
  1743.   functions with the same name, but with di erent arguments. For example:
  1744.  
  1745.   procedure DoSomething (a : longint);
  1746.   begin
  1747.   {...}
  1748.   end;
  1749.  
  1750.   procedure DoSomething (a : real);
  1751.   begin
  1752.   {...}
  1753.   end;
  1754.  
  1755.   You can then call procedure DoSomething with an argument of type Longint
  1756.   or Real.
  1757.   This feature has the consequence that a previously declared function must
  1758.   always be defined with the header completely the same:
  1759.  
  1760.   procedure x (v : longint); forward;
  1761.  
  1762.   {...}
  1763.  
  1764.   procedure x;{ This will overload the previously declared x}
  1765.   begin
  1766.   {...}
  1767.   end;
  1768.  
  1769.   This construction will generate a compiler error, because the compiler didn't
  1770.   find a definition of procedure x (v : longint);. Instead you should de-
  1771.   fine your procedure x as:
  1772.  
  1773.   procedure x (v : longint);
  1774.   { This correctly defines the previously declared x}
  1775.   begin
  1776.   {...}
  1777.   end;
  1778.  
  1779.                                      31
  1780.  
  1781.  
  1782.  
  1783.                                6.3. TURBO PASCAL COMPATIBILITY MODE
  1784.  
  1785.  
  1786.      (The See 5.1 switch disables overloading. When you use it, the above will
  1787.      compile, as in Turbo Pascal.
  1788.   7. Operator overloading. Free Pascal allows to overload operators, i.e. you can
  1789.      define e.g. the '+' operator for matrices.
  1790.   8. On FAT16 and FAT32 systems, long file names are supported.
  1791.  
  1792.  
  1793. 6.3 Turbo Pascal compatibility mode
  1794.  
  1795. When you compile a program with the -So switch, the compiler will attempt to
  1796. mimic the Turbo Pascal compiler in the following ways:
  1797.  
  1798.    * Assigning a procedural variable doesn't require a @ operator. One of the
  1799.      di erences between Turbo Pascal and Free Pascal is that the latter requires
  1800.      you to specify an address operator when assigning a value to a procedural
  1801.      variable. In Turbo Pascal compatibility mode, this is not required.
  1802.    * Procedure overloading is disabled. This means that function header and im-
  1803.      plementation can be di erent (i.e. the function iplementation doesn't need to
  1804.      repeat the function header).
  1805.    * Forward defined procedures don't need the full parameter list when they are
  1806.      defined. Due to the procedure overloading feature of Free Pascal, you must
  1807.      always specify the parameter list of a function when you define it, even when
  1808.      it was declared earlier with Forward. In Turbo Pascal compatibility mode,
  1809.      there is no function overloading, hence you can omit the parameter list:
  1810.  
  1811.      Procedure a (L : Longint); Forward;
  1812.  
  1813.      ...
  1814.  
  1815.      Procedure a ; { No need to repeat the (L : Longint) }
  1816.  
  1817.      begin
  1818.           ...
  1819.      end;
  1820.  
  1821.  
  1822.    * recursive function calls are handled d erently. Consider the following example
  1823.      :
  1824.  
  1825.      Function expr : Longint;
  1826.  
  1827.      begin
  1828.            ...
  1829.            Expr:=L:
  1830.            Writeln (Expr);
  1831.            ...
  1832.      end;
  1833.  
  1834.      In Turbo Pascal compatibility mode, the function will be called recursively
  1835.      when the writeln statement is processed. In Free Pascal, the function result
  1836.      will be printed. In order to call the function recusively under Free Pascal, you
  1837.      need to implement it as follows :
  1838.  
  1839.                                           32
  1840.  
  1841.  
  1842.  
  1843.                            6.3. TURBO PASCAL COMPATIBILITY MODE
  1844.  
  1845.  
  1846.   Function expr : Longint;
  1847.  
  1848.   begin
  1849.     ...
  1850.     Expr:=L:
  1851.     Writeln (Expr());
  1852.     ...
  1853.   end;
  1854.  
  1855. * Any text after the final End. statement is ignored. Normally, this text is
  1856.   processed too.
  1857.  
  1858. * You cannot assign procedural variables to void pointers.
  1859.  
  1860. * The @ operator is typed when applied on procedures.
  1861.  
  1862. * You cannot nest comments.
  1863.  
  1864.  
  1865.  
  1866.  
  1867.  
  1868.  
  1869.  
  1870.  
  1871.  
  1872.  
  1873.  
  1874.  
  1875.  
  1876.  
  1877.  
  1878.  
  1879.  
  1880.  
  1881.  
  1882.  
  1883.  
  1884.  
  1885.  
  1886.  
  1887.  
  1888.  
  1889.  
  1890.  
  1891.  
  1892.  
  1893.  
  1894.  
  1895.  
  1896.  
  1897.  
  1898.  
  1899.                                     33
  1900.  
  1901.  
  1902.  
  1903. Chapter 7
  1904.  
  1905. Utilities and units that come
  1906. with Free Pascal
  1907.  
  1908. Besides the compiler and the Run-Time Library, Free Pascal comes with some utility
  1909. programs and units. Here we list these programs and units.
  1910.  
  1911.  
  1912. 7.1 Supplied programs
  1913.  
  1914. ppudump program
  1915. ppudump is a program which shows the contents of a Free Pascal unit. It is dis-
  1916. tributed with the compiler. You can just issue the following command
  1917.  
  1918.   ppudump [options] foo.ppu
  1919.  
  1920. to display the contents of the foo.ppu unit. You can specify multiple files on the
  1921. command line.
  1922. The options can be used to change the verbosity of the display. By default, all
  1923. available information is displayed. You can set the verbosity level using the -Vxxx
  1924. option. Here, xxx is a combination of the following letters:
  1925.  
  1926. h: show header info.
  1927. i: show interface information.
  1928. m: show implementation information.
  1929. d: show only (interface) definitions.
  1930. s: show only (interface) symbols.
  1931. b: show browser info.
  1932. a: show everything (default if no -V option is present).
  1933.  
  1934.  
  1935. Demo programs
  1936. Also distributed with Free Pascal comes a series of demonstration programs. These
  1937. programs have no other purpose than demonstrating the capabilities of Free Pascal.
  1938. They are located in the demo directory of the sources.
  1939.  
  1940.                                          34
  1941.  
  1942.  
  1943.  
  1944.                                                       7.1. SUPPLIED PROGRAMS
  1945.  
  1946.  
  1947. Documentation Example programs
  1948. All example programs of the documentation are available. Check out the directories
  1949. that end on ex in the documentation sources. There you will find all example
  1950. sources.
  1951.  
  1952.  
  1953. ppumove program
  1954. ppumove is a program to make shared or static libraries from multiple units. It can
  1955. be compared with the tpumove program that comes with Turbo Pascal.
  1956. It should be distributed in binary form along with the compiler.
  1957. It's usage is very simple:
  1958.  
  1959. ppumove [options] unit1.ppu unit2.ppu ... unitn.ppu
  1960.  
  1961. Where options is a combination of
  1962.  
  1963. -b: If specified, ppumve will generate a batch file that will contain the external
  1964.       linking and archiving commands that must be executed. The name of this
  1965.       batch file is pmove.sh on linux, and pmove.bat otherwise.
  1966.  
  1967. -d xxx: If specified, the output files will put in the directory xxx
  1968.  
  1969. -e xxx: Sets the extension of the moved unit files to xxx. By default, this is .ppl.
  1970.       You don't have to specify the dot.
  1971.  
  1972. -o xxx: sets the name of the output file, i.e. the name of the file containing all the
  1973.       units. This parameter is mandatory when you use multiple files. On linux,
  1974.       ppumove will prepend this name with lib if it isn't already there, and will add
  1975.       an extension appropriate to the type of library.
  1976.  
  1977. -q: Causes ppumove to operate silently.
  1978.  
  1979. -s: Tells ppumove to make a static library instead of a dynamic one; By default a
  1980.       dynamic library is made on linux.
  1981.  
  1982. -w: Tells ppumove that it is working under Windows NT. This will change the
  1983.       names of te linker and archiving program to ldw and arw, respectively.
  1984.  
  1985. -h or -?: will display a short help.
  1986.  
  1987. The action of the ppumve program is as follows: It takes each of the unit files, and
  1988. modifies it so that the compile will know that it should look for the unit code in the
  1989. library. The new unit files will have an extension .ppu, this can be changed with the
  1990. -e option. It will then put together all the object files of the units into one library,
  1991. static or dynamic, depending on the presence of the -s option.
  1992. The name of this library must be set with the -o option. If needed, the prefix lib
  1993. will be prepended under linux.. The extension will be set to .a for static libraries,
  1994. for shared libraries the extensions are .so on linux, and .dll under Windows NT
  1995. and os/2.
  1996. As an example, the following command
  1997.  
  1998. ./ppumove -o both -e ppl ppu.ppu timer.ppu
  1999.  
  2000. under linux, will generate the following output:
  2001.  
  2002.                                             35
  2003.  
  2004.  
  2005.  
  2006.                                                            7.1. SUPPLIED PROGRAMS
  2007.  
  2008.  
  2009. PPU-Mover Version 0.99.7
  2010. Copyright (c) 1998 by the Free Pascal Development Team
  2011.  
  2012. Processing ppu.ppu... Done.
  2013. Processing timer.ppu... Done.
  2014. Linking timer.o ppu.o
  2015. Done.
  2016.  
  2017. And it will produce the following files:
  2018.  
  2019.    1. libboth.so : The shared library containing the code from ppu.o and timer.o.
  2020.       Under Windows NT, this file would be called both.dll.
  2021.  
  2022.    2. timer.ppl : The unit file that tells the Free Pascal compiler to look for the
  2023.       timer code in the library.
  2024.  
  2025.    3. ppu.ppl : The unit file that tells the Free Pascal compiler to look for the timer
  2026.       code in the library.
  2027.  
  2028. You could then use or distribute the files libboth.so, timer.ppl and ppu.ppl.
  2029.  
  2030.  
  2031. ptop - Pascal source beautifier
  2032. ptop program
  2033.  
  2034. ptop is a source beautifier written by Peter Grogono based on the ancient pretty-
  2035. printer by Ledgard, Hueras, and Singer, modernized by the Free Pascal team (ob-
  2036. jects, streams, configurability etc)
  2037. This configurability, and the thorough bottom-up design are the advantages of this
  2038. program over the diverse TurboPascal sourcebeautifiers on e.g. SIMTEL.
  2039. The program is quite simple to operate:
  2040. ptop "[-v] [-i indent] [-b bufsize ][-c optsfile] infile outfile"
  2041. The Infile parameter is the pascal file to be processed, and will be written to outfile,
  2042. overwriting an existing outfile if it exists.
  2043. Some options modify the behaviour of ptop:
  2044.  
  2045. -h Writes an overview of the possible parameters and commandline syntax.
  2046.  
  2047. -c ptop.cfg Read some configuration data from configuration file instead of using
  2048.       the internal defaults then. A config file is not required, the program can
  2049.       operate without one. See also -g.
  2050.  
  2051. -i ident Sets the number of indent spaces used for BEGIN END; and other blocks.
  2052.  
  2053. -b bufsize Sets the streaming bu ersize to bufsize. Default 255, 0 is considered
  2054.       non-valid and ignored.
  2055.  
  2056. -v be verbose. Currently only outputs the number of lines read/written and some
  2057.       error messages.
  2058.  
  2059. -g ptop.cfg Writes a default configuration file to be edited to the file "ptop.cfg"
  2060.  
  2061.  
  2062.  
  2063.  
  2064.                                               36
  2065.  
  2066.  
  2067.  
  2068.                                                        7.1. SUPPLIED PROGRAMS
  2069.  
  2070.  
  2071.  
  2072.                             Table 7.1: keywords for operators
  2073.  
  2074.               Name of codeword operator
  2075.               casevar                 : in a case label ( unequal 'colon')
  2076.               becomes                 :=
  2077.               delphicomment           //
  2078.               opencomment             { or (*
  2079.               closecomment            } or *)
  2080.               semicolon               ;
  2081.               colon                   :
  2082.               equals                  =
  2083.               openparen               [
  2084.               closeparen              ]
  2085.               period                  .
  2086.  
  2087.  
  2088. The ptop configuration file
  2089.  
  2090. Creating and distributing a configuration file for ptop is not necesarry, unless you
  2091. want to modify the standard behaviour of ptop. The configuration file is never
  2092. preloaded, so if you want to use it you should always specify it with a -c ptop.cfg
  2093. parameter.
  2094. The structure of a ptop configuration file is a simple buildingblock repeated several
  2095. (20-30) times, for each pascal keyword known to the ptop program. (see the default
  2096. configuration file or ptopu.pp source to find out which keywords are known)
  2097. The basic building block of the configuration file consists out of one or two lines,
  2098. describing how ptop should react on a certain keyword. First a line without square
  2099. brackets with the following format:
  2100. keyword=option1,option2,option3,...
  2101. If one of the options is "dindonkey" (see further below), a second line (with square
  2102. brackets) is needed like this:
  2103. [keyword]=otherkeyword1,otherkeyword2,otherkeyword3,...
  2104. As you can see the block contains two types of identifiers, keywords(keyword and
  2105. otherkeyword1..3 in above example) and options, (option1..3 above).
  2106. Keywords are the built-in valid Pascal structure-identifiers like BEGIN, END, CASE,
  2107. IF, THEN, ELSE, IMPLEMENTATION. The default configuration file lists most
  2108. of these.
  2109. Besides the real Pascal keywords, some other codewords are used for operators and
  2110. comment expressions. table (7.1)
  2111. The Options codewords define actions to be taken when the keyword before the
  2112. equal sign is found, table (7.2)
  2113. The option "dindonkey" requires some extra parameters, which are set by a second
  2114. line for that option (the one with the square brackets), which is therefore is only
  2115. needed if the options contain "dinkdonkey" (contraction of de-indent on assiociated
  2116. keyword).
  2117. "dinkdonkey" deindents if any of the keywords specified by the extra options of the
  2118. square-bracket line is found.
  2119. Example: The lines
  2120.  
  2121.  
  2122.                                             37
  2123.  
  2124.  
  2125.  
  2126.                                                          7.1. SUPPLIED PROGRAMS
  2127.  
  2128.  
  2129.  
  2130.                                 Table 7.2: Possible options
  2131.  
  2132.                   Option        does what
  2133.                   crsupp        suppress CR before the keyword.
  2134.                   crbefore      force CR before keyword
  2135.                                 (doesn't go with crsupp :) )
  2136.                   blinbefore    blank line before keyword.
  2137.                   dindonkey de-indent on associated keywords
  2138.                                 (see below)
  2139.                   dindent       deindent (always)
  2140.                   spbef         space before
  2141.                   spaft         space after
  2142.                   gobsym        Print symbols which follow a
  2143.                                 keyword but which do not
  2144.                                 a ect layout. prints until
  2145.                                 terminators occur.
  2146.                                 (terminators are hard-coded in pptop,
  2147.                                 still needs changing)
  2148.                   inbytab       indent by tab.
  2149.                   crafter       force CR after keyword.
  2150.                   upper         prints keyword all uppercase
  2151.                   lower         prints keyword all lowercase
  2152.                   capital       capitalizes keyword: 1st letter
  2153.                                 uppercase, rest lowercase.
  2154.  
  2155.  
  2156. else=crbefore,dindonkey,inbytab,upper
  2157. [else]=if,then,else
  2158.  
  2159. mean the following:
  2160.  
  2161.    * The keyword this block is about is else because it's on the LEFT side of both
  2162.       equal signs.
  2163.  
  2164.    * The option crbefore signals not to allow other code (so just spaces) before
  2165.       the ELSE keyword on the same line.
  2166.  
  2167.    * The option dindonkey de-indents if the parser finds any of the keywords in
  2168.       the square brackets line (if,then,else)
  2169.  
  2170.    * The option inbytab means indent by a tab.
  2171.  
  2172.    * The option upper uppercase the keyword (else or Else becomes ELSE)
  2173.  
  2174. Try to play with the configfile step by step until you find the e ect you desire. The
  2175. configurability and possibilities of ptop are quite large. E.g. I like all keywords
  2176. uppercased instead of capitalized, so I replaced all capital keywords in the default
  2177. file by upper.
  2178. ptop is still development software, so it is wise to visually check the generated source
  2179. and try to compile it, to see if ptop hasn't made any errors.
  2180.  
  2181.  
  2182.  
  2183.  
  2184.                                                38
  2185.  
  2186.  
  2187.  
  2188.                                                      7.1. SUPPLIED PROGRAMS
  2189.  
  2190.  
  2191. ptopu unit
  2192.  
  2193. The source of the PtoP program is conveniently split in two files: One is a unit
  2194. containing an object that does the actual beautifying of the source, the other is a
  2195. shell built around this object so it can be used from the command line. This design
  2196. makes it possible to include the object in some program (e.g. an IDE) and use it's
  2197. features to format code.
  2198. The object resided in the PtoPU unit, and is declared as follows
  2199.  
  2200.   TPrettyPrinter=Object(TObject)
  2201.          Indent : Integer;            { How many characters to indent ? }
  2202.          InS     : PStream;
  2203.          OutS    : PStream;
  2204.          DiagS : PStream;
  2205.          CfgS : PStream;
  2206.          Constructor Create;
  2207.          Function PrettyPrint : Boolean;
  2208.     end;
  2209.  
  2210. Using this object is very simple. The procedure is as follows:
  2211.  
  2212.   1. Create the object, using it's constructor.
  2213.  
  2214.   2. Set the Ins stream. This is an open stream, from which pascal source will be
  2215.      read. This is a mandatory step.
  2216.  
  2217.   3. Set the OutS stream. This is an open stream, to which the beautified pascal
  2218.      source will be written. This is a mandatory step.
  2219.  
  2220.   4. Set the DiagS stream. Any diagnostics will be written to this stream. This
  2221.      step is optional. If you don't set this, no diagnostics are written.
  2222.  
  2223.   5. Set the Cfgs stream. A configuration is read from this stream. (see the previ-
  2224.      ous section for more information about configuration). This step is optional.
  2225.      If you don't set this, a default configuration is used.
  2226.  
  2227.   6. Set the Indent variable. This is the number of spaces to use when indenting.
  2228.      Tab characters are not used in the program. This step is optional. The indent
  2229.      variable is initialized to 2.
  2230.  
  2231.   7. Call PrettyPrint. This will pretty-print the source in Ins and write the result
  2232.      to OutS. The function returns True if no errors occurred, False otherwise.
  2233.  
  2234. So, a minimal procedure would be:
  2235.  
  2236. Procedure CleanUpCode;
  2237.  
  2238. varIns,OutS : PBufStream;
  2239.   PPRinter : TPrettyPrinter;
  2240.  
  2241. begin
  2242.   Ins:=New(PBufStream,Init('ugly.pp',StopenRead,TheBufSize));
  2243.   OutS:=New(PBufStream,Init('beauty.pp',StCreate,TheBufSize));
  2244.   PPrinter.Create;
  2245.   PPrinter.Ins:=Ins;
  2246.  
  2247.                                             39
  2248.  
  2249.  
  2250.  
  2251.                                                                 7.2. SUPPLIED UNITS
  2252.  
  2253.  
  2254.      PPrinter.outS:=OutS;
  2255.      PPrinter.PrettyPrint;
  2256.   end;
  2257.  
  2258.   Using memory streams allows very fast formatting of code, and is perfectly suitable
  2259.   for editors.
  2260.  
  2261.  
  2262.   7.2 Supplied units
  2263.  
  2264.   Here we list the units that come with the Free Pascal distribution. Since there is
  2265.   a di erence in the supplied units per operating system, we list them separately per
  2266.   system. They are documented in the Unit reference.
  2267.  
  2268.  
  2269.   Under DOS
  2270. strings This unit provides basic string handling routines for the pchar type, compa-
  2271.           rable to similar routines in standard C libraries.
  2272.  
  2273. objects This unit provides basic routines for handling objects.
  2274.  
  2275.     dos This unit provides basic routines for accessing the operating system dos. It
  2276.           provides almost the same functionality as the Turbo Pascal unit.
  2277.  
  2278. printer This unit provides all you need for rudimentary access to the printer.
  2279.  
  2280. getopts This unit gives you the gnu getopts command-line arguments handling mech-
  2281.           anism. It also supports long options.
  2282.  
  2283.     crt This unit provides basic screen handling routines. It provides the same func-
  2284.           tionality as the Turbo Pascal CRT unit.
  2285.  
  2286.  graph This unit provides basic graphics handling, with routines to draw lines on the
  2287.           screen, display texts etc. It provides the same functions as the Turbo Pascal
  2288.           unit.
  2289.  
  2290.   go32 This unit provides access to possibilities of the GO32 dos extender.
  2291.  
  2292. emu387 This unit provides support for the coprocessor emulator.
  2293.  
  2294.   mmx This unit provides support for mmx extensions in your code.
  2295.  
  2296.  
  2297.   Under Linux
  2298. strings This unit provides basic string handling routines for the PChar type, compa-
  2299.           rable to similar routines in standard C libraries.
  2300.  
  2301. objects This unit provides basic routines for handling objects.
  2302.  
  2303.     crt This unit provides basic screen handling routines. It provides the same func-
  2304.           tionality Turbo Pascal CRT unit. It works on any terminal which supports the
  2305.           vt100 escape sequences.
  2306.  
  2307.     dos This unit provides an emulation of the same unit under dos. It is intended
  2308.           primarily for easy porting of Pascal programs from dos to linux. For good
  2309.           performance, however, it is recommended to use the linux unit.
  2310.  
  2311.  
  2312.                                               40
  2313.  
  2314.  
  2315.  
  2316.                                                             7.2. SUPPLIED UNITS
  2317.  
  2318.  
  2319.   linux This unit provides access to the linux operating system. It provides most
  2320.        file and I/O handling routines that you may need. It implements most of the
  2321.        standard C library constructs that you will find on a Unix system. If you do
  2322.        a lot of disk/file operations, the use of this unit is recommended over the one
  2323.        you use under Dos.
  2324.  
  2325. printer This unit provides an interface to the standard Unix printing mechanism.
  2326.  
  2327. getopts This unit gives you the gnu getopts command-line arguments handling mech-
  2328.        anism. It also supports long options.
  2329.  
  2330.   mmx This unit provides support for mmx extensions in your code.
  2331.  
  2332. sockets This unit gives you access to sockets and TCP/IP programming.
  2333.  
  2334.  graph Is an implementation of Borlands graph unit, which works on the Linux con-
  2335.        sole. It's implementation is fairly complete, the only non-functional things
  2336.        are the fillpatterns and line styles. It uses the libvga and libvgagl graphics
  2337.        libraries, so you need these installed for this unit to work. Also, programs
  2338.        using this library need to be run as root, or setuid root, and hence are a
  2339.        potential security risk.
  2340.  
  2341.  ports This implements the various port[] constructs. These are provided for com-
  2342.        patibility only, and it is not recommended to use them extensively. Programs
  2343.        using this construct must be run as ruit or setuid root, and are a serious
  2344.        security risk on your system.
  2345.  
  2346.  
  2347.  
  2348.  
  2349.  
  2350.  
  2351.  
  2352.  
  2353.  
  2354.  
  2355.  
  2356.  
  2357.  
  2358.  
  2359.  
  2360.  
  2361.  
  2362.  
  2363.  
  2364.  
  2365.  
  2366.  
  2367.  
  2368.  
  2369.  
  2370.  
  2371.  
  2372.  
  2373.  
  2374.                                           41
  2375.  
  2376.  
  2377.  
  2378. Chapter 8
  2379.  
  2380. Debugging your Programs
  2381.  
  2382. Free Pascal supports debug information for the gnu debugger gdb. This chapter
  2383. describes shortly how to use this feature. It doesn't attempt to describe completely
  2384. the gnu debugger, however. For more information on the workings of the gnu
  2385. debugger, see the gdb users' guide.
  2386. Free Pascal also suports gprof, the gnu profiler, see section 8.4 for more information
  2387. on profiling.
  2388.  
  2389. 8.1 Compiling your program with debugger sup-
  2390.          port
  2391.  
  2392. First of all, you must be sure that the compiler is compiled with debugging support.
  2393. Unfortunately, there is no way to check this at run time, except by trying to compile
  2394. a program with debugging support.
  2395. To compile a program with debugging support, just specify the -g option on the
  2396. command-line, as follows:
  2397.  
  2398. ppc386 -g hello.pp
  2399.  
  2400. This will generate debugging information in the executable from your program. You
  2401. will notice that the size of the executable increases substantially because of this1.
  2402. Note that the above will only generate debug information for the code that has
  2403. been generated when compiling hello.pp. This means that if you used some units
  2404. (the system unit, for instance) which were not compiled with debugging support,
  2405. no debugging support will be available for the code in these units.
  2406. There are 2 solutions for this problem.
  2407.  
  2408.    1. Recompile all units manually with the -g option.
  2409.    2. Specify the 'build' option (-B) when compiling with debugging support. This
  2410.       will recompile all units, and insert debugging information in each of the units.
  2411.  
  2412. The second option may have undesirable side e ects. It may be that some units
  2413. aren't found, or compile incorrectly due to missing conditionals, etc..
  2414. If all went well, the executable now contains the necessary information with which
  2415. you can debug it using gnu gdb.
  2416.   1A good reason not to include debug information in an executable you plan to distribute.
  2417.  
  2418.  
  2419.                                              42
  2420.  
  2421.  
  2422.  
  2423.                                  8.2. USING GDB TO DEBUG YOUR PROGRAM
  2424.  
  2425.  
  2426. 8.2 Using gdb to debug your program
  2427.  
  2428. To use gdb to debug your program, you can start the debugger, and give it as an
  2429. option the full name of your program:
  2430.  
  2431. gdb hello
  2432.  
  2433. Or, under dos:
  2434.  
  2435. gdb hello.exe
  2436.  
  2437. This starts the debugger, and the debugger immediately loads your program into
  2438. memory, but it does not run the program yet. Instead, you are presented with the
  2439. following (more or less) message, followed by the gdb prompt '(gdb)':
  2440.  
  2441. GDB is free software and you are welcome to distribute copies of it
  2442.  under certain conditions; type "show copying" to see the conditions.
  2443. There is absolutely no warranty for GDB; type "show warranty" for details.
  2444. GDB 4.15.1 (i486-slackware-linux),
  2445. Copyright 1995 Free Software Foundation, Inc...
  2446. (gdb)
  2447.  
  2448. To start the program you can use the run command. You can optionally specify
  2449. command-line parameters, which will then be fed to your program, for example:
  2450.  
  2451. (gdb) run -option -anotheroption needed_argument
  2452.  
  2453. If your program runs without problems, gdb will inform you of this, and return the
  2454. exit code of your program. If the exit code was zero, then the message 'Program
  2455. exited normally'.
  2456. If something went wrong (a segmentation fault or so), gdb will stop the execution of
  2457. your program, and inform you of this with an appropriate message. You can then
  2458. use the other gdb commands to see what happened. Alternatively, you can instruct
  2459. gdb to stop at a certain point in your program, with the break command.
  2460. Here is a short list of gdb commands, which you are likely to need when debugging
  2461. your program:
  2462.  
  2463. quit Exits the debugger.
  2464.  
  2465. kill Stops a running program.
  2466.  
  2467. help Gives help on all gdb commands.
  2468.  
  2469. file Loads a new program into the debugger.
  2470.  
  2471. directory Add a new directory to the search path for source files.
  2472.      Remark: My copy of gdb needs '.' to be added explicitly to the search path,
  2473.      otherwise it doesn't find the sources.
  2474.  
  2475. list Lists the program sources per 10 lines. As an option you can specify a line
  2476.      number or function name.
  2477.  
  2478. break Sets a breakpoint at a specified line or function
  2479.  
  2480. awatch Sets a watch-point for an expression. A watch-point stops execution of
  2481.      your program whenever the value of an expression is either read or written.
  2482.  
  2483.                                          43
  2484.  
  2485.  
  2486.  
  2487.                                    8.3. CAVEATS WHEN DEBUGGING WITH GDB
  2488.  
  2489.  
  2490. for more information, see the gdb users' guide, or use the 'help' function in gdb.
  2491. The appendix F contains a sample init file for gdb, which produces good results
  2492. when debugging Free Pascal programs.
  2493. It is also possible to use RHIDE, a text-based IDE that uses gdb. There is a version
  2494. of RHIDE available that can work together with FPC.
  2495.  
  2496.  
  2497. 8.3 Caveats when debugging with gdb
  2498.  
  2499. There are some peculiarities of Free Pascal which you should be aware of when
  2500. using gdb. We list the main ones here:
  2501.  
  2502.   1. Free Pascal generates information for GDB in uppercare letters. This is a
  2503.      consequence of the fact that pascal is a case insensitive language. So, when
  2504.      referring to a variable or function, you need to make it's name all uppercase.
  2505.      As an example, of you want to watch the value of a loop variable count, you
  2506.      should type
  2507.  
  2508.      watch COUNT
  2509.  
  2510.      Or if you want stop when a certain function (e.g MyFunction) is called, type
  2511.  
  2512.      break MYFUNCTION
  2513.  
  2514.   2. Line numbers may be o  by a little. This is a bug in Free Pascal and will be
  2515.      fixed as soon as possible.
  2516.  
  2517.   3. gdb does not know sets.
  2518.  
  2519.   4. gdb doesn't know strings. Strings are represented in gdb as records with a
  2520.      length field and an array of char contaning the string.
  2521.      You can also use the following user function to print strings:
  2522.  
  2523.      define pst
  2524.      set $pos=&$arg0
  2525.      set $strlen = {byte}$pos
  2526.      print {char}&$arg0.st@($strlen+1)
  2527.      end
  2528.  
  2529.      document pst
  2530.         Print out a Pascal string
  2531.      end
  2532.  
  2533.      If you insert it in your gdb.ini file, you can look at a string with this function.
  2534.      There is a sample gdb.ini in appendix F.
  2535.  
  2536.   5. Objects are di cult to handle, mainly because gdb is oriented towards C and
  2537.      C++. The workaround implemented in Free Pascal is that object methods are
  2538.      represented as functions, with an extra parameter this (all lowercase !) The
  2539.      name of this function is a concatenation of the object type and the function
  2540.      name, separated by two underscore characters.
  2541.      For example, the method TPoint.Draw would be converted to TPOINT DRAW,
  2542.      and could be stopped at with
  2543.  
  2544.                                           44
  2545.  
  2546.  
  2547.  
  2548.                              8.4. SUPPORT FOR GPROF, THE GNU PROFILER
  2549.  
  2550.  
  2551.       break TPOINT__DRAW
  2552.  
  2553.   6. Global overloaded functions confuse gdb because they have the same name.
  2554.       Thus you cannot set a breakpoint at an overloaded function, unless you know
  2555.       it's line number, in which case you can set a breakpoint at the starting
  2556.       linenumber of the function.
  2557.  
  2558.  
  2559. 8.4 Support for gprof, the gnu profiler
  2560.  
  2561. You can compile your programs with profiling support. for this, you just have to use
  2562. the compiler switch -pg. The compiler wil insert the necessary stu  for profiling.
  2563. When you have done this, you can run your program as you normally would run it.
  2564.  
  2565. yourexe
  2566.  
  2567. Where yourexe is the name of your executable.
  2568. When your program finishes a file called gmon.out is generated. Then you can start
  2569. the profiler to see the output. You can better redirect the output to a file, becuase
  2570. it could be quite a lot:
  2571.  
  2572. gprof yourexe > profile.log
  2573.  
  2574. Hint: you can use the ¡flat option to reduce the amount of output of gprof. It will
  2575. then only output the information about the timings
  2576. For more information on the gnu profiler gprof, see its manual.
  2577.  
  2578.  
  2579.  
  2580.  
  2581.  
  2582.  
  2583.  
  2584.  
  2585.  
  2586.  
  2587.  
  2588.  
  2589.  
  2590.  
  2591.  
  2592.  
  2593.  
  2594.  
  2595.  
  2596.  
  2597.  
  2598.  
  2599.  
  2600.  
  2601.  
  2602.  
  2603.                                          45
  2604.  
  2605.  
  2606.  
  2607. Chapter 9
  2608.  
  2609. CGI programming in Free
  2610. Pascal
  2611.  
  2612. In these days of heavy WWW tra c on the Internet, CGI scripts have become an
  2613. important topic in computer programming. While CGI programming can be done
  2614. with almost any tool you wish, most languages aren't designed for it. Perl may be
  2615. a notable exception, but perl is an interpreted language, the executable is quite big,
  2616. and hence puts a big load on the server machine.
  2617. Because of its simple, almost intuitive, string handling and its easy syntax, Pascal is
  2618. very well suited for CGI programming. Pascal allows you to quickly produce some
  2619. results, while giving you all the tools you need for more complex programming.
  2620. The basic RTL routines in principle are enough to get the job done, but you can
  2621. create, with relatively little e ort, some units which can be used as a base for more
  2622. complex CGI programming.
  2623. That's why, in this chapter, we will discuss the basics of CGI in Free Pascal. In the
  2624. subsequent, we will assume that the server for which the programs are created, are
  2625. based upon the NCSA httpd WWW server, as the examples will be based upon
  2626. the NCSA method of CGI programming1. They have been tested with the apache
  2627. server on linux, and the xitami server on Windows NT.
  2628. The two example programs in this chapter have been tested on the command line
  2629. and worked, under the condition that no spaces were present in the name and value
  2630. pairs provided to them.
  2631. There is however, a faster and generally better uncgi unit available, you can find
  2632. it on the contributed units page of the Free Pascal web site. It uses techniques
  2633. discussed here, but in a generally more e cient way, and it also provides some
  2634. extra functionality, not discussed here.
  2635.  
  2636.  
  2637. 9.1 Getting your data
  2638.  
  2639. Your CGI program must react on data the user has filled in on the form which your
  2640. web-server gave him. The Web server takes the response on the form, and feeds it
  2641. to the CGI script.
  2642. There are essentially two ways of feeding the data to the CGI script. We will discuss
  2643. both.
  2644.   1... and it's the only WWW-server I have to my disposition at the moment.
  2645.  
  2646.  
  2647.                                             46
  2648.  
  2649.  
  2650.  
  2651.                                                         9.1. GETTING YOUR DATA
  2652.  
  2653.  
  2654. Data coming through standard input.
  2655. The first method of getting your data is through standard input. This method is in-
  2656. voked when the form uses a form submission method of POST. The web browser sets
  2657. three environment variables REQUEST METHOD, CONTENT TYPE and CONTENT LENGTH.
  2658. It feeds then the results of the di erent fields through standard input to the CGI
  2659. script. All the Pascal program has to do is :
  2660.  
  2661.    * Check the value of the REQUEST METHOD environment variable. The getenv
  2662.      function will retrieve this value this for you.
  2663.  
  2664.    * Check the value of the CONTENT TYPE environment variable.
  2665.  
  2666.    * Read CONTENT LENGTH characters from standard input. read (c) with c of
  2667.      type char will take care of that.
  2668.  
  2669. if you know that the request method will always be POST, and the CONTENT TYPE
  2670. will be correct, then you can skip the first two steps. The third step can be done
  2671. easier: read characters until you reach the end-of-file marker of standard input.
  2672. The following example shows how this can be achieved:
  2673.  
  2674. program cgi_post;
  2675.  
  2676. uses dos;
  2677.  
  2678. const max_data = 1000;
  2679.  
  2680. type datarec = record
  2681.   name,value : string;
  2682.   end;
  2683.  
  2684. var data : array[1..max_data] of datarec;
  2685.     i,nrdata : longint;
  2686.     c : char;
  2687.     literal,aname : boolean;
  2688.  
  2689. begin
  2690. writeln ('Content-type: text/html');
  2691. writeln;
  2692. if getenv('REQUEST_METHOD')<>'POST' then
  2693.    begin
  2694.    writeln ('This script should be referenced with a METHOD of POST');
  2695.    write ('If you don''t understand this, see this ');
  2696.    write ('< A HREF="http://www.ncsa.uiuc.edu/SDG/Softare/Mosaic');
  2697.    writeln ('/Docs/fill-out-forms/overview.html">forms overview</A>.');
  2698.    halt(1);
  2699.    end;
  2700. if getenv('CONTENT_TYPE')<>'application/x-www-form-urlencoded' then
  2701.    begin
  2702.    writeln ('This script can only be used to decode form results');
  2703.    halt(1)
  2704.    end;
  2705. nrdata:=1;
  2706. aname:=true;
  2707. while not eof(input) do
  2708.  
  2709.                                           47
  2710.  
  2711.  
  2712.  
  2713.                                                               9.1. GETTING YOUR DATA
  2714.  
  2715.  
  2716.   begin
  2717.   literal:=false;
  2718.   read(c);
  2719.   if c='\' then
  2720.         begin
  2721.         literal:=true;
  2722.         read(c);
  2723.         end;
  2724.   if literal or ((c<>'=') and (c<>'&')) then
  2725.         with data[nrdata] do
  2726.             if aname then name:=name+c else value:=value+c
  2727.   elsebegin
  2728.         if c='&' then
  2729.                  begin
  2730.                  inc (nrdata);
  2731.                  aname:=true;
  2732.                  end
  2733.           elseaname:=false;
  2734.           end
  2735.   end;
  2736. writeln ('<H1>Form Results :</H1>');
  2737. writeln ('You submitted the following name/value pairs :');
  2738. writeln ('<UL>');
  2739. for i:=1 to nrdata do writeln ('<LI> ',data[i].name,' = ',data[i].value);
  2740. writeln ('</UL>');
  2741. end.
  2742.  
  2743. While this program isn't shorter than the C program provided as an example at
  2744. NCSA, it doesn't need any other units. everythig is done using standard Pascal
  2745. procedures2.
  2746. Note that this program has a limitation: the length of names and values is limited
  2747. to 255 characters. This is due to the fact that strings in Pascal have a maximal
  2748. length of 255. It is of course easy to redefine the datarec record in such a way that
  2749. longer values are allowed. In case you have to read the contents of a TEXTAREA form
  2750. element, this may be needed.
  2751.  
  2752.  
  2753. Data passed through an environment variable
  2754. If your form uses the GET method of passing it's data, the CGI script needs to read
  2755. the QUERY STRING environment variable to get it's data. Since this variable can,
  2756. and probably will, be more than 255 characters long, you will not be able to use
  2757. normal string methods, present in pascal. Free Pascal implements the pchar type,
  2758. which is a pointer to a null-terminated array of characters. And, fortunately, Free
  2759. Pascal has a strings unit, which eases the use of the pchar type.
  2760. The following example illustrates what to do in case of a method of GET
  2761.  
  2762. program cgi_get;
  2763.  
  2764.    2actually, this program will give faulty results, since spaces in the input are converted to plus
  2765. signs by the web browser. The program doesn't check for this, but that is easy to change. The
  2766. main concern here is to give the working principle.
  2767.  
  2768.  
  2769.                                                 48
  2770.  
  2771.  
  2772.  
  2773.                                               9.1. GETTING YOUR DATA
  2774.  
  2775.  
  2776. uses strings,linux;
  2777.  
  2778. const max_data = 1000;
  2779.  
  2780. type datarec = record
  2781.   name,value : string;
  2782.   end;
  2783.  
  2784. var data : array[1..max_data] of datarec;
  2785.     i,nrdata : longint;
  2786.     p : PChar;
  2787.     literal,aname : boolean;
  2788.  
  2789. begin
  2790. Writeln ('Content-type: text/html');
  2791. Writeln;
  2792. if StrComp(GetEnv('REQUEST_METHOD'),'POST')<>0 then
  2793.    begin
  2794.    Writeln ('This script should be referenced with a METHOD of GET');
  2795.    write ('If you don''t understand this, see this ');
  2796.    write ('< A HREF="http://www.ncsa.uiuc.edu/SDG/Softare/Mosaic');
  2797.    Writeln ('/Docs/fill-out-forms/overview.html">forms overview</A>.');
  2798.    halt(1);
  2799.    end;
  2800. p:=GetEnv('QUERY_STRING');
  2801. nrdata:=1;
  2802. aname:=true;
  2803. while p^<>#0 do
  2804.   begin
  2805.   literal:=false;
  2806.   if p^='\' then
  2807.          begin
  2808.          literal:=true;
  2809.          inc(longint(p));
  2810.          end;
  2811.   if ((p^<>'=') and (p^<>'&')) or literal then
  2812.          with data[nrdata] do
  2813.             if aname then name:=name+p^ else value:=value+p^
  2814.   elsebegin
  2815.          if p^='&' then
  2816.                  begin
  2817.                  inc (nrdata);
  2818.                  aname:=true;
  2819.                  end
  2820.           elseaname:=false;
  2821.           end;
  2822.   inc(longint(p));
  2823.   end;
  2824. Writeln ('<H1>Form Results :</H1>');
  2825. Writeln ('You submitted the following name/value pairs :');
  2826. Writeln ('<UL>');
  2827. for i:=1 to nrdata do writeln ('<LI> ',data[i].name,' = ',data[i].value);
  2828.  
  2829.                                      49
  2830.  
  2831.  
  2832.  
  2833.                                                      9.2. PRODUCING OUTPUT
  2834.  
  2835.  
  2836. Writeln ('</UL>');
  2837. end.
  2838.  
  2839. Although it may not be written in the most elegant way, this program does the
  2840. same thing as the previous one. It also su ers from the same drawback, namely the
  2841. limited length of the value field of the datarec.
  2842. This drawback can be remedied by redefining datarec as follows:
  2843.  
  2844. type datarec = record;
  2845.          name,value : pchar;
  2846.         end;
  2847.  
  2848. and assigning at run time enough space to keep the contents of the value field. This
  2849. can be done with a
  2850.  
  2851.  getmem (data[nrdata].value,needed_number_of_bytes);
  2852.  
  2853. call. After that you can do a
  2854.  
  2855. strlcopy (data[nrdata].value,p,needed_number_of_bytes);
  2856.  
  2857. to copy the data into place.
  2858. You may have noticed the following unorthodox call :
  2859.  
  2860. inc(longint(p));
  2861.  
  2862. Free Pascal doesn't give you pointer arithmetic as in C. However, longints and
  2863. pointers have the same length (namely 4 bytes). Doing a type-cast to a longint
  2864. allows you to do arithmetic on the pointer.
  2865. Note however, that this is a non-portable call. This may work on the I386 processor,
  2866. but not on a ALPHA processor (where a pointer is 8 bytes long). This will be
  2867. remedied in future releases of Free Pascal.
  2868.  
  2869.  
  2870. 9.2 Producing output
  2871.  
  2872. The previous section concentrated mostly on getting input from the web server. To
  2873. send the reply to the server, you don't need to do anything special.You just print
  2874. your data on standard output, and the Web-server will intercept this, and send your
  2875. output to the WWW-client waiting for it.
  2876. You can print anything you want, the only thing you must take care of is that you
  2877. supply a Contents-type line, followed by an empty line, as follows:
  2878.  
  2879. Writeln ('Content-type: text/html');
  2880. Writeln;
  2881. { ...start output of the form... }
  2882.  
  2883.  
  2884. And that's all there is to it !
  2885.  
  2886.  
  2887.  
  2888.  
  2889.                                          50
  2890.  
  2891.  
  2892.  
  2893.                                      9.3. I'M UNDER WINDOWS, WHAT NOW ?
  2894.  
  2895.  
  2896. 9.3 I'm under Windows, what now ?
  2897.  
  2898. Under Windows the system of writing CGI scripts can be totally di erent. If you use
  2899. Free Pascal under Windows then you also should be able to do CGI programming,
  2900. but the above instructions may not work. They are known to work for the xitami
  2901. server, however.
  2902. If some kind soul is willing to write a section on CGI programming under Windows
  2903. for other servers, I'd be willing to include it here.
  2904.  
  2905.  
  2906.  
  2907.  
  2908.  
  2909.  
  2910.  
  2911.  
  2912.  
  2913.  
  2914.  
  2915.  
  2916.  
  2917.  
  2918.  
  2919.  
  2920.  
  2921.  
  2922.  
  2923.  
  2924.  
  2925.  
  2926.  
  2927.  
  2928.  
  2929.  
  2930.  
  2931.  
  2932.  
  2933.  
  2934.  
  2935.  
  2936.  
  2937.  
  2938.  
  2939.  
  2940.  
  2941.  
  2942.  
  2943.  
  2944.  
  2945.  
  2946.  
  2947.                                            51
  2948.  
  2949.  
  2950.  
  2951. Appendix A
  2952.  
  2953. Alphabetical listing of
  2954. command-line options
  2955.  
  2956. The following is alphabetical listing of all command-line options, as generated by
  2957. the compiler:
  2958.  
  2959. ppc386 [options] <inputfile> [options]
  2960. put + after a boolean switch option to enable it, - to disable it
  2961.   -a      the compiler doesn't delete the generated assembler file
  2962.                  -al       list sourcecode lines in assembler file
  2963.                  -ar       list register allocation/release info in assembler file
  2964.                  -at       list temp allocation/release info in assembler file
  2965.   -b      generate browser info
  2966.                  -bl       generate local symbol info
  2967.   -B      build all modules
  2968.   -C<x> code generation options:
  2969.                  -CD       create dynamic library
  2970.                  -Ch<n>    <n> bytes heap (between 1023 and 67107840)
  2971.                  -Ci       IO-checking
  2972.                  -Cn       omit linking stage
  2973.                  -Co       check overflow of integer operations
  2974.                  -Cr       range checking
  2975.                  -Cs<n>    set stack size to <n>
  2976.                  -Ct       stack checking
  2977.                  -CS       create static library
  2978.                  -Cx       use smartlinking
  2979.   -d<x> defines the symbol <x>
  2980.   -e<x> set path to executable
  2981.   -E      same as -Cn
  2982.   -F<x> set file names and paths:
  2983.                  -FD<x>    sets the directory where to search for compiler utilities
  2984.                  -Fe<x>    redirect error output to <x>
  2985.                  -FE<x>    set exe/unit output path to <x>
  2986.                  -Fi<x>    adds <x> to include path
  2987.                  -Fl<x>    adds <x> to library path
  2988.                  -Fo<x>    adds <x> to object path
  2989.                  -Fr<x>    load error message file <x>
  2990.                  -Fu<x>    adds <x> to unit path
  2991.                  -FU<x>    set unit output path to <x>, overrides -FE
  2992.  
  2993.                                           52
  2994.  
  2995.  
  2996.  
  2997.   -g<x> generate debugger information:
  2998.            -gg               use gsym
  2999.            -gd               use dbx
  3000.            -gh               use heap trace unit
  3001.   -i     information
  3002.            -iD               return compiler date
  3003.            -iV               return compiler version
  3004.            -iSO              return compiler OS
  3005.            -iSP              return compiler processor
  3006.            -iTO              return target OS
  3007.            -iTP              return target processor
  3008.   -I<x> adds <x> to include path
  3009.   -k<x> Pass <x> to the linker
  3010.   -l     write logo
  3011.   -n     don't read the default config file
  3012.   -o<x> change the name of the executable produced to <x>
  3013.   -pg    generate profile code for gprof
  3014.   -S<x> syntax options:
  3015.            -S2               switch some Delphi 2 extensions on
  3016.            -Sc               supports operators like C (*=,+=,/= and -=)
  3017.            -Sd               tries to be Delphi compatible
  3018.            -Se               compiler stops after the first error
  3019.            -Sg               allow LABEL and GOTO
  3020.            -Sh               Use ansistrings
  3021.            -Si               support C++ styled INLINE
  3022.            -Sm               support macros like C (global)
  3023.            -So               tries to be TP/BP 7.0 compatible
  3024.            -Sp               tries to be gpc compatible
  3025.            -Ss               constructor name must be init (destructor must be done)
  3026.            -St               allow static keyword in objects
  3027.   -s     don't call assembler and linker (only with -a)
  3028.   -u<x> undefines the symbol <x>
  3029.   -U     unit options:
  3030.            -Un               don't check the unit name
  3031.            -Us               compile a system unit
  3032.   -v<x> Be verbose. <x> is a combination of the following letters:
  3033.            e : Show errors (default)                  d : Show debug info
  3034.            w : Show warnings                          u : Show unit info
  3035.            n : Show notes                             t : Show tried/used files
  3036.            h : Show hints                             m : Show defined macros
  3037.            i : Show general info                      p : Show compiled procedures
  3038.            l : Show linenumbers                       c : Show conditionals
  3039.            a : Show everything                        0 : Show nothing (except errors)
  3040.            b : Show all procedure                     r : Rhide/GCC compatibility mode
  3041.                    declarations if an error           x : Executable info (Win32 only)
  3042.                    occurs
  3043.   -X     executable options:
  3044.            -XD               link with dynamic libraries (defines FPC_LINK_DYNAMIC)
  3045.            -Xs               strip all symbols from executable
  3046.            -XS               link with static libraries (defines FPC_LINK_STATIC)
  3047.  
  3048. Processor specific options:
  3049.   -A<x> output format:
  3050.            -Ao               coff file using GNU AS
  3051.  
  3052.                                          53
  3053.  
  3054.  
  3055.  
  3056.         -Anasmcoff coff file using Nasm
  3057.         -Anasmelf elf32 (Linux) file using Nasm
  3058.         -Anasmobj obj file using Nasm
  3059.         -Amasm      obj file using Masm (Microsoft)
  3060.         -Atasm      obj file using Tasm (Borland)
  3061. -R<x> assembler reading style:
  3062.         -Ratt       read AT&T style assembler
  3063.         -Rintel     read Intel style assembler
  3064.         -Rdirect    copy assembler text directly to assembler file
  3065. -O<x> optimizations:
  3066.         -Og         generate smaller code
  3067.         -OG         generate faster code (default)
  3068.         -Or         keep certain variables in registers (still BUGGY!!!)
  3069.         -Ou         enable uncertain optimizations (see docs)
  3070.         -O1         level 1 optimizations (quick optimizations)
  3071.         -O2         level 2 optimizations (-O1 + slower optimizations)
  3072.         -O3         level 3 optimizations (same as -O2u)
  3073.         -Op<x>      target processor:
  3074.                     -Op1 set target processor to 386/486
  3075.                     -Op2 set target processor to Pentium/PentiumMMX (tm)
  3076.                     -Op3 set target processor to PPro/PII/c6x86/K6 (tm)
  3077. -T<x> Target operating system:
  3078.         -TGO32V1    version 1 of DJ Delorie DOS extender
  3079.         -TGO32V2    version 2 of DJ Delorie DOS extender
  3080.         -TLINUX     Linux
  3081.         -TOS2       OS/2 2.x
  3082.         -TWin32     Windows 32 Bit
  3083.  
  3084. -?    shows this help
  3085. -h    shows this help without waiting
  3086.  
  3087.  
  3088.  
  3089.  
  3090.  
  3091.  
  3092.  
  3093.  
  3094.  
  3095.  
  3096.  
  3097.  
  3098.  
  3099.  
  3100.  
  3101.  
  3102.  
  3103.  
  3104.  
  3105.  
  3106.  
  3107.  
  3108.  
  3109.                                   54
  3110.  
  3111.  
  3112.  
  3113. Appendix B
  3114.  
  3115. Alphabetical list of reserved
  3116. words
  3117.  
  3118. absolute       file               packed
  3119. abstract       finally            popstack
  3120. and            for                private
  3121. array          forward            procedure
  3122. as             function           program
  3123. asm            goto               property
  3124. assembler      if                 protected
  3125. begin          implementation     public
  3126. break          in                 raise
  3127. case           index              record
  3128. cdecl          inherited          repeat
  3129. class          initialization     self
  3130. const          inline             set
  3131. constructor    interface          shl
  3132. continue       interrupt          shr
  3133. destructor     is                 stdcall
  3134. dispose        label              string
  3135. div            library            then
  3136. do             mod                to
  3137. downto         name               true
  3138. else           near               try
  3139. end            new                type
  3140. except         nil                unit
  3141. exit           not                until
  3142. export         object             uses
  3143. exports        of                 var
  3144. external       on                 virtual
  3145. fail           operator           while
  3146. false          or                 with
  3147. far            otherwise          xor
  3148.  
  3149.  
  3150.  
  3151.  
  3152.  
  3153.  
  3154.                             55
  3155.  
  3156.  
  3157.  
  3158. Appendix C
  3159.  
  3160. Compiler messages
  3161.  
  3162. This appendix is meant to list all the compiler messages. The list of messages is
  3163. generated from he compiler source itself, and should be faitly complete. At this
  3164. point, only assembler errors are not in the list.
  3165.  
  3166.  
  3167. C.1 General compiler messages
  3168.  
  3169. This section gives the compiler messages which are not fatal, but which display
  3170. useful information. The number of such messages can be controlled with the various
  3171. verbosity level -v switches.
  3172.  
  3173. Compiler: arg1 When the -vt switch is used, this line tells you what compiler is
  3174.      used.
  3175.  
  3176. Compiler OS: arg1 When the -vd switch is used, this line tells you what the
  3177.      source operating system is.
  3178.  
  3179. Info: Target OS: arg1 When the -vd switch is used, this line tells you what the
  3180.      target operating system is.
  3181.  
  3182. Using executable path: arg1 When the -vt switch is used, this line tells you
  3183.      where the compiler looks for it's binaries.
  3184.  
  3185. Using unit path: arg1 When the -vt switch is used, this line tells you where the
  3186.      compiler looks for compiled units. You can set this path with the -Fu
  3187.  
  3188. Using include path: arg1 When the -vt switch is used, this line tells you where
  3189.      the compiler looks for it's include files (files used in {$I xxx} statements).
  3190.      You can set this path with the -I option.
  3191.  
  3192. Using library path: arg1 When the -vt switch is used, this line tells you where
  3193.      the compiler looks for the libraries. You can set this path with the -Fl option.
  3194.  
  3195. Using object path: arg1 When the -vt switch is used, this line tells you where
  3196.      the compiler looks for object files you link in (files used in {$L xxx} state-
  3197.      ments). You can set this path with the -Fo option.
  3198.  
  3199. Info: arg1 Lines compiled, arg2 sec When the -vi switch is used, the compiler
  3200.      reports the number of lines compiled, and the time it took to compile them
  3201.      (real time, not program time).
  3202.  
  3203.  
  3204.                                           56
  3205.  
  3206.  
  3207.  
  3208.                                                       C.2. SCANNER MESSAGES.
  3209.  
  3210.  
  3211. Fatal: No memory left The compiler doesn't have enough memory to compile
  3212.       your program. There are several remedies for this:
  3213.  
  3214.          * If you're using the build option of the compiler, try compiling the di erent
  3215.            units manually.
  3216.          * If you're compiling a huge program, split it up in units, and compile
  3217.            these separately.
  3218.          * If the previous two don't work, recompile the compiler with a bigger heap
  3219.            (you can use the -Ch option for this, See 5.1)
  3220.  
  3221.  
  3222. C.2 Scanner messages.
  3223.  
  3224. This section lists the messages that the scanner emits. The scanner takes care of
  3225. the lexical structure of the pascal file, i.e. it tries to find reserved words, strings,
  3226. etc. It also takes care of directives and conditional compiling handling.
  3227.  
  3228. Fatal: Unexpected end of file this typically happens in one of the following
  3229.       cases :
  3230.  
  3231.          * The source file ends before the final end. statement. This happens
  3232.            mostly when the begin and end statements aren't balanced;
  3233.          * An include file ends in the middle of a statement.
  3234.          * A comment wasn't closed.
  3235.  
  3236. Fatal: String exceeds line You forgot probably to include the closing ' in a
  3237.       string, so it occupies multiple lines.
  3238.  
  3239. Fatal: illegal character An illegal character was encountered in the input file.
  3240.  
  3241. Fatal: Syntax error, arg1 expected but arg2 found This indicates that the
  3242.       compiler expected a di erent token than the one you typed. It can occur
  3243.       almost everywhere where you make a mistake against the pascal language.
  3244.  
  3245. Start reading includefile arg1 When you provide the -vt switch, the compiler
  3246.       tells you when it starts reading an included file.
  3247.  
  3248. Warning: Comment level arg1 found When the -vw switch is used, then the
  3249.       compiler warns you if it finds nested comments. Nested comments are not
  3250.       allowed in Turbo Pascal and can be a possible source of errors.
  3251.  
  3252. Note: argF directive (FAR) ignored The FAR directive is a 16-bit construction
  3253.       which is recorgnised but ignored by the compiler, since it produces 32 bit code.
  3254.  
  3255. Note: Stack check is global under Linux Stack checking with the -Cs switch
  3256.       is ignored under linux, since linux does this for you. Only displayed when
  3257.       -vn is used.
  3258.  
  3259. Note: Ignored compiler switch arg1 With -vn on, the compiler warns if it ig-
  3260.       nores a switch
  3261.  
  3262. Warning: Illegal compiler switch arg1 You included a compiler switch (i.e.
  3263.       {$... }) which the compiler doesn't know.
  3264.  
  3265. Warning: This compiler switch has a global e ect When -vw is used, the
  3266.       compiler warns if a switch is global.
  3267.  
  3268.  
  3269.                                            57
  3270.  
  3271.  
  3272.  
  3273.                                                    C.2. SCANNER MESSAGES.
  3274.  
  3275.  
  3276. Error: Illegal char constant This happens when you specify a character with
  3277.      its ASCII code, as in #96, but the number is either illegal, or out of range.
  3278.      The range is 1-255.
  3279.  
  3280. Fatal: Can't open file arg1 Free Pascal cannot find the program or unit source
  3281.      file you specified on the command line.
  3282.  
  3283. Fatal: Can't open include file arg1 Free Pascal cannot find the source file you
  3284.      specified in a {$include ..} statement.
  3285.  
  3286. Error: Too many argENDIFs or argELSEs Your {$IFDEF ..} and {$ENDIF}
  3287.      statements aren't balanced.
  3288.  
  3289. Warning: Records fields can be aligned to 1,2,4 or 16 bytes only You are
  3290.      specifying the {$PACKRECORDS n} with an illegal value for n. Only 1,2,4 or
  3291.      16 are valid in this case.
  3292.  
  3293. Warning: Enumerated can be saved in 1,2 or 4 bytes only You are speci-
  3294.      fying the {$PACKENUM n} with an illegal value for n. Only 1,2 or 4 are valid
  3295.      in this case.
  3296.  
  3297. Error: arg1 expected for arg2 defined in line arg3 Your conditional compi-
  3298.      lation statements are unbalanced.
  3299.  
  3300. Error: Syntax error while parsing a conditional compiling expression There
  3301.      is an error in the expression following the {$if ..} compiler directive.
  3302.  
  3303. Error: Evaluating a conditional compiling expression There is an error in
  3304.      the expression following the {$if ..} compiler directive.
  3305.  
  3306. Warning: Macro contents is cut after char 255 to evalute expression The
  3307.      contents of macros canno be longer than 255 characters. This is a safety in
  3308.      the compiler, to prevent bu er overflows. This is shown as a warning, i.e.
  3309.      when the -vw switch is used.
  3310.  
  3311. Error: ENDIF without IF(N)DEF Your {$IFDEF ..} and {$ENDIF} state-
  3312.      ments aren't balanced.
  3313.  
  3314. Fatal: User defined: arg1 A user defined fatal error occurred. see also the Pro-
  3315.      grammers' guide
  3316.  
  3317. Error: User defined: arg1 A user defined error occurred. see also the Program-
  3318.      mers' guide
  3319.  
  3320. Warning: User defined: arg1 A user defined warning occurred. see also the
  3321.      Programmers' guide
  3322.  
  3323. Note: User defined: arg1 A user defined note was encountered. see also the
  3324.      Programmers' guide
  3325.  
  3326. Hint: User defined: arg1 A user defined hint was encountered. see also the
  3327.      Programmers' guide
  3328.  
  3329. Info: User defined: arg1 User defined information was encountered. see also
  3330.      the Programmers' guide
  3331.  
  3332. Error: Keyword redefined as macro has no e ect You cannot redefine key-
  3333.      words with macros.
  3334.  
  3335.  
  3336.  
  3337.                                           58
  3338.  
  3339.  
  3340.  
  3341.                                                       C.2. SCANNER MESSAGES.
  3342.  
  3343.  
  3344. Fatal: Macro bu er overflow while reading or expanding a macro Your macro
  3345.      or it's result was too long for the compiler.
  3346.  
  3347. Warning: Extension of macros exceeds a deep of 16. When expanding a macro
  3348.      macros have been nested to a level of 16. The compiler will expand no further,
  3349.      since this may be a sign that recursion is used.
  3350.  
  3351. Error: compiler switches aren't allowed in (* ... *) styled comments Compiler
  3352.      switches should always be between { } comment delimiters.
  3353.  
  3354. Handling switch "arg1" When you set debugging info on (-vd) the compiler
  3355.      tells you when it is evaluating conditional compile statements.
  3356.  
  3357. ENDIF arg1 found When you turn on conditional messages(-vc), the compiler
  3358.      tells you where it encounters conditional statements.
  3359.  
  3360. IFDEF arg1 found, arg2 When you turn on conditional messages(-vc), the com-
  3361.      piler tells you where it encounters conditional statements.
  3362.  
  3363. IFOPT arg1 found, arg2 When you turn on conditional messages(-vc), the com-
  3364.      piler tells you where it encounters conditional statements.
  3365.  
  3366. IF arg1 found, arg2 When you turn on conditional messages(-vc), the compiler
  3367.      tells you where it encounters conditional statements.
  3368.  
  3369. IFNDEF arg1 found, arg2 When you turn on conditional messages(-vc), the
  3370.      compiler tells you where it encounters conditional statements.
  3371.  
  3372. ELSE arg1 found, arg2 When you turn on conditional messages(-vc), the com-
  3373.      piler tells you where it encounters conditional statements.
  3374.  
  3375. Skipping until... When you turn on conditional messages(-vc), the compiler tells
  3376.      you where it encounters conditional statements, and whether it is skipping or
  3377.      compiling parts.
  3378.  
  3379. Info: Press íreturn┐ to continue When the -vi switch is used, the compiler
  3380.      stops compilation and waits for the Enter key to be pressed when it encounters
  3381.      a {$STOP} directive.
  3382.  
  3383. Warning: Unsupported switch arg1 When warings are turned on (-vw) the
  3384.      compiler warns you about unsupported switches. This means that the switch
  3385.      is used in Delphi or Turbo Pascal, but not in Free Pascal
  3386.  
  3387. Warning: Illegal compiler directive arg1 When warings are turned on (-vw)
  3388.      the compiler warns you about unrecognised switches. For a list of recognised
  3389.      switches, Programmers' guide
  3390.  
  3391. Back in arg1 When you use (-vt) the compiler tells you when it has finished
  3392.      reading an include file.
  3393.  
  3394. Warning: Unsupported application type: arg1 You get this warning,   you
  3395.      specify an unknown application type with the directive {$APPTYPE}
  3396.  
  3397. Warning: APPTYPE isn't support by the target OS The {$APPTYPE} di-
  3398.      rective is supported by win32 applications only.
  3399.  
  3400. Warning: Unsupported assembler style specified arg1 When you specify an
  3401.      assembler mode with the {$ASMMODE xxx} the compiler didn't recognize the
  3402.      mode you specified.
  3403.  
  3404.  
  3405.                                          59
  3406.  
  3407.  
  3408.  
  3409.                                                         C.3. PARSER MESSAGES
  3410.  
  3411.  
  3412. Warning: ASM reader switch is not possible inside asm statement, arg1 will be e ective only for next
  3413.      It is not possible to switch from one assembler reader to another inside an ass-
  3414.      mebler block. The new reader will be used for next assembler statement only.
  3415.  
  3416. Error: Wrong switch toggle, use ON/OFF or +/- You need to use ON or
  3417.      OFF or a + or - to toggle the switch
  3418.  
  3419. Error: Resource files are not supported for this target The target you are
  3420.      compiling for doesn't support Resource files. The only target which can use
  3421.      resource files is Win32
  3422.  
  3423.  
  3424. C.3 Parser messages
  3425.  
  3426. This section lists all parser messages. The parser takes care of the semantics of you
  3427. language, i.e. it determines if your pascal constructs are correct.
  3428.  
  3429. Error: Parser - Syntax Error An error against the Turbo Pascal language was
  3430.      encountered. This happens typically when an illegal character is found in the
  3431.      sources file.
  3432.  
  3433. Warning: Procedure type FAR ignored This is a warning. FAR is a construct
  3434.      for 8 or 16 bit programs. Since the compile generates 32 bit programs, it
  3435.      ignores this directive.
  3436.  
  3437. Warning: Procedure type NEAR ignored This is a warning. NEAR is a con-
  3438.      struct for 8 or 16 bit programs. Since the compile generates 32 bit programs,
  3439.      it ignores this directive.
  3440.  
  3441. Warning: Procedure type REGISTER ignored This is a warning. REGISTER
  3442.      is ignored by FPC programs for now. This is introduced first for Delphi
  3443.      compatibility.
  3444.  
  3445. Error: No DLL File specified No longer in use.
  3446.  
  3447. Error: Duplicate exported function name arg1 Exported function names in-
  3448.      side a specific DLL must all be di erent
  3449.  
  3450. Error: Duplicate exported function index arg1 Exported function names in-
  3451.      side a specific DLL must all be di erent
  3452.  
  3453. Error: Invalid index for exported function DLL function index must be in
  3454.      the range 1..$FFFF
  3455.  
  3456. Error: Constructor name must be INIT You are declaring a constructor with
  3457.      a name which isn't init, and the -Ss switch is in e ect. See the -Ss switch
  3458.      (See 5.1).
  3459.  
  3460. Error: Destructor name must be DONE You are declaring a constructor with
  3461.      a name which isn't done, and the -Ss switch is in e ect. See the -Ss switch
  3462.      (See 5.1).
  3463.  
  3464. Error: Illegal open parameter You are trying to use the wrong type for an open
  3465.      parameter.
  3466.  
  3467. Error: Procedure type INLINE not supported You tried to compile a pro-
  3468.      gram with C++ style inlining, and forgot to specify the -Si option (See 5.1).
  3469.      The compiler doesn't support C++ styled inlining by default.
  3470.  
  3471.                                          60
  3472.  
  3473.  
  3474.  
  3475.                                                        C.3. PARSER MESSAGES
  3476.  
  3477.  
  3478. Warning: Private methods shouldn't be VIRTUAL You declared a method
  3479.      in the private part of a object (class) as virtual. This is not allowed. Private
  3480.      methods cannot be overridden anyway.
  3481.  
  3482. Warning: Constructor should be public Constructors must be in the 'public'
  3483.      part of an object (class) declaration.
  3484.  
  3485. Warning: Destructor should be public Destructors must be in the 'public' part
  3486.      of an object (class) declaration.
  3487.  
  3488. Note: Class should have one destructor only You can declare only one de-
  3489.      structor for a class.
  3490.  
  3491. Error: Local class definitions are not allowed Classes must be defined glob-
  3492.      ally. They cannot be defined inside a procedure or function
  3493.  
  3494. Fatal: Anonym class definitions are not allowed An invalid object (class) dec-
  3495.      laration was encountered, i.e. an object or class without methods that isn't
  3496.      derived from another object or class. For example:
  3497.  
  3498.       Type o = object
  3499.                     a : longint;
  3500.                     end;
  3501.  
  3502.  
  3503.      will trigger this error.
  3504.  
  3505. Error: The object arg1 has no VMT
  3506.  
  3507. Error: Illegal parameter list You are calling a function with parameters that
  3508.      are of a di erent type than the declared parameters of the function.
  3509.  
  3510. Error: Wrong parameter type specified for arg no. arg1 There is an error
  3511.      in the parameter list of the function or procedure. The compiler cannot de-
  3512.      termine the error more accurate than this.
  3513.  
  3514. Error: Wrong amount of parameters specified There is an error in the pa-
  3515.      rameter list of the function or procedure, the number of parameters is not
  3516.      correct.
  3517.  
  3518. Error: overloaded identifier arg1 isn't a function The compiler encountered
  3519.      a symbol with the same name as an overloaded function, but it isn't a function
  3520.      it can overload.
  3521.  
  3522. Error: overloaded functions have the same parameter list You're declaring
  3523.      overloaded functions, but with the same parameter list. Overloaded function
  3524.      must have at least 1 di erent parameter in their declaration.
  3525.  
  3526. Error: function header doesn't match the forward declaration arg1 You de-
  3527.      clared a function with same parameters but di erent result type or function
  3528.      specifiers.
  3529.  
  3530. Error: function header arg1 doesn't match forward : var name changes arg2 =┐ arg3
  3531.      You declared the function in the interface part, or with the forward direc-
  3532.      tive, but define it with a di erent parameter list.
  3533.  
  3534. Note: Values in enumeration types have to be ascending Free Pascal allows
  3535.      enumeration constructions as in C. Given the following declaration two dec-
  3536.      larations:
  3537.  
  3538.                                           61
  3539.  
  3540.  
  3541.  
  3542.                                                         C.3. PARSER MESSAGES
  3543.  
  3544.  
  3545.       type a = (A_A,A_B,A_E:=6,A_UAS:=200);
  3546.       type a = (A_A,A_B,A_E:=6,A_UAS:=4);
  3547.  
  3548.  
  3549.      The second declaration would produce an error. A UAS needs to have a value
  3550.      higher than A E, i.e. at least 7.
  3551.  
  3552. Note: Interface and implementation names are di erent arg1 =┐ arg2 This
  3553.      note warns you if the implementation and interface names of a functions are
  3554.      di erent, but they have the same mangled name. This is important when
  3555.      using overloaded functions (but should produce no error).
  3556.  
  3557. Error: With can not be used for variables in a di erent segment With stores
  3558.      a variable locally on the stack, but this is not possible if the variable belongs
  3559.      to another segment.
  3560.  
  3561. Error: function nesting ┐ 31 You can nest function definitions only 31 times.
  3562.  
  3563. Error: range check error while evaluating constants The constants are out
  3564.      of their allowed range.
  3565.  
  3566. Warning: range check error while evaluating constants The constants are
  3567.      out of their allowed range.
  3568.  
  3569. Error: duplicate case label You are specifying the same label 2 times in a case
  3570.      statement.
  3571.  
  3572. Error: Upper bound of case range is less than lower bound The upper bound
  3573.      of a case label is less than the lower bound and this is useless
  3574.  
  3575. Error: typed constants of classes are not allowed You cannot declare a con-
  3576.      stant of type class or object.
  3577.  
  3578. Error: functions variables of overloaded functions are not allowed You are
  3579.      trying to assign an overloaded function to a procedural variable. This isn't
  3580.      allowed.
  3581.  
  3582. Error: string length must be a value from 1 to 255 The length of a string
  3583.      in Pascal is limited to 255 characters. You are trying to declare a string with
  3584.      length lower than 1 or greater than 255 (This is not true for Longstrings and
  3585.      AnsiStrings.
  3586.  
  3587. Warning: use extended syntax of NEW and DISPOSE for instances of objects
  3588.      If you have a pointer a to a class type, then the statement new(a) will not
  3589.      initialize the class (i.e. the constructor isn't called), although space will be
  3590.      allocated. you should issue the new(a,init) statement. This will allocate
  3591.      space, and call the constructor of the class.
  3592.  
  3593. Warning: use of NEW or DISPOSE for untyped pointers is meaningless
  3594.  
  3595. Error: use of NEW or DISPOSE is not possible for untyped pointers You
  3596.      cannot use new(p) or dispose(p) if p is an untyped pointer because no size
  3597.      is associated to an untyped pointer. Accepted for compatibility in tp and
  3598.      delphi modes.
  3599.  
  3600. Error: class identifier expected This happens when the compiler scans a pro-
  3601.      cedure declaration that contains a dot, i.e., a object or class method, but the
  3602.      type in front of the dot is not a known type.
  3603.  
  3604.                                           62
  3605.  
  3606.  
  3607.  
  3608.                                                       C.3. PARSER MESSAGES
  3609.  
  3610.  
  3611. Error: type identifier not allowed here You cannot use a type inside an ex-
  3612.      pression.
  3613.  
  3614. Error: method identifier expected This identifier is not a method. This hap-
  3615.      pens when the compiler scans a procedure declaration that contains a dot,
  3616.      i.e., a object or class method, but the procedure name is not a procedure of
  3617.      this type.
  3618.  
  3619. Error: function header doesn't match any method of this class This iden-
  3620.      tifier is not a method. This happens when the compiler scans a procedure dec-
  3621.      laration that contains a dot, i.e., a object or class method, but the procedure
  3622.      name is not a procedure of this type.
  3623.  
  3624. procedure/function arg1 When using the -vp switch, the compiler tells you
  3625.      when it starts processing a procedure or function implementation.
  3626.  
  3627. Error: Illegal floating point constant The compiler expects a floating point
  3628.      expression, and gets something else.
  3629.  
  3630. Error: FAIL can be used in constructors only You are using the FAIL in-
  3631.      struction outside a constructor method.
  3632.  
  3633. Error: Destructors can't have parameters You are declaring a destructor with
  3634.      a parameter list. Destructor methods cannot have parameters.
  3635.  
  3636. Error: Only class methods can be referred with class references This er-
  3637.      ror occurs in a situation like the following:
  3638.  
  3639.       Type :
  3640.              Tclass = Class of Tobject;
  3641.  
  3642.       Var C : TClass;
  3643.  
  3644.       begin
  3645.       ...
  3646.       C.free
  3647.  
  3648.  
  3649.      Free is not a class method and hence cannot be called with a class reference.
  3650.  
  3651. Error: Only class methods can be accessed in class methods This is related
  3652.      to the previous error. You cannot call a method of an object from a inside a
  3653.      class method. The following code would produce this error:
  3654.  
  3655.       class procedure tobject.x;
  3656.  
  3657.       begin
  3658.         free
  3659.  
  3660.  
  3661.      Because free is a normal method of a class it cannot be called from a class
  3662.      method.
  3663.  
  3664. Error: Constant and CASE types do not match One of the labels is not of
  3665.      the same type as the case variable.
  3666.  
  3667.  
  3668.  
  3669.                                          63
  3670.  
  3671.  
  3672.  
  3673.                                                        C.3. PARSER MESSAGES
  3674.  
  3675.  
  3676. Error: The symbol can't be exported from a library You can only export
  3677.      procedures and functions when you write a library. You cannot export vari-
  3678.      ables or constants.
  3679.  
  3680. Warning: An inherited method is hidden by arg1 A method that is declared
  3681.      virtual in a parent class, should be overridden in the descendent class with
  3682.      the override directive. If you don't specify the override directive, you will
  3683.      hide the parent method; you will not override it.
  3684.  
  3685. Error: There is no method in an ancestor class to be overridden: arg1 You
  3686.      try to override a virtual method of a parent class that doesn't exist.
  3687.  
  3688. Error: No member is provided to access property You specified no read di-
  3689.      rective for a property.
  3690.  
  3691. Warning: Stored prorperty directive is not yet implemented The stored
  3692.      directive is not yet implemented
  3693.  
  3694. Error: Illegal symbol for property access There is an error in the read or
  3695.      write directives for an array property. When you declare an array property,
  3696.      you can only access it with procedures and functions. The following code
  3697.      woud cause such an error.
  3698.  
  3699.       tmyobject = class
  3700.         i : integer;
  3701.         property x [i : integer]: integer read I write i;
  3702.  
  3703.  
  3704. Error: Cannot access a protected field of an object here Fields that are de-
  3705.      clared in a protected section of an object or class declaration cannot be ac-
  3706.      cessed outside the module wher the object is defined, or outside descendent
  3707.      object methods.
  3708.  
  3709. Error: Cannot access a private field of an object here Fields that are de-
  3710.      clared in a private section of an object or class declaration cannot be accessed
  3711.      outside the module where the class is defined.
  3712.  
  3713. Warning: overloaded method of virtual method should be virtual: arg1
  3714.      If you declare overloaded methods in a class, then they should either all be
  3715.      virtual, or none. You shouldn't mix them.
  3716.  
  3717. Warning: overloaded method of non-virtual method should be non-virtual: arg1
  3718.      If you declare overloaded methods in a class, then they should either all be
  3719.      virtual, or none. You shouldn't mix them.
  3720.  
  3721. Error: overloaded methods which are virtual must have the same return type: arg1
  3722.      If you declare virtual overloaded methods in a class definition, they must have
  3723.      the same return type.
  3724.  
  3725. Error: EXPORT declared functions can't be nested You cannot declare a
  3726.      function or procedure within a function or procedure that was declared as an
  3727.      export procedure.
  3728.  
  3729. Error: methods can't be EXPORTed You cannot declare a procedure that is
  3730.      a method for an object as exported. That is, your methods cannot be called
  3731.      from a C program.
  3732.  
  3733.  
  3734.  
  3735.                                          64
  3736.  
  3737.  
  3738.  
  3739.                                                       C.3. PARSER MESSAGES
  3740.  
  3741.  
  3742. Error: call by var parameters have to match exactly When calling a func-
  3743.      tion declared with var parameters, the variables in the function call must be
  3744.      of exactly the same type. There is no automatic type conversion.
  3745.  
  3746. Error: Class isn't a parent class of the current class When calling inherited
  3747.      methods, you are trying to call a method of a strange class. You can only call
  3748.      an inherited method of a parent class.
  3749.  
  3750. Error: SELF is only allowed in methods You are trying to use the self pa-
  3751.      rameter outside an object's method. Only methods get passed the self pa-
  3752.      rameters.
  3753.  
  3754. Error: methods can be only in other methods called direct with type identifier of the class
  3755.      A construction like sometype.somemethod is only allowed in a method.
  3756.  
  3757. Error: Illegal use of ':' You are using the format : (colon) 2 times on an ex-
  3758.      pression that is not a real expression.
  3759.  
  3760. Error: range check error in set constructor or duplicate set element The
  3761.      declaration of a set contains an error. Either one of the elements is outside
  3762.      the range of the set type, either two of the elements are in fact the same.
  3763.  
  3764. Error: Pointer to object expected You specified an illegal type in a New state-
  3765.      ment. The extended synax of New needs an object as a parameter.
  3766.  
  3767. Error: Expression must be constructor call When using the extended syntax
  3768.      of new, you must specify the constructor method of the object you are trying
  3769.      to create. The procedure you specified is not a constructor.
  3770.  
  3771. Error: Expression must be destructor call When using the extended syntax
  3772.      of dispose, you must specify the destructor method of the object you are
  3773.      trying to dispose of. The procedure you specified is not a destructor.
  3774.  
  3775. Error: Illegal order of record elements When declaring a constant record, you
  3776.      specified the fields in the wrong order.
  3777.  
  3778. Error: Expression type must be class or record type A with statement needs
  3779.      an argument that is of the type record or class. You are using with on an
  3780.      expression that is not of this type.
  3781.  
  3782. Error: Procedures can't return a value In Free Pascal, you can specify a re-
  3783.      turn value for a function when using the exit statement. This error occurs
  3784.      when you try to do this with a procedure. Procedures cannot return a value.
  3785.  
  3786. Error: constructors and destructors must be methods You're declaring a pro-
  3787.      cedure as destructor or constructor, when the procedure isn't a class method.
  3788.  
  3789. Error: Operator is not overloaded You're trying to use an overloaded operator
  3790.      when it isn't overloaded for this type.
  3791.  
  3792. Error: Re-raise isn't possible there You are trying to raise an exception where
  3793.      it isn't allowed. You can only raise exceptions in an except block.
  3794.  
  3795. Error: The extended syntax of new or dispose isn't allowed for a class You
  3796.      cannot generate an instance of a class with the extended syntax of new. The
  3797.      constructor must be used for that. For the same reason, you cannot call
  3798.      Dispose to de-allocate an instance of a class, the destructor must be used for
  3799.      that.
  3800.  
  3801.  
  3802.                                              65
  3803.  
  3804.  
  3805.  
  3806.                                                         C.3. PARSER MESSAGES
  3807.  
  3808.  
  3809. Error: Assembler incompatible with function return type You're trying to
  3810.      implement a assembler function, but the return type of the function doesn't
  3811.      allow that.
  3812.  
  3813. Error: Procedure overloading is switched o  When using the -So switch, pro-
  3814.      cedure overloading is switched o . Turbo Pascal does not support function
  3815.      overloading.
  3816.  
  3817. Error: It is not possible to overload this operator (overload = instead)
  3818.      You are trying to overload an operator which cannot be overloaded. The fol-
  3819.      lowing operators can be overloaded :
  3820.  
  3821.           +, -, *, /, =, >, <, <=, >=, is, as, in, **, :=
  3822.  
  3823.  
  3824. Error: Comparative operator must return a boolean value When overload-
  3825.      ing the = operator, the function must return a boolean value.
  3826.  
  3827. Error: Only virtual methods can be abstract You are declaring a method as
  3828.      abstract, when it isn't declared to be virtual.
  3829.  
  3830. Fatal: Use of unsupported feature! You're trying to force the compiler into
  3831.      doing something it cannot do yet.
  3832.  
  3833. Error: The mix of CLASSES and OBJECTS isn't allowed You cannot de-
  3834.      rive objects and classes intertwined . That is, a class cannot have an object
  3835.      as parent and vice versa.
  3836.  
  3837. Warning: Unknown procedure directive had to be ignored: arg1 The pro-
  3838.      cedure direcive you secified is unknown. Recognised procedure directives are
  3839.      cdecl, stdcall, popstack, pascal register, export.
  3840.  
  3841. Error: absolute can only be associated to ONE variable You cannot spec-
  3842.      ify more than one variable before the absolute directive. Thus, the following
  3843.      construct will provide this error:
  3844.  
  3845.       Var Z : Longint;
  3846.            X,Y : Longint absolute Z;
  3847.  
  3848.  
  3849. absolute can only be associated a var or const The address of a absolute
  3850.      directive can only point to a variable or constant. Therefore, the following
  3851.      code will produce this error:
  3852.  
  3853.         Procedure X;
  3854.  
  3855.        var p : longint absolute x;
  3856.  
  3857.  
  3858. Error: absolute can only be associated a var or const The address of a absolute
  3859.      directive can only point to a variable or constant. Therefore, the following
  3860.      code will produce this error:
  3861.  
  3862.         Procedure X;
  3863.  
  3864.        var p : longint absolute x;
  3865.  
  3866.  
  3867.                                            66
  3868.  
  3869.  
  3870.  
  3871.                                                          C.3. PARSER MESSAGES
  3872.  
  3873.  
  3874. Error: Only ONE variable can be initialized You cannot specify more than
  3875.      one variable with a initial value in Delphi syntax.
  3876.  
  3877. Error: Abstract methods shouldn't have any definition (with function body)
  3878.      Abstract methods can only be declared, you cannot implement them. They
  3879.      should be overridden by a descendant class.
  3880.  
  3881. Error: This overloaded function can't be local (must be exported) You are
  3882.      defining a overloaded function in the implementation part of a unit, but there
  3883.      is no corresponding declaration in the interface part of the unit.
  3884.  
  3885. Warning: Virtual methods are used without a constructor in arg1 If you
  3886.      declare objects or classes that contain virtual methods, you need to have a con-
  3887.      structor and destructor to initialize them. The compiler encountered an object
  3888.      or class with virtual methods that doesn't have a constructor/destructor pair.
  3889.  
  3890. Macro defined: arg1 When -vm is used, the compiler tells you when it defines
  3891.      macros.
  3892.  
  3893. Macro undefined: arg1 When -vm is used, the compiler tells you when it unde-
  3894.      fines macros.
  3895.  
  3896. Macro arg1 set to arg2 When -vm is used, the compiler tells you what values
  3897.      macros get.
  3898.  
  3899. Info: Compiling arg1 When you turn on information messages (-vi), the com-
  3900.      piler tells you what units it is recompiling.
  3901.  
  3902. Compiling arg1 for the second time When you request debug messages (-vd)
  3903.      the compiler tells you what units it recompiles for the second time.
  3904.  
  3905. Error: Array properties aren't allowed at this point You cannot use array
  3906.      properties at that point.a
  3907.  
  3908. Error: No property found to override You want to overrride a property of a
  3909.      parent class, when there is, in fact, no such property in the parent class.
  3910.  
  3911. Error: Only one default property is allowed, found inherited default property in class arg1
  3912.      You specified a property as Default, but a parent class already has a default
  3913.      property, and a class can have only one default property.
  3914.  
  3915. Error: The default property must be an array property Only array prop-
  3916.      erties of classes can be made default properties.
  3917.  
  3918. Error: Virtual constructors are only supported in class object model You
  3919.      cannot have virtual constructors in objects. You can only have them in classes.
  3920.  
  3921. Error: No default property available You try to access a default property of
  3922.      a class, but this class (or one of it's ancestors) doesn't have a default property.
  3923.  
  3924. Error: The class can't have a published section, use the argM+ switch If
  3925.      you want a published section in a class definition, you must use the {$M+}
  3926.      switch, whch turns on generation of type information.
  3927.  
  3928. Error: Forward declaration of class arg1 must be resolved here to use the class as ancestor
  3929.      To be able to use an object as an ancestor object, it must be defined first.
  3930.      This error occurs in the following situation:
  3931.  
  3932.  
  3933.  
  3934.                                           67
  3935.  
  3936.  
  3937.  
  3938.                                                       C.3. PARSER MESSAGES
  3939.  
  3940.  
  3941.        Type ParentClas = Class;
  3942.                  ChildClass = Class(ParentClass)
  3943.                    ...
  3944.                  end;
  3945.  
  3946.  
  3947.      Where ParentClass is declared but not defined.
  3948. Error: Local operators not supported You cannot overload locally, i.e. inside
  3949.      procedures or function definitions.
  3950. Error: Procedure directive arg1 not allowed in interface section This pro-
  3951.      cedure directive is not allowed in the interface section of a unit. You can
  3952.      only use it in the implementation section.
  3953. Error: Procedure directive arg1 not allowed in implementation section This
  3954.      procedure directive is not defined in the implementation section of a unit.
  3955.      You can only use it in the interface section.
  3956. Error: Procedure directive arg1 not allowed in procvar declaration This pro-
  3957.      cedure directive cannot be part of a procedural of function type declaration.
  3958. Error: Function is already declared Public/Forward arg1 You will get this
  3959.      error if a function is defined as forward twice. Or it is once in the interface
  3960.      section, and once as a forward declaration in the implmentation section.
  3961. Error: Can't use both EXPORT and EXTERNAL These two procedure di-
  3962.      rectives are mutually exclusive
  3963. Error: NAME keyword expected The definition of an external variable needs
  3964.      a name clause.
  3965. Warning: arg1 not yet supported inside inline procedure/function Inline
  3966.      procedures don't support this declaration.
  3967. Warning: Inlining disabled Inlining of procedures is disabled.
  3968. Info: Writing Browser log arg1 When information messages are on, the com-
  3969.      piler warns you when it writes the browser log (generated with the {$Y+ }
  3970.      switch).
  3971. Hint: may be pointer dereference is missing The compiler thinks that a pointer
  3972.      may need a dereference.
  3973. Fatal: Selected assembler reader not supported The selected assembler reader
  3974.      (with {$ASMMODE xxx} is not supported. The compiler can be compiled with
  3975.      or without support for a particular assembler reader.
  3976. Error: Procedure directive arg1 has conflicts with other directives You spec-
  3977.      ified a procedure directive that conflicts with other directives. for instance
  3978.      cdecl and pascal are mutually exclusive.
  3979. Error: Calling convention doesn't match forward This error happens when
  3980.      you declare a function or procedure with e.g. cdecl; but omit this directive
  3981.      in the implementation, or vice versa. The calling convention is part of the
  3982.      function declaration, and must be repeated in the function definition.
  3983. Error: Register calling (fastcall) not supported The register calling con-
  3984.      vention, i.e., arguments are passed in registers instead of on the stack is not
  3985.      supported. Arguments are always passed on the stack.
  3986.  
  3987.                                             68
  3988.  
  3989.  
  3990.  
  3991.                                                       C.3. PARSER MESSAGES
  3992.  
  3993.  
  3994. Error: Property can't have a default value Set properties or indexed proper-
  3995.      ties cannot have a default value.
  3996.  
  3997. Error: The default value of a property must be constant The value of a default
  3998.      declared property must be knwon at compile time. The value you specified is
  3999.      only known at run time. This happens .e.g. if you specify a variable name as
  4000.      a default value.
  4001.  
  4002. Error: Symbol can't be published, can be only a class Only class type vari-
  4003.      ables can be in a published section of a class if they are not declared as a
  4004.      property.
  4005.  
  4006. Error: That kind of property can't be published Properties in a published
  4007.      section cannot be array properties. they must be moved to public sections.
  4008.      Properties in a published section must be an ordinal type, a real type, strings
  4009.      or sets.
  4010.  
  4011. Warning: Empty import name specified Both index and name for the import
  4012.      are 0 or empty
  4013. Warning: Empty import name specified Some targets need a name for the
  4014.      imported procedure or a cdecl specifier
  4015.  
  4016. Error: Function internal name changed after use of function
  4017. Error: Division by zero There is a divsion by zero encounted
  4018.  
  4019. Error: Invalid floating point operation An operation on two real type values
  4020.      produced an overflow or a division by zero.
  4021. Error: Upper bound of range is less than lower bound The upper bound of
  4022.      a case label is less than the lower bound and this is not possible
  4023. Error: string length is larger than array of char length The size of the con-
  4024.      stant string is larger than the size you specified in the array[x..y] of char
  4025.      definition
  4026.  
  4027. Error: Illegal expression after message directive Free Pascal supports only
  4028.      integer or string values as message constants
  4029. Error: Message handlers can take only one call by ref. parameter A method
  4030.      declared with the message-directive as message handler can take only one pa-
  4031.      rameter which must be declared as call by reference Parameters are declared
  4032.      as call by reference using the var-directive
  4033.  
  4034. Error: Duplicate message label: arg1 A label for a message is used twice in
  4035.      one object/class
  4036.  
  4037. Error: Self can be only an explicit parameter in message handlers The self
  4038.      parameter can be passed only explicit if it is a method which is declared as
  4039.      message method handler
  4040.  
  4041. Error: Threadvars can be only static or global Threadvars must be static or
  4042.      global, you can't declare a thread local to a procedure. Local variables are
  4043.      always local to a thread, because every thread has it's own stack and local
  4044.      variables are stored on the stack
  4045.  
  4046. Fatal: Direct assembler not supported for binary output format You can't
  4047.      use direct assembler when using a binary writer, choose an other outputformat
  4048.      or use an other assembler reader
  4049.  
  4050.                                           69
  4051.  
  4052.  
  4053.  
  4054.                                                  C.4. TYPE CHECKING ERRORS
  4055.  
  4056.  
  4057. Warning: Don't load OBJPAS unit manual, use argmode objfpc or argmode delphi instead
  4058.      You're trying to load the ObjPas unit manual from a uses clause. This is not a
  4059.      good idea to do, you can better use the {$mode objfpc} or {$mode delphi}
  4060.      directives which load the unit automaticly
  4061.  
  4062. Error: OVERRIDE can't be used in objects Override isn't support for ob-
  4063.      jects, use VIRTUAL instead to override a method of an anchestor object
  4064.  
  4065. Error: Data types which requires initialization/finalization can't be used in variant records
  4066.      Some data type (e.g. ansistring) needs initialization/finalization code which
  4067.      is implicitly generated by the compiler. Such data types can't be used in the
  4068.      variant part of a record.
  4069.  
  4070.  
  4071. C.4 Type checking errors
  4072.  
  4073. This section lists all errors that can occur when type checking is performed.
  4074.  
  4075. Error: Type mismatch This can happen in many cases:
  4076.  
  4077.         * The variable you're assigning to is of a di erent type than the expression
  4078.           in the assignment.
  4079.         * You are calling a function or procedure with parameters that are incom-
  4080.           patible with the parameters in the function or procedure definition.
  4081.  
  4082. Error: Incompatible types: got "arg1" expected "arg2" There is no con-
  4083.      version possible between the two types Another possiblity is that they are
  4084.      declared in di erent declarations:
  4085.  
  4086.        VarA1 : Array[1..10] Of Integer;
  4087.           A2 : Array[1..10] Of Integer;
  4088.  
  4089.        Begin
  4090.           A1:=A2; { This statement gives also this error, it
  4091.                       is due the strict type checking of pascal }
  4092.        End.
  4093.  
  4094.  
  4095. Error: Type mismatch between arg1 and arg2 The types are not equal
  4096.  
  4097. Error: Integer expression expected The compiler expects an expression of type
  4098.      integer, but gets a di erent type.
  4099.  
  4100. Error: Ordinal expression expected The expression must be of ordinal type,
  4101.      i.e., maximum a Longint. This happens, for instance, when you specify a
  4102.      second argument to Inc or Dec that doesn't evaluate to an ordinal value.
  4103.  
  4104. Error: Type identifier expected The identifier is not a type, or you forgot to
  4105.      supply a type identifier.
  4106.  
  4107. Error: Variable identifier expected This happens when you pass a constant to
  4108.      a Inc var or Dec procedure. You can only pass variables as arguments to these
  4109.      functions.
  4110.  
  4111. Error: pointer type expected The variable or expression isn't of the type pointer.
  4112.      This happens when you pass a variable that isn't a pointer to New or Dispose.
  4113.  
  4114.                                            70
  4115.  
  4116.  
  4117.  
  4118.                                                 C.4. TYPE CHECKING ERRORS
  4119.  
  4120.  
  4121. Error: class type expected The variable of expression isn't of the type class.
  4122.      This happens typically when
  4123.  
  4124.        1. The parent class in a class declaration isn't a class.
  4125.        2. An exception handler (On) contains a type identifier that isn't a class.
  4126.  
  4127. Error: Variable or type indentifier expected The argument to the High or
  4128.      Low function is not a variable nor a type identifier.
  4129.  
  4130. Error: Can't evaluate constant expression No longer in use.
  4131.  
  4132. Error: Set elements are not compatible You are trying to make an operation
  4133.      on two sets, when the set element types are not the same. The base type of
  4134.      a set must be the same when taking the union
  4135.  
  4136. Error: Operation not implemented for sets several binary operations are not
  4137.      defined for sets like div mod ** (also ┐= í= for now)
  4138.  
  4139. Warning: Automatic type conversion from floating type to COMP which is an integer type
  4140.      An implicit type conversion from a real type to a comp is encountered. Since
  4141.      Comp is a 64 bit integer type, this may indicate an error.
  4142.  
  4143. Hint: use DIV instead to get an integer result When hints are on, then an
  4144.      integer division with the '/' operator will procuce this message, because the
  4145.      result will then be of type real
  4146.  
  4147. Error: string types doesn't match, because of argV+ mode When compil-
  4148.      ing in {$V+} mode, the string you pass as a parameter should be of the exact
  4149.      same type as the declared parameter of the procedure.
  4150.  
  4151. Error: succ or pred on enums with assignments not possible When you de-
  4152.      clared an enumeration type which has assignments in it, as in C, like in the
  4153.      following:
  4154.  
  4155.          Tenum = (a,b,e:=5);
  4156.  
  4157.  
  4158.      you cannot use the Succ or Pred functions on them.
  4159.  
  4160. Error: Can't read or write variables of this type You are trying to read or
  4161.      write a variable from or to a file of type text, which doesn't support that.
  4162.      Only integer types, booleans, reals, pchars and strings can be read from/written
  4163.      to a text file.
  4164.  
  4165. Error: Type conflict between set elements There is at least one set element
  4166.      which is of the wrong type, i.e. not of the set type.
  4167.  
  4168. Warning: lo/hi(dword/qword) returns the upper/lower word/dword Free
  4169.      Pascal supports an overloaded version of lo/hi for longint/dword/int64/qword
  4170.      which returns the lower/upper word/dword of the argument. TP always uses
  4171.      a 16 bit lo/hi which returns always bits 0..7 for lo and the bits 8..15 for
  4172.      hi. If you want the TP behavior you have to type cast the argument to
  4173.      word/integer
  4174.  
  4175. Error: Integer or real expression expected The first argument to str must a
  4176.      real or integer type.
  4177.  
  4178. Error: Wrong type in array constructor You are trying to use a type in an
  4179.      array constructor which is not allowed.
  4180.  
  4181.                                          71
  4182.  
  4183.  
  4184.  
  4185.                                                          C.5. SYMBOL HANDLING
  4186.  
  4187.  
  4188. Error: Incompatible type for arg no. arg1: Got arg2, expected arg3 You
  4189.      are trying to pass an invalid type for the specified parameter.
  4190. Error: Method (variable) and Procedure (variable) are not compatible You
  4191.      can't assign a method to a procedure variable or a procedure to a method
  4192.      pointer.
  4193. Error: Illegal constant passed to internal math function The constant ar-
  4194.      gument passed to a ln or sqrt function is out of the definition range of these
  4195.      functions.
  4196. Error: Can't get the address of constants It's not possible to get the address
  4197.      of a constant, because they aren't stored in memory, you can try making it a
  4198.      typed constant.
  4199.  
  4200.  
  4201. C.5 Symbol handling
  4202.  
  4203. This section lists all the messages that concern the handling of symbols. This means
  4204. all things that have to do with procedure and variable names.
  4205.  
  4206. Error: Identifier not found arg1 The compiler doesn't know this symbol. Usu-
  4207.      ally happens when you misspel the name of a variable or procedure, or when
  4208.      you forgot to declare a variable.
  4209. Fatal: Internal Error in SymTableStack() An internal error occurred in the
  4210.      compiler; If you encounter such an error, please contact the developers and
  4211.      try to provide an exact description of the circumstances in which the error
  4212.      occurs.
  4213. Error: Duplicate identifier arg1 The identifier was already declared in the cur-
  4214.      rent scope.
  4215. Hint: Identifier already defined in arg1 at line arg2 The identifier was al-
  4216.      ready declared in a previous scope.
  4217. Error: Unknown identifier arg1 The identifier encountered hasn't been declared,
  4218.      or is used outside the scope where it's defined.
  4219. Error: Forward declaration not solved arg1 This can happen in two cases:
  4220.         * This happens when you declare a function (in the interface part, or
  4221.               with a forward directive, but do not implement it.
  4222.         * You reference a type which isn't declared in the current type block.
  4223. Fatal: Identifier type already defined as type You are trying to redefine a
  4224.      type.
  4225. Error: Error in type definition There is an error in your definition of a new
  4226.      array type:
  4227.  One of the range delimiters in an array declaration is erroneous. For example,
  4228.      Array [1..1.25] will trigger this error.
  4229. Error: Type identifier not defined The type identifier has not been defined
  4230.      yet.
  4231. Error: Forward type not resolved arg1 The compiler encountered an unknown
  4232.      type.
  4233.  
  4234.                                           72
  4235.  
  4236.  
  4237.  
  4238.                                                        C.5. SYMBOL HANDLING
  4239.  
  4240.  
  4241. Error: Only static variables can be used in static methods or outside methods
  4242.      A static method of an object can only access static variables.
  4243. Error: Invalid call to tvarsym.mangledname() An internal error occurred in
  4244.      the compiler; If you encounter such an error, please contact the developers
  4245.      and try to provide an exact description of the circumstances in which the
  4246.      error occurs.
  4247. Fatal: record or class type expected The variable or expression isn't of the
  4248.      type record or class.
  4249. Error: Instances of classes or objects with an abstract method are not allowed
  4250.      You are trying to generate an instance of a class which has an abstract method
  4251.      that wasn't overridden.
  4252. Warning: Label not defined arg1 A label was declared, but not defined.
  4253. Error: Illegal label declaration
  4254. Error: GOTO and LABEL are not supported (use switch -Sg) You must
  4255.      compile a program which has labels and goto statements with the -Sg switch.
  4256.      By default, label and goto aren't supported.
  4257. Error: Label not found A goto label was encountered, but the label isn't de-
  4258.      clared.
  4259. Error: identifier isn't a label The identifier specified after the goto isn't of type
  4260.      label.
  4261. Error: label already defined You are defining a label twice. You can define a
  4262.      label only once.
  4263. Error: illegal type declaration of set elements The declaration of a set con-
  4264.      tains an invalid type definition.
  4265. Error: Forward class definition not resolved arg1 You declared a class, but
  4266.      you didn't implement it.
  4267. Hint: Parameter not used arg1 This is a warning. The identifier was declared
  4268.      (locally or globally) but wasn't used (locally or globally).
  4269. Note: Local variable not used arg1 You have declared, but not used a variable
  4270.      in a procedure or function implementation.
  4271. Error: Set type expected The variable or expression isn't of type set. This
  4272.      happens in an in statement.
  4273. Warning: Function result does not seem to be set You can get this warning
  4274.      if the compiler thinks that a function return value is not set. This will not
  4275.      be displayed for assembler procedures, or procedures that contain assembler
  4276.      blocks.
  4277. Error: Unknown record field identifier arg1 The field doesn't exist in the record
  4278.      definition.
  4279. Warning: Local variable arg1 does not seem to be initialized
  4280. Warning: Variable arg1 does not seem to be initialized These messages are
  4281.      displayed if the compiler thinks that a variable will be used (i.e. appears in the
  4282.      right-hand-side of an expression) when it wasn't initialized first (i.e. appeared
  4283.      in the left-hand side of an assigment)
  4284.  
  4285.                                           73
  4286.  
  4287.  
  4288.  
  4289.                                           C.6. CODE GENERATOR MESSAGES
  4290.  
  4291.  
  4292. Error: identifier idents no member arg1 When using the extended syntax of
  4293.      new, you must specify the constructor method of the class you are trying to
  4294.      create. The procedure you specified does not exist.
  4295.  
  4296. Found declaration: arg1 You get this when you use the -vb switch. In case an
  4297.      overloaded procedure is not found, then all candidate overloaded procedures
  4298.      are listed, with their parameter lists.
  4299.  
  4300.  
  4301. C.6 Code generator messages
  4302.  
  4303. This section lists all messages that can be displayed if the code generator encounters
  4304. an error condition.
  4305.  
  4306. Error: BREAK not allowed You're trying to use break outside a loop construc-
  4307.      tion.
  4308.  
  4309. Error: CONTINUE not allowed You're trying to use continue outside a loop
  4310.      construction.
  4311.  
  4312. Error: Expression too complicated - FPU stack overflow Your expression is
  4313.      too long for the compiler. You should try dividing the construct over multiple
  4314.      assignments.
  4315.  
  4316. Error: Illegal expression This can occur under many circumstances. Mostly
  4317.      when trying to evaluate constant expressions.
  4318.  
  4319. Error: Invalid integer expression You made an expression which isn't an inte-
  4320.      ger, and the compiler expects the result to be an integer.
  4321.  
  4322. Error: Illegal qualifier One of the following is happening :
  4323.  
  4324.         * You're trying to access a field of a variable that is not a record.
  4325.         * You're indexing a variable that is not an array.
  4326.         * You're dereferencing a variable that is not a pointer.
  4327.  
  4328. Error: High range limit í low range limit You are declaring a subrange, and
  4329.      the lower limit is higher than the high limit of the range.
  4330.  
  4331. Error: Illegal counter variable The type of a for loop variable must be an
  4332.      ordinal type. Loop variables cannot be reals or strings.
  4333.  
  4334. Error: Can't determine which overloaded function to call You're calling over-
  4335.      loaded functions with a parameter that doesn't correspond to any of the de-
  4336.      clared function parameter lists. e.g. when you have declared a function with
  4337.      parameters word and longint, and then you call it with a parameter which
  4338.      is of type integer.
  4339.  
  4340. Error: Parameter list size exceeds 65535 bytes The I386 processor limits the
  4341.      parameter list to 65535 bytes (the RET instruction causes this)
  4342.  
  4343. Error: Illegal type conversion When doing a type-cast, you must take care that
  4344.      the sizes of the variable and the destination type are the same.
  4345.  
  4346. Conversion between ordinals and pointers is not portable across platforms
  4347.      If you typecast a pointer to a longint, this code will not compile on a machine
  4348.      using 64bit for pointer storage.
  4349.  
  4350.  
  4351.                                          74
  4352.  
  4353.  
  4354.  
  4355.                                           C.6. CODE GENERATOR MESSAGES
  4356.  
  4357.  
  4358. Error: File types must be var parameters You cannot specify files as value
  4359.      parameters, i.e. they must always be declared var parameters.
  4360.  
  4361. Error: The use of a far pointer isn't allowed there Free Pascal doesn't sup-
  4362.      port far pointers, so you cannot take the address of an expression which has
  4363.      a far reference as a result. The mem construct has a far reference as a result,
  4364.      so the following code will produce this error:
  4365.  
  4366.       var p : pointer;
  4367.       ...
  4368.       p:=@mem[a000:000];
  4369.  
  4370.  
  4371. Error: illegal call by reference parameters You are trying to pass a constant
  4372.      or an expression to a procedure that requires a var parameter. Only variables
  4373.      can be passed as a var parameter.
  4374.  
  4375. Error: EXPORT declared functions can't be called No longer in use.
  4376.  
  4377. Warning: Possible illegal call of constructor or destructor (doesn't match to this context)
  4378.      No longer in use.
  4379.  
  4380. Note: Ine cient code You construction seems dubious to the compiler.
  4381.  
  4382. Warning: unreachable code You specified a loop which will never be executed.
  4383.      Example:
  4384.  
  4385.       while false do
  4386.         begin
  4387.         {.. code ...}
  4388.         end;
  4389.  
  4390.  
  4391. Error: procedure call with stackframe ESP/SP The compiler encountered a
  4392.      procedure or function call inside a procedure that uses a ESP/SP stackframe.
  4393.      Normally, when a call is done the procedure needs a EBP stackframe.
  4394.  
  4395. Error: Abstract methods can't be called directly You cannot call an abstract
  4396.      method directy, instead you must call a overriding child method, because an
  4397.      abstract method isn't implemented.
  4398.  
  4399. Fatal: Internal Error in getfloatreg(), allocation failure An internal error oc-
  4400.      curred in the compiler; If you encounter such an error, please contact the de-
  4401.      velopers and try to provide an exact description of the circumstances in which
  4402.      the error occurs.
  4403.  
  4404. Fatal: Unknown float type The compiler cannot determine the kind of float
  4405.      that occurs in an expression.
  4406.  
  4407. Fatal: SecondVecn() base defined twice An internal error occurred in the com-
  4408.      piler; If you encounter such an error, please contact the developers and try to
  4409.      provide an exact description of the circumstances in which the error occurs.
  4410.  
  4411. Fatal: Extended cg68k not supported The varextended type is not supported
  4412.      on the m68k platform.
  4413.  
  4414. Fatal: 32-bit unsigned not supported in MC68000 mode The cardinal is not
  4415.      supported on the m68k platform.
  4416.  
  4417.                                         75
  4418.  
  4419.  
  4420.  
  4421.                                                C.7. UNIT LOADING MESSAGES.
  4422.  
  4423.  
  4424. Fatal: Internal Error in secondinline() An internal error occurred in the com-
  4425.      piler; If you encounter such an error, please contact the developers and try to
  4426.      provide an exact description of the circumstances in which the error occurs.
  4427.  
  4428. Register arg1 weight arg2 arg3 Debugging message. Shown when the compiler
  4429.      considers a variable for keeping in the registers.
  4430.  
  4431. Error: Stack limit excedeed in local routine Your code requires a too big stack.
  4432.      Some operating systems pose limits on the stack size. You should use less vari-
  4433.      ables or try ro put large variables on the heap.
  4434.  
  4435. Stack frame is omitted Some procedure/functions do not need a complete stack-
  4436.      frame, so it is omitted. This message will be displayed when the -vd switch
  4437.      is used.
  4438.  
  4439. Error: Object or class methods can't be inline. You cannot have inlined ob-
  4440.      ject methods.
  4441.  
  4442. Error: Procvar calls can't be inline. A procedure with a procedural variable
  4443.      call cannot be inlined.
  4444.  
  4445. Error: No code for inline procedure stored The compiler couldn't store code
  4446.      for the inline procedure.
  4447.  
  4448. Error: Element zero of an ansi/wide- or longstring can't be accessed, use (set)length instead
  4449.      You should use setlength to set the length of an ansi/wide/longstring and
  4450.      length to get the length of such kinf of string
  4451.  
  4452. Error: Include and exclude not implemented in this case include and exclude
  4453.      are only partially implemented for i386 processors and not at all for m68k pro-
  4454.      cessors.
  4455.  
  4456. Error: Constructors or destructors can not be called inside a 'with' clause
  4457.      Inside a With clause you cannot call a constructor or destructor for the object
  4458.      you have in the with clause.
  4459.  
  4460. Error: Cannot call message handler method directly A message method han-
  4461.      dler method can't be called directly if it contains an explicit self argument
  4462.  
  4463.  
  4464. C.7 Unit loading messages.
  4465.  
  4466. This section lists all messages that can occur when the compiler is loading a unit
  4467. from disk into memory. Many of these mesages are informational messages.
  4468.  
  4469. Unitsearch: arg1 When you use the -vt, the compiler tells you where it tries to
  4470.      find unit files.
  4471.  
  4472. PPU Loading arg1 When the -vt switch is used, the compiler tells you what
  4473.      units it loads.
  4474.  
  4475. PPU Name: arg1 When you use the -vu flag, the unit name is shown.
  4476.  
  4477. PPU Flags: arg1 When you use the -vu flag, the unit flags are shown.
  4478.  
  4479. PPU Crc: arg1 When you use the -vu flag, the unit CRC check is shown.
  4480.  
  4481. PPU Time: arg1 When you use the -vu flag, the unit time is shown.
  4482.  
  4483.  
  4484.                                          76
  4485.  
  4486.  
  4487.  
  4488.                                                  C.7. UNIT LOADING MESSAGES.
  4489.  
  4490.  
  4491. PPU File too short When you use the -vu flag, the unit time is shown.
  4492.  
  4493. PPU Invalid Header (no PPU at the begin) A unit file contains as the first
  4494.      three bytes the ascii codes of PPU
  4495.  
  4496. PPU Invalid Version arg1 This unit file was compiled with a di erent version
  4497.      of the compiler, and cannot be read.
  4498.  
  4499. PPU is compiled for an other processor This unit file was compiled for a dif-
  4500.      ferent processor type, and cannot be read
  4501.  
  4502. PPU is compiled for an other target This unit file was compiled for a di er-
  4503.      ent processor type, and cannot be read
  4504.  
  4505. PPU Source: arg1 When you use the -vu flag, the unit CRC check is shown.
  4506.  
  4507. Writing arg1 When you specify the -vu switch, the compiler will tell you where
  4508.      it writes the unit file.
  4509.  
  4510. Fatal: Can't Write PPU-File An err
  4511.  
  4512. Fatal: reading PPU-File Unexpected end of file
  4513.  
  4514. Fatal: unexpected end of PPU-File This means that the unit file was cor-
  4515.      rupted, and contains invalid information. Recompilation will be necessary.
  4516.  
  4517. Fatal: Invalid PPU-File entry: arg1 The unit the compiler is trying to read is
  4518.      corrupted, or generated with a newer version of the compiler.
  4519.  
  4520. Fatal: PPU Dbx count problem There is an inconsistency in the debugging
  4521.      information of the unit.
  4522.  
  4523. Error: Illegal unit name: arg1 The name of the unit doesn't match the file
  4524.      name.
  4525.  
  4526. Fatal: Too much units Free Pascal has a limit of 1024 units in a program. You
  4527.      can change this behavior by changing the maxunits constant in the files.pas
  4528.      file of the compiler, and recompiling the compiler.
  4529.  
  4530. Fatal: Circular unit reference between arg1 and arg2 Two units are using
  4531.      each other in the interface part. This is only allowed in the implementation
  4532.      part. At least one unit must contain the other one in the implementation
  4533.      section.
  4534.  
  4535. Fatal: Can't compile unit arg1, no sources available A unit was found that
  4536.      needs to be recompiled, but no sources are available.
  4537.  
  4538. Warning: Compiling the system unit requires the -Us switch When recom-
  4539.      piling the system unit (it needs special treatment), the -Us must be specified.
  4540.  
  4541. Fatal: There were arg1 errors compiling module, stopping When the com-
  4542.      piler encounters a fatal error or too many errors in a module then it stops with
  4543.      this message.
  4544.  
  4545. Load from arg1 (arg2) unit arg3 When you use the -vu flag, which unit is
  4546.      loaded from which unit is shown.
  4547.  
  4548. Recompiling arg1, checksum changed for arg2
  4549.  
  4550. Recompiling arg1, source found only When you use the -vu flag, these mes-
  4551.      sages tell you why the current unit is recompiled.
  4552.  
  4553.                                            77
  4554.  
  4555.  
  4556.  
  4557.                                     C.8. COMMAND-LINE HANDLING ERRORS
  4558.  
  4559.  
  4560. Recompiling unit, static lib is older than ppufile When you use the -vu flag,
  4561.       the compiler warns if the static library of the unit are older than the unit file
  4562.       itself.
  4563.  
  4564. Recompiling unit, shared lib is older than ppufile When you use the -vu flag,
  4565.       the compiler warns if the shared library of the unit are older than the unit file
  4566.       itself.
  4567.  
  4568. Recompiling unit, obj and asm are older than ppufile When you use the -vu
  4569.       flag, the compiler warns if the assembler of object file of the unit are older
  4570.       than the unit file itself.
  4571.  
  4572. Recompiling unit, obj is older than asm When you use the -vu flag, the com-
  4573.       piler warns if the assembler file of the unit is older than the object file of the
  4574.       unit.
  4575.  
  4576. Parsing interface of arg1 When you use the -vu flag, the compiler warns that
  4577.       it starts parsing the interface part of the unit
  4578.  
  4579. Parsing implementation of arg1 When you use the -vu flag, the compiler warns
  4580.       that it starts parsing the implementation part of the unit
  4581.  
  4582. Second load for unit arg1 When you use the -vu flag, the compiler warns that
  4583.       it starts recompiling a unit for the second time. This can happend with
  4584.       interdepend units.
  4585.  
  4586. PPU Check file arg1 time arg2 When you use the -vu flag, the compiler show
  4587.       the filename and date and time of the file which a recompile depends on
  4588.  
  4589.  
  4590. C.8 Command-line handling errors
  4591.  
  4592. This section lists errors that occur when the compiler is processing the command
  4593. line or handling the configuration files.
  4594.  
  4595. Warning: Only one source file supported You can specify only one source file
  4596.       on the command line. The first one will be compiled, others will be ignored.
  4597.       This may indicate that you forgot a '-' sign.
  4598.  
  4599. Warning: DEF file can be created only for OS/2 This option can only be
  4600.       specified when you're compiling for OS/2
  4601.  
  4602. Error: nested response files are not supported you cannot nest response files
  4603.       with the @file command-line option.
  4604.  
  4605. Fatal: No source file name in command line The compiler expects a source
  4606.       file name on the command line.
  4607.  
  4608. Error: Illegal parameter: arg1 You specified an unknown option.
  4609.  
  4610. Hint: -? writes help pages When an unknown option is given, this message is
  4611.       diplayed.
  4612.  
  4613. Fatal: Too many config files nested You can only nest up to 16 config files.
  4614.  
  4615. Fatal: Unable to open file arg1 The option file cannot be found.
  4616.  
  4617. Note: Reading further options from arg1 Displayed when you have notes turned
  4618.       on, and the compiler switches to another options file.
  4619.  
  4620.                                              78
  4621.  
  4622.  
  4623.  
  4624.                                           C.9. ASSEMBLER READER ERRORS.
  4625.  
  4626.  
  4627. Warning: Target is already set to: arg1 Displayed if more than one -T option
  4628.      is specified.
  4629.  
  4630. Warning: Shared libs not supported on DOS platform, reverting to static
  4631.      If you specify -CD for the dos platform, this message is displayed. The com-
  4632.      piler supports only static libraries under dos
  4633.  
  4634. Fatal: too many IF(N)DEFs the #IF(N)DEF statements in the options file are
  4635.      not balanced with the #ENDIF statements.
  4636.  
  4637. Fatal: too many ENDIFs the #IF(N)DEF statements in the options file are not
  4638.      balanced with the #ENDIF statements.
  4639.  
  4640. Fatal: open conditional at the end of the file the #IF(N)DEF statements in
  4641.      the options file are not balanced with the #ENDIF statements.
  4642.  
  4643. Warning: Debug information generation is not supported by this executable
  4644.      It is possible to have a compiler executable that doesn't support the genera-
  4645.      tion of debugging info. If you use such an executable with the -g switch, this
  4646.      warning will be displayed.
  4647.  
  4648. Hint: Try recompiling with -dGDB It is possible to have a compiler executable
  4649.      that doesn't support the generation of debugging info. If you use such an ex-
  4650.      ecutable with the -g switch, this warning will be displayed.
  4651.  
  4652. Error: You are using the obsolete switch arg1 this warns you when you use
  4653.      a switch that is not needed/supported anymore. It is recommended that
  4654.      you remove the switch to overcome problems in the future, when the switch
  4655.      meaning may change.
  4656.  
  4657. Error: You are using the obsolete switch arg1, please use arg2 this warns
  4658.      you when you use a switch that is not supported anymore. You must now use
  4659.      the second switch instead. It is recommended that you change the switch to
  4660.      overcome problems in the future, when the switch meaning may change.
  4661.  
  4662. Note: Switching assembler to default source writing assembler this noti-
  4663.      fies you that the assembler has been changed because you used the -a switch
  4664.      which can't be used with a binary assembler writer.
  4665.  
  4666.  
  4667. C.9 Assembler reader errors.
  4668.  
  4669. This section lists the errors that are generated by the inline assembler reader. They
  4670. are not the messages of the assembler itself.
  4671.  
  4672.  
  4673. General assembler errors
  4674. Divide by zero in asm evaluator This fatal error is reported when a constant
  4675.      assembler expressions does a division by zero.
  4676.  
  4677. Evaluator stack overflow, Evaluator stack underflow These fatal errors are
  4678.      reported when a constant assembler expression is too big to evaluate by the
  4679.      constant parser. Try reducing the number of terms.
  4680.  
  4681. Invalid numeric format in asm evaluator This fatal error is reported when a
  4682.      non-numeric value is detected by the constant parser. Normally this error
  4683.      should never occur.
  4684.  
  4685.                                          79
  4686.  
  4687.  
  4688.  
  4689.                                           C.9. ASSEMBLER READER ERRORS.
  4690.  
  4691.  
  4692. Invalid Operator in asm evaluator This fatal error is reported when a math-
  4693.      ematical operator is detected by the constant parser. Normally this error
  4694.      should never occur.
  4695.  
  4696. Unknown error in asm evaluator This fatal error is reported when an internal
  4697.      error is detected by the constant parser. Normally this error should never
  4698.      occur.
  4699.  
  4700. Invalid numeric value This warning is emitted when a conversion from octal,binary
  4701.      or hexadecimal to decimal is outside of the supported range.
  4702.  
  4703. Escape sequence ignored This error is emitted when a non ANSI C escape se-
  4704.      quence is detected in a C string.
  4705.  
  4706. Asm syntax error - Prefix not found This occurs when trying to use a non-
  4707.      valid prefix instruction
  4708.  
  4709. Asm syntax error - Trying to add more than one prefix This occurs when
  4710.      you try to add more than one prefix instruction
  4711.  
  4712. Asm syntax error - Opcode not found You have tried to use an unsupported
  4713.      or unknown opcode
  4714.  
  4715. Constant value out of bounds This error is reported when the constant parser
  4716.      determines that the value you are using is out of bounds, either with the
  4717.      opcode or with the constant declaration used.
  4718.  
  4719. Non-label pattern contains @ This only applied to the m68k and Intel styled
  4720.      assembler, this is reported when you try to use a non-label identifier with a
  4721.      '@' prefix.
  4722.  
  4723. Internal error in Findtype()
  4724.  
  4725. Internal Error in ConcatOpcode()
  4726.  
  4727. Internal Errror converting binary
  4728.  
  4729. Internal Errror converting hexadecimal
  4730.  
  4731. Internal Errror converting octal
  4732.  
  4733. Internal Error in BuildScaling()
  4734.  
  4735. Internal Error in BuildConstant()
  4736.  
  4737. internal error in BuildReference()
  4738.  
  4739. internal error in HandleExtend()
  4740.  
  4741. Internal error in ConcatLabeledInstr() These errors should never occur, if
  4742.      they do then you have found a new bug in the assembler parsers. Please
  4743.      contact one of the developers.
  4744.  
  4745. Opcode not in table, operands not checked This warning only occurs when
  4746.      compiling the system unit, or related files. No checking is performed on the
  4747.      operands of the opcodes.
  4748.  
  4749. @CODE and @DATA not supported This Turbo Pascal construct is not sup-
  4750.      ported.
  4751.  
  4752. SEG and OFFSET not supported This Turbo Pascal construct is not supported.
  4753.  
  4754.                                           80
  4755.  
  4756.  
  4757.  
  4758.                                          C.9. ASSEMBLER READER ERRORS.
  4759.  
  4760.  
  4761. Modulo not supported Modulo constant operation is not supported.
  4762.  
  4763. Floating point binary representation ignored
  4764.  
  4765. Floating point hexadecimal representation ignored
  4766.  
  4767. Floating point octal representation ignored These warnings occur when a float-
  4768.      ing point constant are declared in a base other then decimal. No conversion
  4769.      can be done on these formats. You should use a decimal representation in-
  4770.      stead.
  4771.  
  4772. Identifier supposed external This warning occurs when a symbol is not found
  4773.      in the symolb table, it is therefore considered external.
  4774.  
  4775. Functions with void return value can't return any value in asm code Only
  4776.      routines with a return value can have a return value set.
  4777.  
  4778. Error in binary constant
  4779.  
  4780. Error in octal constant
  4781.  
  4782. Error in hexadecimal constant
  4783.  
  4784. Error in integer constant These errors are reported when you tried using an
  4785.      invalid constant expression, or that the value is out of range.
  4786.  
  4787. Invalid labeled opcode
  4788.  
  4789. Asm syntax error - error in reference
  4790.  
  4791. Invalid Opcode
  4792.  
  4793. Invalid combination of opcode and operands
  4794.  
  4795. Invalid size in reference
  4796.  
  4797. Invalid middle sized operand
  4798.  
  4799. Invalid three operand opcode
  4800.  
  4801. Assembler syntax error
  4802.  
  4803. Invalid operand type You tried using an invalid combination of opcode and
  4804.      operands, check the syntax and if you are sure it is correct, please contact
  4805.      one of the developers.
  4806.  
  4807. Unknown identifier The identifier you are trying to access does not exist, or is
  4808.      not within the current scope.
  4809.  
  4810. Trying to define an index register more than once
  4811.  
  4812. Trying to define a segment register twice
  4813.  
  4814. Trying to define a base register twice You are trying to define an index/segment
  4815.      register more then once.
  4816.  
  4817. Invalid field specifier The record or object field you are trying to access does not
  4818.      exist, or is incorrect.
  4819.  
  4820. Invalid scaling factor
  4821.  
  4822. Invalid scaling value
  4823.  
  4824.  
  4825.                                         81
  4826.  
  4827.  
  4828.  
  4829.                                              C.9. ASSEMBLER READER ERRORS.
  4830.  
  4831.  
  4832. Scaling value only allowed with index Allowed scaling values are 1,2,4 or 8.
  4833.  
  4834. Cannot use SELF outside a method You are trying to access the SELF iden-
  4835.      tifier for objects outside a method.
  4836.  
  4837. Invalid combination of prefix and opcode This opcode cannot be prefixed by
  4838.      this instruction
  4839.  
  4840. Invalid combination of override and opcode This opcode cannot be overri-
  4841.      den by this combination
  4842.  
  4843. Too many operands on line At most three operand instructions exist on the
  4844.      m68k, and i386, you are probably trying to use an invalid syntax for this
  4845.      opcode.
  4846.  
  4847. Duplicate local symbol You are trying to redefine a local symbol, such as a local
  4848.      label.
  4849.  
  4850. Unknown label identifer
  4851.  
  4852. Undefined local symbol
  4853.  
  4854. local symbol not found inside asm statement This label does not seem to
  4855.      have been defined in the current scope
  4856.  
  4857. Assemble node syntax error
  4858.  
  4859. Not a directive or local symbol The assembler statement is invalid, or you are
  4860.      not using a recognized directive.
  4861.  
  4862.  
  4863. I386 specific errors
  4864. repeat prefix and a segment override on <= i386 ... A problem with interrupts
  4865.      and a prefix instruction may occur and may cause false results on 386 and
  4866.      earlier computers.
  4867.  
  4868. Fwait can cause emulation problems with emu387 This warning is reported
  4869.      when using the FWAIT instruction, it can cause emulation problems on sys-
  4870.      tems which use the em387.dxe emulator.
  4871.  
  4872. You need GNU as version ┐= 2.81 to compile this MMX code MMX as-
  4873.      sembler code can only be compiled using GAS v2.8.1 or later.
  4874.  
  4875. NEAR ignored
  4876.  
  4877. FAR ignored NEAR and FAR are ignored in the intel assemblers, but are still ac-
  4878.      cepted for compatiblity with the 16-bit code model.
  4879.  
  4880. Invalid size for MOVSX/MOVZX
  4881.  
  4882. 16-bit base in 32-bit segment
  4883.  
  4884. 16-bit index in 32-bit segment 16-bit addressing is not supported, you must
  4885.      use 32-bit addressing.
  4886.  
  4887. Constant reference not allowed It is not allowed to try to address a constant
  4888.      memory address in protected mode.
  4889.  
  4890. Segment overrides not supported Intel style (eg: rep ds stosb) segment over-
  4891.      rides are not support by the assembler parser.
  4892.  
  4893.                                           82
  4894.  
  4895.  
  4896.  
  4897.                                           C.9. ASSEMBLER READER ERRORS.
  4898.  
  4899.  
  4900. Expressions of the form [sreg:reg... are currently not supported] To access a
  4901.      memory operand in a di erent segment, you should use the sreg:[reg...] snytax
  4902.      instead of [sreg:reg...]
  4903.  
  4904. Size su x and destination register do not match In intel AT&T syntax, you
  4905.      are using a register size which does not concord with the operand size specified.
  4906.  
  4907. Invalid assembler syntax. No ref with brackets
  4908.  
  4909. Trying to use a negative index register
  4910.  
  4911. Local symbols not allowed as references
  4912.  
  4913. Invalid operand in bracket expression
  4914.  
  4915. Invalid symbol name:
  4916.  
  4917. Invalid Reference syntax
  4918.  
  4919. Invalid string as opcode operand:
  4920.  
  4921. Null label references are not allowed
  4922.  
  4923. Using a defined name as a local label
  4924.  
  4925. Invalid constant symbol
  4926.  
  4927. Invalid constant expression
  4928.  
  4929. / at beginning of line not allowed
  4930.  
  4931. NOR not supported
  4932.  
  4933. Invalid floating point register name
  4934.  
  4935. Invalid floating point constant:
  4936.  
  4937. Asm syntax error - Should start with bracket
  4938.  
  4939. Asm syntax error - register:
  4940.  
  4941. Asm syntax error - in opcode operand
  4942.  
  4943. Invalid String expression
  4944.  
  4945. Constant expression out of bounds
  4946.  
  4947. Invalid or missing opcode
  4948.  
  4949. Invalid real constant expression
  4950.  
  4951. Parenthesis are not allowed
  4952.  
  4953. Invalid Reference
  4954.  
  4955. Cannot use SELF outside a method
  4956.  
  4957. Cannot use OLDEBP outside a nested procedure
  4958.  
  4959. Invalid segment override expression
  4960.  
  4961. Strings not allowed as constants
  4962.  
  4963. Switching sections is not allowed in an assembler block
  4964.  
  4965.                                          83
  4966.  
  4967.  
  4968.  
  4969.                                         C.9. ASSEMBLER READER ERRORS.
  4970.  
  4971.  
  4972. Invalid global definition
  4973.  
  4974. Line separator expected
  4975.  
  4976. Invalid local common definition
  4977.  
  4978. Invalid global common definition
  4979.  
  4980. assembler code not returned to text
  4981.  
  4982. invalid opcode size
  4983.  
  4984. Invalid character: í
  4985.  
  4986. Invalid character: ┐
  4987.  
  4988. Unsupported opcode
  4989.  
  4990. Invalid su x for intel assembler
  4991.  
  4992. Extended not supported in this mode
  4993.  
  4994. Comp not supported in this mode
  4995.  
  4996. Invalid Operand:
  4997.  
  4998. Override operator not supported
  4999.  
  5000.  
  5001. m68k specific errors.
  5002. Increment and Decrement mode not allowed together You are trying to use
  5003.      dec/inc mode together.
  5004.  
  5005. Invalid Register list in movem/fmovem The register list is invalid, normally
  5006.      a range of registers should be separated by - and individual registers should
  5007.      be separated by a slash.
  5008.  
  5009. Invalid Register list for opcode
  5010.  
  5011. 68020+ mode required to assemble
  5012.  
  5013.  
  5014.  
  5015.  
  5016.  
  5017.  
  5018.  
  5019.  
  5020.  
  5021.  
  5022.  
  5023.  
  5024.  
  5025.  
  5026.  
  5027.  
  5028.  
  5029.  
  5030.  
  5031.                                        84
  5032.  
  5033.  
  5034.  
  5035. Appendix D
  5036.  
  5037. Run time errors
  5038.  
  5039. The Free Pascal Run-time library generates the following errors at run-time 1:
  5040.  
  5041. 1 Invalid function number You tried to call a dos function which doesn't exist.
  5042.  
  5043. 2 File not found You can get this error when you tried to do an operation on a
  5044.      file which doesn't exist.
  5045.  
  5046. 3 Path not found You can get this error when you tried to do an operation on a
  5047.      file which doesn't exist, or when you try to change to, or remove a directory
  5048.      that doesn't exist, or try to make a subdirectory of a subdirectory that doesn't
  5049.      exist.
  5050.  
  5051. 4 Too many open files When attempting to open a file for reading or writing,
  5052.      you can get this error when your program has too many open files.
  5053.  
  5054. 5 File access denied You don't have access to the specified file.
  5055.  
  5056. 6 Invalid file handle If this happens, the file variable you are using is trashed; it
  5057.      indicates that your memory is corrupted.
  5058.  
  5059. 12 Invalid file access code This will happen if you do a reset or rewrite of a file
  5060.      when FileMode is invalid.
  5061.  
  5062. 15 Invalid drive number The number given to the Getdir function specifies a
  5063.      non-existent disk.
  5064.  
  5065. 16 Cannot remove current directory You get this if you try to remove the
  5066.      current diirectory.
  5067.  
  5068. 17 Cannot rename across drives You cannot rename a file such that it would
  5069.      end up on another disk or partition.
  5070.  
  5071. 100 Disk read error dos only. An error occurred when reading from disk. Typ-
  5072.      ically when you try to read past the end of a file.
  5073.  
  5074. 101 Disk write error dos only. Reported when the disk is full, and you're trying
  5075.      to write to it.
  5076.  
  5077. 102 File not assigned This is reported by Reset, Rewrite, Append, Rename and
  5078.      Erase, if you call them with an unassigne function as a parameter.
  5079.   1The linux port will generate only a subset of these.
  5080.  
  5081.  
  5082.                                               85
  5083.  
  5084.  
  5085.  
  5086. 103 File not open Reported by the following functions : Close , Read, Write,
  5087.      Seek, EOf, FilePos, FileSize, Flush, BlockRead, and BlockWrite if the file
  5088.      isn't open.
  5089.  
  5090. 104 File not open for input Reported by Read, BlockRead, Eof, Eoln, SeekEof
  5091.      or SeekEoln if the file isn't opened with Reset.
  5092.  
  5093. 105 File not open for output Reported by write if a text file isn't opened with
  5094.      Rewrite.
  5095.  
  5096. 106 Invalid numeric format Reported when a non-numerice value is read from
  5097.      a text file, when a numeric value was expected.
  5098.  
  5099. 150 Disk is write-protected (Critical error, dos only.)
  5100.  
  5101. 151 Bad drive request struct length (Critical error, dos only.)
  5102.  
  5103. 152 Drive not ready (Critical error, dos only.)
  5104.  
  5105. 154 CRC error in data (Critical error, dos only.)
  5106.  
  5107. 156 Disk seek error (Critical error, dos only.)
  5108.  
  5109. 157 Unknown media type (Critical error, dos only.)
  5110.  
  5111. 158 Sector Not Found (Critical error, dos only.)
  5112.  
  5113. 159 Printer out of paper (Critical error, dos only.)
  5114.  
  5115. 160 Device write fault (Critical error, dos only.)
  5116.  
  5117. 161 Device read fault (Critical error, dos only.)
  5118.  
  5119. 162 Hardware failure (Critical error, dos only.)
  5120.  
  5121. 200 Division by zero You are dividing a number by zero.
  5122.  
  5123. 201 Range check error If you compiled your program with range checking on,
  5124.      then you can get this error in the following cases:
  5125.  
  5126.        1. An array was accessed with an index outside its declared range.
  5127.        2. You're trying to assign a value to a variable outside its range (for instance
  5128.           a enumerated type).
  5129.  
  5130. 202 Stack overflow error The stack has grown beyond itss maximum size. This
  5131.      error can easily occur if you have recursive functions.
  5132.  
  5133. 203 Heap overflow error The heap has grown beyond its boundaries, ad you are
  5134.      rying to get more memory. Please note that Free Pascal provides a growing
  5135.      heap, i.e. the heap will try to allocate more memory if needed. However, if
  5136.      the heap has reached the maximum size allowed by the operating system or
  5137.      hardware, then you will get this error.
  5138.  
  5139. 204 Invalid pointer operation This you will get if you call dispose or Freemem
  5140.      with an invalid pointer (notably, Nil)
  5141.  
  5142. 205 Floating point overflow You are trying to use or produce too large real
  5143.      numbers.
  5144.  
  5145. 206 Floating point underflow You are trying to use or produce too small real
  5146.      numbers.
  5147.  
  5148.                                          86
  5149.  
  5150.  
  5151.  
  5152. 207 Invalid floating point operation Can occur if you try to calculate the square
  5153.      root or logarithm of a negative number.
  5154.  
  5155. 210 Object not initialized When compiled with range checking on, a program
  5156.      will report this error if you call a virtal method without having initialized the
  5157.      VMT.
  5158.  
  5159. 211 Call to abstract method Your program tried to execute an abstract virtual
  5160.      method. Abstract methods should be overridden, and the overriding method
  5161.      should be called.
  5162.  
  5163. 212 Stream registration error This occurs when an invalid type is registered in
  5164.      the objects unit.
  5165.  
  5166. 213 Collection index out of range You are trying to access a collection item
  5167.      with an invalid index. (objects unit)
  5168.  
  5169. 214 Collection overflow error The collection has reached its maximal size, and
  5170.      you are trying to add another element. (objects unit)
  5171.  
  5172. 216 General Protection fault You are trying to access memory outside your
  5173.      appointed memory.
  5174.  
  5175. 217 Unhandled exception occurred An exception occurred, and there was no
  5176.      exception handler present. The sysutils unit installs a default exception han-
  5177.      dler which catches all excpetions and exits gracefully.
  5178.  
  5179. 227 Assertion failed error An assertion failed, and no AssertErrorProc proce-
  5180.      dural variable was installed.
  5181.  
  5182.  
  5183.  
  5184.  
  5185.  
  5186.  
  5187.  
  5188.  
  5189.  
  5190.  
  5191.  
  5192.  
  5193.  
  5194.  
  5195.  
  5196.  
  5197.  
  5198.  
  5199.  
  5200.  
  5201.  
  5202.  
  5203.  
  5204.  
  5205.  
  5206.  
  5207.  
  5208.                                          87
  5209.  
  5210.  
  5211.  
  5212. Appendix E
  5213.  
  5214. The Floating Point
  5215. Coprocessor emulator
  5216.  
  5217. In this appendix we note some caveats when using the floating point emulator on
  5218. GO32V2 systems. Under GO32V1 systems, all is as described in the installation
  5219. section.
  5220. Q: I don't have an 80387. How do I compile and run floating point programs under
  5221. GO32V2?
  5222. Q: What shall I install on a target machine which lacks hardware floating-point
  5223. support?
  5224. A : Programs which use floating point computations and could be run on machines
  5225. without an 80387 should be allowed to dynamically load the emu387.dxe file at
  5226. run-time if needed. To do this you must link the emu387 unit to your exectuable
  5227. program, for example:
  5228.  
  5229.        Program MyFloat;
  5230.  
  5231.        Uses emu387;
  5232.  
  5233.        var
  5234.             r: real;
  5235.        Begin
  5236.             r:=1.0;
  5237.             WriteLn(r);
  5238.        end.
  5239.  
  5240. Emu387 takes care of loading the dynamic emulation point library.
  5241. You should always add emulation when you distribute floating-point programs.
  5242. A few users reported that the emulation won't work for them unless they explicitly
  5243. tell DJGPP there is no x87 hardware, like this:
  5244.  
  5245.             set 387=N
  5246.             set emu387=c:/djgpp/bin/emu387.dxe
  5247.  
  5248. There is an alternative FP emulator called WMEMU. It mimics a real coprocessor
  5249. more closely.
  5250.  
  5251.  
  5252.                                          88
  5253.  
  5254.  
  5255.  
  5256. WARNING: We strongly suggest that you use WMEMU as FPU emulator, since
  5257. emu387.dxe does not emulate all the instructions which are used by the Run-Time
  5258. Libary such as FWAIT.
  5259. Q: I have an 80387 emulator installed in my AUTOEXEC.BAT, but DJGPP-
  5260. compiled floating point programs still doesn't work. Why?
  5261. A : DJGPP switches the CPU to protected mode, and the information needed to
  5262. emulate the 80387 is di erent. Not to mention that the exceptions never get to the
  5263. real-mode handler. You must use emulators which are designed for DJGPP. Apart
  5264. of emu387 and WMEMU, the only other emulator known to work with DJGPP is
  5265. Q87 from QuickWare. Q87 is shareware and is available from the QuickWare Web
  5266. site.
  5267. Q: I run DJGPP in an os/2 DOS box, and I'm told that os/2 will install its
  5268. own emulator library if the CPU has no FPU, and will transparently execute FPU
  5269. instructions. So why won't DJGPP run floating-point code under os/2 on my
  5270. machine?
  5271. A : os/2 installs an emulator for native os/2 images, but does not provide FPU
  5272. emulation for DOS sessions.
  5273.  
  5274.  
  5275.  
  5276.  
  5277.  
  5278.  
  5279.  
  5280.  
  5281.  
  5282.  
  5283.  
  5284.  
  5285.  
  5286.  
  5287.  
  5288.  
  5289.  
  5290.  
  5291.  
  5292.  
  5293.  
  5294.  
  5295.  
  5296.  
  5297.  
  5298.  
  5299.  
  5300.  
  5301.  
  5302.  
  5303.  
  5304.  
  5305.  
  5306.  
  5307.                                        89
  5308.  
  5309.  
  5310.  
  5311. Appendix F
  5312.  
  5313. A sample gdb.ini file
  5314.  
  5315. Here you have a sample gdb.ini file listing, which gives better results when using
  5316. gdb. Under linux you should put this in a .gdbinit file in your home directory or
  5317. the current directory..
  5318.  
  5319. set print demangle off
  5320. set gnutarget auto
  5321. set verbose on
  5322. set complaints 1000
  5323. dir ./rtl/dosv2
  5324. set language c++
  5325. set print vtbl on
  5326. set print object on
  5327. set print sym on
  5328. set print pretty on
  5329. disp /i $eip
  5330.  
  5331. define pst
  5332. set $pos=&$arg0
  5333. set $strlen = {byte}$pos
  5334. print {char}&$arg0.st@($strlen+1)
  5335. end
  5336.  
  5337. document pst
  5338.   Print out a pascal string
  5339. end
  5340.  
  5341.  
  5342.  
  5343.  
  5344.  
  5345.  
  5346.  
  5347.  
  5348.  
  5349.  
  5350.  
  5351.  
  5352.  
  5353.                                        90
  5354.  
  5355.  
  5356.  
  5357.