Utilisation des directives de compilation

version 2003 (Modifiée)

4e Dimension utilise trois catégories de variables :

• les variables locales,

• les variables process,

• les variables interprocess.

Pour plus d'informations sur ce point, reportez-vous à la section Variables. Les variables process et les variables interprocess sont structurellement de même nature pour le compilateur.

Toutes les variables ont un type. Comme décrit dans la section Types de données, vous disposez de 12 types pour les variables simples :

Booléen

Alphanumérique (ou Chaîne fixe)

Date

Entier

Entier long

Graphe

Heure

Image

Numérique (ou Réel)

Pointeur

Texte

BLOB

Pour les variables de type Tableau, vous disposez des 9 types suivants :

Tableau Booléen

Tableau Alpha (ou Chaîne fixe)

Tableau Date

Tableau Entier

Tableau Entier long

Tableau Image

Tableau Numérique (ou Réel)

Tableau Pointeur

Tableau Texte

Lorsque vous travaillez avec 4e Dimension en mode interprété, une variable peut avoir plusieurs types. Cette tolérance se justifie parfaitement puisque vous êtes en mode interprété. En effet, à chaque ligne de code, 4e Dimension interprète l'instruction et comprend le contexte.

Lorsque vous travaillez en mode compilé, vous êtes dans une situation différente. Alors que l'interprétation agit ligne par ligne, la compilation s'intéresse à une base dans sa globalité.

La manière d'opérer du compilateur est la suivante :

• Le programme explore systématiquement les objets qui lui sont proposés par 4e Dimension.

Ces objets sont les méthodes base, les méthodes projet, les méthodes formulaire, les méthodes table (triggers) et les méthodes objet.

• Le programme peigne ces objets pour retrouver le type de chacune des variables utilisées dans la base et génère la table des variables et des méthodes.

• Une fois qu'il a retrouvé le type de toutes les variables, le compilateur traduit la base. Encore faut-il qu'il puisse identifier un type d'une manière univoque pour chacune des variables.

Si le compilateur trouve un même nom de variable avec deux types différents, il n'a aucune raison de privilégier l'un par rapport à l'autre. En d'autres termes, avant de pouvoir ranger un objet, de lui donner une adresse mémoire, le compilateur a besoin de connaître l'identité exacte de cet objet, c'est-à-dire son nom et son type, le type permettant au compilateur de déduire sa taille. Ainsi, pour chaque application compilée, le compilateur crée un plan, contenant, pour chaque variable, son nom (ou identificateur), son emplacement (ou adresse mémoire) et la taille qu'elle occupe (représentée par son type). Ce "plan" s'appelle la table de symboles. Une option des Préférences vous permet de générer ou non cette table sous forme de fichier lors de la compilation.

Ce plan est également utilisé pour la génération automatique des méthodes compilateur.

Le compilateur doit respecter les critères d'identification des variables.

Il existe deux possibilités :

• Si les variables ne sont pas typées, le compilateur s'en occupera automatiquement pour vous. Toutes les fois que c'est possible, dans la mesure où il n'y a pas d'ambiguïtés, le compilateur déduit automatiquement pour vous le type des variables utilisées. Si, par exemple, vous écrivez :

   V1 := Vrai

le compilateur pourra en déduire que la variable V1 est de type Booléen.

De même, si vous écrivez :

   V2:= "Ceci est une phrase exemple"

le compilateur en déduira que V2 est une variable de type Texte.

Le programme peut également déduire le type des variables dans des cas moins faciles :

   V3:= V1   `V3 est du même type que V1
   V4:= 2*V2   `V4 est du même type que V2

Le compilateur déduit également le type de vos variables d'après les appels aux commandes 4e Dimension et à vos propres méthodes. Si vous passez à une méthode un paramètre de type Booléen et un paramètre de type Date, le compilateur donnera le type Booléen et le type Date aux variables locales $1 et $2 de la méthode appelée.

