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
|
#! /usr/bin/perl -w
########################################################################
##
## Copyright (C) 2012-2021 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/>.
##
########################################################################
unless (@ARGV > 1) { die "Usage: $0 SRCDIR src-file1 ..." }
$srcdir = shift (@ARGV);
print <<__END_OF_MSG__;
### DO NOT EDIT!
###
### This file is generated automatically from Octave source files.
### Edit source files directly and run make to update this file.
__END_OF_MSG__
FILE: foreach $fname (@ARGV)
{
if (-f "$fname")
{
$src_fname = "$fname";
}
else
{
$src_fname = "$srcdir/$fname";
}
open (SRC_FH, $src_fname) or die "Unable to open $src_fname";
@func_list = ();
@docstr = ();
LINE: while (my $line = <SRC_FH>)
{
if ($line =~ /^\s*DEF(?:CONSTFUN|CONSTMETHOD|METHOD|METHOD_DLD|METHODX|METHODX_DLD|UN|UN_DLD|UNX|UNX_DLD)\s*\(/)
{
($func) = $line =~ /\("?(\w+)"?,/;
unless ($func) { die "Unable to parse $src_fname at line $.\n" }
push (@func_list, $func);
## Skip optional line that declares list of classes that this
## function accepts.
$line = <SRC_FH>;
if ($line =~ m#\s*classes:#)
{
$line = <SRC_FH>;
}
if ($line =~ m#\s*doc:\s+\Q/*\E\s+\Q-*- texinfo -*-\E\s*$#)
{
$str = "-*- texinfo -*-\n";
$reading_docstring = 1;
}
else
{
print STDERR "mk-doc.pl: undocumented function $func from $fname\n";
push (@docstr, "Undocumented.");
}
}
elsif ($reading_docstring)
{
if ($line =~ /^.*\s+\*\/\s*\)\s*$/)
{
$line =~ s#\s+\*/\s*\)\s*$##;
push (@docstr, $str . $line);
$reading_docstring = 0;
}
else
{
$str .= $line;
}
}
}
close (SRC_FH);
## Print results in DOCSTRING format
foreach $i (0 .. $#func_list)
{
$func = $func_list[$i];
print "\x{1d}$func\n";
print "\@c $func $fname\n";
print $docstr[$i],"\n";
}
}
|
