tagmanager/docbook.c

   1 /*
   2  *   $Id$
   3  *
   4  *   Copyright (c) 2000-2001, Jérôme Plût
   5  *   Copyright (c) 2006, Enrico Tröger
   6  *
   7  *   This source code is released for free distribution under the terms of the
   8  *   GNU General Public License.
   9  *
  10  *   This module contains functions for generating tags for source files
  11  *   for docbook files(based on TeX parser from Jérôme Plût).
  12  */
  13
  14 /*
  15 *   INCLUDE FILES
  16 */
  17 #include "general.h"    /* must always come first */
  18
  19 #include <ctype.h>
  20 #include <string.h>
  21
  22 #include "parse.h"
  23 #include "read.h"
  24 #include "vstring.h"
  25
  26 /*
  27 *   DATA DEFINITIONS
  28 */
  29 typedef enum {
  30     K_CHAPTER,
  31     K_SECTION,
  32     K_SECT1,
  33     K_SECT2,
  34     K_SECT3,
  35     K_APPENDIX
  36 } docbookKind;
  37
  38 static kindOption DocBookKinds [] = {
  39     { TRUE,  'f', "function",   "chapters"},
  40     { TRUE,  'c', "class",      "sections"},
  41     { TRUE,  'm', "member",     "sect1"},
  42     { TRUE,  'd', "macro",      "sect2"},
  43     { TRUE,  'v', "variable",   "sect3"},
  44     { TRUE,  's', "struct",     "appendix"}
  45 };
  46
  47 /*
  48 *   FUNCTION DEFINITIONS
  49 */
  50
  51 static int getWord(const char *ref, const char **ptr)
  52 {
  53      const char *p = *ptr;
  54
  55      while ((*ref != '\0') && (*p != '\0') && (*ref == *p)) ref++, p++;
  56
  57      if (*ref) return FALSE;
  58
  59      *ptr = p;
  60      return TRUE;
  61 }
  62
  63
  64 static void createTag(docbookKind kind, const char *buf)
  65 {
  66         vString *name;
  67
  68         if (*buf == '>') return;
  69
  70         buf = strstr(buf, "id=\"");
  71         if (buf == NULL) return;
  72         buf += 4;
  73         if (*buf == '"') return;
  74         name = vStringNew();
  75
  76         do
  77         {
  78                 vStringPut(name, (int) *buf);
  79                 ++buf;
  80         } while ((*buf != '\0') && (*buf != '"'));
  81         vStringTerminate(name);
  82         makeSimpleTag(name, DocBookKinds, kind);
  83 }
  84
  85
  86 static void findDocBookTags(void)
  87 {
  88     const char *line;
  89
  90     while ((line = (const char*)fileReadLine()) != NULL)
  91     {
  92                 const char *cp = line;
  93
  94                 for (; *cp != '\0'; cp++)
  95                 {
  96                         if (*cp == '<')
  97                         {
  98                                 cp++;
  99
 100                                 /* <section id="..."> */
 101                                 if (getWord("section", &cp))
 102                                 {
 103                                         createTag(K_SECTION, cp);
 104                                         continue;
 105                                 }
 106                                 /* <sect1 id="..."> */
 107                                 if (getWord("sect1", &cp))
 108                                 {
 109                                         createTag(K_SECT1, cp);
 110                                         continue;
 111                                 }
 112                                 /* <sect2 id="..."> */
 113                                 if (getWord("sect2", &cp))
 114                                 {
 115                                         createTag(K_SECT2, cp);
 116                                         continue;
 117                                 }
 118                                 /* <sect3 id="..."> */
 119                                 if (getWord("sect3", &cp) ||
 120                                         getWord("sect4", &cp) ||
 121                                         getWord("sect5", &cp))
 122                                 {
 123                                         createTag(K_SECT3, cp);
 124                                         continue;
 125                                 }
 126                                 /* <chapter id="..."> */
 127                                 if (getWord("chapter", &cp))
 128                                 {
 129                                         createTag(K_CHAPTER, cp);
 130                                         continue;
 131                                 }
 132                                 /* <appendix id="..."> */
 133                                 if (getWord("appendix", &cp))
 134                                 {
 135                                         createTag(K_APPENDIX, cp);
 136                                         continue;
 137                                 }
 138                         }
 139                 }
 140     }
 141 }
 142
 143 extern parserDefinition* DocBookParser (void)
 144 {
 145         static const char *const extensions [] = { "sgml", "docbook", NULL };
 146     parserDefinition* def = parserNew ("Docbook");
 147     def->extensions = extensions;
 148     def->kinds      = DocBookKinds;
 149     def->kindCount  = KIND_COUNT (DocBookKinds);
 150     def->parser     = findDocBookTags;
 151     return def;
 152 }
 153