You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
373 lines
18 KiB
373 lines
18 KiB
<!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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Pin: PROTO API</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="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="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Pin
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- 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="summary">
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PROTO API</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:gacb4faa1f3649fce55756313c6259519f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROTO__API.html#gacb4faa1f3649fce55756313c6259519f">PIN_PARG</a>(t)   <a class="el" href="struct__PinPargClass.html">_PinPargClass</a><t>::parg()</td></tr>
|
|
<tr class="separator:gacb4faa1f3649fce55756313c6259519f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf8061627abf953100e29bd3f031ded2c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROTO__API.html#gaf8061627abf953100e29bd3f031ded2c">PIN_PARG_AGGREGATE</a>(t)   _PinParg(PARG_AGGREGATE, sizeof(t))</td></tr>
|
|
<tr class="separator:gaf8061627abf953100e29bd3f031ded2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3fbcb1f92a17fcc24febac0676165ca2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROTO__API.html#ga3fbcb1f92a17fcc24febac0676165ca2">PIN_PARG_ENUM</a>(t)   _PinParg(PARG_ENUM, sizeof(t))</td></tr>
|
|
<tr class="separator:ga3fbcb1f92a17fcc24febac0676165ca2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaeebb4a42707b704ebf214a06a6bf4e62"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROTO__API.html#gaeebb4a42707b704ebf214a06a6bf4e62">PIN_PARG_END</a>()   _PinParg(PARG_END, 0)</td></tr>
|
|
<tr class="separator:gaeebb4a42707b704ebf214a06a6bf4e62"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga554ff954c3ea33bb537f30e3b500ef1c"><td class="memItemLeft" align="right" valign="top">typedef PROTO_CLASS * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROTO__API.html#ga554ff954c3ea33bb537f30e3b500ef1c">PROTO</a></td></tr>
|
|
<tr class="separator:ga554ff954c3ea33bb537f30e3b500ef1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gacfd9f3c8dc22310ce9b9152e8c61b17c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROTO__API.html#gacfd9f3c8dc22310ce9b9152e8c61b17c">CALLINGSTD_TYPE</a> { <br />
|
|
  <b>CALLINGSTD_INVALID</b>,
|
|
<br />
|
|
  <b>CALLINGSTD_DEFAULT</b>,
|
|
<br />
|
|
  <b>CALLINGSTD_CDECL</b>,
|
|
<br />
|
|
  <b>CALLINGSTD_REGPARMS</b>,
|
|
<br />
|
|
  <b>CALLINGSTD_STDCALL</b>,
|
|
<br />
|
|
  <b>CALLINGSTD_ART</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:gacfd9f3c8dc22310ce9b9152e8c61b17c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga59e26fa7c51d677aaac419e05bfb1305"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROTO__API.html#ga59e26fa7c51d677aaac419e05bfb1305">PARG_TYPE</a> { <br />
|
|
  <b>PARG_INVALID</b>,
|
|
<br />
|
|
  <b>PARG_POINTER</b>,
|
|
<br />
|
|
  <b>PARG_BOOL</b>,
|
|
<br />
|
|
  <b>PARG_CHAR</b>,
|
|
<br />
|
|
  <b>PARG_UCHAR</b>,
|
|
<br />
|
|
  <b>PARG_SCHAR</b>,
|
|
<br />
|
|
  <b>PARG_SHORT</b>,
|
|
<br />
|
|
  <b>PARG_USHORT</b>,
|
|
<br />
|
|
  <b>PARG_INT</b>,
|
|
<br />
|
|
  <b>PARG_UINT</b>,
|
|
<br />
|
|
  <b>PARG_LONG</b>,
|
|
<br />
|
|
  <b>PARG_ULONG</b>,
|
|
<br />
|
|
  <b>PARG_LONGLONG</b>,
|
|
<br />
|
|
  <b>PARG_ULONGLONG</b>,
|
|
<br />
|
|
  <b>PARG_FLOAT</b>,
|
|
<br />
|
|
  <b>PARG_DOUBLE</b>,
|
|
<br />
|
|
  <b>PARG_VOID</b>,
|
|
<br />
|
|
  <b>PARG_ENUM</b>,
|
|
<br />
|
|
  <b>PARG_AGGREGATE</b>,
|
|
<br />
|
|
  <b>PARG_END</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ga59e26fa7c51d677aaac419e05bfb1305"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga83166e4f44766add35b740312e346054"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__PROTO__API.html#ga554ff954c3ea33bb537f30e3b500ef1c">PROTO</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROTO__API.html#ga83166e4f44766add35b740312e346054">LEVEL_PINCLIENT::PROTO_Allocate</a> (<a class="el" href="structPARG__T.html">PARG_T</a> returnArg, <a class="el" href="group__PROTO__API.html#gacfd9f3c8dc22310ce9b9152e8c61b17c">CALLINGSTD_TYPE</a> cstype, const char *name,...)</td></tr>
|
|
<tr class="separator:ga83166e4f44766add35b740312e346054"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga164ba9eb7fbd418343184b0e2c8a3ae6"><td class="memItemLeft" align="right" valign="top">VOID </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PROTO__API.html#ga164ba9eb7fbd418343184b0e2c8a3ae6">LEVEL_PINCLIENT::PROTO_Free</a> (<a class="el" href="group__PROTO__API.html#ga554ff954c3ea33bb537f30e3b500ef1c">PROTO</a> proto)</td></tr>
|
|
<tr class="separator:ga164ba9eb7fbd418343184b0e2c8a3ae6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>This API describes an application routine. </p>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="gacb4faa1f3649fce55756313c6259519f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacb4faa1f3649fce55756313c6259519f">◆ </a></span>PIN_PARG</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIN_PARG</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">t</td><td>)</td>
|
|
<td>   <a class="el" href="struct__PinPargClass.html">_PinPargClass</a><t>::parg()</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Macros used to simplify the passing of function prototype arguments. The macro will pass the type and size of each argument specified. When passing an argument to <a class="el" href="group__PROTO__API.html#ga83166e4f44766add35b740312e346054">PROTO_Allocate()</a>, use these macros. As an example, <a class="el" href="group__PROTO__API.html#gacb4faa1f3649fce55756313c6259519f">PIN_PARG(int)</a> will pass the PARG_TYPE PARG_INT and the size of an integer to <a class="el" href="group__PROTO__API.html#ga83166e4f44766add35b740312e346054">PROTO_Allocate()</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf8061627abf953100e29bd3f031ded2c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf8061627abf953100e29bd3f031ded2c">◆ </a></span>PIN_PARG_AGGREGATE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIN_PARG_AGGREGATE</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">t</td><td>)</td>
|
|
<td>   _PinParg(PARG_AGGREGATE, sizeof(t))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Type and size of an aggregate in <a class="el" href="group__PROTO__API.html#ga83166e4f44766add35b740312e346054">PROTO_Allocate()</a> See <a class="el" href="group__PROTO__API.html#gacb4faa1f3649fce55756313c6259519f">PIN_PARG</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaeebb4a42707b704ebf214a06a6bf4e62"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaeebb4a42707b704ebf214a06a6bf4e62">◆ </a></span>PIN_PARG_END</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIN_PARG_END</td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td>   _PinParg(PARG_END, 0)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Ends a list of arguments in <a class="el" href="group__PROTO__API.html#ga83166e4f44766add35b740312e346054">PROTO_Allocate()</a> See <a class="el" href="group__PROTO__API.html#gacb4faa1f3649fce55756313c6259519f">PIN_PARG</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3fbcb1f92a17fcc24febac0676165ca2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3fbcb1f92a17fcc24febac0676165ca2">◆ </a></span>PIN_PARG_ENUM</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PIN_PARG_ENUM</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">t</td><td>)</td>
|
|
<td>   _PinParg(PARG_ENUM, sizeof(t))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Type and size of an enum in <a class="el" href="group__PROTO__API.html#ga83166e4f44766add35b740312e346054">PROTO_Allocate()</a> See <a class="el" href="group__PROTO__API.html#gacb4faa1f3649fce55756313c6259519f">PIN_PARG</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="ga554ff954c3ea33bb537f30e3b500ef1c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga554ff954c3ea33bb537f30e3b500ef1c">◆ </a></span>PROTO</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef PROTO_CLASS* <a class="el" href="group__PROTO__API.html#ga554ff954c3ea33bb537f30e3b500ef1c">PROTO</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>List of function prototype arguments. See <a class="el" href="group__PROTO__API.html#ga83166e4f44766add35b740312e346054">PROTO_Allocate()</a> for its use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="gacfd9f3c8dc22310ce9b9152e8c61b17c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacfd9f3c8dc22310ce9b9152e8c61b17c">◆ </a></span>CALLINGSTD_TYPE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__PROTO__API.html#gacfd9f3c8dc22310ce9b9152e8c61b17c">CALLINGSTD_TYPE</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Type of calling standards used for compiling the function. See <a class="el" href="group__PROTO__API.html#ga83166e4f44766add35b740312e346054">PROTO_Allocate()</a> for its use. CALLINGSTD_DEFAULT is the default calling standard for the platform. This is the recommended option. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga59e26fa7c51d677aaac419e05bfb1305"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga59e26fa7c51d677aaac419e05bfb1305">◆ </a></span>PARG_TYPE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__PROTO__API.html#ga59e26fa7c51d677aaac419e05bfb1305">PARG_TYPE</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Function prototype argument types. See <a class="el" href="group__PROTO__API.html#ga83166e4f44766add35b740312e346054">PROTO_Allocate()</a> for its use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga83166e4f44766add35b740312e346054"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga83166e4f44766add35b740312e346054">◆ </a></span>PROTO_Allocate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__PROTO__API.html#ga554ff954c3ea33bb537f30e3b500ef1c">PROTO</a> LEVEL_PINCLIENT::PROTO_Allocate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structPARG__T.html">PARG_T</a> </td>
|
|
<td class="paramname"><em>returnArg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__PROTO__API.html#gacfd9f3c8dc22310ce9b9152e8c61b17c">CALLINGSTD_TYPE</a> </td>
|
|
<td class="paramname"><em>cstype</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Allocate and initialize a function prototype. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">returnArg</td><td>The return argument type and size. See <a class="el" href="group__PROTO__API.html#gacb4faa1f3649fce55756313c6259519f">PIN_PARG</a>. </td></tr>
|
|
<tr><td class="paramname">cstype</td><td>The calling standard used for compiling this function (CALLINGSTD_DEFAULT recommended). </td></tr>
|
|
<tr><td class="paramname">name</td><td>The name of the function. </td></tr>
|
|
<tr><td class="paramname">...</td><td>List of function argument type and size. See <a class="el" href="group__PROTO__API.html#gacb4faa1f3649fce55756313c6259519f">PIN_PARG</a> for the recommended method of passing function arguments. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>currently PARG_FLOAT, PARG_DOUBLE are supported as return type only and can not be used as function argument types. Any other PRG_* that does not fit in an integer register are not supported neither as function argument nor as return type of replacement functions.</dd></dl>
|
|
<p><a class="el" href="group__PROTO__API.html#gaeebb4a42707b704ebf214a06a6bf4e62">PIN_PARG_END()</a> must end the argument list, even if the function has no arguments. </p><dl class="section return"><dt>Returns</dt><dd>proto A pointer to a function prototype. This is an opaque type.</dd></dl>
|
|
<dl class="section user"><dt>Availability:</dt><dd><b>Mode:</b> JIT & Probe<br />
|
|
<b>O/S</b>: Linux, Windows & macOS*<br />
|
|
<b>CPU:</b> All<br />
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga164ba9eb7fbd418343184b0e2c8a3ae6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga164ba9eb7fbd418343184b0e2c8a3ae6">◆ </a></span>PROTO_Free()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">VOID LEVEL_PINCLIENT::PROTO_Free </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__PROTO__API.html#ga554ff954c3ea33bb537f30e3b500ef1c">PROTO</a> </td>
|
|
<td class="paramname"><em>proto</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Free the specified function prototype. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">proto</td><td>A pointer to a function prototype.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Availability:</dt><dd><b>Mode:</b> JIT & Probe<br />
|
|
<b>O/S</b>: Linux, Windows & macOS*<br />
|
|
<b>CPU:</b> All<br />
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|