|
5671
|
1 ## Copyright (C) 2006 Keith Goodman |
|
|
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 |
|
|
7 ## the Free Software Foundation; either version 2, or (at your option) |
|
|
8 ## any later version. |
|
|
9 ## |
|
|
10 ## Octave is distributed in the hope that it will be useful, but |
|
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
|
13 ## General Public License for more details. |
|
|
14 ## |
|
|
15 ## You should have received a copy of the GNU General Public License |
|
|
16 ## along with Octave; see the file COPYING. If not, write to the Free |
|
|
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
|
|
18 ## 02110-1301, USA. |
|
|
19 |
|
|
20 ## -*- texinfo -*- |
|
6547
|
21 ## @deftypefn {Function File} {} mkoctfile [-options] file @dots{} |
|
5695
|
22 ## |
|
|
23 ## The @code{mkoctfile} function compiles source code written in C, |
|
|
24 ## C++, or Fortran. Depending on the options used with @code{mkoctfile}, the |
|
|
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 |
|
|
29 ## prompt. |
|
|
30 ## |
|
|
31 ## @code{mkoctfile} accepts the following options, all of which are optional |
|
|
32 ## except for the file name of the code you wish to compile: |
|
|
33 ## |
|
|
34 ## @table @samp |
|
|
35 ## @item -I DIR |
|
|
36 ## Add the include directory DIR to compile commands. |
|
|
37 ## |
|
|
38 ## @item -D DEF |
|
|
39 ## Add the definition DEF to the compiler call. |
|
|
40 ## |
|
|
41 ## @item -l LIB |
|
|
42 ## Add the library LIB to the link command. |
|
|
43 ## |
|
|
44 ## @item -L DIR |
|
|
45 ## Add the library directory DIR to the link command. |
|
|
46 ## |
|
6573
|
47 ## @item -M |
|
|
48 ## @itemx --depend |
|
5695
|
49 ## Generate dependency files (.d) for C and C++ source files. |
|
|
50 ## |
|
|
51 ## @item -c |
|
|
52 ## Compile but do not link. |
|
|
53 ## |
|
5904
|
54 ## @item -g |
|
|
55 ## Enable debugging options for compilers. |
|
|
56 ## |
|
6573
|
57 ## @item -o FILE |
|
|
58 ## @itemx --output FILE |
|
5904
|
59 ## Output file name. Default extension is .oct |
|
|
60 ## (or .mex if --mex is specified) unless linking |
|
|
61 ## a stand-alone executable. |
|
5695
|
62 ## |
|
6573
|
63 ## @item -p VAR |
|
|
64 ## @itemx --print VAR |
|
5695
|
65 ## Print the configuration variable VAR. Recognized variables are: |
|
5671
|
66 ## |
|
5695
|
67 ## @example |
|
|
68 ## ALL_CFLAGS FFTW_LIBS |
|
|
69 ## ALL_CXXFLAGS FLIBS |
|
|
70 ## ALL_FFLAGS FPICFLAG |
|
|
71 ## ALL_LDFLAGS INCFLAGS |
|
|
72 ## BLAS_LIBS LDFLAGS |
|
|
73 ## CC LD_CXX |
|
|
74 ## CFLAGS LD_STATIC_FLAG |
|
|
75 ## CPICFLAG LFLAGS |
|
|
76 ## CPPFLAGS LIBCRUFT |
|
|
77 ## CXX LIBOCTAVE |
|
|
78 ## CXXFLAGS LIBOCTINTERP |
|
|
79 ## CXXPICFLAG LIBREADLINE |
|
|
80 ## DEPEND_EXTRA_SED_PATTERN LIBS |
|
|
81 ## DEPEND_FLAGS OCTAVE_LIBS |
|
|
82 ## DL_LD RDYNAMIC_FLAG |
|
|
83 ## DL_LDFLAGS RLD_FLAG |
|
|
84 ## F2C SED |
|
|
85 ## F2CFLAGS XTRA_CFLAGS |
|
|
86 ## F77 XTRA_CXXFLAGS |
|
|
87 ## FFLAGS |
|
|
88 ## @end example |
|
5671
|
89 ## |
|
5745
|
90 ## @item --link-stand-alone |
|
|
91 ## Link a stand-alone executable file. |
|
|
92 ## |
|
5904
|
93 ## @item --mex |
|
|
94 ## Assume we are creating a MEX file. Set the default output extension |
|
|
95 ## to ".mex". |
|
|
96 ## |
|
6573
|
97 ## @item -s |
|
|
98 ## @itemx --strip |
|
5695
|
99 ## Strip the output file. |
|
|
100 ## |
|
6573
|
101 ## @item -v |
|
|
102 ## @itemx --verbose |
|
5695
|
103 ## Echo commands as they are executed. |
|
|
104 ## |
|
|
105 ## @item file |
|
|
106 ## The file to compile or link. Recognised file types are |
|
|
107 ## |
|
|
108 ## @example |
|
|
109 ## .c C source |
|
|
110 ## .cc C++ source |
|
|
111 ## .C C++ source |
|
|
112 ## .cpp C++ source |
|
|
113 ## .f Fortran source |
|
|
114 ## .F Fortran source |
|
|
115 ## .o object file |
|
|
116 ## @end example |
|
|
117 ## |
|
|
118 ## @end table |
|
5671
|
119 ## @end deftypefn |
|
|
120 |
|
5695
|
121 ## PKG_ADD: mark_as_command mkoctfile |
|
|
122 |
|
|
123 function mkoctfile (varargin) |
|
5671
|
124 |
|
5696
|
125 bindir = octave_config_info ("bindir"); |
|
|
126 |
|
|
127 shell_script = fullfile (bindir, sprintf ("mkoctfile-%s", OCTAVE_VERSION)); |
|
|
128 |
|
|
129 cmd = shell_script; |
|
5695
|
130 for i = 1:nargin |
|
5696
|
131 cmd = strcat (cmd, " ", varargin{i}); |
|
5695
|
132 endfor |
|
|
133 |
|
|
134 status = system (cmd); |
|
|
135 |
|
|
136 if (status == 127) |
|
5696
|
137 warning ("unable to find mkoctfile in expected location: `%s'", |
|
|
138 shell_script); |
|
5695
|
139 elseif (status != 0) |
|
|
140 warning ("mkoctfile exited with failure status"); |
|
|
141 endif |
|
5671
|
142 |
|
|
143 endfunction |
