tagmanager/ctags/docbook.c

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