ctags.rb 1.0.0 → 1.0.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjY3ODkyNTBlOWM4ZjMwOTY5ZmQyMmViNTY0NDYyZWJhNDQxYTI1OQ==
+  data.tar.gz: !binary |-
+    YTk4OGZiZWU2NzY5MDdjOWQ5YWY4YzljM2M4MTc5ZmIwNzBlOTAzNA==
+SHA512:
+  metadata.gz: !binary |-
+    YzliMGVjZjIyNmY4YzBhZDVmY2I4ZDIzMmRmMmM5YTdlZjlkNDM2NzNmMGYx
+    Nzk3MTFlYWM5MmVkYTI3MmZlYmUzOTZlNzQ4ZjYxYzgzY2FiMDYwYTllYzI0
+    MjZmOTg3ZTZiZjFmNWY5ODI3M2U1MDU1YTAwNjRlZjA0OGM5Njk=
+  data.tar.gz: !binary |-
+    NmU4ZjBjZTUzODhiZGM0MDM0MjU5ZTQ2ODBjYTM4YmIxNWVlNjhjM2Q4OTg2
+    Y2E1N2I5MGJlY2QzZDM4MzkwMmVhZDUxNGI2Y2M0MGFhZjE0OWM5OThjNzZh
+    OWJmMzE3ZGM0MzM5ZTNkNjdiMWM3YzlhNDlmMzc4MmQzNGQ5YTI=

data/Gemfile

@@ -1,2 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
+gem 'rake'

data/README.md

@@ -0,0 +1,49 @@
+## ctags.rb
+
+simple ruby wrapper for exuberant-ctags
+
+### usage
+
+``` ruby
+>> pp Ctags.tags_for_file('/usr/lib/ruby/1.8/timeout.rb')
+[
+ {:path=>
+   "/usr/lib/ruby/1.8/timeout.rb",
+  :kind=>"module",
+  :language=>"Ruby",
+  :pattern=>"module Timeout",
+  :name=>"Timeout",
+  :line=>30},
+ {:path=>
+   "/usr/lib/ruby/1.8/timeout.rb",
+  :kind=>"class",
+  :class=>"Timeout",
+  :language=>"Ruby",
+  :pattern=>"class Error < Interrupt",
+  :name=>"Error",
+  :line=>35},
+ {:path=>
+   "/usr/lib/ruby/1.8/timeout.rb",
+  :kind=>"class",
+  :class=>"Timeout",
+  :language=>"Ruby",
+  :pattern=>"class ExitException < ::Exception # :nodoc:",
+  :name=>"ExitException",
+  :line=>37},
+ {:path=>
+   "/usr/lib/ruby/1.8/timeout.rb",
+  :kind=>"method",
+  :class=>"Timeout",
+  :language=>"Ruby",
+  :pattern=>"def timeout(sec, klass = nil)",
+  :name=>"timeout",
+  :line=>52},
+ {:path=>
+   "/usr/lib/ruby/1.8/timeout.rb",
+  :kind=>"method",
+  :language=>"Ruby",
+  :pattern=>"def timeout(n, e = nil, &block) # :nodoc:",
+  :name=>"timeout",
+  :line=>100}
+]
+```

data/Rakefile

@@ -12,6 +12,16 @@ require 'rubygems/package_task'
 Gem::PackageTask.new(GEMSPEC) do |pkg|
 end
 
+# ==========================================================
+# Compiling
+# ==========================================================
+
+task :build do
+  Dir.chdir('ext') do
+    ruby 'extconf.rb'
+  end
+end
+
 # ==========================================================
 # Testing
 # ==========================================================
@@ -21,3 +31,12 @@ Rake::TestTask.new 'test' do |t|
   t.test_files = FileList['test/test_*.rb']
   t.ruby_opts = ['-rubygems']
 end
+task :test => :build
+
+# ==========================================================
+# Benchmarks
+# ==========================================================
+
+task :bench => :build do
+  ruby 'bench.rb'
+end

data/bench.rb

@@ -0,0 +1,28 @@
+require 'benchmark'
+require 'rubygems'
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'ctags'
+
+Benchmark.bmbm(30) do |b|
+  [
+    ['small', __FILE__],
+    ['medium', Gem.find_files('mkmf.rb')[0]],
+    ['big', Gem.find_files('tk.rb')[0]]
+  ].each do |type, file|
+    b.report("tags for #{type} file") do
+      Ctags.tags_for_file(file)
+    end
+
+    b.report("tags for #{type} file x500") do
+      500.times{ Ctags.tags_for_file(file) }
+    end
+
+    b.report("tags for #{type} blob") do
+      Ctags.tags_for_file(file, File.read(file))
+    end
+
+    b.report("tags for #{type} blob x500") do
+      500.times{ Ctags.tags_for_file(file, File.read(file)) }
+    end
+  end
+end

