Swi-cs-pl - A CSharp class library to connect .NET ... · The first version of this Interface was...

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-Prolog

SbsSW.SwiPlCs

AbstractThisdocumentdescribesaCSharpinterfacetoSWI-Prolog.ThedescribedinterfaceprovidesalayeraroundtheC-interfacefornaturalprogrammingfromC#.Theinterfacedealswithautomatictype-conversiontoandfromProlog,mappingofexceptionsandmakingqueriestoProloginaneasyway.Thereisacall-backfromPrologtoC#.

IntroductionThefirstversionofthisInterfacewasmoreorlessaportoftheC++interface.Nowthenamingismore'.Net'likeandtheinterfaceprovidesanumberoffeaturesthatmakequeriestoSWI-Prologveryeasyandpowerful.Usingprogrammabletype-conversion(casting),nativedata-typescanbetranslatedautomaticallyintoappropriatePrologtypes.Automaticdestructiondealswithmostofthecleanuprequired.

AcknowledgementsIwouldliketothankJanWielemakerforansweringmanyquestionsandforhiscomments.AlsotoArneSkjærholtforthe64-Bitversion(SwiPlCs64.dll)andBatuAkanfortheMonocode.FouteletJoelprovidetheF#sample.

Downloadbinaries

Hereisthelinktodownloadthelatestbinariesorolderversions.DownloadpageThereisalsoacopyonSWI-PrologTwikipageandSWI-Prologcontribpage.Thelattermightbeoutdated.AtpresentIonlypublishthebinariesincludingthedocumentation.Thesources,whicharenowunderLGPL2,mightbepublishedlater.Ifyouliketoseethemorworkonthemdon'thesitatetocontactmeviamail.

Versions

ThelatestversionworkwithSWI-Prolog6.3.1andhigher.

http://www.swi-prolog.org

http://gollem.swi.psy.uva.nl/twiki/pl/bin/view/Foreign/CSharpInterface

http://www.swi-prolog.org/contrib/CSharp.html

TheAssemblyVersionnumber,e.g.1.1.60301.0,canbeinterpretedasfollows:

1-majorversion

1-minorversion

60301-SWI-Prologversion6.3.1(testcasesrunagainstthisprologversion)

0-patchlevelversion

Gettingstarted

CopySwiPlCs.dllorSwiPlCs64.dllandSwiPlCs.XMLwhereeveryouwantandaddinyourprojectareferencetoSwiPlCs.dll.

AfterthatIntelliSenseandtooltipsshouldbeavailable.

screenshot

Makesurethatlibswipl.dllanditsdependenciescouldbefoundbythesystem.Forthesamplebelowitislibswipl.dllandpthreadVC.dll.Forabigapplicationitcouldbealotmore.

TIP:FordevelopmentaddtheSWI-prologbindirectorytothePATHenvironmentvariable.NOTE:Don'tforgettorestartVisualStudioafterthat.VSmustrecognizethenewenvironmentfordebugging.

BasicallywindowssearchfirstinthefolderwheretheexecutableresistthaninthewindowssystemdirectoryandatleastinthedirectoriesthatarelistedinthePATHenvironmentvariable.Fordetailssee"Dynamic-LinkLibrarySearchOrder"

Iflibswipl.dlloroneofitsdependenciescouldnotfoundyouwillreciveanerrorlikeSystem.IO.FileNotFoundException:DasangegebeneModulwurdenichtgefunden.(AusnahmevonHRESULT:0x8007007E)

http://msdn.microsoft.com/en-us/library/ms682586.aspx

Copy

Anothercommonerroris:SWI-Prolog:[FATALERROR:Couldnotfindsystemresources]Failedtoreleasestacks

TofixthisaddtheSWI_HOME_DIRenvironmentvariableasdescribedinSWI-PrologFAQFindResourceswithastatmentlikethisbeforcallingPlEngine.Initialize.

Environment.SetEnvironmentVariable("SWI_HOME_DIR",

@"the_PATH_to_boot32.prc");

Firstprogram

AsamplesaysmorethenIwanttowritehere.

C#

usingSystem;

usingSbsSW.SwiPlCs;

namespaceHelloWorldDemo

