swipl 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 187e536fbdc31b19a4622f713887c8060eaf4d4f
+  data.tar.gz: 674e107ad57b73640a26af99299202b4b3e3a856
+SHA512:
+  metadata.gz: 28674680661610bf44248641440c8955d55c575bba0c390cf4594a89d23b431f15bdb3f6da04c39a613d7cf6a07b27e96bbd19545d1663a048fadbb802f373a2
+  data.tar.gz: b2d235f8204c8023bd097ef2664213eeeb608406f48f3c49326b31d75f09f25fc123f61e41e5884c7ce0e7970befec0538bee27d2b104da472cd35798dad2b09

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swo
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mark Eschbach
+
+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/README.md

@@ -0,0 +1,84 @@
+# SWIPL
+
+A Ruby Gem for binding to SWI Prolog. This uses Ruby's FFI gem for binding.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swipl'
+```
+
+## Usage
+
+Set `SWI_LIB` to the where you have the libswipl.{dylib,so,dll} file.  Unforunately I haven't figured out a better method for locating the library; open to ideas and pull requests to make this easier for client applications.
+
+### Basic Usage
+
+You can query if a statement is truthy by passing it as string as follows:
+```ruby
+SWIPL::verify('true')
+```
+
+This will boot up the engine and run the query the Prolog for the answer.  Your programs can be arbitrarily complex, however this will only result in true or false.
+
+### Usage Level 2
+
+Let's say you have the following prolog database in foods.pl: 
+
+```prolog
+food( beef ).
+food( broccoli ).
+food( potatoes ).
+
+enjoys( mark, broccoli ).
+```
+
+You can they load the database (assuming in the same directory) an query for all solutions as follows:
+
+```ruby
+SWIPL::truth( "consult('foods.pl')" )
+foods = SWIPL::query( "food", 1 )
+```
+
+The variable foods should now contain the follow (note: order of the elements may change):
+```ruby
+[ ["beef"], ["broccoli"], ["potatoes"] ]
+```
+
+### Advanced Usage
+
+This is kind of a gnarly API right now.  My goal is to clean it up, but querying with bound variables is
+possible right now.
+
+```ruby
+SWIPL::PrologFrame.on do |frame|
+	human = frame.atom_from_string( "mark" )
+	predicate = SWIPL::Predicate.find( "enjoys", 2 )
+	query = predicate.query_normally_with( frame, [human, nil ] ) # nil will result in an unground variable
+	begin
+		query.each_solution do |solution|
+			puts solution
+		end
+	ensure
+		query.close # if you forget this there will probably be some strange statement about no foreign frame
+	end
+end
+```
+
+Resulting output:
+```ruby
+["mark", "broccoli"]
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/meschbach/gem-swipl.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swipl"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/lib/swipl.rb

@@ -0,0 +1,43 @@
+require "swipl/cffi"
+require 'swipl/predicate'
+require 'swipl/prologframe'
+require 'swipl/query'
+require 'swipl/term'
+require "swipl/version"
+
+module SWIPL
+	PL_TRUE = 1
+	PL_FALSE = 2
+	PL_FAIL = PL_FALSE
+	PL_Q_NORMAL = 2
+
+	def self.verify( fact )
+		CFFI.init
+		PrologFrame.on do |frame|
+			atom = frame.atom_from_string( fact )
+			CFFI.PL_call( atom.term_id, nil ) == PL_TRUE
+		end
+	end
+
+	def self.query( predicateName, arity )
+		solutions = []
+		PrologFrame.on do |frame|
+			predicate = Predicate.find( predicateName, arity)
+			query = predicate.query_normally( frame )
+			begin
+				query.each_solution do |p|
+					solutions.push([ p[0].as_atom ] )
+				end
+			ensure
+				query.close
+			end
+		end
+		solutions
+	end
+
+	def self.truth( fact )
+		unless self.verify( fact )
+			raise "Truth '#{fact}' failed"
+		end
+	end
+end

data/lib/swipl/cffi.rb

@@ -0,0 +1,46 @@
+require 'ffi'
+
+module SWIPL
+	module CFFI
+		extend FFI::Library
+		ffi_lib ENV["SWI_LIB"]
+
+		attach_function :PL_open_foreign_frame, [], :ulong
+		attach_function :PL_discard_foreign_frame, [:ulong], :int
+
+		# Warning: the following method repeatedly failed
+		attach_function :PL_atom_chars, [:ulong], :pointer
+
+		attach_function :PL_call, [:ulong, :pointer], :int
+		attach_function :PL_chars_to_term, [:pointer, :ulong], :int
+		attach_function :PL_close_query, [:ulong], :void
+		attach_function :PL_get_atom_chars, [:ulong, :pointer], :int
+		attach_function :PL_initialise, [:int, :pointer], :int
+		attach_function :PL_is_atom, [:ulong], :int
+		attach_function :PL_is_ground, [:ulong], :int
+		attach_function :PL_new_atom, [:pointer], :ulong 
+		attach_function :PL_new_term_ref, [], :ulong 
+		attach_function :PL_new_term_refs, [:int], :ulong 
+		attach_function :PL_next_solution, [:ulong], :int
+		attach_function :PL_open_query, [:pointer, :int, :ulong, :ulong], :ulong
+		attach_function :PL_predicate, [:pointer, :int, :pointer], :ulong
+		attach_function :PL_thread_self, [], :int
+		attach_function :PL_unify, [ :ulong, :ulong ], :int
+
+		@is_initialized = false
+		def self.init
+			return if @is_initialized
+
+			libptr = ::FFI::MemoryPointer.from_string( ENV["SWI_LIB"] ) 
+			plargv = ::FFI::MemoryPointer.new( :pointer, 1 )
+			plargv.write_pointer( libptr )
+
+			value = PL_initialise( 1, plargv )
+			if value != 1
+				raise "SWI failed to initialize"
+			end
+
+			@is_initialized = true
+		end
+	end
+end

