/usr/share/doc/swi-prolog-doc/Manual/plld.html is in swi-prolog-doc 5.6.59-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<HTML>
<HEAD>
<TITLE>SWI-Prolog 5.6.59 Reference Manual: Section 9.7</TITLE><LINK REL=home HREF="index.html">
<LINK REL=contents HREF="Contents.html">
<LINK REL=index HREF="DocIndex.html">
<LINK REL=previous HREF="foreigninclude.html">
<LINK REL=next HREF="findhome.html">
<STYLE type="text/css">
/* Style sheet for SWI-Prolog latex2html
*/
dd.defbody
{ margin-bottom: 1em;
}
dt.pubdef
{ background-color: #c5e1ff;
}
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;
font-size: 80%;
font-style: italic;
color: #202020;
}
/* Footnotes */
sup.fn { color: blue; text-decoration: underline; }
span.fn-text { display: none; }
sup.fn span {display: none;}
sup:hover span
{ display: block !important;
position: absolute; top: auto; left: auto; width: 80%;
color: #000; background: white;
border: 2px solid;
padding: 5px; margin: 10px; z-index: 100;
font-size: smaller;
}
</STYLE>
</HEAD>
<BODY BGCOLOR="white">
<DIV class="navigate"><A class="nav" href="index.html"><IMG SRC="home.gif" BORDER=0 ALT="Home"></A>
<A class="nav" href="Contents.html"><IMG SRC="index.gif" BORDER=0 ALT="Contents"></A>
<A class="nav" href="DocIndex.html"><IMG SRC="yellow_pages.gif" BORDER=0 ALT="Index"></A>
<A class="nav" href="foreigninclude.html"><IMG SRC="prev.gif" BORDER=0 ALT="Previous"></A>
<A class="nav" href="findhome.html"><IMG SRC="next.gif" BORDER=0 ALT="Next"></A>
</DIV>
<H2><A NAME="sec:9.7"><SPAN class="sec-nr">9.7</SPAN> <SPAN class="sec-title">Linking
embedded applications using plld</SPAN></A></H2>
<A NAME="sec:plld"></A>
<P>The utility program <B>plld</B> (Win32: plld.exe) may be used to link
a combination of C-files and Prolog files into a stand-alone executable.
<B>plld</B> automates most of what is described in the previous
sections.
<P>In the normal usage, a copy is made of the default embedding template
<CODE>\ldots/pl/include/stub.c</CODE>. The main() routine is modified to
suit your application. PL_initialise() <STRONG>must</STRONG> be passed
the program-name (<VAR>argv[0]</VAR>) (Win32: the executing program can
be obtained using GetModuleFileName()). The other elements of the
command-line may be modified. Next, <B>plld</B> is typically invoked as:
<PRE class="code">
plld -o output stubfile.c [other-c-or-o-files] [plfiles]
</PRE>
<P><B>plld</B> will first split the options into various groups for both
the C-compiler and the Prolog compiler. Next, it will add various
default options to the C-compiler and call it to create an executable
holding the user's C-code and the Prolog kernel. Then, it will call the
SWI-Prolog compiler to create a saved state from the provided Prolog
files and finally, it will attach this saved state to the created
emulator to create the requested executable.
<P>Below, it is described how the options are split and which additional
options are passed.
<DL>
<DT><STRONG>-help</STRONG> <VAR></VAR></DT>
<DD class="defbody">
Print brief synopsis.
</DD>
<DT><STRONG>-pl</STRONG> <VAR>prolog</VAR></DT>
<DD class="defbody">
Select the prolog to use. This prolog is used for two purposes: get the
home-directory as well as the compiler/linker options and create a saved
state of the Prolog code.
</DD>
<DT><STRONG>-ld</STRONG> <VAR>linker</VAR></DT>
<DD class="defbody">
Linker used to link the raw executable. Default is to use the C-compiler
(Win32: <B>link.exe</B>).
</DD>
<DT><STRONG>-cc</STRONG> <VAR>C-compiler</VAR></DT>
<DD class="defbody">
Compiler for <CODE>.c</CODE> files found on the command-line. Default is
the compiler used to build SWI-Prolog accessible through the Prolog flag
<A class="flag" href="flags.html#flag:c_cc">c_cc</A> (Win32: <B>cl.exe</B>)..
</DD>
<DT><STRONG>-c++</STRONG> <VAR>C++-compiler</VAR></DT>
<DD class="defbody">
Compiler for C++ sources (extensions <CODE>.cpp</CODE>, <CODE>.cxx</CODE>,
<CODE>.cc</CODE> or <CODE>.C</CODE>) files found on the command-line.
Default is
<B>c++</B> or <B>g++</B> if the C-compiler is <B>gcc</B>) (Win32:
cl.exe).</DD>
<DT><STRONG>-nostate</STRONG> <VAR></VAR></DT>
<DD class="defbody">
Just relink the kernel, do not add any Prolog code to the new kernel.
This is used to create a new kernel holding additional foreign
predicates on machines that do not support the shared-library (DLL)
interface, or if building the state cannot be handled by the default
procedure used by
<B>plld</B>. In the latter case the state is created separately and
appended to the kernel using <CODE>cat <<VAR>kernel</VAR>> <<VAR>state</VAR>>
> <<VAR>out</VAR>></CODE> (Win32: <CODE>copy /b <<VAR>kernel</VAR>>+<<VAR>state</VAR>> <<VAR>out</VAR>></CODE>)</DD>
<DT><STRONG>-shared</STRONG> <VAR></VAR></DT>
<DD class="defbody">
Link C, C++ or object files into a shared object (DLL) that can be
loaded by the <A NAME="idx:loadforeignlibrary1:1415"></A><A class="pred" href="DLL.html#load_foreign_library/1">load_foreign_library/1</A>
predicate. If used with
<STRONG>-c</STRONG> it sets the proper options to compile a C or C++
file ready for linking into a shared object</DD>
<DT><STRONG>-dll</STRONG> <VAR></VAR></DT>
<DD class="defbody">
<EM>Windows only</EM>. Embed SWI-Prolog into a DLL rather than an
executable.</DD>
<DT><STRONG>-c</STRONG> <VAR></VAR></DT>
<DD class="defbody">
Compile C or C++ source-files into object files. This turns
<B>plld</B> into a replacement for the C or C++ compiler where proper
options such as the location of the include directory are passed
automatically to the compiler.</DD>
<DT><STRONG>-E</STRONG> <VAR></VAR></DT>
<DD class="defbody">
Invoke the C preprocessor. Used to make <B>plld</B> a replacement for
the C or C++ compiler.</DD>
<DT><STRONG>-pl-options</STRONG> <VAR>, ...</VAR></DT>
<DD class="defbody">
Additional options passed to Prolog when creating the saved state. The
first character immediately following <CODE>pl-options</CODE> is used as
separator and translated to spaces when the argument is built. Example: <CODE>-pl-options,-F,xpce</CODE>
passed <CODE>-F xpce</CODE> as additional flags to Prolog.
</DD>
<DT><STRONG>-ld-options</STRONG> <VAR>, ...</VAR></DT>
<DD class="defbody">
Passes options to the linker, similar to <STRONG>-pl-options</STRONG>.
</DD>
<DT><STRONG>-cc-options</STRONG> <VAR>, ...</VAR></DT>
<DD class="defbody">
Passes options to the C/C++ compiler, similar to <STRONG>-pl-options</STRONG>.
</DD>
<DT><STRONG>-v</STRONG> <VAR></VAR></DT>
<DD class="defbody">
Select verbose operation, showing the various programs and their
options.
</DD>
<DT><STRONG>-o</STRONG> <VAR>outfile</VAR></DT>
<DD class="defbody">
Reserved to specify the final output file.
</DD>
<DT><STRONG>-l</STRONG><VAR>library</VAR></DT>
<DD class="defbody">
Specifies a library for the C-compiler. By default, <CODE>-lpl</CODE>
(Win32: libpl.lib) and the libraries needed by the Prolog kernel are
given.
</DD>
<DT><STRONG>-L</STRONG><VAR>library-directory</VAR></DT>
<DD class="defbody">
Specifies a library directory for the C-compiler. By default the
directory containing the Prolog C-library for the current architecture
is passed.
</DD>
<DT><STRONG><STRONG>-g</STRONG> | <STRONG>-I<VAR>include-directory</VAR></STRONG>
| <STRONG>-D<VAR>definition</VAR></STRONG></STRONG> <VAR></VAR></DT>
<DD class="defbody">
These options are passed to the C-compiler. By default, the include
directory containing <CODE>SWI-Prolog.h</CODE> is passed. <B>plld</B>
adds two additional <STRONG>*</STRONG> <VAR>-D</VAR>def flags:
<DL>
<DT><STRONG>-D</STRONG><VAR><CODE>__SWI_PROLOG__</CODE></VAR></DT>
<DD class="defbody">
Indicates the code is to be connected to SWI-Prolog.
</DD>
<DT><STRONG>-D</STRONG><VAR><CODE>__SWI_EMBEDDED__</CODE></VAR></DT>
<DD class="defbody">
Indicates the creation of an embedded program.
</DD>
</DL>
</DD>
<DT><STRONG></STRONG> <VAR>*.o | *.c | *.C | *.cxx | *.cpp</VAR></DT>
<DD class="defbody">
Passed as input files to the C-compiler
</DD>
<DT><STRONG></STRONG> <VAR>*.pl | *.qlf</VAR></DT>
<DD class="defbody">
Passed as input files to the Prolog compiler to create the saved-state.
</DD>
<DT><STRONG></STRONG> <VAR><CODE>*</CODE></VAR></DT>
<DD class="defbody">
I.e. all other options. These are passed as linker options to the
C-compiler.
</DD>
</DL>
<H3><A NAME="sec:9.7.1"><SPAN class="sec-nr">9.7.1</SPAN> <SPAN class="sec-title">A
simple example</SPAN></A></H3>
<P>The following is a very simple example going through all the steps
outlined above. It provides an arithmetic expression evaluator. We will
call the application <B>calc</B> and define it in the files <CODE>calc.c</CODE>
and <CODE>calc.pl</CODE>. The Prolog file is simple:
<PRE class="code">
calc(Atom) :-
term_to_atom(Expr, Atom),
A is Expr,
write(A),
nl.
</PRE>
<P>The C-part of the application parses the command-line options,
initialises the Prolog engine, locates the calc/1 predicate and calls
it. The coder is in <A class="fig" href="plld.html#fig:calc">figure 11</A>.
<PRE class="code">
#include <stdio.h>
#include <SWI-Prolog.h>
#define MAXLINE 1024
int
main(int argc, char **argv)
{ char expression[MAXLINE];
char *e = expression;
char *program = argv[0];
char *plav[2];
int n;
/* combine all the arguments in a single string */
for(n=1; n<argc; n++)
{ if ( n != 1 )
*e++ = ' ';
strcpy(e, argv[n]);
e += strlen(e);
}
/* make the argument vector for Prolog */
plav[0] = program;
plav[1] = NULL;
/* initialise Prolog */
if ( !PL_initialise(1, plav) )
PL_halt(1);
/* Lookup calc/1 and make the arguments and call */
{ predicate_t pred = PL_predicate("calc", 1, "user");
term_t h0 = PL_new_term_refs(1);
int rval;
PL_put_atom_chars(h0, expression);
rval = PL_call_predicate(NULL, PL_Q_NORMAL, pred, h0);
PL_halt(rval ? 0 : 1);
}
return 0;
}
</PRE>
<TABLE ALIGN=center WIDTH="75%"><TR><TD>
<B>Figure 11 : </B>C-source for the calc application</TABLE>
<A NAME="fig:calc"></A>
<P>The application is now created using the following command-line:
<PRE class="code">
% plld -o calc calc.c calc.pl
</PRE>
<P>The following indicates the usage of the application:
<PRE class="code">
% calc pi/2
1.5708
</PRE>
<P></BODY></HTML>
|