annotate src/mkgendoc @ 7334:274d9642ac10 release-3-0-0

[project @ 2007-12-22 01:42:45 by jwe]
author jwe
date Sat, 22 Dec 2007 01:42:46 +0000
parents 4270ded9ddc6
children 8c32f95c2639
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
1 #! /bin/sh
7019
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
2 #
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
3 # Copyright (C) 1999, 2000, 2002, 2003, 2005, 2006, 2007 John W. Eaton
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
4 #
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
5 # This file is part of Octave.
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
6 #
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
7 # Octave is free software; you can redistribute it and/or modify it
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
8 # under the terms of the GNU General Public License as published by the
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
9 # Free Software Foundation; either version 3 of the License, or (at
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
10 # your option) any later version.
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
11 #
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
12 # Octave is distributed in the hope that it will be useful, but WITHOUT
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
13 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
14 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
15 # for more details.
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
16 #
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
17 # You should have received a copy of the GNU General Public License
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
18 # along with Octave; see the file COPYING. If not, see
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5796
diff changeset
19 # <http://www.gnu.org/licenses/>.
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
20
4299
02fcb550f20c [project @ 2003-01-16 20:15:14 by jwe]
jwe
parents: 4279
diff changeset
21 SED=${SED:-'sed'}
02fcb550f20c [project @ 2003-01-16 20:15:14 by jwe]
jwe
parents: 4279
diff changeset
22
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
23 if test $# -ne 1; then
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
24 echo "usage: mkgendoc f1" 1>&2
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
25 exit 1
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
26 fi
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
27
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
28 DOC_FILES=`cat $1`
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
29
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
30 if test -z "$DOC_FILES"; then
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
31 echo "mkgendoc: DOC_FILES is empty!" 1>&2
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
32 exit 1
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
33 fi
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
34
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
35 cat << \EOF
3364
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3321
diff changeset
36 // DO NOT EDIT! Generated automatically by mkgendoc
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
37
4279
64c444ac1fee [project @ 2003-01-04 01:10:25 by jwe]
jwe
parents: 4234
diff changeset
38 #if defined (__DECCXX)
64c444ac1fee [project @ 2003-01-04 01:10:25 by jwe]
jwe
parents: 4234
diff changeset
39 #define __USE_STD_IOSTREAM
64c444ac1fee [project @ 2003-01-04 01:10:25 by jwe]
jwe
parents: 4234
diff changeset
40 #endif
64c444ac1fee [project @ 2003-01-04 01:10:25 by jwe]
jwe
parents: 4234
diff changeset
41
3543
c5b996022ef7 [project @ 2000-02-02 20:13:49 by jwe]
jwe
parents: 3364
diff changeset
42 #include <iostream>
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
43 #include <string>
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
44
3364
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3321
diff changeset
45 #define XDEFUN_DLD_INTERNAL(name, args_name, nargout_name, is_text_fcn, doc) \
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3321
diff changeset
46 print_doc_string (#name, doc);
fac05a83b4c5 [project @ 1999-11-20 03:05:42 by jwe]
jwe
parents: 3321
diff changeset
47
5796
20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe]
jwe
parents: 5333
diff changeset
48 #define XDEFUNX_DLD_INTERNAL(name, fname, args_name, nargout_name, \
20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe]
jwe
parents: 5333
diff changeset
49 is_text_fcn, doc) \
20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe]
jwe
parents: 5333
diff changeset
50 print_doc_string (name, doc);
20f4bd627a74 [project @ 2006-05-09 02:04:54 by jwe]
jwe
parents: 5333
diff changeset
51
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
52 #define XDEFUN_INTERNAL(name, args_name, nargout_name, is_text_fcn, doc) \
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
53 print_doc_string (#name, doc);
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
54
4234
90e44267e8cf [project @ 2002-12-21 17:15:25 by jwe]
jwe
parents: 4100
diff changeset
55 #define XDEFCONSTFUN_INTERNAL(name, args_name, nargout_name, \
90e44267e8cf [project @ 2002-12-21 17:15:25 by jwe]
jwe
parents: 4100
diff changeset
56 is_text_fcn, doc) \
90e44267e8cf [project @ 2002-12-21 17:15:25 by jwe]
jwe
parents: 4100
diff changeset
57 print_doc_string (#name, doc);
90e44267e8cf [project @ 2002-12-21 17:15:25 by jwe]
jwe
parents: 4100
diff changeset
58
3746
c82ab37998aa [project @ 2000-11-30 01:11:42 by jwe]
jwe
parents: 3555
diff changeset
59 #define XDEFUNX_INTERNAL(name, fname, args_name, nargout_name, \
c82ab37998aa [project @ 2000-11-30 01:11:42 by jwe]
jwe
parents: 3555
diff changeset
60 is_text_fcn, doc) \
c82ab37998aa [project @ 2000-11-30 01:11:42 by jwe]
jwe
parents: 3555
diff changeset
61 print_doc_string (name, doc);
c82ab37998aa [project @ 2000-11-30 01:11:42 by jwe]
jwe
parents: 3555
diff changeset
62
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
63 #define XDEFALIAS_INTERNAL(alias, name)
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
64
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
65 #define XDEFVAR_INTERNAL(name, sname, defn, protect, chg_fcn, doc) \
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
66 print_doc_string (#name, doc);
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
67
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3295
diff changeset
68 #define XDEFCONST_INTERNAL(name, defn, doc) \
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
69 print_doc_string (#name, doc);
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
70
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
71 #define XDEFUN_MAPPER_INTERNAL(name, ch_map, d_b_map, c_b_map, d_d_map, \
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
72 d_c_map, c_c_map, lo, hi, \
4100
ed0090ecf80f [project @ 2002-10-11 16:37:45 by jwe]
jwe
parents: 3746
diff changeset
73 ch_map_flag, can_ret_cmplx_for_real, doc) \
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
74 print_doc_string (#name, doc);
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
75
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
76 static void
3555
0b00b69ab2fd [project @ 2000-02-03 03:36:13 by jwe]
jwe
parents: 3553
diff changeset
77 print_doc_string (const std::string& name, const std::string& doc)
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
78 {
3553
c5600b44bef9 [project @ 2000-02-03 03:22:37 by jwe]
jwe
parents: 3543
diff changeset
79 std::cout << "";
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3295
diff changeset
80
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3295
diff changeset
81 size_t len = name.length ();
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3295
diff changeset
82
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3295
diff changeset
83 if (name[0] == '"' && name[len-1] == '"')
3553
c5600b44bef9 [project @ 2000-02-03 03:22:37 by jwe]
jwe
parents: 3543
diff changeset
84 std::cout << name.substr (1, len-2);
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3295
diff changeset
85 else
3553
c5600b44bef9 [project @ 2000-02-03 03:22:37 by jwe]
jwe
parents: 3543
diff changeset
86 std::cout << name;
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3295
diff changeset
87
3553
c5600b44bef9 [project @ 2000-02-03 03:22:37 by jwe]
jwe
parents: 3543
diff changeset
88 std::cout << "\n" << doc << "\n";
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
89 }
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
90
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
91 EOF
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
92
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
93 for file in $DOC_FILES; do
4299
02fcb550f20c [project @ 2003-01-16 20:15:14 by jwe]
jwe
parents: 4279
diff changeset
94 fcn=`echo $file | $SED 's,^\./,,; s/\.df//; s/-/_/g'`
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
95 echo "static void"
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
96 echo "print_${fcn}_doc_strings (void)"
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
97 echo "{"
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
98 cat $file
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
99 echo "}"
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
100 echo ""
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
101 done
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
102
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
103 cat << \EOF
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
104
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
105 int
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
106 main (void)
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
107 {
5333
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4299
diff changeset
108 std::cout
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4299
diff changeset
109 << "### DO NOT EDIT!\n"
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4299
diff changeset
110 << "###\n"
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4299
diff changeset
111 << "### This file is generated automatically from the Octave sources.\n"
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4299
diff changeset
112 << "### Edit those files instead and run make to update this file.\n"
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4299
diff changeset
113 << std::endl;
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4299
diff changeset
114
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
115 EOF
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
116
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
117 for file in $DOC_FILES; do
4299
02fcb550f20c [project @ 2003-01-16 20:15:14 by jwe]
jwe
parents: 4279
diff changeset
118 fcn=`echo $file | $SED 's,^\./,,; s/\.df//; s/-/_/g'`
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
119 echo " print_${fcn}_doc_strings ();"
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
120 done
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
121
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
122 cat << \EOF
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
123
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
124 return 0;
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
125 }
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
126 EOF
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
127
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
128 exit 0