Пример "C++ Source Code Analyzer"Файлы:
This example uses XQuery and the xmlpatterns command line utility to query C++ source code. ВведениеSuppose we want to analyze C++ source code to find coding standard violations and instances of bad or inefficient patterns. We can do it using the common searching and pattern matching utilities to process the C++ files (e.g., grep, sed, and awk). Now we can also use XQuery with the QtXmlPatterns module. An extension to the g++ open source C++ compiler (GCC-XML) generates an XML description of C++ source code declarations. This XML description can then be processed by QtXmlPatterns using XQueries to navigate the XML description of the C++ source and produce a report. Consider the problem of finding mutable global variables: Reporting Uses of Mutable Global VariablesSuppose we want to introduce threading to a C++ application that was originally written without threading. In a threaded program, mutable global variables can cause bugs, because one thread might change a global variable that other threads are reading, or two threads might try to set the same global variable. So when converting our program to use threading, one of the things we must do is protect the global variables to prevent the bugs described above. How can we use XQuery and GCC-XML to find the variables that need protecting? A C++ applicationConsider the declarations in this hypothetical C++ application: 1. int mutablePrimitive1; 2. int mutablePrimitive2; 3. const int constPrimitive1 = 4; 4. const int constPrimitive2 = 3; 5. 6. class ComplexClass 7. { 8. public: 9. ComplexClass(); 10. ComplexClass(const ComplexClass &); 11. ~ComplexClass(); 12. }; 13. 14. ComplexClass mutableComplex1; 15. ComplexClass mutableComplex2; 16. const ComplexClass constComplex1; 17. const ComplexClass constComplex2; 18. 19. int main() 20. { 22. int localVariable; 23. localVariable = 0; 24. return localVariable; 25. } The XML description of the C++ applicationSubmitting this C++ source to GCC-XML produces this XML description:
The XQuery for finding global variablesWe need an XQuery to find the global variables in the XML description. Here is our XQuery source. We walk through it in XQuery Code Walk-Through. (: Этот XQuery загружает файл GCC-XML и сообщает содержимое всех глобальных переменных исходного файла исходных кодов C++. Чтобы запустить запрос, используйте командную строку: xmlpatterns reportGlobals.xq -param fileToOpen=globals.gccxml -output globals.html "fileToOpen=globals.gccxml" назначает имя файла "globals.gccxml" переменной "fileToOpen" описанной и используемой ниже. :) declare variable $fileToOpen as xs:anyURI external; declare variable $inDoc as document-node() := doc($fileToOpen); (: Эта функция определяет является ли typeId сложным типом, например, QString. Мы просто проверяем не является ли он классом. Если быть точным, то мы должны проверять есть ли у класса несинтезированный конструктор. Мы принимаем как изменяемые, так и постоянные типы. :) declare function local:isComplexType($typeID as xs:string) as xs:boolean { exists($inDoc/GCC_XML/Class[@id = $typeID]) или exists($inDoc/GCC_XML/Class[@id = $inDoc/GCC_XML/CvQualifiedType[@id = $typeID]/@type]) }; (: Эта функция определяет, является ли typeId простым типом. :) declare function local:isPrimitive($typeId as xs:string) as xs:boolean { exists($inDoc/GCC_XML/FundamentalType[@id = $typeId]) }; (: Эта функция создаёт строку для отчета. Строка содержит имя переменной, файл исходных кодов и номер строки. :) declare function local:location($block as element()) as xs:string { concat($inDoc/GCC_XML/File[@id = $block/@file]/@name, " at line ", $block/@line) }; (: Эта функция генерирует отчет. Заметьте, что она вызывает один раз в элементе <body> вывода <html>. Она игнорирует постоянные переменные простых типов, но сообщает обо всех остальных. :) 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/"> { (: Для каждой Variable в $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/"> { (: Для каждой Variable в $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> }; (: Здесь происходит вывод <html> отчета. Сначала стиль, затем элемент <body>, который содержит вызов \c{local:report()} указанный выше. :) <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> Running the XQueryTo run the XQuery using the xmlpatterns command line utility, enter the following command: xmlpatterns reportGlobals.xq -param fileToOpen=globals.gccxml -output globals.html The XQuery outputThe xmlpatterns command loads and parses globals.gccxml, runs the XQuery reportGlobals.xq, and generates this report: Start report: 2008-12-16T13:43:49.65Z Global variables with complex types:
Mutable global variables with primitives types:
End report: 2008-12-16T13:43:49.65Z XQuery Code Walk-ThroughThe XQuery source is in examples/xmlpatterns/xquery/globalVariables/reportGlobals.xq It begins with two variable declarations that begin the XQuery: declare variable $fileToOpen as xs:anyURI external; declare variable $inDoc as document-node() := doc($fileToOpen); The first variable, $fileToOpen, appears in the xmlpatterns command shown earlier, as -param fileToOpen=globals.gccxml. This binds the variable name to the file name. This variable is then used in the declaration of the second variable, $inDoc, as the parameter to the doc() function. The doc() function returns the document node of globals.gccxml, which is assigned to $inDoc to be used later in the XQuery as the root node of our searches for global variables. Next skip to the end of the XQuery, where the <html> element is constructed. The <html> will contain a <head> element to specify a heading for the html page, followed by some style instructions for displaying the text, and then the <body> element. <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> The <body> element contains a call to the local:report() function, which is where the query does the "heavy lifting." Note the two return clauses separated by the comma operator about halfway down: 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/"> { (: Для каждой Variable в $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/"> { (: Для каждой Variable в $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> }; The return clauses are like two separate queries. The comma operator separating them means that both return clauses are executed and both return their results, or, rather, both output their results. The first return clause searches for global variables with complex types, and the second searches for mutable global variables with primitive types. Here is the html generated for the <body> element. Compare it with the XQuery code above: <body> <p class="details">Start report: 2008-12-16T13:43:49.65Z</p> <p>Global variables with complex types:</p> <ol> <li> <span class="variableName">mutableComplex1</span> in globals.cpp at line 14</li> <li> <span class="variableName">mutableComplex2</span> in globals.cpp at line 15</li> <li> <span class="variableName">constComplex1</span> in globals.cpp at line 16</li> <li> <span class="variableName">constComplex2</span> in globals.cpp at line 17</li> </ol> <p>Mutable global variables with primitives types:</p> <ol> <li> <span class="variableName">mutablePrimitive1</span> in globals.cpp at line 1</li> <li> <span class="variableName">mutablePrimitive2</span> in globals.cpp at line 2</li> </ol> <p class="details">End report: 2008-12-16T13:43:49.65Z</p> </body> The XQuery declares three more local functions that are called in turn by the local:report() function. isComplexType() returns true if the variable has a complex type. The variable can be mutable or const. declare function local:isComplexType($typeID as xs:string) as xs:boolean { exists($inDoc/GCC_XML/Class[@id = $typeID]) или exists($inDoc/GCC_XML/Class[@id = $inDoc/GCC_XML/CvQualifiedType[@id = $typeID]/@type]) }; isPrimitive() returns true if the variable has a primitive type. The variable must be mutable. declare function local:isPrimitive($typeId as xs:string) as xs:boolean { exists($inDoc/GCC_XML/FundamentalType[@id = $typeId]) }; location() returns a text constructed from the variable's file and line number attributes. declare function local:location($block as element()) as xs:string { concat($inDoc/GCC_XML/File[@id = $block/@file]/@name, " at line ", $block/@line) }; |
Попытка перевода Qt документации. Если есть желание присоединиться, или если есть замечания или пожелания, то заходите на форум: Перевод Qt документации на русский язык... Люди внесшие вклад в перевод: Команда переводчиков |