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
|
########################################################################
##
## Copyright (C) 2006-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} mkoctfile [-options] file @dots{}
## @deftypefnx {} {[@var{output}, @var{status}] =} mkoctfile (@dots{})
##
## The @code{mkoctfile} function compiles source code written in C, C++, or
## Fortran. Depending on the options used with @code{mkoctfile}, the
## compiled code can be called within Octave or can be used as a stand-alone
## application.
##
## @code{mkoctfile} can be called from the shell prompt or from the Octave
## prompt. Calling it from the Octave prompt simply delegates the call to
## the shell prompt. Any output is stored in the @var{output} variable and
## the exit status in the @var{status} variable. If called with no outputs
## and the compilation fails then Octave will emit an error. If the programmer
## requests @var{output} or @var{status}, however, Octave will merely issue
## a warning and it is the programmer's responsibility to verify the command
## was successful.
##
## @code{mkoctfile} accepts the following options, all of which are optional
## except for the filename of the code you wish to compile:
##
## @table @samp
## @item -I DIR
## Add the include directory DIR to compile commands.
##
## @item -D DEF
## Add the definition DEF to the compiler call.
##
## @item -l LIB
## Add the library LIB to the link command.
##
## @item -L DIR
## Add the library directory DIR to the link command.
##
## @item -M
## @itemx --depend
## Generate dependency files (.d) for C and C++ source files.
##
## @item -R DIR
## Add the run-time path to the link command.
##
## @item @nospell{-Wl,@dots{}}
## Pass options to the linker like @nospell{"-Wl,-rpath=@dots{}"}.
## The quotes are needed since commas are interpreted as command
## separators.
##
## @item -W@dots{}
## Pass options to the assembler like @nospell{"-Wa,OPTION"}.
##
## @item -c
## Compile but do not link.
##
## @item -g
## Enable debugging options for compilers.
##
## @item -o FILE
## @itemx --output FILE
## Output filename. Default extension is @file{.oct} (or @file{.mex} if
## @samp{--mex} is specified) unless linking a stand-alone executable.
##
## @item -p VAR
## @itemx --print VAR
## Print configuration variable VAR@. There are three categories of
## variables:
##
## Octave configuration variables that users may override with environment
## variables. These are used in commands that @code{mkoctfile} executes.
##
## @example
## ALL_CFLAGS INCLUDEDIR
## ALL_CXXFLAGS LAPACK_LIBS
## ALL_FFLAGS LDFLAGS
## ALL_LDFLAGS LD_STATIC_FLAG
## BLAS_LIBS LFLAGS
## CC LIBDIR
## CFLAGS LIBOCTAVE
## CPICFLAG LIBOCTINTERP
## CPPFLAGS OCTAVE_LINK_OPTS
## CXX OCTINCLUDEDIR
## CXXFLAGS OCTAVE_LIBS
## CXXLD OCTAVE_LINK_DEPS
## CXXPICFLAG OCTLIBDIR
## DL_LDFLAGS OCT_LINK_DEPS
## F77 OCT_LINK_OPTS
## F77_INTEGER8_FLAG RDYNAMIC_FLAG
## FFLAGS SPECIAL_MATH_LIB
## FPICFLAG XTRA_CFLAGS
## INCFLAGS XTRA_CXXFLAGS
## @end example
##
## Octave configuration variables as above, but currently unused by
## @code{mkoctfile}.
##
## @example
## @group
## AR
## DEPEND_EXTRA_SED_PATTERN
## DEPEND_FLAGS
## FFTW3F_LDFLAGS
## FFTW3F_LIBS
## FFTW3_LDFLAGS
## FFTW3_LIBS
## FFTW_LIBS
## FLIBS
## LIBS
## RANLIB
## READLINE_LIBS
## @end group
## @end example
##
## Octave configuration variables that are provided for informational
## purposes only. Except for @samp{OCTAVE_HOME} and @samp{OCTAVE_EXEC_HOME},
## users may not override these variables.
##
## If @w{@env{OCTAVE_HOME}}@ or @w{@env{OCTAVE_EXEC_HOME}}@ are set in the
## environment, then other variables are adjusted accordingly with
## @w{@env{OCTAVE_HOME}}@ or @w{@env{OCTAVE_EXEC_HOME}}@ substituted for the
## original value of the directory specified by the @option{--prefix} or
## @option{--exec-prefix} options that were used when Octave was configured.
##
## @example
## @group
## API_VERSION LOCALFCNFILEDIR
## ARCHLIBDIR LOCALOCTFILEDIR
## BINDIR LOCALSTARTUPFILEDIR
## CANONICAL_HOST_TYPE LOCALVERARCHLIBDIR
## DATADIR LOCALVERFCNFILEDIR
## DATAROOTDIR LOCALVEROCTFILEDIR
## DEFAULT_PAGER MAN1DIR
## EXEC_PREFIX MAN1EXT
## EXEEXT MANDIR
## FCNFILEDIR OCTAVE_EXEC_HOME
## IMAGEDIR OCTAVE_HOME
## INFODIR OCTAVE_VERSION
## INFOFILE OCTDATADIR
## LIBEXECDIR OCTDOCDIR
## LOCALAPIARCHLIBDIR OCTFILEDIR
## LOCALAPIFCNFILEDIR OCTFONTSDIR
## LOCALAPIOCTFILEDIR STARTUPFILEDIR
## LOCALARCHLIBDIR
## @end group
## @end example
##
## @item --link-stand-alone
## Link a stand-alone executable file.
##
## @item --mex
## Assume creation of a MEX file. Set the default output extension to
## @file{.mex}.
##
## @item -s
## @itemx --strip
## Strip the output file.
##
## @item -v
## @itemx --verbose
## Echo commands as they are executed.
##
## @item file
## The file to compile or link. Recognized file types are:
##
## @example
## @group
## .c C source
## .cc C++ source
## .cp C++ source
## .cpp C++ source
## .CPP C++ source
## .cxx C++ source
## .c++ C++ source
## .C C++ source
## .f Fortran source (fixed form)
## .F Fortran source (fixed form)
## .f90 Fortran source (free form)
## .F90 Fortran source (free form)
## .o object file
## .a library file
## @end group
## @end example
##
## @end table
## @end deftypefn
function [output, status] = mkoctfile (varargin)
bindir = __octave_config_info__ ("bindir");
ext = __octave_config_info__ ("EXEEXT");
shell_script = fullfile (bindir,
"mkoctfile");
if (! exist (shell_script, "file"))
__gripe_missing_component__ ("mkoctfile", "mkoctfile");
endif
cmd = ['"' shell_script '"'];
for i = 1:nargin
cmd = [cmd ' "' varargin{i} '"'];
endfor
[sts, out] = system (cmd);
if (nargout > 0)
[output, status] = deal (strtrim (out), sts);
if (sts != 0)
warning ("mkoctfile: building exited with failure status\n");
endif
else
printf ("%s", out);
if (sts != 0)
error ("mkoctfile: building exited with failure status\n");
endif
endif
endfunction
|
