# Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of "Eclipse Public License v1.0"

# which accompanies this distribution, and is available

# at the URL "http://www.eclipse.org/legal/epl-v10.html".

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description:

# parseseq.pl  [<arguments>] <sequence file>

# Arguments:

# -p			Include popups (when clicking on messages etc).

# -r <begin row>,<end row>	Display rows in the range specified.  Row numbers are zero based and inclusive.

# Negative row numbers count backwards from the end row.  <begin row> and/or

# <end row> may be omitted, in which case the beginning and ending rows respectively

# are assumed.  If "r" argument is not specified, a default of the last 400 rows

# is assumed (equivalent to an argument of "-r -400,").

# -R <rows per view>		The maximum number of rows in each "view" (page).  The overall sequence is generated as a number

# of individual HTML/SVG files, each showing a fragment of the sequence.  Each of these is

# termed a "view".  This option indicates the maximum number of rows per view.  Note

# that because the sequence is split into equal sized views, the actual size of each

# view can vary from half values of this parameter to its full value.  This parameter

# only limits the maximum size of each view.

# -H			On "trimmed" displays (i.e. only displaying last <n> lines), don't

# hide object timelines that don't have any messages within the area

# being displayed (but do have messages outside of that area).

# -x <file>		File containing "[DontHideShortName]" section which contains truncated names

# of classes (minus the instance numbering at the end) that should *not* be

# hidden from "trimmed" displays (i.e. displays where only the last <n> lines

# are displayed).

# -M			Exclude messages from the display.  Used for getting an overview of node and activity creation.

# -v			Print on standard output a list of objects which have not been displayed because

# they exchanged no messages or were outside of the displayed view.

# -V			Print on standard output some progress messages (useful when parsing long logs that

# take several minutes).

# -f					Do not display page links in a fixed position window.

# -n                    Print node names vertically as opposed to horizontally.

# -N                    Node to filter available list by

# -A                    Activity to filter available list by

# -h                    This help message

# todo:

# - use findObject() within findOrCreateobject()

# - hide objects whose lifetime extends entirely across the displayed area, but exchange no messages in that area

# 

#

#require 'getopts.pl';

use Getopt::Std;

use HTML::Entities;

use strict;

use Cwd;

my $version = "2.2 (27/02/08)";

getopts("MHpx:N:A:vVr:R:hnf");

our($opt_M, $opt_H, $opt_p, $opt_x, $opt_N, $opt_A, $opt_v, $opt_V, $opt_r, $opt_R, $opt_h, $opt_n, $opt_f);

if ($opt_h)

{

    print <<HELP;

Usage:

    parseseq.pl  [<arguments>] <sequence file>

 Arguments:

 -p			Include popups (when clicking on messages etc).

 -r <begin row>,<end row>   Display rows in the range specified.  Row numbers are zero based and inclusive.

                            Negative row numbers count backwards from the end row.  <begin row> and/or

                            <end row> may be omitted, in which case the beginning and ending rows respectively

                            are assumed.  If "r" argument is not specified, a default of the last 400 rows

                            is assumed (equivalent to an argument of "-r -400,").

 -R <rows per view>         The maximum number of rows in each "view" (page).  The overall sequence is generated

                            as a number of individual HTML/SVG files, each showing a fragment of the sequence.

			    Each of these is termed a "view".  This option indicates the maximum number of rows

			    per view.  Note that because the sequence is split into equal sized views, the actual

			    size of each view can vary from half values of this parameter to its full value.

			    This parameter only limits the maximum size of each view.

 -H                         On "trimmed" displays (i.e. only displaying last <n> lines), don't

                            hide object timelines that don't have any messages within the area

                            being displayed (but do have messages outside of that area).

 -x <file>		    File containing "[DontHideShortName]" section which contains truncated names

                            of classes (minus the instance numbering at the end) that should *not* be

                            hidden from "trimmed" displays (i.e. displays where only the last <n> lines

                            are displayed).

 -M                         Exclude messages from the display.  Used for getting an overview of node and activity

                            creation.

 -v                         Print on standard output a list of objects which have not been displayed because

                            they exchanged no messages or were outside of the displayed view.

 -V                         Print on standard output some progress messages (useful when parsing long logs that

                            take several minutes).

 -f							Do not display page links in a fixed position window.

 -n                         Print node names vertically as opposed to horizontally.

 -N                         Node to filter available list by. If set, you will be given a list of node activities

                            which contain the string you passed in, in the node. Select one of these and it will

			    generate the diagram only for the lifetime of that activity.

 -A                         Activity to filter available list by. If set, you will be given a list of node

                            activities which match the string you passed in, in the activity.

			    e.g.

			    >parseseq -A start \log.seq

                            Reading sequence file

                            [1] Conn1 :: ConnectionStart

                            [2] IPCPr :: IpCprStart

                            [3] IPProtoCPr :: IPProtoCprStart

                            [4] AgentCPr :: PRStart

                            [5] AgentCPr :: CprDataClientStart

                            [6] AgentSCPr :: AgentSCprStart

                            Select activity to draw:

                            ...

 -h                         This help message

HELP

    exit (0);

}

