clipsruby 0.0.11 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5181c11e5791e9e519d8324fb2b8a72843db339af9f0b0dbbd4c6afccf82c31
-  data.tar.gz: cd1618021fa058de8c5b05cf7b2aedd77fb0164de1b11323f708d557be1633af
+  metadata.gz: f33a751deeebf96aa16135763365063f9facdd95c2cd7e7df7de0e3e90bea56b
+  data.tar.gz: f24d9c9901986b83ce38ffd97d5ef9f06c2409ae3b24de85094a73b78f39dbc4
 SHA512:
-  metadata.gz: 79e7dc3122317674dc25526ac2957aaad06a36243ab3d611989582a1150782b2872d8662d8091191337511ecac8d51749d74106e6e26fd2e1768de829a2cc07d
-  data.tar.gz: 02c6ce66e34dfa331ce5b8b77055debf027a39e4ed1d802a95a557bc86eb2b11abff778725dc1fb7d3251497c254ad3249406a90f65f0860dfdce709966bcc7f
+  metadata.gz: 1d8d10e392c06bb956d2c889e3090afce100ae4b9ef27a2a8463da231d5d00c645890b82376656bc7f17cdc33f248d49f8dd274ac341a7e60fdaf76d8a3d8496
+  data.tar.gz: caf7c237fb87e4e04d842593fb7cb23d7d65b4494a373cd59fb5fc775a48dbe6c71a7cd86fbfa2d2efc93b338994079f26b9f406f47390cdad52d352476e1846

data/README.md

@@ -39,6 +39,102 @@ CLIPS::Environment.batch_star(env, "./my-batch.bat")
 env.batch_star("./my-batch.bat")
 ```
 
+### `CLIPS::Environment.save`
+### `env.save`
+
+Pass the path in which we'll save the environment constructs.
+
+```ruby
+CLIPS::Environment.save(env, "./my-save.bin")
+env.save("./my-save.bin")
+```
+
+### `CLIPS::Environment.load`
+### `env.load`
+
+Pass the path to a file that will load the constructs stored in the file
+into the environment. Remember to `reset` the environment if you need.
+
+```ruby
+CLIPS::Environment.load(env, "./my-load.bin")
+env.load("./my-load.bin")
+```
+
+### `CLIPS::Environment.save_facts`
+### `env.save_facts`
+
+Pass the path in which we'll save the environment facts.
+The third argument is optional, and determines whether to store the visible or local facts.
+By default, it'll store local.
+
+```ruby
+CLIPS::Environment.save_facts(env, "./my-save-facts.bin")
+env.save_facts("./my-save-facts.bin")
+CLIPS::Environment.save_facts(env, "./my-save-facts.bin", :local)
+env.save_facts("./my-save-facts.bin", :local)
+CLIPS::Environment.save_facts(env, "./my-save-facts.bin", :visible)
+env.save_facts("./my-save-facts.bin", :visible)
+```
+
+### `CLIPS::Environment.load_facts`
+### `env.load_facts`
+
+Pass the path to a file that will load the facts stored in the file
+into the environment.
+
+```ruby
+CLIPS::Environment.load_facts(env, "./my-load-facts.bin")
+env.load_facts("./my-load-facts.bin")
+```
+
+### `CLIPS::Environment.bsave`
+### `env.bsave`
+
+Pass the path in which we'll save the binary representation of the environment constructs.
+
+```ruby
+CLIPS::Environment.bsave(env, "./my-bsave.bin")
+env.bsave("./my-bsave.bin")
+```
+
+### `CLIPS::Environment.bload`
+### `env.bload`
+
+Pass the path to a binary file that will load the constructs stored in the file
+into the environment. Remember to `reset` the environment if you need.
+
+```ruby
+CLIPS::Environment.bload(env, "./my-bload.bin")
+env.bload("./my-bload.bin")
+```
+
+### `CLIPS::Environment.bsave_facts`
+### `env.bsave_facts`
+
+Pass the path in which we'll save the binary representation of the environment facts.
+The third argument is optional, and determines whether to store the visible or local facts.
+By default, it'll store local.
+
+```ruby
+CLIPS::Environment.bsave_facts(env, "./my-bsave-facts.bin")
+env.bsave_facts("./my-bsave-facts.bin")
+CLIPS::Environment.bsave_facts(env, "./my-bsave-facts.bin", :local)
+env.bsave_facts("./my-bsave-facts.bin", :local)
+CLIPS::Environment.bsave_facts(env, "./my-bsave-facts.bin", :visible)
+env.bsave_facts("./my-bsave-facts.bin", :visible)
+```
+
+### `CLIPS::Environment.bload_facts`
+### `env.bload_facts`
+
+Pass the path to a binary file that will load the facts stored in the file
+into the environment.
+
+```ruby
+CLIPS::Environment.bload_facts(env, "./my-bload-facts.bin")
+env.bload_facts("./my-bload-facts.bin")
+```
+
 ### `CLIPS::Environment.assert_string`
 ### `CLIPS::Environment#assert_string`
 
