A generic Makefile for Objective Caml

The skeleton for the Make command

Makefile_ocaml.tpl must be copied as Makefile in the project directory.

Simplified instructions for use

• The file Makefile must exist in the directory where your source code files are.
• Fill in the parts of the Makefile that are specific to your application:
  • SOURCES = the list of Caml sources (including ocamlyacc and ocamllex source files).
  • EXEC = a.out replace a.out by the name of the executable program you want to create.
• Create a .depend file (executing touch .depend under Unix). This file will contain the list of compilation dependencies automatically generated by the Makefile when executing the command make depend.
• Type make. Type make again each time you modify of one of the source files of the program.

Advanced instructions for use

In addition, the Makefile file offers the following entry points:

• make clean removes the executable program and all the object files (compiled Caml files).
• make depend computes the dependencies between the modules of the program, hence tries to find a correct compilation order to recompile the application.
• make rebuilds the executable program, recompiling what has to be recompiled.
• make all combines make depend and make, hence recomputes dependencies and then rebuilds the application.
• make clean; make all is the normal sequence to recompile the program from scratch.

If you use Caml libraries (such as graphics, unix, or nums), you must set the line LIBS= with the list of libraries you use. The names of these libraries for Make are listed in the Makefile: each ``name'' is in fact a Make macro that adds the relevant options to the Caml compiler. For instance, to use both ``graphics'' and ``unix'' you should write: LIBS=WITHGRAPHICS WITHUNIX

Make and Emacs

Advanced Caml programmers generally agree that the simplest way of developing Caml programs is to use make from within the emacs editor: call make with the emacs command Meta-X compile. If an error occurs, the editor points to the precise file and line where the Caml compiler found the error, if you type in Meta-X next-error. The command Meta-X compile is generally bound to the keystrokes combination CTRL-C CTRL-C, while Meta-X next-error is bound to CTRL-X `.
This means that the entire compilation + error finding process just needs to 4 key-strokes.

Le squelette de fichier pour la commande Make

Mode d'emploi simplifié

• Ce fichier Makefile doit être écrit dans le répertoire où réside les sources de votre programme.
• Complètez ensuite les parties spécifiques à votre programme (nom de l'exécutable, lignes correspondant aux fichiers camlc, camllex et camlyacc, liste des fichiers source Caml et des fichiers objets à créer).
• Créer aussi un fichier de nom .depend (touch .depend). Vide au départ, ce fichier contiendra la liste des dépendances de compilation entre les fichiers des modules de votre programme, calculées automatiquement par la commande make depend.
• Taper make. Recommencer à chaque nouvelle modification de l'un des fichiers du programme.

Plus précisément, ce fichier Makefile vous offre les «entrées» suivantes:

• La commande make reconstruit le programme exécutable.
• La commande make depend recalcule les dépendances entre les modules du programme et donc recalcule l'ordre dans lequel il faut compiler les fichiers.
• La commande make clean supprime les fichiers compilés et le programme exécutable.
• La commande make all recalcule les dépendances et recompile le programme.
• La commande make clean; make all recompile entièrement tous les modules du programme et recrée l'exécutable.

L'idéal est d'utiliser make avec l'éditeur emacs: on appelle make avec la commande emacs Meta-X compile. S'il se produit une erreur à la compilation, l'éditeur se positionnera automatiquement sur la ligne signalée par le compilateur Caml, en ouvrant le fichier correspondant Meta-X next-error. La commande Meta-X compile est généralement liée à la combinaison de touche CTRL-C CTRL-C, tandis que Meta-X next-error est lié à CTRL-X `.
Ce qui signifie qu'on recompile le programme et positionne le curseur sur l'erreur détectée en 4 appuis de touches.

Mode d'emploi avancé

En outre ce Makefile générique vous propose la liaison avec les librairies du système Caml. Pour cela il vous faut ajouter des options $(WITH*), par exemple $(WITHUNIX) pour utiliser la librairie d'interface avec Unix dans votre programme. (Voir le mode d'emploi dans le Makefile lui-même).

Exemple

Le Makefile proposé ci-dessous prend pour exemple un petit programme composé de:

• l'analyseur lexical lexer.mll
• l'analyseur syntaxique parser.mly
• le module types composé des fichiers types.mli et types.ml.
• le fichier principal main.ml

On suppose en outre que le programme exécutable à créer se nomme a.out.