clipsruby 0.0.19 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c06b3f9f05fc87da93b208ba7f77de5097f964a689e2a9d1cdc8d8e0d992c826
-  data.tar.gz: 151dd0c82d9213a7ce971935513cbd9c16ab76bc08b123c7321ecfe1fa5cf985
+  metadata.gz: 7e26c6a3eb9602ca2ab8d3aa497b95b19d404640fa281aac5544310a01040b62
+  data.tar.gz: 56000c5e564e43d907daf53fd0476113448e0a27377b36ad41cd1a04202f1c03
 SHA512:
-  metadata.gz: d545c65c3587d29c3b0a4fa12ffa6ecc030c242c472bcb5eb607014de3a03bd465defbe34fa4753e2594e55b2f5685f4111d8ab1c38b2467a9fa38256e31458c
-  data.tar.gz: c49a1fa673d5f680ee9c6fc2a38ed4dd4708cc996b8624f620e97d5161a5f533077542d7b0a4e788c4a6a4b9be49ad1bbf4307e769fde4cc537dde92905b8b86
+  metadata.gz: 8a7ec9525ec36621cba6fb7c75bb89f2406dcdb13237b478e2a98b2d9b7af202b79fae1e65779fc48b1ab89ef490a66cb68343c48144cb8d857fab3c4a1eaaf4
+  data.tar.gz: 5d45dcb799e1c829f76d5f20a41b05817f9d0a57ab7d72827b45b871a38755f9f695fd5fb9d62a1c899fe83b993a29cd42870b194a651b92461ac846d67bde04

data/README.md

@@ -162,7 +162,7 @@ A light wrapper around the CLIPS find-fact function. Accepts a fact set template
 returns the first Facts in the environment that match as Ruby objects.
 
 ```ruby
-CLIPS::Environment.find_facts(env, "(?f my_deftemplate)")
+CLIPS::Environment.find_fact(env, "(?f my_deftemplate)")
 env.find_fact("(?f my_deftemplate)")
 CLIPS::Environment.find_fact(env, "(?f my_deftemplate)", "(eq ?f:b \"asdf\")")
 env.find_fact("(?f my_deftemplate)", "(= ?f:a 1)")
@@ -302,6 +302,16 @@ CLIPS::Environment.set_current_module(env, defmodule)
 env.set_current_module(defmodule)
 ```
 
+### `CLIPS::Environment::Fact.pp_form`
+### `CLIPS::Environment::Fact#pp_form`
+
+Returns a pretty printed string representation of the Fact
+
+```ruby
+CLIPS::Environment::Fact.pp_form(fact)
+fact.pp_form
+```
+
 ### `CLIPS::Environment::Fact.to_h`
 ### `CLIPS::Environment::Fact#to_h`
 
@@ -494,6 +504,66 @@ CLIPS::Environment::Defmodule.get_fact_list(defmodule)
 defmodule.get_fact_list
 ```
 
+### `CLIPS::Environment.find_deftemplate`
+### `CLIPS::Environment#find_deftemplate`
+
+Finds a deftemplate by name and returns a CLIPS::Environment::Deftemplate object
+
+```ruby
+CLIPS::Environment.find_deftemplate(:a)
+env.find_deftemplate("foo")
+```
+
+### `CLIPS::Environment::Deftemplate.name`
+### `CLIPS::Environment::Deftemplate#name`
+
+Returns the name of a deftemplate as a symbol
+
+```ruby
+CLIPS::Environment::Deftemplate.name(deftemplate)
+deftemplate.name
+```
+
+### `CLIPS::Environment::Deftemplate.pp_form`
+### `CLIPS::Environment::Deftemplate#pp_form`
+
+Returns a pretty printed string representation of the Deftemplate
+
+```ruby
+CLIPS::Environment::Deftemplate.pp_form(deftemplate)
+deftemplate.pp_form
+```
+
+### `CLIPS::Environment.find_deffacts`
+### `CLIPS::Environment#find_deffacts`
+
+Finds a deffacts by name and returns a CLIPS::Environment::Deffacts object
+
+```ruby
+CLIPS::Environment.find_deffacts(:a)
+env.find_deffacts("foo")
+```
+
+### `CLIPS::Environment::Deffacts.name`
+### `CLIPS::Environment::Deffacts#name`
+
+Returns the name of a deffacts as a symbol
+
+```ruby
+CLIPS::Environment::Deffacts.name(deffacts)
+deffacts.name
+```
+
+### `CLIPS::Environment::Deffacts.pp_form`
+### `CLIPS::Environment::Deffacts#pp_form`
+
+Returns a pretty printed string representation of the Deffacts
+
+```ruby
+CLIPS::Environment::Deffacts.pp_form(deffacts)
+deffacts.pp_form
+```
+
 ## Running the tests
 
 Simply do `rake compile` and then `rake test` in order to run the tests.