@@ -59,6 +155,19 @@ fact = CLIPS::Environment.assert_hash(env, :my_deftemplate, a: 1, b: "asdf", c:
 fact2 = env.assert_hash(:my_deftemplate, d: 4.5, e: :asdf)
 ```
 
+### `CLIPS::Environment.find_fact`
+### `CLIPS::Environment#find_fact`
+
+A light wrapper around the CLIPS find-fact function. Accepts a fact set template and query,
+returns the first Facts in the environment that match as Ruby objects.
+
+```ruby
+CLIPS::Environment.find_facts(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)")
+```
+
 ### `CLIPS::Environment.find_all_facts`
 ### `CLIPS::Environment#find_all_facts`
 
@@ -167,6 +276,16 @@ CLIPS::Environment::Fact.to_h(fact)
 fact.to_h
 ```
 
+### `CLIPS::Environment::Fact.index`
+### `CLIPS::Environment::Fact#index`
+
+Returns the index of the fact in working memory
+
+```ruby
+CLIPS::Environment::Fact.index(fact)
+fact.index
+```
+
 ### `CLIPS::Environment::Fact.deftemplate_name`
 ### `CLIPS::Environment::Fact#deftemplate_name`
 

data/ext/clipsruby/clipsruby.c

@@ -642,6 +642,32 @@ static VALUE clips_environment_static_eval(VALUE self, VALUE rbEnvironment, VALU
 	return clips_environment_eval(rbEnvironment, string);
 }
 
+static VALUE clips_environment_find_fact(int argc, VALUE *argv, VALUE environment) {
+	VALUE fact_set_template, query;
+
+	rb_scan_args(argc, argv, "11", &fact_set_template, &query);
+	if (NIL_P(query)) {
+		query = rb_str_new_cstr("TRUE");
+	}
+
+	return clips_environment_eval(
+		environment,
+		rb_sprintf("(find-fact (%s) %s)", StringValueCStr(fact_set_template), StringValueCStr(query)));
+}
+
+static VALUE clips_environment_static_find_fact(int argc, VALUE *argv, VALUE klass) {
+	VALUE rbEnvironment, fact_set_template, query;
+
+	rb_scan_args(argc, argv, "21", &rbEnvironment, &fact_set_template, &query);
+	if (NIL_P(query)) {
+		query = rb_str_new_cstr("TRUE");
+	}
+
+	return clips_environment_eval(
+		rbEnvironment,
+		rb_sprintf("(find-fact (%s) %s)", StringValueCStr(fact_set_template), StringValueCStr(query)));
+}
+
 static VALUE clips_environment_find_all_facts(int argc, VALUE *argv, VALUE environment) {
 	VALUE fact_set_template, query;
 
@@ -747,6 +773,222 @@ static VALUE clips_environment_static_reset(VALUE self, VALUE rbEnvironment)
 	return clips_environment_reset(rbEnvironment);
 }
 
+static VALUE clips_environment_save(VALUE self, VALUE path)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	if (Save(env, StringValueCStr(path))) {
+		return Qtrue;
+	} else {
+		return Qfalse;
+	}
+}
+
+static VALUE clips_environment_static_save(VALUE self, VALUE rbEnvironment, VALUE path)
+{
+	return clips_environment_save(rbEnvironment, path);
+}
+
+static VALUE clips_environment_load(VALUE self, VALUE path)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	switch (Load(env, StringValueCStr(path)))
+	{
+		case LE_NO_ERROR:
+			break;
+		case LE_OPEN_FILE_ERROR:
+			rb_warn("could not load: issue opening file.");
+			return Qnil;
+		case LE_PARSING_ERROR:
+			rb_warn("could not load: parsing issue.");
+			return Qnil;
+	}
+	return Qtrue;
+}
+
+static VALUE clips_environment_static_load(VALUE self, VALUE rbEnvironment, VALUE path)
+{
+	return clips_environment_load(rbEnvironment, path);
+}
+
+static VALUE clips_environment_save_facts(int argc, VALUE *argv, VALUE rbEnvironment) {
+	VALUE path, scope;
+	Environment *env;
+
+	TypedData_Get_Struct(rbEnvironment, Environment, &Environment_type, env);
+
+	rb_scan_args(argc, argv, "11", &path, &scope);
+	if (NIL_P(scope)) {
+		scope = ID2SYM(rb_intern("local"));
+	}
+
+	int number_of_facts_saved;
+
+	if (scope == ID2SYM(rb_intern("visible"))) {
+		number_of_facts_saved = SaveFacts(env, StringValueCStr(path), VISIBLE_SAVE);
+	} else if (scope == ID2SYM(rb_intern("local"))) {
+		number_of_facts_saved = SaveFacts(env, StringValueCStr(path), LOCAL_SAVE);
+	} else {
+		rb_warn("could not bsave_facts: unsupported scope.");
+		return Qnil;
+	}
+	return INT2NUM(number_of_facts_saved);
+}
+
+static VALUE clips_environment_static_save_facts(int argc, VALUE *argv, VALUE klass) {
+	VALUE rbEnvironment, path, scope;
+	Environment *env;
+
+	rb_scan_args(argc, argv, "21", &rbEnvironment, &path, &scope);
+
+	TypedData_Get_Struct(rbEnvironment, Environment, &Environment_type, env);
+
+	if (NIL_P(scope)) {
+		scope = ID2SYM(rb_intern("local"));
+	}
+
+	int number_of_facts_saved;
+
+	if (scope == ID2SYM(rb_intern("visible"))) {
+		number_of_facts_saved = SaveFacts(env, StringValueCStr(path), VISIBLE_SAVE);
+	} else if (scope == ID2SYM(rb_intern("local"))) {
+		number_of_facts_saved = SaveFacts(env, StringValueCStr(path), LOCAL_SAVE);
+	} else {
+		rb_warn("could not bsave_facts: unsupported scope.");
+		return Qnil;
+	}
+	return INT2NUM(number_of_facts_saved);
+}
+
+static VALUE clips_environment_load_facts(VALUE self, VALUE path)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+	int number_of_facts_loaded = LoadFacts(env, StringValueCStr(path));
+
+	if (number_of_facts_loaded == -1) {
+		return Qnil;
+	} else {
+		return INT2NUM(number_of_facts_loaded);
+	}
+}
+
+static VALUE clips_environment_static_load_facts(VALUE self, VALUE rbEnvironment, VALUE path)
+{
+	return clips_environment_load_facts(rbEnvironment, path);
+}
+
+static VALUE clips_environment_bsave(VALUE self, VALUE path)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	if (Bsave(env, StringValueCStr(path))) {
+		return Qtrue;
+	} else {
+		return Qfalse;
+	}
+}
+
+static VALUE clips_environment_static_bsave(VALUE self, VALUE rbEnvironment, VALUE path)
+{
+	return clips_environment_bsave(rbEnvironment, path);
+}
+
+static VALUE clips_environment_bload(VALUE self, VALUE path)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	if (Bload(env, StringValueCStr(path))) {
+		return Qtrue;
+	} else {
+		return Qfalse;
+	}
+}
+
+static VALUE clips_environment_static_bload(VALUE self, VALUE rbEnvironment, VALUE path)
+{
+	return clips_environment_bload(rbEnvironment, path);
+}
+
+static VALUE clips_environment_bsave_facts(int argc, VALUE *argv, VALUE rbEnvironment) {
+	VALUE path, scope;
+	Environment *env;
+
+	TypedData_Get_Struct(rbEnvironment, Environment, &Environment_type, env);
+
+	rb_scan_args(argc, argv, "11", &path, &scope);
+	if (NIL_P(scope)) {
+		scope = ID2SYM(rb_intern("local"));
+	}
+
+	int number_of_facts_saved;
+
+	if (scope == ID2SYM(rb_intern("visible"))) {
+		number_of_facts_saved = BinarySaveFacts(env, StringValueCStr(path), VISIBLE_SAVE);
+	} else if (scope == ID2SYM(rb_intern("local"))) {
+		number_of_facts_saved = BinarySaveFacts(env, StringValueCStr(path), LOCAL_SAVE);
+	} else {
+		rb_warn("could not bsave_facts: unsupported scope.");
+		return Qnil;
+	}
+
+	return INT2NUM(number_of_facts_saved);
+}
+
+static VALUE clips_environment_static_bsave_facts(int argc, VALUE *argv, VALUE klass) {
+	VALUE rbEnvironment, path, scope;
+	Environment *env;
+
+	rb_scan_args(argc, argv, "21", &rbEnvironment, &path, &scope);
+
+	TypedData_Get_Struct(rbEnvironment, Environment, &Environment_type, env);
+
+	if (NIL_P(scope)) {
+		scope = ID2SYM(rb_intern("local"));
+	}
+
+	int number_of_facts_saved;
+
+	if (scope == ID2SYM(rb_intern("visible"))) {
+		number_of_facts_saved = BinarySaveFacts(env, StringValueCStr(path), VISIBLE_SAVE);
+	} else if (scope == ID2SYM(rb_intern("local"))) {
+		number_of_facts_saved = BinarySaveFacts(env, StringValueCStr(path), LOCAL_SAVE);
+	} else {
+		rb_warn("could not bsave_facts: unsupported scope.");
+		return Qnil;
+	}
+	return INT2NUM(number_of_facts_saved);
+}
+
+static VALUE clips_environment_bload_facts(VALUE self, VALUE path)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+	int number_of_facts_loaded = BinaryLoadFacts(env, StringValueCStr(path));
+
+	if (number_of_facts_loaded == -1) {
+		return Qnil;
+	} else {
+		return INT2NUM(number_of_facts_loaded);
+	}
+}
+
+static VALUE clips_environment_static_bload_facts(VALUE self, VALUE rbEnvironment, VALUE path)
+{
+	return clips_environment_bload_facts(rbEnvironment, path);
+}
+
 static VALUE clips_environment_fact_slot_names(VALUE self)
 {
 	Fact *fact;
@@ -911,6 +1153,20 @@ static VALUE clips_environment_fact_static_modify(VALUE self, VALUE rbFact, VALU
 	return clips_environment_fact_modify(rbFact, hash);
 }
 
+static VALUE clips_environment_fact_index(VALUE self)
+{
+	Fact *fact;
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+
+	return INT2NUM(FactIndex(fact));
+}
+
+static VALUE clips_environment_fact_static_index(VALUE self, VALUE rbFact)
+{
+	return clips_environment_fact_index(rbFact);
+}
+
 
 void Init_clipsruby(void)
 {
@@ -933,6 +1189,8 @@ void Init_clipsruby(void)
 	rb_define_method(rbEnvironment, "run", clips_environment_run, -1);
 	rb_define_singleton_method(rbEnvironment, "_eval", clips_environment_static_eval, 2);
 	rb_define_method(rbEnvironment, "_eval", clips_environment_eval, 1);
+	rb_define_singleton_method(rbEnvironment, "find_fact", clips_environment_static_find_fact, -1);
+	rb_define_method(rbEnvironment, "find_fact", clips_environment_find_fact, -1);
 	rb_define_singleton_method(rbEnvironment, "find_all_facts", clips_environment_static_find_all_facts, -1);
 	rb_define_method(rbEnvironment, "find_all_facts", clips_environment_find_all_facts, -1);
 	rb_define_singleton_method(rbEnvironment, "batch_star", clips_environment_static_batch_star, 2);
@@ -941,6 +1199,22 @@ void Init_clipsruby(void)
 	rb_define_method(rbEnvironment, "clear", clips_environment_clear, 0);
 	rb_define_singleton_method(rbEnvironment, "reset", clips_environment_static_reset, 1);
 	rb_define_method(rbEnvironment, "reset", clips_environment_reset, 0);
+	rb_define_singleton_method(rbEnvironment, "save", clips_environment_static_save, 2);
+	rb_define_method(rbEnvironment, "save", clips_environment_save, 1);
+	rb_define_singleton_method(rbEnvironment, "load", clips_environment_static_load, 2);
+	rb_define_method(rbEnvironment, "load", clips_environment_load, 1);
+	rb_define_singleton_method(rbEnvironment, "save_facts", clips_environment_static_save_facts, -1);
+	rb_define_method(rbEnvironment, "save_facts", clips_environment_save_facts, -1);
+	rb_define_singleton_method(rbEnvironment, "load_facts", clips_environment_static_load_facts, 2);
+	rb_define_method(rbEnvironment, "load_facts", clips_environment_load_facts, 1);
+	rb_define_singleton_method(rbEnvironment, "bsave", clips_environment_static_bsave, 2);
+	rb_define_method(rbEnvironment, "bsave", clips_environment_bsave, 1);
+	rb_define_singleton_method(rbEnvironment, "bload", clips_environment_static_bload, 2);
+	rb_define_method(rbEnvironment, "bload", clips_environment_bload, 1);
+	rb_define_singleton_method(rbEnvironment, "bsave_facts", clips_environment_static_bsave_facts, -1);
+	rb_define_method(rbEnvironment, "bsave_facts", clips_environment_bsave_facts, -1);
+	rb_define_singleton_method(rbEnvironment, "bload_facts", clips_environment_static_bload_facts, 2);
+	rb_define_method(rbEnvironment, "bload_facts", clips_environment_bload_facts, 1);
 
 	VALUE rbFact = rb_define_class_under(rbEnvironment, "Fact", rb_cObject);
 	rb_define_singleton_method(rbFact, "deftemplate_name", clips_environment_fact_static_deftemplate_name, 1);
@@ -955,6 +1229,8 @@ void Init_clipsruby(void)
 	rb_define_method(rbFact, "retract", clips_environment_fact_retract, 0);
 	rb_define_singleton_method(rbFact, "modify", clips_environment_fact_static_modify, 2);
 	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);
 
 	VALUE rbInstance = rb_define_class_under(rbEnvironment, "Instance", rb_cObject);
 }

metadata

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