Skip to content

JvanKatwijk/algol-60-compiler

Repository files navigation

========================================================================= jff-algol. a simple Algol 60 to C translator

Note: The link https://gtoal.com/languages/algol60/new-unicode-parser/README.html refers to a site with a very useful, more genral parser that might be helpful to convert old(er) Algol 60 programs into a format that can be handled by the jff-algol compiler. As the text in the link reads:

"The demonstration parser builds an executable, "algol60", which will re-indent an Algol60 source file (such as the examples in test/*.a60) while canonicalizing some of the alternative Algol symbols to something approaching the publication syntax standard, with stropped keywords having been converted to underlined format. You can compile the canonical Algol60 program by piping it through the unicode_to_jff utility in the tools/ subdirectory, and feeding that to the jff-a2c compiler from https://github.com/JvanKatwijk/algol-60-compiler. " (text from the site of Graham Toal)


jff-algol: A simple ALGOL 60 to C translator

In version 2.4 it is now (experimentally) possible to use the French version of the Algol 60 language

DEBUT TABLEAU B,C [-2:N];
      REEL R,T1,Y1,Y2,S,P,S1,P1, DELTA, DISCR,S2,P2,X1,X2 ;

      ENTIER I,K,NITER ;
      	
      B[-2]:= B[-1]:=0 ;
      C[-2]:= C[-1]:=0 ;
      T1 := EPS1;
     SI N=0 ALORS ALLERA BOUT ;
     SI N=1 ALORS DEBUT B[0]:=A[0]; B[1]:=A[1];
                  ALLERA DERZERO;
                  FIN ;

The compiler is equipped with a "-F" flag, when set, the keywords are the French ones (in captitals though), and the "prelude" and "operator" file selected so support the French language

In in the install procedure, now two versions of the "operator" file and the "prelude" file are installed.

=======================================================================

In the period 2002, 2003 I wrote in spare time, as a hobby project, a simple Algol 60 to C translator. The rationale was to show the semantics of (some of the) Algol 60 constructs in terms of C expressions.

The objective was therefore to translate Algol 60 constructs into C equivalents rather than to some "intermediate stack machine".

As an example (see example 3 in the example directory), the function

begin
   integer array A [1:10];
   integer i;
   outstring (1, "Example 3: simple static arrays\n");
   for i := 1 step 1 until 10 do
       A [i] := i * i;
   for i := 1 step 1 until 10 do
   begin
       outinteger (1, i); space (1);
       outinteger (1, A [i]); newline (1);
   end;
end;

is translated into (full compiler output)

/* jff_algol (Jan van Katwijk) */
/* Version 2.3		*/
/* input file: example3.alg		*/
/* Compiled at Thu Dec 13 19:17:14 2018		*/

#include	<stdio.h>
#include "example3.h"

//	Code for the global declarations
int _A_41[10 - 1 +1]; /* A declared at line 2*/
int _i_41; /* i declared at line 3*/


// The main program
int	main () {
char	*LP = (char *)NULL;

{ // code for block at line 2
   outstring (1, "Example 3: simple static arrays\n");
   for (_i_41=1; ( _i_41- (10)) * sign ((double)1 )<= 0;_i_41 +=1)
       A_41 [_i_41-1]=(_i_41) * (_i_41);
   for (_i_41=1; ( _i_41- (10)) * sign ((double)1 )<= 0;_i_41 +=1) {
       outinteger (1, _i_41);
       space (1);
       outinteger (1, _A_41 [_i_41-1]);
       newline (1);
       ; // null statement 
    }
    ; // null statement 
}
}

The resulting compiler compiled Algol 60, using C as intermediate language, and - if the mapping to C succeeded - invoked a C compiler and an executable is generated. For those interested: the compiler is certainly capable of handling things like the famous "man or boy" example

begin
   integer i;
   integer count;
   integer procedure A (k, x1, x2, x3, x4, x5);
   value k; integer k, x1, x2, x3, x4, x5;
   begin
      integer procedure B;
      begin
         k := k - 1;
         A := B := A (k, B, x1, x2, x3, x4);
      end;
	count := count + 1;
      if k <= 0 then A := x4 + x5 else B;
   end;
   count := 0;
   for i := 1 step 1 until 15 do
   begin
      outinteger (1, A (i, 1, -1, -1 , 1 , 1));
      newline (1);
      outstring (1, "Recursie diepte voor "); outinteger (1, i);
      outstring (1, " is "); outinteger (1, count);
      count := 0;
      newline (1);
   end;
end;

The output is

