clipsruby 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e97c3ac1ef91f6eace7ed6f45290fd832c3bf5cf862f0da15bf0c4efd59d3b7
-  data.tar.gz: f33b1fd96f3e2c505e47e23cea1a3244bb50f345382f44ad52f88ef409008c77
+  metadata.gz: 829a0ce02dc7dbe02fb75f5f3324b001240ae4a742de842c95067291481b7b85
+  data.tar.gz: d258273d013a710125000c07a3cfad654e22a81fe300c222e0d34b8fd805e1ff
 SHA512:
-  metadata.gz: a933862a2f9d59f2efcbdeb3c67c7fb9d0f1b87467a56ed8e8a38d91954a79acbbde5a997b111161444128a891f25d272c6941bf65e688415875147748b427a3
-  data.tar.gz: 17cc9ec2838a396877c30da3201bdf4c9641d13a918555bc2e46f0ec6531983802377a079d529f063ee27ae4d9ef27e47ae734e82eecbdfcf27e6c4cf93b85d1
+  metadata.gz: 30b76872939a39ca16c17f130db788c4aa55cadd7fd2d1ee07e28e1f0daba2d406ff431472f2e666bbe20083703dfc0e78ade13af51fbc0cd2fb9a40e2c7dac7
+  data.tar.gz: d0c18d5c756b9318682276aac714721ae2c5c7160324880985cd3e65619086e9ca9f5498c93c65101f19e80038aae7c25bc0f44fe33c3eef2dde55c090608008

data/README.md

@@ -39,6 +39,54 @@ CLIPS::Environment.batch_star(env, "./my-batch.bat")
 env.batch_star("./my-batch.bat")
 ```
 
+### `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(env, "./my-bsave-facts.bin")
+env.bsave("./my-bsave-facts.bin")
+CLIPS::Environment.bsave(env, "./my-bsave-facts.bin", :local)
+env.bsave("./my-bsave-facts.bin", :local)
+CLIPS::Environment.bsave(env, "./my-bsave-facts.bin", :visible)
+env.bsave("./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(env, "./my-bload-facts.bin")
+env.bload("./my-bload-facts.bin")
+```
+
 ### `CLIPS::Environment.assert_string`
 ### `CLIPS::Environment#assert_string`
 
@@ -208,6 +256,17 @@ CLIPS::Environment::Fact.retract(fact)
 fact.retract
 ```
 
+### `CLIPS::Environment::Fact.modify`
+### `CLIPS::Environment::Fact#modify`
+
+Modifies a non-implicit deftemplate fact from the environment.
+Will not work with non-deftemplate facts!
+
+```ruby
+CLIPS::Environment::Fact.modify(fact, bar: 123)
+fact.modify(foo: "my new foo!")
+```
+
 ## Running the tests
 
 Simply do `rake compile` and then `rake test` in order to run the tests.

data/ext/clipsruby/clipsruby.c

@@ -747,6 +747,107 @@ static VALUE clips_environment_static_reset(VALUE self, VALUE rbEnvironment)
 	return clips_environment_reset(rbEnvironment);
 }
 
+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"));
+	}
+
+	if (scope == ID2SYM(rb_intern("visible"))) {
+		return INT2NUM(BinarySaveFacts(env, StringValueCStr(path), VISIBLE_SAVE));
+	} else if (scope == ID2SYM(rb_intern("local"))) {
+		return INT2NUM(BinarySaveFacts(env, StringValueCStr(path), LOCAL_SAVE));
+	} else {
+		rb_warn("could not bsave_facts: unsupported scope.");
+		return Qnil;
+	}
+}
+
+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;
@@ -829,6 +930,103 @@ static VALUE clips_environment_fact_static_retract(VALUE self, VALUE rbFact)
 	return clips_environment_fact_retract(rbFact);
 }
 
+static int _clips_environment_fact_modify(VALUE key, VALUE value, VALUE args)
+{
+	const char *cslot_name;
+	switch(TYPE(key))
+	{
+		case T_SYMBOL:
+			cslot_name = rb_id2name(SYM2ID(key));
+			break;
+		case T_STRING:
+			cslot_name = StringValueCStr(key);
+			break;
+		default:
+			rb_raise(rb_eTypeError, "Slot name must be a String or a Symbol");
+			return ST_CONTINUE;
+	}
+
+	VALUE *fm_and_env = (VALUE*)args;
+	FactModifier *fm = (FactModifier*) fm_and_env[0];
+	Environment *env = (Environment*) fm_and_env[1];
+	CLIPSValue cv = VALUE_to_CLIPSValue(value, env);
+	handle_pse_error(FMPutSlot(fm, cslot_name, &cv), cslot_name);
+
+	return ST_CONTINUE;
+}
+
+static VALUE clips_environment_fact_modify(VALUE self, VALUE hash)
+{
+	Fact *fact;
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+
+	VALUE rbEnvironment = rb_iv_get(self, "@environment");
+	Environment *env;
+	TypedData_Get_Struct(rbEnvironment, Environment, &Environment_type, env);
+
+	FactModifier *fm = CreateFactModifier(env, fact);
+	switch (FMError(env))
+	{
+		case FME_NO_ERROR:
+			break;
+		case FME_RETRACTED_ERROR:
+			rb_warn("Could not modify fact; fact is retracted!");
+			return Qnil;
+		case FME_IMPLIED_DEFTEMPLATE_ERROR:
+			rb_warn("Could not modify fact; cannot use modify to modify non-deftemplated facts!");
+			return Qnil;
+	}
+	void *args[2] = { (void *)fm, (void *)env };
+	rb_hash_foreach(hash, _clips_environment_fact_modify, (VALUE)args);
+	Fact *modified_fact = FMModify(fm);
+	FMDispose(fm);
+
+	switch (FMError(env))
+	{
+		case FME_NO_ERROR:
+			break;
+		case FME_NULL_POINTER_ERROR:
+			rb_warn("Could not modify fact. This might be a bug in clipsruby!");
+			return Qnil;
+		case FME_RETRACTED_ERROR:
+			rb_warn("Could not modify fact; fact is retracted!");
+			return Qnil;
+		case FME_COULD_NOT_MODIFY_ERROR:
+			rb_warn("Could not modify fact. Pattern matching of a fact or instance is already occurring.");
+			return Qnil;
+		case FME_RULE_NETWORK_ERROR:
+			rb_warn("Could not modify fact. An error occurs while the assertion was being processed in the rule network.");
+			return Qnil;
+	}
+
+	VALUE rb_fact =
+		TypedData_Wrap_Struct(CLASS_OF(self), &Fact_type, modified_fact);
+
+	rb_iv_set(rb_fact, "@environment", rbEnvironment);
+
+	return rb_fact;
+}
+
+static VALUE clips_environment_fact_static_modify(VALUE self, VALUE rbFact, VALUE hash)
+{
+	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)
 {
 	VALUE rbCLIPS = rb_define_module("CLIPS");
@@ -858,6 +1056,14 @@ 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, "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);
@@ -870,6 +1076,10 @@ void Init_clipsruby(void)
 	rb_define_method(rbFact, "get_slot", clips_environment_fact_get_slot, 1);
 	rb_define_singleton_method(rbFact, "retract", clips_environment_fact_static_retract, 1);
 	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.10
+  version: 0.0.12
 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