#!/usr/bin/perl -w

#

#   Copyright (c) International Business Machines  Corp., 2002

#

#   This program is free software;  you can redistribute it and/or modify

#   it under the terms of the GNU General Public License as published by

#   the Free Software Foundation; either version 2 of the License, or (at

#   your option) any later version.

#

#   This program is distributed in the hope that it will be useful, but

#   WITHOUT ANY WARRANTY;  without even the implied warranty of

#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

#   General Public License for more details. 

#

#   You should have received a copy of the GNU General Public License

#   along with this program;  if not, write to the Free Software

#   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

#

#

# genhtml

#

#   This script generates HTML output from .info files as created by the

#   geninfo script. Call it with --help and refer to the genhtml man page

#   to get information on usage and available options.

#

#

# History:

#   2002-08-23 created by Peter Oberparleiter <Peter.Oberparleiter@de.ibm.com>

#                         IBM Lab Boeblingen

#        based on code by Manoj Iyer <manjo@mail.utexas.edu> and

#                         Megan Bock <mbock@us.ibm.com>

#                         IBM Austin

#   2002-08-27 / Peter Oberparleiter: implemented frame view

#   2002-08-29 / Peter Oberparleiter: implemented test description filtering

#                so that by default only descriptions for test cases which

#                actually hit some source lines are kept

#   2002-09-05 / Peter Oberparleiter: implemented --no-sourceview

#   2002-09-05 / Mike Kobler: One of my source file paths includes a "+" in

#                the directory name.  I found that genhtml.pl died when it

#                encountered it. I was able to fix the problem by modifying

#                the string with the escape character before parsing it.

#   2002-10-26 / Peter Oberparleiter: implemented --num-spaces

#   2003-04-07 / Peter Oberparleiter: fixed bug which resulted in an error

#                when trying to combine .info files containing data without

#                a test name

#   2003-04-10 / Peter Oberparleiter: extended fix by Mike to also cover

#                other special characters

#   2003-04-30 / Peter Oberparleiter: made info write to STDERR, not STDOUT

#   2003-07-10 / Peter Oberparleiter: added line checksum support

#   2004-08-09 / Peter Oberparleiter: added configuration file support

#

use strict;

use File::Basename; 

use Getopt::Long;

use Digest::MD5 qw(md5_base64);

# Global constants

our $title		= "LTP GCOV extension - code coverage report";

our $lcov_version	= "LTP GCOV extension version 1.4";

our $lcov_url		= "http://ltp.sourceforge.net/coverage/lcov.php";

# Specify coverage rate limits (in %) for classifying file entries

# HI:   $hi_limit <= rate <= 100          graph color: green

# MED: $med_limit <= rate <  $hi_limit    graph color: orange

# LO:          0  <= rate <  $med_limit   graph color: red

our $hi_limit	= 50;

our $med_limit	= 15;

# Width of overview image

our $overview_width = 80;

# Resolution of overview navigation: this number specifies the maximum

# difference in lines between the position a user selected from the overview

# and the position the source code window is scrolled to.

our $nav_resolution = 4;

# Clicking a line in the overview image should show the source code view at

# a position a bit further up so that the requested line is not the first

# line in the window. This number specifies that offset in lines.

our $nav_offset = 10;

our $overview_title = "directory";

# Data related prototypes

sub print_usage(*);

sub gen_html();

sub process_dir($);

sub process_file($$$);

sub info(@);

sub read_info_file($);

sub get_info_entry($);

sub set_info_entry($$$$$;$$);

sub get_prefix(@);

sub shorten_prefix($);

sub get_dir_list(@);

sub get_relative_base_path($);

sub read_testfile($);

sub get_date_string();

sub split_filename($);

sub create_sub_dir($);

sub subtract_counts($$);

sub add_counts($$);

sub apply_baseline($$);

sub remove_unused_descriptions();

sub get_found_and_hit($);

sub get_affecting_tests($);

sub combine_info_files($$);

