ctags/parsers/r.c

   1 /*
   2 *   Copyright (c) 2003-2004, Ascher Stefan <stievie@utanet.at>
   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 R language files.
   8 *   R is a programming language for statistical computing.
   9 *   R is GPL Software, get it from http://www.r-project.org/
  10 */
  11
  12 /*
  13 *   INCLUDE FILES
  14 */
  15 #include "general.h"    /* must always come first */
  16
  17 #include <string.h>
  18 #include <ctype.h>      /* to define isalpha(), isalnum(), isspace() */
  19
  20 #include "debug.h"
  21 #include "entry.h"
  22 #include "read.h"
  23 #include "vstring.h"
  24
  25 /*#define R_REGEX*/
  26
  27 #define SKIPSPACE(ch) while (isspace((int)*ch)) \
  28   ch++
  29
  30 #ifndef R_REGEX
  31 typedef enum {
  32   K_FUNCTION,
  33   K_LIBRARY,
  34   K_SOURCE,
  35   KIND_COUNT
  36 } rKind;
  37
  38 static kindOption RKinds [KIND_COUNT] = {
  39   { TRUE, 'f', "function",  "functions" },
  40   { TRUE, 'l', "library",  "libraries" },
  41   { TRUE, 's', "source",  "sources" },
  42 };
  43 #endif
  44
  45 #ifdef R_REGEX
  46 static void installRRegex (const langType language)
  47 {
  48   /* This is a function, looks as follows:
  49    * itent <- function(arg1, arg2) {
  50    *   do_something;
  51    * }
  52    */
  53   addTagRegex (language,
  54     "^[ \t]*([.a-zA-Z0-9_]+)([ \t]*)<-([ \t]*)function", "\\1", "f,function", NULL);
  55   /* This loads someting, e.g. a library, simply: library(libname) */
  56   addTagRegex (language,
  57     "^[ \t]*(library|source|load|data)[\\(]([a-zA-Z0-9_]+)[\\)]", "\\2", "s,other", NULL);
  58 }
  59 #else
  60 static void makeRTag(const vString* const name, rKind kind)
  61 {
  62   tagEntryInfo e;
  63   initTagEntry(&e, vStringValue(name));
  64
  65   Assert(kind < KIND_COUNT);
  66
  67   e.kindName = RKinds[kind].name;
  68   e.kind     = RKinds[kind].letter;
  69
  70   makeTagEntry(&e);
  71 }
  72
  73 static void createRTags(void)
  74 {
  75   vString *vLine = vStringNew();
  76   vString *name = vStringNew();
  77   int ikind;
  78   const unsigned char *line;
  79
  80   while ((line = fileReadLine()) != NULL)
  81   {
  82     const unsigned char *cp = (const unsigned char*)line;
  83
  84     vStringClear(name);
  85     while ((*cp != '\0') && (*cp != '#')) {
  86       /* iterate to the end of line or to a comment */
  87       ikind = -1;
  88       switch (*cp) {
  89         case 'l':
  90         case 's':
  91           if (strncasecmp((const char*)cp, "library", (size_t)7) == 0) {
  92             /* load a library: library(tools) */
  93             cp += 7;
  94             SKIPSPACE(cp);
  95             if (*cp == '(')
  96               ikind = K_LIBRARY;
  97             else
  98               cp -= 7;
  99           } else if (strncasecmp((const char*)cp, "source", (size_t)6) == 0) {
 100             /* load a source file: source("myfile.r") */
 101             cp += 6;
 102             SKIPSPACE(cp);
 103             if (*cp == '(')
 104               ikind = K_SOURCE;
 105             else
 106               cp -= 6;
 107           }
 108           if (ikind != -1) {
 109             cp++;
 110
 111             vStringClear(name);
 112             while ((!isspace((int)*cp)) && *cp != '\0' && *cp != ')') {
 113               vStringPut(name, (int)*cp);
 114               cp++;
 115             }
 116             vStringTerminate(name);
 117
 118             /* if the string really exists, make a tag of it */
 119             if (vStringLength(name) > 0)
 120               makeRTag(name, ikind);
 121
 122             /* prepare for the next iteration */
 123             vStringClear(name);
 124           } else {
 125             vStringPut(name, (int)*cp);
 126             cp++;
 127           }
 128           break;
 129         case '<':
 130           cp++;
 131           if (*cp == '-') {
 132             /* assignment: ident <- someval */
 133             cp++;
 134             SKIPSPACE(cp);
 135
 136             if (*cp == '\0') {
 137               /* not in this line, read next */
 138               /* sometimes functions are declared this way:
 139                 ident <-
 140                 function(...)
 141                 {
 142                   ...
 143                 }
 144                 I don't know if there is a reason to write the function keyword
 145                 in a new line
 146               */
 147               if ((line = fileReadLine()) != NULL) {
 148                 cp = (const unsigned char*)line;
 149                 SKIPSPACE(cp);
 150               }
 151             }
 152
 153             if (strncasecmp((const char*)cp, "function", (size_t)8) == 0) {
 154               /* it's a function: ident <- function(args) */
 155               cp += 8;
 156               vStringTerminate(name);
 157               /* if the string really exists, make a tag of it */
 158               if (vStringLength(name) > 0)
 159                 makeRTag(name, K_FUNCTION);
 160
 161               /* prepare for the next iteration */
 162               vStringClear(name);
 163               break;
 164             }
 165           }
 166         case ' ':
 167         case '\x009':
 168           /* skip whitespace */
 169           cp++;
 170           break;
 171         default:
 172           /* collect all characters that could be a part of an identifier */
 173           vStringPut(name, (int)*cp);
 174           cp++;
 175           break;
 176       }
 177     }
 178   }
 179
 180   vStringDelete(name);
 181   vStringDelete(vLine);
 182 }
 183 #endif
 184
 185 extern parserDefinition* RParser (void)
 186 {
 187   /* *.r: R files
 188    * *.s;*.q: S files
 189    */
 190   static const char *const extensions [] = { "r", "s", "q", NULL };
 191   parserDefinition* const def = parserNew ("R");
 192 #ifndef R_REGEX
 193   def->kinds      = RKinds;
 194   def->kindCount  = KIND_COUNT (RKinds);
 195 #endif
 196   def->extensions = extensions;
 197 #ifndef R_REGEX
 198   def->parser     = createRTags;
 199 #else
 200   def->initialize = installRRegex;
 201   def->regex      = TRUE;
 202 #endif
 203   return def;
 204 }
 205
 206 /* vi:set tabstop=8 shiftwidth=4: */