#

# Flags

#

# remove objects that are created but have no messages

my $trimSilentFlag = 1;

# sort objects left-to-right by type

my $sortObjectsFlag = 1;

my $maxRowsToDisplay = 300;

if ($opt_R) {

	die "Parameter to -R option must be between 100 and 1000\n" if $opt_R < 100 || $opt_R > 1000;

	$maxRowsToDisplay = $opt_R;

}

# whether to output timestamps in the form "hh:mm:ss,dd" where the ",dd" represents the number of seconds since the last timestamp (where possible)

my $outputTimeDeltas = 0;

# constants controlling progress messages

my $sequenceProgressIncrement = 10000;

my $trimProgressTrigger = 1000;

my $trimProgressPercentIncrement = 10;

#

# constants controlling layout

#

my $incrementY = 19;

my $fontWidth = 5;

my $fontHeight = 9;

my $leftMargin = 125;

my $leftSeperatorMargin = 55;

my $screenWidth = 50;

my $rightMargin = 30;

my $topMargin = 20;

my $bottomMargin = 22;

my $objectSpacing = 90;

my $arrowWidth = 10;

my $textArrowSpacing = 1;

my $messageSpacingAboveLine = 1;

my $objectVerticalLineSpacing = 2;

my $objectUnderlineToLifelineGap = 2;

my $objectNameRepeatCount = 35;

my $lifelineBottomOverrun = 5;

my $activitySpacing = 6;

my $textMattSize = $activitySpacing * 2 + 2;	# text is on top of node lifeline and first two activity lines

my $lifelineTextLeftMargin = 8;

my $rotatedTextOffset = 3;

#

# derived constants

#

my $topOffset = $topMargin + $objectVerticalLineSpacing;

#

# colour constants

#

my $objectNameColour1 = "red";

my $objectNameColour2 = "blue";

my $objectNameLightColour1 = "salmon";

my $objectNameLightColour2 = "rgb(50,50,200)";

my $aliveColour = "black";

my $deadColour = "white";

my $seperatorColour = "rgb(245,245,245)";

my $receiveColour = "black";

my $postColour = "green";

my $activityColour = "skyblue";

my $activityEndUnknownColour = "salmon";

# magic value for Creation/Deletion unknown

my $objectUnknown = -2;

#

# changeable global variables that need to be re-initialised per view drawn

# (see initialiseGlobals())

#

my $currentY;

#

# changeable global variables that need to be initialised once before views are drawn

#

my $minOrder = 100;

my $maxOrder = 0;

my $limitedRowText;

# hash for quick lookup of objects

my %objhash = ();

my @silentObjectsTrimmed = ();

my @messages = ();

my @sequences = ();

my @objects = ();

my %dontHideShortName = ();

#

# Data Structures:

#

# "objects" is array of hashes:

#	{ Name => , X =>,   Y =>,  MsgCount =>, Creation =>, Deletion =>, Order => }

#

# "sequences" is an array of hashes:

#	{ Action => , Object => Text =>, SrcObj =>, DestObj =>, Msg => }