Lors de ces déductions, sauf indication contraire dans les Préférences, le compilateur ne donne pas à vos variables des types limitatifs : Entier, Entier long ou Alphanumérique. Par défaut, le compilateur donne toujours le type le plus large possible à vos variables. Si vous écrivez :

   LeNombre :=4

le compilateur donnera à la variable LeNombre le type Réel, même si en toute rigueur la valeur 4 est entière. En d'autres termes, le compilateur n'exclut pas que dans d'autres occurrences de la variable, la valeur puisse être 4,5.

Si vous ne voulez pas de cette interprétation générale, vous pouvez préciser vos choix : c'est l'objet de ce qu'on appelle les directives de compilation.

• Les directives de compilation servent à déclarer de façon explicite les variables simples que vous utilisez dans vos bases.

Leur utilisation se fait de la façon suivante :

   C_BOOLEEN(Var)

Par cette directive, vous forcez le compilateur à créer une variable Var dont le type sera Booléen.

Dans le cas où une application comporte des directives de compilation, le compilateur les détecte et n'a pas à se livrer à une quelconque estimation.

Une directive a la priorité sur une déduction à partir d'une affectation ou d'une utilisation.

Les variables simples déclarées par la directive de compilation C_ENTIER sont considérés comme des Entiers longs, compris entre –2147483648 et +2147483647 comme pour les variables déclarées par la directive C_ENTIER LONG.

Les directives de compilation sont utiles dans deux cas :

• lorsque le compilateur ne peut pas déduire seul le type d'une variable,

• lorsque vous voulez éviter que le compilateur fasse des déductions.

Par ailleurs, utiliser des directives de compilation peut vous permettre de réduire le temps de compilation.

Il arrive que le compilateur ne puisse pas déduire le type d'une variable, et cela pour plusieurs raisons. Il est impossible de recenser tous les cas de figure. Une chose est certaine, c'est qu'en cas d'impossibilité à compiler, le compilateur vous en donnera la raison précise ainsi que les moyens d'y remédier.

On peut cependant distinguer trois causes majeures d'hésitation pour le compilateur : l'ambiguïté proprement dite, l'ambiguïté sur une déduction forcée, et l'impossibilité totale de déduire un type.

• L'ambiguïté proprement dite

L'ambiguïté sur le nom de la variable est généré dans le cas suivant : le compilateur choisit la première variable qu'il rencontre et assigne arbitrairement à la suivante, de même nom mais de type différent, le type qu'il a précédemment attribué.

Prenons un exemple simple :

dans une méthode A,

   LaVariable:=Vrai 

dans une méthode B,

   LaVariable:="La lune est verte"

Dans le cas où la méthode A est compilée avant la méthode B, le compilateur considérera que LaVariable:="La lune est verte" est un changement de type d'une variable précédemment rencontrée. Il vous signalera qu'il y a retypage. Il génère une erreur qu'il vous appartient de corriger.

Ne vous inquiétez pas, le compilateur ne transformera pas votre variable LaVariable:="La lune est verte" en variable booléenne sans vous demander ce que vous en pensez !

• L'ambiguïté sur une déduction forcée

Il peut arriver que le compilateur déduise un type sur un objet qui ne convient pas à son utilisation finale. Dans ce cas, vous devrez typer explicitement vos variables à l'aide des directives de compilation.

Voici un exemple de cas d'ambiguïté lors de l'utilisation des listes de valeurs par défaut sur un objet : dans les formulaires, il est possible de spécifier une liste de valeurs par défaut pour les objets de type combo box, pop up menu, menu/liste déroulante, onglet, zone de défilement et liste déroulante à l'aide du bouton d'édition Valeurs (voir à ce sujet le manuel Mode Structure de 4e Dimension). Les valeurs par défaut sont automatiquement chargées dans un tableau dont le nom est le même que celui de l'objet.

Dans le cas simple où l'objet n'est pas utilisé dans une méthode, le compilateur peut déduire son type sans ambiguïté et l'objet sera typé en tableau texte par défaut.