sub merge_checksums($$$);

sub combine_info_entries($$$);

sub apply_prefix($$);

sub system_no_output($@);

sub read_config($);

sub apply_config($);

# HTML related prototypes

sub escape_html($);

sub get_bar_graph_code($$$);

sub write_png_files();

sub write_css_file();

sub write_description_file($$$);

sub write_html(*$);

sub write_html_prolog(*$$);

sub write_html_epilog(*$;$);

sub write_header(*$$$$$);

sub write_header_prolog(*$);

sub write_header_line(*$$;$$);

sub write_header_epilog(*$);

sub write_file_table(*$$$$);

sub write_file_table_prolog(*$$);

sub write_file_table_entry(*$$$$);

sub write_file_table_detail_heading(*$$);

sub write_file_table_detail_entry(*$$$);

sub write_file_table_epilog(*);

sub write_test_table_prolog(*$);

sub write_test_table_entry(*$$);

sub write_test_table_epilog(*);

sub write_source($$$$$);

sub write_source_prolog(*);

sub write_source_line(*$$$$);

sub write_source_epilog(*);

sub write_frameset(*$$$);

sub write_overview_line(*$$$);

sub write_overview(*$$$$);

# External prototype (defined in genpng)

sub gen_png($$$@);

# Global variables & initialization

our %info_data;		# Hash containing all data from .info file

our $dir_prefix;	# Prefix to remove from all sub directories

our %test_description;	# Hash containing test descriptions if available

our $date = get_date_string();

our @info_filenames;	# List of .info files to use as data source

our $test_title;	# Title for output as written to each page header

our $output_directory;	# Name of directory in which to store output

our $base_filename;	# Optional name of file containing baseline data

our $desc_filename;	# Name of file containing test descriptions

our $css_filename;	# Optional name of external stylesheet file to use

our $quiet;		# If set, suppress information messages

our $help;		# Help option flag

our $version;		# Version option flag

our $show_details;	# If set, generate detailed directory view

our $no_prefix;		# If set, do not remove filename prefix

our $frames;		# If set, use frames for source code view

our $keep_descriptions;	# If set, do not remove unused test case descriptions

our $no_sourceview;	# If set, do not create a source code view for each file

our $highlight;		# If set, highlight lines covered by converted data only

our $tab_size = 8;	# Number of spaces to use in place of tab

our $config;		# Configuration file contents

our $cwd = `pwd`;	# Current working directory

chomp($cwd);

our $tool_dir = dirname($0);	# Directory where genhtml tool is installed

#

# Code entry point

#

# Add current working directory if $tool_dir is not already an absolute path

if (! ($tool_dir =~ /^\/(.*)$/))

{

	$tool_dir = "$cwd/$tool_dir";

}

# Read configuration file if available

if (-r $ENV{"HOME"}."/.lcovrc")

{

	$config = read_config($ENV{"HOME"}."/.lcovrc");

}

elsif (-r "/etc/lcovrc")

{

	$config = read_config("/etc/lcovrc");

}

if ($config)

{

	# Copy configuration file values to variables

	apply_config({

		"genhtml_css_file"		=> \$css_filename,

		"genhtml_hi_limit"		=> \$hi_limit,

		"genhtml_med_limit"		=> \$med_limit,

		"genhtml_overview_width"	=> \$overview_width,

		"genhtml_nav_resolution"	=> \$nav_resolution,

		"genhtml_nav_offset"		=> \$nav_offset,

		"genhtml_keep_descriptions"	=> \$keep_descriptions,

		"genhtml_no_prefix"		=> \$no_prefix,

		"genhtml_no_source"		=> \$no_sourceview,

		"genhtml_num_spaces"		=> \$tab_size,

		"genhtml_highlight"		=> \$highlight});

}

# Parse command line options

