xref: /Universal-ctags/main/ptag.c (revision cea85fadf7cf99e1279d706fe757df84f4730426)

/*
 *
 *  Copyright (c) 1996-2002, Darren Hiebert
 *  Copyright (c) 2016, Red Hat, Inc.
 *  Copyright (c) 2016, Masatake YAMATO
 *
 *  Author: Masatake YAMATO <yamato@redhat.com>
 *
 *   This source code is released for free distribution under the terms of the
 *   GNU General Public License version 2 or (at your option) any later version.
 *
 */

#include "general.h"  /* must always come first */

#include "colprint_p.h"
#include "ctags.h"
#include "debug.h"
#include "entry_p.h"
#include "options_p.h"
#include "parse_p.h"
#include "ptag_p.h"
#include "routines_p.h"
#include "writer_p.h"
#include <string.h>


static bool ptagMakeFormat (ptagDesc *desc, langType language CTAGS_ATTR_UNUSED,
							const void *data CTAGS_ATTR_UNUSED)
{
	char format [11];
	const char *formatComment = "unknown format";
	const optionValues *opt = data;

	sprintf (format, "%u", opt->tagFileFormat);
	if (opt->tagFileFormat == 1)
		formatComment = "original ctags format";
	else if (opt->tagFileFormat == 2)
		formatComment =
			"extended format; --format=1 will not append ;\" to lines";
	return writePseudoTag (desc, format, formatComment, NULL);
}

static bool ptagMakeHowSorted (ptagDesc *desc, langType language CTAGS_ATTR_UNUSED,
							   const void *data CTAGS_ATTR_UNUSED)
{
	const optionValues *opt = data;
	return writePseudoTag (desc,
			       opt->sorted == SO_FOLDSORTED ? "2" :
			       (opt->sorted == SO_SORTED ? "1" : "0"),
			       "0=unsorted, 1=sorted, 2=foldcase",
			       NULL);
}

static bool ptagMakeAuthor (ptagDesc *desc, langType language CTAGS_ATTR_UNUSED,
							const void *data CTAGS_ATTR_UNUSED)
{
	return writePseudoTag (desc,
						   AUTHOR_NAME,  "", NULL);
}

static bool ptagMakeProgName (ptagDesc *desc, langType language CTAGS_ATTR_UNUSED,
							  const void *data CTAGS_ATTR_UNUSED)
{
	return writePseudoTag (desc,
						   PROGRAM_NAME,  "Derived from Exuberant Ctags", NULL);
}

static bool ptagMakeProgURL (ptagDesc *desc, langType language CTAGS_ATTR_UNUSED,
							 const void *data CTAGS_ATTR_UNUSED)
{
	return writePseudoTag (desc,
						   PROGRAM_URL, "official site", NULL);
}

static bool ptagMakeProgVersion (ptagDesc *desc, langType language CTAGS_ATTR_UNUSED,
								 const void *data CTAGS_ATTR_UNUSED)
{
	const char* repoinfo = ctags_repoinfo? ctags_repoinfo: "";
	return writePseudoTag (desc, PROGRAM_VERSION, repoinfo, NULL);
}

#ifdef HAVE_ICONV
static bool ptagMakeFileEncoding (ptagDesc *desc, langType language CTAGS_ATTR_UNUSED,
								  const void *data)
{
	const optionValues *opt = data;
	if (! opt->outputEncoding)
		return false;

	return writePseudoTag (desc, opt->outputEncoding, "", NULL);
}
#endif

static bool ptagMakeKindSeparators (ptagDesc *desc, langType language,
									const void *data CTAGS_ATTR_UNUSED)
{
	return makeKindSeparatorsPseudoTags (language, desc);
}

static bool ptagMakeKindDescriptions (ptagDesc *desc, langType language,
									  const void *data CTAGS_ATTR_UNUSED)
{
	return makeKindDescriptionsPseudoTags (language, desc);
}

static bool ptagMakeFieldDescriptions (ptagDesc *desc, langType language,
									   const void *data CTAGS_ATTR_UNUSED)
{
	return makeFieldDescriptionsPseudoTags (language, desc);
}

static bool ptagMakeExtraDescriptions (ptagDesc *desc, langType language,
									   const void *data CTAGS_ATTR_UNUSED)
{
	return makeExtraDescriptionsPseudoTags (language, desc);
}

static bool ptagMakeRoleDescriptions (ptagDesc *desc, langType language,
									  const void *data CTAGS_ATTR_UNUSED)
{
	return makeRoleDescriptionsPseudoTags (language, desc);
}

static bool ptagMakeProcCwd (ptagDesc *desc, langType language,
									   const void *data CTAGS_ATTR_UNUSED)
{
	return writePseudoTag (desc, CurrentDirectory, "", NULL);
}