En revanche, dans le cas où vous devez initialiser la position de votre tableau pour son affichage dans le formulaire, vous pouvez écrire les instructions suivantes dans la méthode formulaire :

   Au cas ou
      : (Evenement formulaire=Sur chargement)
         MonPopUp:=2
         ...
   Fin de cas

C'est dans ce cas que l'ambiguïté apparaît : lors de l'analyse des méthodes, le compilateur déduira par défaut le type Réel pour la variable MonPopUp. Dans ce cas très précis, vous devez explicitement déclarer le tableau dans une méthode compilateur ou dans la méthode formulaire :

   Au cas ou
      : (Evenement formulaire=Sur chargement)
         TABLEAU TEXTE(MonPopUp;2)
         MonPopUp:=2
         ...
   Fin de cas

• L'impossibilité totale de déduire un type

Dans ce cas, seule une directive de compilation peut orienter le compilateur. Le compilateur peut se trouver dans cette situation lorsqu'une variable est utilisée sans être déclarée et dans un cadre qui ne donne aucune information sur son type possible.

Le phénomène se produit principalement dans quatre cas :

- lorsque vous utilisez des pointeurs,

- lorsque vous utilisez une commande à syntaxe multiple,

- lorsque vous utilisez une commande 4D avec des paramètres optionnels de types différents,

- lorsque vous utilisez une méthode appelée via un URL.

- Cas des pointeurs

Un pointeur étant un outil universel qui a donc pour première caractéristique la flexibilité, il est inutile d'espérer qu'il renvoie un type d'une manière ou d'une autre, hormis le sien propre.

Supposons que vous écriviez dans une méthode la séquence suivante :

   LaVar1:=5,2         (1)
   LePointeur:=->LaVar1   (2)
   LaVar2:=LePointeur->   (3)

Bien que la ligne (2) définisse le type de la variable pointée par le pointeur LePointeur, LaVar2 n'est pas pour autant typée. Lors de la compilation, le compilateur peut reconnaître un pointeur, mais n'a aucun moyen de savoir sur quel type de variable il pointe. Il ne peut donc pas déduire le type de LaVar2 ; une directive de compilation du type C_REEL(LaVar2) est donc indispensable.

- Cas des commandes à syntaxe multiple

Lorsque vous utilisez une variable associée à la fonction Annee de, la variable ne peut être, compte tenu de la nature même de la fonction, que de type Date. En revanche, prenons un cas extrême : la commande LIRE PROPRIETES CHAMP admet deux syntaxes :

Lorsque vous utilisez cette commande, le compilateur ne peut pas deviner quelle syntaxe et quels paramètres vous avez choisis. Il vous appartient alors d'orienter le compilateur par une directive de compilation.

- Cas des commandes 4D ayant des paramètres optionnels de types différents

Lorsque vous utilisez une commande 4e Dimension qui accepte plusieurs paramètres optionnels de différents types, le compilateur ne peut pas deviner quels paramètres ont été passés.

Par exemple, la commande INFORMATION ELEMENT admet deux paramètres optionnels. Le premier est de type Entier long, le second est de type Booléen.

La commande peut donc être utilisée comme ceci :

INFORMATION ELEMENT(liste;position;num;texte;sous-liste;déployé)

ou comme cela :

Vous devez donc utiliser des directives de compilation pour typer les paramètres optionnels passés à la commande (s'ils n'ont pas déjà été typés suite à leur utilisation dans un autre endroit de la base).

- Cas des méthodes appelées via un URL

Si vous écrivez des méthodes appelées via un URL, il est nécessaire de déclarer explicitement la variable Texte $1 dans vos méthodes, par l'intermédiaire de l'instruction C_TEXTE($1), dans le cas où vous n'utilisez pas $1 dans la méthode. En effet, le compilateur ne peut pas deviner qu'une méthode 4D va être appelée via un URL.

Si toutes les variables utilisées dans votre base sont explicitement déclarées, il n'est pas nécessaire que le compilateur refasse tout le typage. Dans ce cas, vous pouvez lui demander d'effectuer uniquement la phase de traduction de vos méthodes dans le chemin de compilation. Ainsi, vous économiserez environ 50 % du temps de compilation.

