RubyGems - rroonga - Versions diffs - 7.1.1-x64-mingw32 → 9.0.2-x64-mingw32 - Mend

rroonga 7.1.1-x64-mingw32 → 9.0.2-x64-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (980) hide show

data/vendor/local/share/doc/groonga/en/html/reference/api/plugin.html CHANGED Viewed

@@ -1,34 +1,26 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.24.3. Plugin &#8212; Groonga v7.1.0-73-g6d02cfa documentation</title>
+    <meta charset="utf-8" />
+    <title>7.25.3. Plugin &#8212; Groonga v9.0.2 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../../',
-        VERSION:     '7.1.0-73-g6d02cfa',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  false,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
     <script type="text/javascript" src="../../_static/jquery.js"></script>
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <script type="text/javascript" src="../../_static/language_data.js"></script>
     <link rel="shortcut icon" href="../../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
-    <link rel="next" title="7.24.4. grn_cache" href="grn_cache.html" />
-    <link rel="prev" title="7.24.2. Global configurations" href="global_configurations.html" />
-  </head>
-  <body>
+    <link rel="next" title="7.25.4. grn_cache" href="grn_cache.html" />
+    <link rel="prev" title="7.25.2. Global configurations" href="global_configurations.html" />
+  </head><body>
 <div class="header">
   <h1 class="title">
     <a id="top-link" href="../../index.html">
@@ -53,14 +45,14 @@
           <a href="../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="grn_cache.html" title="7.24.4. grn_cache"
+          <a href="grn_cache.html" title="7.25.4. grn_cache"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="global_configurations.html" title="7.24.2. Global configurations"
+          <a href="global_configurations.html" title="7.25.2. Global configurations"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v7.1.0-73-g6d02cfa documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v9.0.2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="../api.html" accesskey="U">7.24. API</a> &#187;</li>
+          <li class="nav-item nav-item-2"><a href="../api.html" accesskey="U">7.25. API</a> &#187;</li>
       </ul>
     </div>
@@ -70,29 +62,29 @@
           <div class="body" role="main">
   <div class="section" id="plugin">
-<h1>7.24.3. Plugin<a class="headerlink" href="#plugin" title="Permalink to this headline">¶</a></h1>
+<h1>7.25.3. Plugin<a class="headerlink" href="#plugin" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="summary">
-<h2>7.24.3.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
+<h2>7.25.3.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
 <p>Groonga supports plugin. You can create a new plugin with the
 following API.</p>
 <p>TOOD: Describe about how to create the minimum plugin here or create a
 tutorial about it.</p>
 </div>
 <div class="section" id="reference">
-<h2>7.24.3.2. Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
+<h2>7.25.3.2. Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt id="c.GRN_PLUGIN_INIT">
-grn_rc <code class="descname">GRN_PLUGIN_INIT</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_INIT" title="Permalink to this definition">¶</a></dt>
+grn_rc <code class="descname">GRN_PLUGIN_INIT</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_INIT" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 <dl class="function">
 <dt id="c.GRN_PLUGIN_REGISTER">
-grn_rc <code class="descname">GRN_PLUGIN_REGISTER</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_REGISTER" title="Permalink to this definition">¶</a></dt>
+grn_rc <code class="descname">GRN_PLUGIN_REGISTER</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_REGISTER" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 <dl class="function">
 <dt id="c.GRN_PLUGIN_FIN">
