Changeset 14393

Timestamp:

2022-04-11T01:21:22Z (4 months ago)

Author:

marios

Message:

Update todo_search.pl

Cloudy does not follow a single format to TODO's, which causes the
script to work incorrectly.

The script has been updated to handle such variations:

• It handles \todo entries, in addition to TODO.
• It processes entries in C++ comments (starting with ).
• It does not require a priority number to immediately follow the TODO / \todo string.
  • If a dash occurs in lieu of a priority number, it removes it from the comment.
• It accepts any kind of whitespace character after the TODO string, not just tabs.
• It accepts comments in Doxygen docstrings (starting with /) and properly extracts comments from them.
• It does not print the '#'-only separator in the HTML file.

The few files that do not conform to these rules were edited and
committed previously.

File:

• branches/c17_branch/source/todo_search.pl (modified) (2 diffs)

branches/c17_branch/source/todo_search.pl

@@ -49 +49 @@
     
     # If line has TODO
-    if($line =~/TODO/ && $flag == 0){
+    if($line =~/TODO/i && $flag == 0){
       # Retrieving the priority 
       $line_no = $countline;
       $priority = $line;
-      $priority =~s/(.*TODO\t)(\d*)(\t.*)/$2/; 
+      $priority =~s/(.*TODO\s*)(\d*)(\s.*)/$2/i;
       $priority =~s/\n$//;
+
       $comment = $line;
-      $comment =~s/(.*TODO\t$priority\t)(.*)/$2/;
+      if( $priority ne '' )
+      {
+        $comment =~s/(.*TODO\s+$priority)(.*)/$2/i;
+      }
+      else
+      {
+        $comment =~s/(.*TODO\s+)(.*)/$2/i;
+      }
+      $comment =~s/^\s*-\s+//;
       $comment =~s/\*\///;
+      $comment =~s/\/\*\*//;
       $comment =~s/\t*//gi;
       $prev = join '',$prev,$comment;  
       
       # Checks if TODO comments extend more than one line
-      if($line !~/\*\//){
+      if($line !~/\*\// and $line !~ m/\/\// ){
         $flag = 1;
-      }         
+      }
       else{ # Print into output temporary file
         print TEMPFILE "$priority\t$sourcefile\t$line_no\t$prev";
@@ -116 +126 @@
 open(FINAL, "< $finalout");
 while(<FINAL>){
+        next if $_ =~ m/^#+$/;
         $_=~s/\t/\<\/TD\>\<TD\>/g;  #formatting the data into rows and columns
         print FHTM "<TR><TD>$_</TD></TR>"