{

classProgram

{

staticvoidMain(string[]args)

{

//Environment.SetEnvironmentVariable("SWI_HOME_DIR",@"the_PATH_to_boot32.prc");

if(!PlEngine.IsInitialized)

{

String[]param={"-q"};//suppressinginformationalandbannermessages

PlEngine.Initialize(param);

PlQuery.PlCall("assert(father(martin,inka))"

PlQuery.PlCall("assert(father(uwe,gloria))"

PlQuery.PlCall("assert(father(uwe,melanie))"

PlQuery.PlCall("assert(father(uwe,ayala))"

using(PlQueryq=newPlQuery("father(P,C),atomic_list_concat([P,'is_father_of',C],L)"

{

http://www.swi-prolog.org/FAQ/FindResources.html

Copy

foreach(PlQueryVariablesvinq.SolutionVariables)

Console.WriteLine(v["L"].ToString());

Console.WriteLine("allchild'sfromuwe:"

q.Variables["P"].Unify("uwe");


Console.WriteLine(v["C"].ToString());

}

PlEngine.PlCleanup();

Console.WriteLine("finshed!");

}

}

}

}

HereishowtousethelibraryinF#.MannythankstoFouteletJoelforthissample.

F#

//LearnmoreaboutF#athttp://fsharp.net

openSystem

openSbsSW.SwiPlCs;

letple=PlEngine.IsInitializedin

ifplethenprintfn"Echecinitialisation"else

begin

PlEngine.Initialize([|"-q"|])

PlQuery.PlCall("assert(father(martin,inka))"



PlQuery.PlCall("assert(father(uwe,ayala))"

letq=newPlQuery"father(P,C),atomic_list_concat([P,'is_father_of',C],L)"

begin

Seq.iter(fun(x:PlQueryVariables)->printfn

printfn"allchild'sfromuwe:"

letr:PlQueryVariables=q.Variables

Seq.iter(fun(x:PlQueryVariables)->printfn

end

PlEngine.PlCleanup()

printfn"%A""finished!"

end

ForfurthersamplesseetheexamplesinSbsSW.SwiPlCsandSbsSW.SwiPlCs.PlEngine.

TheclassSbsSW.SwiPlCs.PlQueryisthekeytoaskSWI-Prologforproofsorsolutions.

TheSbsSW.SwiPlCs.PlTermplaysacentralroleinconversionandoperatingonPrologdata.

KnownBugs

SbsSW.SwiPlCs.PlEngine.Initializework*not*asexpectediftherearee.g.Germanumlautsintheparameterse.g.inthepathorfilenameforaqlffile(switch-x)SeemarshallinginthesourceNativeMethods.cs

byUweLesta,SBS-SoftwaresystemeGmbH

C#SwiPlCsinterface►SbsSW.SwiPlCs

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-

PrologSbsSW.SwiPlCsNamespace

Theonlinedocumentationhomeishere.

ThisnamespaceSbsSW.SwiPlCsprovidesan.NETinterfacetoSWI-Prolog

Overview

PrologvariablesaredynamicallytypedandallinformationispassedaroundusingtheC-interfacetypeterm_twitchisanint.InC#,term_tisembeddedinthelightweightstructPlTerm.ConstructorsandoperatordefinitionsprovideflexibleoperationsandintegrationwithimportantC#-types(string,intanddouble).

Thelistbelowsummarisestheimportantclasses/structdefinedintheC#interface.

class/struct ShortdescriptionPlEngine Astaticclassrepresentstheprologengine.

PlTerm Astructrepresentingprologdata.

PlTermV AvectorofPlTerm.

PlQuery AclasstoqueryProlog.

DeclarationSyntaxC# VisualBasic VisualC++

namespaceSbsSW.SwiPlCs

NamespaceSbsSW.SwiPlCs

namespaceSbsSW.SwiPlCs

http://www.lesta.de/prolog/swiplcs/Generated/Index.aspx


TypesAllTypes Classes Structures Enumerations

Icon Type DescriptionPlEngine Thisstaticclassrepresentstheprolog

engine.

PlFrameTheclassPlFrameprovidesaninterfacetodiscardunusedterm-referencesaswellasrewindingunifications(data-backtracking).Reclaimingunusedterm-referencesisautomaticallyperformedafteracalltoaC#-definedpredicatehasfinishedandreturnscontroltoProlog.InthisscenarioPlFrameisrarelyofanyuse.

ThisclasscomesintoplayifthetoplevelprogramisdefinedinC#andcallsPrologmultipletimes.Settingupargumentstoaqueryrequiresterm-referencesandusingPlFrameistheonlywaytoreclaimthem.

PlQueryThisclassallowsqueriestoprolog.

AquerycanbecreatedbyastringorbyconstructingcompoundtermsseeConstructorsfordetails.

AllresourcesantermscreatedbyaqueryarereclaimedbyDispose().Itisrecommendedtobuildaqueryina

usingscope.

TherearefourpossibleopportunitiestoqueryProlog

Querytype DescriptionAstaticcall Toaskprologfor

aproof.Returnonlytrueorfalse.

APlCallQuery(String)

Togetthefirstresultofagoal

ConstructaPlQueryobjectbyastring.

Themostconvenientway.

ConstructaPlQueryobjectbycompoundterms.

Themostflexibleandfast(runtime)way.

ForexamplesseePlQuery(String)andPlQuery(String,PlTermV)

PlQuerySwitch Flagsthatcontrolfortheforeignpredicateparameters

SWI-PrologManual-9.6.16QueryingProlog.

PlQueryVar RepresentsonevariableofaQueryresult.

PlQueryVariablesRepresentsthesetvariablesofaQueryifitwascreatedfromastring.

http://gollem.science.uva.nl/SWI-Prolog/Manual/foreigninclude.html#PL_query()

ThisclassisalsousedtorepresenttheresultsofaPlQueryafterToList()orSolutionVariableswascalled.

PlTermThePlTermstructplaysacentralroleinconversionandoperatingonPrologdata.

PlTermimplementsIComparabletosupportorderingin[!:System.Linq]queriesifPlTermisaList.

CreatingaPlTermcanbedonebytheConstructorsorbythefollowingstaticmethods:

PlVar(),PlTail(),PlCompound,PlString(),PlCodeList(),PlCharList()(seeremarks)

PlTermV ThisAPIispreliminaryandsubjecttochange.

Thistypeisusedtopasstheargumentstoaforeigndefinedpredicate(seeDelegateParameterVarArgs),constructcompoundterms(seePlCompound(String,PlTermV)andtocreatequeries(seePlQuery).

Theonlyusefulmemberfunctionistheoverloadingof[],providing(0-based)accesstotheelements.Item[Int32]Rangecheckingisperformedand

http://msdn2.microsoft.com/en-us/library/ey2t2ys5

Copy

Copy

raisesaArgumentOutOfRangeExceptionexception.

PlType Obtainthetypeofaterm,whichshouldbeatermreturnedbyoneoftheotherinterfacepredicatesorpassedasanargument.ThefunctionreturnsthetypeofthePrologterm.Thetypeidentifiersarelistedbelow.

Examples

BeforegoingintoadetaileddescriptionoftheCSharpclassesletmepresentafewexamplesillustratingthe`feel'oftheinterface.TheAssertclassinthesampleisfromthetestframeworkandhasnothingtodowiththeinterface.Itshowsonlywhichreturnvaluesareexpected.

Creatingterms

ThisverysimpleexampleshowsthebasiccreationofaPrologtermandhowaPrologtermisconvertedtoC#-data:

C#

PlTermt1=newPlTerm("x(A)");

PlTermt2=newPlTerm("x(1)");

Assert.IsTrue(t1.Unify(t2));

Assert.AreEqual("x(1)",t1.ToString());

CallingProlog

Thisexampleshowshowtomakeasimplecalltoprolog.

C#

Copy

Copy

Copy

PlTerml1=newPlTerm("[a,b,c,d]");

Assert.IsTrue(PlQuery.PlCall("is_list",l1));

Gettingthesolutionsofaquery

Thisexampleshowshowtoobtainallsolutionsofaprologquery.

PlQuerytakesthenameofapredicateandthegoal-argumentvectorasarguments.Fromthisinformationitdeducesthearityandlocatesthepredicate.themember-functionNextSolution()yieldstrueiftherewasasolutionandfalseotherwise.IfthegoalyieldedaPrologexceptionitismappedintoaC#exception.

C#

PlQueryq=newPlQuery("member",newPlTermV(newPlTerm(

while(q.NextSolution())

Console.WriteLine(s[0].ToString());

ThereisanotherconstructorofPlQuerywhichsimplifythesampleabove.

C#

PlQueryq=newPlQuery("member(A,[a,b,c])");

foreach(PlTermVsinq.Solutions)

Console.WriteLine(s[0].ToString());

AnotherwaytogettheresultsistouseSolutionVariablestoiterateoverPlQueryVariables.

C#


foreach(PlQueryVariablesvarsinq.SolutionVariables)

Console.WriteLine(vars["A"].ToString());

ItisalsopossibletogetallsolutionsinalistbyToList().ThiscouldbeusedtoworkwithLinQtoobjectswhichisreallynice.PlQueryand

Copy

ToList()forfurthersamples.

C#

varresults=fromninnewPlQuery("member(A,[a,b,c])"

foreach(varsinresults)

Console.WriteLine(s.A);

byUweLesta,SBS-SoftwaresystemeGmbHSendcommentsonthistopictoLestaatSBS-Softwaresysteme.de

mailto:Lesta%40SBS-Softwaresysteme.de?Subject=Swi-cs-pl - A CSharp class library to connect .NET languages with SWI-Prolog

C#SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlEngineClass

Thisstaticclassrepresentstheprologengine.


publicstaticclassPlEngine

PublicNotInheritableClassPlEngine

publicrefclassPlEngineabstractsealed

MembersAllMembers Methods Properties

PublicProtected

InstanceStatic

Declared

InheritedIcon Member Description

Initialize(String[])InitialiseSWI-Prolog

ThewritemethodoftheoutputstreamisredirectedtoSbsSW.SwiPlCs.StreamsbeforeInitialize.ThereadmethodoftheinputstreamjustafterInitialize.

IsInitialized Totestiftheprologengineisup.

PlCleanup() Tryacleanupbutitisbuggysearchthewebfor"possibleregressionfrompl-5.4.7topl-5.6.27"toseereasons

PlHalt() StopsthePlEngineandtheprogram

PlThreadAttachEngine()return:referencecountoftheengine

Ifanerroroccurs,-1isreturned.

IfthisPrologisnotcompiledformulti-threading,-2isreturned.

PlThreadDestroyEngine() ReturnsTRUEonsuccessandFALSEifthecallingthreadhasnoengineorthisPrologdoesnotsupportthreads.

PlThreadSelf() ReturnstheintegerPrologidentifierofthe

engineor-1ifthecallingthreadhasnoPrologengine.Thismethodisalsoprovidedinthesingle-threadedversionofSWI-Prolog,whereitreturns-2.

RegisterForeign(Delegate)RegisteraC#callbackmethod

RegisterForeign(String,Delegate)RegisteraC#callbackmethod

RegisterForeign(String,Int32,Delegate)RegisteraC#callbackmethod

RegisterForeign(String,String,Int32,Delegate) RegisteraC#callback

method

SetStreamFunctionRead(PlStreamType,DelegateStreamReadFunction)

TODO

SetStreamFunctionWrite(PlStreamType,DelegateStreamWriteFunction)

Thisisaprimitiveapproachtoentertheoutputfromastream.

Copy

Copy

ExamplesAsample

C#

if(!PlEngine.IsInitialized)

{

String[]empty_param={""};

PlEngine.Initialize(empty_param);

//dosomefunnythings...


}

//programendshere

Thefollowingsampleshowhowafileisconsultviacomand-lineoptions.

C#

publicvoidDemo_consult_pl_file_by_param()

{

string[]ref_values={"gloria","melanie","ayala"

Console.WriteLine("Demo_consult_pl_file_by_param"

//Buildaprologsourcefile(skipthisstepifyoualreadyhaveone:-)

stringfilename=Path.GetTempFileName();

StreamWritersw=File.CreateText(filename);

sw.WriteLine("father(martin,inka).");

sw.WriteLine("father(uwe,gloria).");

sw.WriteLine("father(uwe,melanie).");

sw.WriteLine("father(uwe,ayala).");

sw.Close();

//buildtheparameterstringtoInitializePlEnginewiththegeneratedfile

String[]param={"-q","-f",filename};

try

{

PlEngine.Initialize(param);

Console.WriteLine("allchild'sfromuwe:");

using(PlQueryq=newPlQuery("father(uwe,Child)"

{

intidx=0;


{

Console.WriteLine(v["Child"].ToString());

Assert.AreEqual(ref_values[idx++],v[

}

}

}

catch(PlExceptione)

{

Console.WriteLine(e.MessagePl);

Console.WriteLine(e.Message);

}

finally

{


}

}//Demo_consult_pl_file_by_param

InheritanceHierarchyObjectPlEngine

SeeAlsoSbsSW.SwiPlCs.Callback

byUweLesta,SBS-SoftwaresystemeGmbHSendcommentsonthistopictoLestaatSBS-Softwaresysteme.deAssembly:SwiPlCs(Module:SwiPlCs)Version:1.1.60301.0(1.1.60301.0)

http://msdn2.microsoft.com/en-us/library/e5kfa45b


SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►Initialize(String[])

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologInitializeMethod(argv)

InitialiseSWI-Prolog

ThewritemethodoftheoutputstreamisredirectedtoSbsSW.SwiPlCs.StreamsbeforeInitialize.ThereadmethodoftheinputstreamjustafterInitialize.


publicstaticvoidInitialize(

string[]argv

)

PublicSharedSubInitialize(_

argvAsString()_

)

public:

staticvoidInitialize(

array<String^>^argv

)

Parametersargv(String[])

ForacompleteparameterdescriptionseetheSWI-Prologreferencemanualsection2.4Command-lineoptions.

sampleparameter:

http://msdn2.microsoft.com/en-us/library/s1wwdcbf




http://gollem.science.uva.nl/SWI-Prolog/Manual/cmdline.html

CopyC#

String[]param={"-q","-f",@"some\filename"};

Atthefirstpositionaparameter""isaddedinthismethod.PL_initialise

Remarks

Aknownbug:Initializework*not*asexpectediftherearee.g.GermanumlautsintheparametersSeemarshallinginthesorceNativeMethods.cs

ExamplesForanexampleseePlEngine


http://www.swi-prolog.org/pldoc/doc_for?object=section(3%2C%20%279.6.20%27%2C%20swi(%27%2Fdoc%2FManual%2Fforeigninclude.html%27))


SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►IsInitializedC#


PrologIsInitializedProperty

Totestiftheprologengineisup.


publicstaticboolIsInitialized{get;}

PublicSharedReadOnlyPropertyIsInitializedAsBoolean

Get

public:

staticpropertyboolIsInitialized{

boolget();

}


http://msdn2.microsoft.com/en-us/library/a28wyd50





SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►PlCleanup()C#


PrologPlCleanupMethod

Tryacleanupbutitisbuggysearchthewebfor"possibleregressionfrompl-5.4.7topl-5.6.27"toseereasons


publicstaticvoidPlCleanup()

PublicSharedSubPlCleanup

public:

staticvoidPlCleanup()

RemarksUsethismethodonlyatthelastcallbeforerunprogramends



SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►PlHalt()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlHaltMethod

StopsthePlEngineandtheprogram


publicstaticvoidPlHalt()

PublicSharedSubPlHalt

public:

staticvoidPlHalt()

RemarksSWI-Prologcallsinternallypl_cleanupandthanexit(0)



SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►PlThreadAttachEngine()

C#


PrologPlThreadAttachEngineMethod

return:referencecountoftheengine

Ifanerroroccurs,-1isreturned.

IfthisPrologisnotcompiledformulti-threading,-2isreturned.


publicstaticintPlThreadAttachEngine()

PublicSharedFunctionPlThreadAttachEngineAsInteger

public:

staticintPlThreadAttachEngine()

ReturnValueAreferencecountoftheengine


http://msdn2.microsoft.com/en-us/library/td2s409d




SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►PlThreadDestroyEngine()

C#


PrologPlThreadDestroyEngineMethod

ReturnsTRUEonsuccessandFALSEifthecallingthreadhasnoengineorthisPrologdoesnotsupportthreads.


publicstaticboolPlThreadDestroyEngine()

PublicSharedFunctionPlThreadDestroyEngineAsBoolean

public:

staticboolPlThreadDestroyEngine()

ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.PlEngine.PlThreadDestroyEngine"]






SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►PlThreadSelf()C#


PrologPlThreadSelfMethod

ReturnstheintegerPrologidentifieroftheengineor-1ifthecallingthreadhasnoPrologengine.Thismethodisalsoprovidedinthesingle-threadedversionofSWI-Prolog,whereitreturns-2.


publicstaticintPlThreadSelf()

PublicSharedFunctionPlThreadSelfAsInteger

public:

staticintPlThreadSelf()

ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.PlEngine.PlThreadSelf"]






SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►RegisterForeign()

C#


PrologRegisterForeignMethod

RegisteraC#-functiontoimplementaPrologpredicate.

Afterthiscallreturnssuccessfully,apredicatewithname(astring)andarityarity(aC#int)iscreatedinmodulemodule.

IfmoduleisNULL,thepredicateiscreatedinthemoduleofthecallingcontextorifnocontextispresentinthemoduleuser.

Remarks

Addaadditionalnamespaceby:

usingSbsSW.SwiPlCs.Callback;

ExamplesForanexampleseeDelegateParameter2andDelegateParameter1.

MembersIcon Member Description

RegisterForeign(Delegate)RegisteraC#callbackmethod

RegisterForeign(String,Delegate) RegisteraC#callbackmethod

RegisterForeign(String,Int32,Delegate) RegisteraC#callbackmethod

RegisterForeign(String,String,Int32,Delegate)

RegisteraC#callbackmethod




SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►RegisterForeign(Delegate)

C#


PrologRegisterForeignMethod(method)



publicstaticboolRegisterForeign(

Delegatemethod

)

PublicSharedFunctionRegisterForeign(_

methodAsDelegate_

)AsBoolean

public:

staticboolRegisterForeign(

Delegate^method

)

Parametersmethod(Delegate)

adelegatetoac#methodSbsSW.SwiPlCs.Callback

ReturnValuetrueifregistrationsucceedotherwisefalse




http://msdn2.microsoft.com/en-us/library/y22acf51






SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►RegisterForeign(String,Delegate)

C#


PrologRegisterForeignMethod(module,method)




stringmodule,

Delegatemethod

)


moduleAsString,_

methodAsDelegate_

)AsBoolean

public:


String^module,

Delegate^method

)

Parametersmodule(String)

thenameofaprologmoduleUsingModules

method(Delegate)adelegatetoac#methodSbsSW.SwiPlCs.Callback












http://gollem.science.uva.nl/SWI-Prolog/Manual/modules.html


SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►RegisterForeign(String,Int32,Delegate)

C#


PrologRegisterForeignMethod(name,arity,method)




stringname,

intarity,

Delegatemethod

)


nameAsString,_

arityAsInteger,_

methodAsDelegate_

)AsBoolean

public:


String^name,

intarity,

Delegate^method

)

Parametersname(String)

ThenameofastaticC#method

arity(Int32)Theamountofparameters

















ExamplesForanexampleseeDelegateParameterVarArgs




SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►RegisterForeign(String,String,Int32,Delegate)

C#


PrologRegisterForeignMethod(module,name,arity,method)




stringmodule,

stringname,

intarity,

Delegatemethod

)


moduleAsString,_

nameAsString,_

arityAsInteger,_

methodAsDelegate_

)AsBoolean

public:


String^module,

String^name,

intarity,

Delegate^method

)


















Thenameofthemodule(Prologmodulesystem)

name(String)ThenameofastaticC#method

arity(Int32)Theamountofparameters



ExamplesForanexampleseeDelegateParameterVarArgs






SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►SetStreamFunctionRead(PlStreamType,DelegateStreamReadFunction)

C#


PrologSetStreamFunctionReadMethod(streamType,function)

TODO


publicstaticvoidSetStreamFunctionRead(

PlStreamTypestreamType,

DelegateStreamReadFunctionfunction

)

PublicSharedSubSetStreamFunctionRead(_

streamTypeAsPlStreamType,_

functionAsDelegateStreamReadFunction_

)

public:

staticvoidSetStreamFunctionRead(


DelegateStreamReadFunction^function

)

ParametersstreamType(PlStreamType)

DeterminewhichstreamtousePlStreamType

function(DelegateStreamReadFunction)ADelegateStreamReadFunction

Examples

CopyC#

staticstringref_string_read="hello_dotnet_world_��."

staticinternallongSread(IntPtrhandle,System.IntPtrbuffer,

{

strings=ref_string_read+"\n";

byte[]array=System.Text.Encoding.Unicode.GetBytes(s);

System.Runtime.InteropServices.Marshal.Copy(array,

returnarray.Length;

}

[TestMethod]

publicvoidStreamRead()

{

DelegateStreamReadFunctionrf=newDelegateStreamReadFunction(Sread);

PlEngine.SetStreamFunctionRead(PlStreamType.Input,rf);

//NOTE:read/1needsadot('.')attheend

PlQuery.PlCall("assert((test_read(A):-read(A)))"

PlTermt=PlQuery.PlCallQuery("test_read(A)");

Assert.AreEqual(ref_string_read,t.ToString()+"."

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlEngine►SetStreamFunctionWrite(PlStreamType,DelegateStreamWriteFunction)

C#


PrologSetStreamFunctionWriteMethod(streamType,function)

Thisisaprimitiveapproachtoentertheoutputfromastream.


publicstaticvoidSetStreamFunctionWrite(


DelegateStreamWriteFunctionfunction

)

PublicSharedSubSetStreamFunctionWrite(_

streamTypeAsPlStreamType,_

functionAsDelegateStreamWriteFunction_

)

public:

staticvoidSetStreamFunctionWrite(


DelegateStreamWriteFunction^function

)

ParametersstreamType(PlStreamType)

DeterminewhichstreamtousePlStreamType

function(DelegateStreamWriteFunction)ADelegateStreamWriteFunction

Examples

CopyC#

staticstringtest_string;

staticlongSwrite(IntPtrhandle,stringbuffer,long

{

strings=buffer.Substring(0,(int)buffersize);

test_string=s;

returnbuffersize;

}

[TestMethod]

publicvoidStreamWrite()

{

//NOTE:theSwritefunctionisonlycalledifyouflushtheoutputorsendanewlinecharacter

stringref_string="Hello.networld��";PlQuery.PlCall("assert((test_write:-writeln('"

DelegateStreamWriteFunctionwf=newDelegateStreamWriteFunction(Swrite);

PlEngine.SetStreamFunctionWrite(PlStreamType.Output,wf);

PlQuery.PlCall("test_write");

Assert.AreEqual(ref_string+"\r\n",test_string);

}



C#SwiPlCsinterface►SbsSW.SwiPlCs►PlFrame

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlFrameClass

TheclassPlFrameprovidesaninterfacetodiscardunusedterm-referencesaswellasrewindingunifications(data-backtracking).Reclaimingunusedterm-referencesisautomaticallyperformedafteracalltoaC#-definedpredicatehasfinishedandreturnscontroltoProlog.InthisscenarioPlFrameisrarelyofanyuse.

ThisclasscomesintoplayifthetoplevelprogramisdefinedinC#andcallsPrologmultipletimes.Settingupargumentstoaqueryrequiresterm-referencesandusingPlFrameistheonlywaytoreclaimthem.


publicclassPlFrame:IDisposable

PublicClassPlFrame_

ImplementsIDisposable

publicrefclassPlFrame:IDisposable

MembersAllMembers Constructors Methods

PublicProtected

InstanceStatic

Declared


PlFrame() Creatinganinstanceofthisclassmarksallterm-referencescreatedafterwardstobevalidonlyinthe

http://msdn2.microsoft.com/en-us/library/aax125c9



scopeofthisinstance.

Dispose() ImplementIDisposable.

Equals(Object) DetermineswhetherthespecifiedObjectisequaltothecurrentObject.

(InheritedfromObject.)

Finalize() Reclaimsallterm-referencescreatedafterconstructingtheinstance.

(OverridesObject.Finalize().)

GetHashCode() Servesasahashfunctionforaparticulartype.


GetType() GetstheTypeofthecurrentinstance.


MemberwiseClone() CreatesashallowcopyofthecurrentObject.


Rewind() Discardsallterm-referencesandglobal-stackdatacreatedaswellasundoingallunificationsaftertheinstancewascreated.

ToString() ReturnsaStringthatrepresentsthecurrentObject.


http://msdn2.microsoft.com/en-us/library/bsc2ak47





http://msdn2.microsoft.com/en-us/library/4k87zsw7

http://msdn2.microsoft.com/en-us/library/zdee4b3y


http://msdn2.microsoft.com/en-us/library/dfwy45w9

http://msdn2.microsoft.com/en-us/library/42892f65


http://msdn2.microsoft.com/en-us/library/57ctke0a



http://msdn2.microsoft.com/en-us/library/7bxwbwt2




Copy

Copy

Remarksseehttp://www.swi-prolog.org/pldoc/package/pl2cpp.html#sec:8.1

ExamplesAtypicaluseforPlFrameisthedefinitionofC#methodsthatcallPrologandmaybecalledrepeatedlyfromC#.ConsiderthedefinitionofassertWord(),addingafacttoword/1:

C#

voidAssertWord2(stringword)

{

PlFramefr=newPlFrame();

PlTermVav=newPlTermV(1);

av[0]=PlTerm.PlCompound("word",newPlTermV(new

PlQueryq=newPlQuery("assert",av);

q.NextSolution();

q.Dispose();//IMPORTANT!neverforgettofreethequerybeforethePlFrameisclosed

fr.Dispose();

}

alternativelyyoucanuse

C#

voidAssertWord(stringword)

{

using(PlFramefr=newPlFrame())

{

PlTermVav=newPlTermV(1);

av[0]=PlTerm.PlCompound("word",newPlTermV(

using(PlQueryq=newPlQuery("assert",av))

{

q.NextSolution();

}

}

}

http://www.swi-prolog.org/pldoc/package/pl2cpp.html#sec:8.1

Caution:NOTE:inanycaseyouhavetodestroyanyqueryobjectusedinsideaPlFrame

InheritanceHierarchyObjectPlFrame




SwiPlCsinterface►SbsSW.SwiPlCs►PlFrame►PlFrame()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlFrameConstructor

Creatinganinstanceofthisclassmarksallterm-referencescreatedafterwardstobevalidonlyinthescopeofthisinstance.


publicPlFrame()

PublicSubNew

public:

PlFrame()



SwiPlCsinterface►SbsSW.SwiPlCs►PlFrame►Dispose()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologDisposeMethod

ImplementIDisposable.


publicvoidDispose()

PublicSubDispose

public:

virtualvoidDispose()sealed

Remarks

Donotmakethismethodvirtual.

Aderivedclassshouldnotbeabletooverridethismethod.



SwiPlCsinterface►SbsSW.SwiPlCs►PlFrame►Finalize()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologFinalizeMethod

Reclaimsallterm-referencescreatedafterconstructingtheinstance.


protectedoverridevoidFinalize()

ProtectedOverridesSubFinalize

protected:

virtualvoidFinalize()override



SwiPlCsinterface►SbsSW.SwiPlCs►PlFrame►Rewind()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologRewindMethod

Discardsallterm-referencesandglobal-stackdatacreatedaswellasundoingallunificationsaftertheinstancewascreated.


publicvoidRewind()

PublicSubRewind

public:

voidRewind()



C#SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlQueryClass

Thisclassallowsqueriestoprolog.

AquerycanbecreatedbyastringorbyconstructingcompoundtermsseeConstructorsfordetails.

AllresourcesantermscreatedbyaqueryarereclaimedbyDispose().Itisrecommendedtobuildaqueryinausingscope.

TherearefourpossibleopportunitiestoqueryProlog

Querytype DescriptionAstaticcall Toaskprologforaproof.Return

onlytrueorfalse.

APlCallQuery(String) Togetthefirstresultofagoal

ConstructaPlQueryobjectbyastring.

Themostconvenientway.

ConstructaPlQueryobjectbycompoundterms.

Themostflexibleandfast(runtime)way.

ForexamplesseePlQuery(String)andPlQuery(String,PlTermV)


publicclassPlQuery:IDisposable

PublicClassPlQuery_

ImplementsIDisposable

publicrefclassPlQuery:IDisposable




MembersAllMembers Constructors Methods Properties

PublicProtected

InstanceStatic

Declared


PlQuery(String)Withthisconstructoraqueryiscreatedfromastring.

Uppercaseparametersareinterpretedavariablesbutcan'tbenestedinsubterms.IfyouneedavariableinanestedtermusePlQuery(String,PlTermV).Seetheexamplesfordetails.

PlQuery(String,String) locatingthepredicateinthenamedmodule.

PlQuery(String,PlTermV) Createaquerywherenamedefinesthenameofthepredicateandavtheargumentvector.Thearityisdeducedfromav.ThepredicateislocatedinthePrologmoduleuser.

PlQuery(String,String,PlTermV)

locatingthepredicateinthenamedmodule.

Args ProvideaccesstotheArgument

vectorforthequery

Dispose() Performsapplication-definedtasksassociatedwithfreeing,releasing,orresettingunmanagedresources.

Dispose(Boolean) Releaseallresourcesfromthequery



Finalize() AllowsanObjecttoattempttofreeresourcesandperformothercleanupoperationsbeforetheObjectisreclaimedbygarbagecollection.

(OverridesObject.Finalize().)







NextSolution() Providethenextsolutiontothequery.PrologexceptionsaremappedtoC#exceptions.

















PlCall(String,PlTermV) Createaquerywherenamedefinesthenameofthepredicateandavtheargumentvector.Thearityisdeducedfromav.ThepredicateislocatedinthePrologmoduleuser.

PlCall(String,String,PlTermV)

AsPlCall(String,PlTermV)butlocatingthepredicateinthenamedmodule.

PlCall(String) Callagoalonce.

PlCallQuery(String)NOTE:willbechangedinthenearfuture.

returnthesolutionofaquerywhichiscalledoncebycallThrowanArgumentExceptionifthereisnoormorethanonevariableinthegoal

PlCallQuery(String,String) AsPlCallQuery(String)butexecutedinthenamedmodule.

Query(PlQuerySwitch)ObtainstatusinformationonthePrologsystem.Theactualargumenttypedependsontheinformationrequired.TheparameterqueryTypedescribeswhatinformationiswanted.

Returningpointersandintegersasalongisbadstyle.Thesignatureofthisfunctionshouldbechanged.

PlQuerySwitch

SolutionsEnumeratethesolutions.

ForexamplesseePlQuery(String)

SolutionVariablesEnumeratethePlQueryVariablesofonesolution.

ToList()CreateaReadOnlyCollection<T>ofPlQueryVariables.

IfcallingToList()allsolutionsofthequeryaregeneratedandstoredintheCollection.



VariableNames GetsaCollection<T>ofthevariablenamesifthequerywasbuiltbyastring.

Variables TheListofPlQueryVariablesofthis

http://msdn2.microsoft.com/en-us/library/ms132474






PlQuery.

Remarks

ThequerywillbeopenedbyNextSolution()andwillbeclosedifNextSolution()returnfalse.

InheritanceHierarchyObjectPlQuery




SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlQuery()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlQueryConstructor

WiththeseconstructorsaPrologquerycanbecreatedbutnotopened.TogettheresultsseeNextSolution()

AQuerycanbecreatedfromastringorbyanameandPlTermV.Thelaterisanativewayandavailableforcompatibility.

IfaQueryiscreatedfromastringrepresentingarbitraryprologtextthehelperclassesPlQueryVarandPlQueryVariablescomesintothegame.InthiscasethemostconvenientwaytogettheresultsistouseSolutionVariablesorToList().

ForexamplesseePlQuery(String).


PlQuery(String)Withthisconstructoraqueryiscreatedfromastring.


PlQuery(String,String) locatingthepredicateinthenamedmodule.

PlQuery(String,PlTermV) Createaquerywherenamedefines

thenameofthepredicateandavtheargumentvector.Thearityisdeducedfromav.ThepredicateislocatedinthePrologmoduleuser.

PlQuery(String,String,PlTermV)




SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlQuery(String)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlQueryConstructor(goal)

Withthisconstructoraqueryiscreatedfromastring.



publicPlQuery(

stringgoal

)

PublicSubNew(_

goalAsString_

)

public:

PlQuery(

String^goal

)

Parametersgoal(String)

Astringforaprologquery

RemarksMuddyWaterssang:"I'ambuildforcomfort,Iain'tbuildforspeed"

Examples





Copy

Copy

Copy

C#

publicvoidqueryStringForeach()

{

stringmm="abc";


inti=0;


{

Assert.AreEqual(mm[i++].ToString(),s[0].ToString());

}

//orwithnamedvariables

i=0;

foreach(PlQueryVariablessinq.SolutionVariables)

{

Assert.AreEqual(mm[i++].ToString(),s["A"].ToString());

}

}

Thissampleshowsaquerywithtwovariables.

C#

publicvoidqueryString2()

{

PlQueryq=newPlQuery("append(A,B,[a,b,c])");

Assert.IsTrue(q.NextSolution());

Assert.AreEqual("[]",q.Args[0].ToString());

Assert.AreEqual("[a,b,c]",q.Args[1].ToString());


Assert.AreEqual("[a]",q.Args[0].ToString());

Assert.AreEqual("[b,c]",q.Args[1].ToString());

}

Andthesamewithnamedvariables.

C#

publicvoidqueryStringNamed()

{

Copy

Copy



Assert.AreEqual("[]",q.Variables["A"].ToString());

Assert.AreEqual("[a,b,c]",q.Variables["B"].ToString());


Assert.AreEqual("[a]",q.Variables["A"].ToString());

Assert.AreEqual("[b,c]",q.Variables["B"].ToString());

}

Thissampleshowswhathappensiftheargumentvectorisusedwithcompoundterms.

C#

publicvoidPlCallQueryCompound_string()

{

string[]mm={"comp(aa,aa1)","comp(aa,aa2)",

build_pred();//create:test(comp(X,Y)):-member(Z,[1,2,3]),atomic_list_concat([X,Z],Y).

PlQueryq=newPlQuery("test(comp(aa,X))");

inti=0;


{


}

}

Andherehowtogettheresultswithnamedvariableswithcompoundterms.

C#

publicvoidPlCallQueryCompoundNamed_string()

{

string[]mm={"aa1","aa2","aa3"};



inti=0;


{

Assert.AreEqual(mm[i++].ToString(),v["X"].ToString());

}

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlQuery(String,PlTermV)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlQueryConstructor(name,termV)

Createaquerywherenamedefinesthenameofthepredicateandavtheargumentvector.Thearityisdeducedfromav.ThepredicateislocatedinthePrologmoduleuser.


publicPlQuery(

stringname,

PlTermVtermV

)

PublicSubNew(_

nameAsString,_

termVAsPlTermV_

)

public:

PlQuery(

String^name,

PlTermVtermV

)


thenameofthepredicate

termV(PlTermV)theargumentvectorcontainingtheparameters

Examples





Copy

Thissampleshowsaquerywithacompoundtermasanargument.

C#

publicvoidPlCallQueryCompound_termv()

{



PlTermvar1=PlTerm.PlVar();

PlTermcomp=PlTerm.PlCompound("comp",newPlTerm(

using(PlQueryq=newPlQuery("test",newPlTermV(comp)))

{

inti=0;


{

Assert.AreEqual(mm[i++].ToString(),var1.ToString());

Assert.AreEqual(comp.ToString(),s[0].ToString());

}

}

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlQuery(String,String)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlQueryConstructor(module,goal)



publicPlQuery(

stringmodule,

stringgoal

)

PublicSubNew(_

moduleAsString,_

goalAsString_

)

public:

PlQuery(

String^module,

String^goal

)



goal(String)Astringforaprologquery

Remarks//TODO:mitatom_to_term/3machen









Copy

Copy

Copy

Examples

C#

publicvoidqueryStringForeach()

{

stringmm="abc";


inti=0;


{


}

//orwithnamedvariables

i=0;

foreach(PlQueryVariablessinq.SolutionVariables)

{

Assert.AreEqual(mm[i++].ToString(),s["A"].ToString());

}

}

Thissampleshowsaquerywithtwovariables.

C#

publicvoidqueryString2()

{



Assert.AreEqual("[]",q.Args[0].ToString());

Assert.AreEqual("[a,b,c]",q.Args[1].ToString());


Assert.AreEqual("[a]",q.Args[0].ToString());

Assert.AreEqual("[b,c]",q.Args[1].ToString());

}

Andthesamewithnamedvariables.

C#

Copy

Copy

publicvoidqueryStringNamed()

{



Assert.AreEqual("[]",q.Variables["A"].ToString());

Assert.AreEqual("[a,b,c]",q.Variables["B"].ToString());


Assert.AreEqual("[a]",q.Variables["A"].ToString());

Assert.AreEqual("[b,c]",q.Variables["B"].ToString());

}

Thissampleshowswhathappensiftheargumentvectorisusedwithcompoundterms.

C#

publicvoidPlCallQueryCompound_string()

{

string[]mm={"comp(aa,aa1)","comp(aa,aa2)",



inti=0;


{


}

}

Andherehowtogettheresultswithnamedvariableswithcompoundterms.

C#

publicvoidPlCallQueryCompoundNamed_string()

{




inti=0;


{

Assert.AreEqual(mm[i++].ToString(),v["X"].ToString());

}

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlQuery(String,String,PlTermV)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlQueryConstructor(module,name,termV)



publicPlQuery(

stringmodule,

stringname,

PlTermVtermV

)

PublicSubNew(_

moduleAsString,_

nameAsString,_

termVAsPlTermV_

)

public:

PlQuery(

String^module,

String^name,

PlTermVtermV

)



name(String)thenameofthepredicate

termV(PlTermV)









Copy

theargumentvectorcontainingtheparameters

Examples


C#


{






{

inti=0;


{



}

}

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►ArgsC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologArgsProperty

ProvideaccesstotheArgumentvectorforthequery


publicPlTermVArgs{get;}

PublicReadOnlyPropertyArgsAsPlTermV

Get

public:

propertyPlTermVArgs{

PlTermVget();

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►Dispose()C#



Dispose() Performsapplication-definedtasksassociatedwithfreeing,releasing,orresettingunmanagedresources.

Dispose(Boolean) Releaseallresourcesfromthequery



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►Dispose()C#


Performsapplication-definedtasksassociatedwithfreeing,releasing,orresettingunmanagedresources.


publicvoidDispose()

PublicSubDispose

public:

virtualvoidDispose()sealed



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►Dispose(Boolean)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologDisposeMethod(disposing)

Releaseallresourcesfromthequery


protectedvirtualvoidDispose(

booldisposing

)

ProtectedOverridableSubDispose(_

disposingAsBoolean_

)

protected:

virtualvoidDispose(

booldisposing

)

Parametersdisposing(Boolean)

iftrueallisdeleted







SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►Finalize()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologFinalizeMethod

AllowsanObjecttoattempttofreeresourcesandperformothercleanupoperationsbeforetheObjectisreclaimedbygarbagecollection.


protectedoverridevoidFinalize()

ProtectedOverridesSubFinalize

protected:

virtualvoidFinalize()override





SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►NextSolution()C#


PrologNextSolutionMethod

Providethenextsolutiontothequery.PrologexceptionsaremappedtoC#exceptions.


publicboolNextSolution()

PublicFunctionNextSolutionAsBoolean

public:

boolNextSolution()

ReturnValuereturntrueifsuccessfulandfalseifthereareno(more)solutions.

Remarks

Ifthequeryiscloseditwillbeopened.Ifthelastsolutionwasgeneratedthequerywillbeclosed.

Ifanexceptionisthrownwhileparsing(open)thequerythe_qidissettozero.

ExceptionsException ConditionPlException IsthrownifSWI-PrologManual

PL_next_solution()returnsfalse





http://gollem.science.uva.nl/SWI-Prolog/Manual/foreigninclude.html#PL_next_solution()


Assembly:SwiPlCs(Module:SwiPlCs)Version:1.1.60301.0(1.1.60301.0)

Copy

Copy

SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlCall()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlCallMethod

ThemainpurposeofthestaticPlCallmethodsistocallaprologproveortodosomesiteeffects.Examples

C#

Assert.IsTrue(PlQuery.PlCall("is_list",newPlTerm("[a,b,c,d]"

C#

Assert.IsTrue(PlQuery.PlCall("consult",newPlTerm("some_file_name"

//or

Assert.IsTrue(PlQuery.PlCall("consult('some_file_name')"


PlCall(String,PlTermV) Createaquerywherenamedefinesthenameofthepredicateandavtheargumentvector.Thearityisdeducedfromav.ThepredicateislocatedinthePrologmoduleuser.

PlCall(String,String,PlTermV)


PlCall(String) Callagoalonce.


SendcommentsonthistopictoLestaatSBS-Softwaresysteme.deAssembly:SwiPlCs(Module:SwiPlCs)Version:1.1.60301.0(1.1.60301.0)


SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlCall(String)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlCallMethod(goal)

Callagoalonce.


publicstaticboolPlCall(

stringgoal

)

PublicSharedFunctionPlCall(_

goalAsString_

)AsBoolean

public:

staticboolPlCall(

String^goal

)


Thecompletegoalasastring

ReturnValueReturntrueorfalseastheresultofNextSolution()orthrowanexception.

Remarks

CreateaPlQueryfromthearguments,generatesthefirstsolutionbyNextSolution()anddestroysthequery.

Examples








Copy

Copy

C#

Assert.IsTrue(PlQuery.PlCall("is_list([a,b,c,d])"));

C#

Assert.IsTrue(PlQuery.PlCall("consult('some_file_name')"



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlCall(String,PlTermV)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlCallMethod(predicate,args)

Createaquerywherenamedefinesthenameofthepredicateandavtheargumentvector.Thearityisdeducedfromav.ThepredicateislocatedinthePrologmoduleuser.



stringpredicate,

PlTermVargs

)


predicateAsString,_

argsAsPlTermV_

)AsBoolean

public:

staticboolPlCall(

String^predicate,

PlTermVargs

)

Parameterspredicate(String)

definesthenameofthepredicate

args(PlTermV)IsaPlTermVofargumentsforthepredicate

ReturnValue








Copy

ReturntrueorfalseastheresultofNextSolution()orthrowanexception.

Remarks


Examples


C#


{






{

inti=0;


{



}

}

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlCall(String,String,PlTermV)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlCallMethod(module,predicate,args)




stringmodule,

stringpredicate,

PlTermVargs

)


moduleAsString,_

predicateAsString,_

argsAsPlTermV_

)AsBoolean

public:

staticboolPlCall(

String^module,

String^predicate,

PlTermVargs

)



predicate(String)definesthenameofthepredicate












Copy

args(PlTermV)IsaPlTermVofargumentsforthepredicate

ReturnValueReturntrueorfalseastheresultofNextSolution()orthrowanexception.

Remarks


Examples


C#


{






{

inti=0;


{



}

}

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlCallQuery()C#


PrologPlCallQueryMethod


PlCallQuery(String)NOTE:willbechangedinthenearfuture.


PlCallQuery(String,String)

AsPlCallQuery(String)butexecutedinthenamedmodule.



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlCallQuery(String)

C#


PrologPlCallQueryMethod(goal)

NOTE:willbechangedinthenearfuture.



publicstaticPlTermPlCallQuery(

stringgoal

)

PublicSharedFunctionPlCallQuery(_

goalAsString_

)AsPlTerm

public:

staticPlTermPlCallQuery(

String^goal

)


agoalwith*one*variable

ReturnValuetheboundvariableofthefirstsolution







SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►PlCallQuery(String,String)

C#


PrologPlCallQueryMethod(module,goal)

AsPlCallQuery(String)butexecutedinthenamedmodule.


publicstaticPlTermPlCallQuery(

stringmodule,

stringgoal

)

PublicSharedFunctionPlCallQuery(_

moduleAsString,_

goalAsString_

)AsPlTerm

public:

staticPlTermPlCallQuery(

String^module,

String^goal

)


Themodulenameinwhichthequeryisexecuted

goal(String)agoalwith*one*variable

ReturnValuetheboundvariableofthefirstsolution









SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►Query(PlQuerySwitch)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologQueryMethod(queryType)

ObtainstatusinformationonthePrologsystem.Theactualargumenttypedependsontheinformationrequired.TheparameterqueryTypedescribeswhatinformationiswanted.

Returningpointersandintegersasalongisbadstyle.Thesignatureofthisfunctionshouldbechanged.

PlQuerySwitch


publicstaticlongQuery(

PlQuerySwitchqueryType

)

PublicSharedFunctionQuery(_

queryTypeAsPlQuerySwitch_

)AsLong

public:

staticlonglongQuery(

PlQuerySwitchqueryType

)

ParametersqueryType(PlQuerySwitch)

APlQuerySwitch.

ReturnValue

http://msdn2.microsoft.com/en-us/library/6yy583ek



Copy

AintdependingonthegivenqueryType

Examples

ThissampleshowshowtogetSWI-Prologsversionnumber

C#

publicvoidPl_query_version()

{

longv=PlQuery.Query(PlQuerySwitch.Version);

Assert.AreEqual(60301,v,"SWI-Prologversionnumber"

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►SolutionsC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologSolutionsProperty

Enumeratethesolutions.

ForexamplesseePlQuery(String)


publicIEnumerable<PlTermV>Solutions{get;}

PublicReadOnlyPropertySolutionsAsIEnumerable(Of

Get

public:

propertyIEnumerable<PlTermV>^Solutions{

IEnumerable<PlTermV>^get();

}

SeeAlsoNextSolution()Constructors


http://msdn2.microsoft.com/en-us/library/9eekhta0





Copy

SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►SolutionVariablesC#


PrologSolutionVariablesProperty

EnumeratethePlQueryVariablesofonesolution.


publicIEnumerable<PlQueryVariables>SolutionVariables

PublicReadOnlyPropertySolutionVariablesAsIEnumerable

Get

public:

propertyIEnumerable<PlQueryVariables^>^SolutionVariables

IEnumerable<PlQueryVariables^>^get();

}

Examples

C#

publicvoidTestCompoundQuery()

{

string[]ref_values={"gloria","melanie","ayala"


{



PlQuery.PlCall("assert(father(uwe,ayala))");

PlQueryplq=newPlQuery("father(P,C),atomic_list_concat([P,'is_father_of',C],L)"

inti=0;

foreach(PlQueryVariablesvarsinplq.SolutionVariables)

{

Assert.AreEqual("uwe",(string)vars["P"]);





Assert.AreEqual(ref_values[i++],(string

}

}

}

SeeAlsoNextSolution()



Copy

SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►ToList()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologToListMethod

CreateaReadOnlyCollection<T>ofPlQueryVariables.

IfcallingToList()allsolutionsofthequeryaregeneratedandstoredintheCollection.


publicReadOnlyCollection<PlQueryVariables>ToList()

PublicFunctionToListAsReadOnlyCollection(OfPlQueryVariables

public:

ReadOnlyCollection<PlQueryVariables^>^ToList()

ReturnValueAReadOnlyCollectionofPlQueryVariablescontainingallsolutionsofthequery.

Examples

C#

publicvoidTest_multi_goal_ToList()

{

stringmm="abc";

varresults=fromninnewPlQuery("L=[a,b,c],member(A,L)"

selectnew{A=(string)n["A"]};

inti=0;

foreach(vartinresults)

Assert.AreEqual(mm[i++].ToString(),t.A);

}





SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►VariableNamesC#


PrologVariableNamesProperty

GetsaCollection<T>ofthevariablenamesifthequerywasbuiltbyastring.


publicCollection<string>VariableNames{get;}

PublicReadOnlyPropertyVariableNamesAsCollection

Get

public:

propertyCollection<String^>^VariableNames{

Collection<String^>^get();

}












Copy

SwiPlCsinterface►SbsSW.SwiPlCs►PlQuery►VariablesC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologVariablesProperty

TheListofPlQueryVariablesofthisPlQuery.


publicPlQueryVariablesVariables{get;}

PublicReadOnlyPropertyVariablesAsPlQueryVariables

Get

public:

propertyPlQueryVariables^Variables{

PlQueryVariables^get();

}

Examples

InthefollowingexampleyouseehowthequeryVariablescanbeusedtosetavariable.

C#

publicvoidTestCompoundQueryWithVariables()

{

string[]ref_values={"x_a","x_b","x_c"};


{

PlQueryplq=newPlQuery("member(X,[a,b,c]),atomic_list_concat([P,X],L)"

plq.Variables["P"].Unify("x_");

inti=0;


{

Assert.AreEqual("x_",(string)vars["P"]);

Copy


}

}

}

Hereisamorecomplexsamplewherethevariablesoftwoqueriesareconnected.

C#

publicvoidTestCompoundNestedQueryWithVariables()

{

string[]ref_values={"x_a","x_b","x_c"};

string[]ref_values_inner={"a1","a2","b1",

intinner_idx=0;


{

PlQueryplq=newPlQuery("member(X,[a,b,c]),atomic_list_concat([P,X],L)"

plq.Variables["P"].Unify("x_");

inti=0;


{

Assert.AreEqual("x_",(string)vars["P"]);


PlQueryq=newPlQuery("member(X,[1,2]),atomic_list_concat([P,X],L)"

q.Variables["P"].Unify(plq.Variables["X"

varresults=fromninq.ToList()select

foreach(varvinresults)

{

Assert.AreEqual(ref_values_inner[inner_idx++],v.L);

}

}

}

}

SeeAlsoPlQueryVariables

C#SwiPlCsinterface►SbsSW.SwiPlCs►PlQuerySwitch


PrologPlQuerySwitchEnumeration

Flagsthatcontrolfortheforeignpredicateparameters

SWI-PrologManual-9.6.16QueryingProlog.


publicenumPlQuerySwitch

PublicEnumerationPlQuerySwitch

publicenumclassPlQuerySwitch

MembersMember DescriptionNone Thedefaultvalue.

Argc ReturnanintegerholdingthenumberofargumentsgiventoPrologfromUnix.

Argv Returnachar**holdingtheargumentvectorgiventoPrologfromUnix.

GetChar Readcharacterfromterminal.

MaxInteger Returnalong,representingthemaximalintegervaluerepresentedbyaProloginteger.

MinInteger Returnalong,representingtheminimalintegervalue.

Version Returnalong,representingtheversionas10,000×M+100×m+p,whereMisthemajor,mtheminorversionnumberandp

http://gollem.science.uva.nl/SWI-Prolog/Manual/foreigninclude.html#PL_query()

thepatch-level.Forexample,20717means2.7.17

MaxThreads Returnthemaximumnumberofthreadsthatcanbecreatedinthisversion.ReturnvaluesofPL_thread_self()arebetween0andthisnumber.

Encoding ReturnthedefaultstreamencodingofProlog(oftypeIOENC).

UserCpu GetamountofuserCPUtimeoftheprocessinmilliseconds.

SeeAlsoQuery(PlQuerySwitch)



C#SwiPlCsinterface►SbsSW.SwiPlCs►PlQueryVar


PrologPlQueryVarClass

RepresentsonevariableofaQueryresult.


publicclassPlQueryVar

PublicClassPlQueryVar

publicrefclassPlQueryVar

MembersAllMembers Methods Properties

PublicProtected

InstanceStatic

Declared





















Name ThenameofavariableinaQuery



Value TheValue(PlTerm)ofavariableinaQuery

InheritanceHierarchyObjectPlQueryVar















SwiPlCsinterface►SbsSW.SwiPlCs►PlQueryVar►NameC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologNameProperty

ThenameofavariableinaQuery


publicstringName{get;internalset;}

PublicPropertyNameAsString

Get

FriendSet

public:

propertyString^Name{

String^get();

internal:voidset(String^value);

}








SwiPlCsinterface►SbsSW.SwiPlCs►PlQueryVar►ValueC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologValueProperty

TheValue(PlTerm)ofavariableinaQuery


publicPlTermValue{get;internalset;}

PublicPropertyValueAsPlTerm

Get

FriendSet

public:

propertyPlTermValue{

PlTermget();

internal:voidset(PlTermvalue);

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlQueryVariablesC#


PrologPlQueryVariablesClass

RepresentsthesetvariablesofaQueryifitwascreatedfromastring.

ThisclassisalsousedtorepresenttheresultsofaPlQueryafterToList()orSolutionVariableswascalled.


publicclassPlQueryVariables

PublicClassPlQueryVariables

publicrefclassPlQueryVariables


PublicProtected

InstanceStatic

Declared


PlQueryVariables() InitializesanewinstanceofthePlQueryVariablesclass

Count Returnsthenumberofelementsinthesequence.(DefinedbyEnumerableofList<PlQueryVar>.)

Copy









Item[String] GetsthePlTermofthegivenvariablenameorthrowanArgumentException.





Examples

ThissampleshowsbothVariablesisusedtounifythevariablesoftwonestedqueriesandtheresult

C#





















publicvoidTestCompoundNestedQueryWithVariables3()

{

string[]ref_values_inner={"_gap_abc1","_gap_abc2"

intinner_idx=0;


{

try

{

PlQueryouter_query=newPlQuery("append(A,B,C),atomic_list_concat(A,A1),atomic_list_concat(B,B1)"

outer_query.Variables["C"].Unify(newPlTerm(

PlQueryinner_query=newPlQuery("member(Count,[1,2]),atomic_list_concat([X,Y,Z,Count],ATOM)"

inner_query.Variables["X"].Unify(outer_query.Variables[

inner_query.Variables["Y"].Unify("_gap_"

inner_query.Variables["Z"].Unify(outer_query.Variables[

foreach(PlQueryVariablesvarsinouter_query.SolutionVariables)

{

varresults=fromnininner_query.ToList()

selectnew{L=n["ATOM"

foreach(varvinresults)

{

Assert.AreEqual(ref_values_inner[inner_idx++],v.L);

}

}

}

catch(Exceptionex)

{

System.Diagnostics.Trace.WriteLine(ex.Message);

Assert.IsFalse(true);

}

}

}

InheritanceHierarchyObjectPlQueryVariables

SeeAlso


Variables



SwiPlCsinterface►SbsSW.SwiPlCs►PlQueryVariables►PlQueryVariables()

C#


PrologPlQueryVariablesConstructor

InitializesanewinstanceofthePlQueryVariablesclass


publicPlQueryVariables()

PublicSubNew

public:

PlQueryVariables()



SwiPlCsinterface►SbsSW.SwiPlCs►PlQueryVariables►CountC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologCountProperty

Returnsthenumberofelementsinthesequence.(DefinedbyEnumerableofList<PlQueryVar>.)


publicintCount{get;}

PublicReadOnlyPropertyCountAsInteger

Get

public:

propertyintCount{

intget();

}







SwiPlCsinterface►SbsSW.SwiPlCs►PlQueryVariables►Item[String]

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologItemProperty(name)

GetsthePlTermofthegivenvariablenameorthrowanArgumentException.


publicPlTermthis[

stringname

]{get;}

PublicReadOnlyDefaultPropertyItem(_

nameAsString_

)AsPlTerm

Get

public:

propertyPlTermdefault[String^name]{

PlTermget(String^name);

}


Thenameofthevariable

ReturnValueThePlTerm(value)ofthevariable

ExceptionsException Condition






ArgumentException Isthrownifthenameisnotthenameofavariable.


http://msdn2.microsoft.com/en-us/library/3w1b3114


C#SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermStructure

ThePlTermstructplaysacentralroleinconversionandoperatingonPrologdata.

PlTermimplementsIComparabletosupportorderingin[!:System.Linq]queriesifPlTermisaList.

CreatingaPlTermcanbedonebytheConstructorsorbythefollowingstaticmethods:

PlVar(),PlTail(),PlCompound,PlString(),PlCodeList(),PlCharList()(seeremarks)


publicstructPlTerm:IComparable,IEnumerable<PlTerm

IEnumerable

PublicStructurePlTerm_

ImplementsIComparable,IEnumerable(OfPlTerm

IEnumerable

publicvalueclassPlTerm:IComparable,

IEnumerable<PlTerm>,IEnumerable


PublicProtected

InstanceStatic

Declared

Inherited




http://msdn2.microsoft.com/en-us/library/h1x9x1b1







Icon Member DescriptionPlTerm(String) Createsaterm-referencesholding

aPrologtermrepresentingtext.

PlTerm(Int32) Createsaterm-referencesholdingaPrologintegerrepresentingvalue.

PlTerm(Double) Createsaterm-referencesholdingaPrologfloatrepresentingvalue.

Add(PlTerm) AppendsanelementtoalistbycreatinganewoneandcopyallelementsNoteThisisaslowversionseemymailfromJanfrom2007.11.0614:44

AddList(PlTerm) Appendsalist(PlTail)toalistbycreatinganewoneandcopyallelements

Append(PlTerm) AppendselementtothelistandmakethePlTailreferencepointtothenewvariabletail.IfAisavariable,andthismethodiscalledonitusingtheargument"gnat",alistoftheform[gnat|B]iscreatedandthePlTailobjectnowpointstothenewvariableB.ThismethodreturnsTRUEiftheunificationsucceededandFALSEotherwise.

Noexceptionsaregenerated.

ArityGetthearityofthefunctorifPlTermisacompoundterm.

Close() Unifiesthetermwith[]andreturnstheresultoftheunification.

CompareTo(Object) Comparesthecurrentinstancewithanotherobjectofthesametypeandreturnsanintegerthatindicateswhetherthecurrentinstanceprecedes,follows,oroccursinthesamepositioninthesortorderastheotherobject.

Equality(PlTerm,PlTerm) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.

Equality(PlTerm,Int32)

Equality(Int32,PlTerm) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptionifthe

conversionfailed.

Equality(PlTerm,String) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.

Equality(String,PlTerm) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.

Equals(Object) Indicateswhetherthisinstanceandaspecifiedobjectareequal.

(OverridesValueType.Equals(Object).)

Explicit(PlTermtoString) ConvertsthePrologargumentintoastringwhichimpliesPrologatomsandstringsareconvertedtotherepresentedtextorthrowaPlTypeException.

Explicit(PlTermtoInt32) YieldsaintifthePlTermisaPrologintegerorfloatthatcanbeconvertedwithoutlosstoaint.ThrowsaPlTypeException

http://msdn2.microsoft.com/en-us/library/aey3s293

http://msdn2.microsoft.com/en-us/library/2dts52z7

exceptionotherwise

Explicit(PlTermtoDouble) YieldsthevalueasaC#doubleifPlTermrepresentsaPrologintegerorfloat.ThrowsaPlTypeExceptionexceptionotherwise.



GetEnumerator() Returnsanenumeratorthatiteratesthroughthecollection.

GetHashCode() Returnsthehashcodeforthisinstance.

(OverridesValueType.GetHashCode().)



GreaterThan(PlTerm,PlTerm)

YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.






http://msdn2.microsoft.com/en-us/library/y3509fc2




GreaterThanOrEqual(PlTerm,PlTerm)


Inequality(PlTerm,PlTerm) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.

Inequality(PlTerm,Int32) summary

Inequality(Int32,PlTerm) summary

Inequality(PlTerm,String) test

Inequality(String,PlTerm) test

IsAtom ReturntrueifPlTermisanatom.

IsAtomic ReturntrueifPlTermisatomic(notvariableorcompound).

IsCompound ReturntrueifPlTermisacompoundterm.Notethatalistisacompoundterm./2

IsFloat ReturntrueifPlTermisafloat.

IsGround ReturntrueifPlTermisagroundterm.Seealsoground/1.Thisfunctioniscycle-safe.

IsInitialized returnfalseforaPlTermvariablewihichisonlydeclaretedandtruifitisalsoInitialized

IsInteger ReturntrueifPlTermisaninteger.

IsList ReturntrueifPlTermisacompoundtermwithfunctor./2ortheatom[].

IsNumber ReturntrueifPlTermisanintegerorfloat.

IsString ReturntrueifPlTermisastring.

IsVar ReturntrueifPlTermisavariable

Item[Int32]IfPlTermiscompoundandindexisbetween0andArity(including),thenthPlTermisreturned.

Ifposis0thefunctorofthetermisreturned(Foralist'.').

See:PL_get_arg/3

LessThan(PlTerm,PlTerm) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.

LessThanOrEqual(PlTerm,PlTerm)




http://gollem.science.uva.nl/SWI-Prolog/Manual//foreigninclude.html#PL_get_arg()




NameGetaholdingthenameofthefunctorifPlTermisacompoundterm.

NextValue() returnaPlTermboundtothenextelementofthelistPlTailandadvancePlTail.ReturnstheelementonsuccessorafreePlTerm(Variable)ifPlTailrepresentstheemptylist.IfPlTailisneitheralistnortheemptylist,aPlTypeException(type_error)isthrown.

PlCharList(String) CreateaProloglistofone-characteratomsfromaC#-string.

PlCodeList(String) CreateaProloglistofASCIIcodesfroma0-terminatedC-string.

PlCompound(String,PlTermV) Createacompoundtermwiththe

givennamefromthegivenvectorofarguments.SeePlTermVfordetails.

PlCompound(String,PlTerm)Createacompoundtermwiththegivennameantthearguments

PlCompound(String,PlTerm,PlTerm)

Createacompoundtermwiththegivennameantthearguments

PlCompound(String,PlTerm,PlTerm,PlTerm) Createacompoundtermwiththe

givennameantthearguments

PlString(String)

PlString(String,Int32)

PlTail(PlTerm)PlTailisforanalysingandconstructinglists.ItiscalledPlTailasenumeration-stepsmaketheterm-referencefollowthe`tail'ofthelist.

APlTailiscreatedbymakinganewterm-referencepointingtothesameobject.AsPlTailisusedtoenumerateorbuildaProloglist,theinitiallistterm-referencekeepspointingtotheheadofthelist.

PlType GetthePlTypeofaPlTerm.

PlVar() Createsanewinitialisedterm(holdingaPrologvariable).

ToList() ConvertstoastronglytypedReadOnlyCollectionofPlTerm

objectsthatcanbeaccessedbyindex

ToListString() ConvertstoastronglytypedCollectionofstringsthatcanbeaccessedbyindex

ToString()IfPlTermisalistthestringisbuildbycallingToString()foreachelementinthelistseparatedby','andputthebracketsaround'['']'.

(OverridesValueType.ToString().)

ToStringCanonical() ConvertaPlTermtoastringbyPL_get_chars/1withtheCVT_WRITE_CANONICALflag.IfitfailsPL_get_chars/3iscalledagainwithREP_MBflag.

Unify(PlTerm) UnifyaPlTermwithaPlTerm

Unify(String) UnifyaPlTermwithaPlTerm

Remarksstaticmethod DescriptionPlVar() Createsanewinitialisedterm(holdingaProlog

variable).

PlTail(PlTerm) PlTailisforanalysingandconstructinglists.


http://msdn2.microsoft.com/en-us/library/wb77sz3h

http://www.swi-prolog.org/pldoc/doc_for?object=c(%27PL_get_chars%27)

PlCompound(string) Createcompoundterms.E.g.byparsing(asread/1)thegiventext.

PlString(String) CreateaSWI-Prologstring.


PlCharList(String) CreateaProloglistofone-characteratomsfroma0-terminatedC-string.



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlTerm()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermConstructor

AnewPlTermcanbealsocreatedbythestaticmethods:staticmethod DescriptionPlVar() Createsanewinitialisedterm(holdingaProlog

variable).

PlTail(PlTerm) PlTailisforanalysingandconstructinglists.

PlCompound(string) Createcompoundterms.E.g.byparsing(asread/1)thegiventext.

PlString(String) CreateaSWI-Prologstring.


PlCharList(String) CreateaProloglistofone-characteratomsfroma0-terminatedC-string.


PlTerm(String) Createsaterm-referencesholdingaPrologtermrepresentingtext.

PlTerm(Int32) Createsaterm-referencesholdingaPrologintegerrepresentingvalue.

PlTerm(Double) Createsaterm-referencesholdingaPrologfloatrepresentingvalue.

SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlTerm(Double)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermConstructor(value)

Createsaterm-referencesholdingaPrologfloatrepresentingvalue.


publicPlTerm(

doublevalue

)

PublicSubNew(_

valueAsDouble_

)

public:

PlTerm(

doublevalue

)

Parametersvalue(Double)

adoublevalue


http://msdn2.microsoft.com/en-us/library/643eft0t





SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlTerm(Int32)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermConstructor(value)

Createsaterm-referencesholdingaPrologintegerrepresentingvalue.


publicPlTerm(

intvalue

)

PublicSubNew(_

valueAsInteger_

)

public:

PlTerm(

intvalue

)

Parametersvalue(Int32)

aintegervalue







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlTerm(String)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermConstructor(text)

Createsaterm-referencesholdingaPrologtermrepresentingtext.


publicPlTerm(

stringtext

)

PublicSubNew(_

textAsString_

)

public:

PlTerm(

String^text

)

Parameterstext(String)

thetext







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Add(PlTerm)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologAddMethod(term)

AppendsanelementtoalistbycreatinganewoneandcopyallelementsNoteThisisaslowversionseemymailfromJanfrom2007.11.0614:44


publicboolAdd(

PlTermterm

)

PublicFunctionAdd(_

termAsPlTerm_

)AsBoolean

public:

boolAdd(

PlTermterm

)

Parametersterm(PlTerm)

aclosedlist

ReturnValueTrueifSucceed






Copy

SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►AddList(PlTerm)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologAddListMethod(listToAppend)

Appendsalist(PlTail)toalistbycreatinganewoneandcopyallelements


publicboolAddList(

PlTermlistToAppend

)

PublicFunctionAddList(_

listToAppendAsPlTerm_

)AsBoolean

public:

boolAddList(

PlTermlistToAppend

)

ParameterslistToAppend(PlTerm)

aclosedlist

ReturnValueTrueifSucceed

Examples

C#

publicvoidList_Add_list_doc()

{




PlTermt=newPlTerm("[x,y]");

PlTerml=newPlTerm("[a,b]");

Assert.IsTrue(l.IsList);

Assert.IsTrue(l.AddList(t));


Assert.AreEqual("[a,b,x,y]",l.ToString());

Assert.AreEqual("a",l.NextValue().ToString());

Assert.AreEqual("b",l.NextValue().ToString());

Assert.AreEqual("[x,y]",l.ToString());

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Append(PlTerm)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologAppendMethod(term)

AppendselementtothelistandmakethePlTailreferencepointtothenewvariabletail.IfAisavariable,andthismethodiscalledonitusingtheargument"gnat",alistoftheform[gnat|B]iscreatedandthePlTailobjectnowpointstothenewvariableB.ThismethodreturnsTRUEiftheunificationsucceededandFALSEotherwise.Noexceptionsaregenerated.


publicboolAppend(

PlTermterm

)

PublicFunctionAppend(_

termAsPlTerm_

)AsBoolean

public:

boolAppend(

PlTermterm

)


ThePlTermtoappendonthelist.

ReturnValuetrueifsuccessfulotherwisefalse

Examples




CopyC#

publicvoidList_Append()

{

PlTermt=PlTerm.PlVar();

PlTerml=PlTerm.PlTail(t);

Assert.IsTrue(l.Append(newPlTerm("one")),"appendone"

Assert.IsTrue(l.Append(newPlTerm("two")),"appendtwo"

Assert.IsTrue(l.Append(newPlTerm("three")),"appendthree"

Assert.AreEqual(1,l.Close());

Assert.AreEqual(3,list_length(t));

Assert.AreEqual("[one,two,three]",t.ToString());

}



C#SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Arity

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologArityProperty

GetthearityofthefunctorifPlTermisacompoundterm.


publicintArity{get;}

PublicReadOnlyPropertyArityAsInteger

Get

public:

propertyintArity{

intget();

}

Remarks

ArityandNameareforcompoundtermsonly

ExceptionsException ConditionNotSupportedException Isthrownifthetermisn'tcompound






http://msdn2.microsoft.com/en-us/library/8a7a4e64


SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Close()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologCloseMethod

Unifiesthetermwith[]andreturnstheresultoftheunification.


publicintClose()

PublicFunctionCloseAsInteger

public:

intClose()

ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.PlTerm.Close"]






SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►CompareTo(Object)

C#


PrologCompareToMethod(obj)

Comparesthecurrentinstancewithanotherobjectofthesametypeandreturnsanintegerthatindicateswhetherthecurrentinstanceprecedes,follows,oroccursinthesamepositioninthesortorderastheotherobject.


publicintCompareTo(

Objectobj

)

PublicFunctionCompareTo(_

objAsObject_

)AsInteger

public:

virtualintCompareTo(

Object^obj

)sealed

Parametersobj(Object)

Anobjecttocomparewiththisinstance.

ReturnValueA32-bitsignedintegerthatindicatestherelativeorderoftheobjectsbeingcompared.Thereturnvaluehasthesemeanings:ValueMeaningLessthanzeroThisinstanceislessthanobj.ZeroThisinstanceisequaltoobj.GreaterthanzeroThisinstanceisgreaterthanobj.








ExceptionsException ConditionArgumentException objisnotthesametypeasthisinstance.


http://msdn2.microsoft.com/en-us/library/3w1b3114


SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Equality()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologEqualityMethod


Equality(PlTerm,PlTerm) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.

Equality(PlTerm,Int32)

Equality(Int32,PlTerm) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.

Equality(PlTerm,String) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.

Equality(String,PlTerm) YieldsTRUEifthePlTermisanatom

orstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Equality(PlTerm,PlTerm)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologEqualityOperator



publicstaticbooloperator==(

PlTermterm1,

PlTermterm2

)

PublicSharedOperator=(_

term1AsPlTerm,_

term2AsPlTerm_

)AsBoolean

public:

staticbooloperator==(

PlTermterm1,

PlTermterm2

)

Parametersterm1(PlTerm)

aPlTerm

term2(PlTerm)aPlTerm

ReturnValue




trueorfalse



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Equality(PlTerm,Int32)

C#


[Missing<summary>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Equality(SbsSW.SwiPlCs.PlTerm,System.Int32)"]



PlTermterm,

intlng

)


termAsPlTerm,_

lngAsInteger_

)AsBoolean

public:


PlTermterm,

intlng

)


aPlTerm

lng(Int32)aint

ReturnValue








Abool



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Equality(PlTerm,String)

C#





PlTermterm,

stringvalue

)


termAsPlTerm,_

valueAsString_

)AsBoolean

public:


PlTermterm,

String^value

)


[Missing<paramname="term"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Equality(SbsSW.SwiPlCs.PlTerm,System.String)"]

value(String)








[Missing<paramname="value"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Equality(SbsSW.SwiPlCs.PlTerm,System.String)"]

ReturnValuetrueorfalse



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Equality(Int32,PlTerm)

C#





intlng,

PlTermterm

)


lngAsInteger,_

termAsPlTerm_

)AsBoolean

public:


intlng,

PlTermterm

)

Parameterslng(Int32)

[Missing<paramname="lng"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Equality(System.Int32,SbsSW.SwiPlCs.PlTerm)"]

term(PlTerm)








[Missing<paramname="term"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Equality(System.Int32,SbsSW.SwiPlCs.PlTerm)"]




SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Equality(String,PlTerm)

C#





stringvalue,

PlTermterm

)


valueAsString,_

termAsPlTerm_

)AsBoolean

public:


String^value,

PlTermterm

)

Parametersvalue(String)

[Missing<paramname="value"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Equality(System.String,SbsSW.SwiPlCs.PlTerm)"]

term(PlTerm)








[Missing<paramname="term"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Equality(System.String,SbsSW.SwiPlCs.PlTerm)"]




SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Equals(Object)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologEqualsMethod(obj)

Indicateswhetherthisinstanceandaspecifiedobjectareequal.


publicoverrideboolEquals(

Objectobj

)

PublicOverridesFunctionEquals(_

objAsObject_

)AsBoolean

public:

virtualboolEquals(

Object^obj

)override


Anotherobjecttocompareto.

ReturnValuetrueifobjandthisinstancearethesametypeandrepresentthesamevalue;otherwise,false.










SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Explicit()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologExplicitMethod


Explicit(PlTermtoString) ConvertsthePrologargumentintoastringwhichimpliesPrologatomsandstringsareconvertedtotherepresentedtextorthrowaPlTypeException.

Explicit(PlTermtoInt32) YieldsaintifthePlTermisaPrologintegerorfloatthatcanbeconvertedwithoutlosstoaint.ThrowsaPlTypeExceptionexceptionotherwise

Explicit(PlTermtoDouble) YieldsthevalueasaC#doubleifPlTermrepresentsaPrologintegerorfloat.ThrowsaPlTypeExceptionexceptionotherwise.



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Explicit(PlTermtoString)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologExplicitOperator

ConvertsthePrologargumentintoastringwhichimpliesPrologatomsandstringsareconvertedtotherepresentedtextorthrowaPlTypeException.


publicstaticexplicitoperatorstring(

PlTermterm

)

PublicSharedNarrowingOperatorCType(_

termAsPlTerm_

)AsString

staticexplicitoperatorString^(

PlTermterm

)


APlTermthatcanbeconvertedtoastring

ReturnValueAC#string

Remarks

ConvertsthePrologargumentusingPL_get_chars()usingtheflagsCVT_ALL|CVT_WRITE|BUF_RING,whichimpliesPrologatomsandstringsareconvertedtotherepresentedtextorthrowaPlTypeException.




Iftheabovecallreturn0PL_get_charsiscalledasecondtimewiththeflagsCVT_ALL|CVT_WRITE|BUF_RING|REP_UTF8.

Allotherdataishandedtowrite/1.

MM23.11.2010:MeinesErachtensnachführtlibpl.REP_MBdiegewünschteKonvertierungnachUNICODE(MultiByte)durch.PasstabernichtzurDoku!

ExceptionsException ConditionPlTypeException ThrowsaPlTypeExceptionexception

PreconditionException IsthrowniftheoperatorisusedonanuninitializedPlTerm


http://gollem.science.uva.nl/SWI-Prolog/Manual/foreigninclude.html#PL_get_chars()


SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Explicit(PlTermtoDouble)

C#


YieldsthevalueasaC#doubleifPlTermrepresentsaPrologintegerorfloat.ThrowsaPlTypeExceptionexceptionotherwise.


publicstaticexplicitoperatordouble(

PlTermterm

)


termAsPlTerm_

)AsDouble

staticexplicitoperatordouble(

PlTermterm

)


APlTermrepresentsaPrologintegerorfloat

ReturnValueAC#double

ExceptionsException ConditionPlTypeException ThrowsaPlTypeExceptionexceptionif

PlTypeisnotaPlType.PlIntegerora




PlType.PlFloat.




SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Explicit(PlTermtoInt32)

C#


YieldsaintifthePlTermisaPrologintegerorfloatthatcanbeconvertedwithoutlosstoaint.ThrowsaPlTypeExceptionexceptionotherwise


publicstaticexplicitoperatorint(

PlTermterm

)


termAsPlTerm_

)AsInteger

staticexplicitoperatorint(

PlTermterm

)


APlTermisaPrologintegerorfloatthatcanbeconvertedwithoutlosstoaint.

ReturnValueAC#int

ExceptionsException ConditionPlTypeException ThrowsaPlTypeExceptionexceptionif




PlTypeisnotaPlType.PlIntegeroraPlType.PlFloat.




SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►GetEnumerator()C#


PrologGetEnumeratorMethod

Returnsanenumeratorthatiteratesthroughthecollection.


publicIEnumerator<PlTerm>GetEnumerator()

PublicFunctionGetEnumeratorAsIEnumerator(OfPlTerm

public:

virtualIEnumerator<PlTerm>^GetEnumerator()sealed

ReturnValueASystem.Collections.Generic.IEnumerator<Tthatcanbeusedtoiteratethroughthecollection.


http://msdn2.microsoft.com/en-us/library/78dfe2yb




SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►GetHashCode()C#


PrologGetHashCodeMethod

Returnsthehashcodeforthisinstance.


publicoverrideintGetHashCode()

PublicOverridesFunctionGetHashCodeAsInteger

public:

virtualintGetHashCode()override

ReturnValueA32-bitsignedintegerthatisthehashcodeforthisinstance.






SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►GreaterThan(PlTerm,PlTerm)

C#


PrologGreaterThanOperator



publicstaticbooloperator>(

PlTermterm1,

PlTermterm2

)

PublicSharedOperator>(_

term1AsPlTerm,_

term2AsPlTerm_

)AsBoolean

public:

staticbooloperator>(

PlTermterm1,

PlTermterm2

)


aPlTerm






SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►GreaterThanOrEqual(PlTerm,PlTerm)

C#


PrologGreaterThanOrEqualOperator



publicstaticbooloperator>=(

PlTermterm1,

PlTermterm2

)

PublicSharedOperator>=(_

term1AsPlTerm,_

term2AsPlTerm_

)AsBoolean

public:

staticbooloperator>=(

PlTermterm1,

PlTermterm2

)


aPlTerm






SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Inequality()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologInequalityMethod

InequalityMethodoverload

Equality(PlTerm,PlTerm)aEquality(PlTerm,Int32)


Inequality(PlTerm,PlTerm) YieldsTRUEifthePlTermisanatomorstringrepresentingthesametextastheargument,FALSEiftheconversionwassuccessful,butthestringsarenotequalandantype_errorexceptioniftheconversionfailed.

Inequality(PlTerm,Int32) summary

Inequality(Int32,PlTerm) summary

Inequality(PlTerm,String) test

Inequality(String,PlTerm) test



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Inequality(PlTerm,PlTerm)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologInequalityOperator



publicstaticbooloperator!=(

PlTermterm1,

PlTermterm2

)

PublicSharedOperator<>(_

term1AsPlTerm,_

term2AsPlTerm_

)AsBoolean

public:

staticbooloperator!=(

PlTermterm1,

PlTermterm2

)


aPlTerm


ReturnValue




trueorfalse



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Inequality(PlTerm,Int32)

C#


summary



PlTermterm,

intlng

)


termAsPlTerm,_

lngAsInteger_

)AsBoolean

public:


PlTermterm,

intlng

)


[Missing<paramname="term"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(SbsSW.SwiPlCs.PlTerm,System.Int32)"]

lng(Int32)

[Missing<paramname="lng"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(SbsSW.SwiPlCs.PlTerm,System.Int32)"]








ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(SbsSW.SwiPlCs.PlTerm,System.Int32)"]



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Inequality(PlTerm,String)

C#


test



PlTermterm,

stringvalue

)


termAsPlTerm,_

valueAsString_

)AsBoolean

public:


PlTermterm,

String^value

)


[Missing<paramname="term"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(SbsSW.SwiPlCs.PlTerm,System.String)"]

value(String)

[Missing<paramname="value"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(SbsSW.SwiPlCs.PlTerm,System.String)"]








ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(SbsSW.SwiPlCs.PlTerm,System.String)"]



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Inequality(Int32,PlTerm)

C#


summary



intlng,

PlTermterm

)


lngAsInteger,_

termAsPlTerm_

)AsBoolean

public:


intlng,

PlTermterm

)

Parameterslng(Int32)

[Missing<paramname="lng"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(System.Int32,SbsSW.SwiPlCs.PlTerm)"]

term(PlTerm)

[Missing<paramname="term"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(System.Int32,SbsSW.SwiPlCs.PlTerm)"]








ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(System.Int32,SbsSW.SwiPlCs.PlTerm)"]



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Inequality(String,PlTerm)

C#


test



stringvalue,

PlTermterm

)


valueAsString,_

termAsPlTerm_

)AsBoolean

public:


String^value,

PlTermterm

)

Parametersvalue(String)

[Missing<paramname="value"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(System.String,SbsSW.SwiPlCs.PlTerm)"]

term(PlTerm)

[Missing<paramname="term"/>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(System.String,SbsSW.SwiPlCs.PlTerm)"]








ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.PlTerm.op_Inequality(System.String,SbsSW.SwiPlCs.PlTerm)"]



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsAtomC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologIsAtomProperty

ReturntrueifPlTermisanatom.


publicboolIsAtom{get;}

PublicReadOnlyPropertyIsAtomAsBoolean

Get

public:

propertyboolIsAtom{

boolget();

}

SeeAlsoPlType







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsAtomicC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologIsAtomicProperty

ReturntrueifPlTermisatomic(notvariableorcompound).


publicboolIsAtomic{get;}

PublicReadOnlyPropertyIsAtomicAsBoolean

Get

public:

propertyboolIsAtomic{

boolget();

}

SeeAlsoPlType







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsCompoundC#


PrologIsCompoundProperty

ReturntrueifPlTermisacompoundterm.Notethatalistisacompoundterm./2


publicboolIsCompound{get;}

PublicReadOnlyPropertyIsCompoundAsBoolean

Get

public:

propertyboolIsCompound{

boolget();

}

SeeAlsoPlType







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsFloatC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologIsFloatProperty

ReturntrueifPlTermisafloat.


publicboolIsFloat{get;}

PublicReadOnlyPropertyIsFloatAsBoolean

Get

public:

propertyboolIsFloat{

boolget();

}

SeeAlsoPlType







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsGroundC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologIsGroundProperty

ReturntrueifPlTermisagroundterm.Seealsoground/1.Thisfunctioniscycle-safe.


publicboolIsGround{get;}

PublicReadOnlyPropertyIsGroundAsBoolean

Get

public:

propertyboolIsGround{

boolget();

}

SeeAlsoPlType







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsInitializedC#


PrologIsInitializedProperty

returnfalseforaPlTermvariablewihichisonlydeclaretedandtruifitisalsoInitialized


publicboolIsInitialized{get;}

PublicReadOnlyPropertyIsInitializedAsBoolean

Get

public:

propertyboolIsInitialized{

boolget();

}







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsIntegerC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologIsIntegerProperty

ReturntrueifPlTermisaninteger.


publicboolIsInteger{get;}

PublicReadOnlyPropertyIsIntegerAsBoolean

Get

public:

propertyboolIsInteger{

boolget();

}

SeeAlsoPlType







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsListC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologIsListProperty

ReturntrueifPlTermisacompoundtermwithfunctor./2ortheatom[].


publicboolIsList{get;}

PublicReadOnlyPropertyIsListAsBoolean

Get

public:

propertyboolIsList{

boolget();

}

SeeAlsoPlType







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsNumberC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologIsNumberProperty

ReturntrueifPlTermisanintegerorfloat.


publicboolIsNumber{get;}

PublicReadOnlyPropertyIsNumberAsBoolean

Get

public:

propertyboolIsNumber{

boolget();

}

SeeAlsoPlType







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsStringC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologIsStringProperty

ReturntrueifPlTermisastring.


publicboolIsString{get;}

PublicReadOnlyPropertyIsStringAsBoolean

Get

public:

propertyboolIsString{

boolget();

}

SeeAlsoPlType







C#SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►IsVar

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologIsVarProperty

ReturntrueifPlTermisavariable


publicboolIsVar{get;}

PublicReadOnlyPropertyIsVarAsBoolean

Get

public:

propertyboolIsVar{

boolget();

}

SeeAlsoPlType







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Item[Int32]C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologItemProperty(pos)

IfPlTermiscompoundandindexisbetween0andArity(including),thenthPlTermisreturned.

Ifposis0thefunctorofthetermisreturned(Foralist'.').

See:PL_get_arg/3


publicPlTermthis[

intpos

]{get;}

PublicReadOnlyDefaultPropertyItem(_

posAsInteger_

)AsPlTerm

Get

public:

propertyPlTermdefault[intpos]{

PlTermget(intpos);

}

Parameterspos(Int32)

ToGetthenthPlTerm

ReturnValueaPlTerm

http://gollem.science.uva.nl/SWI-Prolog/Manual//foreigninclude.html#PL_get_arg()






Copy

Examples

C#

[TestMethod]

publicvoidPlTermIndexer2()

{

PlTermt=PlTerm.PlCompound("foo(bar,x(y))");

Assert.AreEqual("foo",t[0].ToString());

Assert.AreEqual("bar",t[1].ToString());

Assert.AreEqual("x(y)",t[2].ToString());

}

[TestMethod]

publicvoidPlTermIndexer_list1()

{

PlTermt=PlTerm.PlCompound("[a,b,c]");

Assert.AreEqual(".",t[0].ToString());

Assert.AreEqual("a",t[1].ToString());

Assert.AreEqual("[b,c]",t[2].ToString());

}

ExceptionsException ConditionNotSupportedException IsthrownifPlTermisnotofType

PlCompoundseeIsCompound

ArgumentOutOfRangeExceptionIsthrownif(pos<0||pos>=Arity)

InvalidOperationException IsthrownifPL_get_argreturns0.



http://msdn2.microsoft.com/en-us/library/8xt94y6e

http://msdn2.microsoft.com/en-us/library/2asft85a


SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►LessThan(PlTerm,PlTerm)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologLessThanOperator



publicstaticbooloperator<(

PlTermterm1,

PlTermterm2

)

PublicSharedOperator<(_

term1AsPlTerm,_

term2AsPlTerm_

)AsBoolean

public:

staticbooloperator<(

PlTermterm1,

PlTermterm2

)


aPlTerm


ReturnValue




trueorfalse



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►LessThanOrEqual(PlTerm,PlTerm)

C#


PrologLessThanOrEqualOperator



publicstaticbooloperator<=(

PlTermterm1,

PlTermterm2

)

PublicSharedOperator<=(_

term1AsPlTerm,_

term2AsPlTerm_

)AsBoolean

public:

staticbooloperator<=(

PlTermterm1,

PlTermterm2

)


aPlTerm






SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►NameC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologNameProperty

GetaholdingthenameofthefunctorifPlTermisacompoundterm.


publicstringName{get;}

PublicReadOnlyPropertyNameAsString

Get

public:

propertyString^Name{

String^get();

}

Remarks

ArityandNameareforcompoundtermsonly

ExceptionsException ConditionNotSupportedException Isthrownifthetermisn'tcompound








Copy

SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►NextValue()C#


PrologNextValueMethod

returnaPlTermboundtothenextelementofthelistPlTailandadvancePlTail.ReturnstheelementonsuccessorafreePlTerm(Variable)ifPlTailrepresentstheemptylist.IfPlTailisneitheralistnortheemptylist,aPlTypeException(type_error)isthrown.


publicPlTermNextValue()

PublicFunctionNextValueAsPlTerm

public:

PlTermNextValue()

ReturnValueTheNextelementinthelistasaPlTermwhichisavariableforthelastelementoranemptylist

Examples

C#

publicvoidList_Add_list_doc()

{

PlTermt=newPlTerm("[x,y]");

PlTerml=newPlTerm("[a,b]");


Assert.IsTrue(l.AddList(t));


Assert.AreEqual("[a,b,x,y]",l.ToString());

Assert.AreEqual("a",l.NextValue().ToString());

Assert.AreEqual("b",l.NextValue().ToString());

Assert.AreEqual("[x,y]",l.ToString());

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlCharList(String)C#


PrologPlCharListMethod(text)

CreateaProloglistofone-characteratomsfromaC#-string.


publicstaticPlTermPlCharList(

stringtext

)

PublicSharedFunctionPlCharList(_

textAsString_

)AsPlTerm

public:

staticPlTermPlCharList(

String^text

)


astring

ReturnValueAnewPlTermcontainingaprologlistofcharacter

RemarksCharacterlistsarecomplianttoProlog'satom_chars/2predicate.

byUweLesta,SBS-SoftwaresystemeGmbHSendcommentsonthistopictoLestaatSBS-Softwaresysteme.deAssembly:SwiPlCs(Module:SwiPlCs)Version:1.1.60301.0





http://gollem.science.uva.nl/SWI-Prolog/Manual/manipatom.html#atom_chars/2


(1.1.60301.0)

SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlCodeList(String)C#


PrologPlCodeListMethod(text)

CreateaProloglistofASCIIcodesfroma0-terminatedC-string.


publicstaticPlTermPlCodeList(

stringtext

)

PublicSharedFunctionPlCodeList(_

textAsString_

)AsPlTerm

public:

staticPlTermPlCodeList(

String^text

)


Thetext

ReturnValueanewPlTerm







SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlCompound()C#


PrologPlCompoundMethod


PlCompound(String,PlTermV) Createacompoundtermwiththe

givennamefromthegivenvectorofarguments.SeePlTermVfordetails.

PlCompound(String,PlTerm) Createacompoundtermwiththe


PlCompound(String,PlTerm,PlTerm) Createacompoundtermwiththe


PlCompound(String,PlTerm,PlTerm,PlTerm) Createacompoundtermwiththe




SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlCompound(String,PlTerm)

C#


PrologPlCompoundMethod(functor,arg1)



publicstaticPlTermPlCompound(

stringfunctor,

PlTermarg1

)

PublicSharedFunctionPlCompound(_

functorAsString,_

arg1AsPlTerm_

)AsPlTerm

public:

staticPlTermPlCompound(

String^functor,

PlTermarg1

)

Parametersfunctor(String)

Thefunctor(name)ofthecompoundterm

arg1(PlTerm)ThefirstArgumentasaPlTerm






SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlCompound(String,PlTerm,PlTerm)

C#


PrologPlCompoundMethod(functor,arg1,arg2)




stringfunctor,

PlTermarg1,

PlTermarg2

)


functorAsString,_

arg1AsPlTerm,_

arg2AsPlTerm_

)AsPlTerm

public:


String^functor,

PlTermarg1,

PlTermarg2

)




arg2(PlTerm)





ThesecondArgumentasaPlTerm




SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlCompound(String,PlTerm,PlTerm,PlTerm)

C#


PrologPlCompoundMethod(functor,arg1,arg2,arg3)




stringfunctor,

PlTermarg1,

PlTermarg2,

PlTermarg3

)


functorAsString,_

arg1AsPlTerm,_

arg2AsPlTerm,_

arg3AsPlTerm_

)AsPlTerm

public:


String^functor,

PlTermarg1,

PlTermarg2,

PlTermarg3

)








arg2(PlTerm)ThesecondArgumentasaPlTerm

arg3(PlTerm)ThethirdArgumentasaPlTerm




SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlCompound(String,PlTermV)

C#


PrologPlCompoundMethod(functor,args)

Createacompoundtermwiththegivennamefromthegivenvectorofarguments.SeePlTermVfordetails.



stringfunctor,

PlTermVargs

)


