ctags.rb 1.0.19 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db15ffcaf735bc781e1b082f3e3d041174718ebe
-  data.tar.gz: 14c272c9a2d121ef14132e15ea778ecba26ae281
+  metadata.gz: cfbac3daba802b08417f169179cad4065c970508
+  data.tar.gz: 2d857ac04dbdf3d888cf5d15ec5603d3209d2f64
 SHA512:
-  metadata.gz: 9c2de3b45e2411ca059efebb7202294c116af0a909c1cb31d99f038680e06a3e5170a13167f64f61003268070649d6a2a0f2b5fd0cefc9e41c456e19b772c1de
-  data.tar.gz: b4e18ae5ee388bdae60d37897834010485d217dda239c71f11c40fac99acf66ce14ae0fd37d4a0203b7e4471a387bafd94538ccfc8009ee27408fc408a912fd2
+  metadata.gz: c59dc1ea1a051d3fad425ed522570db502d3d5494601d709fffab79f4915f47a2e0d496358734e0fc2aac5738f59c4a5e5c96333f964d8c411b6277b286836dc
+  data.tar.gz: 8d0a10102b4f6436443cca2f61797d1952423c956c18f724834155cb808f7f4e6966a379583ed99678d28c02275e46fa2cedc2b8ca7ee5082d723c1e3ce44295

data/Gemfile

@@ -3,3 +3,4 @@ gemspec
 
 gem 'rake'
 gem 'ripper', :platforms => :mri_18
+gem 'minitest'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ctags.rb (1.0.16)
+    ctags.rb (1.1.3)
       posix-spawn (~> 0.3.6)
       ripper-tags (~> 0.1.3)
       yajl-ruby
@@ -9,17 +9,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    posix-spawn (0.3.8)
+    minitest (5.9.0)
+    posix-spawn (0.3.11)
     rake (10.1.1)
     ripper (1.0.5)
     ripper-tags (0.1.3)
       yajl-ruby
