Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/cfish.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/c/cfish.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/c/cfish.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,117 @@ +<!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 â C API Index</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></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 â C API Index</h2> +<h3>Documentation</h3> +<ul> +<li><a href="Clownfish.html">Clownfish</a></li> +<li><a href="Clownfish/Docs/BuildingProjects.html">Clownfish::Docs::BuildingProjects</a></li> +<li><a href="Clownfish/Docs/ClassIntro.html">Clownfish::Docs::ClassIntro</a></li> +<li><a href="Clownfish/Docs/WritingClasses.html">Clownfish::Docs::WritingClasses</a></li> +</ul> +<h3>Classes in parcel Clownfish</h3> +<ul> +<li><a href="Clownfish/Blob.html">Clownfish::Blob</a></li> +<li><a href="Clownfish/Boolean.html">Clownfish::Boolean</a></li> +<li><a href="Clownfish/ByteBuf.html">Clownfish::ByteBuf</a></li> +<li><a href="Clownfish/CharBuf.html">Clownfish::CharBuf</a></li> +<li><a href="Clownfish/Class.html">Clownfish::Class</a></li> +<li><a href="Clownfish/Err.html">Clownfish::Err</a></li> +<li><a href="Clownfish/Float.html">Clownfish::Float</a></li> +<li><a href="Clownfish/Hash.html">Clownfish::Hash</a></li> +<li><a href="Clownfish/HashIterator.html">Clownfish::HashIterator</a></li> +<li><a href="Clownfish/Integer.html">Clownfish::Integer</a></li> +<li><a href="Clownfish/Obj.html">Clownfish::Obj</a></li> +<li><a href="Clownfish/String.html">Clownfish::String</a></li> +<li><a href="Clownfish/StringIterator.html">Clownfish::StringIterator</a></li> +<li><a href="Clownfish/Vector.html">Clownfish::Vector</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/lucy.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/c/lucy.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/c/lucy.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>Lucy â C API Index</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></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>Lucy â C API Index</h2> +<h3>Documentation</h3> +<ul> +<li><a href="Lucy/Docs/Cookbook.html">Lucy::Docs::Cookbook</a></li> +<li><a href="Lucy/Docs/Cookbook/CustomQuery.html">Lucy::Docs::Cookbook::CustomQuery</a></li> +<li><a href="Lucy/Docs/Cookbook/CustomQueryParser.html">Lucy::Docs::Cookbook::CustomQueryParser</a></li> +<li><a href="Lucy/Docs/Cookbook/FastUpdates.html">Lucy::Docs::Cookbook::FastUpdates</a></li> +<li><a href="Lucy/Docs/DevGuide.html">Lucy::Docs::DevGuide</a></li> +<li><a href="Lucy/Docs/DocIDs.html">Lucy::Docs::DocIDs</a></li> +<li><a href="Lucy/Docs/FileFormat.html">Lucy::Docs::FileFormat</a></li> +<li><a href="Lucy/Docs/FileLocking.html">Lucy::Docs::FileLocking</a></li> +<li><a href="Lucy/Docs/IRTheory.html">Lucy::Docs::IRTheory</a></li> +<li><a href="Lucy/Docs/Tutorial.html">Lucy::Docs::Tutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/AnalysisTutorial.html">Lucy::Docs::Tutorial::AnalysisTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/BeyondSimpleTutorial.html">Lucy::Docs::Tutorial::BeyondSimpleTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/FieldTypeTutorial.html">Lucy::Docs::Tutorial::FieldTypeTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/HighlighterTutorial.html">Lucy::Docs::Tutorial::HighlighterTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/QueryObjectsTutorial.html">Lucy::Docs::Tutorial::QueryObjectsTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/SimpleTutorial.html">Lucy::Docs::Tutorial::SimpleTutorial</a></li> +</ul> +<h3>Classes in parcel Lucy</h3> +<ul> +<li><a href="Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a></li> +<li><a href="Lucy/Analysis/CaseFolder.html">Lucy::Analysis::CaseFolder</a></li> +<li><a href="Lucy/Analysis/EasyAnalyzer.html">Lucy::Analysis::EasyAnalyzer</a></li> +<li><a href="Lucy/Analysis/Inversion.html">Lucy::Analysis::Inversion</a></li> +<li><a href="Lucy/Analysis/Normalizer.html">Lucy::Analysis::Normalizer</a></li> +<li><a href="Lucy/Analysis/PolyAnalyzer.html">Lucy::Analysis::PolyAnalyzer</a></li> +<li><a href="Lucy/Analysis/RegexTokenizer.html">Lucy::Analysis::RegexTokenizer</a></li> +<li><a href="Lucy/Analysis/SnowballStemmer.html">Lucy::Analysis::SnowballStemmer</a></li> +<li><a href="Lucy/Analysis/SnowballStopFilter.html">Lucy::Analysis::SnowballStopFilter</a></li> +<li><a href="Lucy/Analysis/StandardTokenizer.html">Lucy::Analysis::StandardTokenizer</a></li> +<li><a href="Lucy/Analysis/Token.html">Lucy::Analysis::Token</a></li> +<li><a href="Lucy/Document/Doc.html">Lucy::Document::Doc</a></li> +<li><a href="Lucy/Document/HitDoc.html">Lucy::Document::HitDoc</a></li> +<li><a href="Lucy/Highlight/Highlighter.html">Lucy::Highlight::Highlighter</a></li> +<li><a href="Lucy/Index/BackgroundMerger.html">Lucy::Index::BackgroundMerger</a></li> +<li><a href="Lucy/Index/DataReader.html">Lucy::Index::DataReader</a></li> +<li><a href="Lucy/Index/DataWriter.html">Lucy::Index::DataWriter</a></li> +<li><a href="Lucy/Index/DeletionsWriter.html">Lucy::Index::DeletionsWriter</a></li> +<li><a href="Lucy/Index/DocReader.html">Lucy::Index::DocReader</a></li> +<li><a href="Lucy/Index/IndexManager.html">Lucy::Index::IndexManager</a></li> +<li><a href="Lucy/Index/IndexReader.html">Lucy::Index::IndexReader</a></li> +<li><a href="Lucy/Index/Indexer.html">Lucy::Index::Indexer</a></li> +<li><a href="Lucy/Index/Lexicon.html">Lucy::Index::Lexicon</a></li> +<li><a href="Lucy/Index/LexiconReader.html">Lucy::Index::LexiconReader</a></li> +<li><a href="Lucy/Index/PolyReader.html">Lucy::Index::PolyReader</a></li> +<li><a href="Lucy/Index/PostingList.html">Lucy::Index::PostingList</a></li> +<li><a href="Lucy/Index/PostingListReader.html">Lucy::Index::PostingListReader</a></li> +<li><a href="Lucy/Index/SegReader.html">Lucy::Index::SegReader</a></li> +<li><a href="Lucy/Index/SegWriter.html">Lucy::Index::SegWriter</a></li> +<li><a href="Lucy/Index/Segment.html">Lucy::Index::Segment</a></li> +<li><a href="Lucy/Index/Similarity.html">Lucy::Index::Similarity</a></li> +<li><a href="Lucy/Index/Snapshot.html">Lucy::Index::Snapshot</a></li> +<li><a href="Lucy/Object/BitVector.html">Lucy::Object::BitVector</a></li> +<li><a href="Lucy/Object/I32Array.html">Lucy::Object::I32Array</a></li> +<li><a href="Lucy/Plan/Architecture.html">Lucy::Plan::Architecture</a></li> +<li><a href="Lucy/Plan/BlobType.html">Lucy::Plan::BlobType</a></li> +<li><a href="Lucy/Plan/FieldType.html">Lucy::Plan::FieldType</a></li> +<li><a href="Lucy/Plan/FullTextType.html">Lucy::Plan::FullTextType</a></li> +<li><a href="Lucy/Plan/Schema.html">Lucy::Plan::Schema</a></li> +<li><a href="Lucy/Plan/StringType.html">Lucy::Plan::StringType</a></li> +<li><a href="Lucy/Search/ANDQuery.html">Lucy::Search::ANDQuery</a></li> +<li><a href="Lucy/Search/Collector.html">Lucy::Search::Collector</a></li> +<li><a href="Lucy/Search/Collector/BitCollector.html">Lucy::Search::Collector::BitCollector</a></li> +<li><a href="Lucy/Search/Compiler.html">Lucy::Search::Compiler</a></li> +<li><a href="Lucy/Search/Hits.html">Lucy::Search::Hits</a></li> +<li><a href="Lucy/Search/IndexSearcher.html">Lucy::Search::IndexSearcher</a></li> +<li><a href="Lucy/Search/LeafQuery.html">Lucy::Search::LeafQuery</a></li> +<li><a href="Lucy/Search/MatchAllQuery.html">Lucy::Search::MatchAllQuery</a></li> +<li><a href="Lucy/Search/Matcher.html">Lucy::Search::Matcher</a></li> +<li><a href="Lucy/Search/NOTQuery.html">Lucy::Search::NOTQuery</a></li> +<li><a href="Lucy/Search/NoMatchQuery.html">Lucy::Search::NoMatchQuery</a></li> +<li><a href="Lucy/Search/ORQuery.html">Lucy::Search::ORQuery</a></li> +<li><a href="Lucy/Search/PhraseQuery.html">Lucy::Search::PhraseQuery</a></li> +<li><a href="Lucy/Search/PolyQuery.html">Lucy::Search::PolyQuery</a></li> +<li><a href="Lucy/Search/PolySearcher.html">Lucy::Search::PolySearcher</a></li> +<li><a href="Lucy/Search/Query.html">Lucy::Search::Query</a></li> +<li><a href="Lucy/Search/QueryParser.html">Lucy::Search::QueryParser</a></li> +<li><a href="Lucy/Search/RangeQuery.html">Lucy::Search::RangeQuery</a></li> +<li><a href="Lucy/Search/RequiredOptionalQuery.html">Lucy::Search::RequiredOptionalQuery</a></li> +<li><a href="Lucy/Search/Searcher.html">Lucy::Search::Searcher</a></li> +<li><a href="Lucy/Search/SortRule.html">Lucy::Search::SortRule</a></li> +<li><a href="Lucy/Search/SortSpec.html">Lucy::Search::SortSpec</a></li> +<li><a href="Lucy/Search/Span.html">Lucy::Search::Span</a></li> +<li><a href="Lucy/Search/TermQuery.html">Lucy::Search::TermQuery</a></li> +<li><a href="Lucy/Simple.html">Lucy::Simple</a></li> +<li><a href="Lucy/Store/FSFolder.html">Lucy::Store::FSFolder</a></li> +<li><a href="Lucy/Store/Folder.html">Lucy::Store::Folder</a></li> +<li><a href="Lucy/Store/Lock.html">Lucy::Store::Lock</a></li> +<li><a href="Lucy/Store/LockErr.html">Lucy::Store::LockErr</a></li> +<li><a href="Lucy/Store/LockFactory.html">Lucy::Store::LockFactory</a></li> +<li><a href="Lucy/Store/RAMFolder.html">Lucy::Store::RAMFolder</a></li> +<li><a href="LucyX/Search/ProximityQuery.html">LucyX::Search::ProximityQuery</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/perl/Clownfish.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,225 @@ +<!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 â Apache Clownfish 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/perl/">Perl</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> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Clownfish - Apache Clownfish symbiotic object system</p> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>The Apache Clownfish “symbiotic” object system pairs with “host” programming language environments and facilitates the development of high performance language extensions.</p> + +<h3><a class='u' +name="Features" +>Features</a></h3> + +<ul> +<li>Support for multiple host languages.</li> + +<li>Support for stand-alone C libraries and executables.</li> + +<li>Subclassing and method overriding from the host language.</li> + +<li>Support for host language idioms like named parameters or default argument values.</li> + +<li>Highly performant object system with lazy creation of host language objects.</li> + +<li>Runtime with classes for commonly used data structures like strings, +dynamic arrays and hash tables.</li> + +<li>Guaranteed ABI stability when adding or reordering methods or instance variables.</li> + +<li>Modularity.</li> + +<li>Introspection.</li> + +<li>Documentation generator.</li> +</ul> + +<h3><a class='u' +name="Planned_features" +>Planned features</a></h3> + +<ul> +<li>Support for more host languages.</li> + +<li>Support for interfaces.</li> +</ul> + +<h3><a class='u' +name="Overview" +>Overview</a></h3> + +<p>Clownfish consists of two parts, +the Clownfish compiler “CFC” and the Clownfish runtime. +CFC is a code generator that creates C header files, +host language bindings, +initialization code and documentation from a set of Clownfish header files. +The generated code is compiled with other project code and linked with the Clownfish runtime.</p> + +<p>Clownfish header files have a <code>.cfh</code> extension and define classes used within the Clownfish object system. +The object system is implemented in C and supports single inheritance and virtual method dispatch. +CFC creates a C header file from each Clownfish header containing the C interface to Clownfish objects. +Functions and methods of objects are implemented in normal C source files. +Beyond the C level, +CFC can generate host language bindings to make Clownfish objects accessible from other programming languages. +The compiler also creates class documentation in various formats from comments contained in Clownfish header files and standalone Markdown files.</p> + +<p>The Clownfish runtime provides:</p> + +<ul> +<li>The <a href="./Clownfish/Obj.html" class="podlinkpod" +>Obj</a> class which is the root of the class hierarchy.</li> + +<li>Core data types like <a href="./Clownfish/String.html" class="podlinkpod" +>strings</a>, +<a href="./Clownfish/Vector.html" class="podlinkpod" +>dynamic arrays</a>, +and <a href="./Clownfish/Hash.html" class="podlinkpod" +>hashes</a>.</li> + +<li>The <a href="./Clownfish/Class.html" class="podlinkpod" +>Class</a> metaclass.</li> + +<li>Some helper classes.</li> +</ul> + +<h3><a class='u' +name="Host_language_support" +>Host language support</a></h3> + +<p>Bindings for the following hosts are under development:</p> + +<ul> +<li>C (feature-complete)</li> + +<li>Go (experimental)</li> + +<li>Perl 5 (feature-complete)</li> + +<li>Python 3 / CPython (nascent)</li> + +<li>Ruby / MRI (nascent)</li> +</ul> + +<h3><a class='u' +name="Help_wanted" +>Help wanted</a></h3> + +<p>The target audience for the current release of Clownfish is developers. +Clownfish is developed by the Apache Lucy community, +where it is used to provide host language bindings for the Lucy search engine library; we expect that as Clownfish matures it will eventually spin off as an independent project. +If you would like to contribute to Clownfish, +please join the <a href="http://lucy.apache.org/mailing_lists"; class="podlinkurl" +>Lucy developers mailing list</a>.</p> + +<h3><a class='u' +name="Documentation" +>Documentation</a></h3> + +<ul> +<li><a href="./Clownfish/Docs/ClassIntro.html" class="podlinkpod" +>Working with Clownfish classes</a></li> + +<li><a href="./Clownfish/Docs/BuildingProjects.html" class="podlinkpod" +>Building Clownfish projects in C environments</a></li> + +<li><a href="./Clownfish/Docs/WritingClasses.html" class="podlinkpod" +>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/perl/Clownfish/Blob.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Blob.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Blob.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,166 @@ +<!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::Blob â Apache Clownfish 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/perl/">Perl</a> » <a href="/docs/0.5.0/perl/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> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Clownfish::Blob - Immutable buffer holding arbitrary bytes.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $blob = Clownfish::Blob->new($byte_string); +my $byte_string = $blob->to_perl;</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $blob = Clownfish::Blob->new($byte_string);</pre> + +<p>Create a Blob containing the passed-in bytes.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_size" +>get_size</a></h3> + +<pre>my $int = $blob->get_size();</pre> + +<p>Return the number of bytes held by the Blob.</p> + +<h3><a class='u' +name="compare_to" +>compare_to</a></h3> + +<pre>my $int = $blob->compare_to($other);</pre> + +<p>Indicate whether one Blob is less than, +equal to, +or greater than another. +The byte contents of the Blobs are compared lexicographically. +Throws an exception if <code>other</code> is not a Blob.</p> + +<p>Returns: 0 if the Blobs 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> + +<h3><a class='u' +name="clone" +>clone</a></h3> + +<pre>my $result = $blob->clone();</pre> + +<p>Return a clone of the object.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Clownfish::Blob isa <a href="../Clownfish/Obj.html" class="podlinkpod" +>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/perl/Clownfish/Boolean.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Boolean.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Boolean.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,158 @@ +<!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::Boolean â Apache Clownfish 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/perl/">Perl</a> » <a href="/docs/0.5.0/perl/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> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Clownfish::Boolean - Boolean type.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>use Clownfish::Boolean qw( $true_singleton $false_singleton ); + +my $bool = Clownfish::Boolean->singleton($truth_value); +my $truth_value = $bool->get_value; + +if ($bool->equals($true_singleton)) { + print "true\n"; +}</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>There are only two singleton instances of this class: <code>$true_singleton</code> and <code>$false_singleton</code> which are exported on demand.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="singleton" +>singleton</a></h3> + +<pre>my $bool = Clownfish::Boolean->singleton($truth_value);</pre> + +<p>Return either <code>$true_singleton</code> or <code>$false_singleton</code> depending on the supplied value.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_value" +>get_value</a></h3> + +<pre>my $bool = $boolean->get_value();</pre> + +<p>Return the value of the Boolean.</p> + +<h3><a class='u' +name="clone" +>clone</a></h3> + +<pre>my $result = $boolean->clone();</pre> + +<p>Return a clone of the object.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Clownfish::Boolean isa <a href="../Clownfish/Obj.html" class="podlinkpod" +>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/perl/Clownfish/ByteBuf.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/ByteBuf.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/ByteBuf.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,220 @@ +<!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::ByteBuf â Apache Clownfish 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/perl/">Perl</a> » <a href="/docs/0.5.0/perl/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> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Clownfish::ByteBuf - Growable buffer holding arbitrary bytes.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $buf = Clownfish::ByteBuf->new($byte_string); +my $byte_string = $buf->to_perl;</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $buf = Clownfish::ByteBuf->new($byte_string);</pre> + +<p>Create a ByteBuf containing the passed-in bytes.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="set_size" +>set_size</a></h3> + +<pre>$byte_buf->set_size($size);</pre> + +<p>Resize the ByteBuf to <code>size</code>. +If greater than the object’s capacity, +throws an error.</p> + +<h3><a class='u' +name="get_size" +>get_size</a></h3> + +<pre>my $int = $byte_buf->get_size();</pre> + +<p>Return the size of the ByteBuf in bytes.</p> + +<h3><a class='u' +name="get_capacity" +>get_capacity</a></h3> + +<pre>my $int = $byte_buf->get_capacity();</pre> + +<p>Return the number of bytes in the ByteBuf’s allocation.</p> + +<h3><a class='u' +name="cat" +>cat</a></h3> + +<pre>$byte_buf->cat($blob);</pre> + +<p>Concatenate the contents of <a href="../Clownfish/Blob.html" class="podlinkpod" +>Blob</a> <code>blob</code> onto the end of the original ByteBuf. +Allocate more memory as needed.</p> + +<h3><a class='u' +name="yield_blob" +>yield_blob</a></h3> + +<pre>my $blob = $byte_buf->yield_blob();</pre> + +<p>Return the content of the ByteBuf as <a href="../Clownfish/Blob.html" class="podlinkpod" +>Blob</a> and clear the ByteBuf.</p> + +<h3><a class='u' +name="utf8_to_string" +>utf8_to_string</a></h3> + +<pre>my $string = $byte_buf->utf8_to_string();</pre> + +<p>Return a String which holds a copy of the UTF-8 character data in the ByteBuf after checking for validity.</p> + +<h3><a class='u' +name="trusted_utf8_to_string" +>trusted_utf8_to_string</a></h3> + +<pre>my $string = $byte_buf->trusted_utf8_to_string();</pre> + +<p>Return a String which holds a copy of the UTF-8 character data in the ByteBuf, +skipping validity checks.</p> + +<h3><a class='u' +name="compare_to" +>compare_to</a></h3> + +<pre>my $int = $byte_buf->compare_to($other);</pre> + +<p>Indicate whether one ByteBuf is less than, +equal to, +or greater than another. +The byte contents of the ByteBufs are compared lexicographically. +Throws an exception if <code>other</code> is not a ByteBuf.</p> + +<p>Returns: 0 if the ByteBufs 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> + +<h3><a class='u' +name="clone" +>clone</a></h3> + +<pre>my $result = $byte_buf->clone();</pre> + +<p>Return a clone of the object.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Clownfish::ByteBuf isa <a href="../Clownfish/Obj.html" class="podlinkpod" +>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/perl/Clownfish/CharBuf.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/CharBuf.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/CharBuf.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,217 @@ +<!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::CharBuf â Apache Clownfish 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/perl/">Perl</a> » <a href="/docs/0.5.0/perl/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> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Clownfish::CharBuf - Growable buffer holding Unicode characters.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $buf = Clownfish::CharBuf->new; +$buf->cat('abc'); +$buf->cat_char(ord("\n")); +print $buf->to_string;</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $char_buf = Clownfish::CharBuf->new( + capacity => $capacity # default: 0 +);</pre> + +<p>Return a new CharBuf.</p> + +<ul> +<li><b>capacity</b> - Initial minimum capacity of the CharBuf, +in bytes.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="cat" +>cat</a></h3> + +<pre>$char_buf->cat($string);</pre> + +<p>Concatenate the contents of <a href="../Clownfish/String.html" class="podlinkpod" +>String</a> <code>string</code> onto the end of the caller.</p> + +<ul> +<li><b>string</b> - The String to concatenate.</li> +</ul> + +<h3><a class='u' +name="cat_char" +>cat_char</a></h3> + +<pre>$char_buf->cat_char($code_point);</pre> + +<p>Concatenate one Unicode character onto the end of the CharBuf.</p> + +<ul> +<li><b>code_point</b> - The code point of the Unicode character.</li> +</ul> + +<h3><a class='u' +name="grow" +>grow</a></h3> + +<pre>$char_buf->grow($capacity);</pre> + +<p>Assign more memory to the CharBuf, +if it doesn’t already have enough room to hold a string of <code>size</code> bytes. +Cannot shrink the allocation.</p> + +<ul> +<li><b>capacity</b> - The new minimum capacity of the ByteBuf.</li> +</ul> + +<h3><a class='u' +name="clear" +>clear</a></h3> + +<pre>$char_buf->clear();</pre> + +<p>Clear the CharBuf.</p> + +<h3><a class='u' +name="get_size" +>get_size</a></h3> + +<pre>my $int = $char_buf->get_size();</pre> + +<p>Return the size of the CharBuf’s content in bytes.</p> + +<h3><a class='u' +name="clone" +>clone</a></h3> + +<pre>my $result = $char_buf->clone();</pre> + +<p>Return a clone of the object.</p> + +<h3><a class='u' +name="yield_string" +>yield_string</a></h3> + +<pre>my $string = $char_buf->yield_string();</pre> + +<p>Return the content of the CharBuf as <a href="../Clownfish/String.html" class="podlinkpod" +>String</a> and clear the CharBuf. +This is more efficient than <a href="../Clownfish/Obj.html#to_string" class="podlinkpod" +>to_string()</a>.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Clownfish::CharBuf isa <a href="../Clownfish/Obj.html" class="podlinkpod" +>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/perl/Clownfish/Class.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Class.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Class.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,193 @@ +<!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::Class â Apache Clownfish 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/perl/">Perl</a> » <a href="/docs/0.5.0/perl/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> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Clownfish::Class - Class.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $class = Clownfish::Class->fetch_class('Foo::Bar'); +my $subclass = Clownfish::Class->singleton('Foo::Bar::Jr', $class);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Classes are first-class objects in Clownfish. +Class objects are instances of Clownfish::Class.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="fetch_class" +>fetch_class</a></h3> + +<pre>my $class = Clownfish::Class->fetch_class($class_name);</pre> + +<p>Find a registered class. +May return undef if the class is not registered.</p> + +<h3><a class='u' +name="singleton" +>singleton</a></h3> + +<pre>my $class = Clownfish::Class->singleton( + class_name => $class_name # required + parent => $parent # required +);</pre> + +<p>Return a singleton. +If a Class can be found in the registry based on the supplied class name, +it will be returned. +Otherwise, +a new Class will be created using <code>parent</code> as a base.</p> + +<p>If <code>parent</code> is undef, +an attempt will be made to find it. +If the attempt fails, +an error will result.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="make_obj" +>make_obj</a></h3> + +<pre>my $obj = $class->make_obj();</pre> + +<p>Create an empty object of the type defined by the Class: allocate, +assign its class and give it an initial refcount of 1. +The caller is responsible for initialization.</p> + +<h3><a class='u' +name="get_name" +>get_name</a></h3> + +<pre>my $string = $class->get_name();</pre> + +<p>Return the name of the class.</p> + +<h3><a class='u' +name="get_parent" +>get_parent</a></h3> + +<pre>my $result = $class->get_parent();</pre> + +<p>Return the parent class, +or undef for a root of the class hierarchy.</p> + +<h3><a class='u' +name="get_obj_alloc_size" +>get_obj_alloc_size</a></h3> + +<pre>my $int = $class->get_obj_alloc_size();</pre> + +<p>Return the number of bytes needed to hold an instance of the class.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Clownfish::Class isa <a href="../Clownfish/Obj.html" class="podlinkpod" +>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/perl/Clownfish/Docs/BuildingProjects.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Docs/BuildingProjects.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Docs/BuildingProjects.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,242 @@ +<!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 â Apache Clownfish 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/perl/">Perl</a> » <a href="/docs/0.5.0/perl/Clownfish/">Clownfish</a> » <a href="/docs/0.5.0/perl/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> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Clownfish::Docs::BuildingProjects - Building Apache Clownfish projects in C environments</p> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></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" class="podlinkpod" +>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><a class='u' +name="Running_cfc" +>Running cfc</a></h3> + +<pre>cfc [--source=<dir>] [--include=<dir>] [--parcel=<name>] + --dest=<dir> + [--header=<file>] [--footer=<file>]</pre> + +<h4><a class='u' +name="(8211)source" +>–source</a></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><a class='u' +name="(8211)include" +>–include</a></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><a class='u' +name="(8211)parcel" +>–parcel</a></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>cfc --parcel=Clownfish --dest=autogen</pre> + +<p>This option may be specified multiple times.</p> + +<h4><a class='u' +name="(8211)dest" +>–dest</a></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><a class='u' +name="(8211)header" +>–header</a></h4> + +<p>Specifies a file whose contents are added as a comment on top of each generated file.</p> + +<h4><a class='u' +name="(8211)footer" +>–footer</a></h4> + +<p>Specifies a file whose contents are added as a comment on the bottom of each generated file.</p> + +<h3><a class='u' +name="Including_the_generated_C_headers" +>Including the generated C headers</a></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><a class='u' +name="Compiling_the_generated_source_files" +>Compiling the generated source files</a></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><a class='u' +name="Linking" +>Linking</a></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/perl/Clownfish/Docs/ClassIntro.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Docs/ClassIntro.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Clownfish/Docs/ClassIntro.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,220 @@ +<!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 â Apache Clownfish 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/perl/">Perl</a> » <a href="/docs/0.5.0/perl/Clownfish/">Clownfish</a> » <a href="/docs/0.5.0/perl/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> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Clownfish::Docs::ClassIntro - Working with Apache Clownfish classes in C</p> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<h3><a class='u' +name="Inititalizing_Clownfish_parcels" +>Inititalizing Clownfish parcels</a></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>cfish_bootstrap_parcel();</pre> + +<h3><a class='u' +name="Including_the_generated_header_file" +>Including the generated header file</a></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>#define CFISH_USE_SHORT_NAMES + +#include <Clownfish/String.h> +#include <Clownfish/Vector.h></pre> + +<h3><a class='u' +name="Function_and_method_prefixes" +>Function and method prefixes</a></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><a class='u' +name="Creating_objects" +>Creating objects</a></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>// Notice the use of nickname "Str" in the constructor prefix. +String *name = Str_newf("%s %s", first, last);</pre> + +<h3><a class='u' +name="Calling_methods" +>Calling methods</a></h3> + +<p>Calling methods is straightforward. +The invocant is always passed as first argument.</p> + +<pre>// Notice the use of nickname "Str" in the method prefix. +size_t len = Str_Length(name);</pre> + +<p>Method names always start with an uppercase letter.</p> + +<h3><a class='u' +name="Memory_management" +>Memory management</a></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>DECREF(name);</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>obj = INCREF(obj);</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><a class='u' +name="Further_reading" +>Further reading</a></h3> + +<ul> +<li><a href="../../Clownfish/Docs/BuildingProjects.html" class="podlinkpod" +>Building Clownfish projects in C environments</a></li> + +<li><a href="../../Clownfish/Docs/WritingClasses.html" class="podlinkpod" +>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>