data/ctags.rb.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.email = ['aman@tmm1.net']
 
   s.add_dependency 'posix-spawn', '~> 0.3.6'
-  s.add_development_dependency 'rake-compiler', '~> 0.7.6'
+  s.add_dependency 'yajl-ruby'
 
   s.extensions = ['ext/extconf.rb']
   s.require_paths = ['lib']

data/ext/.gitignore

@@ -1,3 +1,3 @@
 /Makefile
 /dst
-
+/mkmf.log

data/ext/extconf.rb

@@ -1,13 +1,37 @@
 require 'mkmf'
 require 'fileutils'
 
-HERE = File.expand_path('../', __FILE__)
-FileUtils.mkdir_p "#{HERE}/dst"
+def sys(cmd)
+  puts "  -- #{cmd}"
+  unless ret = xsystem(cmd)
+    puts " ==> tail -10 #{CWD}/mkmf.log"
+    puts File.readlines("#{CWD}/mkmf.log").last(10).join("")
+    raise "#{cmd} failed"
+  end
+  ret
+end
+
+CWD = File.expand_path('../', __FILE__)
+FileUtils.mkdir_p "#{CWD}/dst"
+xsystem('pwd') # to create mkmf.log before the chdir
+
+Dir.chdir("#{CWD}/vendor/jansson-2.5") do
+  sys "./configure --prefix=#{CWD}/dst --disable-shared" unless File.exists?('config.h')
+  sys "make install"
+end
+
+ENV['CFLAGS']  = "-ggdb -I#{CWD}/dst/include"
+ENV['LDFLAGS'] = "-L#{CWD}/dst/lib"
+ENV['LIBS']    = "-ljansson"
+
+if !have_func('fmemopen','stdio.h') && have_func('funopen','stdio.h')
+  ENV['CFLAGS'] += " -DHAVE_FMEMOPEN_C"
+  FileUtils.cp "#{CWD}/vendor/fmemopen/fmemopen.c", "#{CWD}/dst/include"
+end
 
-Dir.chdir("#{HERE}/vendor/exuberant-ctags") do
-  system "./configure --prefix=#{HERE}/dst"
-  system "make"
-  system "make install"
+Dir.chdir("#{CWD}/vendor/exuberant-ctags") do
+  sys "./configure --prefix=#{CWD}/dst" unless File.exists?('config.h')
+  sys "make install"
 end
 
 File.open('Makefile', 'w') do |f|

data/ext/vendor/exuberant-ctags/entry.c

@@ -38,6 +38,8 @@
 # include <io.h>
 #endif
 
+#include <jansson.h>
+
 #include "debug.h"
 #include "ctags.h"
 #include "entry.h"
@@ -806,6 +808,69 @@ static int writeCtagsEntry (const tagEntryInfo *const tag)
 	return length;
 }
 
