1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>SWI-Prolog 7.3.6 Reference Manual: Section A.25</title><link rel="home" href="index.html">
<link rel="contents" href="Contents.html">
<link rel="index" href="DocIndex.html">
<link rel="summary" href="summary.html">
<link rel="previous" href="prologpack.html">
<link rel="next" href="quasiquotations.html">
<style type="text/css">
/* Style sheet for SWI-Prolog latex2html
*/
dd.defbody
{ margin-bottom: 1em;
}
dt.pubdef, dt.multidef
{ color: #fff;
padding: 2px 10px 0px 10px;
margin-bottom: 5px;
font-size: 18px;
vertical-align: middle;
overflow: hidden;
}
dt.pubdef { background-color: #0c3d6e; }
dt.multidef { background-color: #ef9439; }
.bib dd
{ margin-bottom: 1em;
}
.bib dt
{ float: left;
margin-right: 1.3ex;
}
pre.code
{ margin-left: 1.5em;
margin-right: 1.5em;
border: 1px dotted;
padding-top: 5px;
padding-left: 5px;
padding-bottom: 5px;
background-color: #f8f8f8;
}
div.navigate
{ text-align: center;
background-color: #f0f0f0;
border: 1px dotted;
padding: 5px;
}
div.title
{ text-align: center;
padding-bottom: 1em;
font-size: 200%;
font-weight: bold;
}
div.author
{ text-align: center;
font-style: italic;
}
div.abstract
{ margin-top: 2em;
background-color: #f0f0f0;
border: 1px dotted;
padding: 5px;
margin-left: 10%; margin-right:10%;
}
div.abstract-title
{ text-align: center;
padding: 5px;
font-size: 120%;
font-weight: bold;
}
div.toc-h1
{ font-size: 200%;
font-weight: bold;
}
div.toc-h2
{ font-size: 120%;
font-weight: bold;
margin-left: 2em;
}
div.toc-h3
{ font-size: 100%;
font-weight: bold;
margin-left: 4em;
}
div.toc-h4
{ font-size: 100%;
margin-left: 6em;
}
span.sec-nr
{
}
span.sec-title
{
}
span.pred-ext
{ font-weight: bold;
}
span.pred-tag
{ float: right;
padding-top: 0.2em;
font-size: 80%;
font-style: italic;
color: #fff;
}
div.caption
{ width: 80%;
margin: auto;
text-align:center;
}
/* Footnotes */
.fn {
color: red;
font-size: 70%;
}
.fn-text, .fnp {
position: absolute;
top: auto;
left: 10%;
border: 1px solid #000;
box-shadow: 5px 5px 5px #888;
display: none;
background: #fff;
color: #000;
margin-top: 25px;
padding: 8px 12px;
font-size: larger;
}
sup:hover span.fn-text
{ display: block;
}
/* Lists */
dl.latex
{ margin-top: 1ex;
margin-bottom: 0.5ex;
}
dl.latex dl.latex dd.defbody
{ margin-bottom: 0.5ex;
}
/* PlDoc Tags */
dl.tags
{ font-size: 90%;
margin-left: 5ex;
margin-top: 1ex;
margin-bottom: 0.5ex;
}
dl.tags dt
{ margin-left: 0pt;
font-weight: bold;
}
dl.tags dd
{ margin-left: 3ex;
}
td.param
{ font-style: italic;
font-weight: bold;
}
/* Index */
dt.index-sep
{ font-weight: bold;
font-size: +1;
margin-top: 1ex;
}
/* Tables */
table.center
{ margin: auto;
}
table.latex
{ border-collapse:collapse;
}
table.latex tr
{ vertical-align: text-top;
}
table.latex td,th
{ padding: 2px 1em;
}
table.latex tr.hline td,th
{ border-top: 1px solid black;
}
table.frame-box
{ border: 2px solid black;
}
</style>
</head>
<body style="background:white">
<div class="navigate"><a class="nav" href="index.html"><img src="home.gif" alt="Home"></a>
<a class="nav" href="Contents.html"><img src="index.gif" alt="Contents"></a>
<a class="nav" href="DocIndex.html"><img src="yellow_pages.gif" alt="Index"></a>
<a class="nav" href="summary.html"><img src="info.gif" alt="Summary"></a>
<a class="nav" href="prologpack.html"><img src="prev.gif" alt="Previous"></a>
<a class="nav" href="quasiquotations.html"><img src="next.gif" alt="Next"></a>
</div>
<h2 id="sec:prolog_xref"><a id="sec:A.25"><span class="sec-nr">A.25</span> <span class="sec-title">library(prolog_xref):
Cross-reference data collection library</span></a></h2>
<a id="sec:prolog_xref"></a>
<a id="sec:lib:prologxref"></a>
<p>This library collects information on defined and used objects in
Prolog source files. Typically these are predicates, but we expect the
library to deal with other types of objects in the future. The library
is a building block for tools doing dependency tracking in applications.
Dependency tracking is useful to reveal the structure of an unknown
program or detect missing components at compile time, but also for
program transformation or minimising a program saved state by only
saving the reachable objects.
<p>This section gives a partial description of the library API,
providing some insight in how you can use it for analysing your program.
The library should be further modularized, moving its knowledge about,
for example, XPCE into a different file and allowing for adding
knowledge about other libraries such as Logtalk. <b>Please do not
consider this interface rock-solid.</b>
<p>The library is exploited by two graphical tools in the SWI-Prolog
environment: the XPCE front-end started by <a id="idx:gxref0:1961"></a><a class="pred" href="xref.html#gxref/0">gxref/0</a>
and described in
<a class="sec" href="xref.html">section 3.7</a>, and PceEmacs (<a class="sec" href="pceemacs.html">section
3.4</a>), which exploits this library for its syntax colouring.
<p>For all predicates described below, <var>Source</var> is the source
that is processed. This is normally a filename in any notation
acceptable to the file loading predicates (see <a id="idx:loadfiles2:1962"></a><a class="pred" href="consulting.html#load_files/2">load_files/2</a>).
Using the hooks defined in <a class="sec" href="prolog_xref.html">section
A.25.1</a> it can be anything else that can be translated into a Prolog
stream holding Prolog source text. <var>Callable</var> is a callable
term (see <a id="idx:callable1:1963"></a><a class="pred" href="typetest.html#callable/1">callable/1</a>).
Callables do not carry a module qualifier unless the referred predicate
is not in the module defined
<var>Source</var>.
<dl class="latex">
<dt class="pubdef"><a id="xref_source/1"><strong>xref_source</strong>(<var>+Source</var>)</a></dt>
<dd class="defbody">
Gather information on <var>Source</var>. If <var>Source</var> has
already been processed and is still up-to-date according to the file
timestamp, no action is taken. This predicate must be called on a file
before information can be gathered.</dd>
<dt class="pubdef"><a id="xref_current_source/1"><strong>xref_current_source</strong>(<var>?Source</var>)</a></dt>
<dd class="defbody">
<var>Source</var> has been processed.</dd>
<dt class="pubdef"><a id="xref_clean/1"><strong>xref_clean</strong>(<var>+Source</var>)</a></dt>
<dd class="defbody">
Remove the information gathered for <var>Source</var></dd>
<dt class="pubdef"><a id="xref_defined/3"><strong>xref_defined</strong>(<var>?Source,
?Callable, -How</var>)</a></dt>
<dd class="defbody">
<var>Callable</var> is defined in <var>Source</var>. <var>How</var> is
one of
<table class="latex frame-void center">
<tr><td><code>dynamic(Line)</code> </td><td>Declared dynamic at <var>Line</var> </td></tr>
<tr><td><code>thread_local(Line)</code> </td><td>Declared thread local
at <var>Line</var> </td></tr>
<tr><td><code>multifile(Line)</code> </td><td>Declared multifile at <var>Line</var> </td></tr>
<tr><td><code>local(Line)</code> </td><td>First clause at <var>Line</var> </td></tr>
<tr><td><code>foreign(Line)</code> </td><td>Foreign library loaded at <var>Line</var> </td></tr>
<tr><td><code>constraint(Line)</code> </td><td>CHR Constraint at <var>Line</var> </td></tr>
<tr><td><code>imported(File)</code> </td><td>Imported from <var>File</var> </td></tr>
</table>
</dd>
<dt class="pubdef"><a id="xref_called/3"><strong>xref_called</strong>(<var>?Source,
?Callable, ?By</var>)</a></dt>
<dd class="defbody">
<var>Callable</var> is called in <var>Source</var> by <var>By</var>.</dd>
<dt class="pubdef"><a id="xref_exported/2"><strong>xref_exported</strong>(<var>?Source,
?Callable</var>)</a></dt>
<dd class="defbody">
<var>Callable</var> is public (exported from the module).</dd>
<dt class="pubdef"><a id="xref_module/2"><strong>xref_module</strong>(<var>?Source,
?Module</var>)</a></dt>
<dd class="defbody">
<var>Source</var> is a module file defining the given module.</dd>
<dt class="pubdef"><a id="xref_built_in/1"><strong>xref_built_in</strong>(<var>?Callable</var>)</a></dt>
<dd class="defbody">
True if <var>Callable</var> is a built-in predicate. Currently this is
assumed for all predicates defined in the <code>system</code> module and
having the property <code>built_in</code>. Built-in predicates are not
registered as `called'.
</dd>
</dl>
<p><h3 id="sec:xrefhooks"><a id="sec:A.25.1"><span class="sec-nr">A.25.1</span> <span class="sec-title">Extending
the library</span></a></h3>
<a id="sec:xrefhooks"></a>
<p>The library provides hooks for extending the rules it uses for
finding predicates called by some programming construct.
<dl class="latex">
<dt class="pubdef"><a id="prolog:called_by/2"><strong>prolog:called_by</strong>(<var>+Goal,
-Called</var>)</a></dt>
<dd class="defbody">
<var>Goal</var> is a non-var subgoal appearing in the called object
(typically a clause body). If it succeeds it must return a list of goals
called by <var>Goal</var>. As a special construct, if a term <var>Callable+N</var>
is returned, <var>N</var> variable arguments are added to <var>Callable</var>
before further processing. For simple meta-calls a single fact suffices.
Complex rules as used in the <code>library(html_write)</code> library
provided by the HTTP package examine the arguments and create a list of
called objects.
<p>The current system cannot deal with the same name/arity in different
modules that behave differently with respect to called arguments.
</dd>
</dl>
</body></html>
|
