Mercurial > hg > octave-nkf
annotate scripts/gethelp.cc @ 14363:f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
* wavread.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m,
asec.m, asecd.m, asech.m, asind.m, atand.m, cosd.m, cot.m, cotd.m, coth.m,
csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, accumarray.m,
accumdim.m, bitcmp.m, bitget.m, bitset.m, blkdiag.m, cart2pol.m, cart2sph.m,
celldisp.m, chop.m, circshift.m, colon.m, common_size.m, cplxpair.m,
cumtrapz.m, curl.m, dblquad.m, deal.m, divergence.m, flipdim.m, fliplr.m,
flipud.m, genvarname.m, gradient.m, idivide.m, int2str.m, interp1.m,
interp1q.m, interp2.m, interp3.m, interpft.m, interpn.m, isa.m, isdir.m,
isequal.m, isequalwithequalnans.m, issquare.m, logspace.m, nargchk.m,
narginchk.m, nargoutchk.m, nextpow2.m, nthargout.m, num2str.m, pol2cart.m,
polyarea.m, postpad.m, prepad.m, profile.m, profshow.m, quadgk.m, quadv.m,
randi.m, rat.m, repmat.m, rot90.m, rotdim.m, shift.m, shiftdim.m, sph2cart.m,
structfun.m, trapz.m, triplequad.m, convhull.m, dsearch.m, dsearchn.m,
griddata3.m, griddatan.m, rectint.m, tsearchn.m, __makeinfo__.m, doc.m,
get_first_help_sentence.m, help.m, type.m, unimplemented.m, which.m, imread.m,
imwrite.m, dlmwrite.m, fileread.m, is_valid_file_id.m, strread.m, textread.m,
textscan.m, commutation_matrix.m, cond.m, condest.m, cross.m,
duplication_matrix.m, expm.m, housh.m, isdefinite.m, ishermitian.m,
issymmetric.m, logm.m, normest.m, null.m, onenormest.m, orth.m, planerot.m,
qzhess.m, rank.m, rref.m, trace.m, vech.m, ans.m, bincoeff.m, bug_report.m,
bzip2.m, comma.m, compare_versions.m, computer.m, edit.m, fileparts.m,
fullfile.m, getfield.m, gzip.m, info.m, inputname.m, isappdata.m, isdeployed.m,
ismac.m, ispc.m, isunix.m, list_primes.m, ls.m, mexext.m, namelengthmax.m,
news.m, orderfields.m, paren.m, recycle.m, rmappdata.m, semicolon.m,
setappdata.m, setfield.m, substruct.m, symvar.m, ver.m, version.m,
warning_ids.m, xor.m, fminbnd.m, fsolve.m, fzero.m, lsqnonneg.m, optimset.m,
pqpnonneg.m, sqp.m, matlabroot.m, __gnuplot_drawnow__.m,
__plt_get_axis_arg__.m, ancestor.m, cla.m, clf.m, close.m, colorbar.m,
colstyle.m, comet3.m, contourc.m, figure.m, gca.m, gcbf.m, gcbo.m, gcf.m,
ginput.m, graphics_toolkit.m, gtext.m, hggroup.m, hist.m, hold.m, isfigure.m,
ishghandle.m, ishold.m, isocolors.m, isonormals.m, isosurface.m, isprop.m,
legend.m, line.m, loglog.m, loglogerr.m, meshgrid.m, ndgrid.m, newplot.m,
orient.m, patch.m, plot3.m, plotyy.m, __print_parse_opts__.m, quiver3.m,
refreshdata.m, ribbon.m, semilogx.m, semilogxerr.m, semilogy.m, stem.m,
stem3.m, subplot.m, title.m, uigetfile.m, view.m, whitebg.m, compan.m, conv.m,
deconv.m, mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m,
polyfit.m, polygcd.m, polyint.m, polyout.m, polyval.m, polyvalm.m, ppder.m,
ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, intersect.m,
ismember.m, powerset.m, setdiff.m, setxor.m, union.m, unique.m,
autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m,
fftshift.m, freqz.m, hamming.m, hanning.m, ifftshift.m, sinc.m, sinetone.m,
sinewave.m, unwrap.m, bicg.m, bicgstab.m, gmres.m, gplot.m, nonzeros.m, pcg.m,
pcr.m, spaugment.m, spconvert.m, spdiags.m, speye.m, spfun.m, spones.m,
sprand.m, sprandsym.m, spstats.m, spy.m, svds.m, treelayout.m, bessel.m,
beta.m, betaln.m, factor.m, factorial.m, isprime.m, lcm.m, legendre.m,
nchoosek.m, nthroot.m, perms.m, pow2.m, primes.m, reallog.m, realpow.m,
realsqrt.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, rosser.m,
vander.m, __finish__.m, center.m, cloglog.m, corr.m, cov.m, gls.m, histc.m,
iqr.m, kendall.m, kurtosis.m, logit.m, mahalanobis.m, mean.m, meansq.m,
median.m, mode.m, moment.m, ols.m, ppplot.m, prctile.m, probit.m, quantile.m,
range.m, ranks.m, run_count.m, runlength.m, skewness.m, spearman.m,
statistics.m, std.m, table.m, var.m, zscore.m, betacdf.m, betainv.m, betapdf.m,
betarnd.m, binocdf.m, binoinv.m, binopdf.m, binornd.m, cauchy_cdf.m,
cauchy_inv.m, cauchy_pdf.m, cauchy_rnd.m, chi2cdf.m, chi2inv.m, chi2pdf.m,
chi2rnd.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, discrete_rnd.m,
empirical_cdf.m, empirical_inv.m, empirical_pdf.m, empirical_rnd.m, expcdf.m,
expinv.m, exppdf.m, exprnd.m, fcdf.m, finv.m, fpdf.m, frnd.m, gamcdf.m,
gaminv.m, gampdf.m, gamrnd.m, geocdf.m, geoinv.m, geopdf.m, geornd.m,
hygecdf.m, hygeinv.m, hygepdf.m, hygernd.m, kolmogorov_smirnov_cdf.m,
laplace_cdf.m, laplace_inv.m, laplace_pdf.m, laplace_rnd.m, logistic_cdf.m,
logistic_inv.m, logistic_pdf.m, logistic_rnd.m, logncdf.m, logninv.m,
lognpdf.m, lognrnd.m, nbincdf.m, nbininv.m, nbinpdf.m, nbinrnd.m, normcdf.m,
norminv.m, normpdf.m, normrnd.m, poisscdf.m, poissinv.m, poisspdf.m,
poissrnd.m, stdnormal_cdf.m, stdnormal_inv.m, stdnormal_pdf.m, stdnormal_rnd.m,
tcdf.m, tinv.m, tpdf.m, trnd.m, unidcdf.m, unidinv.m, unidpdf.m, unidrnd.m,
unifcdf.m, unifinv.m, unifpdf.m, unifrnd.m, wblcdf.m, wblinv.m, wblpdf.m,
wblrnd.m, kolmogorov_smirnov_test.m, kruskal_wallis_test.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
findstr.m, hex2dec.m, index.m, isletter.m, mat2str.m, rindex.m, str2num.m,
strcat.m, strjust.m, strmatch.m, strsplit.m, strtok.m, strtrim.m, strtrunc.m,
substr.m, validatestring.m, demo.m, example.m, fail.m, speed.m, addtodate.m,
asctime.m, clock.m, ctime.m, date.m, datenum.m, datetick.m, datevec.m,
eomday.m, etime.m, is_leap_year.m, now.m:
Use Octave coding conventions in all m-file %!test blocks
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 13 Feb 2012 07:29:44 -0800 |
parents | 72c96de7a403 |
children |
rev | line source |
---|---|
7016 | 1 /* |
2 | |
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14065
diff
changeset
|
3 Copyright (C) 1999-2012 John W. Eaton |
7016 | 4 |
5 This file is part of Octave. | |
6 | |
7 Octave is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
9 Free Software Foundation; either version 3 of the License, or (at your | |
10 option) any later version. | |
11 | |
12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
18 along with Octave; see the file COPYING. If not, see | |
19 <http://www.gnu.org/licenses/>. | |
20 | |
21 */ | |
22 | |
8521 | 23 #include <cstdio> |
24 | |
25 #include <iostream> | |
3295 | 26 #include <string> |
27 | |
28 static bool | |
3575 | 29 looks_like_octave_copyright (const std::string& s) |
3295 | 30 { |
6528 | 31 // Perhaps someday we will want to do more here, so leave this as a |
32 // separate function. | |
3295 | 33 |
14065
3709aaf73715
gethelp.cc: also identify blocks starting with Author as license text
Carnë Draug <carandraug+dev@gmail.com>
parents:
12174
diff
changeset
|
34 return (s.substr (0, 9) == "Copyright" || s.substr (0, 6) == "Author"); |
3295 | 35 } |
36 | |
37 // Eat whitespace and comments from FFILE, returning the text of the | |
38 // first block of comments that doesn't look like a copyright notice, | |
39 | |
3575 | 40 static std::string |
3295 | 41 extract_help_text (void) |
42 { | |
3575 | 43 std::string help_txt; |
3295 | 44 |
45 bool first_comments_seen = false; | |
46 bool begin_comment = false; | |
47 bool have_help_text = false; | |
48 bool in_comment = false; | |
3427 | 49 bool discard_space = true; |
3295 | 50 int c; |
51 | |
3575 | 52 while ((c = std::cin.get ()) != EOF) |
3295 | 53 { |
54 if (begin_comment) | |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
55 { |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
56 if (c == '%' || c == '#') |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
57 continue; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
58 else if (discard_space && c == ' ') |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
59 { |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
60 discard_space = false; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
61 continue; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
62 } |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
63 else |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
64 begin_comment = false; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
65 } |
3295 | 66 |
67 if (in_comment) | |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
68 { |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
69 if (! have_help_text) |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
70 { |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
71 first_comments_seen = true; |
10553 | 72 help_txt += static_cast<char> (c); |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
73 } |
3295 | 74 |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
75 if (c == '\n') |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
76 { |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
77 in_comment = false; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
78 discard_space = true; |
3295 | 79 |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
80 if ((c = std::cin.get ()) != EOF) |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
81 { |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
82 if (c == '\n') |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
83 break; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
84 } |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
85 else |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
86 break; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
87 } |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
88 } |
3295 | 89 else |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
90 { |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
91 switch (c) |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
92 { |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
93 case ' ': |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
94 case '\t': |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
95 if (first_comments_seen) |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
96 have_help_text = true; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
97 break; |
3295 | 98 |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
99 case '\n': |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
100 if (first_comments_seen) |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
101 have_help_text = true; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
102 continue; |
3295 | 103 |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
104 case '%': |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
105 case '#': |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
106 begin_comment = true; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
107 in_comment = true; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
108 break; |
3295 | 109 |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
110 default: |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
111 goto done; |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
112 } |
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
113 } |
3295 | 114 } |
115 | |
116 done: | |
117 | |
118 if (! help_txt.empty ()) | |
119 { | |
12174 | 120 if (looks_like_octave_copyright (help_txt)) |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
121 help_txt.resize (0); |
3295 | 122 |
123 if (help_txt.empty ()) | |
10163
a822560a3ce3
scripts/gethelp.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9014
diff
changeset
|
124 help_txt = extract_help_text (); |
3295 | 125 } |
126 | |
127 return help_txt; | |
128 } | |
129 | |
130 int | |
131 main (int argc, char **argv) | |
132 { | |
3575 | 133 std::string name; |
9014
71fca0fc2436
save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
134 std::string file_name; |
3295 | 135 |
9014
71fca0fc2436
save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
136 if (argc != 3) |
3295 | 137 { |
9014
71fca0fc2436
save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
138 std::cerr << "usage: gethelp name file-name\n"; |
3295 | 139 return 1; |
140 } | |
141 else | |
9014
71fca0fc2436
save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
142 { |
71fca0fc2436
save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
143 name = argv[1]; |
71fca0fc2436
save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
144 file_name = argv[2]; |
71fca0fc2436
save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
145 } |
3295 | 146 |
12174 | 147 std::string help_text = extract_help_text (); |
3295 | 148 |
149 if (! help_text.empty ()) | |
150 { | |
9014
71fca0fc2436
save source file names for functions as comments in .texi files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
151 std::cout << "" << name << "\n" |
11550
a9be431c1595
write function name along with filename in docstring comments
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
152 << "@c " << name << " " << file_name << "\n" |
10165
bc59bc6282a0
scripts/gethelp.cc: finish previous untabification
John W. Eaton <jwe@octave.org>
parents:
10163
diff
changeset
|
153 << help_text; |
3295 | 154 |
155 if (help_text[help_text.length () - 1] != '\n') | |
10165
bc59bc6282a0
scripts/gethelp.cc: finish previous untabification
John W. Eaton <jwe@octave.org>
parents:
10163
diff
changeset
|
156 std::cout << "\n"; |
3295 | 157 } |
158 | |
159 return 0; | |
160 } |