add perl_checker.html

author: Pascal Rigaux <pixel@mandriva.com> 2004-04-05 13:52:49 +0000
committer: Pascal Rigaux <pixel@mandriva.com> 2004-04-05 13:52:49 +0000
commit: 6c5f73c85f32a0fa16c39d0a4e70bd54904772c9 (patch)
tree: 46a57e842135a64e5a07212d85f39862e0af3dcf
parent: fa92d91276ed4f4dd64cf1590756df75b9c7ead3 (diff)
download: perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.tar
perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.tar.gz
perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.tar.bz2
perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.tar.xz
perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.zip
4 files changed, 163 insertions, 2 deletions
diff --git a/perl-MDK-Common.spec b/perl-MDK-Common.spec
index 1405494..b5d5271 100644
--- a/perl-MDK-Common.spec
+++ b/perl-MDK-Common.spec
@@ -66,7 +66,7 @@ rm -rf $RPM_BUILD_ROOT
 
 %files devel
 %defattr(-,root,root)
-%doc index.html tutorial.html
+%doc index.html tutorial.html perl_checker.src/perl_checker.html
 %{_bindir}/*
 %{perl_vendorlib}/perl_checker_fake_packages
 
diff --git a/perl_checker.src/.cvsignore b/perl_checker.src/.cvsignore
index 2bd7e98..8c0f1f4 100644
--- a/perl_checker.src/.cvsignore
+++ b/perl_checker.src/.cvsignore
@@ -5,6 +5,7 @@
 *.cmo
 *.cmx
 perl_checker
+perl_checker.html
 perl_checker_debug
 gmon.out
 lexer.ml
diff --git a/perl_checker.src/Makefile b/perl_checker.src/Makefile
index 75a375e..b6d716d 100644
--- a/perl_checker.src/Makefile
+++ b/perl_checker.src/Makefile
@@ -9,7 +9,7 @@ LIBS = unix
 VENDORLIB = $(shell dirname `pwd`)
 DEBUG = 1
 
-default: TAGS build_ml build.ml debug-code native-code
+default: TAGS build_ml build.ml debug-code native-code perl_checker.html
 
 build_ml:
 	rm -f build.ml
@@ -20,6 +20,11 @@ build.ml:
 	echo 'let fake_packages_dir = "'$(VENDORLIB)'/perl_checker_fake_packages"' >> $@
 	echo 'let debugging = $(DEBUG) > 0' >> $@
 
+%.html: %.html.pl
+	rm -f $@
+	perl $< > $@
+	chmod a-w $@
+
 tags: 
 	ocamltags *.ml
 
diff --git a/perl_checker.src/perl_checker.html.pl b/perl_checker.src/perl_checker.html.pl
new file mode 100644
index 0000000..5928f70
--- /dev/null
+++ b/perl_checker.src/perl_checker.html.pl
@@ -0,0 +1,155 @@
+$s = <<'EOF';
+<head><title>perl_checker</title></head>
+<h1>Goals of perl_checker</h1>
+
+<ul>
+<li> for beginners in perl:
+  based on what the programmer is writing,
+ <ul>
+  <li> suggest better or more standard ways to do the same
+  <li> detect wrong code
+  <br>
+  =&gt; a kind of automatic teacher
+ </ul>
+
+<li> for senior programmers:
+  detect typos, unused variables, check number
+  of parameters, global analysis to check method calls...
+
+<li> enforce the same perl style by enforcing a subset of perl of features.
+     In perl <a href="http://c2.com/cgi/wiki?ThereIsMoreThanOneWayToDoIt">There is more than one way to do it</a>. 
+     In perl_checker's subset of Perl, there is not too many ways to do it.
+     This is especially useful for big projects.
+     (NB: the subset is chosen to keep a good expressivity)
+
+</ul>
+
+<h1>Get it</h1>
+
+<a href="http://cvs.mandrakesoft.com/cgi-bin/cvsweb.cgi/soft/perl-MDK-Common/perl_checker.src/">CVS source</a>
+
+<h1>Implemented features</h1>
+
+<dl>
+ <dt>white space normalization
+ <dd>enforce a similar coding style. In many languages you can find a coding
+ style document (eg: <a href="http://www.gnu.org/prep/standards_23.html">the GNU one</a>).
+
+ TESTS=force_layout.t
+
+ </dd>
+ <dt>disallow <i>complex</i> expressions
+ <dd>perl_checker try to ban some weird-not-used-a-lot features.
+
+ TESTS=syntax_restrictions.t
+
+ </dd>
+ <dt>suggest simpler expressions
+ <dd>when there is a simpler way to write an expression, suggest it. It can
+ also help detecting errors.
+
+ TESTS=suggest_better.t
+
+ </dd>
+ <dt>context checks
+ <dd>Perl has types associated with variables names, the so-called "context".
+ Some expressions mixing contexts are stupid, perl_checker detects them.
+
+ TESTS=context.t
+
+ </dd>
+ <dt>function call check
+ <dd>detection of unknown functions or mismatching prototypes (warning: since
+  perl is a dynamic language, some spurious warnings may occur when a function
+  is defined using stashes).
+
+ TESTS=prototype.t
+
+ </dd>
+ <dt>method call check
+ <dd>detection of unknown methods or mismatching prototypes. perl_checker
+ doesn't have any idea what the object type is, it simply checks if a method
+ with that name and that number of parameters exists.
+
+ TESTS=method.t
+
+ </dd>
+ <dt>return value check
+ <dd>dropping the result of a functionnally <i>pure</i> function is stupid.
+ using the result of a function returning void is stupid too.
+
+ TESTS=return_value.t
+
+ </dd>
+ <dt>detect some Perl traps
+ <dd>some Perl expressions are stupid, and one gets a warning when running
+ them with <tt>perl -w</tt>. The drawback are <tt>perl -w</tt> is the lack of
+ code coverage, it only detects expressions which are evaluated.
+
+ TESTS=various_errors.t
+
+</dl>
+
+<h1>Todo</h1>
+
+Functionalities that would be nice:
+<ul>
+ <li> add flow analysis
+ <li> maybe a "soft typing" type analysis
+ <li> detect places where imperative code can be replaced with
+   functional code (already done for some <b>simple</b> loops)
+ <li> check the number of returned values when checking prototype compliance
+</ul>
+EOF
+
+my $_rationale = <<'EOF';
+<h1>Rationale</h1>
+
+Perl is a big language, there is <a
+href="http://c2.com/cgi/wiki?ThereIsMoreThanOneWayToDoIt">ThereIsMoreThanOneWayToDoIt</a>.
+It has advantages but also some drawbacks for team project:
+<ul>
+ <li> it is hard to learn every special rules. Automatically enforced syntax
+ coding rules help learning incrementally
+EOF
+
+use lib 'test';
+use read_t;
+sub get_example {
+    my ($file) = @_;
+    my @tests = read_t::read_t("test/$file");
+    $file =~ s|test/||;
+    qq(<p><a name="$file"><table border=1 cellpadding=3>\n) .
+      join('', map { 
+	  my $lines = join("<br>", map { "<tt>" . html_quote($_) . "</tt>" } @{$_->{lines}});
+	  my $logs = join("<br>", map { html_quote($_) } @{$_->{logs}});
+	  "  <tr><td>\n", $lines, "</td><td>", $logs, "</td></tr>\n";
+      } @tests) .
+      "</table></a>\n";
+}
+
+sub anchor_to_examples {
+    my ($s) = @_;
+    $s =~ s!TESTS=(\S+)!(<a href="#$1">examples</a>)!g;
+    $s;
+}
+sub fill_in_examples {
+    my ($s) = @_;
+    $s =~ s!TESTS=(\S+)!get_example($1)!ge;
+    $s;
+}
+
+$s =~ s!<h1>Implemented features</h1>(.*)<h1>!
+        "<h1>Implemented features</h1>" . anchor_to_examples($1) .
+        "<h1>Examples</h1>" . fill_in_examples($1) .
+        "<h1>"!se;
+
+print $s;
+
+sub html_quote {
+    local $_ = $_[0];
+    s/</&lt;/g;
+    s/>/&gt;/g;
+    s/^(\s*)/"&nbsp;" x length($1)/e;
+    $_;
+}
author	Pascal Rigaux <pixel@mandriva.com>	2004-04-05 13:52:49 +0000
committer	Pascal Rigaux <pixel@mandriva.com>	2004-04-05 13:52:49 +0000
commit	6c5f73c85f32a0fa16c39d0a4e70bd54904772c9 (patch)
tree	46a57e842135a64e5a07212d85f39862e0af3dcf
parent	fa92d91276ed4f4dd64cf1590756df75b9c7ead3 (diff)
download	perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.tar perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.tar.gz perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.tar.bz2 perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.tar.xz perl-MDK-Common-6c5f73c85f32a0fa16c39d0a4e70bd54904772c9.zip