project.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548
  1. <?xml version="1.0" encoding="iso-8859-5"?>
  2. <!--
  3. Metrix++, Copyright 2009-2013, Metrix++ Project
  4. Link: http://metrixplusplus.sourceforge.net
  5. This file is part of Metrix++ Tool.
  6. Metrix++ is free software: you can redistribute it and/or modify
  7. it under the terms of the GNU General Public License as published by
  8. the Free Software Foundation, version 3 of the License.
  9. Metrix++ is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. GNU General Public License for more details.
  13. You should have received a copy of the GNU General Public License
  14. along with Metrix++. If not, see <http://www.gnu.org/licenses/>.
  15. -->
  16. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  17. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  18. <html xmlns="http://www.w3.org/1999/xhtml">
  19. <head>
  20. <meta http-equiv="cache-control" content="max-age=0" />
  21. <meta http-equiv="cache-control" content="no-cache" />
  22. <meta http-equiv="expires" content="0" />
  23. <meta http-equiv="expires" content="Tue, 01 Jan 1980 1:00:00 GMT" />
  24. <meta http-equiv="pragma" content="no-cache" />
  25. <meta http-equiv="content-type" content="text/html; charset=iso-8859-5" />
  26. <title>Metrix++ Project</title>
  27. <link href="style.css" rel="stylesheet" type="text/css" />
  28. </head>
  29. <body>
  30. <table border="0" align="center" cellpadding="0" cellspacing="0" width="800">
  31. <tbody>
  32. <tr>
  33. <td></td>
  34. <td valign="middle"></td>
  35. </tr>
  36. <tr>
  37. <td><img src="logo_project.png" alt="Software Index Project Page" /></td>
  38. <td valign="top">
  39. <div align="right">
  40. <p align="center"><a
  41. href="http://sourceforge.net/projects/metrixplusplus"
  42. class="lowImportance"><img
  43. src="http://sflogo.sourceforge.net/sflogo.php?group_id=275605&amp;type=13"
  44. alt="Get Software Index at SourceForge.net. Fast, secure and Free Open Source software downloads"
  45. border="0" /></a></p>
  46. <p align="center"><script type="text/javascript"
  47. src="http://www.ohloh.net/p/485947/widgets/project_users_logo.js">
  48. </script>
  49. </p>
  50. </div>
  51. </td>
  52. </tr>
  53. <tr>
  54. <td colspan="2"><hr />
  55. </td>
  56. </tr>
  57. <tr>
  58. <td colspan="2" class="highImportance"
  59. style="text-align:center;margin-left:auto;margin-right:0;"><a
  60. href="#Overview">Overview</a> | <a href="#Download">Download</a> | <a
  61. href="#Documentation">Documentation</a> | <a href="#Support">Bur
  62. report</a> | <a href="#Support">Feature request</a> | <a
  63. href="#Createplugin">Create plugin</a></td>
  64. </tr>
  65. <tr>
  66. <td colspan="2"><hr />
  67. </td>
  68. </tr>
  69. <tr>
  70. <td colspan="2" valign="top">
  71. <table width="100%" border="0" cellspacing="0" cellpadding="10">
  72. <tbody>
  73. <tr>
  74. <td valign="top"><h3 id="Overview">Overview</h3>
  75. <p><span class="normalImportance">Metrix++</span> is the
  76. platform to collect and analyse code metrics.</p>
  77. <ul>
  78. <li>It has got plugin based architecture, so it is easy to
  79. add support for new languages and/or define new metrics
  80. and/or create new pre- and post-processing tools.</li>
  81. <li>Every metric has got 'turn-on' and other configuration
  82. options.</li>
  83. <li>There is no predefined thresholds for metrics or rules.
  84. You can choose and configure any limit you want.</li>
  85. <li>It scales well to big code bases. For example initial
  86. parsing of about 10000 files takes 2-3 minutes on average
  87. PC, and ONLY 10-20 seconds for iterative re-run. Reporting
  88. summary results and exceeded limits is less than 1 - 10
  89. seconds.</li>
  90. <li>It can compare results for 2 code snapshots (collections)
  91. and differentiate added regions (classes, functions, etc.),
  92. modified regions and unchanged regions.</li>
  93. <li>As a result, easy deployment is guaranteed into legacy
  94. software, helping you to deal with legacy code effiently -
  95. either enforce 'leave it not worse than it was before' rule
  96. or motivate re-factoring.</li>
  97. </ul>
  98. <h4>Standard Plugins</h4>
  99. <p>The distributive includes a set of standard plugins:</p>
  100. <ul>
  101. <li><h4>Code parsers</h4>
  102. <ul>
  103. <li><span class="normalImportance">C/C++</span> parser
  104. recognises definition of namespaces, definition of
  105. classes/structs (including enclosed in functions),
  106. templates and definition of functions/operators</li>
  107. <li><span class="normalImportance">C#</span> parser
  108. recognises definition of namespaces, definition of
  109. classes/structs (including enclosed in functions),
  110. interfaces, generics, definition of
  111. functions/operators</li>
  112. <li><span class="normalImportance">Java</span> parser
  113. recognises definition of classes (including local in
  114. functions), interfaces, generics and functions</li>
  115. </ul>
  116. </li>
  117. <li><h4>Metrics</h4>
  118. <ul>
  119. <li><span class="normalImportance">cyclomatic
  120. complexity</span> (by McCabe) per function <span
  121. class="lowImportance">[supports C/C++, C#, Java
  122. languages]</span></li>
  123. <li><span class="normalImportance">processing
  124. errors</span> per file <span
  125. class="lowImportance">[supports any file
  126. type]</span></li>
  127. <li><span class="normalImportance">processing time</span>
  128. per file <span class="lowImportance">[supports any file
  129. type]</span></li>
  130. </ul>
  131. </li>
  132. <li><h4>Analysis tools</h4>
  133. <ul>
  134. <li><span class="normalImportance">export.py</span> -
  135. exporter to xml, python or plain text of detailed
  136. information per file and/or aggregated information per
  137. file or directory <span
  138. class="lowImportance">[aggregated data includes <span
  139. class="normalImportance">sum</span>, <span
  140. class="normalImportance">maximum</span>, <span
  141. class="normalImportance">minimum</span>, <span
  142. class="normalImportance">average</span> within a subset
  143. of selected files or directories]</span></li>
  144. <li><span class="normalImportance">limit.py</span> - a
  145. tool to report regions exceeding speified thresholds,
  146. which are configurable (output is plain text with
  147. metadata compatible with gcc compiler warning
  148. messages)</li>
  149. <li><span class="normalImportance">info.py</span> - a
  150. tool to show file metadata, such as properties,
  151. namespaces and fields recorded</li>
  152. </ul>
  153. </li>
  154. </ul>
  155. <h3 id="Download">Download &amp; Installation</h3>
  156. <p>For the installation of the <span
  157. class="normalImportance">Metrix++</span> <a
  158. href="http://sourceforge.net/projects/metrixplusplus/files/">download
  159. the archive</a> with <span class="highImportance">the latest
  160. stable version</span> and unpack it to some folder.
  161. Corresponding checkout from the version control system:</p>
  162. <p><pre>&gt; svn checkout <a href="https://metrixplusplus.svn.sourceforge.net/svnroot/metrixplusplus/releases/">https://metrixplusplus.svn.sourceforge.net/svnroot/metrixplusplus/releases/</a>&lt;version&gt;</pre>
  163. </p>
  164. <p>Alternatively, there is an option to <a
  165. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/mainline/?view=tar">download
  166. tarball file</a> with <span class="highImportance">the latest
  167. development version</span> of the tool or checkout this version
  168. of <a
  169. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/">source
  170. code</a> from the version conrol system:</p>
  171. <p><pre>&gt; svn checkout <a href="https://metrixplusplus.svn.sourceforge.net/svnroot/metrixplusplus/mainline/">https://metrixplusplus.svn.sourceforge.net/svnroot/metrixplusplus/mainline/</a></pre>
  172. </p>
  173. <h4>Prerequisites:</h4>
  174. <p>Python Runtime Environment (version 2.7.0 or later, version
  175. 3.0 has not been tested)</p>
  176. <h4>License:</h4>
  177. <p>This program is free software; you can redistribute it
  178. and/or modify it under the terms of the GNU General Public
  179. License as published by the Free Software Foundation; version 3
  180. of the License.</p>
  181. <p>This program is distributed in the hope that it will be
  182. useful, but WITHOUT ANY WARRANTY; without even the implied
  183. warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  184. PURPOSE. See the GNU General Public License for more
  185. details.</p>
  186. <p>You should have received a copy of the GNU General Public
  187. License along with the <span
  188. class="normalImportance">Metriix++</span>; if not, contact <a
  189. href="mailto:avkonst@users.sourceforge.net">Project
  190. Administrator</a> and write to the Free Software Foundation,
  191. Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
  192. USA.</p>
  193. <h3 id="Documentation">Documentation</h3>
  194. <p>Tools are self-descriptive and have got comprehensive
  195. context help. Type in the command line: python
  196. &lt;tool-name&gt;.py --help</p>
  197. <h4>Known Limitations</h4>
  198. <p>Check 'doc/limitations.txt' file distributed with the tool
  199. or browse for recent version <a
  200. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/mainline/doc/limitations.txt">online</a>.</p>
  201. <h4>Basic Workflow</h4>
  202. <p>Assuming that you opened a terminal and your current working
  203. directory is in the root folder of the tool installed.</p>
  204. <p><strong>I.</strong> Start with running a collector tool,
  205. enabling a collection of cyclomatic complexity:</p>
  206. <p><pre>&gt; python <span class="highImportance">collect.py</span> <span class="normalImportance">--std.code.complexity.on</span> -- /path/to/your/project ../../path/to/some/other/project</pre>
  207. </p>
  208. <p>It will generate a database file in working directory with
  209. default name. In order to change the name or location, use
  210. corresponding command line option. Depending on a size of code
  211. base, collection may take seconds or minutes, but it is very
  212. fast in general. In order to achive the highest performance (~
  213. to calculation of crc32) for iterative re-scans, point out to
  214. the dabase file collected for the previous code revision:</p>
  215. <p><pre>&gt; python <span class="highImportance">collect.py</span> --std.code.complexity.on <span class="highImportance normalImportance">--general.db-file-prev=metrixpp-prev.db</span> --
  216. /path/to/your/project</pre>
  217. </p>
  218. <p>Paths are optional. If you do not specify a path, it will
  219. scan files in the current working directory. Check other
  220. available options for the tool by executing:</p>
  221. <p><pre>&gt; python <span class="highImportance">collect.py</span> <span class="normalImportance">--help</span></pre>
  222. </p>
  223. <p><strong>II.</strong> Secondly, export data using export
  224. tool.</p>
  225. <p><pre>&gt; python <span class="highImportance">export.py</span> --
  226. <span class="lowImportance">&lt;export&gt;
  227. &lt;data&gt;
  228. &lt;info path="" id="1" /&gt;
  229. &lt;file-data /&gt;
  230. &lt;subfiles&gt;
  231. &lt;/subfiles&gt;
  232. &lt;subdirs&gt;
  233. &lt;subdir&gt;path&lt;/subdir&gt;
  234. &lt;/subdirs&gt;
  235. &lt;aggregated-data&gt;
  236. &lt;<span class="normalImportance">std.code.complexity</span>&gt;
  237. &lt;cyclomatic max="2" total="14.0" avg="0.168674698795" min="0" /&gt;
  238. &lt;/<span class="normalImportance">std.code.complexity</span>&gt;
  239. &lt;/aggregated-data&gt;
  240. &lt;/data&gt;
  241. &lt;/export&gt;</span>
  242. </pre>
  243. </p>
  244. <p>By default, it exports all aggregated data for all files
  245. scanned in xml format. It is possible to re-configure output
  246. format to python or plain text. In order to narrow the scope,
  247. specify a path to directory or a file. In order to export only
  248. subset of metrics, specify them as well.</p>
  249. <p><pre>&gt; python <span class="highImportance">export.py</span> --general.format=<span class="normalImportance">python</span> --general.namespaces=<span class="normalImportance">std.code.complexity</span> --
  250. <span class="normalImportance">/path/to/your/project/subdir</span>
  251. <span class="lowImportance">&lt;export&gt;
  252. ...
  253. &lt;/export&gt;</span></pre>
  254. </p>
  255. <p>If you have got results collected for previous version,
  256. point out to the file using the corresponding option and the
  257. tool will add diff data.</p>
  258. <p><pre>&gt; python <span class="highImportance">export.py</span> --general.namespaces=<span class="normalImportance">std.code.complexity</span> --general.db-file-prev=<span class="normalImportance">metrixpp-prev.db</span> --
  259. <span class="lowImportance">&lt;export&gt;
  260. &lt;data&gt;
  261. &lt;info path="" id="1" /&gt;
  262. &lt;file-data /&gt;
  263. &lt;subfiles&gt;
  264. &lt;/subfiles&gt;
  265. &lt;subdirs&gt;
  266. &lt;subdir&gt;path&lt;/subdir&gt;
  267. &lt;/subdirs&gt;
  268. &lt;aggregated-data&gt;
  269. &lt;<span class="normalImportance">std.code.complexity</span>&gt;
  270. &lt;cyclomatic max="2" total="14.0" avg="0.168674698795" min="0"&gt;
  271. &lt;<span class="normalImportance">__diff__ max="0" total="0.0" avg="0.0" min="0"</span> /&gt;
  272. &lt;/cyclomatic&gt;
  273. &lt;/<span class="normalImportance">std.code.complexity</span>&gt;
  274. &lt;/aggregated-data&gt;
  275. &lt;/data&gt;
  276. &lt;/export&gt;</span>
  277. </pre>
  278. </p>
  279. <p>Check other available options for the tool by executing:</p>
  280. <p><pre>&gt; python <span class="highImportance">export.py</span> <span class="normalImportance">--help</span></pre>
  281. </p>
  282. <p><strong>III.</strong> Finally, identify code regions which
  283. exceed a specified limit, applying it to all scanned files:</p>
  284. <p><pre>&gt; python <span class="highImportance">limit.py</span> --general.max-limit=<span class="normalImportance">std.code.complexity</span><strong>:</strong><span class="normalImportance">cyclomatic</span><strong>:</strong><span class="normalImportance">7</span><strong> </strong>--
  285. <span class="lowImportance">/path/to/your/project/ui/notifications.cpp:72: warning: Metric '<span class="normalImportance">std.code.complexity</span>/<span class="normalImportance">cyclomatic</span>' for
  286. region 'doFont' exceeds the limit.
  287. Metric name : <span class="normalImportance">std.code.complexity</span>/<span class="normalImportance">cyclomatic</span>
  288. Region name : doFont
  289. Metric value : 10
  290. Modified : None
  291. Change trend : None
  292. Limit : 7
  293. /path/to/your/project/ui/notifications.cpp:144: warning: Metric '<span class="normalImportance">std.code.complexity</span>/<span class="normalImportance">cyclomatic</span>' for
  294. region 'doStyle' exceeds the limit.
  295. Metric name : <span class="normalImportance">std.code.complexity</span>/<span class="normalImportance">cyclomatic</span>
  296. Region name : doStyle
  297. Metric value : 9
  298. Modified : None
  299. Change trend : None
  300. Limit : 7</span></pre>
  301. </p>
  302. <p>You can limit the scope of analysis by defining paths to
  303. directories or files.If you have got results collected for
  304. previous version, point out to the file using the corresponding
  305. option and the tool will notify about change status:</p>
  306. <p><pre>&gt; python <span class="highImportance">limit.py</span> --general.max-limit=std.code.complexity<strong>:</strong>cyclomatic<strong>:</strong>7
  307. --general.db-file-prev=<span class="normalImportance">metrixpp-prev.db</span> --
  308. <span class="lowImportance normalImportance">/path/to/your/project/ui/notifications.cpp:72: warning: Metric 'std.code.complexity/cyclomatic' for
  309. region 'doFont' exceeds the limit.
  310. Metric name : std.code.complexity/cyclomatic
  311. Region name : doFont
  312. Metric value : 10
  313. Modified : <span class="normalImportance">True</span>
  314. Change trend : <span class="normalImportance">0</span>
  315. Limit : 7
  316. /path/to/your/project/ui/notifications.cpp:144: warning: Metric 'std.code.complexity/cyclomatic' for
  317. region 'doStyle' exceeds the limit.
  318. Metric name : std.code.complexity/cyclomatic
  319. Region name : doStyle
  320. Metric value : 9
  321. Modified : <span class="normalImportance">True</span>
  322. Change trend : <span class="normalImportance">+1</span>
  323. Limit : 7</span></pre>
  324. </p>
  325. <p>Another useful option for this tool helps you to <span
  326. class="highImportance">deal with legacy code</span>. It is not
  327. unusual if you have got enormous number of warnings enabling
  328. new thresholds for the code designed in the past, which has not
  329. be profiled/targeted to specific metric limits. By default the
  330. tool warns about all code regions, ignoring their change
  331. status. You can reconfigure it to one of the following:</p>
  332. <ul>
  333. <li>warn only about <span class="normalImportance">new</span>
  334. code regions (functions, classes):</li>
  335. </ul>
  336. <p><pre>&gt; python <span class="highImportance">limit.py</span> --general.max-limit=std.code.complexity<strong>:</strong>cyclomatic<strong>:</strong>7
  337. --general.db-file-prev=metrixpp-prev.db <span class="normalImportance">--general.warn=<strong>new</strong></span> --</pre>
  338. </p>
  339. <ul>
  340. <li>warn about <span class="normalImportance">new</span> code
  341. regions and <span class="normalImportance">modifed regions
  342. <strong>regressing</strong> the metric</span> (enforces the
  343. rule 'leave not worse than it was before'):</li>
  344. </ul>
  345. <p><pre>&gt; python <span class="highImportance">limit.py</span> --general.max-limit=std.code.complexity<strong>:</strong>cyclomatic<strong>:</strong>7
  346. --general.db-file-prev=metrixpp-prev.db <span class="normalImportance">--general.warn=<strong>trend</strong></span> --
  347. <span class="lowImportance normalImportance">/path/to/your/project/ui/notifications.cpp:144: warning: Metric 'std.code.complexity/cyclomatic' for
  348. region 'doStyle' exceeds the limit.
  349. Metric name : std.code.complexity/cyclomatic
  350. Region name : doStyle
  351. Metric value : 9
  352. Modified : <span class="normalImportance">True</span>
  353. Change trend : <span class="normalImportance"><strong>+1</strong></span>
  354. Limit : 7</span></pre>
  355. </p>
  356. <ul>
  357. <li>warn about <span class="normalImportance">new</span> and
  358. <span class="normalImportance">all modified regions</span>
  359. (motivates for refactoring of legacy code): </li>
  360. </ul>
  361. <p><pre>&gt; python <span class="highImportance">limit.py</span> --general.max-limit=std.code.complexity<strong>:</strong>cyclomatic<strong>:</strong>7
  362. --general.db-file-prev=metrixpp-prev.db <span class="normalImportance">--general.warn=<strong>touched</strong></span> --
  363. <span class="lowImportance normalImportance">/path/to/your/project/ui/notifications.cpp:72: warning: Metric 'std.code.complexity/cyclomatic' for
  364. region 'doFont' exceeds the limit.
  365. Metric name : std.code.complexity/cyclomatic
  366. Region name : doFont
  367. Metric value : 10
  368. Modified : <span class="normalImportance"><strong>True</strong></span>
  369. Change trend : <span class="normalImportance">0</span>
  370. Limit : 7
  371. /path/to/your/project/ui/notifications.cpp:144: warning: Metric 'std.code.complexity/cyclomatic' for
  372. region 'doStyle' exceeds the limit.
  373. Metric name : std.code.complexity/cyclomatic
  374. Region name : doStyle
  375. Metric value : 9
  376. Modified : <strong><span class="normalImportance">True</span></strong>
  377. Change trend : <span class="normalImportance">+1</span>
  378. Limit : 7</span></pre>
  379. </p>
  380. <p>Check other available options for the tool by executing:</p>
  381. <p><pre>&gt; python <span class="highImportance">limit.py</span> <span class="normalImportance">--help</span></pre>
  382. </p>
  383. <h3 id="Support">Bug Report &amp; Feature Request</h3>
  384. <p>Any types of enquiries are welcomed by e-mail to <a
  385. href="mailto:avkonst@users.sourceforge.net">project
  386. administrator</a>.</p>
  387. <h3 id="Createplugin">Create Plugin</h3>
  388. <p>Please, consider to join the project and <span
  389. class="normalImportance">contribute to the development</span>
  390. of the engine or <span class="normalImportance">include you
  391. plugins into the standard set</span> of plugins distributed
  392. together with this tool. Contact <a
  393. href="mailto:avkonst@users.sourceforge.net">project
  394. administrator</a> by e-mail.</p>
  395. <h4>New Metric</h4>
  396. <p>Unfortunately, there is no rich documentation at this stage.
  397. Briefly, any new plugin starts with creating 2 new files: 'ini'
  398. and 'py'. You can copy from other avaialble (for example, <a
  399. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/mainline/ext/std/code/complexity.ini">ini</a>
  400. and <a
  401. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/mainline/ext/std/code/complexity.py">py</a>
  402. files for the standard complexity plugin) and impelement the
  403. logic related to the new metric.</p>
  404. <h4>New Analysis Tool</h4>
  405. <p>Unfortunately, there is no rich documentation at this stage.
  406. Briefly, database API (class Loader implemented in '<a
  407. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/mainline/core/db/loader.py">core.db.loader</a>')
  408. is a starting point for any new post-analysis tool. There are 2
  409. standard tools (<a
  410. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/mainline/export.py">export.py</a>
  411. and <a
  412. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/mainline/limit.py">limit.py</a>)
  413. available which use this API.</p>
  414. <h4>New Language Support</h4>
  415. <p>Unfortunately, there is no rich documentation at this stage.
  416. Briefly:</p>
  417. <ul>
  418. <li>a plugin is registered in the same way as a plugin for
  419. new metric</li>
  420. <li>it subscribes to directory reader plugin</li>
  421. <li>parses a file in a callback, called by directory
  422. reader</li>
  423. <li>parser needs to identify markers (like comments, strings,
  424. preprocessor) and regions (like functions, classes, etc.)
  425. and tell about this to file data object passed as an
  426. argument for the callback.</li>
  427. </ul>
  428. <p>Parser for C/C++ language can serve as <a
  429. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/mainline/ext/std/code/cpp.py">an
  430. example</a>. There useful options and tools are avaialble for
  431. trobuleshooting purposes during development:</p>
  432. <ul>
  433. <li><span class="normalImportance">debug.py tool</span> is
  434. helpful troubleshooting tool. In mode 'dumphtml' it
  435. generates html code showing code highlightings</li>
  436. <li><span
  437. class="normalImportance">--general.nest-regions</span> for
  438. export tool forces exporting of code structure in tree
  439. format. It can be helpful for analysis of parser's
  440. internals</li>
  441. <li><span
  442. class="normalImportance">--general.log-level</span>=GENERAL.LOG_LEVEL
  443. for any tool is helpful to trace execution </li>
  444. </ul>
  445. <p>Finally, if there are any questions or enquires, please,
  446. feel free to contact <a
  447. href="mailto:avkonst@users.sourceforge.net">project
  448. administrator</a> by e-mail.</p>
  449. <h4>Source Code Repository</h4>
  450. <p>Source code is in the Subversion repository <a
  451. href="http://metrixplusplus.svn.sourceforge.net/viewvc/metrixplusplus/mainline/">(browse
  452. online)</a> used by the project. Corresponding checkout command
  453. is the following:</p>
  454. <p><pre>&gt; svn checkout <a href="https://metrixplusplus.svn.sourceforge.net/svnroot/metrixplusplus/mainline/">https://metrixplusplus.svn.sourceforge.net/svnroot/metrixplusplus/mainline/</a></pre>
  455. </p>
  456. <h4></h4>
  457. </td>
  458. </tr>
  459. </tbody>
  460. </table>
  461. <hr />
  462. </td>
  463. </tr>
  464. <tr>
  465. <td colspan="2">
  466. <div align="center">
  467. <p align="right">Copyright <strong>&copy; </strong>2009 - 2013<br />
  468. <a href="mailto:avkonst@users.sourceforge.net"><span
  469. class="normalImportance">Metrix++</span> Project</a></p>
  470. <p align="right">License: <a
  471. href="http://www.gnu.org/licenses/gpl.txt">GPL</a></p>
  472. </div>
  473. </td>
  474. </tr>
  475. </tbody>
  476. </table>
  477. </body>
  478. </html>