Added: incubator/lucene4c/trunk/www/apidocs/lcn__types_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__types_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__types_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__types_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,153 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_types.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_types.h</h1><a href="lcn__types_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_types.h</span> +00019 <span class="comment"> * @brief Random stuff that doesn't fit anywhere else</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_TYPES_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_TYPES_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include <apr.h></span> +00026 <span class="preprocessor">#include <apr_pools.h></span> +00027 +00028 <span class="preprocessor">#ifdef __cplusplus</span> +00029 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00030 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00031 <span class="comment"></span> +00032 <span class="comment">/** Since we use C89 we need a boolean type... */</span> +<a name="l00033"></a><a class="code" href="lcn__types_8h.html#a8">00033</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="lcn__types_8h.html#a8">lcn_boolean_t</a>; +00034 +00035 <span class="preprocessor">#ifndef FALSE</span> +00036 <span class="preprocessor"></span><span class="comment">/** You figure it out. */</span> +<a name="l00037"></a><a class="code" href="lcn__types_8h.html#a0">00037</a> <span class="preprocessor">#define FALSE 0</span> +00038 <span class="preprocessor"></span><span class="preprocessor">#endif</span> +00039 <span class="preprocessor"></span> +00040 <span class="preprocessor">#ifndef TRUE</span> +00041 <span class="preprocessor"></span><span class="comment">/** You figure it out. */</span> +<a name="l00042"></a><a class="code" href="lcn__types_8h.html#a1">00042</a> <span class="preprocessor">#define TRUE 1</span> +00043 <span class="preprocessor"></span><span class="preprocessor">#endif</span> +00044 <span class="preprocessor"></span><span class="comment"></span> +00045 <span class="comment">/** Our exception object. */</span> +<a name="l00046"></a><a class="code" href="structlcn__error__t.html">00046</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structlcn__error__t.html">lcn_error_t</a> { +<a name="l00047"></a><a class="code" href="structlcn__error__t.html#o0">00047</a> apr_status_t <a class="code" href="structlcn__error__t.html#o0">apr_err</a>; <span class="comment">/**< The underlying APR error */</span> +00048 +<a name="l00049"></a><a class="code" href="structlcn__error__t.html#o1">00049</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structlcn__error__t.html#o1">message</a>; <span class="comment">/**< Human readable error message */</span> +00050 +<a name="l00051"></a><a class="code" href="structlcn__error__t.html#o2">00051</a> <span class="keyword">struct </span><a class="code" href="structlcn__error__t.html">lcn_error_t</a> *<a class="code" href="structlcn__error__t.html#o2">child</a>; <span class="comment">/**< The next error in the chain, or @c NULL */</span> +00052 +<a name="l00053"></a><a class="code" href="structlcn__error__t.html#o3">00053</a> apr_pool_t *<a class="code" href="structlcn__error__t.html#o3">pool</a>; <span class="comment">/**< The pool this error was allocated in */</span> +00054 +00055 } <a class="code" href="structlcn__error__t.html">lcn_error_t</a>; +00056 <span class="comment"></span> +00057 <span class="comment">/** The best kind of error. */</span> +<a name="l00058"></a><a class="code" href="lcn__types_8h.html#a2">00058</a> <span class="preprocessor">#define LCN_NO_ERROR 0</span> +00059 <span class="preprocessor"></span><span class="comment"></span> +00060 <span class="comment">/** Create a new error with underlying error code @a apr_err, wrapping around</span> +00061 <span class="comment"> * @a child, with error message @a message.</span> +00062 <span class="comment"> */</span> +00063 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00064 <a class="code" href="lcn__types_8h.html#a11">lcn_error_create</a> (apr_status_t apr_err, +00065 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> *child, +00066 <span class="keyword">const</span> <span class="keywordtype">char</span> *message); +00067 <span class="comment"></span> +00068 <span class="comment">/** A @c printf style version of @c lcn_error_create. */</span> +00069 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00070 <a class="code" href="lcn__types_8h.html#a12">lcn_error_createf</a> (apr_status_t apr_err, +00071 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> *child, +00072 <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, +00073 ...) +00074 #ifdef DOXYGEN_SHOULD_SKIP_THIS +00075 ; +00076 <span class="preprocessor">#else</span> +00077 <span class="preprocessor"></span> __attribute__ ((format (printf, 3, 4))); +00078 <span class="preprocessor">#endif</span> +00079 <span class="preprocessor"></span><span class="comment"></span> +00080 <span class="comment">/** Destroy @a error. */</span> +00081 <span class="keywordtype">void</span> <a class="code" href="lcn__types_8h.html#a13">lcn_error_clear</a> (<a class="code" href="structlcn__error__t.html">lcn_error_t</a> *error); +00082 <span class="comment"></span> +00083 <span class="comment">/** A handy wrapper for functions that return an @c lcn_error_t, just returns</span> +00084 <span class="comment"> * the error to our caller if it's not @c LCN_NO_ERROR.</span> +00085 <span class="comment"> */</span> +<a name="l00086"></a><a class="code" href="lcn__types_8h.html#a3">00086</a> <span class="preprocessor">#define LCN_ERR(expr) \</span> +00087 <span class="preprocessor"> do { \</span> +00088 <span class="preprocessor"> lcn_error_t *lcn_err__temp = (expr); \</span> +00089 <span class="preprocessor"> if (lcn_err__temp) \</span> +00090 <span class="preprocessor"> return lcn_err__temp; \</span> +00091 <span class="preprocessor"> } while (0)</span> +00092 <span class="preprocessor"></span><span class="comment"></span> +00093 <span class="comment">/** A java style 16 bit char. */</span> +<a name="l00094"></a><a class="code" href="lcn__types_8h.html#a10">00094</a> <span class="keyword">typedef</span> apr_uint16_t <a class="code" href="lcn__types_8h.html#a10">lcn_char_t</a>; +00095 <span class="comment"></span> +00096 <span class="comment">/** Count the number of characters in a string of lcn_char_t's */</span> +00097 apr_size_t <a class="code" href="lcn__types_8h.html#a14">lcn_strlen</a> (<span class="keyword">const</span> lcn_char_t *str); +00098 <span class="comment"></span> +00099 <span class="comment">/** Get the size of a string of lcn_char_t's in bytes */</span> +<a name="l00100"></a><a class="code" href="lcn__types_8h.html#a4">00100</a> <span class="preprocessor">#define LCN_STRING_SIZE(str) ((lcn_strlen (str) + 1) * sizeof (lcn_char_t))</span> +00101 <span class="preprocessor"></span><span class="comment"></span> +00102 <span class="comment">/** Lexographically compare @a first and @a second. */</span> +00103 <span class="keywordtype">int</span> <a class="code" href="lcn__types_8h.html#a15">lcn_strcmp</a> (<span class="keyword">const</span> lcn_char_t *first, <span class="keyword">const</span> lcn_char_t *second); +00104 <span class="comment"></span> +00105 <span class="comment">/** Return a copy of @a str, allocated in @a pool. */</span> +00106 <a class="code" href="lcn__types_8h.html#a10">lcn_char_t</a> * +00107 <a class="code" href="lcn__types_8h.html#a16">lcn_strcpy</a> (<span class="keyword">const</span> lcn_char_t *str, apr_pool_t *pool); +00108 <span class="comment"></span> +00109 <span class="comment">/** Convert @a in into a cstring @a out, allocated in @a pool.</span> +00110 <span class="comment"> *</span> +00111 <span class="comment"> * This will result in an error if @a in cannot be represented in ASCII</span> +00112 <span class="comment"> * characters.</span> +00113 <span class="comment"> */</span> +00114 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00115 <a class="code" href="lcn__types_8h.html#a17">lcn_str_to_cstring</a> (<span class="keywordtype">char</span> **out, <span class="keyword">const</span> lcn_char_t *in, apr_pool_t *pool); +00116 <span class="comment"></span> +00117 <span class="comment">/** Create a string of @c lcn_char_ts that corresponds to the contents of </span> +00118 <span class="comment"> * @a in, allocated in @a pool.</span> +00119 <span class="comment"> */</span> +00120 <a class="code" href="lcn__types_8h.html#a10">lcn_char_t</a> * +00121 <a class="code" href="lcn__types_8h.html#a18">lcn_str_from_cstring</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *in, apr_pool_t *pool); +00122 <span class="comment"></span> +00123 <span class="comment">/** Index into an apr_array_header_t */</span> +<a name="l00124"></a><a class="code" href="lcn__types_8h.html#a5">00124</a> <span class="preprocessor">#define APR_ARRAY_IDX(ary,i,type) (((type *)(ary)->elts)[i])</span> +00125 <span class="preprocessor"></span><span class="comment"></span> +00126 <span class="comment">/** Easier array-pushing syntax */</span> +<a name="l00127"></a><a class="code" href="lcn__types_8h.html#a6">00127</a> <span class="preprocessor">#define APR_ARRAY_PUSH(ary,type) (*((type *)apr_array_push (ary)))</span> +00128 <span class="preprocessor"></span><span class="comment"></span> +00129 <span class="comment">/** A convenience wrapper for @c apr_pool_create. */</span> +00130 apr_pool_t *<a class="code" href="lcn__types_8h.html#a19">lcn_pool_create</a> (apr_pool_t *parent); +00131 <span class="comment"></span> +00132 <span class="comment">/** For symmetry with @c lcn_pool_create. */</span> +<a name="l00133"></a><a class="code" href="lcn__types_8h.html#a7">00133</a> <span class="preprocessor">#define lcn_pool_destroy apr_pool_destroy</span> +00134 <span class="preprocessor"></span> +00135 <span class="preprocessor">#ifdef __cplusplus</span> +00136 <span class="preprocessor"></span>} +00137 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00138 +00139 <span class="preprocessor">#endif</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html>
Added: incubator/lucene4c/trunk/www/apidocs/lcn__types_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__types_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__types_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__types_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,193 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_types.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_types.h File Reference</h1>Random stuff that doesn't fit anywhere else. <a href="#_details">More...</a> +<p> +<code>#include <apr.h></code><br> +<code>#include <apr_pools.h></code><br> + +<p> +<a href="lcn__types_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_types.h::FALSE"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a0">FALSE</a> 0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">You figure it out. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_types.h::TRUE"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a1">TRUE</a> 1</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">You figure it out. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_types.h::LCN_NO_ERROR"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a2">LCN_NO_ERROR</a> 0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The best kind of error. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a3">LCN_ERR</a>(expr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A handy wrapper for functions that return an <code><a class="el" href="structlcn__error__t.html">lcn_error_t</a></code>, just returns the error to our caller if it's not <code>LCN_NO_ERROR</code>. <a href="#a3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="lcn_types.h::LCN_STRING_SIZE"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a4">LCN_STRING_SIZE</a>(str) ((lcn_strlen (str) + 1) * sizeof (<a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a>))</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of a string of lcn_char_t's in bytes. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="lcn_types.h::APR_ARRAY_IDX"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a5">APR_ARRAY_IDX</a>(ary, i, type) (((type *)(ary)->elts)[i])</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Index into an apr_array_header_t. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="lcn_types.h::APR_ARRAY_PUSH"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a6">APR_ARRAY_PUSH</a>(ary, type) (*((type *)apr_array_push (ary)))</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Easier array-pushing syntax. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="lcn_types.h::lcn_pool_destroy"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a7">lcn_pool_destroy</a> apr_pool_destroy</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">For symmetry with <code>lcn_pool_create</code>. <br></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="lcn_types.h::lcn_boolean_t"></a> +typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a8">lcn_boolean_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Since we use C89 we need a boolean type... <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="lcn_types.h::lcn_error_t"></a> +typedef <a class="el" href="structlcn__error__t.html">lcn_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a9">lcn_error_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Our exception object. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="lcn_types.h::lcn_char_t"></a> +typedef apr_uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A java style 16 bit char. <br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11" doxytag="lcn_types.h::lcn_error_create"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a11">lcn_error_create</a> (apr_status_t apr_err, <a class="el" href="structlcn__error__t.html">lcn_error_t</a> *child, const char *message)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new error with underlying error code <em>apr_err</em>, wrapping around <em>child</em>, with error message <em>message</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12" doxytag="lcn_types.h::lcn_error_createf"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a12">lcn_error_createf</a> (apr_status_t apr_err, <a class="el" href="structlcn__error__t.html">lcn_error_t</a> *child, const char *fmt,...)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A <code>printf</code> style version of <code>lcn_error_create</code>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13" doxytag="lcn_types.h::lcn_error_clear"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a13">lcn_error_clear</a> (<a class="el" href="structlcn__error__t.html">lcn_error_t</a> *error)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy <em>error</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14" doxytag="lcn_types.h::lcn_strlen"></a> +apr_size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a14">lcn_strlen</a> (const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *str)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Count the number of characters in a string of lcn_char_t's. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a15" doxytag="lcn_types.h::lcn_strcmp"></a> +int </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a15">lcn_strcmp</a> (const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *first, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *second)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Lexographically compare <em>first</em> and <em>second</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a16" doxytag="lcn_types.h::lcn_strcpy"></a> +<a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a16">lcn_strcpy</a> (const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *str, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a copy of <em>str</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a17">lcn_str_to_cstring</a> (char **out, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *in, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert <em>in</em> into a cstring <em>out</em>, allocated in <em>pool</em>. <a href="#a17"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a18" doxytag="lcn_types.h::lcn_str_from_cstring"></a> +<a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a18">lcn_str_from_cstring</a> (const char *in, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a string of <code>lcn_char_ts</code> that corresponds to the contents of <em>in</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a19" doxytag="lcn_types.h::lcn_pool_create"></a> +apr_pool_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__types_8h.html#a19">lcn_pool_create</a> (apr_pool_t *parent)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A convenience wrapper for <code>apr_pool_create</code>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Random stuff that doesn't fit anywhere else. +<p> + +<p> +Definition in file <a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>.<hr><h2>Define Documentation</h2> +<a class="anchor" name="a3" doxytag="lcn_types.h::LCN_ERR"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">#define LCN_ERR </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">expr </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordflow">do</span> { \ + <a class="code" href="structlcn__error__t.html">lcn_error_t</a> *lcn_err__temp = (expr); \ + <span class="keywordflow">if</span> (lcn_err__temp) \ + <span class="keywordflow">return</span> lcn_err__temp; \ + } <span class="keywordflow">while</span> (0) +</pre></div>A handy wrapper for functions that return an <code><a class="el" href="structlcn__error__t.html">lcn_error_t</a></code>, just returns the error to our caller if it's not <code>LCN_NO_ERROR</code>. +<p> + +<p> +Definition at line <a class="el" href="lcn__types_8h-source.html#l00086">86</a> of file <a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>. </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="a17" doxytag="lcn_types.h::lcn_str_to_cstring"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a>* lcn_str_to_cstring </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char ** </td> + <td class="mdname" nowrap> <em>out</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td> + <td class="mdname" nowrap> <em>in</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>apr_pool_t * </td> + <td class="mdname" nowrap> <em>pool</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Convert <em>in</em> into a cstring <em>out</em>, allocated in <em>pool</em>. +<p> +This will result in an error if <em>in</em> cannot be represented in ASCII characters. </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/structlcn__directory__entry__t.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/structlcn__directory__entry__t.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/structlcn__directory__entry__t.html (added) +++ incubator/lucene4c/trunk/www/apidocs/structlcn__directory__entry__t.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,40 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_directory_entry_t Struct Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<h1>lcn_directory_entry_t Struct Reference</h1>An entry in a ram-based directory. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="lcn__directory_8h-source.html">lcn_directory.h</a>></code> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o0" doxytag="lcn_directory_entry_t::bytes"></a> +const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__directory__entry__t.html#o0">bytes</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The actual contents of the file. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o1" doxytag="lcn_directory_entry_t::len"></a> +apr_size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__directory__entry__t.html#o1">len</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The length of the contents in bytes. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o2" doxytag="lcn_directory_entry_t::mtime"></a> +apr_time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__directory__entry__t.html#o2">mtime</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The time the file was last modified on. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +An entry in a ram-based directory. +<p> + +<p> +Definition at line <a class="el" href="lcn__directory_8h-source.html#l00040">40</a> of file <a class="el" href="lcn__directory_8h-source.html">lcn_directory.h</a>.<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="lcn__directory_8h-source.html">lcn_directory.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/structlcn__error__t.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/structlcn__error__t.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/structlcn__error__t.html (added) +++ incubator/lucene4c/trunk/www/apidocs/structlcn__error__t.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_error_t Struct Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<h1>lcn_error_t Struct Reference</h1>Our exception object. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>></code> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o0" doxytag="lcn_error_t::apr_err"></a> +apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__error__t.html#o0">apr_err</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The underlying APR error. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o1" doxytag="lcn_error_t::message"></a> +const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__error__t.html#o1">message</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Human readable error message. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o2" doxytag="lcn_error_t::child"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__error__t.html#o2">child</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The next error in the chain, or <code>NULL</code>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o3" doxytag="lcn_error_t::pool"></a> +apr_pool_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__error__t.html#o3">pool</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The pool this error was allocated in. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Our exception object. +<p> + +<p> +Definition at line <a class="el" href="lcn__types_8h-source.html#l00046">46</a> of file <a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>.<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="lcn__types_8h-source.html">lcn_types.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/structlcn__fieldinfo__t.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/structlcn__fieldinfo__t.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/structlcn__fieldinfo__t.html (added) +++ incubator/lucene4c/trunk/www/apidocs/structlcn__fieldinfo__t.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_fieldinfo_t Struct Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<h1>lcn_fieldinfo_t Struct Reference</h1>Information about a particular field in a segment. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="lcn__fieldinfos_8h-source.html">lcn_fieldinfos.h</a>></code> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o0" doxytag="lcn_fieldinfo_t::name"></a> +const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__fieldinfo__t.html#o0">name</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the field. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o1" doxytag="lcn_fieldinfo_t::is_indexed"></a> +<a class="el" href="lcn__types_8h.html#a8">lcn_boolean_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__fieldinfo__t.html#o1">is_indexed</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the field indexed? <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o2" doxytag="lcn_fieldinfo_t::number"></a> +apr_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__fieldinfo__t.html#o2">number</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The field's number. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o3" doxytag="lcn_fieldinfo_t::store_term_vector"></a> +<a class="el" href="lcn__types_8h.html#a8">lcn_boolean_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__fieldinfo__t.html#o3">store_term_vector</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the field stored in the term vector? <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Information about a particular field in a segment. +<p> + +<p> +Definition at line <a class="el" href="lcn__fieldinfos_8h-source.html#l00033">33</a> of file <a class="el" href="lcn__fieldinfos_8h-source.html">lcn_fieldinfos.h</a>.<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="lcn__fieldinfos_8h-source.html">lcn_fieldinfos.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/structlcn__term__t.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/structlcn__term__t.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/structlcn__term__t.html (added) +++ incubator/lucene4c/trunk/www/apidocs/structlcn__term__t.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_term_t Struct Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<h1>lcn_term_t Struct Reference</h1>A lucene term. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="lcn__term_8h-source.html">lcn_term.h</a>></code> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o0" doxytag="lcn_term_t::contents"></a> +<a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__term__t.html#o0">contents</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The actual contents of the term. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o1" doxytag="lcn_term_t::field"></a> +<a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlcn__term__t.html#o1">field</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The field the term is found in. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A lucene term. +<p> + +<p> +Definition at line <a class="el" href="lcn__term_8h-source.html#l00032">32</a> of file <a class="el" href="lcn__term_8h-source.html">lcn_term.h</a>.<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="lcn__term_8h-source.html">lcn_term.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html>
