2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>src.colorama.win32 — salomeTools 5.0.0dev documentation</title>
10 <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
11 <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
12 <script type="text/javascript" src="../../../_static/documentation_options.js"></script>
13 <script type="text/javascript" src="../../../_static/jquery.js"></script>
14 <script type="text/javascript" src="../../../_static/underscore.js"></script>
15 <script type="text/javascript" src="../../../_static/doctools.js"></script>
16 <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
17 <link rel="index" title="Index" href="../../../genindex.html" />
18 <link rel="search" title="Search" href="../../../search.html" />
20 <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
23 <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
28 <div class="document">
29 <div class="documentwrapper">
30 <div class="bodywrapper">
31 <div class="body" role="main">
33 <h1>Source code for src.colorama.win32</h1><div class="highlight"><pre>
34 <span></span><span class="c1"># Copyright Jonathan Hartley 2013. BSD 3-Clause license, see LICENSE file.</span>
36 <span class="c1"># from winbase.h</span>
37 <span class="n">STDOUT</span> <span class="o">=</span> <span class="o">-</span><span class="mi">11</span>
38 <span class="n">STDERR</span> <span class="o">=</span> <span class="o">-</span><span class="mi">12</span>
40 <span class="k">try</span><span class="p">:</span>
41 <span class="kn">import</span> <span class="nn">ctypes</span>
42 <span class="kn">from</span> <span class="nn">ctypes</span> <span class="k">import</span> <span class="n">LibraryLoader</span>
43 <span class="n">windll</span> <span class="o">=</span> <span class="n">LibraryLoader</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">WinDLL</span><span class="p">)</span>
44 <span class="kn">from</span> <span class="nn">ctypes</span> <span class="k">import</span> <span class="n">wintypes</span>
45 <span class="k">except</span> <span class="p">(</span><span class="ne">AttributeError</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">):</span>
46 <span class="n">windll</span> <span class="o">=</span> <span class="kc">None</span>
47 <span class="n">SetConsoleTextAttribute</span> <span class="o">=</span> <span class="k">lambda</span> <span class="o">*</span><span class="n">_</span><span class="p">:</span> <span class="kc">None</span>
48 <span class="n">winapi_test</span> <span class="o">=</span> <span class="k">lambda</span> <span class="o">*</span><span class="n">_</span><span class="p">:</span> <span class="kc">None</span>
49 <span class="k">else</span><span class="p">:</span>
50 <span class="kn">from</span> <span class="nn">ctypes</span> <span class="k">import</span> <span class="n">byref</span><span class="p">,</span> <span class="n">Structure</span><span class="p">,</span> <span class="n">c_char</span><span class="p">,</span> <span class="n">POINTER</span>
52 <span class="n">COORD</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">_COORD</span>
54 <span class="k">class</span> <span class="nc">CONSOLE_SCREEN_BUFFER_INFO</span><span class="p">(</span><span class="n">Structure</span><span class="p">):</span>
55 <span class="sd">"""struct in wincon.h."""</span>
56 <span class="n">_fields_</span> <span class="o">=</span> <span class="p">[</span>
57 <span class="p">(</span><span class="s2">"dwSize"</span><span class="p">,</span> <span class="n">COORD</span><span class="p">),</span>
58 <span class="p">(</span><span class="s2">"dwCursorPosition"</span><span class="p">,</span> <span class="n">COORD</span><span class="p">),</span>
59 <span class="p">(</span><span class="s2">"wAttributes"</span><span class="p">,</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">WORD</span><span class="p">),</span>
60 <span class="p">(</span><span class="s2">"srWindow"</span><span class="p">,</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">SMALL_RECT</span><span class="p">),</span>
61 <span class="p">(</span><span class="s2">"dwMaximumWindowSize"</span><span class="p">,</span> <span class="n">COORD</span><span class="p">),</span>
62 <span class="p">]</span>
63 <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
64 <span class="k">return</span> <span class="s1">'(</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">,</span><span class="si">%d</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span>
65 <span class="bp">self</span><span class="o">.</span><span class="n">dwSize</span><span class="o">.</span><span class="n">Y</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwSize</span><span class="o">.</span><span class="n">X</span>
66 <span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">Y</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwCursorPosition</span><span class="o">.</span><span class="n">X</span>
67 <span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">wAttributes</span>
68 <span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">srWindow</span><span class="o">.</span><span class="n">Top</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">srWindow</span><span class="o">.</span><span class="n">Left</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">srWindow</span><span class="o">.</span><span class="n">Bottom</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">srWindow</span><span class="o">.</span><span class="n">Right</span>
69 <span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwMaximumWindowSize</span><span class="o">.</span><span class="n">Y</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dwMaximumWindowSize</span><span class="o">.</span><span class="n">X</span>
70 <span class="p">)</span>
72 <span class="n">_GetStdHandle</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">GetStdHandle</span>
73 <span class="n">_GetStdHandle</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
74 <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">,</span>
75 <span class="p">]</span>
76 <span class="n">_GetStdHandle</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span>
78 <span class="n">_GetConsoleScreenBufferInfo</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">GetConsoleScreenBufferInfo</span>
79 <span class="n">_GetConsoleScreenBufferInfo</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
80 <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
81 <span class="n">POINTER</span><span class="p">(</span><span class="n">CONSOLE_SCREEN_BUFFER_INFO</span><span class="p">),</span>
82 <span class="p">]</span>
83 <span class="n">_GetConsoleScreenBufferInfo</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
85 <span class="n">_SetConsoleTextAttribute</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">SetConsoleTextAttribute</span>
86 <span class="n">_SetConsoleTextAttribute</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
87 <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
88 <span class="n">wintypes</span><span class="o">.</span><span class="n">WORD</span><span class="p">,</span>
89 <span class="p">]</span>
90 <span class="n">_SetConsoleTextAttribute</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
92 <span class="n">_SetConsoleCursorPosition</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">SetConsoleCursorPosition</span>
93 <span class="n">_SetConsoleCursorPosition</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
94 <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
95 <span class="n">COORD</span><span class="p">,</span>
96 <span class="p">]</span>
97 <span class="n">_SetConsoleCursorPosition</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
99 <span class="n">_FillConsoleOutputCharacterA</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">FillConsoleOutputCharacterA</span>
100 <span class="n">_FillConsoleOutputCharacterA</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
101 <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
102 <span class="n">c_char</span><span class="p">,</span>
103 <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">,</span>
104 <span class="n">COORD</span><span class="p">,</span>
105 <span class="n">POINTER</span><span class="p">(</span><span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">),</span>
106 <span class="p">]</span>
107 <span class="n">_FillConsoleOutputCharacterA</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
109 <span class="n">_FillConsoleOutputAttribute</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">FillConsoleOutputAttribute</span>
110 <span class="n">_FillConsoleOutputAttribute</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
111 <span class="n">wintypes</span><span class="o">.</span><span class="n">HANDLE</span><span class="p">,</span>
112 <span class="n">wintypes</span><span class="o">.</span><span class="n">WORD</span><span class="p">,</span>
113 <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">,</span>
114 <span class="n">COORD</span><span class="p">,</span>
115 <span class="n">POINTER</span><span class="p">(</span><span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">),</span>
116 <span class="p">]</span>
117 <span class="n">_FillConsoleOutputAttribute</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
119 <span class="n">_SetConsoleTitleW</span> <span class="o">=</span> <span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">SetConsoleTitleA</span>
120 <span class="n">_SetConsoleTitleW</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
121 <span class="n">wintypes</span><span class="o">.</span><span class="n">LPCSTR</span>
122 <span class="p">]</span>
123 <span class="n">_SetConsoleTitleW</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">BOOL</span>
125 <span class="n">handles</span> <span class="o">=</span> <span class="p">{</span>
126 <span class="n">STDOUT</span><span class="p">:</span> <span class="n">_GetStdHandle</span><span class="p">(</span><span class="n">STDOUT</span><span class="p">),</span>
127 <span class="n">STDERR</span><span class="p">:</span> <span class="n">_GetStdHandle</span><span class="p">(</span><span class="n">STDERR</span><span class="p">),</span>
128 <span class="p">}</span>
130 <div class="viewcode-block" id="winapi_test"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.win32.winapi_test">[docs]</a> <span class="k">def</span> <span class="nf">winapi_test</span><span class="p">():</span>
131 <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">STDOUT</span><span class="p">]</span>
132 <span class="n">csbi</span> <span class="o">=</span> <span class="n">CONSOLE_SCREEN_BUFFER_INFO</span><span class="p">()</span>
133 <span class="n">success</span> <span class="o">=</span> <span class="n">_GetConsoleScreenBufferInfo</span><span class="p">(</span>
134 <span class="n">handle</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">csbi</span><span class="p">))</span>
135 <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">success</span><span class="p">)</span></div>
137 <span class="k">def</span> <span class="nf">GetConsoleScreenBufferInfo</span><span class="p">(</span><span class="n">stream_id</span><span class="o">=</span><span class="n">STDOUT</span><span class="p">):</span>
138 <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
139 <span class="n">csbi</span> <span class="o">=</span> <span class="n">CONSOLE_SCREEN_BUFFER_INFO</span><span class="p">()</span>
140 <span class="n">success</span> <span class="o">=</span> <span class="n">_GetConsoleScreenBufferInfo</span><span class="p">(</span>
141 <span class="n">handle</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">csbi</span><span class="p">))</span>
142 <span class="k">return</span> <span class="n">csbi</span>
144 <div class="viewcode-block" id="SetConsoleTextAttribute"><a class="viewcode-back" href="../../../commands/apidoc/src.colorama.html#src.colorama.win32.SetConsoleTextAttribute">[docs]</a> <span class="k">def</span> <span class="nf">SetConsoleTextAttribute</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">attrs</span><span class="p">):</span>
145 <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
146 <span class="k">return</span> <span class="n">_SetConsoleTextAttribute</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">attrs</span><span class="p">)</span></div>
148 <span class="k">def</span> <span class="nf">SetConsoleCursorPosition</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">position</span><span class="p">,</span> <span class="n">adjust</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
149 <span class="n">position</span> <span class="o">=</span> <span class="n">COORD</span><span class="p">(</span><span class="o">*</span><span class="n">position</span><span class="p">)</span>
150 <span class="c1"># If the position is out of range, do nothing.</span>
151 <span class="k">if</span> <span class="n">position</span><span class="o">.</span><span class="n">Y</span> <span class="o"><=</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">position</span><span class="o">.</span><span class="n">X</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
152 <span class="k">return</span>
153 <span class="c1"># Adjust for Windows' SetConsoleCursorPosition:</span>
154 <span class="c1"># 1. being 0-based, while ANSI is 1-based.</span>
155 <span class="c1"># 2. expecting (x,y), while ANSI uses (y,x).</span>
156 <span class="n">adjusted_position</span> <span class="o">=</span> <span class="n">COORD</span><span class="p">(</span><span class="n">position</span><span class="o">.</span><span class="n">Y</span> <span class="o">-</span> <span class="mi">1</span><span class="p">,</span> <span class="n">position</span><span class="o">.</span><span class="n">X</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
157 <span class="k">if</span> <span class="n">adjust</span><span class="p">:</span>
158 <span class="c1"># Adjust for viewport's scroll position</span>
159 <span class="n">sr</span> <span class="o">=</span> <span class="n">GetConsoleScreenBufferInfo</span><span class="p">(</span><span class="n">STDOUT</span><span class="p">)</span><span class="o">.</span><span class="n">srWindow</span>
160 <span class="n">adjusted_position</span><span class="o">.</span><span class="n">Y</span> <span class="o">+=</span> <span class="n">sr</span><span class="o">.</span><span class="n">Top</span>
161 <span class="n">adjusted_position</span><span class="o">.</span><span class="n">X</span> <span class="o">+=</span> <span class="n">sr</span><span class="o">.</span><span class="n">Left</span>
162 <span class="c1"># Resume normal processing</span>
163 <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
164 <span class="k">return</span> <span class="n">_SetConsoleCursorPosition</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">adjusted_position</span><span class="p">)</span>
166 <span class="k">def</span> <span class="nf">FillConsoleOutputCharacter</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">char</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">start</span><span class="p">):</span>
167 <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
168 <span class="n">char</span> <span class="o">=</span> <span class="n">c_char</span><span class="p">(</span><span class="n">char</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>
169 <span class="n">length</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">(</span><span class="n">length</span><span class="p">)</span>
170 <span class="n">num_written</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
171 <span class="c1"># Note that this is hard-coded for ANSI (vs wide) bytes.</span>
172 <span class="n">success</span> <span class="o">=</span> <span class="n">_FillConsoleOutputCharacterA</span><span class="p">(</span>
173 <span class="n">handle</span><span class="p">,</span> <span class="n">char</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">num_written</span><span class="p">))</span>
174 <span class="k">return</span> <span class="n">num_written</span><span class="o">.</span><span class="n">value</span>
176 <span class="k">def</span> <span class="nf">FillConsoleOutputAttribute</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">start</span><span class="p">):</span>
177 <span class="sd">''' FillConsoleOutputAttribute( hConsole, csbi.wAttributes, dwConSize, coordScreen, &cCharsWritten )'''</span>
178 <span class="n">handle</span> <span class="o">=</span> <span class="n">handles</span><span class="p">[</span><span class="n">stream_id</span><span class="p">]</span>
179 <span class="n">attribute</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">WORD</span><span class="p">(</span><span class="n">attr</span><span class="p">)</span>
180 <span class="n">length</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">(</span><span class="n">length</span><span class="p">)</span>
181 <span class="n">num_written</span> <span class="o">=</span> <span class="n">wintypes</span><span class="o">.</span><span class="n">DWORD</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
182 <span class="c1"># Note that this is hard-coded for ANSI (vs wide) bytes.</span>
183 <span class="k">return</span> <span class="n">_FillConsoleOutputAttribute</span><span class="p">(</span>
184 <span class="n">handle</span><span class="p">,</span> <span class="n">attribute</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">num_written</span><span class="p">))</span>
186 <span class="k">def</span> <span class="nf">SetConsoleTitle</span><span class="p">(</span><span class="n">title</span><span class="p">):</span>
187 <span class="k">return</span> <span class="n">_SetConsoleTitleW</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
193 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
194 <div class="sphinxsidebarwrapper">
195 <p class="logo"><a href="../../../index.html">
196 <img class="logo" src="../../../_static/sat_v5.0.png" alt="Logo"/>
197 </a></p><div class="relations">
198 <h3>Related Topics</h3>
200 <li><a href="../../../index.html">Documentation overview</a><ul>
201 <li><a href="../../index.html">Module code</a><ul>
202 <li><a href="../../src.html">src</a><ul>
208 <div id="searchbox" style="display: none" role="search">
209 <h3>Quick search</h3>
210 <div class="searchformwrapper">
211 <form class="search" action="../../../search.html" method="get">
212 <input type="text" name="q" />
213 <input type="submit" value="Go" />
214 <input type="hidden" name="check_keywords" value="yes" />
215 <input type="hidden" name="area" value="default" />
219 <script type="text/javascript">$('#searchbox').show(0);</script>
222 <div class="clearer"></div>
228 Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
229 & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>