functorAsString,_

argsAsPlTermV_

)AsPlTerm

public:


String^functor,

PlTermVargs

)



args(PlTermV)theargumentsasaPlTermV






Copy

Examples

TheexamplebelowcreatesthePrologtermhello(world).

C#

PlTermt=PlTerm.PlCompound("hello",newPlTermv("world"



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlString()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlStringMethod

ASWI-Prologstringrepresentsabyte-stringontheglobalstack.It'slifetimeisthesameasforcompoundtermsandotherdatalivingontheglobalstack.Stringsarenotonlyacompoundrepresentationoftextthatisgarbage-collected,butastheycancontain0-bytes,theycanbeusedtocontainarbitraryC-datastructures.


PlString(String)

PlString(String,Int32)



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlString(String)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlStringMethod(text)

[Missing<summary>documentationfor"M:SbsSW.SwiPlCs.PlTerm.PlString(System.String)"]


publicstaticPlTermPlString(

stringtext

)

PublicSharedFunctionPlString(_

textAsString_

)AsPlTerm

public:

staticPlTermPlString(

String^text

)


thestring








SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlString(String,Int32)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlStringMethod(text,len)

[Missing<summary>documentationfor"M:SbsSW.SwiPlCs.PlTerm.PlString(System.String,System.Int32)"]


publicstaticPlTermPlString(

stringtext,

intlen

)

PublicSharedFunctionPlString(_

textAsString,_

lenAsInteger_

)AsPlTerm

public:

staticPlTermPlString(

String^text,

intlen

)


thestring

len(Int32)thelengthofthestring

ReturnValue









anewPlTerm



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlTail(PlTerm)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTailMethod(list)

PlTailisforanalysingandconstructinglists.ItiscalledPlTailasenumeration-stepsmaketheterm-referencefollowthe`tail'ofthelist.

APlTailiscreatedbymakinganewterm-referencepointingtothesameobject.AsPlTailisusedtoenumerateorbuildaProloglist,theinitiallistterm-referencekeepspointingtotheheadofthelist.


publicstaticPlTermPlTail(

PlTermlist

)

PublicSharedFunctionPlTail(_

listAsPlTerm_

)AsPlTerm

public:

staticPlTermPlTail(

PlTermlist

)

Parameterslist(PlTerm)

TheinitialPlTerm

ReturnValueAPlTermforwhichis_list/1succeed.

Examples

CopyC#

publicvoidList_Append()

{


PlTerml=PlTerm.PlTail(t);

Assert.IsTrue(l.Append(newPlTerm("one")),"appendone"

Assert.IsTrue(l.Append(newPlTerm("two")),"appendtwo"

Assert.IsTrue(l.Append(newPlTerm("three")),"appendthree"

Assert.AreEqual(1,l.Close());

Assert.AreEqual(3,list_length(t));

Assert.AreEqual("[one,two,three]",t.ToString());

}

SeeAlsoAppend(PlTerm)Add(PlTerm)AddList(PlTerm)Close()NextValue()



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlTypeC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTypeProperty

GetthePlTypeofaPlTerm.


publicPlTypePlType{get;}

PublicReadOnlyPropertyPlTypeAsPlType

Get

public:

propertyPlTypePlType{

PlTypeget();

}



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►PlVar()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlVarMethod

Createsanewinitialisedterm(holdingaPrologvariable).


publicstaticPlTermPlVar()

PublicSharedFunctionPlVarAsPlTerm

public:

staticPlTermPlVar()

ReturnValueaPlTerm



SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►ToList()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologToListMethod

ConvertstoastronglytypedReadOnlyCollectionofPlTermobjectsthatcanbeaccessedbyindex


publicReadOnlyCollection<PlTerm>ToList()

PublicFunctionToListAsReadOnlyCollection(OfPlTerm

public:

ReadOnlyCollection<PlTerm>^ToList()

ReturnValueAstronglytypedReadOnlyCollectionofPlTermobjects






SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►ToListString()C#


PrologToListStringMethod

ConvertstoastronglytypedCollectionofstringsthatcanbeaccessedbyindex


publicCollection<string>ToListString()

PublicFunctionToListStringAsCollection(OfString

public:

Collection<String^>^ToListString()

ReturnValueAstronglytypedstringCollection









SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►ToString()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologToStringMethod

IfPlTermisalistthestringisbuildbycallingToString()foreachelementinthelistseparatedby','andputthebracketsaround'['']'.


publicoverridestringToString()

PublicOverridesFunctionToStringAsString

public:

virtualString^ToString()override

ReturnValueAstringrepresentingthePlTerm.

SeeAlso[O:string]






SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►ToStringCanonical()

C#


PrologToStringCanonicalMethod

ConvertaPlTermtoastringbyPL_get_chars/1withtheCVT_WRITE_CANONICALflag.IfitfailsPL_get_chars/3iscalledagainwithREP_MBflag.


publicstringToStringCanonical()

PublicFunctionToStringCanonicalAsString

public:

String^ToStringCanonical()

ReturnValuereturnthestringofaPlTerm

ExceptionsException ConditionPlTypeException ThrowsaPlTypeExceptionif

PL_get_chars/3didn'tsucceeds.


http://www.swi-prolog.org/pldoc/doc_for?object=c(%27PL_get_chars%27)





SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Unify()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologUnifyMethod

ThismethodsperformsPrologunificationandreturnstrueifsuccessfulandfalseotherwise.Itisequaltotheprolog=/2operator.

SeeUnify(PlTerm)foranexample.

RemarksThismethodsareintroducedforclearseparationbetweenthedestructiveassignmentinC#using=andprologunification.


Unify(PlTerm) UnifyaPlTermwithaPlTerm

Unify(String) UnifyaPlTermwithaPlTerm



Copy

SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Unify(PlTerm)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologUnifyMethod(term)

UnifyaPlTermwithaPlTerm


publicboolUnify(

PlTermterm

)

PublicFunctionUnify(_

termAsPlTerm_

)AsBoolean

public:

boolUnify(

PlTermterm

)


thesecondtermforunification


Examples

C#

publicvoidUnifyTermVar_doc()

{

PlTermt1=newPlTerm("x(A,2)");




PlTermt2=newPlTerm("x(1,B)");


Assert.AreEqual("x(1,2)",t1.ToString());


}



Copy

SwiPlCsinterface►SbsSW.SwiPlCs►PlTerm►Unify(String)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologUnifyMethod(atom)

UnifyaPlTermwithaPlTerm


publicboolUnify(

stringatom

)

PublicFunctionUnify(_

atomAsString_

)AsBoolean

public:

boolUnify(

String^atom

)

Parametersatom(String)

Astringtounifywith


Examples

C#

publicvoidUnifyTermVar_doc()

{

PlTermt1=newPlTerm("x(A,2)");








PlTermt2=newPlTerm("x(1,B)");




}



C#SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermVStructure

ThisAPIispreliminaryandsubjecttochange.

Thistypeisusedtopasstheargumentstoaforeigndefinedpredicate(seeDelegateParameterVarArgs),constructcompoundterms(seePlCompound(String,PlTermV)andtocreatequeries(seePlQuery).

Theonlyusefulmemberfunctionistheoverloadingof[],providing(0-based)accesstotheelements.Item[Int32]RangecheckingisperformedandraisesaArgumentOutOfRangeExceptionexception.


publicstructPlTermV:IEquatable<PlTermV>

PublicStructurePlTermV_

ImplementsIEquatable(OfPlTermV)

publicvalueclassPlTermV:IEquatable<PlTermV>


PublicProtected

InstanceStatic

Declared


PlTermV(Int32) CreateavectorofPlTermswithsizeelements




PlTermV(PlTerm) CreateaPlTermVfromthegivenPlTerms.

PlTermV(PlTerm,PlTerm) CreateaPlTermVfromthegivenPlTerms.

PlTermV(PlTerm,PlTerm,PlTerm)

CreateaPlTermVfromthegivenPlTerms.

PlTermV(PlTerm[]) CreateaPlTermVfromthegivenPlTerm[]array.

Equality(PlTermV,PlTermV)



Equals(PlTermV) Indicateswhetherthecurrentobjectisequaltoanotherobjectofthesametype.



GetHashCode() Returnsthehashcodeforthisinstance.







(OverridesValueType.GetHashCode().)



Inequality(PlTermV,PlTermV)

Item[Int32] Azerobasedlist



Size GetthesizeofaPlTermV

ToString() Returnsthefullyqualifiedtypenameofthisinstance.

(InheritedfromValueType.)



http://msdn2.microsoft.com/en-us/library/y3509fc2







http://msdn2.microsoft.com/en-us/library/wb77sz3h



SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►PlTermV()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermVConstructor

CreateaPlTermVvectorfromthegivenPlTermparameters

CreateanewvectorwithPlTermaselements

Itcanbecreatedwithsizeelements

or

automaticallyfor1,2or3plTerms


PlTermV(Int32) CreateavectorofPlTermswithsizeelements

PlTermV(PlTerm) CreateaPlTermVfromthegivenPlTerms.

PlTermV(PlTerm,PlTerm) CreateaPlTermVfromthegivenPlTerms.

PlTermV(PlTerm,PlTerm,PlTerm)


PlTermV(PlTerm[]) CreateaPlTermVfromthegivenPlTerm[]array.

SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►PlTermV(PlTerm)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermVConstructor(term0)



publicPlTermV(

PlTermterm0

)

PublicSubNew(_

term0AsPlTerm_

)

public:

PlTermV(

PlTermterm0

)


ThefirstPlTerminthevector.



SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►PlTermV(PlTerm,PlTerm)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermVConstructor(term0,term1)



publicPlTermV(

PlTermterm0,

PlTermterm1

)

PublicSubNew(_

term0AsPlTerm,_

term1AsPlTerm_

)

public:

PlTermV(

PlTermterm0,

PlTermterm1

)



term1(PlTerm)ThesecondPlTerminthevector.

byUweLesta,SBS-SoftwaresystemeGmbHSendcommentsonthistopictoLestaatSBS-Softwaresysteme.deAssembly:SwiPlCs(Module:SwiPlCs)Version:1.1.60301.0


(1.1.60301.0)

SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►PlTermV(PlTerm,PlTerm,PlTerm)

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermVConstructor(term0,term1,term2)



publicPlTermV(

PlTermterm0,

PlTermterm1,

PlTermterm2

)

PublicSubNew(_

term0AsPlTerm,_

term1AsPlTerm,_

term2AsPlTerm_

)

public:

PlTermV(

PlTermterm0,

PlTermterm1,

PlTermterm2

)



term1(PlTerm)ThesecondPlTerminthevector.

term2(PlTerm)

ThethirdPlTerminthevector.



Copy

SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►PlTermV(PlTerm[])

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermVConstructor(terms)

CreateaPlTermVfromthegivenPlTerm[]array.


publicPlTermV(

PlTerm[]terms

)

PublicSubNew(_

termsAsPlTerm()_

)

public:

PlTermV(

array<PlTerm>^terms

)

Parametersterms(PlTerm[])

AnarrayofPlTermstobuildthevector.

ExamplesUseofInitializinganArrayinCSharp

C#

PlTermVv=newPlTermV(newPlTerm[]{t1,t2,t3,t4});


SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►PlTermV(Int32)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTermVConstructor(size)

CreateavectorofPlTermswithsizeelements


publicPlTermV(

intsize

)

PublicSubNew(_

sizeAsInteger_

)

public:

PlTermV(

intsize

)

Parameterssize(Int32)

TheamountofPlTermsinthevector







SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►Equality(PlTermV,PlTermV)

C#


[Missing<summary>documentationfor"M:SbsSW.SwiPlCs.PlTermV.op_Equality(SbsSW.SwiPlCs.PlTermV,SbsSW.SwiPlCs.PlTermV)"]



PlTermVtv1,

PlTermVtv2

)


tv1AsPlTermV,_

tv2AsPlTermV_

)AsBoolean

public:


PlTermVtv1,

PlTermVtv2

)

Parameterstv1(PlTermV)

[Missing<paramname="tv1"/>documentationfor"M:SbsSW.SwiPlCs.PlTermV.op_Equality(SbsSW.SwiPlCs.PlTermV,SbsSW.SwiPlCs.PlTermV)"]

tv2(PlTermV)




[Missing<paramname="tv2"/>documentationfor"M:SbsSW.SwiPlCs.PlTermV.op_Equality(SbsSW.SwiPlCs.PlTermV,SbsSW.SwiPlCs.PlTermV)"]

ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.PlTermV.op_Equality(SbsSW.SwiPlCs.PlTermV,SbsSW.SwiPlCs.PlTermV)"]



SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►Equals()C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologEqualsMethod




Equals(PlTermV) Indicateswhetherthecurrentobjectisequaltoanotherobjectofthesametype.





SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►Equals(PlTermV)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologEqualsMethod(other)

Indicateswhetherthecurrentobjectisequaltoanotherobjectofthesametype.


publicboolEquals(

PlTermVother

)

PublicFunctionEquals(_

otherAsPlTermV_

)AsBoolean

public:

virtualboolEquals(

PlTermVother

)sealed

Parametersother(PlTermV)

Anobjecttocomparewiththisobject.

ReturnValuetrueifthecurrentobjectisequaltotheotherparameter;otherwise,false.

Remarks//TODOcompareeachPlTerminPlTermVnotonlythereferecesinA0






SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►Equals(Object)C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologEqualsMethod(obj)

Indicateswhetherthisinstanceandaspecifiedobjectareequal.


publicoverrideboolEquals(

Objectobj

)

PublicOverridesFunctionEquals(_

objAsObject_

)AsBoolean

public:

virtualboolEquals(

Object^obj

)override


Anotherobjecttocompareto.

ReturnValuetrueifobjandthisinstancearethesametypeandrepresentthesamevalue;otherwise,false.










SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►GetHashCode()C#


PrologGetHashCodeMethod

Returnsthehashcodeforthisinstance.


publicoverrideintGetHashCode()

PublicOverridesFunctionGetHashCodeAsInteger

public:

virtualintGetHashCode()override

ReturnValueA32-bitsignedintegerthatisthehashcodeforthisinstance.






SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►Inequality(PlTermV,PlTermV)

C#


[Missing<summary>documentationfor"M:SbsSW.SwiPlCs.PlTermV.op_Inequality(SbsSW.SwiPlCs.PlTermV,SbsSW.SwiPlCs.PlTermV)"]



PlTermVtv1,

PlTermVtv2

)


tv1AsPlTermV,_

tv2AsPlTermV_

)AsBoolean

public:


PlTermVtv1,

PlTermVtv2

)

Parameterstv1(PlTermV)

[Missing<paramname="tv1"/>documentationfor"M:SbsSW.SwiPlCs.PlTermV.op_Inequality(SbsSW.SwiPlCs.PlTermV,SbsSW.SwiPlCs.PlTermV)"]

tv2(PlTermV)




[Missing<paramname="tv2"/>documentationfor"M:SbsSW.SwiPlCs.PlTermV.op_Inequality(SbsSW.SwiPlCs.PlTermV,SbsSW.SwiPlCs.PlTermV)"]

ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.PlTermV.op_Inequality(SbsSW.SwiPlCs.PlTermV,SbsSW.SwiPlCs.PlTermV)"]



SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►Item[Int32]C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologItemProperty(index)

Azerobasedlist


publicPlTermthis[

intindex

]{get;set;}

PublicDefaultPropertyItem(_

indexAsInteger_

)AsPlTerm

Get

Set

public:

propertyPlTermdefault[intindex]{

PlTermget(intindex);

voidset(intindex,PlTermvalue);

}

Parametersindex(Int32)

ReturnValueThePlTermforthegivenindex

ExceptionsException ConditionArgumentOutOfRangeExceptionIsthrownif(index<0||index>=Size)







http://msdn2.microsoft.com/en-us/library/8xt94y6e

SwiPlCsinterface►SbsSW.SwiPlCs►PlTermV►SizeC#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologSizeProperty

GetthesizeofaPlTermV


publicintSize{get;}

PublicReadOnlyPropertySizeAsInteger

Get

public:

propertyintSize{

intget();

}







C#SwiPlCsinterface►SbsSW.SwiPlCs►PlType

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlTypeEnumeration

Obtainthetypeofaterm,whichshouldbeatermreturnedbyoneoftheotherinterfacepredicatesorpassedasanargument.ThefunctionreturnsthetypeofthePrologterm.Thetypeidentifiersarelistedbelow.


publicenumPlType

PublicEnumerationPlType

publicenumclassPlType

MembersMember DescriptionPlUnknown 0-PL_UNKNOWN:Undefined

PlVariable 1-PL_VARIABLE:Anunboundvariable.Thevalueoftermassuchisauniqueidentifierforthevariable.

PlAtom 2-PL_ATOM:APrologatom.

PlInteger 3-PL_INTEGER:AProloginteger.

PlFloat 4-PL_FLOAT:APrologfloatingpointnumber.

PlString 5-PL_STRING:APrologstring.

PlTerm 6-PL_TERM:Acompoundterm.Notethatalistisacompoundterm./2.

Remarks

Copy

seePL_term_type(term_t)intheSWI-PrologManual.

ExamplesInthissampleaPrologvariableiscreatedinPlTermtandthePlTypeischeckedbyhisintegerrepresentationandhisname.

C#


Assert.AreEqual(1,(int)t.PlType);

Assert.AreEqual(PlType.PlVariable,t.PlType);

SeeAlsoPlType


http://gollem.science.uva.nl/SWI-Prolog/Manual/foreigninclude.html#PL_term_type()


C#SwiPlCsinterface►SbsSW.SwiPlCs.Callback


PrologSbsSW.SwiPlCs.CallbackNamespace

ThenamespaceSbsSW.SwiPlCs.Callbackprovidesthedelegatestoregister.NETmethodstobecalledfromSWI-Prolog


namespaceSbsSW.SwiPlCs.Callback

NamespaceSbsSW.SwiPlCs.Callback

namespaceSbsSW.SwiPlCs.Callback

TypesAllTypes Enumerations Delegates

Icon Type DescriptionDelegateParameter0

ProvideapredefinedDelegatetoregisteraC#methodtobecalledfromSWI-Prolog

DelegateParameter1ProvideapredefinedDelegatetoregisteraC#methodtobecalledfromSWI-Prolog

DelegateParameter2ProvideapredefinedDelegatetoregisteraC#methodtobecalled


fromSWI-Prolog

DelegateParameter3ProvideapredefinedDelegatetoregisteraC#methodtobecalledfromSWI-Prolog

DelegateParameterBacktrackNOTIMPLEMENTEDYET

Fordetailstoimplementsee9.6.17RegisteringForeignPredicates

seealsoPL_foreign_control

DelegateParameterVarArgsWiththisdelegateyoucanbuildacall-backpredicatewithavariableamountofparameters.

PlForeignSwitches Flagsthatareresponsiblefortheforeignpredicateparameters

RemarksNote:Itisonlypossibletocallstaticmethods

SeeAlsoRegisterForeign(String,Delegate)

http://gollem.science.uva.nl/SWI-Prolog/Manual/foreigninclude.html#PL_register_foreign_in_module()

http://gollem.science.uva.nl/SWI-Prolog/Manual/foreigninclude.html#PL_foreign_control()

Copy

SwiPlCsinterface►SbsSW.SwiPlCs.Callback►DelegateParameter0

C#


PrologDelegateParameter0Delegate



publicdelegateboolDelegateParameter0()

PublicDelegateFunctionDelegateParameter0AsBoolean

publicdelegateboolDelegateParameter0()

ReturnValuetrueforsucceedingotherwisefalseforfail

Examples

ThisexampleisforDelegateParameter2andshowshowocallaC#methodwithtwoparameter.

ForothersamplesseethesourcefileCallbackForeigenPredicate.csintheTestSwiPlVS2008testproject.

C#

publicvoidt_in_out()

{

DelegatereplaceDelegate=newDelegateParameter2(atom_replace);

PlEngine.RegisterForeign(replaceDelegate);

for(inti=1;i<10;i++)

{




PlTermVarg=newPlTermV(newPlTerm("test_f"

PlQuery.PlCall("atom_replace",arg);

Assert.AreEqual("test_xx_f",arg[1].ToString(),

}

}

publicstaticboolatom_replace(PlTermatom_in,PlTermatom_out)

{

returnatom_out.Unify(atom_in.ToString().Replace(

}

SeeAlsoRegisterForeign(Delegate)PlEngine()



Copy


C#





publicdelegateboolDelegateParameter1(

PlTermterm

)

PublicDelegateFunctionDelegateParameter1(_

termAsPlTerm_

)AsBoolean


PlTermterm

)



Examples

SeealsotheexampleinDelegateParameter2.

C#

[TestMethod]




publicvoidt_creating_a_list()

{

Delegated=newDelegateParameter1(create_list);

PlEngine.RegisterForeign(d);


{

PlTermt=PlQuery.PlCallQuery("create_list(L)"

Assert.AreEqual("[a,b,c]",t.ToString(),"create_listfailed!"

}

}

publicstaticboolcreate_list(PlTermlist)

{

returnlist.Unify(newPlTerm("[a,b,c]"));

}





C#






PlTermterm1,

PlTermterm2

)


term1AsPlTerm,_

term2AsPlTerm_

)AsBoolean


PlTermterm1,

PlTermterm2

)

Parametersterm1(PlTerm)term2(PlTerm)


Examples




Copy



C#


{




{




}

}


{


}





C#






PlTermterm1,

PlTermterm2,

PlTermterm3

)


term1AsPlTerm,_

term2AsPlTerm,_

term3AsPlTerm_

)AsBoolean


PlTermterm1,

PlTermterm2,

PlTermterm3

)

Parametersterm1(PlTerm)term2(PlTerm)term3(PlTerm)

ReturnValue




Copy

trueforsucceedingotherwisefalseforfail

Examples



C#


{




{




}

}


{


}




SwiPlCsinterface►SbsSW.SwiPlCs.Callback►DelegateParameterBacktrack

C#


PrologDelegateParameterBacktrackDelegate

NOTIMPLEMENTEDYET

Fordetailstoimplementsee9.6.17RegisteringForeignPredicates

seealsoPL_foreign_control


publicdelegateintDelegateParameterBacktrack(

PlTermterm1,

PlTermterm2,

IntPtrcontrol

)

PublicDelegateFunctionDelegateParameterBacktrack(_

term1AsPlTerm,_

term2AsPlTerm,_

controlAsIntPtr_

)AsInteger

publicdelegateintDelegateParameterBacktrack(

PlTermterm1,

PlTermterm2,

IntPtrcontrol

)


TODO

http://gollem.science.uva.nl/SWI-Prolog/Manual/foreigninclude.html#PL_register_foreign_in_module()

http://gollem.science.uva.nl/SWI-Prolog/Manual/foreigninclude.html#PL_foreign_control()


http://msdn2.microsoft.com/en-us/library/5he14kz8





term2(PlTerm)TODO

control(IntPtr)TODO

ReturnValueTODO

ExamplesTODO

See"t_backtrack"inTestSwiPl.CallbackForeigenPredicate.cs




Copy

SwiPlCsinterface►SbsSW.SwiPlCs.Callback►DelegateParameterVarArgs

C#


PrologDelegateParameterVarArgsDelegate

Withthisdelegateyoucanbuildacall-backpredicatewithavariableamountofparameters.


publicdelegateboolDelegateParameterVarArgs(

PlTermVtermVector

)

PublicDelegateFunctionDelegateParameterVarArgs(_

termVectorAsPlTermV_

)AsBoolean

publicdelegateboolDelegateParameterVarArgs(

PlTermVtermVector

)

ParameterstermVector(PlTermV)

ThetermVectorrepresentingtheargumentswhichcanbeaccessedbytheindexerofPlTermVseePlTermV.TheamountofparametersisinSize

ReturnValueTrueforsucceedingotherwisefalseforfail

Examples

C#




publicvoidt_varargs()

{

Delegated=newDelegateParameterVarArgs(my_concat_atom);

PlEngine.RegisterForeign("my_concat_atom",4,d);

PlEngine.RegisterForeign("my_concat_atom",7,d);


{

PlTermt=PlQuery.PlCallQuery("my_concat_atom(a,b,c,X)"

Assert.AreEqual("abc",t.ToString(),"my_concat_atomfailed!"

t=PlQuery.PlCallQuery("my_concat_atom(a,b,c,d,e,f,X)"

Assert.AreEqual("abcdef",t.ToString(),"my_concat_atomfailed!"

}

}

publicstaticboolmy_concat_atom(PlTermVterm1)

{

intarity=term1.Size;

stringsRet="";

PlTermterm_out=term1[arity-1];

for(inti=0;i<arity-1;i++)

{

strings=term1.ToString();

sRet+=term1[i].ToString();

}

term_out.Unify(sRet);

returntrue;

}



SwiPlCsinterface►SbsSW.SwiPlCs.Callback►PlForeignSwitchesC#


PrologPlForeignSwitchesEnumeration

Flagsthatareresponsiblefortheforeignpredicateparameters


[FlagsAttribute]

publicenumPlForeignSwitches

<FlagsAttribute>_

PublicEnumerationPlForeignSwitches

[FlagsAttribute]

publicenumclassPlForeignSwitches

MembersMember DescriptionNone 0-PL_FA_NOTHING:noflags.

NoTrace 1-PL_FA_NOTRACE:Predicatecannotbeseeninthetracer.

Transparent 2-PL_FA_TRANSPARENT:Predicateismoduletransparent.

Nondeterministic 4-PL_FA_NONDETERMINISTIC:Predicateisnon-deterministic.SeealsoPL_retry().

VarArgs 8-PL_FA_VARARGS:(Default)Usealternativecallingconvention.


http://msdn2.microsoft.com/en-us/library/dk06fkbc




C#SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions


PrologSbsSW.SwiPlCs.ExceptionsNamespace

ThesearethenamespacecommentsforSbsSW.SwiPlCs.Exceptions.

ThenamespaceSbsSW.SwiPlCs.ExceptionsprovidestheExceptionclassestocatchaprologexceptionseeSWI-PrologManual-4.9ISOcompliantExceptionhandling

PrologexceptionsaremappedtoC#exceptionsusingthesubclassPlExceptionofExceptiontorepresentthePrologexceptionterm.

Alltype-conversionfunctionsoftheinterfaceraiseProlog-compliantexceptions,providingdecenterror-handlingsupportatnoextraworkfortheprogrammer.

Forsomecommonlyusedexceptions,subclassesofPlExceptionhavebeencreatedtoexploitboththeirconstructorsforeasycreationoftheseexceptionsaswellasselectivetrappinginC#.

Currently,thesearePlTypeExceptionandPlDomainException.


namespaceSbsSW.SwiPlCs.Exceptions

NamespaceSbsSW.SwiPlCs.Exceptions

namespaceSbsSW.SwiPlCs.Exceptions

TypesAllTypes Classes

Icon Type Description

http://gollem.science.uva.nl/SWI-Prolog/Manual/exception.html

http://msdn2.microsoft.com/en-us/library/c18k6c59

PlException ThisclassisthebaseclasstocatchexceptionsthrownbyprologinC#.

PlLibException Thisexceptionisthrownifsomethingintheinterfacewentwrong.

PlTypeException AtypeerrorexpressesthatatermdoesnotsatisfytheexpectedbasicPrologtype.

Remarks



SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlExceptionC#


PrologPlExceptionClass

ThisclassisthebaseclasstocatchexceptionsthrownbyprologinC#.


[SerializableAttribute]

publicclassPlException:Exception,

ISerializable

<SerializableAttribute>_

PublicClassPlException_

InheritsException_

ImplementsISerializable


publicrefclassPlException:publicException,

ISerializable


PublicProtected

InstanceStatic

Declared


PlException() Initializesanewinstanceoftheclass.

PlException(String) Initializesanewinstanceofthe

http://msdn2.microsoft.com/en-us/library/bcfsa90a


http://msdn2.microsoft.com/en-us/library/wf4375ks







classwithaspecifiederrormessage.

PlException(String,Exception) Initializesanewinstanceoftheclasswithaspecifiederrormessageandareferencetotheinnerexceptionthatisthecauseofthisexception.

PlException(SerializationInfo,StreamingContext)

Initializesanewinstanceoftheclasswithserializeddata.

PlException(PlTerm)Tocatchaexceptionthrownbyprolog

ForaexampleseePlException

Data Getsacollectionofkey/valuepairsthatprovideadditionaluser-definedinformationabouttheexception.

(InheritedfromException.)

Equals(Object) DetermineswhetherthespecifiedequaltothecurrentObject.




GetBaseException() Whenoverriddeninaderivedclass,returnstheExceptionthatistherootcause



http://msdn2.microsoft.com/en-us/library/2wyfbc48









http://msdn2.microsoft.com/en-us/library/49kcee3b


ofoneormoresubsequentexceptions.




GetObjectData(SerializationInfo,StreamingContext)

Whenoverriddeninaderivedclass,setstheSerializationInfowithinformationabouttheexception.

(OverridesException.GetObjectData(SerializationInfo,StreamingContext).)

GetType() Getstheruntimetypeofthecurrentinstance.


HelpLink Getsorsetsalinktothehelpfileassociatedwiththisexception.


HResult GetsorsetsHRESULT,acodednumericalvaluethatisassignedtoaspecificexception.


InnerException GetstheExceptioninstancethatcausedthecurrentexception.




Message Getsamessagethatdescribesthecurrent







http://msdn2.microsoft.com/en-us/library/a9b6042e


http://msdn2.microsoft.com/en-us/library/fwb1489e

http://msdn2.microsoft.com/en-us/library/44zb316t


http://msdn2.microsoft.com/en-us/library/71tawy4s


http://msdn2.microsoft.com/en-us/library/sh5cw61c


http://msdn2.microsoft.com/en-us/library/902sca80






exception.

(OverridesException.Message.)

MessagePl providesomtimessomeadditionalinformationabouttheexceptionsreason.

PlThrow() TODO

Source Getsorsetsthenameoftheapplicationortheobjectthatcausestheerror.


StackTrace Getsastringrepresentationoftheframesonthecallstackatthetimethecurrentexceptionwasthrown.


TargetSite Getsthemethodthatthrowsthecurrentexception.


Term GetthePlTermofthisexception.

Throw() TODO

ToString() Theexceptionistranslatedintoamessageasproducedbyprint_message/2.Thecharacterdataisstoredinaring.

(OverridesException.ToString()

Examples


http://msdn2.microsoft.com/en-us/library/9btwf6wk

http://msdn2.microsoft.com/en-us/library/85weac5w


http://msdn2.microsoft.com/en-us/library/dxzhy005


http://msdn2.microsoft.com/en-us/library/2wchw354



http://msdn2.microsoft.com/en-us/library/es4y6f7e

CopyC#

publicvoidprolog_exception_sample()

{

stringexception_text="test_exception";

Assert.IsTrue(PlQuery.PlCall("assert((test_throw:-throw("

try

{

Assert.IsTrue(PlQuery.PlCall("test_throw"));

}

catch(PlExceptionex)

{

Assert.AreEqual(exception_text,ex.Term.ToString());

Assert.AreEqual("Unknownmessage:"+exception_text,ex.Message);

}

}

InheritanceHierarchyObjectException

PlException PlTypeException

SeeAlsoPlTypeExceptionSWI-PrologManual-4.9ISOcompliantExceptionhandling






SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►PlException()

C#


PrologPlExceptionConstructor


PlException() InitializesanewinstanceoftheExceptionclass.

PlException(String) InitializesanewinstanceoftheExceptionclasswithaspecifiederrormessage.

PlException(String,Exception)

InitializesanewinstanceoftheExceptionclasswithaspecifiederrormessageandareferencetotheinnerexceptionthatisthecauseofthisexception.

PlException(SerializationInfo,StreamingContext)

InitializesanewinstanceoftheExceptionclasswithserializeddata.

PlException(PlTerm)Tocatchaexceptionthrownbyprolog

ForaexampleseePlException.





SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►PlException()

C#


PrologPlExceptionConstructor

InitializesanewinstanceoftheExceptionclass.


publicPlException()

PublicSubNew

public:

PlException()




SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►PlException(PlTerm)

C#


PrologPlExceptionConstructor(term)

Tocatchaexceptionthrownbyprolog



publicPlException(

PlTermterm

)

PublicSubNew(_

termAsPlTerm_

)

public:

PlException(

PlTermterm

)


APlTermcontainingthePrologexception



SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►PlException(SerializationInfo,StreamingContext)

C#


PrologPlExceptionConstructor(info,context)



protectedPlException(

SerializationInfoinfo,

StreamingContextcontext

)

ProtectedSubNew(_

infoAsSerializationInfo,_

contextAsStreamingContext_

)

protected:

PlException(

SerializationInfo^info,


)

Parametersinfo(SerializationInfo)

TheSerializationInfothatholdstheserializedobjectdataabouttheexceptionbeingthrown.

context(StreamingContext)TheStreamingContextthatcontainscontextualinformationaboutthesourceordestination.

Exceptions



http://msdn2.microsoft.com/en-us/library/t16abws5









Exception ConditionArgumentNullException Theinfoparameterisnull.

SerializationException TheclassnameisnullorHResultiszero(0).


http://msdn2.microsoft.com/en-us/library/27426hcy

http://msdn2.microsoft.com/en-us/library/akw26cdk



SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►PlException(String)

C#


PrologPlExceptionConstructor(message)

InitializesanewinstanceoftheExceptionclasswithaspecifiederrormessage.


publicPlException(

stringmessage

)

PublicSubNew(_

messageAsString_

)

public:

PlException(

String^message

)

Parametersmessage(String)

Themessagethatdescribestheerror.








SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►PlException(String,Exception)

C#


PrologPlExceptionConstructor(message,innerException)



publicPlException(

stringmessage,

ExceptioninnerException

)

PublicSubNew(_

messageAsString,_

innerExceptionAsException_

)

public:

PlException(

String^message,

Exception^innerException

)


Theerrormessagethatexplainsthereasonfortheexception.

innerException(Exception)Theexceptionthatisthecauseofthecurrentexception,oranullreference(NothinginVisualBasic)ifnoinnerexceptionisspecified.










SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►GetObjectData(SerializationInfo,StreamingContext)

C#


PrologGetObjectDataMethod(info,context)



publicoverridevoidGetObjectData(



)

PublicOverridesSubGetObjectData(_



)

public:

virtualvoidGetObjectData(



)override




Exceptions












Exception ConditionArgumentNullException Theinfoparameterisanullreference

(NothinginVisualBasic).

SecurityException Thecallerdoesnothavetherequiredpermission.



http://msdn2.microsoft.com/en-us/library/yx0zh807


SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►Message

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologMessageProperty

Getsamessagethatdescribesthecurrentexception.


publicoverridestringMessage{get;}

PublicOverridesReadOnlyPropertyMessageAsString

Get

public:

virtualpropertyString^Message{

String^get()override;

}

ReturnValueTheerrormessagethatexplainsthereasonfortheexception,oranemptystring("").







SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►MessagePl

C#


PrologMessagePlProperty

providesomtimessomeadditionalinformationabouttheexceptionsreason.


publicstringMessagePl{get;}

PublicReadOnlyPropertyMessagePlAsString

Get

public:

propertyString^MessagePl{

String^get();

}







SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►PlThrow()

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologPlThrowMethod

TODO


publicintPlThrow()

PublicFunctionPlThrowAsInteger

public:

intPlThrow()

ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.Exceptions.PlException.PlThrow"]

RemarksUsedinthePREDICATE()wrappertopasstheexceptiontoProlog.SeePL_raise_exeption().






SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►Term

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologTermProperty

GetthePlTermofthisexception.


publicPlTermTerm{get;}

PublicReadOnlyPropertyTermAsPlTerm

Get

public:

propertyPlTermTerm{

PlTermget();

}



SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►Throw()

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologThrowMethod

TODO


publicvoidThrow()

PublicSubThrow

public:

voidThrow()

Remarksseehttp://www.swi-prolog.org/packages/pl2cpp.html#cppThrow()


http://www.swi-prolog.org/packages/pl2cpp.html#cppThrow()


SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlException►ToString()

C#

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologToStringMethod

Theexceptionistranslatedintoamessageasproducedbyprint_message/2.Thecharacterdataisstoredinaring.


publicoverridestringToString()

PublicOverridesFunctionToStringAsString

public:

virtualString^ToString()override

ReturnValue

[Missing<returns>documentationfor"M:SbsSW.SwiPlCs.Exceptions.PlException.ToString"]






SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlLibExceptionC#


PrologPlLibExceptionClass

Thisexceptionisthrownifsomethingintheinterfacewentwrong.



publicclassPlLibException:Exception,

ISerializable


PublicClassPlLibException_

InheritsException_

ImplementsISerializable


publicrefclassPlLibException:publicException,

ISerializable


PublicProtected

InstanceStatic

Declared


PlLibException() Initializesanewinstanceoftheclass.

PlLibException(String) Initializesanewinstanceoftheclasswithaspecifiederrormessage.










PlLibException(String,Exception)

Initializesanewinstanceoftheclasswithaspecifiederrormessageandareferencetotheinnerexceptionthatisthecauseofthisexception.

PlLibException(SerializationInfo,StreamingContext)

Initializesanewinstanceoftheclasswithserializeddata.



Equals(Object) DetermineswhetherthespecifiedequaltothecurrentObject.




GetBaseException() Whenoverriddeninaderivedclass,returnstheExceptionthatistherootcauseofoneormoresubsequentexceptions.




GetObjectData(SerializationInfo, Whenoverriddeninaderivedclass,sets

















StreamingContext) theSerializationInfowithinformationabouttheexception.

(OverridesException.GetObjectData(SerializationInfo,StreamingContext).)











Message Getsamessagethatdescribesthecurrentexception.




StackTrace Getsastringrepresentationoftheframes






http://msdn2.microsoft.com/en-us/library/fwb1489e













http://msdn2.microsoft.com/en-us/library/9btwf6wk





onthecallstackatthetimethecurrentexceptionwasthrown.




ToString() Createsandreturnsastringrepresentationofthecurrentexception.



PlLibException





http://msdn2.microsoft.com/en-us/library/es4y6f7e





SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlLibException►PlLibException()

C#


PrologPlLibExceptionConstructor


PlLibException() InitializesanewinstanceoftheExceptionclass.

PlLibException(String) InitializesanewinstanceoftheExceptionclasswithaspecifiederrormessage.

PlLibException(String,Exception)


PlLibException(SerializationInfo,StreamingContext)








SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlLibException►PlLibException()

C#


PrologPlLibExceptionConstructor



publicPlLibException()

PublicSubNew

public:

PlLibException()




SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlLibException►PlLibException(SerializationInfo,StreamingContext)

C#


PrologPlLibExceptionConstructor(info,context)



protectedPlLibException(



)

ProtectedSubNew(_



)

protected:

PlLibException(



)




Exceptions












SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlLibException►PlLibException(String)

C#


PrologPlLibExceptionConstructor(message)



publicPlLibException(

stringmessage

)

PublicSubNew(_

messageAsString_

)

public:

PlLibException(

String^message

)










SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlLibException►PlLibException(String,Exception)

C#


PrologPlLibExceptionConstructor(message,innerException)



publicPlLibException(

stringmessage,


)

PublicSubNew(_

messageAsString,_


)

public:

PlLibException(

String^message,


)













SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlLibException►GetObjectData(SerializationInfo,StreamingContext)

C#


PrologGetObjectDataMethod(info,context)



publicoverridevoidGetObjectData(



)

PublicOverridesSubGetObjectData(_



)

public:

virtualvoidGetObjectData(



)override




Exceptions












Exception ConditionArgumentNullException Theinfoparameterisanullreference

(NothinginVisualBasic).

SecurityException Thecallerdoesnothavetherequiredpermission.



http://msdn2.microsoft.com/en-us/library/yx0zh807


SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlTypeExceptionC#


PrologPlTypeExceptionClass

AtypeerrorexpressesthatatermdoesnotsatisfytheexpectedbasicPrologtype.



publicclassPlTypeException:PlException


PublicClassPlTypeException_

InheritsPlException


publicrefclassPlTypeException:publicPlException


PublicProtected

InstanceStatic

Declared


PlTypeException() InitializesanewinstanceoftheExceptionclass.

PlTypeException(String) InitializesanewinstanceoftheExceptionclasswithaspecifiederrormessage.






PlTypeException(String,Exception)


PlTypeException(SerializationInfo,StreamingContext)


PlTypeException(PlTerm)Tocatchaexceptionthrownbyprolog


PlTypeException(String,PlTerm) CreatesanISOstandardPrologerrortermexpressingtheexpectedtypeandactualtermthatdoesnotsatisfythistype.



Equals(Object) DetermineswhetherthespecifiedObjectisequalto







thecurrentObject.




GetBaseException() Whenoverriddeninaderivedclass,returnstheExceptionthatistherootcauseofoneormoresubsequentexceptions.




GetObjectData(SerializationInfo,StreamingContext)


(InheritedfromPlException.)



























Message Getsamessagethatdescribesthecurrentexception.


MessagePl providesomtimessomeadditionalinformationabouttheexceptionsreason.


PlThrow() TODO




StackTrace Getsastringrepresentationoftheframesonthecallstackatthetimethecurrentexception












Copy

wasthrown.




Term GetthePlTermofthisexception.


Throw() TODO


ToString() Theexceptionistranslatedintoamessageasproducedbyprint_message/2.Thecharacterdataisstoredinaring.


ExamplesThissampledemonstratehowtocatchaPlTypeExceptioninC#thatisthrownsomewhereinttheprologcode.

C#

publicvoidprolog_type_exception_sample()

{

try

{

Assert.IsTrue(PlQuery.PlCall("sumlist([1,error],L)"

}

catch(PlTypeExceptionex)

{

Assert.AreEqual("is/2:Arithmetic:`error/0'isnotafunction"




}

}


