ghazel-ffi-clang 0.2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 506649e109549d1903e03b67c447155675058565
+  data.tar.gz: b6db09a97418026ebcbde1f6566020e19c072b6a
+SHA512:
+  metadata.gz: 1e9ac59e87eb20103c844bf160ebe2c0bd9a433f3f98fcbaf3fa10cb6487add82e44c6ff21a0c3fc68e80c2f35b8cb13f92b092590fa6c8b64329041d5e8e050
+  data.tar.gz: 488e6bfd72f695c81a5ce2ad4455a82e65d00bcfd788163d9e2f592cb7523eacbdfff20d336e5797fce841af16a1cf79d00b7eb251c89ee683dac42dd2af541d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+env:
+  - LLVM_VERSION=3.2
+  - LLVM_VERSION=3.3
+  - LLVM_VERSION=3.4
+  - LLVM_VERSION=3.5
+install:
+    - sudo add-apt-repository --yes ppa:h-rayflood/llvm
+    - sudo add-apt-repository --yes ppa:ubuntu-toolchain-r/test
+    - sudo add-apt-repository --yes 'deb http://llvm.org/apt/precise/ llvm-toolchain-precise main'
+    - wget -O - http://llvm.org/apt/llvm-snapshot.gpg.key | sudo apt-key add -
+    - sudo apt-get -qq update
+    - sudo apt-get -qq install libclang-${LLVM_VERSION}-dev clang-${LLVM_VERSION}
+    - export LD_LIBRARY_PATH=/usr/lib/llvm-${LLVM_VERSION}/lib/
+    - export PATH=/usr/lib/llvm-${LLVM_VERSION}/bin:$PATH
+    - if [ "${LLVM_VERSION}" = "3.5" ]; then sudo ln -s /usr/bin/clang /usr/lib/llvm-${LLVM_VERSION}/bin/clang; fi
+    - if [ "${LLVM_VERSION}" = "3.5" ]; then sudo ln -s /usr/bin/clang++ /usr/lib/llvm-${LLVM_VERSION}/bin/clang++; fi
+    - bundle install

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ffi-clang.gemspec
+gemspec

data/README.md