static ptagDesc ptagDescs [] = {
	{
	  /* The prefix is not "TAG_".
	     Only --output-format=json use this ptag. */
	  false, "JSON_OUTPUT_VERSION",
	  "the version of json output stream format",
	  ptagMakeJsonOutputVersion,
	  PTAGF_COMMON },
	{ true, "TAG_FILE_FORMAT",
	  "the version of tags file format",
	  ptagMakeFormat,
	  PTAGF_COMMON },
	{ true, "TAG_FILE_SORTED",
	  "how tags are sorted",
	  ptagMakeHowSorted,
	  PTAGF_COMMON },
	{ true, "TAG_PROGRAM_AUTHOR",
	  "the author of this ctags implementation",
	  ptagMakeAuthor,
	  PTAGF_COMMON },
	{ true, "TAG_PROGRAM_NAME",
	  "the name of this ctags implementation",
	  ptagMakeProgName,
	  PTAGF_COMMON },
	{ true, "TAG_PROGRAM_URL",
	  "the official site URL of this ctags implementation",
	  ptagMakeProgURL,
	  PTAGF_COMMON },
	{ true, "TAG_PROGRAM_VERSION",
	  "the version of this ctags implementation",
	  ptagMakeProgVersion,
	  PTAGF_COMMON },
#ifdef HAVE_ICONV
	{ true, "TAG_FILE_ENCODING",
	  "the encoding used in output tags file",
	  ptagMakeFileEncoding,
	  PTAGF_COMMON },
#endif
	{ false, "TAG_KIND_SEPARATOR",
	  "the separators used in kinds",
	  ptagMakeKindSeparators,
	  PTAGF_PARSER },
	{ false, "TAG_KIND_DESCRIPTION",
	  "the letters, names and descriptions of enabled kinds in the language",
	  ptagMakeKindDescriptions,
	  PTAGF_PARSER },
	{ false, "TAG_FIELD_DESCRIPTION",
	  "the names and descriptions of enabled fields",
	  ptagMakeFieldDescriptions,
	  PTAGF_COMMON|PTAGF_PARSER },
	{ false, "TAG_EXTRA_DESCRIPTION",
	  "the names and descriptions of enabled extras",
	  ptagMakeExtraDescriptions,
	  PTAGF_COMMON|PTAGF_PARSER },
	{ false, "TAG_ROLE_DESCRIPTION",
	  "the names and descriptions of enabled roles",
	  ptagMakeRoleDescriptions,
	  PTAGF_PARSER },
	{ true, "TAG_OUTPUT_MODE",
	  "the output mode: u-ctags or e-ctags",
	  ptagMakeCtagsOutputMode,
	  PTAGF_COMMON },
	{ true, "TAG_OUTPUT_FILESEP",
	  "the separator used in file name (slash or backslash)",
	  ptagMakeCtagsOutputFilesep,
	  PTAGF_COMMON },
	{ true, "TAG_PATTERN_LENGTH_LIMIT",
	  "the limit of pattern length",
	  ptagMakePatternLengthLimit,
	  PTAGF_COMMON },
	{ true, "TAG_PROC_CWD",
	  "the current working directory of the tags generator",
	  ptagMakeProcCwd,
	  PTAGF_COMMON },
	{ true, "TAG_OUTPUT_EXCMD",
	  "the excmd: number, pattern, mixed, or combine",
	  ptagMakeCtagsOutputExcmd,
	  PTAGF_COMMON },
};

extern bool makePtagIfEnabled (ptagType type, langType language, const void *data)
{
	ptagDesc *desc;

	Assert (0 <= type && type < PTAG_COUNT);

	desc = ptagDescs + type;
	if (desc->enabled)
		return desc->makeTag (desc, language, data);
	else
		return false;
}

extern bool isPtagEnabled (ptagType type)
{
	ptagDesc *desc;

	Assert (0 <= type && type < PTAG_COUNT);

	desc = ptagDescs + type;
	return desc->enabled;

}

extern bool enablePtag (ptagType type, bool state)
{
	bool oldstate;
	ptagDesc *desc;

	Assert (0 <= type && type < PTAG_COUNT);

	desc = ptagDescs + type;
	oldstate = desc->enabled;
	desc->enabled = state;
	return oldstate;
}

extern ptagDesc* getPtagDesc (ptagType type)
{
	if (type == PTAG_UNKNOWN
	    || type >= PTAG_COUNT)
		return NULL;

	return ptagDescs + type;
}

extern ptagType getPtagTypeForName (const char *name)
{
	int i;

	Assert (name);
	for (i = 0; i < PTAG_COUNT; i++)
		if (strcmp (ptagDescs [i].name, name) == 0)
			return i;
	return PTAG_UNKNOWN;
}

extern bool isPtagCommonInParsers  (ptagType type)
{
	ptagDesc* pdesc = getPtagDesc (type);
	return pdesc->flags & PTAGF_COMMON;
}

extern bool isPtagParserSpecific (ptagType type)
{
	ptagDesc* pdesc = getPtagDesc (type);
	return pdesc->flags & PTAGF_PARSER;
}

static int ptagCompare (struct colprintLine *a, struct colprintLine *b)
{
	const char *a_name = colprintLineGetColumn (a, 0);
	const char *b_name = colprintLineGetColumn (b, 0);
	return strcmp(a_name, b_name);
}

extern void printPtags (bool withListHeader, bool machinable, FILE *fp)
{
	struct colprintTable *table = colprintTableNew ("L:NAME",
													"L:ENABLED",
													"L:DESCRIPTION",
													NULL);
	for (unsigned int i = 0; i < PTAG_COUNT; i++)
	{
		struct colprintLine *line = colprintTableGetNewLine (table);
		colprintLineAppendColumnCString (line, ptagDescs[i].name);
		colprintLineAppendColumnCString (line, ptagDescs[i].enabled
										 ? "on"
										 : "off");
		colprintLineAppendColumnCString (line, ptagDescs[i].description);
	}

	colprintTableSort (table, ptagCompare);
	colprintTablePrint (table, 0, withListHeader, machinable, fp);
	colprintTableDelete (table);
}