ctags/parsers/markdown.c

   1 /*
   2 *
   3 *   Copyright (c) 2009, Jon Strait
   4 *
   5 *   This source code is released for free distribution under the terms of the
   6 *   GNU General Public License.
   7 *
   8 *   This module contains functions for generating tags for Markdown files.
   9 */
  10
  11 /*
  12 *   INCLUDE FILES
  13 */
  14 #include "general.h"    /* must always come first */
  15
  16 #include <ctype.h>
  17 #include <string.h>
  18
  19 #include "parse.h"
  20 #include "read.h"
  21 #include "vstring.h"
  22 #include "routines.h"
  23
  24 /*
  25 *   DATA DEFINITIONS
  26 */
  27
  28 static kindOption MarkdownKinds[] = {
  29         { true, 'v', "variable", "sections" }
  30 };
  31
  32 /*
  33 *   FUNCTION DEFINITIONS
  34 */
  35
  36 /* checks if str is all the same character */
  37 static bool issame(const char *str)
  38 {
  39         char first = *str;
  40
  41         while (*(++str))
  42         {
  43                 if (*str && *str != first)
  44                         return false;
  45         }
  46         return true;
  47 }
  48
  49 static void makeMarkdownTag (const vString* const name, bool name_before)
  50 {
  51         tagEntryInfo e;
  52         initTagEntry (&e, vStringValue(name), &(MarkdownKinds [0]));
  53
  54         if (name_before)
  55                 e.lineNumber--; /* we want the line before the underline chars */
  56
  57         makeTagEntry(&e);
  58 }
  59
  60
  61 static void findMarkdownTags (void)
  62 {
  63         vString *name = vStringNew();
  64         const unsigned char *line;
  65
  66         while ((line = readLineFromInputFile()) != NULL)
  67         {
  68                 int name_len = vStringLength(name);
  69
  70                 /* underlines must be the same length or more */
  71                 if (name_len > 0 &&     (line[0] == '=' || line[0] == '-') && issame((const char*) line))
  72                 {
  73                         makeMarkdownTag(name, true);
  74                 }
  75                 else if (line[0] == '#') {
  76                         vStringClear(name);
  77                         vStringCatS(name, (const char *) line);
  78                         makeMarkdownTag(name, false);
  79                 }
  80                 else {
  81                         vStringClear (name);
  82                         if (! isspace(*line))
  83                                 vStringCatS(name, (const char*) line);
  84                 }
  85         }
  86         vStringDelete (name);
  87 }
  88
  89 extern parserDefinition* MarkdownParser (void)
  90 {
  91         static const char *const patterns [] = { "*.md", NULL };
  92         static const char *const extensions [] = { "md", NULL };
  93         parserDefinition* const def = parserNew ("Markdown");
  94
  95         def->kinds = MarkdownKinds;
  96         def->kindCount = ARRAY_SIZE (MarkdownKinds);
  97         def->patterns = patterns;
  98         def->extensions = extensions;
  99         def->parser = findMarkdownTags;
 100         return def;
 101 }
 102