src/editor/etags.c

   1 /* editor C-code navigation via tags.
   2    make TAGS file via command:
   3    $ find . -type f -name "*.[ch]" | etags -l c --declarations -
   4
   5    or, if etags utility not installed:
   6    $ find . -type f -name "*.[ch]" | ctags --c-kinds=+p --fields=+iaS --extra=+q -e -L-
   7
   8    Copyright (C) 2009 Free Software Foundation, Inc.
   9
  10    Authors:
  11     Ilia Maslakov <il.smind@gmail.com>, 2009
  12     Slava Zanko <slavazanko@gmail.com>, 2009
  13
  14
  15    This file is part of the Midnight Commander.
  16
  17    The Midnight Commander is free software; you can redistribute it
  18    and/or modify it under the terms of the GNU General Public License as
  19    published by the Free Software Foundation; either version 2 of the
  20    License, or (at your option) any later version.
  21
  22    The Midnight Commander is distributed in the hope that it will be
  23    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  24    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  25    General Public License for more details.
  26
  27    You should have received a copy of the GNU General Public License
  28    along with this program; if not, write to the Free Software
  29    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  30    MA 02110-1301, USA.
  31 */
  32
  33 #include <config.h>
  34
  35 #include <stdlib.h>
  36 #include <stdio.h>
  37 #include <inttypes.h>
  38 #include <string.h>
  39 #include <ctype.h>
  40
  41 #include "lib/global.h"
  42 #include "src/editor/etags.h"
  43
  44 /*** file scope functions **********************************************/
  45
  46 static gboolean parse_define(char *buf, char **long_name, char **short_name, long *line)
  47 {
  48     enum {in_longname, in_shortname, in_shortname_first_char, in_line, finish} def_state = in_longname;
  49
  50     static char longdef[LONG_DEF_LEN];
  51     static char shortdef[SHORT_DEF_LEN];
  52     static char linedef[LINE_DEF_LEN];
  53     int nlong = 0;
  54     int nshort = 0;
  55     int nline = 0;
  56     char c = *buf;
  57
  58     while ( !(c =='\0' || c =='\n') ) {
  59         switch ( def_state ) {
  60         case in_longname:
  61             if ( c == 0x01 ) {
  62                 def_state = in_line;
  63             } else if ( c == 0x7F ) {
  64                 def_state = in_shortname;
  65             } else {
  66                 if ( nlong < LONG_DEF_LEN - 1 ) {
  67                     longdef[nlong++] = c;
  68                 }
  69             }
  70             break;
  71         case in_shortname_first_char:
  72             if ( isdigit(c) ) {
  73                 nshort = 0;
  74                 buf--;
  75                 def_state = in_line;
  76             } else if ( c == 0x01 ) {
  77                 def_state = in_line;
  78             } else {
  79                 if ( nshort < SHORT_DEF_LEN - 1 ) {
  80                     shortdef[nshort++] = c;
  81                     def_state = in_shortname;
  82                 }
  83             }
  84             break;
  85         case in_shortname:
  86             if ( c == 0x01 ) {
  87                 def_state = in_line;
  88             } else if ( c == '\n' ) {
  89                 def_state = finish;
  90             } else {
  91                 if ( nshort < SHORT_DEF_LEN - 1 ) {
  92                     shortdef[nshort++] = c;
  93                 }
  94             }
  95             break;
  96         case in_line:
  97             if ( c == ',' || c == '\n') {
  98                 def_state = finish;
  99             } else if ( isdigit(c) ) {
 100                 if ( nline < LINE_DEF_LEN - 1 ) {
 101                     linedef[nline++] = c;
 102                 }
 103             }
 104             break;
 105         case finish:
 106             longdef[nlong] = '\0';
 107             shortdef[nshort] = '\0';
 108             linedef[nline] = '\0';
 109             *long_name = g_strdup (longdef);
 110             *short_name = g_strdup (shortdef);
 111             *line = atol (linedef);
 112             return TRUE;
 113             break;
 114         }
 115         buf++;
 116         c = *buf;
 117     }
 118     *long_name = NULL;
 119     *short_name = NULL;
 120     *line = 0;
 121     return FALSE;
 122 }
 123
 124 /*** public functions **************************************************/
 125
 126 int etags_set_definition_hash(const char *tagfile, const char *start_path,
 127                               const char *match_func,
 128                               etags_hash_t *def_hash)
 129 {
 130     enum {start, in_filename, in_define} state = start;
 131
 132     FILE *f;
 133     static char buf[BUF_LARGE];
 134
 135     char *longname = NULL;
 136     char *shortname = NULL;
 137     long line;
 138
 139     char *chekedstr = NULL;
 140
 141     int num = 0; /* returned value */
 142     int pos;
 143     char *filename = NULL;
 144
 145     if ( !match_func || !tagfile )
 146         return 0;
 147
 148     /* open file with positions */
 149     f = fopen (tagfile, "r");
 150     if (f == NULL)
 151         return 0;
 152
 153     while (fgets (buf, sizeof (buf), f)) {
 154
 155         switch ( state ) {
 156         case start:
 157             if ( buf[0] == 0x0C ) {
 158                 state = in_filename;
 159             }
 160             break;
 161         case in_filename:
 162             pos = strcspn(buf, ",");
 163             g_free(filename);
 164             filename = g_malloc (pos + 2);
 165             g_strlcpy(filename, (char *)buf, pos + 1);
 166             state = in_define;
 167             break;
 168         case in_define:
 169             if ( buf[0] == 0x0C ) {
 170                 state = in_filename;
 171                 break;
 172             }
 173             /* check if the filename matches the define pos */
 174             chekedstr = strstr (buf, match_func);
 175             if ( chekedstr ) {
 176                 parse_define (chekedstr, &longname, &shortname, &line);
 177                 if ( num < MAX_DEFINITIONS - 1 ) {
 178                     def_hash[num].filename_len = strlen (filename);
 179                     def_hash[num].fullpath =  g_build_filename ( start_path, filename, (char *) NULL);
 180
 181                     canonicalize_pathname (def_hash[num].fullpath);
 182                     def_hash[num].filename = g_strdup (filename);
 183                     if ( shortname ) {
 184                         def_hash[num].short_define = g_strdup (shortname);
 185                     } else {
 186                         def_hash[num].short_define = g_strdup (longname);
 187                     }
 188                     def_hash[num].line = line;
 189                     g_free(shortname);
 190                     g_free(longname);
 191                     num++;
 192                 }
 193             }
 194             break;
 195         }
 196     }
 197
 198     g_free(filename);
 199     fclose (f);
 200     return num;
 201 }