if (!GetOptions("output-directory=s"	=> \$output_directory,

		"title=s"		=> \$test_title,

		"description-file=s"	=> \$desc_filename,

		"keep-descriptions"	=> \$keep_descriptions,

		"css-file=s"		=> \$css_filename,

		"baseline-file=s"	=> \$base_filename,

		"prefix=s"		=> \$dir_prefix,

		"num-spaces=i"		=> \$tab_size,

		"no-prefix"		=> \$no_prefix,

		"no-sourceview"		=> \$no_sourceview,

		"show-details"		=> \$show_details,

		"frames"		=> \$frames,

		"highlight"		=> \$highlight,

		"quiet"			=> \$quiet,

		"help|h"		=> \$help,

		"version"		=> \$version

		))

{

	print_usage(*STDERR);

	exit(1);

}

@info_filenames = @ARGV;

# Check for help option

if ($help)

{

	print_usage(*STDOUT);

	exit(0);

}

# Check for version option

if ($version)

{

	print($lcov_version."\n");

	exit(0);

}

# Check for info filename

if (!@info_filenames)

{

	print(STDERR "No filename specified\n");

	print_usage(*STDERR);

	exit(1);

}

# Generate a title if none is specified

if (!$test_title)

{

	if (scalar(@info_filenames) == 1)

	{

		# Only one filename specified, use it as title

		$test_title = basename($info_filenames[0]);

	}

	else

	{

		# More than one filename specified, used default title

		$test_title = "unnamed";

	}

}

# Make sure css_filename is an absolute path (in case we're changing

# directories)

if ($css_filename)

{

	if (!($css_filename =~ /^\/(.*)$/))

	{

		$css_filename = $cwd."/".$css_filename;

	}

}

# Make sure tab_size is within valid range

if ($tab_size < 1)

{

	print(STDERR "ERROR: invalid number of spaces specified: ".

		     "$tab_size!\n");

	exit(1);

}

# Issue a warning if --no-sourceview is enabled together with --frames

if ($no_sourceview && $frames)

{

	warn("WARNING: option --frames disabled because --no-sourceview ".

	     "was specified!\n");

	$frames = undef;

}

if ($frames)

{

	# Include genpng code needed for overview image generation

	do("$tool_dir/genpng");

}

# Make sure output_directory exists, create it if necessary

if ($output_directory)

{

	stat($output_directory);

	if (! -e _)

	{

		system("mkdir", "-p", $output_directory)

			and die("ERROR: cannot create directory $_!\n");

	}

}

# Do something

gen_html();

exit(0);

#

# print_usage(handle)

#

# Print usage information.

#

sub print_usage(*)

{

	local *HANDLE = $_[0];

	my $executable_name = basename($0);

	print(HANDLE <<END_OF_USAGE);

Usage: $executable_name [OPTIONS] INFOFILE(S)

Create HTML output for coverage data found in INFOFILE. Note that INFOFILE

may also be a list of filenames.

  -h, --help                        Print this help, then exit

  -v, --version                     Print version number, then exit

  -q, --quiet                       Do not print progress messages

  -s, --show-details                Generate detailed directory view

  -f, --frames                      Use HTML frames for source code view

  -b, --baseline-file BASEFILE      Use BASEFILE as baseline file

  -o, --output-directory OUTDIR     Write HTML output to OUTDIR

  -t, --title TITLE                 Display TITLE in header of all pages

  -d, --description-file DESCFILE   Read test case descriptions from DESCFILE

  -k, --keep-descriptions           Do not remove unused test descriptions

  -c, --css-file CSSFILE            Use external style sheet file CSSFILE

  -p, --prefix PREFIX               Remove PREFIX from all directory names

      --no-prefix                   Do not remove prefix from directory names

      --no-source                   Do not create source code view

      --num-spaces NUM              Replace tabs with NUM spaces in source view

      --highlight                   Highlight lines with converted-only data

See $lcov_url for more information about this tool.

END_OF_USAGE

	;

}

#

# gen_html()

#

# Generate a set of HTML pages from contents of .info file INFO_FILENAME.

# Files will be written to the current directory. If provided, test case

