ctags/parsers/sh.c

   1 /*
   2 *   Copyright (c) 2000-2002, Darren Hiebert
   3 *
   4 *   This source code is released for free distribution under the terms of the
   5 *   GNU General Public License version 2 or (at your option) any later version.
   6 *
   7 *   This module contains functions for generating tags for scripts for the
   8 *   Bourne shell (and its derivatives, the Korn and Z shells).
   9 */
  10
  11 /*
  12 *   INCLUDE FILES
  13 */
  14 #include "general.h"  /* must always come first */
  15
  16 #include <string.h>
  17
  18 #include "parse.h"
  19 #include "read.h"
  20 #include "routines.h"
  21 #include "vstring.h"
  22 #include "xtag.h"
  23
  24 /*
  25 *   DATA DEFINITIONS
  26 */
  27 typedef enum {
  28         K_FUNCTION
  29 } shKind;
  30
  31 static kindOption ShKinds [] = {
  32         { true, 'f', "function", "functions"}
  33 };
  34
  35 /*
  36 *   FUNCTION DEFINITIONS
  37 */
  38
  39 /*  Reject any tag "main" from a file named "configure". These appear in
  40  *  here-documents in GNU autoconf scripts and will add a haystack to the
  41  *  needle.
  42  */
  43 static bool hackReject (const vString* const tagName)
  44 {
  45         const char *const scriptName = baseFilename (getInputFileName ());
  46         bool result = (bool) (strcmp (scriptName, "configure") == 0  &&
  47                                                   strcmp (vStringValue (tagName), "main") == 0);
  48         return result;
  49 }
  50
  51 static void findShTags (void)
  52 {
  53         vString *name = vStringNew ();
  54         const unsigned char *line;
  55
  56         while ((line = readLineFromInputFile ()) != NULL)
  57         {
  58                 const unsigned char* cp = line;
  59                 bool functionFound = false;
  60
  61                 if (line [0] == '#')
  62                         continue;
  63
  64                 while (isspace (*cp))
  65                         cp++;
  66                 if (strncmp ((const char*) cp, "function", (size_t) 8) == 0  &&
  67                         isspace ((int) cp [8]))
  68                 {
  69                         functionFound = true;
  70                         cp += 8;
  71                         if (! isspace ((int) *cp))
  72                                 continue;
  73                         while (isspace ((int) *cp))
  74                                 ++cp;
  75                 }
  76                 if (! (isalnum ((int) *cp) || *cp == '_'))
  77                         continue;
  78                 while (isalnum ((int) *cp)  ||  *cp == '_')
  79                 {
  80                         vStringPut (name, (int) *cp);
  81                         ++cp;
  82                 }
  83                 while (isspace ((int) *cp))
  84                         ++cp;
  85                 if (*cp++ == '(')
  86                 {
  87                         while (isspace ((int) *cp))
  88                                 ++cp;
  89                         if (*cp == ')'  && ! hackReject (name))
  90                                 functionFound = true;
  91                 }
  92                 if (functionFound)
  93                         makeSimpleTag (name, ShKinds, K_FUNCTION);
  94                 vStringClear (name);
  95         }
  96         vStringDelete (name);
  97 }
  98
  99 extern parserDefinition* ShParser (void)
 100 {
 101         static const char *const extensions [] = {
 102                 "sh", "SH", "bsh", "bash", "ksh", "zsh", "ash", NULL
 103         };
 104         parserDefinition* def = parserNew ("Sh");
 105         def->kinds      = ShKinds;
 106         def->kindCount  = ARRAY_SIZE (ShKinds);
 107         def->extensions = extensions;
 108         def->parser     = findShTags;
 109         return def;
 110 }