tagmanager/php.c

   1 /*
   2 *   $Id$
   3 *
   4 *   Copyright (c) 2000, Jesus Castagnetto <jmcastagnetto@zkey.com>
   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 the PHP web page
  10 *   scripting language. Only recognizes functions and classes, not methods or
  11 *   variables.
  12 *
  13 *   Parsing PHP defines by Pavel Hlousek <pavel.hlousek@seznam.cz>, Apr 2003.
  14 */
  15
  16 /*
  17 *   INCLUDE FILES
  18 */
  19 #include "general.h"  /* must always come first */
  20
  21 #include <string.h>
  22
  23 #include "parse.h"
  24 #include "read.h"
  25 #include "vstring.h"
  26
  27 /*
  28 *   DATA DEFINITIONS
  29 */
  30 typedef enum {
  31         K_CLASS, K_DEFINE, K_FUNCTION, K_VARIABLE
  32 } phpKind;
  33
  34 static kindOption PhpKinds [] = {
  35         { TRUE, 'c', "class",    "classes" },
  36         { TRUE, 'd', "define",   "constant definitions" },
  37         { TRUE, 'f', "function", "functions" },
  38         { TRUE, 'v', "variable", "variables" }
  39 };
  40
  41 /*
  42 *   FUNCTION DEFINITIONS
  43 */
  44
  45 static boolean isLetter(const int c)
  46 {
  47         return (boolean)(isalpha(c) || (c >= 127  &&  c <= 255));
  48 }
  49
  50 static boolean isVarChar1(const int c)
  51 {
  52         return (boolean)(isLetter (c)  ||  c == '_');
  53 }
  54
  55 static boolean isVarChar(const int c)
  56 {
  57         return (boolean)(isVarChar1 (c) || isdigit (c));
  58 }
  59
  60 static void findPhpTags (void)
  61 {
  62         vString *name = vStringNew ();
  63         const unsigned char *line;
  64
  65         while ((line = fileReadLine ()) != NULL)
  66         {
  67                 const unsigned char *cp = line;
  68
  69                 while (isspace (*cp))
  70                         cp++;
  71
  72                 if (*(const char*)cp == '$'  &&  isVarChar1 (*(const char*)(cp+1)))
  73                 {
  74                         cp += 1;
  75                         vStringClear (name);
  76                         while (isVarChar ((int) *cp))
  77                         {
  78                                 vStringPut (name, (int) *cp);
  79                                 ++cp;
  80                         }
  81                         while (isspace ((int) *cp))
  82                                 ++cp;
  83                         if (*(const char*) cp == '=')
  84                         {
  85                                 vStringTerminate (name);
  86                                 makeSimpleTag (name, PhpKinds, K_VARIABLE);
  87                                 vStringClear (name);
  88                         }
  89                 }
  90                 else if (strncmp ((const char*) cp, "function", (size_t) 8) == 0  &&
  91                         isspace ((int) cp [8]))
  92                 {
  93                         cp += 8;
  94
  95                         while (isspace ((int) *cp))
  96                                 ++cp;
  97
  98                         if (*cp == '&')  /* skip reference character */
  99                                 cp++;
 100
 101                         vStringClear (name);
 102                         while (isalnum ((int) *cp)  ||  *cp == '_')
 103                         {
 104                                 vStringPut (name, (int) *cp);
 105                                 ++cp;
 106                         }
 107                         vStringTerminate (name);
 108                         makeSimpleTag (name, PhpKinds, K_FUNCTION);
 109                         vStringClear (name);
 110                 }
 111                 else if (strncmp ((const char*) cp, "class", (size_t) 5) == 0 &&
 112                                  isspace ((int) cp [5]))
 113                 {
 114                         cp += 5;
 115
 116                         while (isspace ((int) *cp))
 117                                 ++cp;
 118                         vStringClear (name);
 119                         while (isalnum ((int) *cp)  ||  *cp == '_')
 120                         {
 121                                 vStringPut (name, (int) *cp);
 122                                 ++cp;
 123                         }
 124                         vStringTerminate (name);
 125                         makeSimpleTag (name, PhpKinds, K_CLASS);
 126                         vStringClear (name);
 127                 }
 128                 else if (strncmp ((const char*) cp, "define", (size_t) 6) == 0 &&
 129                                  ! isalnum ((int) cp [6]))
 130                 {
 131                         cp += 6;
 132
 133                         while (isspace ((int) *cp))
 134                                 ++cp;
 135                         if (*cp != '(')
 136                                 continue;
 137                         ++cp;
 138
 139                         while (isspace ((int) *cp))
 140                                 ++cp;
 141                         if ((*cp == '\'') || (*cp == '"'))
 142                                 ++cp;
 143                         else if (! ((*cp == '_')  || isalnum ((int) *cp)))
 144                                 continue;
 145
 146                         vStringClear (name);
 147                         while (isalnum ((int) *cp)  ||  *cp == '_')
 148                         {
 149                                 vStringPut (name, (int) *cp);
 150                                 ++cp;
 151                         }
 152                         vStringTerminate (name);
 153                         makeSimpleTag (name, PhpKinds, K_DEFINE);
 154                         vStringClear (name);
 155                 }
 156         }
 157         vStringDelete (name);
 158 }
 159
 160 extern parserDefinition* PhpParser (void)
 161 {
 162         static const char *const extensions [] = { "php", "php3", "phtml", NULL };
 163         parserDefinition* def = parserNew ("PHP");
 164         def->kinds      = PhpKinds;
 165         def->kindCount  = KIND_COUNT (PhpKinds);
 166         def->extensions = extensions;
 167         def->parser     = findPhpTags;
 168         return def;
 169 }
 170
 171 /* vi:set tabstop=4 shiftwidth=4: */