Les interfaces de Programmation en langage C dans la plate-forme FrameKit

par Jean-Luc Mounier
Laboratoire d'Informatique de Paris 6

SOMMAIRE

Principes généraux

Conventions sur les identificateurs

Quelques types de base

Encapsulation en C des trois axes de FrameKit

Pour la programmation en langage C dans un environnement Unix, il est recommandé d'utiliser les arboscences décrites dans le document "Environnement de Développement Unix" et les librairies:

Principes généraux

Toutes les structures de données de FrameKit sont référencées par des pointeurs aveugles (c'est à dire que vous n'avez pas accès aux champs). Par abus de langage dans ce document, nous parlerons d'objets passés en paramètres au lieu de pointeurs sur objets passés en paramètre. Cependant, lorsque le nom de l'objet commencera par la lettre 'p', cela signifiera qu'il s'agit effectivement d'un pointeur.

Conventions sur les identificateurs

  • Les noms des identificateurs dans FrameKit suivent les règles suivantes:
  • Les noms des fonctions commencent par Fk (exemple FkExit).
  • Les noms des structures commencent par Fk (exemple FkModel).
  • Les types 'pointeurs sur structures' commencent par PFk (exemple PFkModel)
  • Les variables de types 'pointeurs sur structures' commencent par p (exemple pFkModel)
  • Les constantes commencent par kFk_ (exemple kFk_EndOnError)

Quelques types de base

Un certain nombre de types sont prédéfinis. Leur utilisation vous garantira un portage aisé.

typedef unsigned char  FkUByte;
typedef char FkSByte;
typedef unsigned short FkUShort;
typedef short FkSShort;
typedef unsigned long  FkULong;
typedef long FkSLong;
typedef void * FkPtr;
typedef char * FkISOStr;
typedef const char * FkConstISOStr;
typedef unsigned char FkBoolean;
enum { kFk_False, kFk_True };


Encapsulation en C des trois axes de FrameKit

Les trois axes de FrameKit se présentent comme trois librairies accompagnées de nombreux fichiers d'interfaces (.h). Une librairie supplémentaire fournit un ensemble d'outils communs: les CListes, des macros pour la mise au point, des primitives d'allocation mémoire.

Les primitives de communications dans l'environnement FrameKit sont contenues dans la librairie libFKEnv.a, la manipulation des données dans libFKData.a, les relations avec l'interface utilisateur dans libFKUser.a et les outils communs dans libTools.a.

Autres References

Remerciement

Apple Technical Note 1088: Strategies for Producing Browser-Based Technical Documentation

API de Framekit en C | FrameKit
 Mise à jour : 4-nov-1999