hw/dmx/doc/html/dmxmap_8c.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html>
   3   <head>
   4     <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   5     <title>File Index</title>
   6     <link href="doxygen.css" rel="stylesheet" type="text/css">
   7   </head>
   8   <body>
   9 <!-- Generated by Doxygen 1.7.1 -->
  10 <div class="navigation" id="top">
  11   <div class="tabs">
  12     <ul class="tablist">
  13       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
  14       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16     </ul>
  17   </div>
  18   <div class="tabs2">
  19     <ul class="tablist">
  20       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
  21       <li><a href="globals.html"><span>Globals</span></a></li>
  22     </ul>
  23   </div>
  24 </div>
  25 <div class="header">
  26   <div class="summary">
  27 <a href="#func-members">Functions</a>  </div>
  28   <div class="headertitle">
  29 <h1>dmxmap.c File Reference</h1>  </div>
  30 </div>
  31 <div class="contents">
  32 <code>#include &quot;<a class="el" href="dmxinputinit_8h_source.html">dmxinputinit.h</a>&quot;</code><br/>
  33 <code>#include &quot;<a class="el" href="dmxmap_8h_source.html">dmxmap.h</a>&quot;</code><br/>
  34 <table class="memberdecls">
  35 <tr><td colspan="2"><h2><a name="func-members"></a>
  36 Functions</h2></td></tr>
  37 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="dmxmap_8c.html#ada5a28e0c746708e0f5c45e9e193d907">dmxMapInsert</a> (<a class="el" href="struct__DMXLocalInputInfo.html">DMXLocalInputInfoPtr</a> dmxLocal, int remoteEvent, int serverEvent)</td></tr>
  38 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="dmxmap_8c.html#a27107d43f96e7c09241d7ef0b5e9c0f5">dmxMapClear</a> (<a class="el" href="struct__DMXLocalInputInfo.html">DMXLocalInputInfoPtr</a> dmxLocal)</td></tr>
  39 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="dmxmap_8c.html#abc1a46c87c4acd45e4e5f79370be6169">dmxMapLookup</a> (<a class="el" href="struct__DMXLocalInputInfo.html">DMXLocalInputInfoPtr</a> dmxLocal, int remoteEvent)</td></tr>
  40 </table>
  41 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  42 <p>This file implements a mapping from remote XInput event types to Xdmx XInput event types.</p>
  43 <p>The exglobals.h file defines global server-side variables with names Device* to be integers that hold the value of the type of the server-side XInput extension event.</p>
  44 <p>The client-side X11/extensions/XInput.h file defines macros with THE EXACT SAME Device* names!</p>
  45 <p>Using those macros to extract remote server event type values from the (opaque) XDevice structure is appropriate, but makes a direct mapping to the Device* integers impossible. So we use the normalized XI_Device* names for these routines. </p>
  46 <hr/><h2>Function Documentation</h2>
  47 <a class="anchor" id="a27107d43f96e7c09241d7ef0b5e9c0f5"></a><!-- doxytag: member="dmxmap.c::dmxMapClear" ref="a27107d43f96e7c09241d7ef0b5e9c0f5" args="(DMXLocalInputInfoPtr dmxLocal)" -->
  48 <div class="memitem">
  49 <div class="memproto">
  50       <table class="memname">
  51         <tr>
  52           <td class="memname">void dmxMapClear </td>
  53           <td>(</td>
  54           <td class="paramtype"><a class="el" href="struct__DMXLocalInputInfo.html">DMXLocalInputInfoPtr</a>&nbsp;</td>
  55           <td class="paramname"> <em>dmxLocal</em></td>
  56           <td>&nbsp;)&nbsp;</td>
  57           <td></td>
  58         </tr>
  59       </table>
  60 </div>
  61 <div class="memdoc">
  62 <p>Remove all mappings there were inserted with <a class="el" href="dmxmap_8h.html#ada5a28e0c746708e0f5c45e9e193d907">dmxMapInsert</a>. </p>
  63
  64 <p>References <a class="el" href="struct__DMXLocalInputInfo.html#af8ea073e34c4e927f7f887603aaba17d">_DMXLocalInputInfo::map</a>, <a class="el" href="struct__DMXLocalInputInfo.html#a5595cf8656f17bceb30699a6d215afa5">_DMXLocalInputInfo::mapOptimize</a>, and <a class="el" href="struct__DMXEventMap.html#aafea1b880cf1b362c7e600b4285c08c3">_DMXEventMap::remote</a>.</p>
  65
  66 </div>
  67 </div>
  68 <a class="anchor" id="ada5a28e0c746708e0f5c45e9e193d907"></a><!-- doxytag: member="dmxmap.c::dmxMapInsert" ref="ada5a28e0c746708e0f5c45e9e193d907" args="(DMXLocalInputInfoPtr dmxLocal, int remoteEvent, int serverEvent)" -->
  69 <div class="memitem">
  70 <div class="memproto">
  71       <table class="memname">
  72         <tr>
  73           <td class="memname">void dmxMapInsert </td>
  74           <td>(</td>
  75           <td class="paramtype"><a class="el" href="struct__DMXLocalInputInfo.html">DMXLocalInputInfoPtr</a>&nbsp;</td>
  76           <td class="paramname"> <em>dmxLocal</em>, </td>
  77         </tr>
  78         <tr>
  79           <td class="paramkey"></td>
  80           <td></td>
  81           <td class="paramtype">int&nbsp;</td>
  82           <td class="paramname"> <em>remoteEvent</em>, </td>
  83         </tr>
  84         <tr>
  85           <td class="paramkey"></td>
  86           <td></td>
  87           <td class="paramtype">int&nbsp;</td>
  88           <td class="paramname"> <em>serverEvent</em></td><td>&nbsp;</td>
  89         </tr>
  90         <tr>
  91           <td></td>
  92           <td>)</td>
  93           <td></td><td></td><td></td>
  94         </tr>
  95       </table>
  96 </div>
  97 <div class="memdoc">
  98 <p>Create a mapping from <em>remoteEvent</em> to <em>serverEvent</em>. The <em>remoteEvent</em> is the type returned from the remote server. The <em>serverEvent</em> is from the XI_* list of events in include/extensions/XIproto.h. </p>
  99
 100 <p>References <a class="el" href="dmxlog_8c.html#ab6259430a57c3cffdfc9f6259df0ad23">dmxLog()</a>, <a class="el" href="dmxlog_8h.html#aeed612a5c0be196e23bd6b71b76b917fae81ae2a11fb7ab8eea902f609574210a">dmxWarning</a>, <a class="el" href="struct__DMXLocalInputInfo.html#af8ea073e34c4e927f7f887603aaba17d">_DMXLocalInputInfo::map</a>, <a class="el" href="struct__DMXLocalInputInfo.html#a5595cf8656f17bceb30699a6d215afa5">_DMXLocalInputInfo::mapOptimize</a>, <a class="el" href="struct__DMXEventMap.html#aafea1b880cf1b362c7e600b4285c08c3">_DMXEventMap::remote</a>, and <a class="el" href="struct__DMXEventMap.html#a6f3626351411d6a9555a16969761ec17">_DMXEventMap::server</a>.</p>
 101
 102 </div>
 103 </div>
 104 <a class="anchor" id="abc1a46c87c4acd45e4e5f79370be6169"></a><!-- doxytag: member="dmxmap.c::dmxMapLookup" ref="abc1a46c87c4acd45e4e5f79370be6169" args="(DMXLocalInputInfoPtr dmxLocal, int remoteEvent)" -->
 105 <div class="memitem">
 106 <div class="memproto">
 107       <table class="memname">
 108         <tr>
 109           <td class="memname">int dmxMapLookup </td>
 110           <td>(</td>
 111           <td class="paramtype"><a class="el" href="struct__DMXLocalInputInfo.html">DMXLocalInputInfoPtr</a>&nbsp;</td>
 112           <td class="paramname"> <em>dmxLocal</em>, </td>
 113         </tr>
 114         <tr>
 115           <td class="paramkey"></td>
 116           <td></td>
 117           <td class="paramtype">int&nbsp;</td>
 118           <td class="paramname"> <em>remoteEvent</em></td><td>&nbsp;</td>
 119         </tr>
 120         <tr>
 121           <td></td>
 122           <td>)</td>
 123           <td></td><td></td><td></td>
 124         </tr>
 125       </table>
 126 </div>
 127 <div class="memdoc">
 128 <p>Lookup a mapping for <em>remoteEvent</em>. The <em>remoteEvent</em> is the type returned from the remote server. The return value is that which was passed into <a class="el" href="dmxmap_8h.html#ada5a28e0c746708e0f5c45e9e193d907">dmxMapInsert</a> (i.e., a value from the XI_* list in include/extensions/XIproto.h). If a mapping is not available, -1 is returned. </p>
 129
 130 <p>References <a class="el" href="struct__DMXLocalInputInfo.html#af8ea073e34c4e927f7f887603aaba17d">_DMXLocalInputInfo::map</a>, <a class="el" href="struct__DMXLocalInputInfo.html#a5595cf8656f17bceb30699a6d215afa5">_DMXLocalInputInfo::mapOptimize</a>, <a class="el" href="struct__DMXEventMap.html#aafea1b880cf1b362c7e600b4285c08c3">_DMXEventMap::remote</a>, and <a class="el" href="struct__DMXEventMap.html#a6f3626351411d6a9555a16969761ec17">_DMXEventMap::server</a>.</p>
 131
 132 <p>Referenced by <a class="el" href="dmxevents_8c.html#ae0083a2b1547708473cbc75ebf0006ae">dmxTranslateAndEnqueueExtEvent()</a>.</p>
 133
 134 </div>
 135 </div>
 136 </div>
 137     <hr>
 138     <address>
 139       <small>
 140         Generated June 29, 2004 for <a
 141         href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
 142         <a href="http://www.doxygen.org/index.html">doxygen</a>
 143         1.3.4.
 144       </small>
 145     </addres>
 146     </hr>
 147   </body>
 148 </html>