<!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>
<title>Parrot - ncidef2asm.pl</title>
<link rel="stylesheet" type="text/css"
href="../../../resources/parrot.css"
media="all">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
</head>
<body>
<div id="wrapper">
<div id="header">
<a href="http://www.parrot.org">
<img border=0 src="../../../resources/parrot_logo.png" id="logo" alt="parrot">
</a>
</div> <!-- "header" -->
<div id="divider"></div>
<div id="mainbody">
<div id="breadcrumb">
<a href="../../../html/index.html">Home</a> » <a href="../../../html/tools.html">Tools</a> » ncidef2asm.pl
</div>
<h1><a name="ncidef2asm.pl"
>ncidef2asm.pl</a></h1>
<p>Take an NCI library definition file and turn it into a</p>
<h1><a name="Sections"
>Sections</a></h1>
<p>An NCI library definition file provides the information needed to generate a parrot wrapper for the named library (or libraries).
Its format is simple,
and looks like:</p>
<pre> [package]
ncurses
[lib]
libform.so
[defs]
p new_field i i i i i i
[lib]
libncurses.so
[defs]
i is_term_resized i i</pre>
<p>Note that the assembly file is generated in the order you specify, so if there are library dependencies, make sure you have them in the correct order.</p>
<h2><a name="package"
>package</a></h2>
<p>Declares the package that all subsequent sub PMCs will be put into. The name is a simple concatenation of the package name, double colon, and the routine name, with no preceding punctuation.</p>
<h2><a name="lib"
>lib</a></h2>
<p>The name of the library to be loaded. Should be as qualified as necessary for your platform--generally the full filename is required, though the directory generally isn't.</p>
<p>You may load multiple libraries here, but only the last one loaded will be exposed to subsequent defs.</p>
<h2><a name="defs"
>defs</a></h2>
<p>This section holds the definitions of functions. Each function is assumed to be in the immediate preceding library. The definition of the function is:</p>
<pre> return_type name [param [param [param ...]]]</pre>
<p>The param and return_type parameters use the NCI standard, which for reference is:</p>
<dl>
<dt><a name="p"
>p</a></dt>
Parameter is a void pointer, taken from the PMC's data pointer. PMC is assumed to be an unmanagedstruct or child class.Taken from a P register
<dt><a name="c"
>c</a></dt>
Parameter is a character.Taken from an I register
<dt><a name="s"
>s</a></dt>
Parameter is a shortTaken from an I register
<dt><a name="i"
>i</a></dt>
Parameter is an intTaken from an I register
<dt><a name="l"
>l</a></dt>
Parameter is a longTaken from an I register
<dt><a name="f"
>f</a></dt>
Paramter is a floatTaken from an N register.
<dt><a name="d"
>d</a></dt>
Parameter is a double.Taken from an N register.
<dt><a name="t"
>t</a></dt>
Paramter is a char *, presumably a C stringTaken from an S register
<dt><a name="v"
>v</a></dt>
Void. Only valid as a return type, noting that the function returns no data.
<dt><a name="I"
>I</a></dt>
Interpreter pointer. The current interpreter pointer is passed in
<dt><a name="P"
>P</a></dt>
PMC.
<dt><a name="2"
>2</a></dt>
Pointer to short.Taken from an I register.
<dt><a name="3"
>3</a></dt>
Pointer to int.Taken from an I register
<dt><a name="4"
>4</a></dt>
Pointer to longTaken from an I register</dl>
</div> <!-- "mainbody" -->
<div id="divider"></div>
<div id="footer">
Copyright © 2002-2009, Parrot Foundation.
</div>
</div> <!-- "wrapper" -->
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
cd14cddf3b3ceaf1193157472227757a
>
files
>
394
