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
|
#! /usr/bin/perl -w
#
# Copyright (C) 2012-2013 Rik Wehbring
#
# 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
# <http://www.gnu.org/licenses/>.
## Expecting arguments in this order:
##
## SRCDIR SRCDIR-FILES ... -- LOCAL-FILES ...
unless (@ARGV >= 2) { die "Usage: $0 srcdir m_filename1 ..." ; }
$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__
MFILE: foreach $m_fname (@ARGV)
{
if ($m_fname eq "--")
{
$srcdir = "./";
next MFILE;
}
$full_fname = $srcdir . $m_fname;
next MFILE unless ( $full_fname =~ m{(.*)/(@|)([^/]*)/(.*)\.m} );
if ($2)
{ $fcn = "$2$3/$4"; }
else
{ $fcn = $4; }
@help_txt = gethelp ($fcn, $full_fname);
next MFILE if ($help_txt[0] eq "");
print "\x{1d}$fcn\n";
print "\@c $fcn scripts/$m_fname\n";
foreach $_ (@help_txt)
{
s/^\s+\@/\@/ unless $in_example;
s/^\s+\@group/\@group/;
s/^\s+\@end\s+group/\@end group/;
$in_example = (/\s*\@example\b/ .. /\s*\@end\s+example\b/);
print $_;
}
}
################################################################################
# Subroutines
################################################################################
sub gethelp
{
($fcn, $fname) = @_[0..1];
open (FH, $fname) or return "";
do
{
@help_txt = ();
## Advance to non-blank line
while (defined ($_ = <FH>) and /^\s*$/) {;}
if (! /^\s*(?:#|%)/ or eof (FH))
{
## No comment block found. Return empty string
close (FH);
return "";
}
## Extract help text stopping when comment block ends
do
{
## Remove comment characters at start of line
s/^\s*(?:#|%){1,2} ?//;
push (@help_txt, $_);
} until (! defined ($_ = <FH>) or ! /^\s*(?:#|%)/);
} until ($help_txt[0] !~ /^(?:Copyright|Author)/);
close (FH);
return @help_txt;
}
|