PlException PlTypeException

SeeAlsoPlTypeExceptionSWI-PrologManual-4.9ISOcompliantExceptionhandling






SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlTypeException►PlTypeException()

C#


PrologPlTypeExceptionConstructor


PlTypeException() InitializesanewinstanceoftheExceptionclass.

PlTypeException(String) InitializesanewinstanceoftheExceptionclasswithaspecifiederrormessage.

PlTypeException(String,Exception)


PlTypeException(SerializationInfo,StreamingContext)


PlTypeException(PlTerm)Tocatchaexceptionthrownbyprolog






PlTypeException(String,PlTerm) CreatesanISOstandardPrologerrortermexpressingtheexpectedtypeandactualtermthatdoesnotsatisfythistype.



SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlTypeException►PlTypeException()

C#


PrologPlTypeExceptionConstructor



publicPlTypeException()

PublicSubNew

public:

PlTypeException()




SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlTypeException►PlTypeException(PlTerm)

C#


PrologPlTypeExceptionConstructor(term)

Tocatchaexceptionthrownbyprolog



publicPlTypeException(

PlTermterm

)

PublicSubNew(_

termAsPlTerm_

)

public:

PlTypeException(

PlTermterm

)


APlTermcontainingthePrologexception



SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlTypeException►PlTypeException(SerializationInfo,StreamingContext)