# Input file format:

#

#	<action> <arguments> ...

#

# specifically:

#

#	[p|r] <message name> <source object> <destination object>

#	t <object> <text>

#	oc <object> <placement order>

#	od <object>

#	l <left hand label>

#

# actions:

#

# p		Post

# r		Receive

# t		Text

# oc	Object Create

# od	Object Destroyed

# l		Label

#

# All fields are space separated text.  For example:

#

# P StartFlow SCPR Flow

#

readIniFile();

initialiseGlobals();

print "Reading sequence file\n" if ($opt_V);

readSequences();

if ($opt_N || $opt_A)

    {

    trimDownToActivity();

    }

if ($trimSilentFlag)

	{

	print "Trimming silent objects\n" if ($opt_V);

	trimSilentObjects();

	}

my $beginRow = 0;

my $endRow = 99999;

# Count the number of rows that would be displayed

# (doesn't actually draw them because of "0" argument)

print "Generating sequence pages\n" if ($opt_V);

my $totalRows = drawSequences($beginRow, $endRow, 0);

fixObjectsWithUnknownCreationDeletion();

my $rowsToDisplay = $totalRows;

if ($opt_r) {

	$rowsToDisplay = processRowArgument($totalRows);

	}

createSubDir();

if ($totalRows <= $maxRowsToDisplay) {

	drawView(0, $totalRows - 1, 0, 0);

} else {

	my $viewsToDisplay = int($rowsToDisplay / $maxRowsToDisplay) + 1;

	my $rowsPerView = int(($rowsToDisplay + $viewsToDisplay - 1) / $viewsToDisplay);

	my $viewNumber = 0;

	createViewMap();

	while ($beginRow < $totalRows) {

		$endRow = $beginRow + $rowsPerView - 1;

		if ($endRow >= $totalRows) {

			drawView($beginRow, $totalRows - 1, $viewNumber, $viewNumber);	# last view

		} else {

			drawView($beginRow, $endRow, $viewNumber, $viewsToDisplay - 1);

		}

		++$viewNumber;

		$beginRow = $endRow + 1;

	}

	closeViewMap($viewNumber);

}

print "\n" if ($opt_V);

if ($opt_v)

	{

	printArray("\nObjects without any message exchange", \@silentObjectsTrimmed);

	}

#

# Generate the SVG and HTML files for a particular "view" (range of rows)

#

sub drawView($$$$) {

	my ($beginRow, $endRow, $viewNumber, $lastViewNumber) = @_;

	print "Generating page $viewNumber of $lastViewNumber\r" if ($opt_V);

	if ($opt_H != 1)

		{

		hideObjectsOutsideOfView($beginRow, $endRow);

		}

	my $screenWidth = calculateObjectColumnPositions();

	my $screenHeight = (($endRow - $beginRow + 1) * $incrementY) + $topMargin + $bottomMargin;

	#

	# Filename convention for views: log0.svg, log1.svg, ..., log<n>.svg, log.svg - i.e. log.svg is the last view

	# (considered the one most interesting and hence gets undecorated filename).

	#

	my $fileName = "log";

	if ($viewNumber != $lastViewNumber) {

		$fileName .= $viewNumber;

		}

	open SVG, ">html/${fileName}.svg" || die "Cannot open html/${fileName}.svg for writing\n";

	#open RTTTL, ">html/${fileName}.rtttlpre" || die "Cannot open html/${fileName}.rttlpre for writing\n";

	outputDocHeader($screenWidth, $screenHeight);

	drawObjectNames(0);

	updateObjectViewList($viewNumber);

	drawObjectLifelines($beginRow, $endRow, $screenHeight);

	drawActivities($beginRow, $endRow, $screenHeight, $viewNumber);

	my @labelsOnPage = ();

	my @objectsDestroyed = ();

	my @objectsCreated = ();

	drawSequences($beginRow, $endRow, 1, \@labelsOnPage, \@objectsCreated, \@objectsDestroyed);

	outputViewMap($viewNumber, $lastViewNumber, \@labelsOnPage, \@objectsCreated, \@objectsDestroyed);

	outputDocFooter();

	close SVG;

	#close RTTTL;

	outputHTMLEmbedder($screenWidth, $screenHeight, $viewNumber, $lastViewNumber, $fileName);

	if ($opt_v) {

		printHiddenObjects("\nObjects outside of displayed view $viewNumber");

	}

	resetForNextView();

}

