Download: stut_src.zip

Téléchargement de: stut_src.zip STUT ONE 3 - Le code source

[NDA: Article écrit en Juin 1996, publié dans ST Magazine n° ? en ?]

STUT ONE est un logiciel vous permettant de réaliser un serveur Minitel avec un simple ATARI STF connecté à un Minitel. Nous vous avons parlé de ce logiciel à plusieurs reprises dans ST Magazine, et en particulier dans les numéros 72 et 105 où nous vous avions fourni, respectivement, les versions 2.6 et 3.0 du logiciel. Nous arrivons aujourd'hui au terme de cette longue aventure en levant le voile sur le code source de la version 3. Vous le trouverez sur la disquette accompagnant le magazine.

DEBALLAGE

En décompactant le fichier STUT_SRC.ZIP se trouvant sur la disquette [attaché à cette page web] vous obtiendrez une collection de modules C (*.C) avec leurs headers (*.H) ainsi que quelques fichiers ressource (.RSC) et le fichier liant tout ceci en un seul et même projet: STUT_3.PRJ.

Tout ceci totalise 1,5 Mega-octets de code source! C'est un chiffre relativement important, surtout si on le compare aux 500 Kilo-octets de code source de la version 2.6... Toujours est-il: prévoyez quelques 5 ou 6 Mega-octets de place libre sur votre disque dur si vous voulez pouvoir décompacter puis recompiler le logiciel...

RESSOURCES NECESSAIRES

Alors justement: de quoi avez vous besoin pour recompiler le logiciel? D'un disque dur avec de la place libre, bien sûr, mais aussi d'un compilateur C. Sachez que STUT ONE 3 a été développé avec Pure C version 1.1 (du 20 Mars 1993). L'utilisation de ce même compilateur pour recompiler le logiciel sera bien évidemment préférable à toute autre solution.

Ceci dit, si vous avez un minimum d'expérience avec le portage d'applications en langage C d'une plate-forme à une autre, ou encore d'un compilateur C à un autre, vous pourrez vous en sortir avec tout compilateur C/ATARI digne de ce nom, moyennant quelques retouches mineures du code source, de manière à l'adapter aux bibliothèques (*.LIB) fournies avec votre compilateur.

STUT ONE 3 étant une application d'assez grande taille (comparativement aux applications ATARI courantes), une machine équipée de 4 Mo de RAM est préférable pour le développement et la compilation. L'exploitation peut se faire sur une machine de 1 Mo de RAM si l'on s'en tient à un serveur Minitel d'envergure limitée.

Concernant la taille de l'écran, le minimum confortable est le monochrome 640 * 400 pixels. STUT ONE 3 peut néanmoins supporter une utilisation en mode "moyenne résolution ST", c'est à dire 640 * 200 pixels. Vous découvrirez que des fichiers de ressources spécifiques à ce mode sont inclus dans la distribution de code source. En tout état de cause, si vous avez la possibilité de faire fonctionner le logiciel en mode VGA (640*400, 16 couleurs), ne vous privez surtout pas!

Au niveau disque dur, si quelques Mega-octets sont indispensables à la compilation, il est envisageable de faire tourner un petit serveur sur une machine équipée uniquement de lecteurs de disquettes.

