joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dash-docs/en/doxygen/html/clang-format_8py_source.html

111 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: contrib/devtools/clang-format.py Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('clang-format_8py_source.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">clang-format.py</div> </div>
</div><!--header-->
<div class="contents">
<a href="clang-format_8py.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="namespaceclang-format.html"> 1</a></span>&#160;<span class="comment">#!/usr/bin/env python</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="stringliteral">&#39;&#39;&#39;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="stringliteral">Wrapper script for clang-format</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="stringliteral"></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="stringliteral">Copyright (c) 2015 MarcoFalke</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="stringliteral">Copyright (c) 2015 The Bitcoin Core developers</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="stringliteral">Distributed under the MIT software license, see the accompanying</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="stringliteral">file COPYING or http://www.opensource.org/licenses/mit-license.php.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="stringliteral">&#39;&#39;&#39;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">import</span> os</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">import</span> sys</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">import</span> subprocess</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="namespaceclang-format.html#a4db297dd66ff61cef28f1398c99f0086"> 15</a></span>&#160;tested_versions = [<span class="stringliteral">&#39;3.6.0&#39;</span>, <span class="stringliteral">&#39;3.6.1&#39;</span>, <span class="stringliteral">&#39;3.6.2&#39;</span>] <span class="comment"># A set of versions known to produce the same output</span></div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="namespaceclang-format.html#a2af7caaacd94c923a80ff8f7b816fe15"> 16</a></span>&#160;accepted_file_extensions = (<span class="stringliteral">&#39;.h&#39;</span>, <span class="stringliteral">&#39;.cpp&#39;</span>) <span class="comment"># Files to format</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="namespaceclang-format.html#aa06c323f7efa8f2ab5485ee9103a9ff9"> 18</a></span>&#160;<span class="keyword">def </span><a class="code" href="namespaceclang-format.html#aa06c323f7efa8f2ab5485ee9103a9ff9">check_clang_format_version</a>(clang_format_exe):</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keywordflow">try</span>:</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; output = subprocess.check_output([clang_format_exe, <span class="stringliteral">&#39;-version&#39;</span>])</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keywordflow">for</span> ver <span class="keywordflow">in</span> tested_versions:</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordflow">if</span> ver <span class="keywordflow">in</span> output:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordflow">print</span> <span class="stringliteral">&quot;Detected clang-format version &quot;</span> + ver</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordflow">return</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">raise</span> RuntimeError(<span class="stringliteral">&quot;Untested version: &quot;</span> + output)</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">except</span> Exception <span class="keyword">as</span> e:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">print</span> <span class="stringliteral">&#39;Could not verify version of &#39;</span> + clang_format_exe + <span class="stringliteral">&#39;.&#39;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">raise</span> e</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="namespaceclang-format.html#aecce89e6a75d86e704cc5ac0fb06a34a"> 30</a></span>&#160;<span class="keyword">def </span><a class="code" href="namespaceclang-format.html#aecce89e6a75d86e704cc5ac0fb06a34a">check_command_line_args</a>(argv):</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; required_args = [<span class="stringliteral">&#39;{clang-format-exe}&#39;</span>, <span class="stringliteral">&#39;{files}&#39;</span>]</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; example_args = [<span class="stringliteral">&#39;clang-format-3.x&#39;</span>, <span class="stringliteral">&#39;src/main.cpp&#39;</span>, <span class="stringliteral">&#39;src/wallet/*&#39;</span>]</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; if(len(argv) &lt; len(required_args) + 1):</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">for</span> word <span class="keywordflow">in</span> ([<span class="stringliteral">&#39;Usage:&#39;</span>, argv[0]] + required_args):</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">print</span> word,</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">print</span> <span class="stringliteral">&#39;&#39;</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">for</span> word <span class="keywordflow">in</span> ([<span class="stringliteral">&#39;E.g:&#39;</span>, argv[0]] + example_args):</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">print</span> word,</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">print</span> <span class="stringliteral">&#39;&#39;</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; sys.exit(1)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="namespaceclang-format.html#a64ca1e5dce6d2b65829c28868b819c65"> 43</a></span>&#160;<span class="keyword">def </span><a class="code" href="namespaceclang-format.html#a64ca1e5dce6d2b65829c28868b819c65">run_clang_format</a>(clang_format_exe, files):</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">for</span> target <span class="keywordflow">in</span> files:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">if</span> os.path.isdir(target):</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">for</span> path, dirs, files <span class="keywordflow">in</span> os.walk(target):</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="namespaceclang-format.html#a64ca1e5dce6d2b65829c28868b819c65">run_clang_format</a>(clang_format_exe, (os.path.join(path, f) <span class="keywordflow">for</span> f <span class="keywordflow">in</span> files))</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">elif</span> target.endswith(accepted_file_extensions):</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">print</span> <span class="stringliteral">&quot;Format &quot;</span> + target</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; subprocess.check_call([clang_format_exe, <span class="stringliteral">&#39;-i&#39;</span>, <span class="stringliteral">&#39;-style=file&#39;</span>, target], stdout=open(os.devnull, <span class="stringliteral">&#39;wb&#39;</span>), stderr=subprocess.STDOUT)</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">else</span>:</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">print</span> <span class="stringliteral">&quot;Skip &quot;</span> + target</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="namespaceclang-format.html#ab04742a2a911e599dbde4ceaa566ce81"> 54</a></span>&#160;<span class="keyword">def </span><a class="code" href="namespaceclang-format.html#ab04742a2a911e599dbde4ceaa566ce81">main</a>(argv):</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="namespaceclang-format.html#aecce89e6a75d86e704cc5ac0fb06a34a">check_command_line_args</a>(argv)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; clang_format_exe = argv[1]</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; files = argv[2:]</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="namespaceclang-format.html#aa06c323f7efa8f2ab5485ee9103a9ff9">check_clang_format_version</a>(clang_format_exe)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="namespaceclang-format.html#a64ca1e5dce6d2b65829c28868b819c65">run_clang_format</a>(clang_format_exe, files)</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="keywordflow">if</span> __name__ == <span class="stringliteral">&quot;__main__&quot;</span>:</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="namespaceclang-format.html#ab04742a2a911e599dbde4ceaa566ce81">main</a>(sys.argv)</div><div class="ttc" id="namespaceclang-format_html_ab04742a2a911e599dbde4ceaa566ce81"><div class="ttname"><a href="namespaceclang-format.html#ab04742a2a911e599dbde4ceaa566ce81">clang-format.main</a></div><div class="ttdeci">def main(argv)</div><div class="ttdef"><b>Definition:</b> <a href="clang-format_8py_source.html#l00054">clang-format.py:54</a></div></div>
<div class="ttc" id="namespaceclang-format_html_aa06c323f7efa8f2ab5485ee9103a9ff9"><div class="ttname"><a href="namespaceclang-format.html#aa06c323f7efa8f2ab5485ee9103a9ff9">clang-format.check_clang_format_version</a></div><div class="ttdeci">def check_clang_format_version(clang_format_exe)</div><div class="ttdef"><b>Definition:</b> <a href="clang-format_8py_source.html#l00018">clang-format.py:18</a></div></div>
<div class="ttc" id="namespaceclang-format_html_a64ca1e5dce6d2b65829c28868b819c65"><div class="ttname"><a href="namespaceclang-format.html#a64ca1e5dce6d2b65829c28868b819c65">clang-format.run_clang_format</a></div><div class="ttdeci">def run_clang_format(clang_format_exe, files)</div><div class="ttdef"><b>Definition:</b> <a href="clang-format_8py_source.html#l00043">clang-format.py:43</a></div></div>
<div class="ttc" id="namespaceclang-format_html_aecce89e6a75d86e704cc5ac0fb06a34a"><div class="ttname"><a href="namespaceclang-format.html#aecce89e6a75d86e704cc5ac0fb06a34a">clang-format.check_command_line_args</a></div><div class="ttdeci">def check_command_line_args(argv)</div><div class="ttdef"><b>Definition:</b> <a href="clang-format_8py_source.html#l00030">clang-format.py:30</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3847941dc22744d30c1d316a1f1a60e2.html">contrib</a></li><li class="navelem"><a class="el" href="dir_37d1fea5042680bd15e1881fba32bbab.html">devtools</a></li><li class="navelem"><a class="el" href="clang-format_8py.html">clang-format.py</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:01 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink