#!/usr/bin/perl -w

# Copyright (c) 2005 MichalDominik (AT) gmail (DOT) com ; MIT X11 license
# Shell logic ported to perl and basically rewritten by muppet, 2005;
# JS code is largely unchanged.
# 
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
# SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
# THE USE OR OTHER DEALINGS IN THE SOFTWARE.

######################### MODIFY HERE FOR YOUR NEEDS ########################

use strict;
use Getopt::Long;

use vars qw(@extensions $afterlines $beforelines $project $note
            $search_expression);
#@extensions = qw(*.c *.h *.xs);           # Files to parse
$afterlines = 10;                         # Number of context lines after
$beforelines = 3;                         # Number of context lines before
$project="Project";
$note="This file was generated by fixme2html. You can customize this note";
$search_expression = '\\<\\(XXX\\|FIXME\\|TODO\\)\\>';

################################## OPTIONS ##################################

GetOptions ('project=s'    => \$project,
            'note=s'       => \$note,
            'extensions=s' => \@extensions,
            'search=s'     => \$search_expression);

@extensions = qw(*.c *.h *.xs) unless @extensions;

#warn "extensions: @extensions\n";
#warn "project:    $project\n";
#__END__

die "Usage: $0 outputfile [grep search expression]\n"
	unless @ARGV;

my $outfile = shift @ARGV;


############################# MAIN PROCESSING #################################

open OUTFILE, "> $outfile" or die "can't open $outfile for writing: $!\n";

header ();

my @allfiles;

# Find files for each extension
foreach my $extension (@extensions) {
	my @these = grep {
		# filter out things in boilerplate directories
		!m{/(\.svn|blib)/}
	} `find ./ -iname "$extension" -print`;

	# special-case hack for C files generated from XS files.
	# something similar would be needed for .y => .c, but we'll
	# figure that out when we need it.
	if ($extension eq '*.c') {
		@these = map {
			(my $xsfile = $_) =~ s/\.c\s?$/.xs/;
			(-e $xsfile) ? () : ($_)
		} @these;
	}

        push @allfiles, @these;
		
}
chomp @allfiles;

our $id=1;

# For each file find fixmes
foreach my $file (sort @allfiles) {
        next if -z $file;

        my @fixmes = `grep -n '$search_expression' $file`;
	#print "fixmes: ".scalar(@fixmes)."\n";
        next unless @fixmes;

        print OUTFILE "<h3>$file</h3>\n";

        
        foreach my $hit (@fixmes) {
		local $/ = undef;
		my ($lineno, $fixme) = $hit =~ m/^(\d+):(.*)$/;
		my $first = $lineno-$beforelines;
		$first = 1 if $first < 1;
		my $last = $lineno+$afterlines;
		# cat with line numbers; print only the lines of interest.
		#print "`cat -n '$file' | sed -n \"$first,$last\"p`\n";
		my $context = `cat -n '$file' | sed -n "$first,$last"p`;
		# mark the line that has the actual hit on it.
		$context =~ s/^(\s*$lineno)/$1:/m;
                print OUTFILE "<div id=\"m$id\" class=\"mhead\">\n";
                print OUTFILE "<p class=\"header\">".escape_html_chars ($fixme)."</p>\n";
                print OUTFILE "<div class=\"submenu\" id=\"s$id\">\n";
                print OUTFILE "<pre>\n";
                print OUTFILE escape_html_chars ($context);
                print OUTFILE "</pre>\n";
                print OUTFILE "</div>\n";
                print OUTFILE "</div>\n";
                $id++;
        }
}

footer ();
close OUTFILE;

print "$project: $id\n";
################################ HTML STUFF ###################################

sub escape_html_chars {
	local $_ = shift;
	s/&/\&amp;/g;
	s/</\&lt;/g;
	s/>/\&gt;/g;
	$_
}