+static int writeJsonEntry (const tagEntryInfo *const tag)
+{
+	char *const line = readSourceLine (TagFile.vLine, tag->filePosition, 0);
+	json_t *response = json_pack ("{ss ss si ss ss ss ss}",
+		"_type", "tag",
+		"name", tag->name,
+		"line", tag->lineNumber,
+		"path", tag->sourceFileName,
+		"kind", tag->kindName,
+		"language", tag->language,
+		"pattern", line
+	);
+
+	if (Option.extensionFields.scope  &&
+			tag->extensionFields.scope [0] != NULL  &&
+			tag->extensionFields.scope [1] != NULL)
+		json_object_set_new (response,
+				tag->extensionFields.scope [0],
+				json_string (tag->extensionFields.scope [1]));
+
+	if (Option.extensionFields.typeRef  &&
+			tag->extensionFields.typeRef [0] != NULL  &&
+			tag->extensionFields.typeRef [1] != NULL) {
+		char *val;
+		asprintf(&val, "%s:%s",
+				tag->extensionFields.typeRef [0],
+				tag->extensionFields.typeRef [1]);
+		json_object_set_new (response,
+				"typeref",
+				json_string (val));
+		free (val);
+	}
+
+	if (Option.extensionFields.fileScope  &&  tag->isFileScope)
+		json_object_set_new (response, "scope",
+				json_string ("file"));
+
+	if (Option.extensionFields.inheritance  &&
+			tag->extensionFields.inheritance != NULL)
+		json_object_set_new (response, "inherits",
+				json_string (tag->extensionFields.inheritance));
+
+	if (Option.extensionFields.access  &&  tag->extensionFields.access != NULL)
+		json_object_set_new (response, "access",
+				json_string (tag->extensionFields.access));
+
+	if (Option.extensionFields.implementation  &&
+			tag->extensionFields.implementation != NULL)
+		json_object_set_new (response, "implementation",
+				json_string (tag->extensionFields.implementation));
+
+	if (Option.extensionFields.signature  &&
+			tag->extensionFields.signature != NULL)
+		json_object_set_new (response, "signature",
+				json_string (tag->extensionFields.signature));
+
+	json_dumpf (response, stdout, 0);
+	fprintf (stdout, "\n");
+	fflush (stdout);
+
+	json_decref (response);
+}
+
 extern void makeTagEntry (const tagEntryInfo *const tag)
 {
 	Assert (tag->name != NULL);
@@ -816,7 +881,11 @@ extern void makeTagEntry (const tagEntryInfo *const tag)
 		int length = 0;
 
 		DebugStatement ( debugEntry (tag); )
-		if (Option.xref)
+		if (Option.json)
+		{
+			writeJsonEntry (tag);
+		}
+		else if (Option.xref)
 		{
 			if (! tag->isFileEntry)
 				length = writeXrefEntry (tag);

data/ext/vendor/exuberant-ctags/main.c

@@ -22,7 +22,9 @@
 *   INCLUDE FILES
 */
 #include "general.h"  /* must always come first */
+#include "ctags.h"
 
+#include <jansson.h>
 #include <string.h>
 
 /*  To provide timings features if available.
@@ -293,7 +295,7 @@ static boolean createTagsForEntry (const char *const entryName)
 		verbose ("excluding \"%s\"\n", entryName);
 	else if (status->isSymbolicLink  &&  ! Option.followLinks)
 		verbose ("ignoring \"%s\" (symbolic link)\n", entryName);
-	else if (! status->exists && ! Option.stdinFileName)
+	else if (! status->exists)
 		error (WARNING | PERROR, "cannot open source file \"%s\"", entryName);
 	else if (status->isDirectory)
 		resize = recurseIntoDirectory (entryName);
@@ -466,6 +468,65 @@ static boolean etagsInclude (void)
 	return (boolean)(Option.etags && Option.etagsInclude != NULL);
 }
 
+static void interactiveJsonMode ()
+{
+	char buffer[1024];
+	json_t *request;
+
+	openTagFile ();
+	fprintf (stdout, "{\"name\": \"" PROGRAM_NAME "\", \"version\": \"" PROGRAM_VERSION "\"}\n");
+	fflush (stdout);
+
+	while (fgets (buffer, sizeof(buffer), stdin)) {
+		if (buffer[0] == '\n')
+			continue;
+
+		request = json_loads (buffer, JSON_DISABLE_EOF_CHECK, NULL);
+		if (! request) {
+			error (FATAL, "invalid json");
+			goto next;
+		}
+
+		json_t *command = json_object_get (request, "command");
+		if (! command) {
+			error (FATAL, "command name not found");
+			goto next;
+		}
+
+		if (!strcmp ("list-parsers", json_string_value (command))) {
+		} else if (!strcmp ("generate-tags", json_string_value (command))) {
+			json_int_t size = -1;
+			const char *filename;
+
+			if (json_unpack (request, "{s?I ss}", "size", &size, "filename", &filename) == -1) {
+				error (FATAL, "invalid generate-tags request");
+				goto next;
+			}
+
+			if (size == -1) { /* read from disk */
+				createTagsForEntry (filename);
+			} else {			/* read nbytes from stream */
+				size_t nbytes = (size_t)size;
+				File.buffer = malloc (nbytes+1);
+				File.buffer [nbytes] = 0;
+				File.buffer_size = fread (File.buffer, 1, nbytes, stdin);
+				parseFile (filename);
+				free (File.buffer);
+				File.buffer = NULL;
+			}
+
+			fprintf (stdout, "{\"completed\": \"generate-tags\"}\n");
+			fflush (stdout);
+		} else {
+			error (FATAL, "unknown command name");
+			goto next;
+		}
+
+next:
+		json_decref (request);
+	}
+}
+
 static void makeTags (cookedArgs *args)
 {
 	clock_t timeStamps [3];
@@ -478,7 +539,7 @@ static void makeTags (cookedArgs *args)
 		if (filesRequired ())
 			error (FATAL, "No files specified. Try \"%s --help\".",
 				getExecutableName ());
-		else if (! Option.recurse && ! Option.stdinFileName && ! etagsInclude ())
+		else if (! Option.recurse && ! etagsInclude ())
 			return;
 	}
 
