tagmanager/latex.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 the TeX formatting system.
  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_COMMAND,
  31      K_ENVIRONMENT,
  32      K_SECTION,
  33      K_SUBSECTION,
  34      K_SUBSUBSECTION,
  35      K_CHAPTER,
  36      K_LABEL
  37 } TeXKind;
  38
  39 static kindOption TeXKinds[] = {
  40      { TRUE, 'f', "function",      "command definitions" },
  41      { TRUE, 'c', "class",         "environment definitions" },
  42      { TRUE, 'm', "member",        "labels, sections and bibliography" },
  43      { TRUE, 'd', "macro",         "subsections" },
  44      { TRUE, 'v', "variable",      "subsubsections" },
  45      { TRUE, 'n', "namespace",     "chapters"},
  46      { TRUE, 's', "struct",        "labels and bibliography" }
  47 };
  48
  49 #define TEX_BRACES (1<<0)
  50 #define TEX_BSLASH (1<<1)
  51 #define TEX_LABEL  (1<<2)
  52
  53 /*
  54 *   FUNCTION DEFINITIONS
  55 */
  56
  57 static int getWord(const char * ref, const char **ptr)
  58 {
  59     const char *p = *ptr;
  60
  61         while ((*ref != '\0') && (*p != '\0') && (*ref == *p))
  62                 ref++, p++;
  63
  64
  65     if (*ref)
  66                 return FALSE;
  67
  68         if (*p == '*') /* to allow something like \section*{foobar} */
  69                 p++;
  70
  71     *ptr = p;
  72         return TRUE;
  73 }
  74
  75 static void createTag(int flags, TeXKind kind, const char * l)
  76 {
  77     vString *name = vStringNew ();
  78
  79     while ((*l == ' '))
  80         l++;
  81     if (flags & (TEX_BRACES | TEX_LABEL))
  82     {
  83         if (*l == '[')
  84         {
  85             while (*l != ']')
  86                 l++;
  87             l++; /* skip the closing square bracket */
  88         }
  89         if (*l != '{')
  90             goto no_tag;
  91         l++;
  92      }
  93      if (flags & TEX_BSLASH)
  94      {
  95         if ((*(l++)) != '\\')
  96             goto no_tag;
  97      }
  98      if (flags & TEX_LABEL)
  99      {
 100         do
 101         {
 102             vStringPut(name, (int) *l);
 103             ++l;
 104         } while ((*l != '\0') && (*l != '}'));
 105         vStringTerminate(name);
 106         if (name->buffer[0] != '}')
 107                 makeSimpleTag(name, TeXKinds, kind);
 108      }
 109      else if (isalpha((int) *l) || *l == '@')
 110      {
 111         do
 112         {
 113             vStringPut (name, (int) *l);
 114             ++l;
 115         } while (isalpha((int) *l) || *l == '@');
 116         vStringTerminate(name);
 117         makeSimpleTag(name, TeXKinds, kind);
 118      }
 119      else
 120      {
 121         vStringPut(name, (int) *l);
 122         vStringTerminate(name);
 123         makeSimpleTag(name, TeXKinds, kind);
 124      }
 125
 126  no_tag:
 127      vStringDelete(name);
 128 }
 129
 130 static void findTeXTags(void)
 131 {
 132     const char *line;
 133
 134     while ((line = (const char*)fileReadLine()) != NULL)
 135     {
 136         const char *cp = line;
 137         /*int escaped = 0;*/
 138
 139         for (; *cp != '\0'; cp++)
 140         {
 141             if (*cp == '%')
 142                         break;
 143             if (*cp == '\\')
 144             {
 145                 cp++;
 146
 147                 /* \newcommand{\command} */
 148                 if (getWord("newcommand", &cp)
 149                     || getWord("providecommand", &cp)
 150                     || getWord("renewcommand", &cp)
 151                     )
 152                 {
 153                     createTag (TEX_BRACES|TEX_BSLASH, K_COMMAND, cp);
 154                     continue;
 155                 }
 156
 157                 /* \DeclareMathOperator{\command} */
 158                 else if (getWord("DeclareMathOperator", &cp))
 159                 {
 160                     if (*cp == '*')
 161                         cp++;
 162                     createTag(TEX_BRACES|TEX_BSLASH, K_COMMAND, cp);
 163                     continue;
 164                 }
 165
 166                 /* \def\command */
 167                 else if (getWord("def", &cp))
 168                 {
 169                     createTag(TEX_BSLASH, K_COMMAND, cp);
 170                     continue;
 171                 }
 172
 173                 /* \newenvironment{name} */
 174                 else if ( getWord("newenvironment", &cp)
 175                     || getWord("newtheorem", &cp)
 176                     || getWord("begin", &cp)
 177                     )
 178                 {
 179                     createTag(TEX_BRACES, K_ENVIRONMENT, cp);
 180                     continue;
 181                 }
 182
 183                 /* \bibitem[label]{key} */
 184                 else if (getWord("bibitem", &cp))
 185                 {
 186                     while (*cp == ' ')
 187                         cp++;
 188                     if (*(cp++) != '[')
 189                         break;
 190                     while ((*cp != '\0') && (*cp != ']'))
 191                         cp++;
 192                     if (*(cp++) != ']')
 193                         break;
 194                     createTag(TEX_LABEL, K_LABEL, cp);
 195                     continue;
 196                 }
 197
 198                 /* \label{key} */
 199                 else if (getWord("label", &cp))
 200                 {
 201                     createTag(TEX_LABEL, K_LABEL, cp);
 202                     continue;
 203                 }
 204                 /* \section{key} */
 205                 else if (getWord("section", &cp))
 206                 {
 207                     createTag(TEX_LABEL, K_SECTION, cp);
 208                     continue;
 209                 }
 210                 /* \subsection{key} */
 211                 else if (getWord("subsection", &cp))
 212                 {
 213                     createTag(TEX_LABEL, K_SUBSECTION, cp);
 214                     continue;
 215                 }
 216                 /* \subsubsection{key} */
 217                 else if (getWord("subsubsection", &cp))
 218                 {
 219                     createTag(TEX_LABEL, K_SUBSUBSECTION, cp);
 220                     continue;
 221                 }
 222                 /* \chapter{key} */
 223                 else if (getWord("chapter", &cp))
 224                 {
 225                     createTag(TEX_LABEL, K_CHAPTER, cp);
 226                     continue;
 227                 }
 228             }
 229         }
 230     }
 231 }
 232
 233 extern parserDefinition* LaTeXParser (void)
 234 {
 235         static const char *const extensions [] = { "tex", "sty", "idx", NULL };
 236         parserDefinition * def = parserNew ("LaTeX");
 237         def->kinds      = TeXKinds;
 238         def->kindCount  = KIND_COUNT (TeXKinds);
 239         def->extensions = extensions;
 240         def->parser     = findTeXTags;
 241         return def;
 242 }
 243