Swicli.Library
cliLoadAssembly('SwiPlCs.dll').
cliLoadAssembly('Cogbot.exe').
?- cliAddAssemblySearchPath('.').
cliRemoveAssemblySearchPath('.').
[] = 'Item'
This after the SwiPrologDir and IKVMHome is set up will update the environment
?- cliNew('java.lang.Long',[long],[44],Out),cliToString(Out,Str).
Returns the Type when denoated by a 'namespace.type' (usefull for static instance specification)
if a @C#234234 the type of the object unless its a a class
c(a) => System.Char "sdfsdf" => System.String uint(5) => System.UInt32
instanceMaybe maybe Null.. it is passed in so the method code doesn't have to call GetInstance again
on classOrInstance
this is just stuffed with a random MethodInfo
0 = SetValue
1 = Count
2 = add/append
3 = GetValue
4 = removeValue
5 = removeAll
6 = cliAddElementGeneric
7 = cliSetElementGeneric
Retreves the ClazzSpec Fields and Properties into a MemberSpecList
Retreves the clazzOrInstance Members into MemberSpec List
used by cli_memb/2
=Attempt to find assembly doc of member
?- cliNewArray(long,10,Out),cliToString(Out,Str).
10 or [10] or [10,2]
Tagged ref to the array
Construct an array of some type
The parent array type .. not the Element type
This finds things like op_Implicit/op_Explicition to
This is no longer needed since we use atom GC (maybe)
FIX ME!!
1 ?- cliToString(-1,X).
X = "4294967295".
?- current_bot(Obj),cli_add_event_handler(Obj,'EachSimEvent',c(A,format(user_error,'EV = ~q.~n',[A])),Out).
Create a Event Handler with a ResetEvent
Add another event to be waited on
Block until ResetEvent occures and run the prolog code.. if it fails.. wait again for the reset event
if over maxTime return time_limit_exceeded
THIS IS ALL @TODO
Creates one constructor for each public constructor in the base class. Each constructor simply
forwards its arguments to the base constructor, and matches the base constructor's signature.
Supports optional values, and custom attributes on constructors and parameters.
Does not support n-ary (variadic) constructors
the .Net process (Not OS)
The OS and not the .Net process
therefore "Program Files" are either for 64bit or 32bit apps
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
2
Advances the enumerator to the next element of the collection.
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
The collection was modified after the enumerator was created.
2
Sets the enumerator to its initial position, which is before the first element in the collection.
The collection was modified after the enumerator was created.
2
Gets the element in the collection at the current position of the enumerator.
The element in the collection at the current position of the enumerator.
Gets the current element in the collection.
The current element in the collection.
The enumerator is positioned before the first element of the collection or after the last element.
2
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
1
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
2
Advances the enumerator to the next element of the collection.
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
The collection was modified after the enumerator was created.
2
Sets the enumerator to its initial position, which is before the first element in the collection.
The collection was modified after the enumerator was created.
2
Gets the element in the collection at the current position of the enumerator.
The element in the collection at the current position of the enumerator.
Gets the current element in the collection.
The current element in the collection.
The enumerator is positioned before the first element of the collection or after the last element.
2
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
2
Adds an item to the .
The object to add to the .
The is read-only.
Removes all items from the .
The is read-only.
Determines whether the contains a specific value.
true if is found in the ; otherwise, false.
The object to locate in the .
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in at which copying begins.
is null.
is less than 0.
is multidimensional.
-or-
is equal to or greater than the length of .
-or-
The number of elements in the source is greater than the available space from to the end of the destination .
-or-
Type cannot be cast automatically to the type of the destination .
Removes the first occurrence of a specific object from the .
true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original .
The object to remove from the .
The is read-only.
Gets the number of elements contained in the .
The number of elements contained in the .
Gets a value indicating whether the is read-only.
true if the is read-only; otherwise, false.
Determines whether the contains an element with the specified key.
true if the contains an element with the key; otherwise, false.
The key to locate in the .
is null.
Adds an element with the provided key and value to the .
The object to use as the key of the element to add.
The object to use as the value of the element to add.
is null.
An element with the same key already exists in the .
The is read-only.
Removes the element with the specified key from the .
true if the element is successfully removed; otherwise, false. This method also returns false if was not found in the original .
The key of the element to remove.
is null.
The is read-only.
Gets the value associated with the specified key.
true if the object that implements contains an element with the specified key; otherwise, false.
The key whose value to get.
When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the parameter. This parameter is passed uninitialized.
is null.
Gets or sets the element with the specified key.
The element with the specified key.
The key of the element to get or set.
is null.
The property is retrieved and is not found.
The property is set and the is read-only.
Gets an containing the keys of the .
An containing the keys of the object that implements .
Gets an containing the values in the .
An containing the values in the object that implements .
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in at which copying begins.
is null.
is less than zero.
is multidimensional.
-or-
is equal to or greater than the length of .
-or-
The number of elements in the source is greater than the available space from to the end of the destination .
The type of the source cannot be cast automatically to the type of the destination .
2
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
2
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
2
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
2
Advances the enumerator to the next element of the collection.
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
The collection was modified after the enumerator was created.
2
Sets the enumerator to its initial position, which is before the first element in the collection.
The collection was modified after the enumerator was created.
2
Gets the element in the collection at the current position of the enumerator.
The element in the collection at the current position of the enumerator.
Gets the current element in the collection.
The current element in the collection.
The enumerator is positioned before the first element of the collection or after the last element.
2
?- closure(v(V1,V2),format('I was called with ~q ~q ...',[V1,V2]).
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
2
Same as Queue except Dequeue function blocks until there is an object to return.
Note: This class does not need to be synchronized
Create new BlockingQueue.
The System.Collections.ICollection to copy elements from
Create new BlockingQueue.
The initial number of elements that the queue can contain
Create new BlockingQueue.
BlockingQueue Destructor (Close queue, resume any waiting thread).
Remove all objects from the Queue.
Remove all objects from the Queue, resume all dequeue threads.
Removes and returns the object at the beginning of the Queue.
Object in queue.
Removes and returns the object at the beginning of the Queue.
time to wait before returning
Object in queue.
Removes and returns the object at the beginning of the Queue.
time to wait before returning (in milliseconds)
Object in queue.
Adds an object to the end of the Queue
Object to put in queue
Open Queue.
Gets flag indicating if queue has been closed.
prolog predicate arity (invokeMethod.IsStatic ? 0 : 1) + ParamArity + (IsVoid ? 0 : 1);
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
2
Design By Contract Checks.
Each method generates an exception or
a trace assertion statement if the contract is broken.
This example shows how to call the Require method.
public void Test(int x)
{
try
{
Check.Require(x > 1, "x must be > 1");
}
catch (System.Exception ex)
{
PrologCLR.ConsoleTrace(ex.ToString());
}
}
You can direct output to a Trace listener. For example, you could insert
Trace.Cogbot.Clear();
Trace.Cogbot.Add(new TextWriterTraceListener(Console.Out));
or direct output to a file or the Event Log.
(Note: For ASP.NET clients use the Cogbot collection
of the Debug, not the Trace, object and, for a Release build, only exception-handling
is possible.)
Precondition check - should run regardless of preprocessor directives.
Precondition check - should run regardless of preprocessor directives.
Precondition check - should run regardless of preprocessor directives.
Postcondition check.
Postcondition check.
Postcondition check.
Invariant check.
Invariant check.
Invariant check.
Assertion check.
Assertion check.
Assertion check.
Set this if you wish to use Trace Assert statements
instead of exception handling.
(The Check class uses exception handling by default.)
Is exception handling being used?
Exception raised when a contract is broken.
Catch this exception type if you wish to differentiate between
any DesignByContract exception and other runtime exceptions.
Exception raised when a precondition fails.
Precondition Exception.
Precondition Exception.
Precondition Exception.
Exception raised when a postcondition fails.
Postcondition Exception.
Postcondition Exception.
Postcondition Exception.
Exception raised when an invariant fails.
Invariant Exception.
Invariant Exception.
Invariant Exception.
Exception raised when an assertion fails.
Assertion Exception.
Assertion Exception.
Assertion Exception.
These are the namespace comments for SbsSW.SwiPlCs.Exceptions.
The namespace SbsSW.SwiPlCs.Exceptions provides the Exception classes to catch a prolog exception
see SWI-Prolog Manual - 4.9 ISO compliant Exception handling
Prolog exceptions are mapped to C# exceptions using the subclass PlException of
to represent the Prolog exception term.
All type-conversion functions of the interface raise Prolog-compliant exceptions,
providing decent error-handling support at no extra work for the programmer.
For some commonly used exceptions, subclasses of PlException have been created to exploit
both their constructors for easy creation of these exceptions as well as selective trapping in C#.
Currently, these are and .
To throw an exception, create an instance of PlException and use throw() or cppThrow(). The latter refines the C# exception class according to the represented Prolog exception before calling throw().
This exception is thrown if something in the interface went wrong.
This class is the base class to catch exceptions thrown by prolog in C#.
Query typeDescription
- A static callTo ask prolog for a proof. Return only true or false.
- A To get the first result of a goal
- Construct a PlQuery object by a string.The most convenient way.
- Construct a PlQuery object by compound terms.The most flexible and fast (runtime) way.
For examples see and
The query will be opened by and will be closed if NextSolution() return false.
The List of of this PlQuery.
In the following example you see how the query Variables can be used to set a variable.
Assert.IsTrue(PlQuery.PlCall("is_list", new PlTerm("[a,b,c,d]")));
Assert.IsTrue(PlQuery.PlCall("consult", new PlTerm("some_file_name")));
// or
Assert.IsTrue(PlQuery.PlCall("consult('some_file_name')"));
Create a PlQuery from the arguments, generates the first solution by NextSolution() and destroys the query.
defines the name of the predicate
Is a of arguments for the predicate
Return true or false as the result of NextSolution() or throw an exception.
As but locating the predicate in the named module.
locating the predicate in the named module.
Call a goal once.
Assert.IsTrue(PlQuery.PlCall("is_list([a,b,c,d])"));
Assert.IsTrue(PlQuery.PlCall("consult('some_file_name')"));
The complete goal as a string
NOTE:will be changed in the near future.
return the solution of a query which is called once by call
Throw an ArgumentException if there is no or more than one variable in the goal
a goal with *one* variable
the bound variable of the first solution
The namespace SbsSW.SwiPlCs.Callback provides the delegates to register .NET methods to be
called from SWI-Prolog
It is only possible to call methods
Flags that are responsible for the foreign predicate parameters
0 - PL_FA_NOTHING: no flags.
1 - PL_FA_NOTRACE: Predicate cannot be seen in the tracer.
2 - PL_FA_TRANSPARENT: Predicate is module transparent.
4 - PL_FA_NONDETERMINISTIC: Predicate is non-deterministic. See also PL_retry().
PL_retry()
8 - PL_FA_VARARGS: (Default) Use alternative calling convention. call using t0, ac, ctx
16 - PL_FA_CREF: /* call using t0, ac, ctx */.
/* Internal: ISO core predicate */
PL_EXPORT(void) PL_on_halt(void (*)(int, void *), void *);
typedef void (*PL_abort_hook_t)(void);
See also the example in .
Overview
Prolog variables are dynamically typed and all information is passed around using the
C-interface type term_t witch is an int. In C#, term_t is embedded in the lightweight struct .
Constructors and operator definitions provide flexible operations and integration with important C#-types (string, int and double).
The list below summarises the important classes / struct defined in the C# interface.
class / structShort description
- A static class represents the prolog engine.
- A struct representing prolog data.
- A vector of .
- A class to query Prolog.
Before going into a detailed description of the CSharp classes let me present a few examples
illustrating the `feel' of the interface. The Assert class in the sample is from the test framework
and has nothing to do with the interface. It shows only which return values are expected.
Creating terms
This very simple example shows the basic creation of a Prolog term and how a Prolog term is converted to C#-data:
PlTerm t1 = new PlTerm("x(A)");
PlTerm t2 = new PlTerm("x(1)");
Assert.IsTrue(t1.Unify(t2));
Assert.AreEqual("x(1)", t1.ToString());
Calling Prolog
This example shows how to make a simple call to prolog.
PlTerm l1 = new PlTerm("[a,b,c,d]");
Assert.IsTrue(PlQuery.PlCall("is_list", l1));
Getting the solutions of a query
This example shows how to obtain all solutions of a prolog query.
takes the name of a predicate and the goal-argument vector as arguments.
From this information it deduces the arity and locates the predicate. the member-function
NextSolution() yields true if there was a solution and false otherwise.
If the goal yielded a Prolog exception it is mapped into a C# exception.
PlQuery q = new PlQuery("member", new PlTermV(new PlTerm("A"), new PlTerm("[a,b,c]")));
while (q.NextSolution())
PrologCLR.ConsoleTrace(s[0].ToString());
There is an other constructor of which simplify the sample above.
PlQuery q = new PlQuery("member(A, [a,b,c])");
foreach (PlTermV s in q.Solutions)
PrologCLR.ConsoleTrace(s[0].ToString());
An other way to get the results is to use to iterate over .
PlQuery q = new PlQuery("member(A, [a,b,c])");
foreach (PlQueryVariables vars in q.SolutionVariables)
PrologCLR.ConsoleTrace(vars["A"].ToString());
It is also possible to get all solutions in a list by .
This could be used to work with LinQ to objects which is really nice. and for further samples.
var results = from n in new PlQuery("member(A, [a,b,c])").ToList() select new {A = n["A"].ToString()};
foreach (var s in results)
PrologCLR.ConsoleTrace(s.A);
Obtain the type of a term, which should be a term returned by one of the other
interface predicates or passed as an argument. The function returns the type of
the Prolog term. The type identifiers are listed below.
see PL_term_type(term_t) in the SWI-Prolog Manual.
In this sample a Prolog variable is created in PlTerm t and the
is checked by his integer representation and his name.
PlTerm t = PlTerm.PlVar();
Assert.AreEqual(1, (int)t.PlType);
Assert.AreEqual(PlType.PlVariable, t.PlType);
0 - PL_UNKNOWN: Undefined
1 - PL_VARIABLE: An unbound variable. The value of term as such is a unique identifier for the variable.
2 - PL_ATOM: A Prolog atom.
3 - PL_INTEGER: A Prolog integer.
4 - PL_FLOAT: A Prolog floating point number.
5 - PL_STRING: A Prolog string.
6 - PL_TERM: A compound term. Note that a list is a compound term ./2.
The PlTerm plays a central role in conversion and operating on Prolog data.
PlTerm implements to support ordering in queries if PlTerm is a List.
Creating a PlTerm can be done by the Constructors or by the following static methods:
PlVar(), PlTail(), PlCompound, PlString(), PlCodeList(), PlCharList() (see remarks)
static methodDescription
- Creates a new initialised term (holding a Prolog variable).
- PlTail is for analysing and constructing lists.
- PlCompound(string)Create compound terms. E.g. by parsing (as read/1) the given text.
- Create a SWI-Prolog string.
- Create a Prolog list of ASCII codes from a 0-terminated C-string.
- Create a Prolog list of one-character atoms from a 0-terminated C-string.
This one should be for checks only e.g.
Check.Require(arg1.TermRefIntern != 0);
If PlTerm is compound and index is between 0 and Arity (including), the nth PlTerm is returned.
If pos is 0 the functor of the term is returned (For a list '.').
See: PL_get_arg/3
To Get the nth PlTerm
a PlTerm
static methodDescription
- Creates a new initialised term (holding a Prolog variable).
- PlTail is for analysing and constructing lists.
- PlCompound(string)Create compound terms. E.g. by parsing (as read/1) the given text.
- Create a SWI-Prolog string.
- Create a Prolog list of ASCII codes from a 0-terminated C-string.
- Create a Prolog list of one-character atoms from a 0-terminated C-string.
Creates a term-references holding a Prolog term representing text.
the text
Creates a term-references holding a Prolog integer representing value.
a integer value
Creates a term-references holding a Prolog float representing value.
a double value
Creates a new initialised term (holding a Prolog variable).
a PlTerm
PlTail is for analysing and constructing lists.
It is called PlTail as enumeration-steps make the term-reference follow the `tail' of the list.
A PlTail is created by making a new term-reference pointing to the same object.
As PlTail is used to enumerate or build a Prolog list, the initial list
term-reference keeps pointing to the head of the list.
The initial PlTerm
A PlTerm for which is_list/1 succeed.
These static methods creates a new compound .
For an example
Create a term by parsing (as read/1) the text.
If the text is not valid Prolog syntax, a syntax error exception is raised.
Otherwise a new term-reference holding the parsed text is created.
The string representing the compound term parsed by read/1.
a new
Create a compound term with the given name from the given vector of arguments. See for details.
The example below creates the Prolog term hello(world).
PlTerm t = PlTerm.PlCompound("hello", new PlTermv("world"));
The functor (name) of the compound term
the arguments as a
a new
Create a compound term with the given name ant the arguments
The functor (name) of the compound term
The first Argument as a
a new
The second Argument as a
The third Argument as a
A SWI-Prolog string represents a byte-string on the global stack.
It's lifetime is the same as for compound terms and other data living on the global stack.
Strings are not only a compound representation of text that is garbage-collected,
but as they can contain 0-bytes, they can be used to contain arbitrary C-data structures.
the string
a new PlTerm
the length of the string
Create a Prolog list of ASCII codes from a 0-terminated C-string.
The text
a new
These static methods creates a new PlCharList TODO TODO .
Create a Prolog list of one-character atoms from a C#-string.
Character lists are compliant to Prolog's atom_chars/2 predicate.
a string
A new PlTerm containing a prolog list of character
Get the of a .
Return true if is a variable
Return true if is a ground term. See also ground/1. This function is cycle-safe.
Return true if is an atom.
Return true if is an atom.
Return true if is an atom.
Return true if is an atom.
Return true if is an atom.
Return true if is a string.
Return true if is an integer.
Return true if is a float.
Return true if is a compound term. Note that a list is a compound term ./2
Return true if is a compound term with functor ./2 or the atom [].
Return true if is a compound term with functor ./2 or the atom [].
Return true if is atomic (not variable or compound).
Return true if is an integer or float.
Return true if is an empty list or nil.
Appends element to the list and make the PlTail reference point to the new variable tail.
If A is a variable, and this method is called on it using the argument "gnat",
a list of the form [gnat|B] is created and the PlTail object now points to the new variable B.
This method returns TRUE if the unification succeeded and FALSE otherwise. No exceptions are generated.
if (!PlEngine.IsInitialized)
{
String[] empty_param = { "" };
PlEngine.Initialize(empty_param);
// do some funny things ...
PlEngine.PlCleanup();
}
// program ends here
The following sample show how a file is consult via comand-line options.
using SbsSW.SwiPlCs.Callback;
For an example see and .
Register a C# callback method
For an example see and .
a delegate to a c# method
true if registration succeed otherwise false
the name of a prolog module Using Modules
The amount of parameters
The name of the method
To test if the prolog engine is up.
Initialise SWI-Prolog
The write method of the output stream is redirected to
before Initialize. The read method of the input stream just after Initialize.
A known bug: Initialize work *not* as expected if there are e.g. German umlauts in the parameters
See marshalling in the sorce NativeMethods.cs
For a complete parameter description see the SWI-Prolog reference manual section 2.4 Command-line options.
sample parameter: String[] param = { "-q", "-f", @"some\filename" };
At the first position a parameter "" is added in this method. PL_initialise
For an example see
Try a clean up but it is buggy
search the web for "possible regression from pl-5.4.7 to pl-5.6.27" to see reasons
Use this method only at the last call before run program ends
Stops the PlEngine and the program
SWI-Prolog calls internally pl_cleanup and than exit(0)
To Avoid callbackOnCollectedDelegate MDA
To Avoid callbackOnCollectedDelegate MDA
This is a primitive approach to enter the output from a stream.