VU University Amsterdam University of Amsterdam Reference Manual

443 Pages·2012·1.74 MB·English

VU University Amsterdam University of Amsterdam
DeBoelelaan1081a,1081HV Amsterdam Kruislaan419,1098VA Amsterdam
TheNetherlands TheNetherlands
˜
Reference Manual
Updatedforversion6.2.3,November2012
JanWielemaker
[email protected]
http://www.swi-prolog.org
SWI-PrologisacomprehensiveandportableimplementationofthePrologprogramming
language. SWI-Prolog aims to be a robust and scalable implementation supporting a
widerangeofapplications. Inparticular,itshipswithawiderangeofinterfacelibraries,
providinginterfacestootherlanguages, databases, graphicsandnetworking. Itprovides
extensive support for managing HTML/SGML/XML and RDF documents. The system
isparticularlysuitedforserverapplicationsduetorobustsupportformultithreadingand
HTTP server libraries. SWI-Prolog is designed in the ‘Edinburgh tradition’. In addition
totheISOPrologstandarditislargelycompatibletoQuintus,SICStusandYAPProlog.
SWI-PrologprovidesacompatibilityframeworkdevelopedincooperationwithYAPand
instantiatedforYAP,SICStusandIF/Prolog. SWI-Prologaimsatprovidingagooddevel-
opmentenvironment,includingextensiveeditorsupport,graphicalsource-leveldebugger,
autoloadingand‘make’facilityandmuchmore. SWI-PrologeditorandthePDTplugin
for Eclipse provide alternative environments. This document gives an overview of the
features,systemlimitsandbuilt-inpredicates.
˜
This work is licensed under the Creative Commons Attribution-
ShareAlike 3.0 Unported License. To view a copy of this license, visit
http://creativecommons.org/licenses/by-sa/3.0/ or send a let-
ter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California,
94041,USA.
Contents
1 Introduction 9
1.1 PositioningSWI-Prolog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.2 Statusandreleases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.3 ShouldIbeusingSWI-Prolog? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4 SupporttheSWI-Prologproject . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.5 Implementationhistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.6 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2 Overview 14
2.1 Gettingstartedquickly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.1.1 StartingSWI-Prolog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.1.2 Executingaquery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.2 Theuser’sinitialisationfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3 Initialisationfilesandgoals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.4 Command-lineoptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.4.1 Controllingthestack-sizes . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.4.2 Runninggoalsfromthecommandline . . . . . . . . . . . . . . . . . . . . . 18
2.4.3 Compileroptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.4.4 Maintenanceoptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.5 GNUEmacsInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.6 OnlineHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.7 Command-linehistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.8 Reuseoftop-levelbindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.9 OverviewoftheDebugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.10 Compilation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.10.1 Duringprogramdevelopment . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.10.2 Forrunningtheresult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.11 EnvironmentControl(Prologflags) . . . . . . . . . . . . . . . . . . . . . . . . . . 29
2.12 Anoverviewofhookpredicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
2.13 Automaticloadingoflibraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
2.14 GarbageCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
2.15 SyntaxNotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2.15.1 ISOSyntaxSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2.16 Rationaltrees(cyclicterms) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
2.17 Just-in-timeclauseindexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
2.17.1 Futuredirections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
2.17.2 Indexingandportability . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
2.18 Widecharactersupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.18.1 Widecharacterencodingsonstreams . . . . . . . . . . . . . . . . . . . . . 49
2.19 Systemlimits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
SWI-Prolog6.2ReferenceManual
2
2.19.1 Limitsonmemoryareas . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2.19.2 OtherLimits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2.19.3 ReservedNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
2.20 SWI-Prologand64-bitmachines . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
2.20.1 Supportedplatforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
2.20.2 Comparing32-and64-bitsProlog . . . . . . . . . . . . . . . . . . . . . . . 53
2.20.3 Choosingbetween32-and64-bitsProlog . . . . . . . . . . . . . . . . . . . 54
3 InitialisingandManagingaPrologProject 55
3.1 Theprojectsourcefiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
3.1.1 FileNamesandLocations . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
3.1.2 ProjectSpecialFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
3.1.3 Internationalsourcefiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
3.2 Usingmodules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
3.3 Thetest-edit-reloadcycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
3.3.1 Locatingthingstoedit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
3.3.2 Editingandincrementalcompilation . . . . . . . . . . . . . . . . . . . . . . 59
3.4 UsingthePceEmacsbuilt-ineditor . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.4.1 ActivatingPceEmacs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.4.2 BluffingthroughPceEmacs . . . . . . . . . . . . . . . . . . . . . . . . . . 60
3.4.3 PrologMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
3.5 TheGraphicalDebugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.5.1 Invokingthewindow-baseddebugger . . . . . . . . . . . . . . . . . . . . . 64
3.6 ThePrologNavigator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
3.7 Cross-referencer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
3.8 AccessingtheIDEfromyourprogram . . . . . . . . . . . . . . . . . . . . . . . . . 67
3.9 SummaryoftheIDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
4 Built-inPredicates 69
4.1 NotationofPredicateDescriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
4.2 Characterrepresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
4.3 LoadingPrologsourcefiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4.3.1 Conditionalcompilationandprogramtransformation . . . . . . . . . . . . . 80
4.3.2 Loadingfiles,activecodeandthreads . . . . . . . . . . . . . . . . . . . . . 83
4.3.3 Quickloadfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
4.4 EditorInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
4.4.1 Customizingtheeditorinterface . . . . . . . . . . . . . . . . . . . . . . . . 86
4.5 Listtheprogram,predicatesorclauses . . . . . . . . . . . . . . . . . . . . . . . . . 87
4.6 VerifyTypeofaTerm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
4.7 ComparisonandUnificationofTerms . . . . . . . . . . . . . . . . . . . . . . . . . 89
4.7.1 StandardOrderofTerms . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
4.7.2 Specialunificationandcomparisonpredicates . . . . . . . . . . . . . . . . . 91
4.8 ControlPredicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
4.9 Meta-CallPredicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
4.10 ISOcompliantExceptionhandling . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
4.10.1 Debuggingandexceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
4.10.2 Theexceptionterm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
SWI-Prolog6.2ReferenceManual
Contents 3
4.10.3 Printingmessages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
4.11 Handlingsignals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
4.11.1 Notesonsignalhandling . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
4.12 DCGGrammarrules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
4.13 Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
4.13.1 Updateview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
4.13.2 Indexingdatabases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
4.14 Declaringpredicateproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
4.15 Examiningtheprogram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
4.16 Inputandoutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
4.16.1 ISOInputandOutputStreams . . . . . . . . . . . . . . . . . . . . . . . . . 116
4.16.2 Edinburgh-styleI/O. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
4.16.3 SwitchingbetweenEdinburghandISOI/O . . . . . . . . . . . . . . . . . . 125
4.16.4 Writeontoatoms,code-lists,etc. . . . . . . . . . . . . . . . . . . . . . . . . 125
4.17 Statusofstreams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
4.18 PrimitivecharacterI/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
4.19 Termreadingandwriting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
4.20 AnalysingandConstructingTerms . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
4.20.1 Non-logicaloperationsonterms . . . . . . . . . . . . . . . . . . . . . . . . 138
4.21 AnalysingandConstructingAtoms . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
4.22 Characterproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
4.22.1 Caseconversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
4.22.2 Whitespacenormalization . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
4.22.3 Language-specificcomparison . . . . . . . . . . . . . . . . . . . . . . . . . 145
4.23 Representingtextinstrings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
4.24 Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
4.25 CharacterConversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
4.26 Arithmetic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
4.26.1 Specialpurposeintegerarithmetic . . . . . . . . . . . . . . . . . . . . . . . 148
4.26.2 Generalpurposearithmetic . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
4.27 Miscarithmeticsupportpredicates . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
4.28 Built-inlistoperations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
4.29 FindingallSolutionstoaGoal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
4.30 Forall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
4.31 FormattedWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
4.31.1 Writef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
4.31.2 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
4.31.3 ProgrammingFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
4.32 TerminalControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
4.33 OperatingSystemInteraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
4.33.1 Dealingwithtimeanddate . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
4.33.2 Controllingtheswipl-win.execonsolewindow . . . . . . . . . . . . . 174
4.34 FileSystemInteraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
4.35 UserTop-levelManipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
4.36 CreatingaProtocoloftheUserInteraction . . . . . . . . . . . . . . . . . . . . . . . 180
4.37 DebuggingandTracingPrograms . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
4.38 ObtainingRuntimeStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
SWI-Prolog6.2ReferenceManual
4
4.39 Executionprofiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
4.39.1 Profilingpredicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
4.39.2 Visualizingprofilingdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
4.39.3 Informationgathering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
4.40 MemoryManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
4.41 WindowsDDEinterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
4.41.1 DDEclientinterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
4.41.2 DDEservermode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
4.42 Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
5 Modules 194
5.1 WhyUseModules? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
5.2 DefiningaModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
5.3 ImportingPredicatesintoaModule . . . . . . . . . . . . . . . . . . . . . . . . . . 195
5.4 Definingameta-predicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
5.5 OverrulingModuleBoundaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
5.5.1 Explicitmanipulationofthecallingcontext . . . . . . . . . . . . . . . . . . 199
5.6 Interactingwithmodulesfromthetoplevel . . . . . . . . . . . . . . . . . . . . . . . 200
5.7 Composingmodulesfromothermodules . . . . . . . . . . . . . . . . . . . . . . . . 200
5.8 Operatorsandmodules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
5.9 Dynamicimportingusingimportmodules . . . . . . . . . . . . . . . . . . . . . . . 201
5.10 ReservedModulesandusingthe‘user’module . . . . . . . . . . . . . . . . . . . . 202
5.11 Analternativeimport/exportinterface . . . . . . . . . . . . . . . . . . . . . . . . . 202
5.12 DynamicModules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
5.13 Transparentpredicates: definitionandcontextmodule . . . . . . . . . . . . . . . . . 203
5.14 Moduleproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
5.15 CompatibilityoftheModuleSystem . . . . . . . . . . . . . . . . . . . . . . . . . . 206
6 SpecialVariablesandCoroutining 207
6.1 Attributedvariables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
6.1.1 Attributemanipulationpredicates . . . . . . . . . . . . . . . . . . . . . . . 209
6.1.2 Attributedvariablehooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
6.1.3 Operationsontermswithattributedvariables . . . . . . . . . . . . . . . . . 210
6.1.4 Specialpurposepredicatesforattributes . . . . . . . . . . . . . . . . . . . . 210
6.2 Coroutining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
6.3 Globalvariables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
6.3.1 CompatibilityofSWI-PrologGlobalVariables . . . . . . . . . . . . . . . . 213
7 CHR:ConstraintHandlingRules 214
7.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
7.2 SyntaxandSemantics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
7.2.1 SyntaxofCHRrules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
7.2.2 Semantics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
7.3 CHRinSWI-PrologPrograms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
7.3.1 EmbeddinginPrologPrograms . . . . . . . . . . . . . . . . . . . . . . . . 217
7.3.2 Constraintdeclaration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
7.3.3 Compilation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
SWI-Prolog6.2ReferenceManual
Contents 5
7.4 Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
7.4.1 Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
7.4.2 Tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
7.4.3 CHRDebuggingPredicates . . . . . . . . . . . . . . . . . . . . . . . . . . 223
7.5 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
7.6 BackwardsCompatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
7.6.1 TheOldSICStusCHRimplemenation . . . . . . . . . . . . . . . . . . . . . 225
7.6.2 TheOldECLiPSeCHRimplemenation . . . . . . . . . . . . . . . . . . . . 226
7.7 ProgrammingTipsandTricks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
7.8 CompilerErrorsandWarnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
7.8.1 CHRCompilerErrors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
8 Multi-threadedapplications 229
8.1 CreatinganddestroyingPrologthreads . . . . . . . . . . . . . . . . . . . . . . . . . 229
8.2 Monitoringthreads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
8.3 Threadcommunication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
8.3.1 Messagequeues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
8.3.2 Signallingthreads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
8.3.3 Threadsanddynamicpredicates . . . . . . . . . . . . . . . . . . . . . . . . 237
8.4 Threadsynchronisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
8.5 Threadsupportlibrary(threadutil) . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
8.5.1 Debuggingthreads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
8.5.2 Profilingthreads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
8.6 Unboundedthreadcreation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
8.7 Multi-threadedmixedCandPrologapplications . . . . . . . . . . . . . . . . . . . . 241
8.7.1 APrologthreadforeachnativethread(one-to-one) . . . . . . . . . . . . . . 241
8.7.2 PoolingPrologengines(many-to-many) . . . . . . . . . . . . . . . . . . . . 242
8.8 MultithreadingandtheXPCEgraphicssystem . . . . . . . . . . . . . . . . . . . . . 243
9 ForeignLanguageInterface 245
9.1 OverviewoftheInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
9.2 LinkingForeignModules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
9.2.1 Whatlinkingisprovided? . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
9.2.2 WhatkindofloadingshouldIbeusing? . . . . . . . . . . . . . . . . . . . . 246
9.2.3 library(shlib): Utilitylibraryforloadingforeignobjects(DLLs,sharedobjects)246
9.2.4 Low-leveloperationsonsharedlibraries . . . . . . . . . . . . . . . . . . . . 248
9.2.5 StaticLinking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
9.3 InterfaceDatatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
9.3.1 Typeterm t: areferencetoaPrologterm . . . . . . . . . . . . . . . . . . 250
9.3.2 Otherforeigninterfacetypes . . . . . . . . . . . . . . . . . . . . . . . . . . 251
9.4 TheForeignIncludeFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
9.4.1 ArgumentPassingandControl . . . . . . . . . . . . . . . . . . . . . . . . . 252
9.4.2 Atomsandfunctors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
9.4.3 AnalysingTermsviatheForeignInterface . . . . . . . . . . . . . . . . . . . 256
9.4.4 ConstructingTerms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
9.4.5 Unifyingdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
9.4.6 ConvenientfunctionstogeneratePrologexceptions . . . . . . . . . . . . . . 272
SWI-Prolog6.2ReferenceManual
6
9.4.7 BLOBS:Usingatomstostorearbitrarybinarydata . . . . . . . . . . . . . . 274
9.4.8 ExchangingGMPnumbers . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
9.4.9 CallingPrologfromC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
9.4.10 DiscardingData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
9.4.11 ForeignCodeandModules . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
9.4.12 Prologexceptionsinforeigncode . . . . . . . . . . . . . . . . . . . . . . . 282
9.4.13 CatchingSignals(SoftwareInterrupts) . . . . . . . . . . . . . . . . . . . . . 284
9.4.14 Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
9.4.15 Errorsandwarnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
9.4.16 EnvironmentControlfromForeignCode . . . . . . . . . . . . . . . . . . . 288
9.4.17 QueryingProlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
9.4.18 RegisteringForeignPredicates . . . . . . . . . . . . . . . . . . . . . . . . . 289
9.4.19 ForeignCodeHooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
9.4.20 Storingforeigndata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
9.4.21 EmbeddingSWI-Prologinotherapplications . . . . . . . . . . . . . . . . . 297
9.5 Linkingembeddedapplicationsusingswipl-ld . . . . . . . . . . . . . . . . . . . . . 300
9.5.1 Asimpleexample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
9.6 TheProlog‘home’directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
9.7 ExampleofUsingtheForeignInterface . . . . . . . . . . . . . . . . . . . . . . . . 304
9.8 NotesonUsingForeignCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
9.8.1 MemoryAllocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
9.8.2 CompatibilitybetweenPrologversions . . . . . . . . . . . . . . . . . . . . 306
9.8.3 Debuggingandprofilingforeigncode(valgrind) . . . . . . . . . . . . . . . 307
9.8.4 NameConflictsinCmodules . . . . . . . . . . . . . . . . . . . . . . . . . 307
9.8.5 CompatibilityoftheForeignInterface . . . . . . . . . . . . . . . . . . . . . 307
10 GeneratingRuntimeApplications 309
10.1 Limitationsofqsave program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
10.2 RuntimesandForeignCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
10.3 Usingprogramresources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
10.3.1 PredicateDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
10.3.2 Theswipl-rcprogram. . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
10.4 FindingApplicationfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
10.4.1 Passingapathtotheapplication . . . . . . . . . . . . . . . . . . . . . . . . 315
A TheSWI-Prologlibrary 316
A.1 library(aggregate): Aggregationoperatorsonbacktrackablepredicates . . . . . . . . 316
A.2 library(apply): Applypredicatesonalist . . . . . . . . . . . . . . . . . . . . . . . . 319
A.3 library(assoc): Associationlists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
A.4 library(broadcast): Broadcastandreceiveeventnotifications . . . . . . . . . . . . . 321
A.5 library(charsio): I/OonListsofCharacterCodes . . . . . . . . . . . . . . . . . . . 323
A.6 library(check): Elementarycompletenesschecks . . . . . . . . . . . . . . . . . . . 325
A.7 library(clpfd): ConstraintLogicProgrammingoverFiniteDomains . . . . . . . . . . 325
A.8 library(clpqr): ConstraintLogicProgrammingoverRationalsandReals . . . . . . . 340
A.8.1 Solverpredicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
A.8.2 Syntaxofthepredicatearguments . . . . . . . . . . . . . . . . . . . . . . . 342
A.8.3 Useofunification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
SWI-Prolog6.2ReferenceManual
Contents 7
A.8.4 Non-linearconstraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
A.8.5 Statusandknownproblems . . . . . . . . . . . . . . . . . . . . . . . . . . 343
A.9 library(csv): ProcessCSV(Comma-SeparatedValues)data . . . . . . . . . . . . . . 344
A.10 library(debug): Printdebugmessagesandtestassertions . . . . . . . . . . . . . . . 345
A.11 library(gensym): Generateuniqueidentifiers . . . . . . . . . . . . . . . . . . . . . . 347
A.12 library(lists): ListManipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
A.13 library(nb set): Non-backtrackableset . . . . . . . . . . . . . . . . . . . . . . . . . 352
A.14 library(www browser): ActivatingyourWeb-browser . . . . . . . . . . . . . . . . . 353
A.15 library(option): Optionlistprocessing . . . . . . . . . . . . . . . . . . . . . . . . . 353
A.16 library(optparse): commandlineparsing . . . . . . . . . . . . . . . . . . . . . . . . 355
A.16.1 Notesandtips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
A.17 library(ordsets): Orderedsetmanipulation . . . . . . . . . . . . . . . . . . . . . . . 361
A.18 library(pairs): Operationsonkey-valuelists . . . . . . . . . . . . . . . . . . . . . . 363
A.19 library(pio): PureI/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
A.19.1 library(pure input): PureInputfromfiles . . . . . . . . . . . . . . . . . . . 364
A.20 library(predicate options): Declareoption-processingofpredicates . . . . . . . . . . 365
A.20.1 Thestrengthandweaknessofpredicateoptions . . . . . . . . . . . . . . . . 365
A.20.2 Optionsasargumentsorenvironment? . . . . . . . . . . . . . . . . . . . . . 366
A.20.3 Improvingonthecurrentsituation . . . . . . . . . . . . . . . . . . . . . . . 367
A.21 library(prolog pack): ApackagemanagerforProlog . . . . . . . . . . . . . . . . . 370
A.22 library(prolog xref): Cross-referencedatacollectionlibrary . . . . . . . . . . . . . . 372
A.22.1 Extendingthelibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
A.23 library(random): Randomnumbers . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
A.24 library(readutil): Readinglines,streamsandfiles . . . . . . . . . . . . . . . . . . . 375
A.25 library(record): Accessnamedfieldsinaterm . . . . . . . . . . . . . . . . . . . . . 376
A.26 library(registry): ManipulatingtheWindowsregistry . . . . . . . . . . . . . . . . . 378
A.27 library(simplex): Solvelinearprogrammingproblems . . . . . . . . . . . . . . . . . 379
A.27.1 Example1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
A.27.2 Example2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
A.27.3 Example3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
A.28 library(thread pool): Resourceboundedthreadmanagement . . . . . . . . . . . . . 383
A.29 library(ugraphs): UnweightedGraphs . . . . . . . . . . . . . . . . . . . . . . . . . 384
A.30 library(url): AnalysingandconstructingURL . . . . . . . . . . . . . . . . . . . . . 388
A.31 library(varnumbers): Utilitiesfornumberedterms . . . . . . . . . . . . . . . . . . . 390
B Hackerscorner 392
B.1 ExaminingtheEnvironmentStack . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
B.2 Globalcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
B.3 InterceptingtheTracer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
B.4 Addingcontexttoerrors: prolog exception hook . . . . . . . . . . . . . . . . . . . 396
B.5 Hooksusingtheexceptionpredicate . . . . . . . . . . . . . . . . . . . . . . . . . . 397
B.6 Hooksforintegratinglibraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
B.7 Hooksforloadingfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
B.8 ReadlineInteraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
C CompatibilitywithotherPrologdialects 400
C.1 Someconsiderationsforwritingportablecode . . . . . . . . . . . . . . . . . . . . . 401
SWI-Prolog6.2ReferenceManual
8
D GlossaryofTerms 404
E SWI-PrologLicenseConditionsandTools 409
E.1 TheSWI-Prologkernelandforeignlibraries . . . . . . . . . . . . . . . . . . . . . . 409
E.1.1 TheSWI-PrologProloglibraries . . . . . . . . . . . . . . . . . . . . . . . . 409
E.2 ContributingtotheSWI-Prologproject . . . . . . . . . . . . . . . . . . . . . . . . 410
E.3 Softwaresupporttokeeptrackoflicenseconditions . . . . . . . . . . . . . . . . . . 410
E.4 Licenseconditionsinheritedfromusedcode . . . . . . . . . . . . . . . . . . . . . . 411
E.4.1 Cryptographicroutines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
F Summary 413
F.1 Predicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
F.2 Librarypredicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
F.2.1 aggregate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
F.2.2 apply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
F.2.3 assoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
F.2.4 broadcast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
F.2.5 charsio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
F.2.6 check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
F.2.7 csv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
F.2.8 lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
F.2.9 debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
F.2.10 option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
F.2.11 optparse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
F.2.12 ordsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
F.2.13 predicate options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
F.2.14 prologpack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
F.2.15 prologxref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
F.2.16 pairs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
F.2.17 pio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
F.2.18 random . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
F.2.19 readutil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
F.2.20 record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
F.2.21 registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
F.2.22 ugraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
F.2.23 url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
F.2.24 www browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
F.2.25 clp/clpfd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
F.2.26 clpqr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
F.2.27 clp/simplex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
F.2.28 thread pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
F.2.29 varnumbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
F.3 ArithmeticFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
F.4 Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
SWI-Prolog6.2ReferenceManual