data/lib/swipl/predicate.rb

@@ -0,0 +1,37 @@
+
+module SWIPL
+	class Predicate
+		def initialize( id, arity )
+			@pred_id = id
+			@arity = arity
+		end
+
+		def self.find( name, arity )
+			name_ptr = FFI::MemoryPointer.from_string( name.to_s )
+			id = CFFI.PL_predicate( name_ptr, arity, nil )
+			Predicate.new( id, arity )
+		end
+
+		# @param frame the frame to allocate the parameters
+		def query_normally( frame )
+			params = frame.refs( @arity )
+			query_id = CFFI.PL_open_query( nil, PL_Q_NORMAL, @pred_id, params[0].id )
+			Query.new( query_id, params )
+		end
+
+		def query_normally_with( frame, inputs )
+			raise "insufficent parameters for arity" if inputs.length != @arity
+
+			params = frame.refs( @arity )
+			(0..(@arity-1)).each do |index|
+				source = inputs[ index ]
+				if source
+					params[index].unify_with( inputs[index] )
+				end
+			end
+
+			query_id = CFFI.PL_open_query( nil, PL_Q_NORMAL, @pred_id, params[0].id )
+			Query.new( query_id, params )
+		end
+	end
+end

data/lib/swipl/prologframe.rb

@@ -0,0 +1,55 @@
+
+module SWIPL
+	class PrologFrame
+		def initialize( frame_id )
+			@frame_id = frame_id
+		end
+
+		def close
+			result = CFFI.PL_discard_foreign_frame( @frame_id )
+			if result == PL_FALSE
+				raise "Failed to close frame"
+			end
+		end
+
+		# Opens a foreign frame
+		def self.open
+			frame_id = CFFI.PL_open_foreign_frame
+			if frame_id == PL_FALSE 
+				raise "failed to open frame"
+			end
+			PrologFrame.new( frame_id )
+		end
+
+		def self.on( &block )
+			frame = self.open
+			begin
+				block.call( frame )
+			ensure
+				frame.close
+			end
+		end
+
+		# allocates teh number of terms and returns an array of those terms
+		#
+		# NOTE: SWI requires continous terms from time to time (ie: PL_open_query) 
+		def refs( count )
+			return [] if count == 0
+
+			base = CFFI.PL_new_term_refs( count )
+			#TODO: Verify the result of the query
+			(0..(count-1)).map do |index|
+				Term.new( base + index )
+			end
+		end
+
+		def atom_from_string( string )
+			atom_ptr = FFI::MemoryPointer.from_string( string.to_s )
+			atom_term = CFFI.PL_new_term_ref
+			if CFFI.PL_chars_to_term( atom_ptr, atom_term ) == 0
+				raise "failed to create atom from terms"
+			end
+			Term.new( atom_term )
+		end
+	end
+end

data/lib/swipl/query.rb

@@ -0,0 +1,23 @@
+
+module SWIPL
+	class Query
+		def initialize( qid, terms )
+			@query_id = qid
+			@terms = terms
+		end
+
+		def next_solution?
+			CFFI.PL_next_solution( @query_id ) == PL_TRUE 
+		end
+
+		def each_solution
+			while next_solution?
+				yield(@terms)
+			end
+		end
+
+		def close
+			CFFI.PL_close_query( @query_id )
+		end
+	end
+end

data/lib/swipl/term.rb

@@ -0,0 +1,43 @@
+
+module SWIPL
+	class Term
+		def initialize( term_id )
+			@term_id = term_id
+		end
+
+		def id; self.term_id; end
+		def term_id; @term_id; end
+
+		def unify_with( other_term )
+			CFFI.PL_unify( @term_id, other_term.term_id ) != PL_FAIL
+		end
+
+		def ground?
+			CFFI.PL_is_ground( @term_id ) == PL_TRUE
+		end
+
+		def atom?
+			CFFI.PL_is_atom( @term_id ) 
+		end
+
+		def as_atom
+			str_ptr = FFI::MemoryPointer.new( :pointer, 1 )
+			if CFFI.PL_get_atom_chars( @term_id, str_ptr ) == PL_FALSE
+				raise "failed to get term #{@term_id} as an atom"
+			end
+			str_ptr.read_pointer.read_string
+		end
+
+		def to_s
+			if self.ground?
+				if self.atom?
+					self.as_atom
+				else
+					"ground"
+				end
+			else
+				"variable"
+			end
+		end
+	end
+end

data/lib/swipl/version.rb

@@ -0,0 +1,3 @@
+module SWIPL
+  VERSION = "0.3.0"
+end

data/swipl.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swipl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swipl"
+  spec.version       = SWIPL::VERSION
+  spec.authors       = ["Mark Eschbach"]
+  spec.email         = ["meschbach@gmail.com"]
+
+  spec.summary       = %q{Ruby bindings for SWI Prolog}
+  spec.description   = %q{Interact with the SWI Prolog system in ruby.  Currently uses FFI to bind using the C interface.}
+  spec.homepage      = "https://github.com/meschbach/gem-swipl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "ffi", "~> 1.9"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: swipl
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Mark Eschbach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: Interact with the SWI Prolog system in ruby.  Currently uses FFI to bind
+  using the C interface.
+email:
+- meschbach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- lib/swipl.rb
+- lib/swipl/cffi.rb
+- lib/swipl/predicate.rb
+- lib/swipl/prologframe.rb
+- lib/swipl/query.rb
+- lib/swipl/term.rb
+- lib/swipl/version.rb
+- swipl.gemspec
+homepage: https://github.com/meschbach/gem-swipl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for SWI Prolog
+test_files: []