Finalement, STUT ONE 3 est un logiciel serveur Minitel, son utilisation nécessite donc l'emploi d'un ou de plusieurs Minitels. Vous avez besoin d'un Minitel pour vérifier votre travail et pour vous connecter à distance. Mais vous avez également besoin d'un ou de plusieurs Minitels (selon le nombre d'appels simultanés que votre serveur aura à traiter) pour recevoir les appels entrants. Le nombre de Minitels que vous pouvez brancher dépend du nombre de ports série dont dispose votre ordinateur. Néanmoins, maintenant que vous disposez du code source, vous pouvez envisager d'interfacer STUT ONE avec le port MIDI ou encore une carte multi-séries. L'utilisation de modems à la place des Minitels est également envisageable.

COMPILATION

La compilation du logiciel sous Pure C exige que vous chargiez le fichier projet (STUT_3.PRJ) d'une part, et que vous fixiez précisément certaines options de compilation d'autre part.

Mais avant même de parler des options de compilation, parlons d'un petit détail qui a son importance: les tabulations. En effet, comme tout programme écrit dans les règles de l'art les plus évidentes, le code source de STUT ONE fait un fort usage d'indentations et d'alignements dans les tableaux ou les listes d'arguments. Ceux-ci sont souvent obtenus au moyens de tabulations. Ce que vous devez savoir c'est que la taille de ces tabulations est censée être de 3 caractères. Si vous ne visualisez pas le source en ayant fixé la taille des tabulations à 3, vous risquez de vous retrouver avec un code source ressemblant plus à une salade de mots-clef qu'à un programme structuré. Dans Pure C, la taille des tabulations se règle dans le menu Options/Shell:tabsize.

Au niveau de la compilation (menu Options/Compiler) maintenant, deux options doivent absolument être cochées: "Default char is unsigned" (-K) et "Use absolute calls" (-P).

Au niveau de l'édition des liens (menu Options/Linker), il n'y a pas d'indications particulières, si ce n'est de réserver au moins 4096 octets à la pile (Stack).

Une fois ces quelques options correctement paramétrées, vous pouvez tout simplement lancer un "make" pour compiler et linker tous les modules. Ce processus peut être assez long. A titre d'exemple, sur mon Mega STE à 16 Mhz avec 4 Mo de RAM, il a fallu 9 minutes 30 pour tout compiler. C'est en partie pour cette raison que le logiciel est découpé en de multiples modules de petite taille. En effet, par la suite, si vous modifiez un module, un "make" ne recompilera que le module en question et le "linkera" avec les autres modules déjà compilés (sous forme de fichier *.O) auparavant.

La fichier compilé aura une taille approximative de 170 Ko... si vous n'avez pas inclus d'informations de debug ni de table des symboles, etc. L'inclusion de toutes ces options vous sera néanmoins fort utile si vous décidez de modifier le code source et que vous avez besoin de le debugguer au moyen d'un debugger (tel que Pure Debug par exemple).

UN MOT SUR LA LICENCE

Tout comme la version 2, STUT ONE 3 est soumis aux termes de la GNU General Public License (GPL version 2). Cela implique que vous êtes libre d'utiliser le logiciel, de le modifier et même de le revendre, tout ceci à la condition expresse que vous diffusiez également le code source intégral correspondant à toute version compilée que vous diffuseriez par quelque moyen que ce soit.

Contrairement aux licences d'utilisation classiques des logiciels, la GPL est une licence destinée à protéger les utilisateurs, plutôt que les vendeurs de logiciels. Le texte complet de la licence est fourni dans le fichier LICENCE.TXT.

LE CODE SOURCE

Comme nous l'avons déjà évoqué plus haut, le code source est décomposé en une multitude de modules plus ou moins importants. Chacun de ces modules remplit (en théorie) un ensemble de fonctions corrélées. Les modules les plus soignés ressemblent même à des objets et sont plus ou moins inspirés de la terminologie objet du C++. Prenons un exemple...

Au hasard: SERIAL.C. Si vous ouvrez ce fichier, vous devriez comprendre très vite qu'il s'agit d'une sorte de "classe" permettant de gérer les ports série de l'ordinateur (c'est écrit dans les commentaires au début du fichier :-).

Ce fichier contient par exemple la définition de la "méthode" (une fonction C) Serial_WaitTXEmpty( n_device ), dont la fonction est d'attendre que le buffer de transmission (TX par opposition à réception/RX) du port n_device soit vide. Cette méthode pourra par exemple être appelée depuis un autre module qui désirerait s'assurer que toutes les informations ont bien été envoyées avant de faire autre chose.

Cette méthode est publique, c'est à dire, qu'elle peut être appelée depuis un autre module. Néanmoins, afin que l'autre module puisse appeler la méthode, il faut lui déclarer. C'est à cet effet que l'interface publique du module SERIAL.C a été regroupée dans le fichier SRIAL_PU.H. Tout module désirant faire appel à une méthode publique du module SERIAL.C peut dès lors le faire en ayant simplement inclus le fichier de déclarations de la manière suivante:

#include "SRIAL_PU.H"

SERIAL.C contient également des méthodes privées, à usage exclusivement interne. C'est le cas par exemple de get_iorec() qui permet à des fonctions de gestion des ports séries d'accomplir leur tâche en obtenant des informations du système d'exploitation. Cette "fonction privée" est déclarée "static" de manière à ne pouvoir être référencée qu'à l'intérieur du module SERIAL.C et sa déclaration ne figure bien sûr pas dans l'interface publique (SRIAL_PU.H).

Voilà pour le principe d'organisation générale. La liste complète des modules se trouve dans STUT_3.PRJ avec une brève description. Vous pouvez obtenir plus d'informations en ouvrant chacun des modules séparément. Vous constaterez en effet que ceux-ci sont en général abondamment commentés.

L'AVENIR ?

Voilà, vous avez entre les mains le fruit de plusieurs années de travail et de recherche en matière de télématique conviviale (vous trouvez que j'exagère? :-) et vous avez le champ libre quant aux possibilités d'évolution: gestion de modems, transformation en serveur BBS, en serveur vocal ou même en logiciel de création multimédia! (Si on y réfléchit, le moteur d'arborescence à la base du logiciel peut être appliqué à un grand nombre de tâches diverses...)

Quant à moi, je vais aller m'occuper d'une autre vision de la télématique que l'on nomme l'Internet...

François PLANQUE
Ingénieur système chez Planete.net

Juin 1996

NDA: Le code source de STUT ONE 3 fait appel aux routines de débogage des mallocs expliquées dans un autre article.