Les directives de compilation peuvent vous aider à accélérer vos méthodes. Pour plus de précision à ce sujet, reportez-vous à la section Conseils d'optimisation. Pour nous en tenir à un exemple simple dans cette section de présentation, imaginez que vous incrémentiez un compteur. Si vous n'avez pas déclaré la variable, le compilateur considérera par défaut qu'elle est de type Numérique (ou réel). Si vous prenez soin de préciser qu'il s'agit d'un Entier, l'exécution de la base compilée sera plus satisfaisante. En effet, un Réel occupe, sur PC par exemple, 8 octets en mémoire alors que si vous choisissez un type limitatif, Entier ou Entier long, le compteur n'en occupera que 4. Il est bien évident que l'incrémentation d'un compteur de 8 octets est plus longue que celle d'un compteur de 4 octets.

Vous avez deux possibilités selon que vous voulez que le compilateur vérifie ou non votre typage.

Si vous voulez que le compilateur vérifie votre typage ou bien s'en charge lui-même, placer une directive de compilation est simple. Vous avez le choix entre deux possibilités, qui correspondent d'ailleurs à deux méthodes de travail :

• ou bien vous écrivez cette directive lors de la première utilisation de la variable, qu'il s'agisse d'une variable locale, process ou interprocess. La seule recommandation en la matière est que vous l'inscriviez bien à la première utilisation de la variable dans la première méthode exécutée. Attention, lors de la compilation le compilateur prend les méthodes dans l'ordre de leur création, et non dans l'ordre dans lequel elles apparaissent dans l'Explorateur.

• ou bien, si vous êtes systématique, regroupez toutes vos variables process ou interprocess avec les directives afférentes dans la Méthode base Sur ouverture ou une méthode appelée par la Méthode base Sur ouverture.

Pour les variables locales, regroupez ces directives en tête de la méthode où elles sont utilisées.

Si vous voulez que le compilateur n'ait pas à vérifier votre typage, vous devez lui donner les clés de l'identification de ses objets.

La convention à respecter est la suivante : les directives de compilation des variables process ou interprocess, ainsi que les paramètres, devront être placées dans une ou plusieurs méthodes dont le nom commence par Compiler.