C#


PrologPlTypeExceptionConstructor(info,context)



protectedPlTypeException(



)

ProtectedSubNew(_



)

protected:

PlTypeException(



)




Exceptions












SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlTypeException►PlTypeException(String)

C#


PrologPlTypeExceptionConstructor(message)




stringmessage

)

PublicSubNew(_

messageAsString_

)

public:

PlTypeException(

String^message

)










SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlTypeException►PlTypeException(String,PlTerm)

C#


PrologPlTypeExceptionConstructor(expected,actual)

CreatesanISOstandardPrologerrortermexpressingtheexpectedtypeandactualtermthatdoesnotsatisfythistype.



stringexpected,

PlTermactual

)

PublicSubNew(_

expectedAsString,_

actualAsPlTerm_

)

public:

PlTypeException(

String^expected,

PlTermactual

)

Parametersexpected(String)

Thetypewhichwasexpected

actual(PlTerm)Theactualterm






SwiPlCsinterface►SbsSW.SwiPlCs.Exceptions►PlTypeException►PlTypeException(String,Exception)

C#


PrologPlTypeExceptionConstructor(message,innerException)




stringmessage,


)

PublicSubNew(_

messageAsString,_


)

public:

PlTypeException(

String^message,


)













C#SwiPlCsinterface►SbsSW.SwiPlCs.Streams