data/ext/clipsruby/clipsruby.c

@@ -1,6 +1,30 @@
 #include "clips.h"
 #include "ruby.h"
 
+size_t deffacts_size(const void *data)
+{
+	return sizeof(Deffacts);
+}
+
+static const rb_data_type_t Deffacts_type = {
+	.function = {
+		.dsize = deffacts_size
+	},
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+size_t deftemplate_size(const void *data)
+{
+	return sizeof(Deftemplate);
+}
+
+static const rb_data_type_t Deftemplate_type = {
+	.function = {
+		.dsize = deftemplate_size
+	},
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
 size_t defmodule_size(const void *data)
 {
 	return sizeof(Defmodule);
@@ -91,6 +115,16 @@ VALUE defmodule_alloc(VALUE self)
 	return TypedData_Wrap_Struct(self, &Defmodule_type, NULL);
 }
 
+VALUE deffacts_alloc(VALUE self)
+{
+	return TypedData_Wrap_Struct(self, &Deffacts_type, NULL);
+}
+
+VALUE deftemplate_alloc(VALUE self)
+{
+	return TypedData_Wrap_Struct(self, &Deftemplate_type, NULL);
+}
+
 VALUE defrule_alloc(VALUE self)
 {
 	return TypedData_Wrap_Struct(self, &Defrule_type, NULL);
@@ -1238,6 +1272,65 @@ static VALUE clips_environment_static_find_defrule(VALUE self, VALUE rbEnvironme
 	return clips_environment_find_defrule(rbEnvironment, defrule_name);
 }
 
+static VALUE clips_environment_find_deffacts(VALUE self, VALUE deffacts_name)
+{
+	Environment *env;
+	Deffacts *deffacts;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	switch (TYPE(deffacts_name)) {
+		case T_STRING:
+			deffacts = FindDeffacts(env, StringValueCStr(deffacts_name));
+			break;
+		case T_SYMBOL:
+			deffacts = FindDeffacts(env, rb_id2name(SYM2ID(deffacts_name)));
+			break;
+                default:
+			rb_warn("deffacts name must be a symbol or string");
+			return Qnil;
+        }
+
+	if (deffacts == NULL) {
+		return Qnil;
+	} else {
+		return TypedData_Wrap_Struct(rb_const_get(CLASS_OF(self), rb_intern("Deffacts")), &Deffacts_type, deffacts);
+	}
+}
+
+static VALUE clips_environment_static_find_deffacts(VALUE self, VALUE rbEnvironment, VALUE deffacts_name)
+{
+	return clips_environment_find_deffacts(rbEnvironment, deffacts_name);
+}
+
+static VALUE clips_environment_deffacts_name(VALUE self)
+{
+	Deffacts *deffacts;
+
+	TypedData_Get_Struct(self, Deffacts, &Deffacts_type, deffacts);
+
+	return ID2SYM(rb_intern(DeffactsName(deffacts)));
+}
+
+static VALUE clips_environment_deffacts_static_name(VALUE self, VALUE rbDeffacts)
+{
+	return clips_environment_deffacts_name(rbDeffacts);
+}
+
+static VALUE clips_environment_deffacts_pp_form(VALUE self)
+{
+	Deffacts *deffacts;
+
+	TypedData_Get_Struct(self, Deffacts, &Deffacts_type, deffacts);
+
+	return rb_str_new2(DeffactsPPForm(deffacts));
+}
+
+static VALUE clips_environment_deffacts_static_pp_form(VALUE self, VALUE rbDeffacts)
+{
+	return clips_environment_deffacts_pp_form(rbDeffacts);
+}
+
 static VALUE clips_environment_get_current_module(VALUE self)
 {
 	Environment *env;
@@ -1313,6 +1406,120 @@ static VALUE clips_environment_static_find_defmodule(VALUE self, VALUE rbEnviron
 	return clips_environment_find_defmodule(rbEnvironment, defmodule_name);
 }
 
+static VALUE clips_environment_find_deftemplate(VALUE self, VALUE deftemplate_name)
+{
+	Environment *env;
+	Deftemplate *template;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	switch (TYPE(deftemplate_name)) {
+		case T_STRING:
+			template = FindDeftemplate(env, StringValueCStr(deftemplate_name));
+			break;
+		case T_SYMBOL:
+			template = FindDeftemplate(env, rb_id2name(SYM2ID(deftemplate_name)));
+			break;
+                default:
+			rb_warn("deftemplate name must be a symbol or string");
+			return Qnil;
+        }
+
+	if (template == NULL) {
+		return Qnil;
+	} else {
+		VALUE rbDeftemplate;
+		rbDeftemplate = TypedData_Wrap_Struct(rb_const_get(CLASS_OF(self), rb_intern("Deftemplate")), &Deftemplate_type, template);
+		rb_iv_set(rbDeftemplate, "@environment", self);
+		return rbDeftemplate;
+	}
+}
+
+static VALUE clips_environment_static_find_deftemplate(VALUE self, VALUE rbEnvironment, VALUE deftemplate_name)
+{
+	return clips_environment_find_deftemplate(rbEnvironment, deftemplate_name);
+}
+
+static VALUE clips_environment_deftemplate_name(VALUE self)
+{
+	Deftemplate *deftemplate;
+
+	TypedData_Get_Struct(self, Deftemplate, &Deftemplate_type, deftemplate);
+
+	return ID2SYM(rb_intern(DeftemplateName(deftemplate)));
+}
+
+static VALUE clips_environment_deftemplate_static_name(VALUE self, VALUE rbDeftemplate)
+{
+	return clips_environment_deftemplate_name(rbDeftemplate);
+}
+
+static VALUE clips_environment_deftemplate_pp_form(VALUE self)
+{
+	Deftemplate *deftemplate;
+
+	TypedData_Get_Struct(self, Deftemplate, &Deftemplate_type, deftemplate);
+
+	return rb_str_new2(DeftemplatePPForm(deftemplate));
+}
+
+static VALUE clips_environment_deftemplate_static_pp_form(VALUE self, VALUE rbDeftemplate)
+{
+	return clips_environment_deftemplate_pp_form(rbDeftemplate);
+}
+
+static VALUE clips_environment_fact_pp_form(int argc, VALUE *argv, VALUE self)
+{
+	Fact *fact;
+	VALUE ignore_defaults, toReturn;
+	Environment *env;
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+	VALUE rbEnvironment = rb_iv_get(self, "@environment");
+	TypedData_Get_Struct(rbEnvironment, Environment, &Environment_type, env);
+	StringBuilder *sb = CreateStringBuilder(env, 0);
+
+	rb_scan_args(argc, argv, "01", &ignore_defaults);
+
+	if (ignore_defaults == Qtrue) {
+		FactPPForm(fact, sb, true);
+	} else {
+		FactPPForm(fact, sb, false);
+	}
+
+	toReturn = rb_str_new2(sb->contents);
+
+	SBDispose(sb);
+
+	return toReturn;
+}
+
+static VALUE clips_environment_fact_static_pp_form(int argc, VALUE *argv, VALUE klass)
+{
+	Fact *fact;
+	VALUE self, ignore_defaults, toReturn;
+	Environment *env;
+
+	rb_scan_args(argc, argv, "11", &self, &ignore_defaults);
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+	VALUE rbEnvironment = rb_iv_get(self, "@environment");
+	TypedData_Get_Struct(rbEnvironment, Environment, &Environment_type, env);
+	StringBuilder *sb = CreateStringBuilder(env, 0);
+
+	if (ignore_defaults == Qtrue) {
+		FactPPForm(fact, sb, true);
+	} else {
+		FactPPForm(fact, sb, false);
+	}
+
+	toReturn = rb_str_new2(sb->contents);
+
+	SBDispose(sb);
+
+	return toReturn;
+}
+
 static VALUE clips_environment_get_fact_list(int argc, VALUE *argv, VALUE rbEnvironment) {
 	VALUE defmodule_or_defmodule_name;
 	Environment *env;
@@ -1603,12 +1810,30 @@ void Init_clipsruby(void)
 	rb_define_method(rbEnvironment, "find_defrule", clips_environment_find_defrule, 1);
 	rb_define_singleton_method(rbEnvironment, "find_defmodule", clips_environment_static_find_defmodule, 2);
 	rb_define_method(rbEnvironment, "find_defmodule", clips_environment_find_defmodule, 1);
+	rb_define_singleton_method(rbEnvironment, "find_deftemplate", clips_environment_static_find_deftemplate, 2);
+	rb_define_method(rbEnvironment, "find_deftemplate", clips_environment_find_deftemplate, 1);
 	rb_define_singleton_method(rbEnvironment, "get_current_module", clips_environment_static_get_current_module, 1);
 	rb_define_method(rbEnvironment, "get_current_module", clips_environment_get_current_module, 0);
 	rb_define_singleton_method(rbEnvironment, "set_current_module", clips_environment_static_set_current_module, 2);
 	rb_define_method(rbEnvironment, "set_current_module", clips_environment_set_current_module, 1);
 	rb_define_singleton_method(rbEnvironment, "get_fact_list", clips_environment_static_get_fact_list, -1);
 	rb_define_method(rbEnvironment, "get_fact_list", clips_environment_get_fact_list, -1);
+	rb_define_singleton_method(rbEnvironment, "find_deffacts", clips_environment_static_find_deffacts, 2);
+	rb_define_method(rbEnvironment, "find_deffacts", clips_environment_find_deffacts, 1);
+
+	VALUE rbDeffacts = rb_define_class_under(rbEnvironment, "Deffacts", rb_cObject);
+	rb_define_alloc_func(rbDeffacts, deffacts_alloc);
+	rb_define_singleton_method(rbDeffacts, "name", clips_environment_deffacts_static_name, 1);
+	rb_define_method(rbDeffacts, "name", clips_environment_deffacts_name, 0);
+	rb_define_singleton_method(rbDeffacts, "pp_form", clips_environment_deffacts_static_pp_form, 1);
+	rb_define_method(rbDeffacts, "pp_form", clips_environment_deffacts_pp_form, 0);
+
+	VALUE rbDeftemplate = rb_define_class_under(rbEnvironment, "Deftemplate", rb_cObject);
+	rb_define_alloc_func(rbDeftemplate, deftemplate_alloc);
+	rb_define_singleton_method(rbDeftemplate, "name", clips_environment_deftemplate_static_name, 1);
+	rb_define_method(rbDeftemplate, "name", clips_environment_deftemplate_name, 0);
+	rb_define_singleton_method(rbDeftemplate, "pp_form", clips_environment_deftemplate_static_pp_form, 1);
+	rb_define_method(rbDeftemplate, "pp_form", clips_environment_deftemplate_pp_form, 0);
 
 	VALUE rbDefmodule = rb_define_class_under(rbEnvironment, "Defmodule", rb_cObject);
 	rb_define_alloc_func(rbDefmodule, defmodule_alloc);
@@ -1637,6 +1862,8 @@ void Init_clipsruby(void)
 	rb_define_method(rbFact, "modify", clips_environment_fact_modify, 1);
 	rb_define_singleton_method(rbFact, "index", clips_environment_fact_static_index, 1);
 	rb_define_method(rbFact, "index", clips_environment_fact_index, 0);
+	rb_define_singleton_method(rbFact, "pp_form", clips_environment_fact_static_pp_form, -1);
+	rb_define_method(rbFact, "pp_form", clips_environment_fact_pp_form, -1);
 
 	VALUE rbDefrule = rb_define_class_under(rbEnvironment, "Defrule", rb_cObject);
 	rb_define_alloc_func(rbDefrule, defrule_alloc);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clipsruby
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.21
 platform: ruby
 authors:
 - Ryan Johnston
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2024-09-11 00:00:00.000000000 Z
 dependencies: []
 description: Calling the CLIPS programming language from within Ruby
 email: mrryanjohnston@gmail.com