sub createSubDir() {

	if (! -d html) {

		mkdir "html" || die "Cannot create 'html' subdirectory\n";

	}

}

sub resetForNextView() {

	# objects to hide must be calculated afresh per view

	unhideAllObjects();

	initialiseGlobals();

}

#

# (re)initialise globals required per view drawn

#

sub initialiseGlobals() {

	$currentY = $topMargin;

	}

####################

# Message routines

####################

sub findOrCreateMessage($)

	{

	my $msgName = $_[0];

	my $msg;

	foreach $msg (@messages) {

		if ($msg eq $msgName) {

			return \$msg;

			}

		}

	push @messages, $msgName;

	return \$messages[$#messages];

	}

###################

# Object routines

###################

sub readSequences()

{

	my $line = 0;

	while (<>) {

		die unless s/^(\w+)\s+//;

		my $action = $1;

		if ($action eq "t")

			{

			# Text

			# "t <object> <text>"

			# Place text item on the timeline of a particular object

			my $pos;

			if (s/^([^\s]*)\s+//) { $pos = $1; }

			my $objRef = findOrCreateObject($pos);

			chomp;

			my $text = $_;

			push @sequences, { Action => $action, Object => $objRef, Text => $text };

			}

		elsif ($action eq "oc")

			{

			# Object Create

			# oc <object name> <display order> <addr>

			split;

			my $objName = shift @_;

			my $order = shift @_;

			my $objRef = findOrCreateObject($objName);

			$objRef->{Order} = $order;

			if ($order < $minOrder)

				{

				$minOrder = $order;

				}

			if ($order > $maxOrder)

				{

				$maxOrder = $order;

				}

			chomp;

			push @sequences, { Action => $action, Object => $objRef };

			}

		elsif ($action eq "od")

			{

			# Object Destroyed

			# od <object name> <addr>

			split;

			my $objName = shift @_;

			my $objRef = findOrCreateObject($objName);

			chomp;

			push @sequences, { Action => $action, Object => $objRef };

			}

		elsif ($action eq "ac")

			{

			# Activity Created

			# ac <object name> <activity addr> <activity name>

			split;

			my $objRef = findObjectByName(shift @_);

			if ($objRef != 0)

				{

				my $addr = shift @_;

				my $name = shift @_;

				push @sequences, { Action => $action, Object => $objRef, Addr => $addr, Name => $name };

				}

			chomp;

			}

		elsif ($action eq "ad")

			{

			# Activity Destroyed

			# ad <addr>

			split;

			my $addr = shift @_;

			chomp;

			push @sequences, { Action => $action, Addr => $addr };

			}

		elsif ($action eq "p" || $action eq "r" || $action eq "sc")

			{

			# Post/Receive/SynchronousCall

			# [P|R|SC] <message> <source object> <destination object>

			my $msg;

			if (/^"/)

				{

				s/^"([^"]+)"\s+//;

				$msg = $1;

				}

			else

				{

				s/^(\S+)\s+//;

				$msg = $1;

				}

			my $msgRef = findOrCreateMessage($msg);

			split;

			my $srcRef = findOrCreateObject(shift @_);

			my $destRef = findOrCreateObject(shift @_);

			$srcRef->{MsgCount}++;

			$destRef->{MsgCount}++;

			if (!$opt_M) {

				push @sequences, { Action => $action, Msg => $msgRef, SrcObj => $srcRef, DestObj => $destRef };

				}

			}

		elsif ($action eq "l" || $action eq "pn" || $action eq "ts") {

			# Label (on lefthand side - for time stamp)

			# l <text>

			#

			# Popup - associated with [n]ext message

			# pn <text>

			chomp;

			push @sequences, { Action => $action, Text => $_ };

		}

		++$line;