PrologSbsSW.SwiPlCs.StreamsNamespace

ThenamespaceSbsSW.SwiPlCs.StreamsprovidesthedelegatestoredirectthereadandwritefunctionsoftheSWI-PrologIOStreams.

WhenInitialize(String[])iscalledthe*Sinput->functions.readisreplacedbythe.NETmethod'Sread_function'and*Sinput->functions.writeby'Swrite_funktion'.

ForfurtherexamplesseethemethodsSetStreamFunctionWrite(PlStreamType,DelegateStreamWriteFunction)andSetStreamFunctionRead(PlStreamType,DelegateStreamReadFunction)


namespaceSbsSW.SwiPlCs.Streams

NamespaceSbsSW.SwiPlCs.Streams

namespaceSbsSW.SwiPlCs.Streams

TypesAllTypes Enumerations Delegates

Icon Type DescriptionDelegateStreamReadFunction See

SetStreamFunctionRead(PlStreamType,DelegateStreamReadFunction)

DelegateStreamWriteFunction See


Copy

SetStreamFunctionWrite(PlStreamType,DelegateStreamWriteFunction)

PlStreamType ThestandardSWI-Prologstreams(inputoutputerror)

RemarksNote:Thereasonforthisisdebugging.

Examples

C#

staticinternallongSwrite_function(IntPtrhandle,

{

strings=buf.Substring(0,(int)bufsize);

Console.Write(s);

System.Diagnostics.Trace.WriteLine(s);

returnbufsize;

}

staticinternallongSread_function(IntPtrhandle,System.IntPtrbuf,

{

thrownewPlLibException("SwiPlCs:Prologtrytoreadfromstdin"

}

SeeAlsoSetStreamFunctionRead(PlStreamType,DelegateStreamReadFunction)



SwiPlCsinterface►SbsSW.SwiPlCs.Streams►DelegateStreamReadFunction

C#


PrologDelegateStreamReadFunctionDelegate

SeeSetStreamFunctionRead(PlStreamType,DelegateStreamReadFunction)


publicdelegatelongDelegateStreamReadFunction(

IntPtrhandle,

IntPtrbuffer,

longbufferSize

)

PublicDelegateFunctionDelegateStreamReadFunction(_

handleAsIntPtr,_

bufferAsIntPtr,_

bufferSizeAsLong_

)AsLong

publicdelegatelonglongDelegateStreamReadFunction

IntPtrhandle,

IntPtrbuffer,

longlongbufferSize

)

Parametershandle(IntPtr)

ACstreamhandle.simpleignoreit.

buffer(IntPtr)Apointertoastringbuffer

bufferSize(Int64)
















Thesizeofthestringbuffer

ReturnValueADelegate




SwiPlCsinterface►SbsSW.SwiPlCs.Streams►DelegateStreamWriteFunction

C#


PrologDelegateStreamWriteFunctionDelegate

SeeSetStreamFunctionWrite(PlStreamType,DelegateStreamWriteFunction)


publicdelegatelongDelegateStreamWriteFunction(

IntPtrhandle,

stringbuffer,

longbufferSize

)

PublicDelegateFunctionDelegateStreamWriteFunction

handleAsIntPtr,_

bufferAsString,_

bufferSizeAsLong_

)AsLong

publicdelegatelonglongDelegateStreamWriteFunction

IntPtrhandle,

String^buffer,

longlongbufferSize

)

