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
|
/* Part of SWI-Prolog
Author: Jan Wielemaker
E-mail: J.Wielemaker@vu.nl
WWW: http://www.swi-prolog.org
Copyright (c) 2018-2023, VU University Amsterdam
CWI, Amsterdam
SWI-Prolog Solutions b.v.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
:- module(prolog_build_home, []).
/** <module> Setup SWI-Prolog to run from the build directory
This module is loaded if SWI-Prolog is started in the build tree and
sets up paths such that all packages can be loaded and the system can be
used interactively similar to the installed system. This serves several
purposes:
- We can easily debug the various installations
- We can easily develop
- We can build the documentation without installing
This file is normally installed in `CMAKE_BINARY_DIRECTORY/home`.
*/
%! cmake_binary_directory(-BinDir) is det.
%! cmake_source_directory(-SrcDir) is det.
%
% Find the equivalent of =CMAKE_BINARY_DIRECTORY= and
% CMAKE_SOURCE_DIRECTORY.
:- dynamic
cmake_bindir/1.
cmake_binary_directory(BinDir) :-
cmake_bindir(BinDir),
!.
cmake_binary_directory(BinDir) :-
exe_or_shared_object(Exe),
parent_dir(Exe, BinDir),
atom_concat(BinDir, '/home/boot.prc', BootFile),
exists_file(BootFile),
!,
asserta(cmake_bindir(BinDir)).
exe_or_shared_object(File) :- % only reliable when read-only
'$current_prolog_flag'(libswipl, File, _Scope, read, atom),
!.
exe_or_shared_object(File) :-
current_prolog_flag(executable, OsExe),
OsExe \== 'libswipl.dll', % avoid dummy for embedded JPL test
prolog_to_os_filename(Exe, OsExe),
working_directory(PWD, PWD),
exe_access(ExeAccess),
absolute_file_name(Exe, File,
[ access(ExeAccess),
relative_to(PWD)
]).
parent_dir(Dir, Dir).
parent_dir(Dir, Parent) :-
file_directory_name(Dir, Parent0),
Parent0 \== Dir,
parent_dir(Parent0, Parent).
exe_access(Access) :-
( current_prolog_flag(unix, true)
-> Access = execute
; Access = read
).
%! swipl_package(-Pkg, -PkgBinDir) is nondet.
%
% True when Pkg is available in the build tree at the given location.
swipl_package(Pkg, PkgBinDir) :-
cmake_binary_directory(CMakeBinDir),
atomic_list_concat([CMakeBinDir, packages], /, PkgRoot),
exists_directory(PkgRoot),
directory_files(PkgRoot, Candidates),
'$member'(Pkg, Candidates),
\+ special(Pkg),
atomic_list_concat([PkgRoot, Pkg], /, PkgBinDir),
atomic_list_concat([PkgBinDir, 'CMakeFiles'], /, CMakeDir),
exists_directory(CMakeDir).
special(.).
special(..).
:- multifile user:file_search_path/2.
:- dynamic user:file_search_path/2.
user:file_search_path(library, swi(packages)).
user:file_search_path(foreign, AppDir) :-
current_prolog_flag(windows, true),
current_prolog_flag(executable, Exe),
prolog_to_os_filename(PlExe, Exe),
file_directory_name(PlExe, AppDir).
%! add_package(+Package, +PkgSrcDir, +PkgBinDir) is det.
%
% Setup the source paths and initialization for Package with the given
% source and binary location.
add_package(xpce, PkgBinDir) :-
!,
add_package_path(PkgBinDir),
( absolute_file_name(swi('xpce/prolog/swipl-rc'),
RCFile,
[ access(read),
file_errors(fail)
])
-> use_module(RCFile)
; true
).
add_package(chr, PkgBinDir) :-
assertz(user:file_search_path(chr, PkgBinDir)),
assertz(user:file_search_path(chr, library(chr))),
assertz(user:file_search_path(library, PkgBinDir)).
add_package(jpl, PkgBinDir) :-
add_package_path(PkgBinDir),
atomic_list_concat([PkgBinDir, 'src/main/java'], /, JarDir),
assertz(user:file_search_path(jar, JarDir)).
add_package(http, PkgBinDir) :-
add_package_path(PkgBinDir),
file_directory_name(PkgBinDir, PkgDir),
assertz(user:file_search_path(library, PkgDir)).
add_package(_Pkg, PkgBinDir) :-
add_package_path(PkgBinDir).
%! add_package_path(+PkgBinDir) is det.
%
% Add the binary directories for the package to the `foreign` search
% path. Note that we only need to add the binary directory if it
% contains shared objects, but it is probably cheaper to add it
% anyway. On Windows, all .dll files are in the directory of the
% executable.
add_package_path(_) :-
current_prolog_flag(windows, true),
!.
add_package_path(PkgBinDir) :-
assertz(user:file_search_path(foreign, PkgBinDir)).
:- if(\+ current_prolog_flag(emscripten, true)).
% disabled as we do not (yet) have packages and opendir() is broken
% and this directory_files/2 raises an exception.
:- forall(swipl_package(Pkg, PkgBinDir),
add_package(Pkg, PkgBinDir)).
:- endif.
%! set_version_info
%
% Indicate we are running from the build directory rather than using
% an installed version.
set_version_info :-
( cmake_binary_directory(BinDir)
-> version(format(' CMake built from "~w"', [BinDir]))
; current_prolog_flag(home, Home)
-> version(format(' CMake built with home "~w"', [Home]))
).
:- initialization(set_version_info).
%! set_libswipl
%
% Set the value for libswipl.
:- if(\+current_prolog_flag(libswipl, _)).
set_libswipl :-
current_prolog_flag(shared_object_extension, SO),
\+current_prolog_flag(windows, true),
!,
cmake_binary_directory(BinDir),
format(atom(Value), '~w/src/libswipl.~w', [BinDir, SO]),
set_prolog_flag(libswipl, Value).
set_libswipl.
:- initialization(set_libswipl).
:- endif.
% Avoid getting Java from the host when running under Wine.
:- if(current_prolog_flag(wine_version, _)).
delete_host_java_home :-
( getenv('JAVA_HOME', Dir),
sub_atom(Dir, 0, _, _, /)
-> unsetenv('JAVA_HOME')
; true
).
:- initialization(delete_host_java_home).
:- endif.
/*******************************
* DOCUMENTATION *
*******************************/
user:file_search_path(swi_man_manual, ManDir) :-
cmake_binary_directory(BinDir),
atomic_list_concat([BinDir, 'man/Manual'], /, ManDir).
user:file_search_path(swi_man_packages, BinDir) :-
swipl_package(_, BinDir).
/*******************************
* CONFIGURATION *
*******************************/
:- multifile
prolog:runtime_config/2.
prolog:runtime_config(c_libdir, LibDir) :-
cmake_binary_directory(BinDir),
atomic_list_concat([BinDir, src], /, LibDir).
|
