CONVENTIONS D'ÉCRITURE

Si la présentation des définitions et le libellé des mots définis par le programmeur FORTH sont laissés à son entière appréciation, il est quand même recommandé de suivre quelques règles. Une bonne présentation facilite la maintenance des programmes.

A. Espacement et indentation.

L'espacement et l'indentation ont pour but d'aérer une définition et mettre en valeur les structures et les composants de la définition. Ces directives s'appliquent esentiellement aux définitions de type "deux-points":

• -1 espace entre le mot de définition et le nom.
• -2 espaces entre le nom et le commentaire.
• -2 espaces ou un retour à la ligne après un commentaire et avant la définition.
• -3 espaces entre le nom et la définition s'il n'y a pas de commentaire après le nom.
• -3 espaces d'indentation, ou multiples de trois, pour marquer les structures de contrôle.
• -1 espace entre le mot et le nombre dans une phrase, 2 à 3 espaces entre phrases.
• -1 espace entre le dernier mot de la définition et le "point-virgule".
• -1 espace entre le "point-virgule" et le mot IMMEDIATE, le cas échéant.

Pas de ligne vierge entre définitions, sauf pour séparer des groupes de définitions distinctes.

B. Le commentaire de pile.

Le commentaire désignant l'action du mot sur le contenu de la pile est indiqué entre parenthèses, après le libellé du mot, en utilisant le mot ( ou (S. Le second mot est plus particulièrement réservé au commentaire de pile.

La nature des données traitées par le mot peut être indiquée de manière symbolique à l'aide des abréviations suivantes:

C. Commentaire du flot d'entrée.

Certaines définitions traitent le flot d'entrée, cas notamment des mots de définition mais également d'autres types de mots.

De tels mots nécessitent, près d'eux, des mots en apposition. Que sont ces appositions?
Ce peuvent être:

Où placer ces appositions? Suivant le mot M sous revue et la nature de ces appositions, ce peut être avant ou après le mot M.

Le commentaire de pile indique clairement ce qui doit se trouver sur la pile AVANT l'exécution du mot M, donc les appositions avant. mais il est muet sur les appositions arrières. Il peut être pédagogique de préciser aussi les appositions avant (bien que cela puisse faire double emploi) dans le commentaire de pile.

C'est pourquoi, il est préconisé la définition et l'emploi, si nécessaire, du commentaire d'entrée.

Les appositions seraient placées entre crochets anglés |< >| (signe inférieur à et supérieur à). Exemple:

CONSTANT ( n ---, <nom>)

ou, si l'on veut préciser davantage la manoeuvre d'entrée:

: CONSTANT ( <n> ---, <nom>)
: DEFER ( - <mot>)
: $! ( <str>, <strVar>, ad1 l1 ad2 l2 ---)
: INPUT$ ( <strVar> ad l --- <Enter ><text> )
: VOCABULARY ( --- <voc> )
: ALSO ( <voc><nomFich[.ext]> ---)
: SAVE ( ad1 ad2 ---<nomFich[.ext]>

En résumé, la syntaxe du commentaire d'entrée serait la suivante:

( <appoAv1> ... <appAvN> --- <appoAr1> ... <appoArN> )

D. Libellé des noms à définir.

E. Prononciation des symboles.

Dans les articles des revues anglaises et américaines traitant du FORTH, les auteurs citent certaines fonctions par leur prononciation afin d'éviter les problèmes de compréhension liés à la typographie de celles-ci. En français, quand nous écrivons point- virgule, nous faisons bien entendu référence au mot ; .

-- hautdepage -- page d'accueil --