clipsruby 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ede586e45827a7552e087b61a6f454a0d5c0c779e9d94b34deb2b13d1c7b5846
-  data.tar.gz: d46fdf1c8b9efd85600c976d414d4919ad8cd3c27171d15685f5dc059dd7c1e3
+  metadata.gz: b5181c11e5791e9e519d8324fb2b8a72843db339af9f0b0dbbd4c6afccf82c31
+  data.tar.gz: cd1618021fa058de8c5b05cf7b2aedd77fb0164de1b11323f708d557be1633af
 SHA512:
-  metadata.gz: 7a4ee2975ebcb75e69f6dd5efd2a3c4c3d9b1c31fdd27a1e3fcbc918342d894bcae35cacdfbfd7c3ecdd3535474ccefe456dcc7ff7fb571b7254c4baf78812e1
-  data.tar.gz: 689887738a961e056658085ef49b1aa52de1679a630db22f6ca8e5b57bd562a65e87574f4b1f5dd96a4caf957aad22311f434356d7a5ea59272674a790bd5d58
+  metadata.gz: 79e7dc3122317674dc25526ac2957aaad06a36243ab3d611989582a1150782b2872d8662d8091191337511ecac8d51749d74106e6e26fd2e1768de829a2cc07d
+  data.tar.gz: 02c6ce66e34dfa331ce5b8b77055debf027a39e4ed1d802a95a557bc86eb2b11abff778725dc1fb7d3251497c254ad3249406a90f65f0860dfdce709966bcc7f

data/README.md

@@ -28,6 +28,17 @@ env = CLIPS.create_environment
 env2 = CLIPS::Environment.new
 ```
 
+### `CLIPS::Environment.batch_star`
+### `env.batch_star`
+
+Pass the path to a file that will be "batched" into the environment,
+allowing many CLIPS commands to be entered at once.
+
+```ruby
+CLIPS::Environment.batch_star(env, "./my-batch.bat")
+env.batch_star("./my-batch.bat")
+```
+
 ### `CLIPS::Environment.assert_string`
 ### `CLIPS::Environment#assert_string`
 
@@ -114,6 +125,28 @@ env.run(1)
 env.run
 ```
 
+### `CLIPS::Environment.clear`
+### `CLIPS::Environment#clear`
+
+Removes constructs and data from the environment.
+
+```ruby
+CLIPS::Environment.clear(env)
+env.clear
+```
+
+### `CLIPS::Environment.reset`
+### `CLIPS::Environment#reset`
+
+Removes all facts and instances.
+Creates facts and instances defined in deffacts and definstances constructs.
+Resets the values of global variables in the specified environment.
+
+```ruby
+CLIPS::Environment.reset(env)
+env.reset
+```
+
 ### `CLIPS::Environment.facts`
 ### `CLIPS::Environment#facts`
 
