Ceci est une ancienne révision du document !

Comment mettre en forme du code informatique?

Les logiciels qui affichent du code informatique utilisent des couleurs pour rendre les programmes plus lisibles. Ceci permet de repérer visuellement les mots-clefs du langage, les noms de variables, etc. Il est possible de faire la même chose avec LaTeX, pour que la structure du code soit soulignée par la mise en forme. C'est très utile pour les livres sur la programmation, mais aussi pour les travaux des étudiants en informatique.

L'inclusion de code «verbatim» est traitée ailleurs, ainsi que le problème de la mise en forme des algorithmes.

Avec l'extension “listings”

L'extension listings est souvent considérée comme la meilleure solution pour une sortie mise en forme (elle se charge d'analyser les sources des programmes et d'utiliser différentes polices de caractères pour en mettre la structure en évidence), mais il existe plusieurs autres extensions bien établies qui s'appuient sur une sorte de pré-compilateur. Vous pouvez utiliser listings pour mettre en page des extraits que vous incluez dans votre source:

  \usepackage{listings}
  \lstset{language=C}
...
\begin{document}
\begin{lstlisting}
#include <stdio.h>
 
int main(int argc, char ** argv)
{
  printf("Bonjour tout le monde!\n");
  return 0;
}
\end{lstlisting}
\end{document}

$\documentclass{article} \usepackage{lmodern} \usepackage{listings} \lstset{language=C} \pagestyle{empty} \begin{document} \begin{lstlisting} #include <stdio.h> int main(int argc, char ** argv) { printf("Bonjour tout le monde!\n"); return 0; } \end{lstlisting} \end{document}$

mais vous pouvez aussi l'utiliser pour mettre en forme des fichiers entiers:

  \usepackage{listings}
  \lstset{language=C}
...
\begin{document}
\lstinputlisting{main.c}
\end{document}

Ces exemples très simples peuvent être coloré de diverses façons et, bien sûr, l'extension comprend beaucoup d'autres langages que le C…

Pendant longtemps, l'extension listings a été vue comme la panacée en la matière. Mais ces dernières années, des alternatives viables sont apparues.

Avec l'extension “highlight”

Highlight est intéressante si vous avez besoin de plus d'un format de sortie pour votre programme. En effet, en plus de la sortie (La)TeX, highlight pourra produire des représentations (X)HTML, RTF et XSL-FO de votre code-source. Le manuel (en anglais) vous sera d'une grande aide si vous devez écrire le fichier de paramètres pour un nouveau langage, ou modifier la mise en forme d'un langage déjà défini.

Avec l'extension “minted”

L'extension minted est une autre alternative qui permet créer de nouvelles définitions de langage. Il nécessite que le code soit traité à l'aide d'un script externe, écrit en Python, Pygments. Pygments, à son tour, a besoin d'un analyseur lexical qui connaît le langage que vous voulez utiliser; il en existe de nombreux, pour les langages les plus utilisés, et il y a aussi des conseils pour écrire le vôtre sur le site web de “Pygments”.

L'usage de minted peut être aussi simple que ceci:

\begin{minted}{<language>}
...
\end{minted}

qui traite le code du programme à la volée, au moment de la compilation.

Cela demande que l'appel aux programmes externes soit autorisé.

Avec l'extension “showexpl”

Dans un autre ordre d'idées, le paquetage showexpl prend en charge la mise en forme de code (La)TeX et de sa sortie compilée, dans des «volets» situés en regard l'un de l'autre. C'est notamment utile pour les manuels (La)TeX, ou pour les articles sur (La)TeX. Le paquetage utilise des listings pour le volet (La)TeX, et insère le résultat de la compilation dans une simple boîte, pour l'autre volet.

Autres solutions

Voici quelques autres systèmes plus anciens (et moins «puissants»):

Le système lgrind est un précompilateur bien établi, avec toutes les facilités dont on peut avoir besoin et un vaste répertoire de langages supportés; il est dérivé du système tgrind, encore plus ancien, dont la sortie était basée sur Plain TeX.
Le système tinyc2l est un peu plus récent: les utilisateurs sont encore encouragés à écrire leurs propres pilotes pour les langages qu'il ne supporte pas encore, mais le « tiny » dans son nom indique à juste titre qu'il ne s'agit pas d'un système spécialement élaboré.
C++2LaTeX est clairement orienté vers une utilisation avec C et C++.
Un système extrêmement simple est c2latex, avec lequel vous écrivez votre source LaTeX dans les commentaires de votre programme C (un peu dans la logique du literate programming). Le programme convertit ensuite votre programme en un fichier LaTeX prêt à être compilé. Le programme est censé être “auto-documenté”.

Source: Code listings in LaTeX