-grn_rc <code class="descname">GRN_PLUGIN_FIN</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_FIN" title="Permalink to this definition">¶</a></dt>
+grn_rc <code class="descname">GRN_PLUGIN_FIN</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_FIN" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 <dl class="macro">
@@ -124,7 +116,7 @@ GRN_PLUGIN_MALLOC() or GRN_PLUGIN_REALLOC().</p>
 <code class="descname">GRN_PLUGIN_LOG</code><span class="sig-paren">(</span>ctx, level, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_LOG" title="Permalink to this definition">¶</a></dt>
 <dd><p>GRN_PLUGIN_LOG() reports a log of <cite>level</cite>. Its error message is generated
 from the varying number of arguments, in which the first one is the format
-string and the rest are its arguments. See grn_log_level in &quot;groonga.h&quot; for
+string and the rest are its arguments. See grn_log_level in “groonga.h” for
 more details of <cite>level</cite>.</p>
 </dd></dl>
@@ -133,7 +125,7 @@ more details of <cite>level</cite>.</p>
 <code class="descname">GRN_PLUGIN_ERROR</code><span class="sig-paren">(</span>ctx, error_code, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.GRN_PLUGIN_ERROR" title="Permalink to this definition">¶</a></dt>
 <dd><p>GRN_PLUGIN_ERROR() reports an error of <cite>error_code</cite>. Its error message is
 generated from the varying number of arguments, in which the first one is the
-format string and the rest are its arguments. See grn_rc in &quot;groonga.h&quot; for
+format string and the rest are its arguments. See grn_rc in “groonga.h” for
 more details of <cite>error_code</cite>.</p>
 </dd></dl>
@@ -146,7 +138,7 @@ following functions.</p>
 <dl class="function">
 <dt id="c.grn_plugin_mutex_open">
-<a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a> *<code class="descname">grn_plugin_mutex_open</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_open" title="Permalink to this definition">¶</a></dt>
+<a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a> *<code class="descname">grn_plugin_mutex_open</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_open" title="Permalink to this definition">¶</a></dt>
 <dd><p>grn_plugin_mutex_open() returns a pointer to a new object of
 grn_plugin_mutex. Memory for the new object is obtained with
 GRN_PLUGIN_MALLOC(). grn_plugin_mutex_open() returns NULL if sufficient
@@ -155,110 +147,102 @@ memory is not available.</p>
 <dl class="function">
 <dt id="c.grn_plugin_mutex_close">
-void <code class="descname">grn_plugin_mutex_close</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a><em>&nbsp;*mutex</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_close" title="Permalink to this definition">¶</a></dt>
+void <code class="descname">grn_plugin_mutex_close</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, <a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a><em> *mutex</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_close" title="Permalink to this definition">¶</a></dt>
 <dd><p>grn_plugin_mutex_close() finalizes an object of grn_plugin_mutex and then
 frees memory allocated for that object.</p>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_mutex_lock">
-void <code class="descname">grn_plugin_mutex_lock</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a><em>&nbsp;*mutex</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_lock" title="Permalink to this definition">¶</a></dt>
+void <code class="descname">grn_plugin_mutex_lock</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, <a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a><em> *mutex</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_lock" title="Permalink to this definition">¶</a></dt>
 <dd><p>grn_plugin_mutex_lock() locks a mutex object. If the object is already
 locked, the calling thread waits until the object will be unlocked.</p>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_mutex_unlock">
-void <code class="descname">grn_plugin_mutex_unlock</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a><em>&nbsp;*mutex</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_unlock" title="Permalink to this definition">¶</a></dt>
+void <code class="descname">grn_plugin_mutex_unlock</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, <a class="reference internal" href="#c.grn_plugin_mutex" title="grn_plugin_mutex">grn_plugin_mutex</a><em> *mutex</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_mutex_unlock" title="Permalink to this definition">¶</a></dt>
 <dd><p>grn_plugin_mutex_unlock() unlocks a mutex object. grn_plugin_mutex_unlock()
 should not be called for an unlocked object.</p>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_proc_alloc">
-<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<code class="descname">grn_plugin_proc_alloc</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="grn_user_data.html#c.grn_user_data" title="grn_user_data">grn_user_data</a><em>&nbsp;*user_data</em>, grn_id<em>&nbsp;domain</em>, grn_obj_flags<em>&nbsp;flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_proc_alloc" title="Permalink to this definition">¶</a></dt>
+<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<code class="descname">grn_plugin_proc_alloc</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, <a class="reference internal" href="grn_user_data.html#c.grn_user_data" title="grn_user_data">grn_user_data</a><em> *user_data</em>, grn_id<em> domain</em>, grn_obj_flags<em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_proc_alloc" title="Permalink to this definition">¶</a></dt>
 <dd><p>grn_plugin_proc_alloc() allocates a <cite>grn_obj</cite> object.
 You can use it in function that is registered as GRN_PROC_FUNCTION.</p>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_proc_get_var">
-<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> <code class="descname">grn_plugin_proc_get_var</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="grn_user_data.html#c.grn_user_data" title="grn_user_data">grn_user_data</a><em>&nbsp;*user_data</em>, const char<em>&nbsp;*name</em>, int<em>&nbsp;name_size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_proc_get_var" title="Permalink to this definition">¶</a></dt>
+<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> <code class="descname">grn_plugin_proc_get_var</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, <a class="reference internal" href="grn_user_data.html#c.grn_user_data" title="grn_user_data">grn_user_data</a><em> *user_data</em>, const char<em> *name</em>, int<em> name_size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_proc_get_var" title="Permalink to this definition">¶</a></dt>
 <dd><p>It gets a variable value from <cite>grn_user_data</cite> by specifying the variable name.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>name</strong> -- The variable name.</li>
-<li><strong>name_size</strong> -- The number of bytes of name. If <cite>name_size</cite> is negative, <cite>name</cite> must be NUL-terminated. <cite>name_size</cite> is computed by <cite>strlen(name)</cite> for the case.</li>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> – The variable name.</p></li>
+<li><p><strong>name_size</strong> – The number of bytes of name. If <cite>name_size</cite> is negative, <cite>name</cite> must be NUL-terminated. <cite>name_size</cite> is computed by <cite>strlen(name)</cite> for the case.</p></li>
 </ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A variable value on success, NULL otherwise.</p>
-</td>
-</tr>
-</tbody>
-</table>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>A variable value on success, NULL otherwise.</p>
+</dd>
+</dl>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_proc_get_var_by_offset">
-<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<code class="descname">grn_plugin_proc_get_var_by_offset</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="grn_user_data.html#c.grn_user_data" title="grn_user_data">grn_user_data</a><em>&nbsp;*user_data</em>, unsigned int<em>&nbsp;offset</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_proc_get_var_by_offset" title="Permalink to this definition">¶</a></dt>
+<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> *<code class="descname">grn_plugin_proc_get_var_by_offset</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, <a class="reference internal" href="grn_user_data.html#c.grn_user_data" title="grn_user_data">grn_user_data</a><em> *user_data</em>, unsigned int<em> offset</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_proc_get_var_by_offset" title="Permalink to this definition">¶</a></dt>
 <dd><p>It gets a variable value from <cite>grn_user_data</cite> by specifying the offset position of the variable.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>offset</strong> -- The offset position of the variable.</li>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>offset</strong> – The offset position of the variable.</p></li>
 </ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A variable value on success, NULL otherwise.</p>
-</td>
-</tr>
-</tbody>
-</table>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>A variable value on success, NULL otherwise.</p>
+</dd>
+</dl>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_win32_base_dir">
 const char *<code class="descname">grn_plugin_win32_base_dir</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_win32_base_dir" title="Permalink to this definition">¶</a></dt>
 <dd><div class="deprecated">
-<p><span class="versionmodified">Deprecated since version 5.0.9.: </span>Use <a class="reference internal" href="#c.grn_plugin_windows_base_dir" title="grn_plugin_windows_base_dir"><code class="xref c c-func docutils literal"><span class="pre">grn_plugin_windows_base_dir()</span></code></a>
+<p><span class="versionmodified deprecated">Deprecated since version 5.0.9.: </span>Use <a class="reference internal" href="#c.grn_plugin_windows_base_dir" title="grn_plugin_windows_base_dir"><code class="xref c c-func docutils literal notranslate"><span class="pre">grn_plugin_windows_base_dir()</span></code></a>
 instead.</p>
 </div>
 <p>It returns the Groonga install directory. The install directory is
-computed from the directory that has <code class="docutils literal"><span class="pre">groonga.dll</span></code>. You can use
+computed from the directory that has <code class="docutils literal notranslate"><span class="pre">groonga.dll</span></code>. You can use
 the directory to generate install directory aware path. It only
-works on Windows. It returns <code class="docutils literal"><span class="pre">NULL</span></code> on other platforms.</p>
+works on Windows. It returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code> on other platforms.</p>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_windows_base_dir">
 const char *<code class="descname">grn_plugin_windows_base_dir</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_windows_base_dir" title="Permalink to this definition">¶</a></dt>
 <dd><div class="versionadded">
-<p><span class="versionmodified">New in version 5.0.9.</span></p>
+<p><span class="versionmodified added">New in version 5.0.9.</span></p>
 </div>
 <p>It returns the Groonga install directory. The install directory is
-computed from the directory that has <code class="docutils literal"><span class="pre">groonga.dll</span></code>. You can use
+computed from the directory that has <code class="docutils literal notranslate"><span class="pre">groonga.dll</span></code>. You can use
 the directory to generate install directory aware path. It only
-works on Windows. It returns <code class="docutils literal"><span class="pre">NULL</span></code> on other platforms.</p>
+works on Windows. It returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code> on other platforms.</p>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_charlen">
-int <code class="descname">grn_plugin_charlen</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, const char<em>&nbsp;*str_ptr</em>, unsigned int<em>&nbsp;str_length</em>, <a class="reference internal" href="grn_encoding.html#c.grn_encoding" title="grn_encoding">grn_encoding</a><em>&nbsp;encoding</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_charlen" title="Permalink to this definition">¶</a></dt>
+int <code class="descname">grn_plugin_charlen</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, const char<em> *str_ptr</em>, unsigned int<em> str_length</em>, <a class="reference internal" href="grn_encoding.html#c.grn_encoding" title="grn_encoding">grn_encoding</a><em> encoding</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_charlen" title="Permalink to this definition">¶</a></dt>
 <dd><p>grn_plugin_charlen() returns the length (#bytes) of the first character
 in the string specified by <cite>str_ptr</cite> and <cite>str_length</cite>. If the starting bytes
 are invalid as a character, grn_plugin_charlen() returns 0. See
-grn_encoding in &quot;groonga.h&quot; for more details of <cite>encoding</cite>.</p>
+grn_encoding in “groonga.h” for more details of <cite>encoding</cite>.</p>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_isspace">
-int <code class="descname">grn_plugin_isspace</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, const char<em>&nbsp;*str_ptr</em>, unsigned int<em>&nbsp;str_length</em>, <a class="reference internal" href="grn_encoding.html#c.grn_encoding" title="grn_encoding">grn_encoding</a><em>&nbsp;encoding</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_isspace" title="Permalink to this definition">¶</a></dt>
+int <code class="descname">grn_plugin_isspace</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, const char<em> *str_ptr</em>, unsigned int<em> str_length</em>, <a class="reference internal" href="grn_encoding.html#c.grn_encoding" title="grn_encoding">grn_encoding</a><em> encoding</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_isspace" title="Permalink to this definition">¶</a></dt>
 <dd><p>grn_plugin_isspace() returns the length (#bytes) of the first character
 in the string specified by <cite>str_ptr</cite> and <cite>str_length</cite> if it is a space
 character. Otherwise, grn_plugin_isspace() returns 0.</p>
@@ -266,49 +250,41 @@ character. Otherwise, grn_plugin_isspace() returns 0.</p>
 <dl class="function">
 <dt id="c.grn_plugin_expr_var_init">
-grn_rc <code class="descname">grn_plugin_expr_var_init</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, grn_expr_var<em>&nbsp;*var</em>, const char<em>&nbsp;*name</em>, int<em>&nbsp;name_size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_expr_var_init" title="Permalink to this definition">¶</a></dt>
+grn_rc <code class="descname">grn_plugin_expr_var_init</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, grn_expr_var<em> *var</em>, const char<em> *name</em>, int<em> name_size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_expr_var_init" title="Permalink to this definition">¶</a></dt>
 <dd><p>It initializes a <cite>grn_expr_var</cite>.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>var</strong> -- The pointer of <cite>grn_expr_var</cite> object to be initialized.</li>
-<li><strong>name</strong> -- The name of <cite>grn_expr_var</cite> object to be initialized.</li>
-<li><strong>name_size</strong> -- The number of bytes of name. If <cite>name_size</cite> is negative, <cite>name</cite> must be NUL-terminated. <cite>name_size</cite> is computed by <cite>strlen(name)</cite> for the case.</li>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>var</strong> – The pointer of <cite>grn_expr_var</cite> object to be initialized.</p></li>
+<li><p><strong>name</strong> – The name of <cite>grn_expr_var</cite> object to be initialized.</p></li>
+<li><p><strong>name_size</strong> – The number of bytes of name. If <cite>name_size</cite> is negative, <cite>name</cite> must be NUL-terminated. <cite>name_size</cite> is computed by <cite>strlen(name)</cite> for the case.</p></li>
 </ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="docutils literal"><span class="pre">GRN_SUCCESS</span></code>. It doesn't fail.</p>
-</td>
-</tr>
-</tbody>
-</table>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">GRN_SUCCESS</span></code>. It doesn’t fail.</p>
+</dd>
+</dl>
 </dd></dl>
 <dl class="function">
 <dt id="c.grn_plugin_command_create">
-<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> * <code class="descname">grn_plugin_command_create</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, const char<em>&nbsp;*name</em>, int<em>&nbsp;name_size</em>, <a class="reference internal" href="grn_proc.html#c.grn_proc_func" title="grn_proc_func">grn_proc_func</a><em>&nbsp;func</em>, unsigned int<em>&nbsp;n_vars</em>, grn_expr_var<em>&nbsp;*vars</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_command_create" title="Permalink to this definition">¶</a></dt>
+<a class="reference internal" href="grn_obj.html#c.grn_obj" title="grn_obj">grn_obj</a> * <code class="descname">grn_plugin_command_create</code><span class="sig-paren">(</span><a class="reference internal" href="grn_ctx.html#c.grn_ctx" title="grn_ctx">grn_ctx</a><em> *ctx</em>, const char<em> *name</em>, int<em> name_size</em>, <a class="reference internal" href="grn_proc.html#c.grn_proc_func" title="grn_proc_func">grn_proc_func</a><em> func</em>, unsigned int<em> n_vars</em>, grn_expr_var<em> *vars</em><span class="sig-paren">)</span><a class="headerlink" href="#c.grn_plugin_command_create" title="Permalink to this definition">¶</a></dt>
 <dd><p>It creates a command.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>name</strong> -- The <cite>proc</cite> name of the command to be created.</li>
-<li><strong>name_size</strong> -- The number of bytes of name. If <cite>name_size</cite> is negative, <cite>name</cite> must be NUL-terminated. <cite>name_size</cite> is computed by <cite>strlen(name)</cite> for the case.</li>
-<li><strong>func</strong> -- The function name to be called by the created command.</li>
-<li><strong>n_vars</strong> -- The number of the variables of the command to create.</li>
-<li><strong>vars</strong> -- The pointer of initialized <cite>grn_expr_var</cite> object.</li>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> – The <cite>proc</cite> name of the command to be created.</p></li>
+<li><p><strong>name_size</strong> – The number of bytes of name. If <cite>name_size</cite> is negative, <cite>name</cite> must be NUL-terminated. <cite>name_size</cite> is computed by <cite>strlen(name)</cite> for the case.</p></li>
+<li><p><strong>func</strong> – The function name to be called by the created command.</p></li>
+<li><p><strong>n_vars</strong> – The number of the variables of the command to create.</p></li>
+<li><p><strong>vars</strong> – The pointer of initialized <cite>grn_expr_var</cite> object.</p></li>
 </ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">The created command object if it creates a command successfully,
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>The created command object if it creates a command successfully,
 <cite>NULL</cite> otherwise. See <cite>ctx</cite> for error details.</p>
-</td>
-</tr>
-</tbody>
-</table>
+</dd>
+</dl>
 </dd></dl>
 </div>
@@ -320,29 +296,29 @@ grn_rc <code class="descname">grn_plugin_expr_var_init</code><span class="sig-pa
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-  <h3><a href="../../index.html">Table Of Contents</a></h3>
+  <h3><a href="../../index.html">Table of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">7.24.3. Plugin</a><ul>
-<li><a class="reference internal" href="#summary">7.24.3.1. Summary</a></li>
-<li><a class="reference internal" href="#reference">7.24.3.2. Reference</a></li>
+<li><a class="reference internal" href="#">7.25.3. Plugin</a><ul>
+<li><a class="reference internal" href="#summary">7.25.3.1. Summary</a></li>
+<li><a class="reference internal" href="#reference">7.25.3.2. Reference</a></li>
 </ul>
 </li>
 </ul>
   <h4>Previous topic</h4>
   <p class="topless"><a href="global_configurations.html"
-                        title="previous chapter">7.24.2. Global configurations</a></p>
+                        title="previous chapter">7.25.2. Global configurations</a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="grn_cache.html"
-                        title="next chapter">7.24.4. <code class="docutils literal"><span class="pre">grn_cache</span></code></a></p>
+                        title="next chapter">7.25.4. <code class="docutils literal notranslate"><span class="pre">grn_cache</span></code></a></p>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
+    <div class="searchformwrapper">
     <form class="search" action="../../search.html" method="get">
-      <div><input type="text" name="q" /></div>
-      <div><input type="submit" value="Go" /></div>
-      <input type="hidden" name="check_keywords" value="yes" />
-      <input type="hidden" name="area" value="default" />
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
     </form>
+    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -356,18 +332,18 @@ grn_rc <code class="descname">grn_plugin_expr_var_init</code><span class="sig-pa
           <a href="../../genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="grn_cache.html" title="7.24.4. grn_cache"
+          <a href="grn_cache.html" title="7.25.4. grn_cache"
              >next</a> |</li>
         <li class="right" >
-          <a href="global_configurations.html" title="7.24.2. Global configurations"
+          <a href="global_configurations.html" title="7.25.2. Global configurations"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v7.1.0-73-g6d02cfa documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v9.0.2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="../api.html" >7.24. API</a> &#187;</li>
+          <li class="nav-item nav-item-2"><a href="../api.html" >7.25. API</a> &#187;</li>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2009-2018, Brazil, Inc.
+        &#169; Copyright 2009-2019, Brazil, Inc.
     </div>
   </body>
 </html>

data/vendor/local/share/doc/groonga/en/html/reference/cast.html CHANGED Viewed

@@ -1,32 +1,26 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Cast &#8212; Groonga v7.1.0-73-g6d02cfa documentation</title>
+    <meta charset="utf-8" />
+    <title>7.12. Cast &#8212; Groonga v9.0.2 documentation</title>
     <link rel="stylesheet" href="../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '7.1.0-73-g6d02cfa',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  false,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
+    <script type="text/javascript" src="../_static/language_data.js"></script>
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
-    <link rel="search" title="Search" href="../search.html" />
-  </head>
-  <body>
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="7.13. grn_expr" href="grn_expr.html" />
+    <link rel="prev" title="7.11.3.2. scorer_tf_idf" href="scorers/scorer_tf_idf.html" />
+  </head><body>
 <div class="header">
   <h1 class="title">
     <a id="top-link" href="../index.html">
@@ -50,7 +44,14 @@
         <li class="right" style="margin-right: 10px">
           <a href="../genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v7.1.0-73-g6d02cfa documentation</a> &#187;</li>
+        <li class="right" >
+          <a href="grn_expr.html" title="7.13. grn_expr"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="scorers/scorer_tf_idf.html" title="7.11.3.2. scorer_tf_idf"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v9.0.2 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../reference.html" accesskey="U">7. Reference manual</a> &#187;</li>
       </ul>
     </div>
@@ -60,8 +61,8 @@
           <div class="body" role="main">
   <div class="section" id="cast">
-<h1>Cast<a class="headerlink" href="#cast" title="Permalink to this headline">¶</a></h1>
-<p>TODO...</p>
+<h1>7.12. Cast<a class="headerlink" href="#cast" title="Permalink to this headline">¶</a></h1>
+<p>TODO…</p>
 </div>
@@ -70,14 +71,20 @@
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="scorers/scorer_tf_idf.html"
+                        title="previous chapter">7.11.3.2. <code class="docutils literal notranslate"><span class="pre">scorer_tf_idf</span></code></a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="grn_expr.html"
+                        title="next chapter">7.13. grn_expr</a></p>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
+    <div class="searchformwrapper">
     <form class="search" action="../search.html" method="get">
-      <div><input type="text" name="q" /></div>
-      <div><input type="submit" value="Go" /></div>
-      <input type="hidden" name="check_keywords" value="yes" />
-      <input type="hidden" name="area" value="default" />
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
     </form>
+    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -90,11 +97,18 @@
         <li class="right" style="margin-right: 10px">
           <a href="../genindex.html" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v7.1.0-73-g6d02cfa documentation</a> &#187;</li>
+        <li class="right" >
+          <a href="grn_expr.html" title="7.13. grn_expr"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="scorers/scorer_tf_idf.html" title="7.11.3.2. scorer_tf_idf"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v9.0.2 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../reference.html" >7. Reference manual</a> &#187;</li>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2009-2018, Brazil, Inc.
+        &#169; Copyright 2009-2019, Brazil, Inc.
     </div>
   </body>
 </html>