You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by ge...@apache.org on 2005/12/01 07:04:00 UTC
svn commit: r350181 [46/198] - in
/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core: ./ depends/
depends/files/ depends/jars/ depends/libs/ depends/libs/linux.IA32/
depends/libs/win.IA32/ depends/oss/ depends/oss/linux.IA32/
depends/oss/win.I...
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/index.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/index.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/index.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/index.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,64 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: Main Page</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindexHL" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<h1>Harmony Class Library Porting Documentation</h1>
+<p>
+<h3 align="center">1.0 </h3><h2>Porting Structure</h2>
+<p>
+The class libraries use a number of external components to make them portable: <ul>
+<li>
+a Virtual Machine (VM), </li>
+<li>
+platform porting, threading, zip support, and pooling libraries, and </li>
+<li>
+existing open source floating point (<a href="http://www.netlib.org/fdlibm/readme">fdlibm</a>) and compression (<a href="http://www.gzip.org/zlib/">zlib</a>) libraries. </li>
+</ul>
+The figure below shows how these components relate to one another and identifies a "VM interface" which is explained in the next section.<p>
+<div align="center">
+<img src="vmport.gif" alt="vmport.gif">
+<p><strong>Porting Structure</strong></p></div>
+ <h2>Porting to Alternate VMs</h2>
+<p>
+<br>
+ The class libraries are comprised of Java code and JNI native code. One of the design objectives of the class libraries enables them to be ported to alternate VMs. To support the class libraries, the VM Vendor must implement a C interface known as the <a href="group__VMInterface.html">VM Interface</a> and a Java interface consisting of a small number of Java classes known as the <a href="../../kernel_doc/html/index.html#KernelJavaClasses">Kernel Java classes</a>.<p>
+The Kernel classes are considered part of the VM component since the VM and these classes may understand each other's implementations rather than necessarily only using each other's external public interfaces. The VM is responsible for providing the implementation of the Kernel classes, although reference implementations of parts of these classes are provided as a possible starting point.<p>
+The C <a href="group__VMInterface.html">VM Interface</a> exposes VM entry points required by the class library JNI natives.<p>
+<div align="center">
+<img src="vminterfaces.gif" alt="vminterfaces.gif">
+<p><strong>VM C and Java Interfaces</strong></p></div>
+ Implementations of platform porting, threading, compression, and floating point libraries are provided with the class library code. These libraries are described in the list of so-called <a href="modules.html">'modules'</a> generated from the source code by doxygen. A doxygen module is simply a named collection of items from the source code. The documented <a href="group__HarmonyNatives.html">Harmony Natives</a>, <a href="group__Port.html">Port</a>, <a href="group__Thread.html">Thread</a>, <a href="group__ZipSupport.html">Zip Support</a>, and <a href="group__Pool.html">Pool</a> modules are part of the contribution. The <a href="http://www.gzip.org/zlib/">zlib</a> compression library, used by the Zip Support, and the <a href="http://www.netlib.org/fdlibm/readme">fdlibm</a> floating point library come from existing open source projects.<p>
+So the minimum that a VM Vendor must supply is an implementation of the VM Interface and Kernel Java Classes.<p>
+<h2>Physical Packaging</h2>
+<p>
+The packaging of Harmony code and a VM into executable programs and DLLs is shown below with an indication of how these link together.<p>
+<div align="center">
+<img src="packaging.gif" alt="packaging.gif">
+<p><strong>Physical Packaging</strong></p></div>
+ <a class="anchor" name="Booting"></a><h2>Booting</h2>
+<p>
+A launcher is provided that demonstrates the boot sequence for the VM and class library code. The sample launcher can be used by any VM that implements the class library and VM interface.<p>
+The sequence is shown below:<p>
+<ol>
+<li>
+<a class="el" href="group__Port.html#CreatePortLib">Create the port library.</a> </li>
+<li>
+Load the <a class="el" href="group__HarmonyNatives.html">Natives library</a> and call <a class="el" href="mathglob_8c.html#a3">JNI_OnLoad()</a> to initialize the library. Note that the <a class="el" href="group__HarmonyNatives.html">VM library</a> will use the <a class="el" href="group__VMInterface.html">VM Interface</a>. </li>
+<li>
+The VM needs to be configured to use the boot classpath. The boot classpath is a list of JAR files which contain the bootstrap Java class library code. The launcher provides a command-line prepend of the kernel (VM-specific) classes to the VM by specifying -Xbootclasspath/p to loads the kernel classes from the VM-specific subdirectory of jre. The boot sequence configures the bootstrap class path in the <a class="el" href="archiveglob_8c.html#a3">JNI_OnLoad()</a> function and updates the "com.ibm.oti.system.class.path" system property using the <a class="el" href="group__VMInterface.html">VM Interface</a>. Currently this is accomplished by reading the bootstrap entries from the <em>bootclasspath.properties</em> file located in the <em>jre/lib/boot</em> directory. </li>
+<li>
+The VM should create the system ThreadGroup by calling the <a class="elRef" doxygen="doxy_tag:../../kernel_doc/html/" href="../../kernel_doc/html/classjava_1_1lang_1_1ThreadGroup.html#a0">ThreadGroup constructor</a>, and stores it in a private field of <a class="elRef" doxygen="doxy_tag:../../kernel_doc/html/" href="../../kernel_doc/html/classjava_1_1lang_1_1Thread.html">java.lang.Thread</a>. </li>
+<li>
+The VM calls a private <a class="elRef" doxygen="doxy_tag:../../kernel_doc/html/" href="../../kernel_doc/html/classjava_1_1lang_1_1Thread.html">java.lang.Thread</a> constructor to initialize a new Thread. This constructor creates the "main" ThreadGroup by calling this <a class="elRef" doxygen="doxy_tag:../../kernel_doc/html/" href="../../kernel_doc/html/classjava_1_1lang_1_1ThreadGroup.html#a0">ThreadGroup constructor</a>, and the rest of the class library is loaded as a side effect of initializing the Thread object. </li>
+</ol>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/installdox
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/installdox?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/installdox (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/installdox Wed Nov 30 21:29:27 2005
@@ -0,0 +1,117 @@
+#!/usr/bin/perl
+
+%subst = ( "doxy_tag", "");
+$quiet = 0;
+
+if (open(F,"search.cfg"))
+{
+ $_=<F> ; s/[ \t\n]*$//g ; $subst{"_doc"} = $_;
+ $_=<F> ; s/[ \t\n]*$//g ; $subst{"_cgi"} = $_;
+}
+
+while ( @ARGV ) {
+ $_ = shift @ARGV;
+ if ( s/^-// ) {
+ if ( /^l(.*)/ ) {
+ $v = ($1 eq "") ? shift @ARGV : $1;
+ ($v =~ /\/$/) || ($v .= "/");
+ $_ = $v;
+ if ( /(.+)\@(.+)/ ) {
+ if ( exists $subst{$1} ) {
+ $subst{$1} = $2;
+ } else {
+ print STDERR "Unknown tag file $1 given with option -l\n";
+ &usage();
+ }
+ } else {
+ print STDERR "Argument $_ is invalid for option -l\n";
+ &usage();
+ }
+ }
+ elsif ( /^q/ ) {
+ $quiet = 1;
+ }
+ elsif ( /^\?|^h/ ) {
+ &usage();
+ }
+ else {
+ print STDERR "Illegal option -$_\n";
+ &usage();
+ }
+ }
+ else {
+ push (@files, $_ );
+ }
+}
+
+foreach $sub (keys %subst)
+{
+ if ( $subst{$sub} eq "" )
+ {
+ print STDERR "No substitute given for tag file `$sub'\n";
+ &usage();
+ }
+ elsif ( ! $quiet && $sub ne "_doc" && $sub ne "_cgi" )
+ {
+ print "Substituting $subst{$sub} for each occurence of tag file $sub\n";
+ }
+}
+
+if ( ! @files ) {
+ if (opendir(D,".")) {
+ foreach $file ( readdir(D) ) {
+ $match = ".html";
+ next if ( $file =~ /^\.\.?$/ );
+ ($file =~ /$match/) && (push @files, $file);
+ ($file =~ "tree.js") && (push @files, $file);
+ }
+ closedir(D);
+ }
+}
+
+if ( ! @files ) {
+ print STDERR "Warning: No input files given and none found!\n";
+}
+
+foreach $f (@files)
+{
+ if ( ! $quiet ) {
+ print "Editing: $f...\n";
+ }
+ $oldf = $f;
+ $f .= ".bak";
+ unless (rename $oldf,$f) {
+ print STDERR "Error: cannot rename file $oldf\n";
+ exit 1;
+ }
+ if (open(F,"<$f")) {
+ unless (open(G,">$oldf")) {
+ print STDERR "Error: opening file $oldf for writing\n";
+ exit 1;
+ }
+ if ($oldf ne "tree.js") {
+ while (<F>) {
+ s/doxygen\=\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\" (href|src)=\"\2/doxygen\=\"$1:$subst{$1}\" \3=\"$subst{$1}/g;
+ print G "$_";
+ }
+ }
+ else {
+ while (<F>) {
+ s/\"([^ \"\:\t\>\<]*)\:([^ \"\t\>\<]*)\", \"\2/\"$1:$subst{$1}\" ,\"$subst{$1}/g;
+ print G "$_";
+ }
+ }
+ }
+ else {
+ print STDERR "Warning file $f does not exist\n";
+ }
+ unlink $f;
+}
+
+sub usage {
+ print STDERR "Usage: installdox [options] [html-file [html-file ...]]\n";
+ print STDERR "Options:\n";
+ print STDERR " -l tagfile\@linkName tag file + URL or directory \n";
+ print STDERR " -q Quiet mode\n\n";
+ exit 1;
+}
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/jclglob__harmony_8c.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/jclglob__harmony_8c.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/jclglob__harmony_8c.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/jclglob__harmony_8c.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,350 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: native-src/win.IA32/archive/jclglob_harmony.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<div class="nav">
+<a class="el" href="dir_000000.html">native-src</a> » <a class="el" href="dir_000001.html">win.IA32</a> » <a class="el" href="dir_000002.html">archive</a></div>
+<h1>jclglob_harmony.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Harmony natives initialization API.
+<p>
+
+<p>
+<code>#include <string.h></code><br>
+<code>#include "jcl.h"</code><br>
+<code>#include "jclglob.h"</code><br>
+<code>#include "zipsup.h"</code><br>
+<code>#include "<a class="el" href="hypool_8h.html">hypool.h</a>"</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="jclglob__harmony_8c.html#a2">props_file_entry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="jclglob__harmony_8c.html#a2">props_file_entry</a></td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">A structure that captures a single key-value setting from the properties file. <a href="#a2"></a><br></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">jint </td><td class="memItemRight" valign="bottom"><a class="el" href="jclglob__harmony_8c.html#a4">decodeProperty</a> (<a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, char **scanCursor, HyPool *properties)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Scans the buffer specified by scanCursor and attempts to locate the next key-value pair separated by the '=' sign, and terminated by the platform line delimiter. <a href="#a4"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">jint </td><td class="memItemRight" valign="bottom"><a class="el" href="jclglob__harmony_8c.html#a5">readPropertiesFile</a> (<a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary, char *filename, HyPool *properties)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the properties file specified by <code>filename</code> into the pool of <code>properties</code>. <a href="#a5"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">jint </td><td class="memItemRight" valign="bottom"><a class="el" href="jclglob__harmony_8c.html#a8">readClassPathFromPropertiesFile</a> (JavaVM *vm)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes the bootstrap classpath used by the VM. <a href="#a8"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="jclglob__harmony_8c.html#a9">concat</a> (<a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary,...)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Concatenates a variable number of null-terminated strings into a single string using the specified port library to allocate memory. <a href="#a9"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">jint JNICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="jclglob__harmony_8c.html#a10">JNI_OnLoad</a> (JavaVM *vm, void *reserved)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">This DLL is being loaded, do any initialization required. <a href="#a10"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void JNICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="jclglob__harmony_8c.html#a11">JNI_OnUnload</a> (JavaVM *vm, void *reserved)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">This DLL is being unloaded, do any clean up required. <a href="#a11"></a><br></td></tr>
+</table>
+<hr><h2>Typedef Documentation</h2>
+<a class="anchor" name="a2"></a><!-- doxytag: member="jclglob_harmony.c::props_file_entry" ref="a2" args="" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">typedef struct <a class="el" href="jclglob__harmony_8c.html#a2">props_file_entry</a> <a class="el" href="jclglob__harmony_8c.html#a2">props_file_entry</a> </td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+A structure that captures a single key-value setting from the properties file.
+<p>
+ </td>
+ </tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a9"></a><!-- doxytag: member="jclglob_harmony.c::concat" ref="a9" args="(HyPortLibrary *portLibrary,...)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">static char * concat </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top"><a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap> </td>
+ <td class="mdname" nowrap> <em>...</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Concatenates a variable number of null-terminated strings into a single string using the specified port library to allocate memory.
+<p>
+The variable number of strings arguments must be terminated by a single NULL value.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>portLibrary</em> </td><td>- The port library used to allocate memory. </td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>The concatenated string.</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a4"></a><!-- doxytag: member="jclglob_harmony.c::decodeProperty" ref="a4" args="(HyPortLibrary *portLibrary, char **scanCursor, HyPool *properties)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">static jint decodeProperty </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top"><a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>char ** </td>
+ <td class="mdname" nowrap> <em>scanCursor</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>HyPool * </td>
+ <td class="mdname" nowrap> <em>properties</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Scans the buffer specified by scanCursor and attempts to locate the next key-value pair separated by the '=' sign, and terminated by the platform line delimiter.
+<p>
+If a key-value pair is located a new props_file_entry structure will be allocated in the <code>properties</code> pool, and the key and value will be copied. The scanCursor will be advanced past the entire property entry on success.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>portLibrary</em> </td><td>- The port library used to interact with the platform. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>scanCursor</em> </td><td>- A null-terminated string containing one or more (or partial) properties. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>properties</em> </td><td>- A pool from which props_file_entry structures are allocated.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>The number of properties read, -1 on error. </dd></dl>
+<dl compact><dt><b>Note:</b></dt><dd>This function modifies the buffer as properties are consumed.</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a10"></a><!-- doxytag: member="jclglob_harmony.c::JNI_OnLoad" ref="a10" args="(JavaVM *vm, void *reserved)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">jint JNICALL JNI_OnLoad </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">JavaVM * </td>
+ <td class="mdname" nowrap> <em>vm</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>reserved</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+This DLL is being loaded, do any initialization required.
+<p>
+This may be called more than once. </td>
+ </tr>
+</table>
+<a class="anchor" name="a11"></a><!-- doxytag: member="jclglob_harmony.c::JNI_OnUnload" ref="a11" args="(JavaVM *vm, void *reserved)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">void JNICALL JNI_OnUnload </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">JavaVM * </td>
+ <td class="mdname" nowrap> <em>vm</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>reserved</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+This DLL is being unloaded, do any clean up required.
+<p>
+This may be called more than once!! </td>
+ </tr>
+</table>
+<a class="anchor" name="a8"></a><!-- doxytag: member="jclglob_harmony.c::readClassPathFromPropertiesFile" ref="a8" args="(JavaVM *vm)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">static jint readClassPathFromPropertiesFile </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">JavaVM * </td>
+ <td class="mdname1" valign="top" nowrap> <em>vm</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Initializes the bootstrap classpath used by the VM.
+<p>
+Stores the result into a system property named 'com.ibm.oti.system.class.path'.<p>
+Reads the bootclasspath.properties file a line at a time<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>vm</em> </td><td>- The JavaVM from which port library and VMI interfaces can be obtained.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>- JNI_OK on success.</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a5"></a><!-- doxytag: member="jclglob_harmony.c::readPropertiesFile" ref="a5" args="(HyPortLibrary *portLibrary, char *filename, HyPool *properties)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">static jint readPropertiesFile </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top"><a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>char * </td>
+ <td class="mdname" nowrap> <em>filename</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>HyPool * </td>
+ <td class="mdname" nowrap> <em>properties</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Read the properties file specified by <code>filename</code> into the pool of <code>properties</code>.
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>portLibrary</em> </td><td>- The port library used to interact with the platform. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>- The file from which to read data using hyfile* functions. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>properties</em> </td><td>- A pool that will contain property file entries.</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>JNI_OK on success, or a JNI error code on failure.</dd></dl>
+ </td>
+ </tr>
+</table>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/luniglob_8c.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/luniglob_8c.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/luniglob_8c.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/luniglob_8c.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,159 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: native-src/linux.IA32/luni/luniglob.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.5 -->
+<div class="tabs">
+ <ul>
+ <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 id="current"><a href="files.html"><span>Files</span></a></li>
+ <li><a href="dirs.html"><span>Directories</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ </ul></div>
+<div class="tabs">
+ <ul>
+ <li><a href="files.html"><span>File List</span></a></li>
+ <li><a href="globals.html"><span>Globals</span></a></li>
+ </ul></div>
+<div class="nav">
+<a class="el" href="dir__2Fhome_2Fgharley_2Fclear_2Fbuilding_2FProject_5FClear_5FContribution_2FHarmony_2Fnative_2Dsrc_2F.html">native-src</a> » <a class="el" href="dir__2Fhome_2Fgharley_2Fclear_2Fbuilding_2FProject_5FClear_5FContribution_2FHarmony_2Fnative_2Dsrc_2Flinux_2EIA32_2F.html">linux.IA32</a> » <a class="el" href="dir__2Fhome_2Fgharley_2Fclear_2Fbuilding_2FProject_5FClear_5FContribution_2FHarmony_2Fnative_2Dsrc_2Flinux_2EIA32_2Fluni_2F.html">luni</a></div>
+<h1>luniglob.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Harmony LUNI natives initialization API.
+<p>
+
+<p>
+<code>#include <string.h></code><br>
+<code>#include "jcl.h"</code><br>
+<code>#include "jclglob.h"</code><br>
+<code>#include "<a class="el" href="hypool_8h.html">hypool.h</a>"</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="luniglob_8c.html#f498cc90a88ad840258b78af7f354e53">props_file_entry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="luniglob_8c.html#f498cc90a88ad840258b78af7f354e53">props_file_entry</a></td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">A structure that captures a single key-value setting from the properties file. <a href="#f498cc90a88ad840258b78af7f354e53"></a><br></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">jint JNICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="luniglob_8c.html#07082d72f8e72980a93861c1e153b8c3">JNI_OnLoad</a> (JavaVM *vm, void *reserved)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">This DLL is being loaded, do any initialization required. <a href="#07082d72f8e72980a93861c1e153b8c3"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void JNICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="luniglob_8c.html#f3affe82103499e260d109e90aea173c">JNI_OnUnload</a> (JavaVM *vm, void *reserved)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">This DLL is being unloaded, do any clean up required. <a href="#f3affe82103499e260d109e90aea173c"></a><br></td></tr>
+</table>
+<hr><h2>Typedef Documentation</h2>
+<a class="anchor" name="f498cc90a88ad840258b78af7f354e53"></a><!-- doxytag: member="luniglob.c::props_file_entry" ref="f498cc90a88ad840258b78af7f354e53" args="" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">typedef struct <a class="el" href="luniglob_8c.html#f498cc90a88ad840258b78af7f354e53">props_file_entry</a> <a class="el" href="luniglob_8c.html#f498cc90a88ad840258b78af7f354e53">props_file_entry</a> </td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+A structure that captures a single key-value setting from the properties file.
+<p>
+ </td>
+ </tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="07082d72f8e72980a93861c1e153b8c3"></a><!-- doxytag: member="luniglob.c::JNI_OnLoad" ref="07082d72f8e72980a93861c1e153b8c3" args="(JavaVM *vm, void *reserved)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">jint JNICALL JNI_OnLoad </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">JavaVM * </td>
+ <td class="mdname" nowrap> <em>vm</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>reserved</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+This DLL is being loaded, do any initialization required.
+<p>
+This may be called more than once. </td>
+ </tr>
+</table>
+<a class="anchor" name="f3affe82103499e260d109e90aea173c"></a><!-- doxytag: member="luniglob.c::JNI_OnUnload" ref="f3affe82103499e260d109e90aea173c" args="(JavaVM *vm, void *reserved)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">void JNICALL JNI_OnUnload </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">JavaVM * </td>
+ <td class="mdname" nowrap> <em>vm</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>reserved</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+This DLL is being unloaded, do any clean up required.
+<p>
+This may be called more than once!! </td>
+ </tr>
+</table>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/mathglob_8c.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/mathglob_8c.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/mathglob_8c.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/mathglob_8c.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,114 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: native-src/win.IA32/math/mathglob.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<div class="nav">
+<a class="el" href="dir_000000.html">native-src</a> » <a class="el" href="dir_000001.html">win.IA32</a> » <a class="el" href="dir_000003.html">math</a></div>
+<h1>mathglob.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Harmony Math natives initialization API.
+<p>
+
+<p>
+<code>#include <string.h></code><br>
+<code>#include "jcl.h"</code><br>
+<code>#include "jclglob.h"</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">jint JNICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="mathglob_8c.html#a3">JNI_OnLoad</a> (JavaVM *vm, void *reserved)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">This DLL is being loaded, do any initialization required. <a href="#a3"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void JNICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="mathglob_8c.html#a4">JNI_OnUnload</a> (JavaVM *vm, void *reserved)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">This DLL is being unloaded, do any clean up required. <a href="#a4"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a3"></a><!-- doxytag: member="mathglob.c::JNI_OnLoad" ref="a3" args="(JavaVM *vm, void *reserved)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">jint JNICALL JNI_OnLoad </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">JavaVM * </td>
+ <td class="mdname" nowrap> <em>vm</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>reserved</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+This DLL is being loaded, do any initialization required.
+<p>
+This may be called more than once. </td>
+ </tr>
+</table>
+<a class="anchor" name="a4"></a><!-- doxytag: member="mathglob.c::JNI_OnUnload" ref="a4" args="(JavaVM *vm, void *reserved)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">void JNICALL JNI_OnUnload </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">JavaVM * </td>
+ <td class="mdname" nowrap> <em>vm</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>reserved</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+This DLL is being unloaded, do any clean up required.
+<p>
+This may be called more than once!! </td>
+ </tr>
+</table>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/modules.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/modules.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/modules.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/modules.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: Module Index</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindexHL" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<h1>Harmony Class Library Porting Modules</h1>Here is a list of all modules:<ul>
+<li><a class="el" href="group__VMInterface.html">VM Interface</a>
+<li><a class="el" href="group__HarmonyNatives.html">Harmony JCL Natives</a>
+<li><a class="el" href="group__Port.html">Port</a>
+<li><a class="el" href="group__Thread.html">Thread</a>
+<li><a class="el" href="group__ZipSupport.html">Zip Support</a>
+<li><a class="el" href="group__Pool.html">Pool</a>
+</ul>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/packaging.gif
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/packaging.gif?rev=350181&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/packaging.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pages.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pages.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pages.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pages.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,19 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: Page Index</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindexHL" href="pages.html">Related Pages</a></div>
+<h1>Harmony Class Library Porting Related Pages</h1>Here is a list of all related documentation pages:<ul>
+<li><a class="el" href="deprecated.html">Deprecated List</a>
+
+</ul>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pool_8c.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pool_8c.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pool_8c.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pool_8c.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,564 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: native-src/win.IA32/pool/pool.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<div class="nav">
+<a class="el" href="dir_000000.html">native-src</a> » <a class="el" href="dir_000001.html">win.IA32</a> » <a class="el" href="dir_000006.html">pool</a></div>
+<h1>pool.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Pool primitives (creation, iteration, deletion, etc.
+<p>
+)
+<p>
+<code>#include <stdio.h></code><br>
+<code>#include <stdlib.h></code><br>
+<code>#include <string.h></code><br>
+<code>#include "<a class="el" href="hypool_8h.html">hypool.h</a>"</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HyPool *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a4">pool_new</a> (U_32 structSize, U_32 minNumberElements, U_32 elementAlignment, UDATA poolFlags, void *(VMCALL *memAlloc)(void *, U_32), void(VMCALL *memFree)(void *, void *), void *userData)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a5">pool_kill</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocates all memory associated with a pool. <a href="#a5"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a6">pool_newElement</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Asks for the address of a new pool element. <a href="#a6"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a7">pool_removeElement</a> (HyPool *aPool, void *anElement)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocates an element from a pool. <a href="#a7"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a8">pool_do</a> (HyPool *aPool, void(*aFunction)(void *anElement, void *userData), void *userData)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Calls a user provided function for each element in the list. <a href="#a8"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">UDATA VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a9">pool_numElements</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elements in a given pool. <a href="#a9"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a10">pool_startDo</a> (HyPool *aPool, pool_state *lastHandle)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a11">pool_nextDo</a> (pool_state *lastHandle)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a12">pool_sortFree</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Sorts the free list of the current pool. <a href="#a12"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HyPool *VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a13">pool_forPortLib</a> (U_32 structSize, <a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> *portLibrary)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for <a class="el" href="pool_8c.html#pool_new">pool_new</a>, using the default malloc/free from the portLibrary. <a href="#a13"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool_8c.html#a14">pool_clear</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the contents of a pool but not delete it. <a href="#a14"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a14"></a><!-- doxytag: member="pool.c::pool_clear" ref="a14" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_clear </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Clear the contents of a pool but not delete it.
+<p>
+<dl compact><dt><b>Note:</b></dt><dd>Make no assumptions about the contents of the pool after invoking this method (it currently does not zero the memory)</dd></dl>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td>The pool to clear</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a8"></a><!-- doxytag: member="pool.c::pool_do" ref="a8" args="(HyPool *aPool, void(*aFunction)(void *anElement, void *userData), void *userData)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_do </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname" nowrap> <em>aPool</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void(*)(void *anElement, void *userData) </td>
+ <td class="mdname" nowrap> <em>aFunction</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>userData</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Calls a user provided function for each element in the list.
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td>The pool to "do" things to </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aFunction</em> </td><td>Pointer to function which will "do" things to the elements of aPool </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>userData</em> </td><td>Pointer to data to be passed to "do" function, along with each pool-element</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+<dl compact><dt><b>See also:</b></dt><dd>pool_startDo, pool_nextDo</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a13"></a><!-- doxytag: member="pool.c::pool_forPortLib" ref="a13" args="(U_32 structSize, HyPortLibrary *portLibrary)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_forPortLib </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">U_32 </td>
+ <td class="mdname" nowrap> <em>structSize</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap><a class="el" href="structHyPortLibrary.html">HyPortLibrary</a> * </td>
+ <td class="mdname" nowrap> <em>portLibrary</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Shortcut for <a class="el" href="pool_8c.html#pool_new">pool_new</a>, using the default malloc/free from the portLibrary.
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>structSize</em> </td><td>size of pool-element </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>portLibrary</em> </td><td></td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>pointer to a Pool</dd></dl>
+<dl compact><dt><b>See also:</b></dt><dd>pool_new</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a5"></a><!-- doxytag: member="pool.c::pool_kill" ref="a5" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_kill </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Deallocates all memory associated with a pool.
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td>Pool to be deallocated</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a4"></a><!-- doxytag: member="pool.c::pool_new" ref="a4" args="(U_32 structSize, U_32 minNumberElements, U_32 elementAlignment, UDATA poolFlags, void *(VMCALL *memAlloc)(void *, U_32), void(VMCALL *memFree)(void *, void *), void *userData)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_new </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">U_32 </td>
+ <td class="mdname" nowrap> <em>structSize</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>U_32 </td>
+ <td class="mdname" nowrap> <em>minNumberElements</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>U_32 </td>
+ <td class="mdname" nowrap> <em>elementAlignment</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>UDATA </td>
+ <td class="mdname" nowrap> <em>poolFlags</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap>(VMCALL *memAlloc)(void *, U_32), </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void(VMCALL *memFree)(void *, void *) </td>
+ <td class="mdname" nowrap>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>userData</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+<h2><a class="anchor" name="pool_new">
+pool_new</a></h2>
+Returns a handle to a variable sized pool of structures. This handle should be passed into all other pool functions.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>structSize</em> </td><td>Size of the pool-elements </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>minNumberElements</em> </td><td>If zero, will default to 1 </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>elementAlignment</em> </td><td>If zero will default to MIN_GRANULARITY </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>poolFlags</em> </td><td></td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>memAlloc</em> </td><td>Allocate function pointer </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>memFree</em> </td><td>Free function pointer </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>userData</em> </td><td></td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>pointer to a new pool</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a6"></a><!-- doxytag: member="pool.c::pool_newElement" ref="a6" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_newElement </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Asks for the address of a new pool element.
+<p>
+If it succeeds, the address returned will have space for one element of the correct structure size. The contents of the element are undefined. If the current pool is full, a new one will be grafted onto the end of the pool chain and memory from there will be used.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td></td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>NULL on error <p>
+pointer to a new element otherwise</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a11"></a><!-- doxytag: member="pool.c::pool_nextDo" ref="a11" args="(pool_state *lastHandle)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_nextDo </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">pool_state * </td>
+ <td class="mdname1" valign="top" nowrap> <em>lastHandle</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+<h2><a class="anchor" name="pool_nextDo">
+pool_nextDo</a></h2>
+Continue an iteration based on state passed in by lastHandle. It is safe to stop an iteration midway through.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>lastHandle</em> </td><td>pointer for current iteration state</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>NULL nothing more to be done <p>
+pointer to next element to be processed otherwise</dd></dl>
+<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="hypool_8h.html#a12">pool_do</a>, pool_startDo</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a9"></a><!-- doxytag: member="pool.c::pool_numElements" ref="a9" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_numElements </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Returns the number of elements in a given pool.
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td></td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on error <p>
+the number of elements in the pool otherwise</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a7"></a><!-- doxytag: member="pool.c::pool_removeElement" ref="a7" args="(HyPool *aPool, void *anElement)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_removeElement </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname" nowrap> <em>aPool</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>void * </td>
+ <td class="mdname" nowrap> <em>anElement</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Deallocates an element from a pool.
+<p>
+It is safe to call <a class="el" href="pool_8c.html#a7">pool_removeElement()</a> while looping over the pool with <a class="el" href="pool_8c.html#pool_startDo">pool_startDo</a> / <a class="el" href="pool_8c.html#pool_nextDo">pool_nextDo</a> on the element returned by those calls. This is because the free element is always inserted at either the head of the free list or before the nextFree element in the pool_state.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td></td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>anElement</em> </td><td>Pointer to the element to be removed</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a12"></a><!-- doxytag: member="pool.c::pool_sortFree" ref="a12" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_sortFree </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Sorts the free list of the current pool.
+<p>
+(ie: does not follow nextPool pointers...) This is a O(n) most of the time.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td>The pool to be sorted</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>none</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a10"></a><!-- doxytag: member="pool.c::pool_startDo" ref="a10" args="(HyPool *aPool, pool_state *lastHandle)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">pool_startDo </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname" nowrap> <em>aPool</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>pool_state * </td>
+ <td class="mdname" nowrap> <em>lastHandle</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+<h2><a class="anchor" name="pool_startDo">
+pool_startDo</a></h2>
+Start of an iteration set that will return when code is to be executed. This is based strongly on pool_sortFreeAndIterateUsed. Pass in a pointer to an empty pool_state and it will be filled in.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td>The pool to "do" things to </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>lastHandle</em> </td><td></td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>NULL <p>
+pointer to element otherwise</dd></dl>
+<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="hypool_8h.html#a12">pool_do</a>, pool_nextDo</dd></dl>
+ </td>
+ </tr>
+</table>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pool__cap_8c.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pool__cap_8c.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pool__cap_8c.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/pool__cap_8c.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,122 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: native-src/win.IA32/pool/pool_cap.c File Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<div class="nav">
+<a class="el" href="dir_000000.html">native-src</a> » <a class="el" href="dir_000001.html">win.IA32</a> » <a class="el" href="dir_000006.html">pool</a></div>
+<h1>pool_cap.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Pool-capacity functions.
+<p>
+
+<p>
+<code>#include <stdio.h></code><br>
+<code>#include <stdlib.h></code><br>
+<code>#include <string.h></code><br>
+<code>#include "<a class="el" href="hypool_8h.html">hypool.h</a>"</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">UDATA VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool__cap_8c.html#a4">pool_ensureCapacity</a> (HyPool *aPool, UDATA newCapacity)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Ensures that the pool is large enough for newCapacity elements. <a href="#a4"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">UDATA VMCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="pool__cap_8c.html#a5">pool_capacity</a> (HyPool *aPool)</td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the total capacity of a pool. <a href="#a5"></a><br></td></tr>
+</table>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="a5"></a><!-- doxytag: member="pool_cap.c::pool_capacity" ref="a5" args="(HyPool *aPool)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">UDATA VMCALL pool_capacity </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname1" valign="top" nowrap> <em>aPool</em> </td>
+ <td class="md" valign="top"> ) </td>
+ <td class="md" nowrap></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Returns the total capacity of a pool.
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td>The pool</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on error <p>
+numElements in aPool otherwise</dd></dl>
+ </td>
+ </tr>
+</table>
+<a class="anchor" name="a4"></a><!-- doxytag: member="pool_cap.c::pool_ensureCapacity" ref="a4" args="(HyPool *aPool, UDATA newCapacity)" --><p>
+<table class="mdTable" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top">UDATA VMCALL pool_ensureCapacity </td>
+ <td class="md" valign="top">( </td>
+ <td class="md" nowrap valign="top">HyPool * </td>
+ <td class="mdname" nowrap> <em>aPool</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td class="md"></td>
+ <td class="md" nowrap>UDATA </td>
+ <td class="mdname" nowrap> <em>newCapacity</em></td>
+ </tr>
+ <tr>
+ <td class="md"></td>
+ <td class="md">) </td>
+ <td class="md" colspan="2"></td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing="5" cellpadding="0" border="0">
+ <tr>
+ <td>
+
+ </td>
+ <td>
+
+<p>
+Ensures that the pool is large enough for newCapacity elements.
+<p>
+This has the side effect of setting the POOL_NEVER_FREE_PUDDLES flag. Without this, the pool could shrink back down to its original size. Note that this does not take into account the number of elements already used in the pool.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aPool</em> </td><td>The pool </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>newCapacity</em> </td><td>The desired new-size of the pool</td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>0 on success <p>
+-1 on failure</dd></dl>
+ </td>
+ </tr>
+</table>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>
Added: incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/structGCStatus.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/structGCStatus.html?rev=350181&view=auto
==============================================================================
--- incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/structGCStatus.html (added)
+++ incubator/harmony/enhanced/trunk/sandbox/contribs/ibm_core/doc/vm_doc/html/structGCStatus.html Wed Nov 30 21:29:27 2005
@@ -0,0 +1,25 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>Harmony Class Library Porting: GCStatus Struct Reference</title>
+<link href="hydoxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.4.4 -->
+<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<h1>GCStatus Struct Reference</h1><!-- doxytag: class="GCStatus" --><code>#include <jni.h></code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+GCStatus structure.
+<p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+</table>
+<hr>The documentation for this struct was generated from the following file:<ul>
+<li>native-src/win.IA32/include/jni.h</ul>
+<hr size="1">
+<address style="text-align: center;">
+ <small>
+ (c) Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
+ </small>
+</address>
+</body>
+</html>