FCL/sf/mw/qt: util/examples/xmlpatterns/xquery/globalVariables/reportGlobals.xq@f7bc934e204c (annotated)

7 f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	1	(:
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	2	This XQuery loads a GCC-XML file and reports the locations of all
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	3	global variables in the original C++ source. To run the query,
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	4	use the command line:
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	5
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	6	xmlpatterns reportGlobals.xq -param fileToOpen=globals.gccxml -output globals.html
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	7
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	8	"fileToOpen=globals.gccxml" binds the file name "globals.gccxml"
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	9	to the variable "fileToOpen" declared and used below.
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	10	:)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	11
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	12	declare variable $fileToOpen as xs:anyURI external;
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	13	declare variable $inDoc as document-node() := doc($fileToOpen);
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	14
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	15	(:
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	16	This function determines whether the typeId is a complex type,
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	17	e.g. QString. We only check whether it's a class. To be strictly
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	18	correct, we should check whether the class has a non-synthesized
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	19	constructor. We accept both mutable and const types.
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	20	:)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	21	declare function local:isComplexType($typeID as xs:string) as xs:boolean
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	22	{
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	23	exists($inDoc/GCC_XML/Class[@id = $typeID])
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	24	or
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	25	exists($inDoc/GCC_XML/Class[@id = $inDoc/GCC_XML/CvQualifiedType[@id = $typeID]/@type])
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	26	};
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	27
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	28	(:
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	29	This function determines whether the typeId is a primitive type.
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	30	:)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	31	declare function local:isPrimitive($typeId as xs:string) as xs:boolean
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	32	{
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	33	exists($inDoc/GCC_XML/FundamentalType[@id = $typeId])
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	34	};
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	35
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	36	(:
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	37	This function constructs a line for the report. The line contains
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	38	a variable name, the source file, and the line number.
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	39	:)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	40	declare function local:location($block as element()) as xs:string
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	41	{
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	42	concat($inDoc/GCC_XML/File[@id = $block/@file]/@name, " at line ", $block/@line)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	43	};
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	44
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	45	(:
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	46	This function generates the report. Note that it is called once
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	47	in the <body> element of the <html> output.
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	48
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	49	It ignores const variables of simple types but reports all others.
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	50	:)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	51	declare function local:report() as element()+
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	52	{
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	53	let $complexVariables as element(Variable)* := $inDoc/GCC_XML/Variable[local:isComplexType(@type)]
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	54	return if (exists($complexVariables))
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	55	then (<p xmlns="http://www.w3.org/1999/xhtml/">Global variables with complex types:</p>,
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	56	<ol xmlns="http://www.w3.org/1999/xhtml/">
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	57	{
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	58	(: For each Variable in $complexVariables... :)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	59	$complexVariables/<li><span class="variableName">{string(@name)}</span> in {local:location(.)}</li>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	60	}
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	61	</ol>)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	62	else <p xmlns="http://www.w3.org/1999/xhtml/">No complex global variables found.</p>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	63
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	64	,
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	65
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	66	let $primitiveVariables as element(Variable)+ := $inDoc/GCC_XML/Variable[local:isPrimitive(@type)]
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	67	return if (exists($primitiveVariables))
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	68	then (<p xmlns="http://www.w3.org/1999/xhtml/">Mutable global variables with primitives types:</p>,
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	69	<ol xmlns="http://www.w3.org/1999/xhtml/">
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	70	{
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	71	(: For each Variable in $complexVariables... :)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	72	$primitiveVariables/<li><span class="variableName">{string(@name)}</span> in {local:location(.)}</li>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	73	}
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	74	</ol>)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	75	else <p xmlns="http://www.w3.org/1999/xhtml/">No mutable primitive global variables found.</p>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	76	};
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	77
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	78	(:
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	79	This is where the <html> report is output. First
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	80	there is some style stuff, then the <body> element,
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	81	which contains the call to the \c{local:report()}
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	82	declared above.
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	83	:)
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	84	<html xmlns="http://www.w3.org/1999/xhtml/" xml:lang="en" lang="en">
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	85	<head>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	86	<title>Global variables report for {$fileToOpen}</title>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	87	</head>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	88	<style type="text/css">
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	89	.details
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	90	{{
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	91	text-align: left;
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	92	font-size: 80%;
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	93	color: blue
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	94	}}
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	95	.variableName
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	96	{{
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	97	font-family: courier;
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	98	color: blue
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	99	}}
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	100	</style>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	101
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	102	<body>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	103	<p class="details">Start report: {current-dateTime()}</p>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	104	{
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	105	local:report()
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	106	}
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	107	<p class="details">End report: {current-dateTime()}</p>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	108	</body>
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	109
f7bc934e204c 5cabc75a39ca2f064f70b40f72ed93c74c4dc19b eckhart.koppen@nokia.com parents: diff changeset	110	</html>

author	eckhart.koppen@nokia.com
	Wed, 31 Mar 2010 11:06:36 +0300
changeset 7	f7bc934e204c
permissions	-rw-r--r--