sub header {
	print OUTFILE <<EOH;
<html>
<script language="JavaScript" type="text/javascript">
<!--
var isNav4, isNav6, isIE4;

/*
 * Browser version snooper; determines your browser
 * (Navigator 4, Navigator 6, or Internet Explorer 4/5)
 */
function setBrowser()
{
    if (navigator.appVersion.charAt(0) == "4")
    {
        if (navigator.appName.indexOf("Explorer") >= 0)
        {
            isIE4 = true;
        }
        else
        {
            isNav4 = true;
        }
    }
    else if (navigator.appVersion.charAt(0) > "4")
    {
        isNav6 = true;
    }
}

/*
 *
 * Given a selector string, return a style object
 * by searching through stylesheets. Return null if
 * none found
 *
 */
function getStyleBySelector( selector )
{
    if (!isNav6)
    {
        return null;
    }
    var sheetList = document.styleSheets;
    var ruleList;
    var i, j;

    /* look through stylesheets in reverse order that
       they appear in the document */
    for (i=sheetList.length-1; i >= 0; i--)
    {
        ruleList = sheetList[i].cssRules;
        for (j=0; j<ruleList.length; j++)
        {
            if (ruleList[j].type == CSSRule.STYLE_RULE &&
                ruleList[j].selectorText == selector)
            {
                return ruleList[j].style;
            }   
        }
    }
    return null;
}

/*
 *
 * Given an id and a property (as strings), return
 * the given property of that id.  Navigator 6 will
 * first look for the property in a tag; if not found,
 * it will look through the stylesheet.
 *
 * Note: do not precede the id with a # -- it will be
 * appended when searching the stylesheets
 *
 */
function getIdProperty( id, property )
{
    if (isNav6)
    {
        var styleObject = document.getElementById( id );
        if (styleObject != null)
        {
            styleObject = styleObject.style;
            if (styleObject[property])
            {
                return styleObject[ property ];
            }
        }
        styleObject = getStyleBySelector( "#" + id );
        return (styleObject != null) ?
            styleObject[property] :
            null;
    }
    else if (isNav4)
    {
        return document[id][property];
    }
    else
    {
        return document.all[id].style[property];
    }
}

/*
 *
 * Given an id and a property (as strings), set
 * the given property of that id to the value provided.
 *
 * The property is set directly on the tag, not in the
 * stylesheet.
 *
 */
function setIdProperty( id, property, value )
{
    if (isNav6)
    {
        var styleObject = document.getElementById( id );
        if (styleObject != null)
        {
            styleObject = styleObject.style;
            styleObject[ property ] = value;
        }
    }
    else if (isNav4)
    {
        document[id][property] = value;
    }
    else if (isIE4)
    {
         document.all[id].style[property] = value;
    }
}

/*
 *
 * Move a given id.  If additive is true,
 * then move it by xValue dots horizontally and
 * yValue units vertically.  If additive is
 * false, then move it to (xValue, yValue)
 *
 * Note: do not precede the id with a # -- it will be
 * appended when searching the stylesheets
 *
 * Note also: length units are preserved in Navigator 6
 * and Internet Explorer. That is, if left is 2cm and
 * top is 3cm, and you move to (4, 5), the left will
 * become 4cm and the top 5cm.
 *
 */
function generic_move( id, xValue, yValue, additive )
{
    var left = getIdProperty(id, "left");
    var top = getIdProperty(id, "top");
    var leftMatch, topMatch;

    if (isNav4)
    {
        leftMatch = new Array( 0, left, "");
        topMatch = new Array( 0, top, "");
    }
    else if (isNav6 || isIE4 )
    {
        var splitexp = /([-0-9.]+)(\\w+)/;
        leftMatch = splitexp.exec( left );
        topMatch = splitexp.exec( top );
        if (leftMatch == null || topMatch == null)
        {
            leftMatch = new Array(0, 0, "px");
            topMatch = new Array(0, 0, "px");
        }
    }
    left = ((additive) ? parseFloat( leftMatch[1] ) : 0) + xValue;
    top = ((additive) ? parseFloat( topMatch[1] ) : 0) + yValue;
    setIdProperty( id, "left", left + leftMatch[2] );
    setIdProperty( id, "top", top + topMatch[2] );
}

/*
 *
 * Move a given id to position (xValue, yValue)
 *
 */
function moveTo( id, x, y )
{
    generic_move( id, x, y, false );
}

/*
 *
 * Move a given id to (currentX + xValue, currentY + yValue)
 *
 */
function moveBy( id, x, y)
{
    generic_move( id, x, y, true );
}

/*
 *
 * Function used when converting rgb format colors
 * from Navigator 6 to a hex format
 *
 */ 
function hex( n )
{
    var hexdigits = "0123456789abcdef";
    return ( hexdigits.charAt(n >> 4) + hexdigits.charAt(n & 0x0f) );
}

/*
 *
 * Retrieve background color for a given id.
 * The value returned will be in hex format (#rrggbb)
 *
 */ 
function getBackgroundColor( id )
{
    var color;

    if (isNav4)
    {
        color = document[id].bgColor;
    }
    else if (isNav6)
    {
        var parseExp = /rgb.(\\d+),(\\d+),(\\d+)./;
        var rgbvals;
        color = getIdProperty( id, "backgroundColor" );
        if (color)
        {
            rgbvals = parseExp.exec( color );
            if (rgbvals)
            {
                color = "#" + hex( rgbvals[1] ) + hex( rgbvals[2] ) +
                    hex( rgbvals[3] );
            }
        }
        return color;
    }
    else if (isIE4)
    {
        return document.all[id].backgroundColor;
    }
    return "";
}

/*
 *
 * Return a division''s document
 * 
 */
function getDocument( divName )
{
    var doc;

    if (isNav4)
    {
        doc = window.document[divName].document;
    }
    else if (isNav6)
    {
        doc = document;
    }
    else if (isIE4)
    {
        doc = document;
    }
    return doc;
}

function findOwner( evt )
{
    var node;
    if (isNav6)
    {
        node = evt.target;
        while (node)
        {
            if ( node.nodeType == Node.ELEMENT_NODE &&
                 node.nodeName == "DIV")
            {
                return node;
            }
            node = node.parentNode;
        }
    }
    else if (isIE4)
    {
        node = window.event.srcElement;
        while (node)
        {
            if (node.tagName == "DIV")
            {
                return node;
            }
            node = node.parentElement;
        }
    }
    return null;
}

function highlight( evt )
{
    var divObj = findOwner( evt );
    if (isNav6) { divObj.style.cursor = "pointer"; }
}

function dim( evt )
{
    var divObj = findOwner( evt );
    if (isNav6) { divObj.style.cursor = "default"; }
    divObj.style.color = "#000000";
}

function getObject( nameStr )
{
    if (isNav6)
    {
        return document.getElementById( nameStr );
    }
    else if (isIE4)
    {
        return document.all[nameStr];
    }
}


function showMenu( evt )
{
    var owner = findOwner( evt );
    var divNum;

    if (isNav6)
    {
        divNum = owner.attributes.getNamedItem("id").nodeValue;
    }
    else if (isIE4)
    {
        divNum = owner.id;
    }

    divNum = parseInt( divNum.substr(1));

    if (getIdProperty( "s" + divNum, "display") != "block" )
    {
        setIdProperty("s" + divNum, "display", "block");
    }
    else
    {
        setIdProperty("s" + divNum, "display", "none");
    }
}

function setupAction( node )
{
    if (isNav6)
    {
        node.addEventListener( "click", showMenu, false);
        node.addEventListener( "mouseover", highlight, false );
        node.addEventListener( "mouseout", dim, false );
        node.style.fontWeight = "bold";
    }
    else if (isIE4)
    {
        node.onclick = showMenu;
        node.onmouseover = highlight;
        node.onmouseout = dim;
    }
}

function setupEvents()
{
    var i;
    var theNode;

    for (i=0; i<vocabList.length; i++)
    {
        theNode = document.getElementById( "s" + i );
        setupAction( theNode );
    }
}

function setup()
{
    var i;
    var obj;

    i = 1;
    while (obj = getObject( "m" + i )) {
        setupAction( obj );
	i++;
    }
}

setBrowser();

// -->
</script>
<style type="text/css">
<!--

.submenu {
    display:none;
    margin-left: 2em;
    margin-right: 2em;
    padding: 3px;
}

.mhead {
    font-family: monospace;
    margin-left: 1em;
    margin-right: 1em;
    display: block;
    margin-bottom: 10px;
    background-color: #f8f0cc;
    border: 1px solid;
}

.header {
    margin-top: 0px;
    margin-bottom: 0px;
    padding: 5px;
    background-color: #f6f6f6;
    font-size: 10pt;
}

h3 {
    font-size: 15pt;
    letter-spacing: +1pt;
    margin-top: 25pt;
    margin-bottom: 10pt;
}

h1 {
    font-size: 30pt;
    font-weight: bold;
    margin-bottom: 5pt;
    text-align: center;
}

h5 { 
    text-align: center;
    font-size: 12pt;
    font-style: italic;
    margin: auto;
    margin-bottom: 20pt;
}

-->
</style>

<head>
  <title>$project : FIXME watcher</title>
</head>

<body onload="setup();">
<h1>$project</h1><h5>$note</h5>
EOH
}

sub footer {
	print OUTFILE "</body></html>";
}