Mercurial > octave
annotate scripts/miscellaneous/mkoctfile.m @ 23084:ef4d915df748
maint: Merge stable to default.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 23 Jan 2017 14:27:48 -0500 |
parents | 3a2b891d0b33 e9a0469dedd9 |
children | 092078913d54 |
rev | line source |
---|---|
22323
bac0d6f07a3e
maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents:
21634
diff
changeset
|
1 ## Copyright (C) 2006-2016 Keith Goodman |
5671 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22463
diff
changeset
|
7 ## the Free Software Foundation; either version 3 of the License, or |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22463
diff
changeset
|
8 ## (at your option) any later version. |
5671 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22463
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22463
diff
changeset
|
13 ## GNU General Public License for more details. |
5671 | 14 ## |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
5671 | 18 |
19 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20727
diff
changeset
|
20 ## @deftypefn {} {} mkoctfile [-options] file @dots{} |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20727
diff
changeset
|
21 ## @deftypefnx {} {[@var{output}, @var{status}] =} mkoctfile (@dots{}) |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
22 ## |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
23 ## The @code{mkoctfile} function compiles source code written in C, C++, or |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
24 ## Fortran. Depending on the options used with @code{mkoctfile}, the |
5695 | 25 ## compiled code can be called within Octave or can be used as a stand-alone |
26 ## application. | |
27 ## | |
28 ## @code{mkoctfile} can be called from the shell prompt or from the Octave | |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
29 ## prompt. Calling it from the Octave prompt simply delegates the call to |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
30 ## the shell prompt. The output is stored in the @var{output} variable and |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
31 ## the exit status in the @var{status} variable. |
5695 | 32 ## |
33 ## @code{mkoctfile} accepts the following options, all of which are optional | |
20713
2469d78a1d8b
Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents:
20164
diff
changeset
|
34 ## except for the filename of the code you wish to compile: |
5695 | 35 ## |
36 ## @table @samp | |
37 ## @item -I DIR | |
38 ## Add the include directory DIR to compile commands. | |
39 ## | |
40 ## @item -D DEF | |
41 ## Add the definition DEF to the compiler call. | |
42 ## | |
43 ## @item -l LIB | |
44 ## Add the library LIB to the link command. | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
45 ## |
5695 | 46 ## @item -L DIR |
47 ## Add the library directory DIR to the link command. | |
48 ## | |
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
16994
diff
changeset
|
49 ## @item -M |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
50 ## @itemx --depend |
5695 | 51 ## Generate dependency files (.d) for C and C++ source files. |
10996
72640afb02b9
mkoctfile.m: Change help text to be consistent with the shell version.
Ben Abbott <bpabbott@mac.com>
parents:
10793
diff
changeset
|
52 ## |
72640afb02b9
mkoctfile.m: Change help text to be consistent with the shell version.
Ben Abbott <bpabbott@mac.com>
parents:
10793
diff
changeset
|
53 ## @item -R DIR |
11575
d6619410e79c
Spellcheck documentation before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11563
diff
changeset
|
54 ## Add the run-time path to the link command. |
10996
72640afb02b9
mkoctfile.m: Change help text to be consistent with the shell version.
Ben Abbott <bpabbott@mac.com>
parents:
10793
diff
changeset
|
55 ## |
16826
a4969508008e
doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents:
15467
diff
changeset
|
56 ## @item @nospell{-Wl,@dots{}} |
a4969508008e
doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents:
15467
diff
changeset
|
57 ## Pass flags though the linker like @nospell{"-Wl,-rpath=@dots{}"}. |
10996
72640afb02b9
mkoctfile.m: Change help text to be consistent with the shell version.
Ben Abbott <bpabbott@mac.com>
parents:
10793
diff
changeset
|
58 ## The quotes are needed since commas are interpreted as command |
72640afb02b9
mkoctfile.m: Change help text to be consistent with the shell version.
Ben Abbott <bpabbott@mac.com>
parents:
10793
diff
changeset
|
59 ## separators. |
72640afb02b9
mkoctfile.m: Change help text to be consistent with the shell version.
Ben Abbott <bpabbott@mac.com>
parents:
10793
diff
changeset
|
60 ## |
12753
00fbb05f099c
Backout 2c54fde0f397 on stable; broke Octave-Forge packages
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
12662
diff
changeset
|
61 ## @item -W@dots{} |
16826
a4969508008e
doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents:
15467
diff
changeset
|
62 ## Pass flags though the compiler like @nospell{"-Wa,OPTION"}. |
10996
72640afb02b9
mkoctfile.m: Change help text to be consistent with the shell version.
Ben Abbott <bpabbott@mac.com>
parents:
10793
diff
changeset
|
63 ## |
5695 | 64 ## @item -c |
65 ## Compile but do not link. | |
66 ## | |
5904 | 67 ## @item -g |
68 ## Enable debugging options for compilers. | |
69 ## | |
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
16994
diff
changeset
|
70 ## @item -o FILE |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
71 ## @itemx --output FILE |
20713
2469d78a1d8b
Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents:
20164
diff
changeset
|
72 ## Output filename. Default extension is .oct (or .mex if @samp{--mex} is |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
73 ## specified) unless linking a stand-alone executable. |
5695 | 74 ## |
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
16994
diff
changeset
|
75 ## @item -p VAR |
6573 | 76 ## @itemx --print VAR |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
77 ## Print the configuration variable VAR@. Recognized variables are: |
5671 | 78 ## |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
79 ## @example |
18359
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
80 ## ALL_CFLAGS INCFLAGS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
81 ## ALL_CXXFLAGS INCLUDEDIR |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
82 ## ALL_FFLAGS LAPACK_LIBS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
83 ## ALL_LDFLAGS LD_CXX |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
84 ## AR LDFLAGS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
85 ## BLAS_LIBS LD_STATIC_FLAG |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
86 ## CC LFLAGS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
87 ## CFLAGS LIBDIR |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
88 ## CPICFLAG LIBOCTAVE |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
89 ## CPPFLAGS LIBOCTINTERP |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
90 ## CXX LIBS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
91 ## CXXFLAGS OCTAVE_HOME |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
92 ## CXXPICFLAG OCTAVE_LIBS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
93 ## DEPEND_EXTRA_SED_PATTERN OCTAVE_LINK_DEPS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
94 ## DEPEND_FLAGS OCTAVE_LINK_OPTS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
95 ## DL_LD OCTAVE_PREFIX |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
96 ## DL_LDFLAGS OCTINCLUDEDIR |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
97 ## F77 OCTLIBDIR |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
98 ## F77_INTEGER8_FLAG OCT_LINK_DEPS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
99 ## FFLAGS OCT_LINK_OPTS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
100 ## FFTW3F_LDFLAGS RANLIB |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
101 ## FFTW3F_LIBS RDYNAMIC_FLAG |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
102 ## FFTW3_LDFLAGS READLINE_LIBS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
103 ## FFTW3_LIBS SED |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
104 ## FFTW_LIBS SPECIAL_MATH_LIB |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
105 ## FLIBS XTRA_CFLAGS |
d9f706dd78df
make mkoctfile.m list of variables consistent with mkoctfile.cc (bug #41296)
John W. Eaton <jwe@octave.org>
parents:
18356
diff
changeset
|
106 ## FPICFLAG XTRA_CXXFLAGS |
5695 | 107 ## @end example |
5671 | 108 ## |
5745 | 109 ## @item --link-stand-alone |
110 ## Link a stand-alone executable file. | |
111 ## | |
5904 | 112 ## @item --mex |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
113 ## Assume we are creating a MEX file. Set the default output extension to |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
114 ## ".mex". |
5904 | 115 ## |
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
16994
diff
changeset
|
116 ## @item -s |
6573 | 117 ## @itemx --strip |
5695 | 118 ## Strip the output file. |
119 ## | |
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
16994
diff
changeset
|
120 ## @item -v |
6573 | 121 ## @itemx --verbose |
5695 | 122 ## Echo commands as they are executed. |
123 ## | |
124 ## @item file | |
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9051
diff
changeset
|
125 ## The file to compile or link. Recognized file types are |
5695 | 126 ## |
127 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
128 ## @group |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
129 ## .c C source |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
130 ## .cc C++ source |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
131 ## .C C++ source |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
132 ## .cpp C++ source |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
133 ## .f Fortran source (fixed form) |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
134 ## .F Fortran source (fixed form) |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
135 ## .f90 Fortran source (free form) |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
136 ## .F90 Fortran source (free form) |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
137 ## .o object file |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
138 ## .a library file |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
139 ## @end group |
5695 | 140 ## @end example |
141 ## | |
142 ## @end table | |
5671 | 143 ## @end deftypefn |
144 | |
14121
6a59b271cd91
mkoctfile.m: Return the output and exit status from the mkoctfile shell command
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13025
diff
changeset
|
145 function [output, status] = mkoctfile (varargin) |
5671 | 146 |
21434
1da428cbf401
deprecate octave_config_info
John W. Eaton <jwe@octave.org>
parents:
20852
diff
changeset
|
147 bindir = __octave_config_info__ ("bindir"); |
1da428cbf401
deprecate octave_config_info
John W. Eaton <jwe@octave.org>
parents:
20852
diff
changeset
|
148 ext = __octave_config_info__ ("EXEEXT"); |
5696 | 149 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
150 shell_script = fullfile (bindir, |
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
151 sprintf ("mkoctfile-%s%s", OCTAVE_VERSION, ext)); |
5696 | 152 |
17516
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17338
diff
changeset
|
153 if (! exist (shell_script, "file")) |
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17338
diff
changeset
|
154 __gripe_missing_component__ ("mkoctfile", "mkoctfile"); |
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17338
diff
changeset
|
155 endif |
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17338
diff
changeset
|
156 |
16994
333243133364
Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents:
16826
diff
changeset
|
157 cmd = ['"' shell_script '"']; |
5695 | 158 for i = 1:nargin |
16994
333243133364
Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents:
16826
diff
changeset
|
159 cmd = [cmd ' "' varargin{i} '"']; |
5695 | 160 endfor |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11575
diff
changeset
|
161 |
14121
6a59b271cd91
mkoctfile.m: Return the output and exit status from the mkoctfile shell command
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13025
diff
changeset
|
162 [sys, out] = system (cmd); |
5695 | 163 |
14121
6a59b271cd91
mkoctfile.m: Return the output and exit status from the mkoctfile shell command
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13025
diff
changeset
|
164 if (nargout > 0) |
6a59b271cd91
mkoctfile.m: Return the output and exit status from the mkoctfile shell command
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13025
diff
changeset
|
165 [output, status] = deal (out, sys); |
6a59b271cd91
mkoctfile.m: Return the output and exit status from the mkoctfile shell command
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13025
diff
changeset
|
166 else |
21634
96518f623c91
Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents:
21633
diff
changeset
|
167 printf ("%s", out); |
14121
6a59b271cd91
mkoctfile.m: Return the output and exit status from the mkoctfile shell command
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13025
diff
changeset
|
168 endif |
6a59b271cd91
mkoctfile.m: Return the output and exit status from the mkoctfile shell command
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
13025
diff
changeset
|
169 |
17516
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17338
diff
changeset
|
170 if (sys != 0) |
22463
913e812ef11d
mkoctfile.m: Suppress Octave side of backtrace if external compilation failed.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
171 warning ("mkoctfile: building exited with failure status\n"); |
5695 | 172 endif |
5671 | 173 |
174 endfunction |