ctags/main/xtag.c

   1 /*
   2  *
   3  *  Copyright (c) 2015, Red Hat, Inc.
   4  *  Copyright (c) 2015, Masatake YAMATO
   5  *
   6  *  Author: Masatake YAMATO <yamato@redhat.com>
   7  *
   8  *   This source code is released for free distribution under the terms of the
   9  *   GNU General Public License version 2 or (at your option) any later version.
  10  *
  11  */
  12
  13 #include "general.h"  /* must always come first */
  14 #include "debug.h"
  15 #include "main.h"
  16 #include "options.h"
  17 #include "routines.h"
  18 #include "xtag.h"
  19
  20 #include <string.h>
  21
  22
  23 static bool isPseudoTagsEnabled (xtagDesc *pdesc CTAGS_ATTR_UNUSED)
  24 {
  25         return ! isDestinationStdout ();
  26 }
  27
  28 static xtagDesc xtagDescs [] = {
  29         { true, 'F',  "fileScope",
  30           "Include tags of file scope", NULL},
  31         { false, 'f', "inputFile",
  32           "Include an entry for the base file name of every input file", NULL},
  33         { false, 'p', "pseudo",
  34           "Include pseudo tags",
  35           isPseudoTagsEnabled},
  36         { false, 'q', "qualified",
  37           "Include an extra class-qualified tag entry for each tag", NULL},
  38         { false, 'r', "reference",
  39           "Include reference tags", NULL},
  40         { false, 's', "subparser",
  41           "Include tags generated by sub parsers", NULL},
  42 };
  43
  44 extern xtagDesc* getXtagDesc (xtagType type)
  45 {
  46         Assert ((0 <= type) && (type < XTAG_COUNT));
  47         return xtagDescs + type;
  48 }
  49
  50 typedef bool (* xtagPredicate) (xtagDesc *pdesc, const void *user_data);
  51 static xtagType  getXtagTypeGeneric (xtagPredicate predicate, const void *user_data)
  52 {
  53         int i;
  54
  55         for (i = 0; i < XTAG_COUNT; i++)
  56         {
  57                 if (predicate (xtagDescs + i, user_data))
  58                         return i;
  59         }
  60         return XTAG_UNKNOWN;
  61 }
  62
  63 static bool xtagEqualByLetter (xtagDesc *pdesc, const void *user_data)
  64 {
  65         return (pdesc->letter == *((char *)user_data))? true: false;
  66 }
  67
  68 extern xtagType  getXtagTypeForLetter (char letter)
  69 {
  70         return getXtagTypeGeneric (xtagEqualByLetter, &letter);
  71 }
  72
  73 static bool xtagEqualByName (xtagDesc *pdesc, const void *user_data)
  74 {
  75         return (strcmp (pdesc->name, user_data) == 0)? true: false;
  76 }
  77
  78 extern xtagType  getXtagTypeForName (const char *name)
  79 {
  80         return getXtagTypeGeneric (xtagEqualByName, name);
  81 }
  82
  83
  84 #define PR_XTAG_WIDTH_LETTER     7
  85 #define PR_XTAG_WIDTH_NAME      22
  86 #define PR_XTAG_WIDTH_ENABLED   7
  87 #define PR_XTAG_WIDTH_DESC      30
  88
  89 #define PR_XTAG_STR(X) PR_XTAG_WIDTH_##X
  90 #define PR_XTAG_FMT(X,T) "%-" STRINGIFY(PR_XTAG_STR(X)) STRINGIFY(T)
  91 #define MAKE_XTAG_FMT(LETTER_SPEC)              \
  92         PR_XTAG_FMT (LETTER,LETTER_SPEC)        \
  93         " "                                     \
  94         PR_XTAG_FMT (NAME,s)                    \
  95         " "                                     \
  96         PR_XTAG_FMT (ENABLED,s)                 \
  97         " "                                     \
  98         PR_XTAG_FMT (DESC,s)                    \
  99         "\n"
 100
 101 static void printXtag (xtagType i)
 102 {
 103         printf((Option.machinable? "%c\t%s\t%s\t%s\n": MAKE_XTAG_FMT(c)),
 104                xtagDescs[i].letter,
 105                xtagDescs[i].name,
 106                getXtagDesc (i)->enabled? "TRUE": "FALSE",
 107                xtagDescs[i].description? xtagDescs[i].description: "NONE");
 108 }
 109
 110 extern void printXtags (void)
 111 {
 112         unsigned int i;
 113
 114         if (Option.withListHeader)
 115                 printf ((Option.machinable? "%s\t%s\t%s\t%s\n": MAKE_XTAG_FMT(s)),
 116                         "#LETTER", "NAME", "ENABLED", "DESCRIPTION");
 117
 118         for (i = 0; i < XTAG_COUNT; i++)
 119                 printXtag (i);
 120 }
 121
 122 extern bool isXtagEnabled (xtagType type)
 123 {
 124         xtagDesc* desc = getXtagDesc (type);
 125
 126         Assert (desc);
 127
 128         if (desc->isEnabled)
 129                 return desc->isEnabled (desc);
 130         else
 131                 return desc->enabled;
 132 }
 133
 134 extern bool enableXtag (xtagType type, bool state)
 135 {
 136         bool old;
 137         xtagDesc* desc = getXtagDesc (type);
 138
 139         Assert (desc);
 140
 141         old = isXtagEnabled (type);
 142         desc->enabled = state;
 143         desc->isEnabled = NULL;;
 144
 145         return old;
 146 }
 147
 148 const char* getXtagName (xtagType type)
 149 {
 150         xtagDesc* desc = getXtagDesc (type);
 151         if (desc)
 152                 return desc->name;
 153         else
 154                 return NULL;
 155 }