<!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"/>
<title>XCB: xcbext.h 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="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 style="padding-left: 0.5em;">
<div id="projectname">XCB
 <span id="projectnumber">1.9</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">xcbext.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2001-2004 Bart Massey and Jamey Sharp.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All Rights Reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * all copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Except as contained in this notice, the names of the authors or their</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * institutions shall not be used in advertising or otherwise to promote the</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * sale, use or other dealings in this Software without prior written</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * authorization from the authors.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef __XCBEXT_H</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="preprocessor">#define __XCBEXT_H</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="xcb_8h.html">xcb.h</a>"</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/* xcb_ext.c */</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="structxcb__extension__t.html"> 39</a></span> <span class="keyword">struct </span><a class="code" href="structxcb__extension__t.html">xcb_extension_t</a> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">int</span> global_id;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> };</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/* xcb_out.c */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="structxcb__protocol__request__t.html"> 47</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">size_t</span> count;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="structxcb__extension__t.html">xcb_extension_t</a> *ext;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  uint8_t opcode;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  uint8_t isvoid;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> } <a class="code" href="structxcb__protocol__request__t.html">xcb_protocol_request_t</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">enum</span> xcb_send_request_flags_t {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  XCB_REQUEST_CHECKED = 1 << 0,</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  XCB_REQUEST_RAW = 1 << 1,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  XCB_REQUEST_DISCARD_REPLY = 1 << 2</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> };</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> xcb_send_request(<a class="code" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <span class="keywordtype">int</span> flags, <span class="keyword">struct</span> <a class="code" href="structiovec.html">iovec</a> *vector, <span class="keyword">const</span> <a class="code" href="structxcb__protocol__request__t.html">xcb_protocol_request_t</a> *request);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">/* xcb_take_socket allows external code to ask XCB for permission to</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * take over the write side of the socket and send raw data with</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * xcb_writev. xcb_take_socket provides the sequence number of the last</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * request XCB sent. The caller of xcb_take_socket must supply a</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * callback which XCB can call when it wants the write side of the</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * socket back to make a request. This callback synchronizes with the</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * external socket owner and flushes any output queues if appropriate.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * If you are sending requests which won't cause a reply, please note the</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * comment for xcb_writev which explains some sequence number wrap issues.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * */</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">int</span> xcb_take_socket(<a class="code" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <span class="keywordtype">void</span> (*return_socket)(<span class="keywordtype">void</span> *closure), <span class="keywordtype">void</span> *closure, <span class="keywordtype">int</span> flags, uint64_t *sent);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/* You must own the write-side of the socket (you've called</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * xcb_take_socket, and haven't returned from return_socket yet) to call</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * xcb_writev. Also, the iovec must have at least 1 byte of data in it.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * You have to make sure that xcb can detect sequence number wraps correctly.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * This means that the first request you send after xcb_take_socket must cause a</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * reply (e.g. just insert a GetInputFocus request). After every (1 << 16) - 1</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * requests without a reply, you have to insert a request which will cause a</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * reply. You can again use GetInputFocus for this. You do not have to wait for</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * any of the GetInputFocus replies, but can instead handle them via</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * xcb_discard_reply(). */</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">int</span> xcb_writev(<a class="code" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <span class="keyword">struct</span> <a class="code" href="structiovec.html">iovec</a> *vector, <span class="keywordtype">int</span> count, uint64_t requests);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">/* xcb_in.c */</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">void</span> *xcb_wait_for_reply(<a class="code" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> request, <a class="code" href="structxcb__generic__error__t.html" title="Generic error.">xcb_generic_error_t</a> **e);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keywordtype">int</span> xcb_poll_for_reply(<a class="code" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> request, <span class="keywordtype">void</span> **reply, <a class="code" href="structxcb__generic__error__t.html" title="Generic error.">xcb_generic_error_t</a> **error);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">/* xcb_util.c */</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">int</span> xcb_popcount(uint32_t mask);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">int</span> xcb_sumof(uint8_t *list, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 22 2012 22:46:48 for XCB by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