# descriptions will be read from .tests file TEST_FILENAME and included

# in ouput.

#

# Die on error.

#

sub gen_html()

{

	local *HTML_HANDLE;

	my %overview;

	my %base_data;

	my $lines_found;

	my $lines_hit;

	my $overall_found = 0;

	my $overall_hit = 0;

	my $dir_name;

	my $link_name;

	my @dir_list;

	my %new_info;

	# Read in all specified .info files

	foreach (@info_filenames)

	{

		info("Reading data file $_\n");

		%new_info = %{read_info_file($_)};

		# Combine %new_info with %info_data

		%info_data = %{combine_info_files(\%info_data, \%new_info)};

	}

	info("Found %d entries.\n", scalar(keys(%info_data)));

	# Read and apply baseline data if specified

	if ($base_filename)

	{

		# Read baseline file

		info("Reading baseline file $base_filename\n");

		%base_data = %{read_info_file($base_filename)};

		info("Found %d entries.\n", scalar(keys(%base_data)));

		# Apply baseline

		info("Subtracting baseline data.\n");

		%info_data = %{apply_baseline(\%info_data, \%base_data)};

	}

	@dir_list = get_dir_list(keys(%info_data));

	if ($no_prefix)

	{

		# User requested that we leave filenames alone

		info("User asked not to remove filename prefix\n");

	}

	elsif (!defined($dir_prefix))

	{

		# Get prefix common to most directories in list

		$dir_prefix = get_prefix(@dir_list);

		if ($dir_prefix)

		{

			info("Found common filename prefix \"$dir_prefix\"\n");

		}

		else

		{

			info("No common filename prefix found!\n");

			$no_prefix=1;

		}

	}

	else

	{

		info("Using user-specified filename prefix \"".

		     "$dir_prefix\"\n");

	}

	# Read in test description file if specified

	if ($desc_filename)

	{

		info("Reading test description file $desc_filename\n");

		%test_description = %{read_testfile($desc_filename)};

		# Remove test descriptions which are not referenced

		# from %info_data if user didn't tell us otherwise

		if (!$keep_descriptions)

		{

			remove_unused_descriptions();

		}

	}

	# Change to output directory if specified

	if ($output_directory)

	{

		chdir($output_directory)

			or die("ERROR: cannot change to directory ".

			"$output_directory!\n");

	}

	info("Writing .css and .png files.\n");

	write_css_file();

	write_png_files();

	info("Generating output.\n");

	# Process each subdirectory and collect overview information

	foreach $dir_name (@dir_list)

	{

		($lines_found, $lines_hit) = process_dir($dir_name);

		# Remove prefix if applicable

		if (!$no_prefix && $dir_prefix)

		{

			# Match directory names beginning with $dir_prefix

			$dir_name = apply_prefix($dir_name, $dir_prefix);

		}

		# Generate name for directory overview HTML page

		if ($dir_name =~ /^\/(.*)$/)

		{

			$link_name = substr($dir_name, 1)."/index.html";

		}

		else

		{

			$link_name = $dir_name."/index.html";

		}

		$overview{$dir_name} = "$lines_found,$lines_hit,$link_name";

		$overall_found	+= $lines_found;

		$overall_hit	+= $lines_hit;

	}

	# Generate overview page

	info("Writing directory view page.\n");

	open(*HTML_HANDLE, ">index.html")

		or die("ERROR: cannot open index.html for writing!\n");

	write_html_prolog(*HTML_HANDLE, "", "LCOV - $test_title");

	write_header(*HTML_HANDLE, 0, "", "", $overall_found, $overall_hit);

	write_file_table(*HTML_HANDLE, "", \%overview, {}, 0);

	write_html_epilog(*HTML_HANDLE, "");

	close(*HTML_HANDLE);

	# Check if there are any test case descriptions to write out

	if (%test_description)

	{

		info("Writing test case description file.\n");

		write_description_file( \%test_description,

					$overall_found, $overall_hit);

	}