sal/qa/helper/gcov/gcov_resultinterpreter.pl

   1 #!/usr/bin/perl -w
   2 #
   3 #
   4 # This file is part of the LibreOffice project.
   5 #
   6 # This Source Code Form is subject to the terms of the Mozilla Public
   7 # License, v. 2.0. If a copy of the MPL was not distributed with this
   8 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   9 #
  10 # This file incorporates work covered by the following license notice:
  11 #
  12 #   Licensed to the Apache Software Foundation (ASF) under one or more
  13 #   contributor license agreements. See the NOTICE file distributed
  14 #   with this work for additional information regarding copyright
  15 #   ownership. The ASF licenses this file to you under the Apache
  16 #   License, Version 2.0 (the "License"); you may not use this file
  17 #   except in compliance with the License. You may obtain a copy of
  18 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  19 #
  20 #
  21 # GCOV_RESULTINTERPRETER
  22 #
  23 # Helper, to interpret the result
  24 #
  25 # Q: Why perl?
  26 # A: regexp ;-)
  27 #
  28
  29 use strict;
  30 use File::Basename;
  31 use Getopt::Long;
  32
  33 our $version_info = 'gcov helper: 1.3 ';
  34
  35 our $help;                    # Help option flag
  36 our $version;                 # Version option flag
  37 # our $infile;
  38
  39 our $usedFunctions;     # show all functions, which have a value > 0
  40 our $nonusedFunctions;  # show all functions, which have a value == 0
  41 our $nPercent;          # show all functions, which have a value > $nPercent
  42 our $complete;          # show all functions, which have a value == 100
  43 our $incomplete;       # show all functions, which have a value > 0 && < 100
  44
  45 # Prototypes
  46 sub print_usage(*);
  47 sub read_gcov_function_file($);
  48
  49 # Parse command line options
  50 if (!GetOptions(
  51                 "usedfunctions" => \$usedFunctions,
  52                 "nonusedfunctions" => \$nonusedFunctions,
  53                 "percent=s" => \$nPercent,
  54                 "complete" => \$complete,
  55                 "incomplete" => \$incomplete,
  56                 "help"   => \$help,
  57                 "version" => \$version
  58                 ))
  59 {
  60     print_usage(*STDERR);
  61     exit(1);
  62 }
  63
  64 # Check for help option
  65 if ($help)
  66 {
  67     print_usage(*STDOUT);
  68     exit(0);
  69 }
  70
  71 # Check for version option
  72 if ($version)
  73 {
  74     print("$version_info\n");
  75     exit(0);
  76 }
  77
  78 # check if enough parameters
  79 if ($#ARGV < 0)
  80 {
  81     print("No input filename specified\n");
  82     print_usage(*STDERR);
  83     exit(1);
  84 }
  85
  86 if ($complete)
  87 {
  88     $nPercent = 100.00;
  89 }
  90 # ------------------------------------------------------------------------------
  91
  92 my %list = read_gcov_function_file($ARGV[0]);
  93
  94 my $key;
  95 my $value;
  96
  97 while (($key, $value) = each %list)
  98 {
  99     # print "function: $key = $value\n";
 100     if ($nonusedFunctions)
 101     {
 102         if ($value <= 0.00)
 103         {
 104             print "$key\n";
 105         }
 106     }
 107     elsif ($usedFunctions)
 108     {
 109         if ($value != 0.00)
 110         {
 111             print "$key, $value\n";
 112         }
 113     }
 114     elsif ($nPercent)
 115     {
 116         if ($value >= $nPercent)
 117         {
 118             print "$key, $value\n";
 119         }
 120     }
 121     elsif ($incomplete)
 122     {
 123         if ($value > 0.00 && $value < 100.00)
 124         {
 125             print "$key, $value\n";
 126         }
 127     }
 128     else
 129     {
 130         print "$key, $value\n";
 131     }
 132 }
 133
 134 # --------------------------------------------------------------------------------
 135 # Read the gcov function (gcov -f) file
 136 # and compare line by line with the export function list
 137 # so we get a list of functions, which are only exported, and not all stuff.
 138
 139 sub read_gcov_function_file($)
 140 {
 141     local *INPUT_HANDLE;
 142     my $file = $_[0];
 143     my %list;
 144     my $line = "";
 145
 146     open(INPUT_HANDLE, $file)
 147         or die("ERROR: cannot open $file!\n");
 148
 149     while ($line = <INPUT_HANDLE>)
 150     {
 151         chomp($line);
 152         # sample line (for reg exp:)
 153         # 100.00 rtl_ustr_toDouble
 154         if ($line =~ /^(.*) (\w+)$/ )
 155         {
 156             my $percent = $1;
 157             my $value = $2;
 158
 159             $list{$value} = $percent;
 160         }
 161     }
 162     close(INPUT_HANDLE);
 163     return %list;
 164 }
 165
 166 # ----------------------------------------------------------------------------
 167 sub print_usage(*)
 168 {
 169     local *HANDLE = $_[0];
 170     my $tool_name = basename($0);
 171
 172     print(HANDLE <<END_OF_USAGE);
 173
 174 Usage: $tool_name [OPTIONS] INPUTFILE
 175
 176     -u, --usedFunctions     show all functions, which have a value > 0
 177     -n, --nonusedFunctions  show all functions, which have a value == 0
 178     -p, --percent           show all functions, which have a value > percent
 179     -c, --complete          show all functions, which have a value == 100
 180     -i, --incomplete        show all functions, which have a value > 0 && < 100
 181
 182     -h, --help              Print this help, then exit
 183     -v, --version           Print version number, then exit
 184
 185 END_OF_USAGE
 186     ;
 187 }