@@ -144,6 +177,48 @@ CLIPS::Environment::Fact.deftemplate_name(fact)
 fact.deftemplate_name
 ```
 
+### `CLIPS::Environment::Fact.slot_names`
+### `CLIPS::Environment::Fact#slot_names`
+
+Returns an array representing the slot names of a fact
+
+```ruby
+CLIPS::Environment::Fact.slot_names(fact)
+fact.slot_names
+```
+
+### `CLIPS::Environment::Fact.get_slot`
+### `CLIPS::Environment::Fact#get_slot`
+
+Gets the value stored in the specified slot of a fact.
+Can either pass a string or symbol for the slot name argument.
+
+```ruby
+CLIPS::Environment::Fact.get_slot(fact, 'bar')
+fact.get_slot(:foo)
+```
+
+### `CLIPS::Environment::Fact.retract`
+### `CLIPS::Environment::Fact#retract`
+
+Retracts a fact from the environment.
+
+```ruby
+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

@@ -290,6 +290,17 @@ static VALUE clips_environment_assert_hash(VALUE self, VALUE deftemplate_name, V
 	TypedData_Get_Struct(self, Environment, &Environment_type, env);
 
 	FactBuilder *fb = CreateFactBuilder(env, cdeftemplate_name);
+	switch (FBError(env))
+	{
+		case FBE_NO_ERROR:
+			break;
+		case FBE_DEFTEMPLATE_NOT_FOUND_ERROR:
+			rb_warn("Could not assert fact; deftemplate not found!");
+			return Qnil;
+		case FBE_IMPLIED_DEFTEMPLATE_ERROR:
+			rb_warn("Could not assert fact; cannot use assert_hash to create non-deftemplated facts!");
+			return Qnil;
+	}
 	void *args[2] = { (void *)fb, (void *)env };
 	rb_hash_foreach(hash, _clips_environment_assert_hash, (VALUE)args);
 	Fact *fact = FBAssert(fb);
@@ -702,6 +713,205 @@ static VALUE clips_environment_static_batch_star(VALUE self, VALUE rbEnvironment
 	return clips_environment_batch_star(rbEnvironment, path);
 }
 
+static VALUE clips_environment_clear(VALUE self)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	if (Clear(env)) {
+		return Qtrue;
+	} else {
+		return Qfalse;
+	}
+}
+
+static VALUE clips_environment_static_clear(VALUE self, VALUE rbEnvironment)
+{
+	return clips_environment_clear(rbEnvironment);
+}
+
+static VALUE clips_environment_reset(VALUE self)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	Reset(env);
+
+	return Qnil;
+}
+
+static VALUE clips_environment_static_reset(VALUE self, VALUE rbEnvironment)
+{
+	return clips_environment_reset(rbEnvironment);
+}
+
+static VALUE clips_environment_fact_slot_names(VALUE self)
+{
+	Fact *fact;
+	CLIPSValue slot_names;
+	VALUE rbEnvironment = rb_iv_get(self, "@environment");
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+
+	FactSlotNames(fact, &slot_names);
+
+	VALUE array;
+
+	CLIPSValue_to_VALUE(&slot_names, &array, &rbEnvironment);
+
+	return array;
+}
+
+static VALUE clips_environment_fact_static_slot_names(VALUE self, VALUE rbFact)
+{
+	return clips_environment_fact_slot_names(rbFact);
+}
+
+static VALUE clips_environment_fact_get_slot(VALUE self, VALUE slot_name)
+{
+	Fact *fact;
+	CLIPSValue slot_value;
+	VALUE rbEnvironment = rb_iv_get(self, "@environment");
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+
+	switch (TYPE(slot_name)) {
+		case T_STRING:
+			GetFactSlot(fact, StringValueCStr(slot_name), &slot_value);
+			break;
+		case T_SYMBOL:
+			GetFactSlot(fact, rb_id2name(SYM2ID(slot_name)), &slot_value);
+			break;
+                default:
+			rb_warn("slot name must be string or symbol in call to get_slot!");
+			return Qnil;
+        }
+
+	VALUE out;
+
+	CLIPSValue_to_VALUE(&slot_value, &out, &rbEnvironment);
+
+	return out;
+}
+
+static VALUE clips_environment_fact_static_get_slot(VALUE self, VALUE rbFact, VALUE slot_name)
+{
+	return clips_environment_fact_get_slot(rbFact, slot_name);
+}
+
+static VALUE clips_environment_fact_retract(VALUE self)
+{
+	Fact *fact;
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+
+	switch (Retract(fact)) {
+		case RE_NO_ERROR:
+			break;
+		case RE_NULL_POINTER_ERROR:
+			rb_warn("could not retract fact; null pointer error. This could be a bug in clipsruby!");
+			return Qfalse;
+		case RE_COULD_NOT_RETRACT_ERROR:
+			rb_warn("could not retract fact! is pattern matching currently happening with this fact?");
+			return Qfalse;
+		case RE_RULE_NETWORK_ERROR:
+			rb_warn("could not retract fact! An error occurs while the retraction was being processed in the rule network");
+			return Qfalse;
+        }
+
+	return Qtrue;
+}
+
+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);
+}
+
+
 void Init_clipsruby(void)
 {
 	VALUE rbCLIPS = rb_define_module("CLIPS");
@@ -727,12 +937,24 @@ void Init_clipsruby(void)
 	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);
 	rb_define_method(rbEnvironment, "batch_star", clips_environment_batch_star, 1);
+	rb_define_singleton_method(rbEnvironment, "clear", clips_environment_static_clear, 1);
+	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);
 
 	VALUE rbFact = rb_define_class_under(rbEnvironment, "Fact", rb_cObject);
 	rb_define_singleton_method(rbFact, "deftemplate_name", clips_environment_fact_static_deftemplate_name, 1);
 	rb_define_method(rbFact, "deftemplate_name", clips_environment_fact_deftemplate_name, 0);
 	rb_define_singleton_method(rbFact, "to_h", clips_environment_fact_static_to_h, 1);
 	rb_define_method(rbFact, "to_h", clips_environment_fact_to_h, 0);
+	rb_define_singleton_method(rbFact, "slot_names", clips_environment_fact_static_slot_names, 1);
+	rb_define_method(rbFact, "slot_names", clips_environment_fact_slot_names, 0);
+	rb_define_singleton_method(rbFact, "get_slot", clips_environment_fact_static_get_slot, 2);
+	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);
 
 	VALUE rbInstance = rb_define_class_under(rbEnvironment, "Instance", rb_cObject);
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clipsruby
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Ryan Johnston