tagmanager/tcl.c

   1 /*
   2 *   $Id$
   3 *
   4 *   Copyright (c) 2000-2003, Darren Hiebert
   5 *
   6 *   This source code is released for free distribution under the terms of the
   7 *   GNU General Public License.
   8 *
   9 *   This module contains functions for generating tags for TCL scripts.
  10 */
  11
  12 /*
  13 *   INCLUDE FILES
  14 */
  15 #include "general.h"  /* must always come first */
  16
  17 #include <string.h>
  18
  19 #include "parse.h"
  20 #include "read.h"
  21 #include "vstring.h"
  22
  23 /*
  24 *   DATA DEFINITIONS
  25 */
  26 typedef enum {
  27         K_CLASS, K_METHOD, K_PROCEDURE, K_MODULE
  28 } tclKind;
  29
  30 static kindOption TclKinds [] = {
  31         { TRUE, 'c', "class",     "classes" },
  32         { TRUE, 'f', "member",    "methods" },
  33         { TRUE, 'p', "function",  "procedures" },
  34         { TRUE, 'm', "namespace", "modules" }
  35 };
  36
  37 /*
  38 *   FUNCTION DEFINITIONS
  39 */
  40
  41 static const unsigned char *makeTclTag (
  42                 const unsigned char *cp,
  43                 vString *const name,
  44                 const tclKind kind)
  45 {
  46         vStringClear (name);
  47         while ((int) *cp != '\0'  &&  ! isspace ((int) *cp))
  48         {
  49                 vStringPut (name, (int) *cp);
  50                 ++cp;
  51         }
  52         vStringTerminate (name);
  53         makeSimpleTag (name, TclKinds, kind);
  54         return cp;
  55 }
  56
  57 static boolean match (const unsigned char *line, const char *word)
  58 {
  59         size_t len = strlen (word);
  60         boolean matched = (strncmp ((const char*) line, word, len) == 0);
  61
  62         if (matched)
  63         {
  64                 /* check that the word is followed by a space to avoid detecting something
  65                  * like "proc_new ..." */
  66                 matched = isspace (*(line + len));
  67         }
  68         return matched;
  69 }
  70
  71 static void findTclTags (void)
  72 {
  73         vString *name = vStringNew ();
  74         const unsigned char *line;
  75
  76         while ((line = fileReadLine ()) != NULL)
  77         {
  78                 const unsigned char *cp;
  79
  80                 while (isspace (line [0]))
  81                         ++line;
  82
  83                 if (line [0] == '\0'  ||  line [0] == '#')
  84                         continue;
  85
  86                 /* read first word */
  87                 for (cp = line ; *cp != '\0'  &&  ! isspace ((int) *cp) ; ++cp)
  88                         ;
  89                 if (! isspace ((int) *cp))
  90                         continue;
  91                 while (isspace ((int) *cp))
  92                         ++cp;
  93                 /* Now `line' points at first word and `cp' points at next word */
  94
  95                 if (match (line, "proc"))
  96                         cp = makeTclTag (cp, name, K_PROCEDURE);
  97                 else if (match (line, "class") || match (line, "itcl::class"))
  98                         cp = makeTclTag (cp, name, K_CLASS);
  99                 else if (match (line, "public") ||
 100                                 match (line, "protected") ||
 101                                 match (line, "private"))
 102                 {
 103                         if (match (cp, "method"))
 104                         {
 105                                 cp += 6;
 106                                 while (isspace ((int) *cp))
 107                                         ++cp;
 108                                 cp = makeTclTag (cp, name, K_METHOD);
 109                         }
 110                 }
 111                 else if (match (line, "method"))
 112                 {
 113                         cp = makeTclTag (cp, name, K_METHOD);
 114                 }
 115                 else if (match (line, "oo::class") ) {
 116                         if (match (cp, "create"))
 117                         {
 118                                 cp += 6;
 119                                 while (isspace ((int) *cp))
 120                                         ++cp;
 121                                 cp = makeTclTag (cp, name, K_CLASS);
 122                         }
 123                 }
 124                 else if (match (line, "namespace") ) {
 125                         if (match (cp, "eval"))
 126                         {
 127                                 cp += 4;
 128                                 while (isspace ((int) *cp))
 129                                         ++cp;
 130                                 cp = makeTclTag (cp, name, K_MODULE);
 131                         }
 132                 }
 133
 134         }
 135         vStringDelete (name);
 136 }
 137
 138 extern parserDefinition* TclParser (void)
 139 {
 140         static const char *const extensions [] = { "tcl", "tk", "wish", "itcl", NULL };
 141         parserDefinition* def = parserNew ("Tcl");
 142         def->kinds      = TclKinds;
 143         def->kindCount  = KIND_COUNT (TclKinds);
 144         def->extensions = extensions;
 145         def->parser     = findTclTags;
 146         return def;
 147 }
 148
 149 /* vi:set tabstop=4 shiftwidth=4: */