0 
Recursie diepte voor �1  is �2 
-2 
Recursie diepte voor �2  is �3 
0 
Recursie diepte voor �3  is �4 
1 
Recursie diepte voor �4  is �8 
0 
Recursie diepte voor �5  is �18 
1 
Recursie diepte voor �6  is �38 
-1 
Recursie diepte voor �7  is �80 
-10 
Recursie diepte voor �8  is �167 
-30 
Recursie diepte voor �9  is �347 
-67 
Recursie diepte voor �10  is �722 
-138 
Recursie diepte voor �11  is �1509 
-291 
Recursie diepte voor �12  is �3168 
-642 
Recursie diepte voor �13  is �6673 
-1446 
Recursie diepte voor �14  is �14091 
-3250 
Recursie diepte voor �15  is �29825 

Since it was a fun project, the compiler was named "jff-algol", i.e. Just-For-Fun-Algol.

Recently, when cleaning up some old archives on disks, I found the sources of the compiler and - with a very few modifications - the software compiled properly and just ran.

The directory contains an automake/configure combination to create two executables and a small library

================================================================

jff-algol

The program jff-algol is the driver program. The setup is that calling

jff-algol [options] filename.alg filename-2.alg ... filename-n.alg

will compile the Algol sources to C code by generating for each of the Algol sources a (more or less) structured C file and include file, and compile and link the C file, resulting in an executable (with the same name as the source program without the extension). The documentation contains a manual with a fairly detailed description of the resulting C code of a dozen example programs.

The file jff-algol.c contains the source for this program.

Command line options to specify components used, build and operating instructions are also described in the manual.

====================================================================

frontend.c

The file frontend.c contains the source of the real Algol 60 to C translator. As mentioned in the manual, the original idea was - whenever I would have some more free time - to recode the frontend into Algol 60 code itself but that (almost obviously) never happened. However, due to that (vague) intention, the implementation refrained from using records. In the C implementation, all structures (treenodes etc) are implemented as segments of homogeneous arrays (arrays of char *).

The file frontend.c is translated into an executable "jff-a2c". The jff-a2c program can be used as a program on its own.

======================================================================

runtime.c

All runtime support is implemented in the file runtime.c. It contains the implementation of the (from a user's point of view invisible) support functions, e.g. setting up an array, leaving a scope etc, the implementation of some of the operators, and the implementation of the functions in the prelude. In the installation process this file is compiled and the result converted into a library lib-jff.a

=======================================================================

jff_header.h

The specification of the runtime support is given in jff_header.h

=======================================================================

operator

One of the objectives was to have a pretty loose coupling of the compile with the definition of the operators. On the start of a compilation, the compiler will read the file "operator". The file contains for each operator a few lines, specifying the operator and presenting a pattern for the compilation, e.g.

   [ ^ 9 ((integer integer integer "(__ipow(%L,%R))")
             (real integer real " __npow (%L, %R)")
             (integer real real "__fpow ((double)%L, %R)")
             (real real real "__fpow (%L, %R)")) ]

shows that the power operator is on priority level 9, and, depending on the type of the operands, implemented as a call to a C function in the runtime support system.

The file is read in at the start of the compilation.

========================================================================

prelude

The prelude file contains the specifications of the predefined functions. The file is readin at the start of the compilation. In the prelude file it is allowed to specify a function as "c function", i.e., a procedure with as body the keyword c_procedure (or c_proc)

procedure outreal    (channel, v); value channel, v;
                                   integer channel; real v; c_procedure;

procedure ininteger (channel, v); value channel; 
	                          integer channel, v; c_procedure;
procedure inreal (channel, v); value channel;
                               integer channel; real v; c_procedure;

=================================================================

Installation

The installation procedure, using auto tools, is a little shaky but does run and was tested both in a Linux environment and a Windows 10 environment with MSYS-2/mingw64 installed. Note that for the compiler to be a real compiler, it needs helpp from a C compiler to translate the C output of the jff-a2c translator into an executable.

I am using the gcc toolchain, both with Linux and MSYS-2/Mingw64 Windows.

The installation procedure will compile jff-algol.c, jff-a2c.c and run-time.c. For compilation of run-time.c the include file jff_header.h is needed.

Furthermore, under Linux the installation process will (try to) install the executables jff-algol and jff-a2c in the directory "/usr/local/bin", create a library lib-jff.a from the compiled runtime.c file and install it in the directory "/usr/local/lib" and the files jff_header.h, operator and prelude in the directory "/usr/local/share/jff-a2c". Under MSYS-2/Mingw64, the installation process will (try to) install the executables jff-algol and jff-a2c in the directory /mingw64/bin, the library lib-jff.a in /mingw64/lib, and the files operator and prelude in /mingw64/share/jff-a2c.

=========================================================================

Copyright

Copyright (C)  2016, 2017
Jan van Katwijk (J.vanKatwijk@gmail.com)
Lazy Chair Programming

The Algol 60 software is made available under the GPL-2.0. All SDR-J software, among which jff-algol is one - is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.