You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by bu...@apache.org on 2016/09/28 12:07:52 UTC
svn commit: r998475 [2/26] - in /websites/staging/lucy/trunk/content: ./
docs/ docs/0.5.0/ docs/0.5.0/c/ docs/0.5.0/c/Clownfish/
docs/0.5.0/c/Clownfish/Docs/ docs/0.5.0/c/Lucy/ docs/0.5.0/c/Lucy/Analysis/
docs/0.5.0/c/Lucy/Docs/ docs/0.5.0/c/Lucy/Docs/...
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Docs/BuildingProjects.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Docs/BuildingProjects.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Docs/BuildingProjects.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,177 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Clownfish::Docs::BuildingProjects</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Clownfish/">Clownfish</a> » <a href="/docs/0.5.0/c/Clownfish/Docs/">Docs</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Building Apache Clownfish projects in C environments</h2>
+<p>The following steps are required to build a project that uses
+Apache Clownfish:</p>
+<ul>
+<li>Run the <code>cfc</code> command-line application (Clownfish compiler) to
+generate C headers, C source files, and documentation.</li>
+<li>Include the C headers generated by the Clownfish compiler in your
+own code to <a href="../../Clownfish/Docs/ClassIntro.html">work with Clownfish objects</a>.</li>
+<li>Compile an additional C source file generated by CFC.</li>
+<li>Link your object code, the object code from the generated file,
+and the Clownfish runtime library.</li>
+</ul>
+<h3>Running cfc</h3>
+<pre><code>cfc [--source=<dir>] [--include=<dir>] [--parcel=<name>]
+ --dest=<dir>
+ [--header=<file>] [--footer=<file>]
+</code></pre>
+<h4>–source</h4>
+<p>Every <code>--source</code> argument adds a directory to the list of source
+directories to search for source parcels. For every source parcel
+found, CFC generates C headers, a C source file, and documentation.</p>
+<p>The source directories are scanned for Clownfish parcel definitions
+(<code>.cfp</code>), Clownfish headers (<code>.cfh</code>), and standalone documentation
+in Markdown format (<code>.md</code>).</p>
+<p>This option may be specified multiple times.</p>
+<h4>–include</h4>
+<p>Every <code>--include</code> argument adds a directory to the list of include
+directories. CFC generates C headers for parcels from an include
+directory only if they’re required by a source parcel or if they’re
+specified with the <code>--parcel</code> option. Only C headers are generated
+for included parcels, no C source code or documentation.</p>
+<p>The include directories are scanned for Clownfish parcel
+definitions (<code>.cfp</code>) and Clownfish headers (<code>.cfh</code>).</p>
+<p>After the directories specified on the command-line, the following
+directories are processed:</p>
+<ul>
+<li>Directories from the environment variable <code>CLOWNFISH_INCLUDE</code>.
+This variable contains a colon-separated list of directories.</li>
+<li>On UNIX-like systems <code>/usr/local/share/clownfish/include</code> and
+<code>/usr/share/clownfish/include</code>.</li>
+</ul>
+<p>This option may be specified multiple times.</p>
+<h4>–parcel</h4>
+<p>Adds a parcel to the list of prerequisite parcels to make sure that
+its C headers are generated. This is useful when running without the
+<code>--source</code> option. For example, a project that doesn’t define its
+own Clownfish classes can generate the C headers for the Clownfish
+runtime with:</p>
+<pre><code>cfc --parcel=Clownfish --dest=autogen
+</code></pre>
+<p>This option may be specified multiple times.</p>
+<h4>–dest</h4>
+<p>The destination directory for generated files. By convention,
+the name <code>autogen</code> is used.</p>
+<p>CFC creates the following subdirectories in the destination
+directory:</p>
+<ul>
+<li><code>include</code> contains generated C headers.</li>
+<li><code>sources</code> contains generated C source files.</li>
+<li><code>man</code> contains generated man pages.</li>
+<li><code>share/doc/clownfish</code> contains generated HTML documentation.</li>
+</ul>
+<p>This option is required.</p>
+<h4>–header</h4>
+<p>Specifies a file whose contents are added as a comment on top of
+each generated file.</p>
+<h4>–footer</h4>
+<p>Specifies a file whose contents are added as a comment on the
+bottom of each generated file.</p>
+<h3>Including the generated C headers</h3>
+<p>The C header files generated with <code>cfc</code> can be found in
+<code>autogen/include</code>. You should add this directory to your compiler’s
+search path, for example using <code>-Iautogen/include</code> under GCC.</p>
+<p>One C header file is generated for every Clownfish header (.cfh) file.
+C code that makes use of a class defined in the .cfh file must include
+the respective C header. The Clownfish compiler also creates a few
+other internal C header files.</p>
+<h3>Compiling the generated source files</h3>
+<p><code>cfc</code> creates one source file for every parcel in
+<code>autogen/sources/{parcel_nick}_parcel.c</code>. These files must be
+compiled with <code>autogen/include</code> added to the header search path.</p>
+<h3>Linking</h3>
+<p>When linking, add the object files of the CFC-generated code created
+in the previous step. You must also link the shared library of the
+Clownfish runtime (<code>-lcfish</code> under GCC).</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Docs/ClassIntro.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Docs/ClassIntro.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Docs/ClassIntro.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,163 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Clownfish::Docs::ClassIntro</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Clownfish/">Clownfish</a> » <a href="/docs/0.5.0/c/Clownfish/Docs/">Docs</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Working with Apache Clownfish classes in C</h2>
+<h3>Inititalizing Clownfish parcels</h3>
+<p>Every Clownfish parcel must be initialized before it is used. The
+initialization function is named <code>{parcel_nick}_bootstrap_parcel</code> and
+takes no arguments.</p>
+<p>Example:</p>
+<pre><code>cfish_bootstrap_parcel();
+</code></pre>
+<h3>Including the generated header file</h3>
+<p>To use Clownfish classes from C code, the header file generated by the
+Clownfish compiler must be included. The name of the C header is
+derived from the name of the Clownfish <code>.cfh</code> header. It can also be
+found in the class documentation.</p>
+<p>Typically, the “short name macro” should be defined before including a
+Clownfish header. Its name is derived from the parcel nickname and has
+the form <code>{PARCEL_NICK}_USE_SHORT_NAMES</code>. If the short name macro is in
+effect, you don’t have to worry about parcel prefixes.</p>
+<p>Example:</p>
+<pre><code>#define CFISH_USE_SHORT_NAMES
+
+#include <Clownfish/String.h>
+#include <Clownfish/Vector.h>
+</code></pre>
+<h3>Function and method prefixes</h3>
+<p>Clownfish classes can have a “nickname” – a shorter version of the
+class name that is used for function and method prefixes. The nickname
+can be found in the class documentation.</p>
+<p>For example the String class has the nickname <code>Str</code>.</p>
+<h3>Creating objects</h3>
+<p>A Clownfish object is an opaque struct referenced by pointer.</p>
+<p>Most classes come with one or more constructors. On the C level, a
+constructor is simply an “inert” function of a class that returns a
+new object. In Clownfish parlance, an inert function is any function
+in a class that isn’t a method, similar to static methods in Java or
+static member functions in C++.</p>
+<p>Example:</p>
+<pre><code>// Notice the use of nickname "Str" in the constructor prefix.
+String *name = Str_newf("%s %s", first, last);
+</code></pre>
+<h3>Calling methods</h3>
+<p>Calling methods is straightforward. The invocant is always passed as
+first argument.</p>
+<pre><code>// Notice the use of nickname "Str" in the method prefix.
+size_t len = Str_Length(name);
+</code></pre>
+<p>Method names always start with an uppercase letter.</p>
+<h3>Memory management</h3>
+<p>Clownfish uses reference counting to manage memory. Constructors, but
+also some methods, return an “incremented” object. If you’re done with
+an incremented object, you must decrease its reference count to avoid
+leaking memory. Use the <code>DECREF</code> macro to release an object:</p>
+<pre><code>DECREF(name);
+</code></pre>
+<p>Some other methods return non-incremented objects. If you want to retain
+a reference to such an object, you must increase its reference count
+using the <code>INCREF</code> macro to make sure it won’t be destroyed too early:</p>
+<pre><code>obj = INCREF(obj);
+</code></pre>
+<p>This invocation of INCREF must be matched by a DECREF when you’re done
+with the object.</p>
+<p>Some methods, for example in container classes, take “decremented”
+objects as arguments. From the caller’s perspective, passing a
+decremented argument is equivalent to passing a non-decremented argument
+and calling DECREF afterwards. Typically, this avoids a call to DECREF
+in the calling code. But sometimes, it must be compensated with an
+INCREF.</p>
+<h3>Further reading</h3>
+<ul>
+<li><a href="../../Clownfish/Docs/BuildingProjects.html">Building Clownfish projects in C environments</a></li>
+<li><a href="../../Clownfish/Docs/WritingClasses.html">Writing Clownfish classes</a></li>
+</ul>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Docs/WritingClasses.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Docs/WritingClasses.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Docs/WritingClasses.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,567 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Clownfish::Docs::WritingClasses</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Clownfish/">Clownfish</a> » <a href="/docs/0.5.0/c/Clownfish/Docs/">Docs</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Writing Apache Clownfish classes</h2>
+<h3>Parcels</h3>
+<p>Every Clownfish class belongs to a Clownfish parcel. Parcels are used for
+namespacing and versioning. Information about parcels is stored in <code>.cfp</code>
+files which contain a JSON hash with the following keys:</p>
+<ul>
+<li>
+<p><strong>name:</strong> The parcel’s name. It must contain only letters.</p>
+</li>
+<li>
+<p><strong>nickname:</strong> A short nickname. It must contain only letters. This nickname,
+followed by an underscore, is used to prefix generated C symbols and
+macros. Depending on the kind of symbol, a lowercase or uppercase prefix
+will be used.</p>
+</li>
+<li>
+<p><strong>version:</strong> A version specifier of the following form (without whitespace):</p>
+<pre><code>version-specifier = "v" version-number
+version-number = digit+ | digit+ "." version-number
+</code></pre>
+</li>
+<li>
+<p><strong>prerequisites:</strong> A hash containing the prerequisite parcels. The hash keys
+are the parcel names. The values contain the minimum required version.</p>
+</li>
+</ul>
+<p>An example <code>.cfp</code> file might look like:</p>
+<pre><code>{
+ "name": "Pathfinder",
+ "nickname": "Pfind",
+ "version": "v2.3.8",
+ "prerequisites": {
+ "Clownfish": "v0.5.0"
+ }
+}
+</code></pre>
+<p>A parcel specifier of the following form is used in Clownfish header files:</p>
+<pre><code>parcel-specifier = "parcel" parcel-name ";"
+parcel-name = identifier
+</code></pre>
+<p>For example:</p>
+<pre><code>parcel Pathfinder;
+</code></pre>
+<p>Every <code>.cfh</code> file starts with a parcel specifier containing the name of
+the parcel for all classes in the header file.</p>
+<h4>Initialization</h4>
+<p>Every Clownfish parcel must be initialized before it is used. The
+initialization function is named <code>{parcel_nick}_bootstrap_parcel</code> and takes
+no arguments.</p>
+<p>Example call:</p>
+<pre><code>pfind_bootstrap_parcel();
+</code></pre>
+<p>The generated host language bindings call the bootstrap function
+automatically. C projects must call the function manually.</p>
+<h4>Short names</h4>
+<p>If a macro with the uppercase name <code>{PARCEL_NICK}_USE_SHORT_NAMES</code> is
+defined before including a generated C header, additional macros without the
+parcel prefix will be defined for most symbols.</p>
+<p>Example:</p>
+<pre><code>#define PFIND_USE_SHORT_NAMES
+#include <Pathfinder/Graph.h>
+#include <Pathfinder/Path.h>
+
+/* Prefixes can be omitted. */
+Path *path = Graph_Find_Shortest_Path(graph);
+
+/* Without PFIND_USE_SHORT_NAMES, one would have to write: */
+pfind_Path *path = PFIND_Graph_Find_Shortest_Path(graph);
+</code></pre>
+<p>For object types in Clownfish header files, prefixes of class structs can
+also be omitted unless multiple parcels declare classes with the same last
+component of the class name.</p>
+<h4>The “Clownfish” parcel</h4>
+<p>The Clownfish runtime classes live in a parcel named <code>Clownfish</code> with
+nickname <code>Cfish</code>. Consequently, the short name macro is named
+<code>CFISH_USE_SHORT_NAMES</code>.</p>
+<h3>Declaring classes</h3>
+<p>Classes are declared in Clownfish header files using a declaration of the
+following form:</p>
+<pre><code>class-declaration = class-exposure-specifier?
+ class-modifier*
+ "class" class-name
+ ("nickname" class-nickname)?
+ ("inherits" class-name)?
+ "{" class-contents "}"
+class-exposure-specifier = "public"
+class-modifier = "inert" | "final"
+class-name = identifier | identifier "::" class-name
+class-nickname = identifier
+class-contents = (variable-declaration | function-declaration)*
+</code></pre>
+<p>Class name components must start with an uppercase letter and must not contain
+underscores. The last component must contain at least one lowercase letter and
+must be unique for every class in a parcel.</p>
+<p>For every class, a type with the name <code>{parcel_nick}_{Class_Last_Comp}</code>
+is defined in the generated C header. This is an opaque typedef used to
+ensure type safety.</p>
+<p>For every class, a global variable with the uppercase name
+<code>{PARCEL_NICK}_{CLASS_LAST_COMP}</code> is defined. This variable is a pointer to
+a Clownfish::Class object which is initialized when bootstrapping the parcel.</p>
+<p>Non-inert classes inherit from Clownfish::Obj by default.</p>
+<p>Example of a class declaration:</p>
+<pre><code>parcel Pathfinder;
+
+public class Pathfinder::Graph::VisibilityGraph nickname VisGraph
+ extends Clownfish::Obj {
+ /* Variables and functions */
+}
+</code></pre>
+<p>This will generate:</p>
+<pre><code>typedef struct pfind_VisibilityGraph pfind_VisibilityGraph;
+extern cfish_Class *PFIND_VISIBILITYGRAPH;
+</code></pre>
+<h4>Class exposure</h4>
+<p>API documentation will only be generated for classes with <code>public</code> exposure.</p>
+<h4>Inert classes</h4>
+<p>Inert classes must contain only inert variables or inert functions, that is,
+neither instance variables nor methods. They must not inherit from another
+class nor be inherited from. They’re essentially nothing more than a
+namespace for functions and global variables.</p>
+<h4>Final classes</h4>
+<p>For final classes, every method is made final, regardless of the method
+modifier. Final classes must not be inherited from.</p>
+<h3>Variables</h3>
+<p>Variables are declared with a declaration of the following form:</p>
+<pre><code>variable-declaration = variable-modifier*
+ type variable-name ";"
+variable-modifier = "inert"
+variable-name = identifier
+</code></pre>
+<h4>Inert variables</h4>
+<p>Inert variables are global class variables of which only a single copy
+exists. They are declared in the generated C header with the name
+<code>{parcel_nick}_{Class_Nick}_{Variable_Name}</code> and must be defined in a C
+source file.</p>
+<p>Example:</p>
+<pre><code>public class Pathfinder::Path {
+ public inert int max_path_length;
+}
+</code></pre>
+<p>This will generate:</p>
+<pre><code>extern int pfind_Path_max_path_length;
+</code></pre>
+<p>The C source file defining the variable will typically use short names. So the
+definition will look like:</p>
+<pre><code>int Path_max_path_length = 5000;
+</code></pre>
+<h4>Instance variables</h4>
+<p>Non-inert variables are instance variables and added to the class’s ivars
+struct.</p>
+<p>Example:</p>
+<pre><code>public class Pathfinder::Path {
+ int num_nodes;
+
+ public int
+ Get_Num_Nodes(Path *self);
+}
+</code></pre>
+<p>This will add a <code>num_nodes</code> member to the ivars struct of <code>Path</code>.</p>
+<h4>The ivars struct</h4>
+<p>To access instance variables, the macro <code>C_{PARCEL_NICK}_{CLASS_LAST_COMP}</code>
+must be defined before including the generated header file. This will make
+a struct named <code>{parcel_nick}_{Class_Name}IVARS</code> with a corresponding
+typedef and short name available that contains all instance variables
+of the class and all superclasses from the same parcel. Instance
+variables defined in other parcels are not accessible. This is by
+design to guarantee ABI stability if the instance variable layout
+of a superclass from another parcel changes in a different version.
+If you need to access an instance variable from another parcel,
+add accessor methods.</p>
+<p>A pointer to the ivars struct can be obtained by calling an inline
+function named <code>{parcel_nick}_{Class_Name}_IVARS</code>. This function
+takes the object of the class (typically <code>self</code>) as argument.</p>
+<p>Example using short names:</p>
+<pre><code>#define C_PFIND_PATH
+#define PFIND_USE_SHORT_NAMES
+#include "Pathfinder/Path.h"
+
+int
+Path_get_num_nodes(Path *self) {
+ PathIVARS *ivars = Path_IVARS(self);
+ return ivars->num_nodes;
+}
+</code></pre>
+<h3>Functions</h3>
+<pre><code>function-declaration = function-exposure-specifier?
+ function-modifier*
+ return-type function-name
+ "(" param-list? ")" ";"
+function-exposure-specifier = "public"
+function-modifier = "inert" | "inline" | "abstract" | "final"
+return-type = return-type-qualifier* type
+return-type-qualifier = "incremented" | "nullable"
+function-name = identifier
+param-list = param | param "," param-list
+param = param-qualifier* type param-name ("=" scalar-constant)?
+param-name = identifier
+param-qualifier = "decremented"
+</code></pre>
+<h4>Function exposure</h4>
+<p>API documentation will only be generated for functions with <code>public</code> exposure.</p>
+<h4>Inert functions</h4>
+<p>Inert functions are dispatched statically. They are declared in the generated
+C header with the name <code>{parcel_nick}_{Class_Nick}_{Function_Name}</code>
+and must be defined in a C source file. They must be neither abstract nor
+final.</p>
+<p>Example:</p>
+<pre><code>public class Pathfinder::Graph::VisibilityGraph nickname VisGraph
+ extends Clownfish::Obj {
+
+ public inert incremented VisibilityGraph*
+ new(int node_capacity);
+}
+</code></pre>
+<p>This will generate:</p>
+<pre><code>pfind_VisibilityGraph*
+pfind_VisGraph_new(int node_capacity);
+</code></pre>
+<p>The C source file implementing the inert function will typically use short
+names. So the implementation will look like:</p>
+<pre><code>#define PFIND_USE_SHORT_NAMES
+#include "Pathfinder/Graph/VisibilityGraph.h"
+
+VisibilityGraph*
+VisGraph_new(int node_capacity) {
+ /* Implementation */
+}
+</code></pre>
+<h4>Inline functions</h4>
+<p>Inert functions can be inline. They should be defined as static inline
+functions in a C block in the Clownfish header file. The macro <code>CFISH_INLINE</code>
+expands to the C compiler’s inline keyword and should be used for portability.</p>
+<h4>Methods</h4>
+<p>Non-inert functions are dynamically dispatched methods. Their name must start
+with an uppercase letter and every underscore must be followed by an uppercase
+letter. Methods must not be declared inline.</p>
+<p>The first parameter of a method must be a pointer to an object of the method’s
+class which receives the object on which the method was invoked. By convention,
+this parameter is named <code>self</code>.</p>
+<p>For every method, an inline wrapper for dynamic dispatch is defined in
+the generated C header with the name
+<code>{PARCEL_NICK}_{Class_Nick}_{Method_Name}</code>. Additionally, an
+implementing function is declared with the name
+<code>{PARCEL_NICK}_{Class_Nick}_{Method_Name}_IMP</code>. The Clownfish compiler also
+generates a typedef for the method’s function pointer type named
+<code>{PARCEL_NICK}_{Class_Nick}_{Method_Name}_t</code>. Wrappers and typedefs are
+created for all subclasses whether they override a method or not.</p>
+<p>Example:</p>
+<pre><code>public class Pathfinder::Graph::VisibilityGraph nickname VisGraph
+ extends Clownfish::Obj {
+
+ public void
+ Add_Node(VisibilityGraph *self, decremented Node *node);
+}
+</code></pre>
+<p>This will generate:</p>
+<pre><code>/* Wrapper for dynamic dispatch */
+static inline void
+PFIND_VisGraph_Add_Node(pfind_VisibilityGraph *self, pfind_Node *node) {
+ /* Inline code for wrapper */
+}
+
+/* Declaration of implementing function */
+void
+PFIND_VisGraph_Add_Node_IMP(pfind_VisibilityGraph *self,
+ pfind_Node *node);
+
+/* Declaration of function pointer type */
+typedef void
+(*PFIND_VisGraph_Add_Node_t)(pfind_VisibilityGraph *self,
+ pfind_Node *node);
+</code></pre>
+<p>The implementing function of non-abstract methods must be defined in a C source
+file. This file will typically define the short names macro. So the
+implementation will look like:</p>
+<pre><code>#define PFIND_USE_SHORT_NAMES
+#include "Pathfinder/Graph/VisibilityGraph.h"
+
+void
+VisGraph_Add_Node_IMP(VisibilityGraph *self, Node *node) {
+ /* Implementation */
+}
+</code></pre>
+<h4>Looking up methods</h4>
+<p>Clownfish defines a macro named <code>CFISH_METHOD_PTR</code> that looks up the pointer
+to the implementing function of a method. The first parameter of the macro is
+a pointer to the Clownfish::Class object of the method’s class, the second is
+the unshortened name of the method wrapper. If short names for the Clownfish
+parcel are used, the macro is also available under the name <code>METHOD_PTR</code>.</p>
+<p>To lookup methods from a superclass, there’s a macro <code>CFISH_SUPER_METHOD_PTR</code>
+with the same parameters.</p>
+<p>Example using short names:</p>
+<pre><code>// Note that the name of the method wrapper must not be shortened.
+VisGraph_Add_Node_t add_node
+ = METHOD_PTR(VISIBILITYGRAPH, Pfind_VisGraph_Add_Node);
+
+VisGraph_Add_Node_t super_add_node
+ = SUPER_METHOD_PTR(VISIBILITYGRAPH, Pfind_VisGraph_Add_Node);
+</code></pre>
+<h4>Abstract methods</h4>
+<p>For abstract methods, the Clownfish compiler generates an implementing function
+which throws an error. They should be overridden in a subclass.</p>
+<h4>Final methods</h4>
+<p>Final methods must not be overridden. They must not be abstract.</p>
+<h4>Nullable return type</h4>
+<p>If a function has a nullable return type, it must return a pointer.
+Non-nullable functions must never return the NULL pointer.</p>
+<h4>Incremented return type</h4>
+<p>Incremented return types must be pointers to Clownfish objects. The function
+will either return a new object with an initial reference count of 1 or
+increment the reference count. The caller must decrement the reference count of
+the returned object when it’s no longer used.</p>
+<p>For returned objects with non-incremented return type, usually no additional
+handling of reference counts is required. Only if an object is returned from an
+accessor or a container object and the caller wants to use the object longer
+than the returning object retains a reference, it must increment the reference
+count itself and decrement when the object is no longer used.</p>
+<h4>Decremented parameters</h4>
+<p>Decremented parameters must be pointers to Clownfish objects. The function
+will either decrement the reference count of the passed-in object or retain a
+reference without incrementing the reference count. If the caller wants to use
+the passed-in object afterwards, it usually must increment its reference count
+before the call and decrement it when it’s no longer used. If the caller does
+not make further use of the passed-in object, it must not decrement its
+reference count after the call.</p>
+<p>This is typically used in container classes like Vector:</p>
+<pre><code>String *string = String_newf("Hello");
+Vec_Push(array, (Obj*)string);
+// No need to DECREF the string.
+</code></pre>
+<h4>Default parameter values</h4>
+<p>Default parameter values can be given as integer, float, or string literals.
+The values <code>true</code>, <code>false</code>, and <code>NULL</code> are also supported. The default
+values are only used by certain host language bindings. They’re not supported
+when calling a function from C.</p>
+<h3>C blocks</h3>
+<p>Clownfish headers can contain C blocks which start with a line containing the
+string <code>__C__</code> and end on a line containing the string <code>__END_C__</code>. The
+contents of a C block are copied verbatim to the generated C header.</p>
+<p>Example:</p>
+<pre><code>__C__
+
+struct pfind_AuxiliaryStruct {
+ int a;
+ int b;
+};
+
+__END_C__
+</code></pre>
+<h3>Object life cycle</h3>
+<h4>Object creation</h4>
+<p>Objects are allocated by invoking the <code>Make_Obj</code> method on a class’s
+Clownfish::Class object.</p>
+<p>Any inert function can be used to construct objects from C. But to support
+inheritance and object creation from the host language, Clownfish classes
+need a separate function to initialize objects. The initializer must take a
+pointer to an object as first argument and return a pointer to the same
+object. If the parent class has an initializer, it should be called first by
+the subclass’s initializer.</p>
+<p>By convention, the standard constructor is named <code>new</code> and the standard
+initializer <code>init</code>.</p>
+<p>Example:</p>
+<pre><code>/* Clownfish header */
+
+class Vehicle {
+ double max_speed;
+
+ inert Vehicle*
+ init(Vehicle *self, double max_speed);
+}
+
+class Train inherits Vehicle {
+ double track_gauge;
+
+ inert incremented Train*
+ new(double max_speed, double track_gauge);
+
+ inert Train*
+ init(Train *self, double max_speed, double track_gauge);
+}
+
+/* Implementation */
+
+Train*
+Train_new(double max_speed, double track_gauge) {
+ Train *self = (Train*)Class_Make_Obj(TRAIN);
+ return Train_init(self, max_speed, track_gauge);
+}
+
+Train*
+Train_init(Train *self, double max_speed, double track_gauge) {
+ Vehicle_init((Vehicle*)self, max_speed);
+ self->track_gauge = track_gauge;
+ return self;
+}
+</code></pre>
+<h4>Reference counting</h4>
+<p>Clownfish uses reference counting for memory management. Objects are created
+with a reference count of 1. There are two macros <code>CFISH_INCREF</code> and
+<code>CFISH_DECREF</code> to increment and decrement reference counts. If short names
+for the Clownfish parcel are enabled, the macros can be abbreviated to
+<code>INCREF</code> and <code>DECREF</code>. Both macros take a pointer to an object as argument.
+NULL pointers are allowed. <code>CFISH_INCREF</code> returns a pointer to the object.
+This value might differ from the passed-in pointer in some cases. So if a
+reference is retained, the pointer returned from <code>CFISH_INCREF</code> should be
+used. <code>CFISH_DECREF</code> returns the modified reference count.</p>
+<p>Examples:</p>
+<pre><code>self->value = INCREF(arg);
+
+DECREF(object);
+</code></pre>
+<h4>Object destruction</h4>
+<p>If an object’s reference count reaches 0, its <code>Destroy</code> method is called.
+This public method takes no arguments besides <code>self</code> and has no return value.
+It should release the resources held by the object and finally call the
+<code>Destroy</code> method of the superclass via the <code>CFISH_SUPER_DESTROY</code> macro with
+short name <code>SUPER_DESTROY</code>. This macro takes the <code>self</code> pointer as first
+argument and a pointer to the object’s Clownfish::Class as second argument.
+The <code>Destroy</code> method of the Clownfish::Obj class will eventually free the
+object struct.</p>
+<p>Example:</p>
+<pre><code>/* Clownfish header */
+
+class Path {
+ Vector *nodes;
+
+ public void
+ Destroy(Path *self);
+}
+
+/* Implementation */
+
+void
+Path_Destroy_IMP(Path *self) {
+ DECREF(self->nodes);
+ SUPER_DESTROY(self, PATH);
+}
+</code></pre>
+<h3>Documentation</h3>
+<p>The Clownfish compiler creates documentation in the host language’s preferred
+format from so-called DocuComments found in the <code>.cfh</code> files. DocuComments use
+Markdown (<a href="http://commonmark.org/">CommonMark</a> flavor) for formatting.
+DocuComments are multi-line C-style comments that start with <code>/**</code>. They
+immediately precede the documented class, inert function, or method.
+A left border consisting of whitespace and asterisks is stripped.</p>
+<p>The DocuComment for a class should start with a short description (everything
+up until the first period <code>.</code>) which may appear in the name section of a
+man page, for example.</p>
+<p>DocuComments for functions and methods may end with a series of <code>@param</code> and
+<code>@return</code> directives which document the parameters and return values.</p>
+<p>Example:</p>
+<pre><code>/** Class describing a train.
+ *
+ * The Train class describes a train. It extends the Vehicle class and
+ * adds some useful properties specific to trains.
+ */
+public class Train inherits Vehicle {
+ /** Create a new Train object.
+ *
+ * @param max_speed The maximum speed in km/h.
+ * @param track_gauge The track gauge in mm.
+ */
+ public inert incremented Train*
+ new(double max_speed, double track_gauge);
+
+ /** Accessor for maximum speed.
+ *
+ * @return the maximum speed in km/h.
+ */
+ public double
+ Get_Max_Speed(Train *self);
+}
+</code></pre>
+<p>The Clownfish compiler also looks for standalone Markdown <code>.md</code> files in the
+source directories which will be included in the documentation.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Err.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Err.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Err.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,200 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Clownfish::Err – C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Clownfish/">Clownfish</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Clownfish::Err</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../cfish.html">Clownfish</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">CFISH_</span>ERR</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">cfish_</span>Err</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">cfish_</span>Err</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Clownfish/Err.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Clownfish::Err – Exception.</p>
+<h3>Description</h3>
+<p>Clownfish::Err is the base class for exceptions in the Clownfish object
+hierarchy.</p>
+<p>The Err module also provides access to a per-thread Err shared variable via
+set_error() and get_error(). It may be used to store an Err object
+temporarily, so that calling code may choose how to handle a particular
+error condition.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_set_error">set_error</dt>
+<dd>
+<pre><code>void
+<span class="prefix">cfish_</span><strong>Err_set_error</strong>(
+ <span class="prefix">cfish_</span>Err *<strong>error</strong> <span class="comment">// decremented</span>
+);
+</code></pre>
+<p>Set the global error object, a per-thread Err shared variable.</p>
+</dd>
+<dt id="func_get_error">get_error</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span>Err*
+<span class="prefix">cfish_</span><strong>Err_get_error</strong>(void);
+</code></pre>
+<p>Retrieve the global error object, a per-thread Err shared variable.</p>
+</dd>
+<dt id="func_trap">trap</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span>Err* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>Err_trap</strong>(
+ CFISH_Err_Attempt_t <strong>routine</strong>,
+ void *<strong>context</strong>
+);
+</code></pre>
+<p>Run <code>routine</code> within the host’s exception handling
+environment, catching and returning any errors that occur.</p>
+<p>If an unrecognized host exception is trapped, it will be wrapped in an
+Err so that it can be handled by Clownfish code.</p>
+<p><strong>Returns:</strong> an Err, or NULL if no exception occurs.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_To_String">To_String</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a>* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>Err_To_String</strong>(
+ <span class="prefix">cfish_</span>Err *<strong>self</strong>
+);
+</code></pre>
+<p>Return a copy of the error message.</p>
+</dd>
+<dt id="func_Cat_Mess">Cat_Mess</dt>
+<dd>
+<pre><code>void
+<span class="prefix">cfish_</span><strong>Err_Cat_Mess</strong>(
+ <span class="prefix">cfish_</span>Err *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>mess</strong>
+);
+</code></pre>
+<p>Concatenate the supplied argument onto the error message.</p>
+</dd>
+<dt id="func_Get_Mess">Get_Mess</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a>*
+<span class="prefix">cfish_</span><strong>Err_Get_Mess</strong>(
+ <span class="prefix">cfish_</span>Err *<strong>self</strong>
+);
+</code></pre>
+<p>Return the error message.</p>
+</dd>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">cfish_</span><strong>Err_Destroy</strong>(
+ <span class="prefix">cfish_</span>Err *<strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Clownfish::Err is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Float.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Float.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Float.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,219 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Clownfish::Float – C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Clownfish/">Clownfish</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Clownfish::Float</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../cfish.html">Clownfish</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">CFISH_</span>FLOAT</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">cfish_</span>Float</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">cfish_</span>Float</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Clownfish/Num.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Clownfish::Float – Immutable double precision floating point number.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span>Float*
+<span class="prefix">cfish_</span><strong>Float_new</strong>(
+ double <strong>value</strong>
+);
+</code></pre>
+<p>Return a new Float.</p>
+<dl>
+<dt>value</dt>
+<dd><p>Initial value.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span>Float*
+<span class="prefix">cfish_</span><strong>Float_init</strong>(
+ <span class="prefix">cfish_</span>Float *<strong>self</strong>,
+ double <strong>value</strong>
+);
+</code></pre>
+<p>Initialize a Float.</p>
+<dl>
+<dt>value</dt>
+<dd><p>Initial value.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Get_Value">Get_Value</dt>
+<dd>
+<pre><code>double
+<span class="prefix">cfish_</span><strong>Float_Get_Value</strong>(
+ <span class="prefix">cfish_</span>Float *<strong>self</strong>
+);
+</code></pre>
+<p>Return the value of the Float.</p>
+</dd>
+<dt id="func_To_I64">To_I64</dt>
+<dd>
+<pre><code>int64_t
+<span class="prefix">cfish_</span><strong>Float_To_I64</strong>(
+ <span class="prefix">cfish_</span>Float *<strong>self</strong>
+);
+</code></pre>
+<p>Convert the Float to an integer, truncating toward zero. Throw an
+exception if the value is out of the range of an <code>int64_t</code>.</p>
+</dd>
+<dt id="func_To_String">To_String</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a>* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>Float_To_String</strong>(
+ <span class="prefix">cfish_</span>Float *<strong>self</strong>
+);
+</code></pre>
+<p>Return the Float formatted as String using <code>sprintf</code> with conversion
+specifier <code>%g</code>.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">cfish_</span><strong>Float_Equals</strong>(
+ <span class="prefix">cfish_</span>Float *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether two numbers are the same.</p>
+<p><strong>Returns:</strong> true if <code>other</code> is a Float or Integer with the same value as
+<code>self</code>.</p>
+</dd>
+<dt id="func_Compare_To">Compare_To</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">cfish_</span><strong>Float_Compare_To</strong>(
+ <span class="prefix">cfish_</span>Float *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether one number is less than, equal to, or greater than
+another. Throws an exception if <code>other</code> is neither a Float nor an
+Integer.</p>
+<p><strong>Returns:</strong> 0 if the numbers are equal, a negative number if <code>self</code> is
+less than <code>other</code>, and a positive number if <code>self</code> is greater than
+<code>other</code>.</p>
+</dd>
+<dt id="func_Clone">Clone</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span>Float* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>Float_Clone</strong>(
+ <span class="prefix">cfish_</span>Float *<strong>self</strong>
+);
+</code></pre>
+<p>Return a clone of the object.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Clownfish::Float is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Hash.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Hash.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/Hash.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,325 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Clownfish::Hash – C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Clownfish/">Clownfish</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Clownfish::Hash</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../cfish.html">Clownfish</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">CFISH_</span>HASH</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">cfish_</span>Hash</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">cfish_</span>Hash</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Clownfish/Hash.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Clownfish::Hash – Hashtable.</p>
+<h3>Description</h3>
+<p>Values are stored by reference and may be any kind of Obj.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span>Hash* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>Hash_new</strong>(
+ size_t <strong>capacity</strong>
+);
+</code></pre>
+<p>Return a new Hash.</p>
+<dl>
+<dt>capacity</dt>
+<dd><p>The number of elements that the hash will be asked to
+hold initially.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span>Hash*
+<span class="prefix">cfish_</span><strong>Hash_init</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>,
+ size_t <strong>capacity</strong>
+);
+</code></pre>
+<p>Initialize a Hash.</p>
+<dl>
+<dt>capacity</dt>
+<dd><p>The number of elements that the hash will be asked to
+hold initially.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Clear">Clear</dt>
+<dd>
+<pre><code>void
+<span class="prefix">cfish_</span><strong>Hash_Clear</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>
+);
+</code></pre>
+<p>Empty the hash of all key-value pairs.</p>
+</dd>
+<dt id="func_Store">Store</dt>
+<dd>
+<pre><code>void
+<span class="prefix">cfish_</span><strong>Hash_Store</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>key</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a> *<strong>value</strong> <span class="comment">// decremented</span>
+);
+</code></pre>
+<p>Store a key-value pair.</p>
+</dd>
+<dt id="func_Store_Utf8">Store_Utf8</dt>
+<dd>
+<pre><code>void
+<span class="prefix">cfish_</span><strong>Hash_Store_Utf8</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>,
+ char *<strong>utf8</strong>,
+ size_t <strong>size</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a> *<strong>value</strong> <span class="comment">// decremented</span>
+);
+</code></pre>
+<p>Store a key-value pair using a raw UTF-8 key.</p>
+<dl>
+<dt>utf8</dt>
+<dd><p>Pointer to UTF-8 character data of the key.</p>
+</dd>
+<dt>size</dt>
+<dd><p>Size of UTF-8 character data in bytes.</p>
+</dd>
+<dt>value</dt>
+<dd><p>The Obj to store.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Fetch">Fetch</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a>*
+<span class="prefix">cfish_</span><strong>Hash_Fetch</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>key</strong>
+);
+</code></pre>
+<p>Fetch the value associated with <code>key</code>.</p>
+<p><strong>Returns:</strong> the value, or NULL if <code>key</code> is not present.</p>
+</dd>
+<dt id="func_Fetch_Utf8">Fetch_Utf8</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a>*
+<span class="prefix">cfish_</span><strong>Hash_Fetch_Utf8</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>,
+ char *<strong>utf8</strong>,
+ size_t <strong>size</strong>
+);
+</code></pre>
+<p>Fetch the value associated with a raw UTF-8 key.</p>
+<dl>
+<dt>utf8</dt>
+<dd><p>Pointer to UTF-8 character data of the key.</p>
+</dd>
+<dt>size</dt>
+<dd><p>Size of UTF-8 character data in bytes.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> the value, or NULL if <code>key</code> is not present.</p>
+</dd>
+<dt id="func_Delete">Delete</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>Hash_Delete</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>key</strong>
+);
+</code></pre>
+<p>Attempt to delete a key-value pair from the hash.</p>
+<p><strong>Returns:</strong> the value if <code>key</code> exists and thus deletion
+succeeds; otherwise NULL.</p>
+</dd>
+<dt id="func_Delete_Utf8">Delete_Utf8</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>Hash_Delete_Utf8</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>,
+ char *<strong>utf8</strong>,
+ size_t <strong>size</strong>
+);
+</code></pre>
+<p>Attempt to delete a key-value pair from the hash.</p>
+<dl>
+<dt>utf8</dt>
+<dd><p>Pointer to UTF-8 character data of the key.</p>
+</dd>
+<dt>size</dt>
+<dd><p>Size of UTF-8 character data in bytes.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> the value if <code>key</code> exists and thus deletion
+succeeds; otherwise NULL.</p>
+</dd>
+<dt id="func_Has_Key">Has_Key</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">cfish_</span><strong>Hash_Has_Key</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>key</strong>
+);
+</code></pre>
+<p>Indicate whether the supplied <code>key</code> is present.</p>
+</dd>
+<dt id="func_Keys">Keys</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/Vector.html">Vector</a>* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>Hash_Keys</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>
+);
+</code></pre>
+<p>Return the Hash’s keys.</p>
+</dd>
+<dt id="func_Values">Values</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/Vector.html">Vector</a>* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>Hash_Values</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>
+);
+</code></pre>
+<p>Return the Hash’s values.</p>
+</dd>
+<dt id="func_Get_Size">Get_Size</dt>
+<dd>
+<pre><code>size_t
+<span class="prefix">cfish_</span><strong>Hash_Get_Size</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of key-value pairs.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">cfish_</span><strong>Hash_Equals</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Equality test.</p>
+<p><strong>Returns:</strong> true if <code>other</code> is a Hash with the same key-value pairs as
+<code>self</code>. Keys and values are compared using their respective <code>Equals</code>
+methods.</p>
+</dd>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">cfish_</span><strong>Hash_Destroy</strong>(
+ <span class="prefix">cfish_</span>Hash *<strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Clownfish::Hash is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/HashIterator.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/HashIterator.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Clownfish/HashIterator.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,187 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Clownfish::HashIterator – C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Clownfish/">Clownfish</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Clownfish::HashIterator</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../cfish.html">Clownfish</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">CFISH_</span>HASHITERATOR</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">cfish_</span>HashIterator</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">cfish_</span>HashIter</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Clownfish/HashIterator.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Clownfish::HashIterator – Hashtable Iterator.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span>HashIterator* <span class="comment">// incremented</span>
+<span class="prefix">cfish_</span><strong>HashIter_new</strong>(
+ <span class="prefix">cfish_</span><a href="../Clownfish/Hash.html">Hash</a> *<strong>hash</strong>
+);
+</code></pre>
+<p>Return a HashIterator for <code>hash</code>.</p>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span>HashIterator*
+<span class="prefix">cfish_</span><strong>HashIter_init</strong>(
+ <span class="prefix">cfish_</span>HashIterator *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/Hash.html">Hash</a> *<strong>hash</strong>
+);
+</code></pre>
+<p>Initialize a HashIterator for <code>hash</code>.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Next">Next</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">cfish_</span><strong>HashIter_Next</strong>(
+ <span class="prefix">cfish_</span>HashIterator *<strong>self</strong>
+);
+</code></pre>
+<p>Advance the iterator to the next key-value pair.</p>
+<p><strong>Returns:</strong> true if there’s another key-value pair, false if the iterator
+is exhausted.</p>
+</dd>
+<dt id="func_Get_Key">Get_Key</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a>*
+<span class="prefix">cfish_</span><strong>HashIter_Get_Key</strong>(
+ <span class="prefix">cfish_</span>HashIterator *<strong>self</strong>
+);
+</code></pre>
+<p>Return the key of the current key-value pair. It’s not allowed to
+call this method before <a href="../Clownfish/HashIterator.html#func_Next">Next()</a> was called for the first time or
+after the iterator was exhausted.</p>
+</dd>
+<dt id="func_Get_Value">Get_Value</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a>*
+<span class="prefix">cfish_</span><strong>HashIter_Get_Value</strong>(
+ <span class="prefix">cfish_</span>HashIterator *<strong>self</strong>
+);
+</code></pre>
+<p>Return the value of the current key-value pair. It’s not allowed to
+call this method before <a href="../Clownfish/HashIterator.html#func_Next">Next()</a> was called for the first time or
+after the iterator was exhausted.</p>
+</dd>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">cfish_</span><strong>HashIter_Destroy</strong>(
+ <span class="prefix">cfish_</span>HashIterator *<strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Clownfish::HashIterator is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>