@@ -0,0 +1,74 @@
+# FFI::Clang
+
+A light weight wrapper for Ruby exposing [libclang][1].
+
+[![Build Status](https://secure.travis-ci.org/ioquatix/ffi-clang.png)](http://travis-ci.org/ioquatix/ffi-clang)
+[![Code Climate](https://codeclimate.com/github/ioquatix/ffi-clang.png)](https://codeclimate.com/github/ioquatix/ffi-clang)
+
+[1]: http://llvm.org/devmtg/2010-11/Gregor-libclang.pdf
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'ffi-clang'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install ffi-clang
+
+## Usage
+
+Traverse the AST in the given file:
+
+	index = Index.new
+	translation_unit = index.parse_translation_unit("list.c")
+	cursor = translation_unit.cursor
+	cursor.visit_children do |cursor, parent|
+		puts "#{cursor.kind} #{cursor.spelling.inspect}"
+		
+		next :recurse 
+	end
+
+### Library Version
+
+Due to issues figuring out which library to use, we require you to manually specify it. For example, to run the tests, with MacPorts llvm/clang 3.4, use the following:
+
+	LLVM_CONFIG=llvm-config-mp-3.4 rake
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright, 2010-2012, by Jari Bakken.  
+Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>  
+Copyright, 2013, by Garry C. Marshall. <http://www.meaningfulname.net>  
+Copyright, 2014, by Masahiro Sano.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+ 
+desc 'Default: run specs.'
+task :default => :spec
+ 
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+	t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+	# Put spec opts in a file named .rspec in root
+end

data/ext/rakefile.rb

@@ -0,0 +1,12 @@
+
+require 'teapot'
+
+task :default do
+	controller = Teapot::Controller.new(__dir__)
+	
+	controller.fetch
+	
+	packages = ["Dependencies/ffi-clang", "variant-release", "platform-darwin-osx"]
+	
+	controller.build(packages)
+end

data/ext/teapot.rb

@@ -0,0 +1,16 @@
+#
+#  This file is part of the "Teapot" project, and is released under the MIT license.
+#
+
+teapot_version "0.8.0"
+
+define_target "ffi-clang" do |target|
+	target.depends "Library/clang"
+	target.provides "Dependencies/ffi-clang"
+end
+
+define_configuration "ffi-clang" do |configuration|
+	configuration[:source] = "https://github.com/dream-framework/"
+	
+	configuration.require "clang"
+end

data/ffi-clang.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ffi/clang/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "ghazel-ffi-clang"
+	spec.version       = FFI::Clang::VERSION
+	spec.authors       = ["Jari Bakken", "Samuel Williams"]
+	spec.email         = ["Jari Bakken", "samuel.williams@oriontransfer.co.nz"]
+	spec.description   = %q{Ruby FFI bindings for libclang C interface.}
+	spec.summary       = %q{Ruby FFI bindings for libclang C interface.}
+	spec.homepage      = ""
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_dependency "ffi"
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+	spec.add_development_dependency "rspec"
+end

data/lib/ffi/clang.rb

@@ -0,0 +1,54 @@
+# Copyright, 2010-2012 by Jari Bakken.
+# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'ffi'
+require "rbconfig"
+
+module FFI::Clang
+	class Error < StandardError
+	end
+
+	def self.platform
+		os = RbConfig::CONFIG["host_os"]
+
+		case os
+		when /darwin/
+			:darwin
+		when /linux/
+			:linux
+		when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+			:windows
+		else
+			os
+		end
+	end
+end
+
+require 'ffi/clang/utils'
+require 'ffi/clang/lib'
+require 'ffi/clang/index'
+require 'ffi/clang/translation_unit'
+require 'ffi/clang/diagnostic'
+require 'ffi/clang/cursor'
+require 'ffi/clang/source_location'
+require 'ffi/clang/source_range'
+require 'ffi/clang/unsaved_file'
+require 'ffi/clang/token'

data/lib/ffi/clang/comment.rb

@@ -0,0 +1,278 @@
+# -*- coding: utf-8 -*-
+# Copyright, 2013, by Carlos Martín Nieto <cmn@dwim.me>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'ffi/clang/lib/cursor'
+require 'ffi/clang/lib/comment'
+require 'ffi/clang/source_location'
+
+module FFI
+	module Clang
+
+		class Comment
+			include Enumerable
+
+			def self.build_from(comment)
+				kind = Lib.comment_get_kind(comment)
+				case kind
+				when :comment_null
+					Comment.new comment
+				when :comment_text
+					TextComment.new comment
+				when :comment_inline_command
+					InlineCommandComment.new comment
+				when :comment_html_start_tag
+					HTMLStartTagComment.new comment
+				when :comment_html_end_tag
+					HTMLEndTagComment.new comment
+				when :comment_paragraph
+					ParagraphComment.new comment
+				when :comment_block_command
+					BlockCommandComment.new comment
+				when :comment_param_command
+					ParamCommandComment.new comment
+				when :comment_tparam_command
+					TParamCommandComment.new comment
+				when :comment_verbatim_block_command
+					VerbatimBlockCommandComment.new comment
+				when :comment_verbatim_block_line
+					VerbatimBlockLineComment.new comment
+				when :comment_verbatim_line
+					VerbatimLine.new comment
+				when :comment_full
+					FullComment.new comment
+				else
+					raise NotImplementedError, kind
+				end
+			end
+
+			def text
+				return ""
+			end
+
+			def initialize(comment)
+				@comment = comment
+			end
+
+			def kind
+				Lib.comment_get_kind(@comment)
+			end
+
+			def num_children
+				Lib.comment_get_num_children(@comment)
+			end
+
+			def child(n = 0)
+				Comment.build_from Lib.comment_get_child(@comment, n)
+			end
+
+			def children
+				num_children.times.map { |i| child(i) }
+			end
+
+			def whitespace?
+				Lib.comment_is_whitespace(@comment) != 0
+			end
+
+			def has_trailing_newline?
+				Lib.inline_content_comment_has_trailing_newline(@comment) != 0
+			end
+
+			def each(&block)
+				num_children.times.map do |i|
+					block.call(child(i))
+				end
+			end
+
+		end
+
+		class HTMLTagComment < Comment
+			def name
+				Lib.extract_string Lib.html_tag_comment_get_tag_name(@comment)
+			end
+			alias_method :tag, :name
+
+			def text
+				Lib.extract_string Lib.html_tag_comment_get_as_string(@comment)
+			end
+		end
+
+		class HTMLStartTagComment < HTMLTagComment
+			def self_closing?
+				Lib.html_start_tag_comment_is_self_closing(@comment) != 0
+			end
+
+			def num_attrs
+				Lib.html_start_tag_comment_get_num_attrs(@comment)
+			end
+
+			def attrs
+				num_attrs.times.map { |i|
+					{
+						name: Lib.extract_string(Lib.html_start_tag_comment_get_attr_name(@comment, i)),
+						value: Lib.extract_string(Lib.html_start_tag_comment_get_attr_value(@comment, i)),
+					}
+			  }
+			end
+		end
+
+		class HTMLEndTagComment < HTMLTagComment
+		end
+
+		class ParagraphComment < Comment
+			def text
+				self.map(&:text).join("\n")
+			end
+		end
+
+		class TextComment < Comment
+			def text
+				Lib.extract_string Lib.text_comment_get_text(@comment)
+			end
+		end
+
+		class InlineCommandComment < Comment
+			def name
+				Lib.extract_string Lib.inline_command_comment_get_command_name(@comment)
+			end
+
+			def render_kind
+				Lib.inline_command_comment_get_render_kind(@comment)
+			end
+
+			def num_args
+				Lib.inline_command_comment_get_num_args(@comment)
+			end
+
+			def args
+				num_args.times.map { |i|
+					Lib.extract_string Lib.inline_command_comment_get_arg_text(@comment, i)
+				}
+			end
+
+			def text
+				args.join
+			end
+		end
+
+		class BlockCommandComment < Comment
+			def name
+				Lib.extract_string Lib.block_command_comment_get_command_name(@comment)
+			end
+
+			def paragraph
+				Comment.build_from Lib.block_command_comment_get_paragraph(@comment)
+			end
+
+			def text
+				self.paragraph.text
+			end
+			alias_method :comment, :text
+
+			def num_args
+				Lib.block_command_comment_get_num_args(@comment)
+			end
+
+			def args
+				num_args.times.map { |i|
+					Lib.extract_string Lib.block_command_comment_get_arg_text(@comment, i)
+				}
+			end
+		end
+
+		class ParamCommandComment < Comment
+			def name
+				Lib.extract_string Lib.param_command_comment_get_param_name(@comment)
+			end
+
+			def text
+				self.map(&:text).join("")
+			end
+			alias_method :comment, :text
+
+			def valid_index?
+				Lib.param_command_comment_is_param_index_valid(@comment) != 0
+			end
+
+			def index
+				Lib.param_command_comment_get_param_index(@comment)
+			end
+
+			def direction_explicit?
+				Lib.param_command_comment_is_direction_explicit(@comment) != 0
+			end
+
+			def direction
+				Lib.param_command_comment_get_direction(@comment)
+			end
+		end
+
+		class TParamCommandComment < Comment
+			def text
+				self.child.text
+			end
+			alias_method :comment, :text
+
+			def name
+				Lib.extract_string Lib.tparam_command_comment_get_param_name(@comment)
+			end
+
+			def valid_position?
+				Lib.tparam_command_comment_is_param_position_valid(@comment) != 0
+			end
+
+			def depth
+				Lib.tparam_command_comment_get_depth(@comment)
+			end
+
+			def index(depth = 0)
+				Lib.tparam_command_comment_get_index(@comment, depth)
+			end
+		end
+
+		class VerbatimBlockCommandComment < Comment
+			def text
+				children.map(&:text).join("\n")
+			end
+		end
+
+		class VerbatimBlockLineComment < Comment
+			def text
+				Lib.extract_string Lib.verbatim_block_line_comment_get_text(@comment)
+			end
+		end
+
+		class VerbatimLine < Comment
+			def text
+				Lib.extract_string Lib.verbatim_line_comment_get_text(@comment)
+			end
+		end
+
+		class FullComment < Comment
+			def to_html
+				Lib.extract_string Lib.full_comment_get_as_html(@comment)
+			end
+
+			def to_xml
+				Lib.extract_string Lib.full_comment_get_as_xml(@comment)
+			end
+		end
+	end
+end