@@ -506,10 +567,6 @@ static void makeTags (cookedArgs *args)
 	if (! files  &&  Option.recurse)
 		resize = recurseIntoDirectory (".");
 	
-	if (Option.stdinFileName)
-	{
-	  resize = createTagsForEntry(Option.stdinFileName);
-	}
 
 	timeStamp (1);
 
@@ -564,7 +621,11 @@ extern int main (int __unused__ argc, char **argv)
 	verbose ("Reading initial options from command line\n");
 	parseOptions (args);
 	checkOptions ();
-	makeTags (args);
+	if (Option.json)
+		interactiveJsonMode ();
+	else
+		makeTags (args);
+
 
 	/*  Clean up.
 	 */

data/ext/vendor/exuberant-ctags/options.c

@@ -148,6 +148,7 @@ optionValues Option = {
 	FALSE,      /* --tag-relative */
 	FALSE,      /* --totals */
 	FALSE,      /* --line-directives */
+	FALSE,      /* --json */
 #ifdef DEBUG
 	0, 0        /* -D, -b */
 #endif
@@ -228,6 +229,8 @@ static optionDescription LongOptionDescription [] = {
  {1,"       Print this option summary."},
  {1,"  --if0=[yes|no]"},
  {1,"       Should C code within #if 0 conditional branches be parsed [no]?"},
+ {1,"  --json"},
+ {1,"       Enter interactive json command mode."},
  {1,"  --<LANG>-kinds=[+|-]kinds"},
  {1,"       Enable/disable tag kinds for language <LANG>."},
  {1,"  --langdef=name"},
@@ -396,7 +399,7 @@ extern void setDefaultTagFileName (void)
 extern boolean filesRequired (void)
 {
 	boolean result = FilesRequired;
-	if (Option.recurse || Option.stdinFileName)
+	if (Option.recurse || Option.json)
 		result = FALSE;
 	return result;
 }
@@ -960,14 +963,12 @@ static void processLanguageForceOption (
 		Option.language = language;
 }
 
-static void processStdinFileName (
-    const char *const option, const char *const parameter)
+static void processJsonOption (
+		const char *const option,
+		const char *const parameter __unused__)
 {
-  if (strlen(parameter) == 0) {
-    error (FATAL, "No filename specified for --stdin-filename");
-  }
-
-  Option.stdinFileName = stringCopy(parameter);
+	Option.json = TRUE;
+	Option.tagFileName = stringCopy ("-");
 }
 
 static char* skipPastMap (char* p)
@@ -1389,6 +1390,7 @@ static parametricOption ParametricOptions [] = {
 	{ "filter-terminator",      processFilterTerminatorOption,  TRUE    },
 	{ "format",                 processFormatOption,            TRUE    },
 	{ "help",                   processHelpOption,              TRUE    },
+	{ "json",                   processJsonOption,              TRUE    },
 	{ "lang",                   processLanguageForceOption,     FALSE   },
 	{ "language",               processLanguageForceOption,     FALSE   },
 	{ "language-force",         processLanguageForceOption,     FALSE   },
@@ -1401,8 +1403,7 @@ static parametricOption ParametricOptions [] = {
 	{ "list-languages",         processListLanguagesOption,     TRUE    },
 	{ "options",                processOptionFile,              FALSE   },
 	{ "sort",                   processSortOption,              TRUE    },
-	{ "version",                processVersionOption,           TRUE    },
-	{ "stdin-filename",         processStdinFileName,           FALSE   }
+	{ "version",                processVersionOption,           TRUE    }
 };
 
 static booleanOption BooleanOptions [] = {
@@ -1693,7 +1694,7 @@ extern void previewFirstOption (cookedArgs* const args)
 		else if (strcmp (args->item, "options") == 0  &&
 				strcmp (args->parameter, "NONE") == 0)
 		{
-			fprintf (stderr, "No options will be read from files or environment\n");
+			/* fprintf (stderr, "No options will be read from files or environment\n");*/
 			SkipConfiguration = TRUE;
 			cArgForth (args);
 		}
@@ -1830,7 +1831,6 @@ extern void freeOptionResources (void)
 	freeString (&Option.tagFileName);
 	freeString (&Option.fileList);
 	freeString (&Option.filterTerminator);
-	freeString (&Option.stdinFileName);
 
 	freeList (&Excluded);
 	freeList (&Option.ignore);