Introduction à la programmation en C des arbres Xml

Cette page reprend une section du cours qui était donné pour l'utilisation de la plateforme Dilib.

Arbres XML - notions de base

La bibliothèque Dilib est basée sur la norme XML avec des adaptations légères (Stream XML ou Sxml) pour pouvoir manipuler des grandes quantités de documents XML.

L'objet de base : SxmlNode

Les arbres Sxml sont réalisés à l'aide d'une structure élémentaire unique nommée "SxmlNode"

un arbre XML contenant 6 nœuds

Type de base : SxmlNode

Nous avons adopté "un style objet" en programmation C. Les arbres XML (ou les sous-arbres) seront toujours repérés pas des pointeurs sur des SxmlNode.

Les méthodes élémentaires associées aux objets SxmlNode

Tout objet de type SxmlNode aura trois méthodes permettant d'accéder au père et aux frères d'un nœud XML.

Accès au parent

SxmlNode *SxmlParent (SxmlNode *myNode);

Un nœud XML n'a, au plus, qu'un seul parent. C'est ainsi que des arbres peuvent être réalisés. Dans la figure précédente le noeud <b> est le parent de b1.

Accès au suivant

SxmlNode *SxmlNextSibling (SxmlNode *myNode);

Accès au précédant

SxmlNode *PreviousSibling (SxmlNode *myNode);

Types dérivés

A partir du type de base SxmlNode, un ensemble de types dérivés sont disponibles, nous nous intéressons maintenant aux 2 types permettant de réaliser l'essentiel des structures XML : les éléments XML (ici SxmlElement) qui réalisent le balisage et les zones de texte (SxmlText).

SxmlElement

Un objet de type SxmlElement est généralement la racine d'un sous-arbre. Dans la figure ci-dessus les nœuds <a>, <b> et <c> sont de type SxmlElement.

Accès au premier fils

La méthode permettant d'accéder au premier fils est :

   SxmlNode *SxmlFirstChild (SgmlNode *nx)

Les méthodes peuvent être combinées. Voici un exemple de programme que vous pouvez reproduire et adapter.

#include "SxmlNode.h"
#include <stdio.h>
main()
{
   SxmlNode *myNodeTest;  /* déclaration d'un pointeur qui sera associé 
                             à l'arbre donné en exemple */
   myNodeTest=SxmlFromString("<a>b1<c>c1</c></a>");
   SxmlPrint (myNodeTest);    /* doit imprimer : <a>b1<c>c1</c></a> */
   putchar ('\n');
   SxmlPrint (SxmlFirstChild(myNodeTest));    /* doit imprimer : b1 */
   putchar ('\n');
   SxmlPrint (SxmlNextSibling(SxmlFirstChild(myNodeTest)));    /* doit imprimer : <c>c1</c> */
   putchar ('\n');
}

Si ce programme est rangé dans le fichier myTest.c, dans le cas d'une installation locale standard, il pourra être compilé par :

. ~/Dilib/init.sh
gcc myTest.c $DILIB_CC -o myTest
./myTest

Accès au dernier fils

SxmlLastChild(SgmlNode *)

SxmlText

Un objet de type SxmlText contient une chaîne de caractères. Dans l'exemple ci-dessus, les parties « a1 », « b1 » et « c1 » sont de ce type.

Construction d'arbres Sxml

Constructeur de base

Toutes les fonctions de création utilisent un constructeur de base qui n'est pratiquement jamais directement utilisé par l'utilisateur. Ce paragraphe est donc simplement destiné à la compréhension de l'ensemble.

 SxmlNode *SxmlNodeCreate(type);
          char type;

Le type est un code interne qui définit le type de nœud. Par exemple le code XML_NODE_COMMENT (ou 8) est associé à un commentaire XML.

Constructeurs effectivement utiles

Création d'un élément qui n'a pas encore de contenu.

SxmlNode *SxmlElementCreate(tag);
          char *tag;

Création d'un élément avec son contenu textuel. .

SxmlNode *SxmlLeafCreate(tag, string);
          char *tag;
          char *string;

Exemples

SxmlElementCreate("a");        /* construit <a></a> */

SxmlLeafCreate("a","text"); /* construit <a>text</a> */

Méthodes de construction de base

SxmlAddFirstChild et SxmlAppendChild

Ajout d'un nouvel élément en tête des fils

SxmlNode *SxmlAddFirstChild(pere, fils);
        SxmlNode *pere, *fils;

Ajout d'un nouvel élément en queue de la liste des fils

SxmlNode *SxmlAppendChild(SxmlNode *pere, SxmlNode * fils);

