X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f95d18a77d4a399455342cef52cdfe13d167acce..22f6838423728e184fd2e2cc5418aa0695a9630e:/tools/doxygen/xbt_log_extract_hierarchy.pl

diff --git a/tools/doxygen/xbt_log_extract_hierarchy.pl b/tools/doxygen/xbt_log_extract_hierarchy.pl
index 7eabb2472b..e7818e7343 100755
--- a/tools/doxygen/xbt_log_extract_hierarchy.pl
+++ b/tools/doxygen/xbt_log_extract_hierarchy.pl
@@ -1,22 +1,55 @@
-#! /usr/bin/perl
+#!/usr/bin/env perl
+
+# Copyright (c) 2008, 2010, 2012-2018. The SimGrid Team.
+# All rights reserved.
+
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the license (GNU LGPL) which comes with this package.
 
 use strict;
 use warnings;
 
 my $debug = 0;
 
+print "/* Generated file, do not edit */\n";
+print "/** \\addtogroup XBT_log_cats\n";
+print "        \@{\n";
 
 # Search for calls to macros defining new channels, and prepare the tree representation
 my %ancestor;
 my %desc;
-# $ancestor{"toto"} is the ancestor of the toto channel
+# $ancestor{"toto"} is the ancestor of the toto channel as declared by XBT_LOG_NEW_SUBCATEGORY and 
+# XBT_LOG_NEW_DEFAULT_SUBCATEGORY ie, when the channel toto is initialized (does not work under windows)
+
 # $desc{"toto"} is its description
 
+sub cleanup_ctn {
+    my $ctn = shift;        # cleanup the content of a macro call
+    $ctn =~ s/^\s*(.*)\s*$/$1/gs;
+    my @elms;
+    print "ctn=$ctn\n" if $debug > 1;
+    if ($ctn =~ m/^(\w+)\s*,\s*(\w+)\s*,\s*"?([^"]*)"?$/s) {
+	# Perfect, we got 0->name; 1->anc; 2->desc
+	$elms[0] = $1;
+	$elms[1] = $2;
+	$elms[2] = $3;
+    } elsif ($ctn =~ m/^(\w+)\s*,\s*"?([^"]*)"?$/s) {
+	# Mmm. got no ancestor. Add the default one.
+	$elms[0] = $1;
+	$elms[1] = "XBT_LOG_ROOT_CAT";
+	$elms[2] = $2;
+    } else {
+	die "Unparsable content: $ctn\n";
+    }
+    $elms[2] =~ s/\\\\/\\/gs;
+    return @elms;
+}
+
 sub parse_file {
     my $filename = shift;
-    
+
     my $data = "";
-    
+
     print "Parse $filename\n" if $debug;
     open IN, "$filename" || die "Cannot read $filename: $!\n";
     while (<IN>) {
@@ -24,78 +57,37 @@ sub parse_file {
     }
     close IN;
 
-    # Purge $data from C comments
+    # Purge $data from C and C++ comments
     $data =~ s|/\*.*?\*/||sg;
-
-    # C++ comments are forbiden in SG for portability reasons, but deal with it anyway
     $data =~ s|//.*$||mg;
 
     while ($data =~ s/^.*?XBT_LOG_NEW(_DEFAULT)?_(SUB)?CATEGORY\(//s) {
-	$data =~ s/([^"]*"[^"]*")\)//s || die "unparsable macro: $data"; # ]]);
-	my $ctn = $1;
+	$data =~ s/([^"]*"[^"]*")\)//s || die "unparsable macro: $data";
+
+        my ($name,$anc,$desc) = cleanup_ctn($1);
     
-        # cleanup the content											 
-	$ctn =~ s/ *\n//gs;										 
-        $ctn =~ s/,\s*"/,"/gs;
-        $ctn =~ s/"\s*$/"/gs;
-        $ctn =~ s/,\s*/,/gs;
-        my @elms_tmp=split (/,/,$ctn); 
-        my @elms;
-        print "ctn=$ctn\n" if $debug > 1;
-        # There may be some ',' in the description. Remerge the stuff like: "description, really"
-        while (1) {
-	    my $acc = shift @elms_tmp;
-	    last unless defined $acc;
-  	    if ($acc =~ /^"/) { # ") {
-	        while (shift @elms_tmp) { 
-		   $acc .= $_;
- 	        }
-	        die "Unparsable content: $ctn\n"
-	           unless ($acc =~ s/^"(.*)"$/$1/);
-	    }
-	    print "  seen $acc\n" if $debug > 1;
-	    push @elms, $acc;
-        }
-
-        my ($name,$anc,$desc);
         # build the tree, checking for name conflict
-        if (scalar(@elms) eq 3) {
-	   $name = $elms[0];
-	   $anc  = $elms[1];
-	   $desc = $elms[2];
-        } elsif (scalar(@elms) eq 2) {
-	   $name = $elms[0];
-	   $anc  = "XBT_LOG_ROOT_CAT";
-	   $desc = $elms[1];
-        } else {
-	   my $l = scalar(@elms);
-	   my $s = "";
-	   map {$s .= $_;} @elms;
-	   die "Unparsable content: $ctn (length=$l) (content=$s)\n";
-        }
-	$name =~ s/^\s*(\S*)\s*$/$1/; # trim
-	$anc  =~ s/^\s*(\S*)\s*$/$1/; # trim
-        die "ERROR: Category name conflict: $name used several times\n"
-	   if defined ($ancestor{$name}) && $ancestor{$name} ne $anc &&
-              defined ($desc{$name}) && $desc{$name} ne $desc;
+        die "ERROR: Category name conflict: $name used several times (in $ancestor{$name} and $anc, last time in $filename)\n"
+	   if defined ($ancestor{$name}) && $ancestor{$name} ne $anc && defined ($desc{$name}) && $desc{$name} ne $desc;
        $ancestor{$name}=$anc;
        $desc{$name}=$desc;
-   
+
        print " $name -> $anc\n" if $debug;
    }
 }
 # Retrieve all the file names, and add their content to $data
 my $data;
-open FILES, "find -name '*.c'|" || die "Cannot search for the source file names; $!\n";
+open FILES, "find ../src/ ../tools/ ../include/ -name '*.c' -o -name '*.cpp' |" || die "Cannot search for the source file names: $!\n";
 while (my $file=<FILES>) {
     chomp $file;
     parse_file($file); 	
 }
+parse_file("../include/xbt/sysdep.h");	
 close FILES;
 
 # Display the tree, looking for disconnected elems    
 my %used;
-    
+
 sub display_subtree {
     my $name=shift;
     my $indent=shift;
@@ -108,7 +100,11 @@ sub display_subtree {
 	display_subtree($cat,"$indent  ");
     }
 }
-    
+
 display_subtree("XBT_LOG_ROOT_CAT","");
 
-map {warn "Category $_ does not seem to be connected to the root (anc=$ancestor{$_})\n";} grep {!defined $used{$_}} sort keys %ancestor;    
+map {
+    warn "Category $_ does not seem to be connected to the root (anc=$ancestor{$_})\n";
+} grep {!defined $used{$_}} sort keys %ancestor;
+
+print "@}*/\n";