Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Doc.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Doc.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Doc.html Tue Dec 2 17:54:11 2014 @@ -1,50 +1,116 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Document::Doc â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Document::Doc</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Document::Doc</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Doc</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_DOC</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Doc</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Document::Doc - A document.</p> +<p>Lucy::Document::Doc â A document.</p> <h2>Description</h2> <p>A Doc object is akin to a row in a database, in that it is made up of one or more fields, each of which has a value.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Doc* -<strong>lucy_Doc_init</strong>( - lucy_Doc* <strong>self</strong>, +<pre><code><span class="prefix">lucy_</span>Doc* +<span class="prefix">lucy_</span><strong>Doc_init</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong>, void* <strong>fields</strong>, int32_t <strong>doc_id</strong> ); </code></pre> <dl> -<dt><emph>fields</emph></dt> +<dt>fields</dt> <dd><p>Field-value pairs.</p> </dd> -<dt><emph>doc_id</emph></dt> +<dt>doc_id</dt> <dd><p>Internal Lucy document id. Default of 0 (an invalid doc id).</p> </dd> @@ -52,77 +118,77 @@ invalid doc id).</p> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Set_Doc_ID</dt> +<dt id="func_Set_Doc_ID">Set_Doc_ID</dt> <dd> <pre><code>void -<strong>LUCY_Doc_Set_Doc_ID</strong>( - lucy_Doc* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Doc_Set_Doc_ID</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong>, int32_t <strong>doc_id</strong> ); </code></pre> <p>Set internal Lucy document id.</p> </dd> -<dt>Get_Doc_ID</dt> +<dt id="func_Get_Doc_ID">Get_Doc_ID</dt> <dd> <pre><code>int32_t -<strong>LUCY_Doc_Get_Doc_ID</strong>( - lucy_Doc* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Doc_Get_Doc_ID</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong> ); </code></pre> <p>Retrieve internal Lucy document id.</p> </dd> -<dt>Get_Fields</dt> +<dt id="func_Get_Fields">Get_Fields</dt> <dd> <pre><code>void* -<strong>LUCY_Doc_Get_Fields</strong>( - lucy_Doc* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Doc_Get_Fields</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong> ); </code></pre> <p>Return the Doc's backing fields hash.</p> </dd> -<dt>Get_Size</dt> +<dt id="func_Get_Size">Get_Size</dt> <dd> <pre><code>uint32_t -<strong>LUCY_Doc_Get_Size</strong>( - lucy_Doc* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Doc_Get_Size</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong> ); </code></pre> <p>Return the number of fields in the Doc.</p> </dd> -<dt>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_Doc_Serialize</strong>( - lucy_Doc* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>Doc_Serialize</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong> ); </code></pre> </dd> -<dt>Deserialize</dt> +<dt id="func_Deserialize">Deserialize</dt> <dd> -<pre><code>lucy_Doc* // incremented -<strong>LUCY_Doc_Deserialize</strong>( - lucy_Doc* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>Doc* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Doc_Deserialize</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong>, <span class="comment">// decremented</span> + <span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <strong>instream</strong> ); </code></pre> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Hash.html">cfish_Hash*</a> // incremented -<strong>LUCY_Doc_Dump</strong>( - lucy_Doc* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Hash.html">Hash*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Doc_Dump</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong> ); </code></pre> </dd> -<dt>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code>lucy_Doc* // incremented -<strong>LUCY_Doc_Load</strong>( - lucy_Doc* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">lucy_</span>Doc* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Doc_Load</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_DocReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_DocReader.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_DocReader.html Tue Dec 2 17:54:11 2014 @@ -1,43 +1,109 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Index::DocReader â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Index::DocReader</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Index::DocReader</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>DocReader</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_DOCREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_DocReader</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::DocReader - Retrieve stored documents.</p> +<p>Lucy::Index::DocReader â Retrieve stored documents.</p> <h2>Description</h2> <p>DocReader defines the interface by which documents (with all stored fields) are retrieved from the index. The default implementation returns <a href="lucy_HitDoc.html">HitDoc</a> objects.</p> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Fetch_Doc</dt> +<dt id="func_Fetch_Doc">Fetch_Doc <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_HitDoc.html">lucy_HitDoc*</a> // incremented -<strong>LUCY_DocReader_Fetch_Doc</strong>( - lucy_DocReader* <strong>self</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_HitDoc.html">HitDoc*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>DocReader_Fetch_Doc</strong>( + <span class="prefix">lucy_</span>DocReader* <strong>self</strong>, int32_t <strong>doc_id</strong> ); </code></pre> @@ -45,86 +111,87 @@ are retrieved from the index. The defau <p><strong>Returns:</strong> a HitDoc.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Index::DataReader</h3><dl> -<dt>Aggregator</dt> +<h3>Methods inherited from Lucy::Index::DataReader</h3> +<dl> +<dt id="func_Aggregator">Aggregator <span class="comment">(abstract)</span></dt> <dd> -<pre><code>lucy_DataReader* // incremented -<strong>LUCY_DataReader_Aggregator</strong>( - lucy_DataReader* <strong>self</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>readers</strong>, - <a href="lucy_I32Array.html">lucy_I32Array*</a> <strong>offsets</strong> +<pre><code><span class="prefix">lucy_</span>DataReader* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>DataReader_Aggregator</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>readers</strong>, + <span class="prefix">lucy_</span><a href="lucy_I32Array.html">I32Array*</a> <strong>offsets</strong> ); </code></pre> <p>Create a reader which aggregates the output of several lower level readers. Return NULL if such a reader is not valid.</p> <dl> -<dt><emph>readers</emph></dt> +<dt>readers</dt> <dd><p>An array of DataReaders.</p> </dd> -<dt><emph>offsets</emph></dt> +<dt>offsets</dt> <dd><p>Doc id start offsets for each reader.</p> </dd> </dl> </dd> -<dt>Get_Schema</dt> +<dt id="func_Get_Schema">Get_Schema</dt> <dd> -<pre><code><a href="lucy_Schema.html">lucy_Schema*</a> -<strong>LUCY_DataReader_Get_Schema</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Schema</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "schema" member var.</p> </dd> -<dt>Get_Folder</dt> +<dt id="func_Get_Folder">Get_Folder</dt> <dd> -<pre><code><a href="lucy_Folder.html">lucy_Folder*</a> -<strong>LUCY_DataReader_Get_Folder</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Folder</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "folder" member var.</p> </dd> -<dt>Get_Snapshot</dt> +<dt id="func_Get_Snapshot">Get_Snapshot</dt> <dd> -<pre><code><a href="lucy_Snapshot.html">lucy_Snapshot*</a> -<strong>LUCY_DataReader_Get_Snapshot</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Snapshot</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "snapshot" member var.</p> </dd> -<dt>Get_Segments</dt> +<dt id="func_Get_Segments">Get_Segments</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> -<strong>LUCY_DataReader_Get_Segments</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Segments</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "segments" member var.</p> </dd> -<dt>Get_Segment</dt> +<dt id="func_Get_Segment">Get_Segment</dt> <dd> -<pre><code><a href="lucy_Segment.html">lucy_Segment*</a> -<strong>LUCY_DataReader_Get_Segment</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Segment.html">Segment*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Segment</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "segment" member var.</p> </dd> -<dt>Get_Seg_Tick</dt> +<dt id="func_Get_Seg_Tick">Get_Seg_Tick</dt> <dd> <pre><code>int32_t -<strong>LUCY_DataReader_Get_Seg_Tick</strong>( - lucy_DataReader* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Seg_Tick</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "seg_tick" member var.</p> </dd> -<dt>Close</dt> +<dt id="func_Close">Close <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_DataReader_Close</strong>( - lucy_DataReader* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>DataReader_Close</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Release external resources, e.g. streams. Implementations must be Modified: websites/staging/lucy/trunk/content/docs/c/lucy_EasyAnalyzer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_EasyAnalyzer.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_EasyAnalyzer.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Analysis::EasyAnalyzer â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Analysis::EasyAnalyzer</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Analysis::EasyAnalyzer</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>EasyAnalyzer</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_EASYANALYZER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_EasyAnalyzer</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Analysis::EasyAnalyzer - A simple analyzer chain.</p> +<p>Lucy::Analysis::EasyAnalyzer â A simple analyzer chain.</p> <h2>Description</h2> <p>EasyAnalyzer is an analyzer chain consisting of a <a href="lucy_StandardTokenizer.html">StandardTokenizer</a>, a @@ -50,72 +116,73 @@ tr => Turkish, </code></pre> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_EasyAnalyzer* -<strong>lucy_EasyAnalyzer_init</strong>( - lucy_EasyAnalyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>language</strong> +<pre><code><span class="prefix">lucy_</span>EasyAnalyzer* +<span class="prefix">lucy_</span><strong>EasyAnalyzer_init</strong>( + <span class="prefix">lucy_</span>EasyAnalyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>language</strong> ); </code></pre> <dl> -<dt><emph>language</emph></dt> +<dt>language</dt> <dd><p>An ISO code from the list of supported languages.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Methods inherited from Lucy::Analysis::Analyzer</h3><dl> -<dt>Transform</dt> +<h3>Methods inherited from Lucy::Analysis::Analyzer</h3> +<dl> +<dt id="func_Transform">Transform <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented -<strong>LUCY_Analyzer_Transform</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="lucy_Inversion.html">lucy_Inversion*</a> <strong>inversion</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Transform</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <strong>inversion</strong> ); </code></pre> <p>Take a single <a href="lucy_Inversion.html">Inversion</a> as input and returns an Inversion, either the same one (presumably transformed in some way), or a new one.</p> </dd> -<dt>Transform_Text</dt> +<dt id="func_Transform_Text">Transform_Text</dt> <dd> -<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented -<strong>LUCY_Analyzer_Transform_Text</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Transform_Text</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Kick off an analysis chain, creating an Inversion from string input. The default implementation simply creates an initial Inversion with a -single Token, then calls Transform(), but occasionally subclasses will +single Token, then calls <a href="lucy_Analyzer.html#func_Transform">Transform()</a>, but occasionally subclasses will provide an optimized implementation which minimizes string copies.</p> </dd> -<dt>Split</dt> +<dt id="func_Split">Split</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented -<strong>LUCY_Analyzer_Split</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Split</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Analyze text and return an array of token texts.</p> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Analyzer_Dump</strong>( - lucy_Analyzer* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Dump</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong> ); </code></pre> </dd> -<dt>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Analyzer_Load</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Load</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_FSFolder.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_FSFolder.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_FSFolder.html Tue Dec 2 17:54:11 2014 @@ -1,46 +1,112 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Store::FSFolder â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Store::FSFolder</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Store::FSFolder</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>FSFolder</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_FSFOLDER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_FSFolder</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Store::FSFolder - File System implementation of Folder.</p> +<p>Lucy::Store::FSFolder â File System implementation of Folder.</p> <h2>Description</h2> <p>Implementation of <a href="lucy_Folder.html">Folder</a> using a single file system directory and multiple files.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_FSFolder* -<strong>lucy_FSFolder_init</strong>( - lucy_FSFolder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span>FSFolder* +<span class="prefix">lucy_</span><strong>FSFolder_init</strong>( + <span class="prefix">lucy_</span>FSFolder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>Location of the index. If the specified directory does not exist already, it will NOT be created, in order to prevent misconfigured read applications from spawning bogus files -- so it may @@ -50,228 +116,229 @@ be necessary to create the directory you </dd> </dl> <h2>Methods</h2> -<h3>Methods inherited from Lucy::Store::Folder</h3><dl> -<dt>Get_Path</dt> +<h3>Methods inherited from Lucy::Store::Folder</h3> +<dl> +<dt id="func_Get_Path">Get_Path</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Folder_Get_Path</strong>( - lucy_Folder* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>Folder_Get_Path</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> ); </code></pre> <p>Getter for <code>path</code> member var.</p> </dd> -<dt>Open_Out</dt> +<dt id="func_Open_Out">Open_Out</dt> <dd> -<pre><code><a href="lucy_OutStream.html">lucy_OutStream*</a> // incremented -<strong>LUCY_Folder_Open_Out</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_Out</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Open an OutStream, or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> an OutStream.</p> </dd> -<dt>Open_In</dt> +<dt id="func_Open_In">Open_In</dt> <dd> -<pre><code><a href="lucy_InStream.html">lucy_InStream*</a> // incremented -<strong>LUCY_Folder_Open_In</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_In</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Open an InStream, or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> an InStream.</p> </dd> -<dt>Open_FileHandle</dt> +<dt id="func_Open_FileHandle">Open_FileHandle</dt> <dd> -<pre><code><a href="lucy_FileHandle.html">lucy_FileHandle*</a> // incremented -<strong>LUCY_Folder_Open_FileHandle</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_FileHandle.html">FileHandle*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_FileHandle</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong>, uint32_t <strong>flags</strong> ); </code></pre> <p>Open a FileHandle, or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> -<dt><emph>flags</emph></dt> +<dt>flags</dt> <dd><p>FileHandle flags.</p> </dd> </dl> <p><strong>Returns:</strong> a FileHandle.</p> </dd> -<dt>Open_Dir</dt> +<dt id="func_Open_Dir">Open_Dir</dt> <dd> -<pre><code><a href="lucy_DirHandle.html">lucy_DirHandle*</a> // incremented -<strong>LUCY_Folder_Open_Dir</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_DirHandle.html">DirHandle*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_Dir</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Open a DirHandle or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>Path to a subdirectory, relative to the Folder's path. If empty or NULL, returns a DirHandle for this Folder.</p> </dd> </dl> <p><strong>Returns:</strong> a DirHandle.</p> </dd> -<dt>MkDir</dt> +<dt id="func_MkDir">MkDir</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_MkDir</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_MkDir</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Create a subdirectory.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> true on success, false on failure (sets Err_error).</p> </dd> -<dt>Exists</dt> +<dt id="func_Exists">Exists</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Exists</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_Exists</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Indicate whether an entity exists at <code>path</code>.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> true if <code>path</code> exists.</p> </dd> -<dt>Delete</dt> +<dt id="func_Delete">Delete</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Delete</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_Delete</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Delete an entry from the folder.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> true if the deletion was successful.</p> </dd> -<dt>Delete_Tree</dt> +<dt id="func_Delete_Tree">Delete_Tree</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Delete_Tree</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_Delete_Tree</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Delete recursively, starting at <code>path</code></p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath specifying a file or subdirectory.</p> </dd> </dl> <p><strong>Returns:</strong> true if the whole tree is deleted successfully, false if any part remains.</p> </dd> -<dt>Rename</dt> +<dt id="func_Rename">Rename <span class="comment">(abstract)</span></dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Rename</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>from</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>to</strong> +<span class="prefix">LUCY_</span><strong>Folder_Rename</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>from</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>to</strong> ); </code></pre> <p>Rename a file or directory, or set Err_error and return false on failure. If an entry exists at <code>to</code>, the results are undefined.</p> <dl> -<dt><emph>from</emph></dt> +<dt>from</dt> <dd><p>The filepath prior to renaming.</p> </dd> -<dt><emph>to</emph></dt> +<dt>to</dt> <dd><p>The filepath after renaming.</p> </dd> </dl> <p><strong>Returns:</strong> true on success, false on failure.</p> </dd> -<dt>Hard_Link</dt> +<dt id="func_Hard_Link">Hard_Link <span class="comment">(abstract)</span></dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Hard_Link</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>from</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>to</strong> +<span class="prefix">LUCY_</span><strong>Folder_Hard_Link</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>from</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>to</strong> ); </code></pre> <p>Create a hard link at path <code>to</code> pointing at the existing file <code>from</code>, or set Err_error and return false on failure.</p> <p><strong>Returns:</strong> true on success, false on failure.</p> </dd> -<dt>Slurp_File</dt> +<dt id="func_Slurp_File">Slurp_File</dt> <dd> -<pre><code><a href="cfish_ByteBuf.html">cfish_ByteBuf*</a> // incremented -<strong>LUCY_Folder_Slurp_File</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_ByteBuf.html">ByteBuf*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Slurp_File</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Read a file and return its contents.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> -<dt><emph>return</emph></dt> +<dt>return</dt> <dd><p>the file's contents.</p> </dd> </dl> </dd> -<dt>Initialize</dt> +<dt id="func_Initialize">Initialize <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_Folder_Initialize</strong>( - lucy_Folder* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Folder_Initialize</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> ); </code></pre> <p>Perform implementation-specific initialization. For example: FSFolder creates its own directory.</p> </dd> -<dt>Check</dt> +<dt id="func_Check">Check <span class="comment">(abstract)</span></dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Check</strong>( - lucy_Folder* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Folder_Check</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> ); </code></pre> <p>Verify that operations may be performed on this Folder.</p> <p><strong>Returns:</strong> true on success.</p> </dd> -<dt>Close</dt> +<dt id="func_Close">Close <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_Folder_Close</strong>( - lucy_Folder* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Folder_Close</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> ); </code></pre> <p>Close the folder and release implementation-specific resources.</p> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_FieldType.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_FieldType.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_FieldType.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Plan::FieldType â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Plan::FieldType</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Plan::FieldType</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>FType</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_FIELDTYPE</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_FieldType</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Plan::FieldType - Define a field's behavior.</p> +<p>Lucy::Plan::FieldType â Define a field's behavior.</p> <h2>Description</h2> <p>FieldType is an abstract class defining a set of traits and behaviors which may be associated with one or more field names.</p> @@ -49,127 +115,124 @@ not settable.</p> and scoring behavior for the field. It is required if the field is <code>indexed</code>.</p> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Dump</dt> -<dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_FType_Dump</strong>( - lucy_FieldType* <strong>self</strong> -); -</code></pre> -</dd> -<dt>Load</dt> -<dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_FType_Load</strong>( - lucy_FieldType* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> -); -</code></pre> -</dd> -</dl> -<h3>Novel methods</h3> -<dl> -<dt>Set_Boost</dt> +<dt id="func_Set_Boost">Set_Boost</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Boost</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Boost</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, float <strong>boost</strong> ); </code></pre> <p>Setter for <code>boost</code>.</p> </dd> -<dt>Get_Boost</dt> +<dt id="func_Get_Boost">Get_Boost</dt> <dd> <pre><code>float -<strong>LUCY_FType_Get_Boost</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Get_Boost</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>boost</code>.</p> </dd> -<dt>Set_Indexed</dt> +<dt id="func_Set_Indexed">Set_Indexed</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Indexed</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Indexed</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, bool <strong>indexed</strong> ); </code></pre> <p>Setter for <code>indexed</code>.</p> </dd> -<dt>Indexed</dt> +<dt id="func_Indexed">Indexed</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Indexed</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Indexed</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>indexed</code>.</p> </dd> -<dt>Set_Stored</dt> +<dt id="func_Set_Stored">Set_Stored</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Stored</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Stored</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, bool <strong>stored</strong> ); </code></pre> <p>Setter for <code>stored</code>.</p> </dd> -<dt>Stored</dt> +<dt id="func_Stored">Stored</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Stored</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Stored</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>stored</code>.</p> </dd> -<dt>Set_Sortable</dt> +<dt id="func_Set_Sortable">Set_Sortable</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Sortable</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Sortable</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, bool <strong>sortable</strong> ); </code></pre> <p>Setter for <code>sortable</code>.</p> </dd> -<dt>Sortable</dt> +<dt id="func_Sortable">Sortable</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Sortable</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Sortable</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>sortable</code>.</p> </dd> -<dt>Binary</dt> +<dt id="func_Binary">Binary</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Binary</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Binary</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Indicate whether the field contains binary data.</p> </dd> -<dt>Compare_Values</dt> +<dt id="func_Compare_Values">Compare_Values</dt> <dd> <pre><code>int32_t -<strong>LUCY_FType_Compare_Values</strong>( - lucy_FieldType* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>a</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>b</strong> +<span class="prefix">LUCY_</span><strong>FType_Compare_Values</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>a</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>b</strong> ); </code></pre> <p>Compare two values for the field. The default implementation -dispatches to the Compare_To() method of argument <code>a</code>.</p> +dispatches to the <a href="lucy_FieldType.html#func_Compare_To">Compare_To()</a> method of argument <code>a</code>.</p> <p><strong>Returns:</strong> a negative number if a is "less than" b, 0 if they are "equal", and a positive number if a is "greater than" b.</p> </dd> +<dt id="func_Dump">Dump <span class="comment">(abstract)</span></dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>FType_Dump</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> +); +</code></pre> +</dd> +<dt id="func_Load">Load <span class="comment">(abstract)</span></dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>FType_Load</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>dump</strong> +); +</code></pre> +</dd> </dl> <h2>Inheritance</h2> <p>Lucy::Plan::FieldType is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Folder.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Folder.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Folder.html Tue Dec 2 17:54:11 2014 @@ -1,281 +1,344 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Store::Folder â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Store::Folder</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Store::Folder</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Folder</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_FOLDER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Folder</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Store::Folder - Abstract class representing a directory.</p> +<p>Lucy::Store::Folder â Abstract class representing a directory.</p> <h2>Description</h2> <p>A "file" within a Folder might be a real file on disk -- or it might be a -RAM buffer. Similarly, Delete() might delete a file from the file system, or +RAM buffer. Similarly, <a href="lucy_Folder.html#func_Delete">Delete()</a> might delete a file from the file system, or a key-value pair from a hash, or something else.</p> <p>The archetypal implementation of Folder, <a href="lucy_FSFolder.html">FSFolder</a>, represents a directory on the file system holding a collection of files.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Folder* -<strong>lucy_Folder_init</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span>Folder* +<span class="prefix">lucy_</span><strong>Folder_init</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> </dd> </dl> <h2>Methods</h2> -<h3>Abstract methods</h3> -<dl> -<dt>Rename</dt> -<dd> -<pre><code>bool -<strong>LUCY_Folder_Rename</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>from</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>to</strong> -); -</code></pre> -<p>Rename a file or directory, or set Err_error and return false on -failure. If an entry exists at <code>to</code>, the results are -undefined.</p> +<h3>Novel methods</h3 <dl> -<dt><emph>from</emph></dt> -<dd><p>The filepath prior to renaming.</p> -</dd> -<dt><emph>to</emph></dt> -<dd><p>The filepath after renaming.</p> -</dd> -</dl> -<p><strong>Returns:</strong> true on success, false on failure.</p> -</dd> -<dt>Hard_Link</dt> -<dd> -<pre><code>bool -<strong>LUCY_Folder_Hard_Link</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>from</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>to</strong> -); -</code></pre> -<p>Create a hard link at path <code>to</code> pointing at the existing -file <code>from</code>, or set Err_error and return false on failure.</p> -<p><strong>Returns:</strong> true on success, false on failure.</p> -</dd> -<dt>Initialize</dt> -<dd> -<pre><code>void -<strong>LUCY_Folder_Initialize</strong>( - lucy_Folder* <strong>self</strong> -); -</code></pre> -<p>Perform implementation-specific initialization. For example: FSFolder -creates its own directory.</p> -</dd> -<dt>Check</dt> -<dd> -<pre><code>bool -<strong>LUCY_Folder_Check</strong>( - lucy_Folder* <strong>self</strong> -); -</code></pre> -<p>Verify that operations may be performed on this Folder.</p> -<p><strong>Returns:</strong> true on success.</p> -</dd> -<dt>Close</dt> +<dt id="func_Get_Path">Get_Path</dt> <dd> -<pre><code>void -<strong>LUCY_Folder_Close</strong>( - lucy_Folder* <strong>self</strong> -); -</code></pre> -<p>Close the folder and release implementation-specific resources.</p> -</dd> -</dl> -<h3>Novel methods</h3> -<dl> -<dt>Get_Path</dt> -<dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Folder_Get_Path</strong>( - lucy_Folder* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>Folder_Get_Path</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> ); </code></pre> <p>Getter for <code>path</code> member var.</p> </dd> -<dt>Open_Out</dt> +<dt id="func_Open_Out">Open_Out</dt> <dd> -<pre><code><a href="lucy_OutStream.html">lucy_OutStream*</a> // incremented -<strong>LUCY_Folder_Open_Out</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_Out</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Open an OutStream, or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> an OutStream.</p> </dd> -<dt>Open_In</dt> +<dt id="func_Open_In">Open_In</dt> <dd> -<pre><code><a href="lucy_InStream.html">lucy_InStream*</a> // incremented -<strong>LUCY_Folder_Open_In</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_In</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Open an InStream, or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> an InStream.</p> </dd> -<dt>Open_FileHandle</dt> +<dt id="func_Open_FileHandle">Open_FileHandle</dt> <dd> -<pre><code><a href="lucy_FileHandle.html">lucy_FileHandle*</a> // incremented -<strong>LUCY_Folder_Open_FileHandle</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_FileHandle.html">FileHandle*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_FileHandle</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong>, uint32_t <strong>flags</strong> ); </code></pre> <p>Open a FileHandle, or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> -<dt><emph>flags</emph></dt> +<dt>flags</dt> <dd><p>FileHandle flags.</p> </dd> </dl> <p><strong>Returns:</strong> a FileHandle.</p> </dd> -<dt>Open_Dir</dt> +<dt id="func_Open_Dir">Open_Dir</dt> <dd> -<pre><code><a href="lucy_DirHandle.html">lucy_DirHandle*</a> // incremented -<strong>LUCY_Folder_Open_Dir</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_DirHandle.html">DirHandle*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_Dir</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Open a DirHandle or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>Path to a subdirectory, relative to the Folder's path. If empty or NULL, returns a DirHandle for this Folder.</p> </dd> </dl> <p><strong>Returns:</strong> a DirHandle.</p> </dd> -<dt>MkDir</dt> +<dt id="func_MkDir">MkDir</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_MkDir</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_MkDir</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Create a subdirectory.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> true on success, false on failure (sets Err_error).</p> </dd> -<dt>Exists</dt> +<dt id="func_Exists">Exists</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Exists</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_Exists</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Indicate whether an entity exists at <code>path</code>.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> true if <code>path</code> exists.</p> </dd> -<dt>Delete</dt> +<dt id="func_Delete">Delete</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Delete</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_Delete</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Delete an entry from the folder.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> true if the deletion was successful.</p> </dd> -<dt>Delete_Tree</dt> +<dt id="func_Delete_Tree">Delete_Tree</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Delete_Tree</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_Delete_Tree</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Delete recursively, starting at <code>path</code></p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath specifying a file or subdirectory.</p> </dd> </dl> <p><strong>Returns:</strong> true if the whole tree is deleted successfully, false if any part remains.</p> </dd> -<dt>Slurp_File</dt> +<dt id="func_Rename">Rename <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>bool +<span class="prefix">LUCY_</span><strong>Folder_Rename</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>from</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>to</strong> +); +</code></pre> +<p>Rename a file or directory, or set Err_error and return false on +failure. If an entry exists at <code>to</code>, the results are +undefined.</p> +<dl> +<dt>from</dt> +<dd><p>The filepath prior to renaming.</p> +</dd> +<dt>to</dt> +<dd><p>The filepath after renaming.</p> +</dd> +</dl> +<p><strong>Returns:</strong> true on success, false on failure.</p> +</dd> +<dt id="func_Hard_Link">Hard_Link <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="cfish_ByteBuf.html">cfish_ByteBuf*</a> // incremented -<strong>LUCY_Folder_Slurp_File</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code>bool +<span class="prefix">LUCY_</span><strong>Folder_Hard_Link</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>from</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>to</strong> +); +</code></pre> +<p>Create a hard link at path <code>to</code> pointing at the existing +file <code>from</code>, or set Err_error and return false on failure.</p> +<p><strong>Returns:</strong> true on success, false on failure.</p> +</dd> +<dt id="func_Slurp_File">Slurp_File</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="cfish_ByteBuf.html">ByteBuf*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Slurp_File</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Read a file and return its contents.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> -<dt><emph>return</emph></dt> +<dt>return</dt> <dd><p>the file's contents.</p> </dd> </dl> </dd> +<dt id="func_Initialize">Initialize <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">LUCY_</span><strong>Folder_Initialize</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> +); +</code></pre> +<p>Perform implementation-specific initialization. For example: FSFolder +creates its own directory.</p> +</dd> +<dt id="func_Check">Check <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>bool +<span class="prefix">LUCY_</span><strong>Folder_Check</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> +); +</code></pre> +<p>Verify that operations may be performed on this Folder.</p> +<p><strong>Returns:</strong> true on success.</p> +</dd> +<dt id="func_Close">Close <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">LUCY_</span><strong>Folder_Close</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> +); +</code></pre> +<p>Close the folder and release implementation-specific resources.</p> +</dd> </dl> <h2>Inheritance</h2> <p>Lucy::Store::Folder is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_FullTextType.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_FullTextType.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_FullTextType.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Plan::FullTextType â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Plan::FullTextType</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Plan::FullTextType</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>FullTextType</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_FULLTEXTTYPE</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_FullTextType</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Plan::FullTextType - Full-text search field type.</p> +<p>Lucy::Plan::FullTextType â Full-text search field type.</p> <h2>Description</h2> <p>Lucy::Plan::FullTextType is an implementation of <a href="lucy_FieldType.html">FieldType</a> tuned for "full text search".</p> @@ -36,53 +102,53 @@ normalize the text so that it can be sea <a href="lucy_StringType.html">StringType</a>.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_FullTextType* -<strong>lucy_FullTextType_init</strong>( - lucy_FullTextType* <strong>self</strong>, - <a href="lucy_Analyzer.html">lucy_Analyzer*</a> <strong>analyzer</strong> +<pre><code><span class="prefix">lucy_</span>FullTextType* +<span class="prefix">lucy_</span><strong>FullTextType_init</strong>( + <span class="prefix">lucy_</span>FullTextType* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Analyzer.html">Analyzer*</a> <strong>analyzer</strong> ); </code></pre> <dl> -<dt><emph>analyzer</emph></dt> +<dt>analyzer</dt> <dd><p>An Analyzer.</p> </dd> -<dt><emph>boost</emph></dt> +<dt>boost</dt> <dd><p>floating point per-field boost.</p> </dd> -<dt><emph>indexed</emph></dt> +<dt>indexed</dt> <dd><p>boolean indicating whether the field should be indexed.</p> </dd> -<dt><emph>stored</emph></dt> +<dt>stored</dt> <dd><p>boolean indicating whether the field should be stored.</p> </dd> -<dt><emph>sortable</emph></dt> +<dt>sortable</dt> <dd><p>boolean indicating whether the field should be sortable.</p> </dd> -<dt><emph>highlightable</emph></dt> +<dt>highlightable</dt> <dd><p>boolean indicating whether the field should be highlightable.</p> </dd> </dl> </dd> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_FullTextType* // incremented -<strong>lucy_FullTextType_new</strong>( - <a href="lucy_Analyzer.html">lucy_Analyzer*</a> <strong>analyzer</strong> +<pre><code><span class="prefix">lucy_</span>FullTextType* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>FullTextType_new</strong>( + <span class="prefix">lucy_</span><a href="lucy_Analyzer.html">Analyzer*</a> <strong>analyzer</strong> ); </code></pre> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Set_Highlightable</dt> +<dt id="func_Set_Highlightable">Set_Highlightable</dt> <dd> <pre><code>void -<strong>LUCY_FullTextType_Set_Highlightable</strong>( - lucy_FullTextType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FullTextType_Set_Highlightable</strong>( + <span class="prefix">lucy_</span>FullTextType* <strong>self</strong>, bool <strong>highlightable</strong> ); </code></pre> @@ -90,146 +156,147 @@ highlightable.</p> <a href="lucy_Highlighter.html">Highlighter</a> for excerpt selection and search term highlighting.</p> </dd> -<dt>Highlightable</dt> +<dt id="func_Highlightable">Highlightable</dt> <dd> <pre><code>bool -<strong>LUCY_FullTextType_Highlightable</strong>( - lucy_FullTextType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FullTextType_Highlightable</strong>( + <span class="prefix">lucy_</span>FullTextType* <strong>self</strong> ); </code></pre> <p>Accessor for "highlightable" property.</p> </dd> -<dt>Get_Analyzer</dt> +<dt id="func_Get_Analyzer">Get_Analyzer</dt> <dd> -<pre><code><a href="lucy_Analyzer.html">lucy_Analyzer*</a> -<strong>LUCY_FullTextType_Get_Analyzer</strong>( - lucy_FullTextType* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Analyzer.html">Analyzer*</a> +<span class="prefix">LUCY_</span><strong>FullTextType_Get_Analyzer</strong>( + <span class="prefix">lucy_</span>FullTextType* <strong>self</strong> ); </code></pre> </dd> -<dt>Make_Similarity</dt> +<dt id="func_Make_Similarity">Make_Similarity</dt> <dd> -<pre><code><a href="lucy_Similarity.html">lucy_Similarity*</a> // incremented -<strong>LUCY_FullTextType_Make_Similarity</strong>( - lucy_FullTextType* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Similarity.html">Similarity*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>FullTextType_Make_Similarity</strong>( + <span class="prefix">lucy_</span>FullTextType* <strong>self</strong> ); </code></pre> </dd> </dl> -<h3>Methods inherited from Lucy::Plan::FieldType</h3><dl> -<dt>Set_Boost</dt> +<h3>Methods inherited from Lucy::Plan::FieldType</h3> +<dl> +<dt id="func_Set_Boost">Set_Boost</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Boost</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Boost</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, float <strong>boost</strong> ); </code></pre> <p>Setter for <code>boost</code>.</p> </dd> -<dt>Get_Boost</dt> +<dt id="func_Get_Boost">Get_Boost</dt> <dd> <pre><code>float -<strong>LUCY_FType_Get_Boost</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Get_Boost</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>boost</code>.</p> </dd> -<dt>Set_Indexed</dt> +<dt id="func_Set_Indexed">Set_Indexed</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Indexed</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Indexed</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, bool <strong>indexed</strong> ); </code></pre> <p>Setter for <code>indexed</code>.</p> </dd> -<dt>Indexed</dt> +<dt id="func_Indexed">Indexed</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Indexed</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Indexed</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>indexed</code>.</p> </dd> -<dt>Set_Stored</dt> +<dt id="func_Set_Stored">Set_Stored</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Stored</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Stored</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, bool <strong>stored</strong> ); </code></pre> <p>Setter for <code>stored</code>.</p> </dd> -<dt>Stored</dt> +<dt id="func_Stored">Stored</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Stored</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Stored</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>stored</code>.</p> </dd> -<dt>Set_Sortable</dt> +<dt id="func_Set_Sortable">Set_Sortable</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Sortable</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Sortable</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, bool <strong>sortable</strong> ); </code></pre> <p>Setter for <code>sortable</code>.</p> </dd> -<dt>Sortable</dt> +<dt id="func_Sortable">Sortable</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Sortable</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Sortable</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>sortable</code>.</p> </dd> -<dt>Binary</dt> +<dt id="func_Binary">Binary</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Binary</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Binary</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Indicate whether the field contains binary data.</p> </dd> -<dt>Compare_Values</dt> +<dt id="func_Compare_Values">Compare_Values</dt> <dd> <pre><code>int32_t -<strong>LUCY_FType_Compare_Values</strong>( - lucy_FieldType* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>a</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>b</strong> +<span class="prefix">LUCY_</span><strong>FType_Compare_Values</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>a</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>b</strong> ); </code></pre> <p>Compare two values for the field. The default implementation -dispatches to the Compare_To() method of argument <code>a</code>.</p> +dispatches to the <a href="lucy_FieldType.html#func_Compare_To">Compare_To()</a> method of argument <code>a</code>.</p> <p><strong>Returns:</strong> a negative number if a is "less than" b, 0 if they are "equal", and a positive number if a is "greater than" b.</p> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_FType_Dump</strong>( - lucy_FieldType* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>FType_Dump</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> </dd> -<dt>Load</dt> +<dt id="func_Load">Load <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_FType_Load</strong>( - lucy_FieldType* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>FType_Load</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd>