Exemple

/*  création de <a><b>b1</b><c>c1</c></a> */

#include "SxmlNode.h"
  main()
    {
        SxmlNode *root;
	root =SxmlElementCreate("a");
	SxmlAppendChild (root, SxmlLeafCreate("b", "b1"));
	SxmlAppendChild (root, SxmlLeafCreate("c", "c1"));
        SxmlPrint(root);
        putchar('\n');
        exit(0);
    }

Exercices

Modifier le programme précédent pour qu'il imprime le document XML donné en introduction de ce chapitre :  :

   <a>a1<b>b1</b><c>c1</c></a>

Écrire un programme qui produise le document suivant:

   <doc>
      <tit>Tintin au Congo</tit>
       <auteurs>
             <auteur>Hergé</auteur>
       </auteurs>
      <lkw>
           <kw type="person">Tintin</kw>
           <kw>Milou</kw>
     </lkw>
   </doc>

Accès à l'environnement d'un nœud

Les voisins ou parents

Toutes les fonctions retournent un pointeur NULL en cas d'échec.

SxmlNode *SgmlNextSibling(SxmlNode *node);

SxmlNode *SxmlPreviousSibling(SxmlNode *node);

SxmlNode *SxmlFirstChild(SxmlNode *node);

SxmlNode *SxmlLastChild(SxmlNode *node);

SxmlNode *SgmlParent(SxmlNode *node);

Les caractéristiques d'un nœud

Pour un nœud de type SxmlElement

char *SxmlNodeName(node);

Pour un noeud de type SxmlText :

char *SxmlText(noeud);

test de type

int SgmlIsText(node);
int SgmlIsElement(node);

Itérations sur les composants d'un noeud

Principe

Toutes les fonctions renvoient la valeur NULL en cas d'échec ou d'absence d'un élément. Ceci permet de réaliser des itérations sur les objets XML contenus dans un élément.

Squelette d'une itérations sur les fils d'un nœud.

Avec une boucle do

if ((fils = SxmlFirstChild (pere)))
  {
    do 
      { traitement sur fils }
    while ((fils=SxmlNextSibling(fils)));
  }
else
 { traitement de l'exception}

Avec une boucle while

 fils = SxmlFirstChild (pere);
 while (fils)
  {
    traitement sur fils 
    fils=SxmlNextSibling(fils);
  }

Exemple

Édition de toutes les étiquettes des fils d'un nœud.

editChildTag ( SxmlNode *node)
{
  SxmlNode *c1;
  if ((c1=SxmlFirstChild(node)))
	do{ 
            if(SxmlIsElement(c1))
	        printf("%s\n",SgmlTag(c1));
      } while ((son=SxmlNextSibling(c1)));
}

Itérateurs

Dans la bibliothèque Dilib, un itérateur est associé à un élément XML. La fonction SxmlNextNode renvoie le fils suivant. La fonction SxmlReset initialise l'itérateur. L'exemple précédent se réécrit ainsi.

editChildTag ( SxmlNode *node)
{
  SxmlNode *c1;
  SxmlReset (node);
  while (c1=SxmlNextNode(node))
    {
       if(SxmlIsElement(c1)) printf("%s\n",SgmlTag(c1));
    }
}

Import Export de structures SGML

Si la chaîne d'entrée est en forme normale, la construction d'un arbre XML peut se faire sans DTD ni schéma.

Conversion XML en string

Les fonctions d'entreés sorties utilisent un noyau de 2 procédures de conversion vers les chaine (char *) de C.

Conversion d'un arbre XML en String

char *SxmlToString (SgmlNode *node);

Construction d'un arbre SGML à partir d'une string.

SxmlNode* SxmlFromString(char *string);

Entrées-sorties

Les fonctions qui réalisent les entrées sorties sont réalisées à partir des fonction précédentes.

Impression d'un objet SGML sur la sortie standard :

SgmlPrint(node);

Impression d'un objet SGML dans un fichier :

SxmlFilePrint(FILE *file, SxmlNode* node);          ;

lecture du prochain document SGML sur l'entrée standard.

SgmlNode *SxmlInputNextDocumentElement();

Exemple

Impression de tous les premiers fils ayant «a» pour tag.

#include "SxmlNode.h"
main()
{
  SxmlNode *docu ,*son;
  while(docu=SxmlInputNextDocumentElement())
    {
       if (son=SxmlFirstChild(docu))
         {if (strcmp(SxmlNodeName(son), "a")==0)
                 {SxmlPrint(son);putchar('\n');
    }}};
}

Voir aussi

notes