Par défaut, le compilateur vous permet de générer automatiquement cinq types de méthodes Compilateur regroupant les directives pour les variables, les tableaux et les paramètres des méthodes (pour plus d'informations sur ce point, reportez-vous au manuel Mode Structure).

Note : La déclaration des paramètres des méthodes obéit à la syntaxe suivante :

Directive (nom de méthode; param). Cette syntaxe n'est pas exécutable en mode interprété.

• Les paramètres reçus par les méthodes base

Ces paramètres sont typés par défaut par le compilateur, si la déclaration n'a pas été faite explicitement. Néanmoins, si vous les déclarez, la déclaration doit se faire à l'intérieur des méthodes base.

La déclaration de ces paramètres ne peut pas se faire dans une méthode compilateur.

Exemple : la Méthode base Sur connexion Web reçoit six paramètres $1 à $6 de type texte. En début de méthode, vous devez écrivez : C_TEXTE($1;$2;$3;$4;$5;$6)

• Les triggers

Le paramètre $0 (Entier long), résultat d'un trigger, est typé par défaut par le compilateur, si la déclaration n'a pas été faite explicitement. Néanmoins si vous le déclarez, la déclaration doit se faire à l'intérieur du trigger.

La déclaration de ce paramètre ne peut pas se faire dans une méthode compilateur.

• Les objets acceptant l'événement formulaire "Sur glisser"

Le paramètre $0 (Entier long), résultat d'un événement formulaire "Sur glisser", est typé par défaut par le compilateur, si la déclaration n'a pas été faite explicitement. Néanmoins si vous le déclarez, la déclaration doit se faire à l'intérieur de la méthode objet.

La déclaration de ce paramètre ne peut pas se faire dans une méthode compilateur.

Note : Le compilateur n'initialise pas le paramètre $0. Dès que vous utilisez l'événement formulaire Sur glisser, vous devez donc initialiser $0. Par exemple :

   C_ENTIER LONG($0)
   Si (Evenement formulaire=Sur glisser)
      $0:=0
      ...
      Si ($TypeDeDonnées=Est une image)
         $0:=-1
      Fin de si
      ...
   Fin de si

La syntaxe de toutes les directives de compilation est extrêmement simple ; seule la commande C_ALPHA requiert une attention particulière puisqu'elle admet un paramètre supplémentaire : la longueur maximale de la chaîne.

Par définition, C_ALPHA porte sur des chaînes fixes, il est donc naturel de donner la longueur de cette chaîne. A cet égard, il convient de rappeler une différence de comportement entre une base interprétée et une base compilée.

Dans une base interprétée, la séquence suivante :

   LaLongueur:=15
   C_ALPHA(LaLongueur; LaChaine)

serait parfaitement logique. 4e Dimension interpréterait LaLongueur puis remplacerait LaLongueur par sa valeur dans la directive.

En revanche, le compilateur utilise cette commande durant le typage des variables et en dehors de toute affectation particulière. Il ne peut donc pas savoir que LaLongueur est égale à 15. Ne connaissant pas la longueur de la chaîne, il ne peut pas lui réserver de place dans la table des symboles. Par conséquent, dans l'optique d'une compilation, il convient d'utiliser une constante pour spécifier la longueur de la chaîne de caractères déclarée. Cette déclaration se fera donc de la façon suivante :

   C_ALPHA(15;LaChaine)

Il en va de même pour la déclaration de tableaux d'alphas par la commande :

   TABLEAU ALPHA(LaLongueur;LeTableau;Nombre d'éléments)

Le paramètre indiquant la longueur des chaînes du tableau sera une constante.

En revanche, vous pouvez utiliser les constantes 4D ou des valeurs hexadécimales pour spécifier la longueur des chaînes dans ces deux directives de compilation. Exemple :

   C_ALPHA(Constante4D;LaChaîne)
   TABLEAU ALPHA(Constante4D;LeTableau;2)
   C_ALPHA(0x000A;LaChaîne)
   TABLEAU ALPHA(0x000A;LeTableau;2)

Ne confondez pas la longueur d'un champ Alphanumérique qui peut être au maximum de 80 caractères avec une variable Alphanumérique. La longueur d'une chaîne déclarée par la directive C_ALPHA ou appartenant à un TABLEAU ALPHA peut être comprise entre 1 et 255.

Note : La syntaxe de cette commande vous permet de déclarer plusieurs variables de même longueur en une seule ligne. Si vous souhaitez déclarer plusieurs chaînes fixes de longueur différente, il faudra le faire en plusieurs lignes.

Les directives de compilation lèvent toute ambiguïté sur les types et, pour le cas des chaînes alphanumériques, sur les longueurs. L'exigence de rigueur ne se fait pas pour autant intolérance.

S'il vous arrive d'utiliser un Numérique là où vous avez déclaré un Entier ou de manipuler une chaîne de 30 caractères là où vous en avez déclaré une de 10, le compilateur ne considère pas qu'il y a conflit et suit simplement vos directives. Ainsi, si vous écrivez :

   C_ENTIER(vEntier)
   vEntier:=2,6

Le compilateur ne verra pas un conflit de types de nature à empêcher la compilation et prendra automatiquement en compte la partie entière arrondie du nombre affecté (3 au lieu de 2,6).

De la même façon, s'il vous arrive de déclarer une chaîne plus courte que la chaîne que vous manipulez, le compilateur ne prend que le nombre de caractères déclarés. Ainsi, dans la séquence suivante :

   C_ALPHA(10;LaChaine)
   LaChaine:="Il fait très beau aujourd'hui"

le compilateur prend en compte les 10 premiers caractères de la constante, soit "Il fait tr".

Conseils d'optimisation, Guide du typage, Messages d'erreurs, Précisions de syntaxe.