r2181 - list unused predicates in the RackCode report

diff --git a/ChangeLog b/ChangeLog
index d9862fc0abe677d89d5a3bf96fbb9c0bf686a793..e96fd9e95480e7ea7c5dd877a3a57f85d4437f55 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -3,6 +3,7 @@
        new feature: CodePress editor enables line numbers and syntax
                highlightling for RackCode editing
        new feature: one more input format for RS manager
+       new feature: standalone RackCode report with warnings
        bugfix: tags are now properly displayed for users
        bugfix: the JavaScript error isn't generated any more (fix by Aaron)
        bugfix: tag tree is now always correctly sorted

diff --git a/inc/code.php b/inc/code.php
index a07cc5a4e59b055f4702676edb9b21fa40b1c5c2..5748519e53cd727dab7efa23d2a5cfdde2defb20 100644 (file)
--- a/inc/code.php
+++ b/inc/code.php
@@ -708,6 +708,33 @@ function getRackCodeWarnings ()
                                        'text' => "Skipped sentence of unknown type '${sentence['type']}'"
                                );
                }
+       // predicates
+       $plist = array();
+       foreach ($rackCode as $sentence)
+               if ($sentence['type'] == 'SYNT_DEFINITION')
+                       $plist[$sentence['term']] = $sentence['lineno'];
+       foreach ($plist as $pname => $lineno)
+       {
+               foreach ($rackCode as $sentence)
+                       switch ($sentence['type'])
+                       {
+                               case 'SYNT_DEFINITION':
+                                       if (referencedPredicate ($pname, $sentence['definition']))
+                                               continue 3; // clear, next term
+                                       break;
+                               case 'SYNT_GRANT':
+                                       if (referencedPredicate ($pname, $sentence['condition']))
+                                               continue 3; // idem
+                                       break;
+                       }
+               $ret[] = array
+               (
+                       'header' => 'line ' . $lineno,
+                       'class' => 'warning',
+                       'text' => "Predicate '${pname}' is defined, but never used."
+               );
+       }
+       // bail out
        $nwarnings = count ($ret);
        $ret[] = array
        (
@@ -718,6 +745,7 @@ function getRackCodeWarnings ()
        return $ret;
 }
 
+// Scan the given expression and return any issues found about its autotags.
 function findAutoTagWarnings ($expr)
 {
        switch ($expr['type'])
@@ -734,9 +762,9 @@ function findAutoTagWarnings ($expr)
                                                return array();
                                        return array (array
                                        (
-                                               'header' => 'Line ' . $expr['lineno'],
+                                               'header' => 'line ' . $expr['lineno'],
                                                'class' => 'warning',
-                                               'text' => "An object with ID '${recid}' does not exist"
+                                               'text' => "An object with ID '${recid}' does not exist."
                                        ));
                                case (mb_ereg_match ('^\$ipv4netid_', $expr['load'])):
                                        $recid = mb_ereg_replace ('^\$ipv4netid_', '', $expr['load']);
@@ -744,7 +772,7 @@ function findAutoTagWarnings ($expr)
                                                return array();
                                        return array (array
                                        (
-                                               'header' => 'Line ' . $expr['lineno'],
+                                               'header' => 'line ' . $expr['lineno'],
                                                'class' => 'warning',
                                                'text' => "IPv4 network with ID '${recid}' does not exist"
                                        ));
@@ -769,4 +797,23 @@ function findAutoTagWarnings ($expr)
        }
 }
 
+// Return true, if the expression makes use of the predicate given.
+function referencedPredicate ($pname, $expr)
+{
+       switch ($expr['type'])
+       {
+               case 'LEX_BOOLCONST':
+               case 'LEX_TAG':
+                       return FALSE;
+               case 'LEX_PREDICATE':
+                       return $pname == $expr['load'];
+               case 'SYNT_NOTEXPR':
+                       return referencedPredicate ($pname, $expr['load']);
+               case 'SYNT_BOOLOP':
+                       return referencedPredicate ($pname, $expr['left']) or referencedPredicate ($pname, $expr['right']);
+               default: // This is actually an internal error.
+                       return FALSE;
+       }
+}
+
 ?>