<html>
<head>
<title>Embryo: Virtual Machine Functions</title>
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
<meta name="author" content="Andres Blanc" >
<link rel="icon" href="img/favicon.png" type="image/x-icon">
<link rel="shortcut icon" href="img/favicon.png" type="image/x-icon">
<link rel="icon" href="img/favicon.png" type="image/ico">
<link rel="shortcut icon" href="img/favicon.png" type="image/ico">
<link rel="stylesheet" type="text/css" media="screen" href="e.css">
<link rel="stylesheet" type="text/css" media="screen" href="edoxy.css">
</head>
<body>
<div id="container">
<div id="header">
<div class="layout">
<h1><span>Enlightenment</span></h1>
<h2><span>Beauty at your fingertips</span></h2>
<div class="menu-container">
<div class="menu">
<ul>
<li class="current"><a href="http://web.enlightenment.org/p.php?p=docs">Docs</a></li>
<li><a href="http://trac.enlightenment.org/e">Tracker</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=contact">Contact</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=support">Support</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=download">Download</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=about">About</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=news">News</a></li>
<li><a href="http://www.enlightenment.org/">Home</a></li>
</ul>
</div>
</div>
<div class="doxytitle">
Embryo Documentation <small>at Tue Feb 8 2011</small>
</div>
<div class="menu-container">
<div class="submenu">
<ul class="current">
<li><a href="todo.html">Todo</a></li>
<li><a href="files.html">Files</a></li>
<li><a href="annotated.html">Data Structures</a></li>
<li><a href="globals.html">Globals</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="pages.html">Related Pages</a></li>
<li class="current"><a href="index.html">Main Page</a></li>
</ul>
</div>
</div>
<div class="clear"></div>
</div>
</div>
<div id="content">
<div class="layout">
<!-- Generated by Doxygen 1.7.3 -->
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Virtual Machine Functions</h1> </div>
</div>
<div class="contents">
<p>Functions that deal with creating and destroying virtual machine sessions for a given program.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Embryo__Program__VM__Group.html#ga6f85080c0f9c9d99190ccf1bdfb60a88">embryo_program_vm_reset</a> (Embryo_Program *ep)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets the current virtual machine session of the given program. <a href="#ga6f85080c0f9c9d99190ccf1bdfb60a88"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Embryo__Program__VM__Group.html#ga4c0362643f9ae872754caabe32ad9764">embryo_program_vm_push</a> (Embryo_Program *ep)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a new virtual machine session for the given program. <a href="#ga4c0362643f9ae872754caabe32ad9764"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Embryo__Program__VM__Group.html#ga41d2fb01dff4ca61a4eb47554d4859fe">embryo_program_vm_pop</a> (Embryo_Program *ep)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frees the current virtual machine session associated with the given program. <a href="#ga41d2fb01dff4ca61a4eb47554d4859fe"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Functions that deal with creating and destroying virtual machine sessions for a given program. </p>
<p>A given embryo program can have multiple virtual machine sessions running. This is useful when you have a native call that in turn calls a function in the embryo program. The native call can start a new virtual machine session to run the function it needs. Once completed, the session can be popped off the program's stack, and the native call can return its value to the old session.</p>
<p>A new virtual machine session is created by pushing a new virtual machine onto the session stack of a program using <a class="el" href="group__Embryo__Program__VM__Group.html#ga4c0362643f9ae872754caabe32ad9764">embryo_program_vm_push</a>. The current virtual machine session can be destroyed by calling <a class="el" href="group__Embryo__Program__VM__Group.html#ga41d2fb01dff4ca61a4eb47554d4859fe">embryo_program_vm_pop</a>. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga41d2fb01dff4ca61a4eb47554d4859fe"></a><!-- doxytag: member="embryo_amx.c::embryo_program_vm_pop" ref="ga41d2fb01dff4ca61a4eb47554d4859fe" args="(Embryo_Program *ep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void embryo_program_vm_pop </td>
<td>(</td>
<td class="paramtype">Embryo_Program * </td>
<td class="paramname"><em>ep</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frees the current virtual machine session associated with the given program. </p>
<p>See <a class="el" href="group__Embryo__Program__VM__Group.html">Virtual Machine Functions</a> for more information about how this works. Note that you will need to retrieve any return data or data on the stack before you pop.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ep</td><td>The given program. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga4c0362643f9ae872754caabe32ad9764"></a><!-- doxytag: member="embryo_amx.c::embryo_program_vm_push" ref="ga4c0362643f9ae872754caabe32ad9764" args="(Embryo_Program *ep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void embryo_program_vm_push </td>
<td>(</td>
<td class="paramtype">Embryo_Program * </td>
<td class="paramname"><em>ep</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts a new virtual machine session for the given program. </p>
<p>See <a class="el" href="group__Embryo__Program__VM__Group.html">Virtual Machine Functions</a> for more information about how this works.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ep</td><td>The given program. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="group__Embryo__Program__VM__Group.html#ga6f85080c0f9c9d99190ccf1bdfb60a88">embryo_program_vm_reset()</a>.</p>
</div>
</div>
<a class="anchor" id="ga6f85080c0f9c9d99190ccf1bdfb60a88"></a><!-- doxytag: member="embryo_amx.c::embryo_program_vm_reset" ref="ga6f85080c0f9c9d99190ccf1bdfb60a88" args="(Embryo_Program *ep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void embryo_program_vm_reset </td>
<td>(</td>
<td class="paramtype">Embryo_Program * </td>
<td class="paramname"><em>ep</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the current virtual machine session of the given program. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ep</td><td>The given program. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="group__Embryo__Program__VM__Group.html#ga4c0362643f9ae872754caabe32ad9764">embryo_program_vm_push()</a>.</p>
</div>
</div>
</div>
<div id="push"></div>
</div> <!-- #content -->
</div> <!-- .layout -->
</div> <!-- #container -->
<div id="footer">
<table><tr>
<td class="poweredby"><img src="doxygen.png"></td>
<td class="copyright">Copyright ©2011 Enlightenment</td>
<td class="generated">Docs generated Tue Feb 8 2011 18:11:42</td>
</tr></table>
</div>
</body>
</html>