Parametershandle(IntPtr)

ACstreamhandle.simpleignoreit.

buffer(String)Apointertoastringbuffer

bufferSize(Int64)
















Thesizeofthestringbuffer

ReturnValueADelegate




SwiPlCsinterface►SbsSW.SwiPlCs.Streams►PlStreamTypeC#


PrologPlStreamTypeEnumeration

ThestandardSWI-Prologstreams(inputoutputerror)


publicenumPlStreamType

PublicEnumerationPlStreamType

publicenumclassPlStreamType

MembersMember DescriptionInput 0-Thestandardinputstream.

Output 1-Thestandardinputstream.

Error 1-Thestandarderrorstream.



C#SwiPlCsinterface

Swi-cs-pl-ACSharpclasslibrarytoconnect.NETlanguageswithSWI-PrologSwiPlCsinterface

istinderquelle(classNamespaceDoc)vomnamespaceSbsSW.SwiPlCs

NamespacesNamespace DescriptionSbsSW.SwiPlCs

Theonlinedocumentationhomeishere

ThisnamespaceSbsSW.SwiPlCsprovidesan.NETinterfacetoSWI-Prolog

Overview

PrologvariablesaredynamicallytypedandallinformationispassedaroundusingtheC-interfacetypeterm_twitchisanint.InC#,term_tisembeddedinthelightweightstructPlTerm.ConstructorsandoperatordefinitionsprovideflexibleoperationsandintegrationwithimportantC#-types(string,intanddouble).

