summaryrefslogtreecommitdiffstats
path: root/examples/xmlpatterns/xquery/globalVariables/reportGlobals.xq
blob: 4bc4243d3d8c35f9e33d08b4cfc7ded728ca38d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
(:
    This XQuery loads a GCC-XML file and reports the locations of all
    global variables in the original C++ source. To run the query,
    use the command line:

    xmlpatterns reportGlobals.xq -param fileToOpen=globals.gccxml -output globals.html

    "fileToOpen=globals.gccxml" binds the file name "globals.gccxml"
    to the variable "fileToOpen" declared and used below.
:)

declare variable $fileToOpen as xs:anyURI external;
declare variable $inDoc as document-node() := doc($fileToOpen);

(:
   This function determines whether the typeId is a complex type,
   e.g. QString. We only check whether it's a class. To be strictly
   correct, we should check whether the class has a non-synthesized
   constructor. We accept both mutable and const types.
:)
declare function local:isComplexType($typeID as xs:string) as xs:boolean
{
    exists($inDoc/GCC_XML/Class[@id = $typeID])
    or
    exists($inDoc/GCC_XML/Class[@id = $inDoc/GCC_XML/CvQualifiedType[@id = $typeID]/@type])
};

(:
   This function determines whether the typeId is a primitive type.
:)
declare function local:isPrimitive($typeId as xs:string) as xs:boolean
{
    exists($inDoc/GCC_XML/FundamentalType[@id = $typeId])
};

(:
   This function constructs a line for the report. The line contains
   a variable name, the source file, and the line number.
:)
declare function local:location($block as element()) as xs:string
{
    concat($inDoc/GCC_XML/File[@id = $block/@file]/@name, " at line ", $block/@line)
};

(:
   This function generates the report. Note that it is called once
   in the <body> element of the <html> output.

   It ignores const variables of simple types but reports all others.
:)
declare function local:report() as element()+
{
    let $complexVariables as element(Variable)* := $inDoc/GCC_XML/Variable[local:isComplexType(@type)]
    return if (exists($complexVariables))
           then (<p xmlns="http://www.w3.org/1999/xhtml/">Global variables with complex types:</p>,
                 <ol xmlns="http://www.w3.org/1999/xhtml/">
                    {
                        (: For each Variable in $complexVariables... :)
                        $complexVariables/<li><span class="variableName">{string(@name)}</span> in {local:location(.)}</li>
                    }
                 </ol>)
           else <p xmlns="http://www.w3.org/1999/xhtml/">No complex global variables found.</p>

    ,

    let $primitiveVariables as element(Variable)+ := $inDoc/GCC_XML/Variable[local:isPrimitive(@type)]
    return if (exists($primitiveVariables))
           then (<p xmlns="http://www.w3.org/1999/xhtml/">Mutable global variables with primitives types:</p>,
                 <ol xmlns="http://www.w3.org/1999/xhtml/">
                    {
                        (: For each Variable in $complexVariables... :)
                        $primitiveVariables/<li><span class="variableName">{string(@name)}</span> in {local:location(.)}</li>
                    }
                 </ol>)
           else <p xmlns="http://www.w3.org/1999/xhtml/">No mutable primitive global variables found.</p>
};

(:
    This is where the <html> report is output. First
    there is some style stuff, then the <body> element,
    which contains the call to the \c{local:report()}
    declared above.
:)
<html xmlns="http://www.w3.org/1999/xhtml/" xml:lang="en" lang="en">
    <head>
        <title>Global variables report for {$fileToOpen}</title>
    </head>
    <style type="text/css">
        .details
        {{
            text-align: left;
            font-size: 80%;
            color: blue
        }}
        .variableName
        {{
            font-family: courier;
            color: blue
        }}
    </style>

    <body>
        <p class="details">Start report: {current-dateTime()}</p>
        {
            local:report()
        }
        <p class="details">End report: {current-dateTime()}</p>
    </body>

</html>