-    yajl-ruby (1.2.0)
+    yajl-ruby (1.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   ctags.rb!
+  minitest
   rake
   ripper
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -1,49 +1,30 @@
 ## ctags.rb
 
-simple ruby wrapper for exuberant-ctags
+simple ruby wrapper for [universal-ctags](https://github.com/universal-ctags/ctags) and [ripper-tags](https://github.com/tmm1/ripper-tags)
 
 ### 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}
+ {: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=>"method", :class=>"Timeout", :language=>"Ruby", :pattern=>"def timeout(sec, klass = nil)", :name=>"timeout", :line=>52},
 ]
 ```
+
+### architecture
+
+This ctags.rb gem includes the sources of my fork of [universal-ctags](https://github.com/tmm1/ctags). The source is compiled into a `ctags` binary when the gem is installed, and the binary is invoked as an external program by this gem to generate code tags.
+
+The changes in my fork include https://github.com/universal-ctags/ctags/pull/1071, which adds an interactive mode. In this mode, a single long-running instance of `ctags` can be used to generate tags for various inputs by sending it json commands over a pipe. Code can also be streamed into `ctags` over stdin, for cases where it is fetched over a network and not readily available on disk. This parent-child setup was chosen for several reasons:
+
+- the ctags codebase was written as a unix command line utility, which makes it very hard to link directly and use as a library (error handling generally causes an `exit(1)` and leaves global variables in a dirty state)
+- the language parsers in ctags could contain security vulnerabilities, so running them in a separate process provides for better sandboxing opportunities
+- on some platforms (like win32), process bootup cost is very expensive. using a single long-running ctags invocation eliminates this overhead.
+
+### license
+
+ctags.rb is licensed under the MIT license.
+
+universal-ctags is licensed under the GPLv2 license.

data/ext/extconf.rb

@@ -4,8 +4,8 @@ require 'fileutils'
 def sys(cmd)
   puts "  -- #{cmd}"
   unless ret = xsystem(cmd)
-    puts " ==> tail -10 #{CWD}/mkmf.log"
-    puts File.readlines("#{CWD}/mkmf.log").last(10).join("")
+    puts " ==> tail -15 #{CWD}/mkmf.log"
+    puts File.readlines("#{CWD}/mkmf.log").last(15).join("")
     raise "#{cmd} failed"
   end
   ret
@@ -15,7 +15,7 @@ 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
+Dir.chdir("#{CWD}/vendor/jansson-2.9") do
   sys "./configure --prefix=#{CWD}/dst --disable-shared" unless File.exists?('config.h')
   sys "touch *"
   sys "make install"
@@ -25,13 +25,9 @@ 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("#{CWD}/vendor/exuberant-ctags") do
+Dir.chdir("#{CWD}/vendor/ctags") do
   sys "./configure --prefix=#{CWD}/dst" unless File.exists?('config.h')
+  sys "touch configure aclocal.m4 Makefile.am Makefile.in"
   sys "make install"
 end
 

data/ext/vendor/ctags/.ctags

@@ -0,0 +1,4 @@
+# Exclude directories that don't contain real code
+--exclude=Units
+--exclude=tinst-root
+--exclude=Tmain

data/ext/vendor/ctags/.dir-locals.el

@@ -0,0 +1,2 @@
+;; Don't forget putting (add-hook 'hack-local-variables-hook (lambda () (editorconfig-apply))) to your .emacs.
+((c-mode . ((c-file-style . "linux"))))

data/ext/vendor/ctags/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{c,h,sh}]
+indent_size = 4
+indent_style = tab
+trim_trailing_whitespace = true

data/ext/vendor/ctags/.gdbinit

@@ -0,0 +1,3 @@
+define pst
+    call ps(st)
+end

data/ext/vendor/ctags/.gitignore

@@ -0,0 +1,69 @@
+*-actual.txt
+*-diff.txt
+*.func-sort-c.html
+*.func.html
+*.gcda
+*.gcno
+*.gcov
+*.gcov.html
+*.o
+*.obj
+*.od
+*.ssexwsp
+*.TMP
+*.tmp
+*~
+.deps
+.dirstamp
+a.out
+aclocal.m4
+autom4te.cache
+badinput
+commit-stamp
+compile
+config.cache
+config.guess
+config.h
+config.h.in
+config.log
+config.status
+config.sub
+configure
+core.*
+ctags
+ctags-universal*
+ctags.1
+ctags.exe
+ctags.ref
+ctags.ref.exe
+dctags
+dctags.exe
+depcomp
+install-sh
+Makefile
+Makefile.in
+missing
+mkinstalldirs
+perf.data*
+readtags
+readtags.exe
+repoinfo.h
+respmvc
+stamp-h1
+STDERR.*
+syntax.vim
+tags
+tags.ref
+tags.test
+test-cases.mak
+test.*.diff
+tg
+tinst-root
+win32/*.opensdf
+win32/*.sdf
+win32/*.suo
+win32/*.user
+win32/[Dd]ebug/
+win32/[Rr]elease/
+_build
+man/ctags.1.rst

data/ext/vendor/ctags/.travis.yml

@@ -0,0 +1,66 @@
+#
+# Derived from
+# https://github.com/steveno/ctags/blob/master/.travis.yml
+#
+
+language: c
+
+os:
+  - linux
+  - osx
+
+compiler:
+  - gcc
+  - clang
+
+env:
+  global:
+    # The next declaration is the encrypted COVERITY_SCAN_TOKEN, created
+    #   via the "travis encrypt" command using the project repo's public key
+    - secure: "FZunj1O8PR/2DEEN1tUAFzSxeo3jf2oOLkP7SmOSdeZ8W8QPo/5Nfhlhl0uambYOXOre/p/mCNXjudtsTwKHtq4uP6fejjPJl5cmHBCm/KtIoLnUaDyaSjoq6tKi2duJJhwY9H6X5ILtDxWveRbs5NhmKo9H+c1vHsBg0Wbuslg="
+
+  addons:
+    coverity_scan:
+      project:
+        name: "fishman/ctags"
+      description: "Build submitted via Travis CI"
+    notification_email: coverityctags@gmail.com
+    build_command_prepend: "./autogen.sh ; ./configure ; make clean"
+    build_command:   "make -j 4 CFLAGS=-O0"
+    branch_pattern: master
+
+sudo: false
+
+addons:
+  apt:
+    packages:
+      - lcov
+      - binutils-mingw-w64-i686
+      - gcc-mingw-w64-i686
+      - libjansson-dev
+      - libyaml-dev
+
+env:
+  - TARGET=Unix
+  - TARGET=Mingw32
+
+# Only with gcc get the mingw-w64 cross compilers
+before_install:
+  - if [ $CC = 'gcc' ] && [ $TRAVIS_OS_NAME = 'linux' ]; then gem install lcoveralls; fi
+# Build and run tests. Only with gcc cross compile
+script:
+  - ./misc/travis-check.sh
+after_success:
+  - if [ $CC = 'gcc' ] && [ $TRAVIS_OS_NAME = 'linux' ]; then lcov -c -b . -d . -o coverage.info && lcoveralls --root . --retry-count 5 coverage.info; fi
+
+# Build Matrix configuration
+# By default Travis CI runs all possible environment/target combinations.
+# This setting allows the exclusion of undesired combination.
+# For more information:
+# http://docs.travis-ci.com/user/customizing-the-build/#Build-Matrix
+matrix:
+  exclude:
+    - compiler: clang
+      env: TARGET=Mingw32
+    - os: osx
+      env: TARGET=Mingw32

data/ext/vendor/ctags/.uncrustify.cfg

@@ -0,0 +1,151 @@
+tok_split_gte=false
+utf8_byte=false
+utf8_force=false
+indent_cmt_with_tabs=false
+indent_align_string=false
+indent_braces=false
+indent_braces_no_func=false
+indent_braces_no_class=false
+indent_braces_no_struct=false
+indent_brace_parent=false
+indent_namespace=false
+indent_extern=false
+indent_class=false
+indent_class_colon=false
+indent_else_if=false
+indent_var_def_cont=false
+indent_func_call_param=false
+indent_func_def_param=false
+indent_func_proto_param=false
+indent_func_class_param=false
+indent_func_ctor_var_param=false
+indent_template_param=false
+indent_func_param_double=false
+indent_relative_single_line_comments=false
+indent_col1_comment=false
+indent_access_spec_body=false
+indent_paren_nl=false
+indent_comma_paren=false
+indent_bool_paren=false
+indent_first_bool_expr=false
+indent_square_nl=false
+indent_preserve_sql=false
+indent_align_assign=true
+sp_balance_nested_parens=false
+align_keep_tabs=false
+align_with_tabs=false
+align_on_tabstop=false
+align_number_left=false
+align_func_params=false
+align_same_func_call_params=false
+align_var_def_colon=false
+align_var_def_attribute=false
+align_var_def_inline=false
+align_right_cmt_mix=false
+align_on_operator=false
+align_mix_var_proto=false
+align_single_line_func=false
+align_single_line_brace=false
+align_nl_cont=false
+align_left_shift=true
+align_oc_decl_colon=false
+nl_collapse_empty_body=false
+nl_assign_leave_one_liners=false
+nl_class_leave_one_liners=false
+nl_enum_leave_one_liners=false
+nl_getset_leave_one_liners=false
+nl_func_leave_one_liners=false
+nl_if_leave_one_liners=false
+nl_multi_line_cond=false
+nl_multi_line_define=false
+nl_before_case=false
+nl_after_case=false
+nl_after_return=false
+nl_after_semicolon=false
+nl_after_brace_open=false
+nl_after_brace_open_cmt=false
+nl_after_vbrace_open=false
+nl_after_vbrace_open_empty=false
+nl_after_brace_close=false
+nl_after_vbrace_close=false
+nl_define_macro=false
+nl_squeeze_ifdef=false
+nl_ds_struct_enum_cmt=false
+nl_ds_struct_enum_close_brace=false
+nl_create_if_one_liner=false
+nl_create_for_one_liner=false
+nl_create_while_one_liner=false
+ls_for_split_full=false
+ls_func_split_full=false
+nl_after_multiline_comment=false
+eat_blanks_after_open_brace=false
+eat_blanks_before_close_brace=false
+mod_full_brace_if_chain=false
+mod_pawn_semicolon=false
+mod_full_paren_if_bool=false
+mod_remove_extra_semicolon=false
+mod_sort_import=false
+mod_sort_using=false
+mod_sort_include=false
+mod_move_case_break=false
+mod_remove_empty_return=false
+cmt_indent_multi=true
+cmt_c_group=false
+cmt_c_nl_start=false
+cmt_c_nl_end=false
+cmt_cpp_group=false
+cmt_cpp_nl_start=false
+cmt_cpp_nl_end=false
+cmt_cpp_to_c=false
+cmt_star_cont=false
+cmt_multi_check_last=true
+cmt_insert_before_preproc=false
+pp_indent_at_level=false
+pp_region_indent_code=false
+pp_if_indent_code=false
+pp_define_at_level=false
+input_tab_size=4
+output_tab_size=4
+indent_columns=4
+indent_brace=0
+indent_switch_case=4
+nl_after_func_body=2
+nl_after_func_body_one_liner=2
+indent_with_tabs=1
+sp_arith=add
+sp_assign=add
+sp_assign_default=add
+sp_enum_assign=add
+sp_bool=add
+sp_compare=add
+sp_inside_paren=remove
+sp_paren_paren=remove
+sp_before_ptr_star=force
+sp_between_ptr_star=remove
+sp_after_ptr_star=remove
+sp_after_ptr_star_func=remove
+sp_before_sparen=force
+sp_before_semi_for_empty=force
+sp_before_square=add
+sp_before_squares=add
+sp_after_cast=force
+sp_sizeof_paren=force
+sp_func_call_paren=force
+sp_return_paren=force
+sp_not=force
+nl_start_of_file=remove
+nl_end_of_file=remove
+nl_enum_brace=remove
+nl_struct_brace=remove
+nl_union_brace=remove
+nl_if_brace=add
+nl_brace_else=add
+nl_elseif_brace=add
+nl_else_brace=add
+nl_else_if=remove
+nl_for_brace=add
+nl_while_brace=add
+nl_do_brace=add
+nl_brace_while=remove
+nl_switch_brace=add
+nl_fdef_brace=force