Thelistbelowsummarisestheimportantclasses/structdefinedintheC#interface.

class/struct Shortdescription

PlEngine Astaticclassrepresentstheprologengine.

http://www.lesta.de/prolog/swiplcs/Generated/Index.aspx


PlTerm Astructrepresentingprologdata.

PlTermV AvectorofPlTerm.

PlQuery AclasstoqueryProlog.

SbsSW.SwiPlCs.CallbackThenamespaceSbsSW.SwiPlCs.Callbackprovidesthedelegatestoregister.NETmethodstobecalledfromSWI-Prolog

SbsSW.SwiPlCs.ExceptionsThesearethenamespacecommentsforSbsSW.SwiPlCs.Exceptions.

ThenamespaceSbsSW.SwiPlCs.ExceptionsprovidestheExceptionclassestocatchaprologexceptionseeSWI-PrologManual-4.9ISOcompliantExceptionhandling

PrologexceptionsaremappedtoC#exceptionsusingthesubclassPlExceptionofExceptiontorepresentthePrologexceptionterm.

Alltype-conversionfunctionsoftheinterfaceraiseProlog-compliantexceptions,providingdecenterror-handlingsupportatnoextraworkfortheprogrammer.

Forsomecommonlyusedexceptions,subclassesofPlExceptionhavebeencreatedtoexploitboththeirconstructors




foreasycreationoftheseexceptionsaswellasselectivetrappinginC#.

Currently,thesearePlTypeExceptionandPlDomainException.

SbsSW.SwiPlCs.StreamsThenamespaceSbsSW.SwiPlCs.StreamsprovidesthedelegatestoredirectthereadandwritefunctionsoftheSWI-PrologIOStreams.

WhenInitialize(String[])iscalledthe*Sinput->functions.readisreplacedbythe.NETmethod'Sread_function'and*Sinput->functions.writeby'Swrite_funktion'.

ForfurtherexamplesseethemethodsSetStreamFunctionWrite(PlStreamType,DelegateStreamWriteFunction)andSetStreamFunctionRead(PlStreamType,DelegateStreamReadFunction)




Swi-cs-pl - A CSharp class library to connect .NET ... · The first version of this Interface was...

Documents

Transcript of Swi-cs-pl - A CSharp class library to connect .NET ... · The first version of this Interface was...