<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>SphinxBase: include/sphinxbase/jsgf.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SphinxBase <span id="projectnumber">0.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('jsgf_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>include/sphinxbase/jsgf.h File Reference</h1> </div>
</div>
<div class="contents">
<p>JSGF grammar compiler.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <stdio.h></code><br/>
<code>#include <sphinxbase/sphinxbase_export.h></code><br/>
<code>#include <sphinxbase/hash_table.h></code><br/>
<code>#include <sphinxbase/fsg_model.h></code><br/>
<code>#include <sphinxbase/logmath.h></code><br/>
</div>
<p><a href="jsgf_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7216bc3a99823fb509e0dd4f8ee02b75"></a><!-- doxytag: member="jsgf.h::jsgf_rule_iter_next" ref="a7216bc3a99823fb509e0dd4f8ee02b75" args="(itor)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#a7216bc3a99823fb509e0dd4f8ee02b75">jsgf_rule_iter_next</a>(itor)   hash_table_iter_next(itor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance an iterator to the next rule in the grammar. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23b17eb0a92ba7e3c4aa086a33e3c5e6"></a><!-- doxytag: member="jsgf.h::jsgf_rule_iter_rule" ref="a23b17eb0a92ba7e3c4aa086a33e3c5e6" args="(itor)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#a23b17eb0a92ba7e3c4aa086a33e3c5e6">jsgf_rule_iter_rule</a>(itor)   ((<a class="el" href="structjsgf__rule__s.html">jsgf_rule_t</a> *)(itor)->ent->val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current rule in a rule iterator. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a697875f60dede64c607180514e4ab2c4"></a><!-- doxytag: member="jsgf.h::jsgf_rule_iter_free" ref="a697875f60dede64c607180514e4ab2c4" args="(itor)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#a697875f60dede64c607180514e4ab2c4">jsgf_rule_iter_free</a>(itor)   hash_table_iter_free(itor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free a rule iterator (if the end hasn't been reached). <br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee85cf9f007eac61cebba97d6aaccaea"></a><!-- doxytag: member="jsgf.h::jsgf_t" ref="aee85cf9f007eac61cebba97d6aaccaea" args="" -->
typedef struct <a class="el" href="structjsgf__s.html">jsgf_s</a> </td><td class="memItemRight" valign="bottom"><b>jsgf_t</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3bb0c86e5f9ba2c29b1fa91e1583bf00"></a><!-- doxytag: member="jsgf.h::jsgf_rule_t" ref="a3bb0c86e5f9ba2c29b1fa91e1583bf00" args="" -->
typedef struct <a class="el" href="structjsgf__rule__s.html">jsgf_rule_s</a> </td><td class="memItemRight" valign="bottom"><b>jsgf_rule_t</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1e450c03748feb7e1db2a487b21c3fa"></a><!-- doxytag: member="jsgf.h::jsgf_rule_iter_t" ref="ac1e450c03748feb7e1db2a487b21c3fa" args="" -->
typedef <a class="el" href="structhash__iter__s.html">hash_iter_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#ac1e450c03748feb7e1db2a487b21c3fa">jsgf_rule_iter_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator over rules in a grammar. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structjsgf__s.html">jsgf_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#a504181dfffafe125df5763e4b841b658">jsgf_grammar_new</a> (<a class="el" href="structjsgf__s.html">jsgf_t</a> *parent)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new JSGF grammar. <a href="#a504181dfffafe125df5763e4b841b658"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structjsgf__s.html">jsgf_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#ac67cab54fdb6ead62a3be79ccffb0836">jsgf_parse_file</a> (const char *filename, <a class="el" href="structjsgf__s.html">jsgf_t</a> *parent)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse a JSGF grammar from a file. <a href="#ac67cab54fdb6ead62a3be79ccffb0836"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8bbbd8834e0248bd8c52252e93c9822b"></a><!-- doxytag: member="jsgf.h::jsgf_grammar_free" ref="a8bbbd8834e0248bd8c52252e93c9822b" args="(jsgf_t *jsgf)" -->
SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#a8bbbd8834e0248bd8c52252e93c9822b">jsgf_grammar_free</a> (<a class="el" href="structjsgf__s.html">jsgf_t</a> *jsgf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free a JSGF grammar. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9617a53c34041e32f0800795aa1341ca"></a><!-- doxytag: member="jsgf.h::jsgf_rule_iter" ref="a9617a53c34041e32f0800795aa1341ca" args="(jsgf_t *grammar)" -->
SPHINXBASE_EXPORT <br class="typebreak"/>
<a class="el" href="structhash__iter__s.html">jsgf_rule_iter_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#a9617a53c34041e32f0800795aa1341ca">jsgf_rule_iter</a> (<a class="el" href="structjsgf__s.html">jsgf_t</a> *grammar)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator over all rules in a grammar. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0329f14f22c4253c975a448dc5e0c3ec"></a><!-- doxytag: member="jsgf.h::jsgf_get_rule" ref="a0329f14f22c4253c975a448dc5e0c3ec" args="(jsgf_t *grammar, char const *name)" -->
SPHINXBASE_EXPORT <a class="el" href="structjsgf__rule__s.html">jsgf_rule_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#a0329f14f22c4253c975a448dc5e0c3ec">jsgf_get_rule</a> (<a class="el" href="structjsgf__s.html">jsgf_t</a> *grammar, char const *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a rule by name from a grammar. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1e5791530b5075f76ab085f248e8f0f"></a><!-- doxytag: member="jsgf.h::jsgf_rule_name" ref="ab1e5791530b5075f76ab085f248e8f0f" args="(jsgf_rule_t *rule)" -->
SPHINXBASE_EXPORT char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#ab1e5791530b5075f76ab085f248e8f0f">jsgf_rule_name</a> (<a class="el" href="structjsgf__rule__s.html">jsgf_rule_t</a> *rule)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the rule name from a rule. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85d7895c7a11d82c85b4529f6009c213"></a><!-- doxytag: member="jsgf.h::jsgf_rule_public" ref="a85d7895c7a11d82c85b4529f6009c213" args="(jsgf_rule_t *rule)" -->
SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#a85d7895c7a11d82c85b4529f6009c213">jsgf_rule_public</a> (<a class="el" href="structjsgf__rule__s.html">jsgf_rule_t</a> *rule)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a rule is public or not. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac355893a25aa071eba6874fae1d51ad2"></a><!-- doxytag: member="jsgf.h::jsgf_build_fsg" ref="ac355893a25aa071eba6874fae1d51ad2" args="(jsgf_t *grammar, jsgf_rule_t *rule, logmath_t *lmath, float32 lw)" -->
SPHINXBASE_EXPORT <a class="el" href="structfsg__model__s.html">fsg_model_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#ac355893a25aa071eba6874fae1d51ad2">jsgf_build_fsg</a> (<a class="el" href="structjsgf__s.html">jsgf_t</a> *grammar, <a class="el" href="structjsgf__rule__s.html">jsgf_rule_t</a> *rule, <a class="el" href="structlogmath__s.html">logmath_t</a> *lmath, float32 lw)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Build a Sphinx FSG object from a JSGF rule. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structfsg__model__s.html">fsg_model_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#a5873c31ddf99379d123c0db2e36600ba">jsgf_build_fsg_raw</a> (<a class="el" href="structjsgf__s.html">jsgf_t</a> *grammar, <a class="el" href="structjsgf__rule__s.html">jsgf_rule_t</a> *rule, <a class="el" href="structlogmath__s.html">logmath_t</a> *lmath, float32 lw)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Build a Sphinx FSG object from a JSGF rule. <a href="#a5873c31ddf99379d123c0db2e36600ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="jsgf_8h.html#abc18712a5a7bda442a8afba38f5827e7">jsgf_write_fsg</a> (<a class="el" href="structjsgf__s.html">jsgf_t</a> *grammar, <a class="el" href="structjsgf__rule__s.html">jsgf_rule_t</a> *rule, FILE *outfh)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a JSGF rule to Sphinx FSG text form. <a href="#abc18712a5a7bda442a8afba38f5827e7"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>JSGF grammar compiler. </p>
<p>This file defines the data structures for parsing JSGF grammars into Sphinx finite-state grammars. </p>
<p>Definition in file <a class="el" href="jsgf_8h_source.html">jsgf.h</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a5873c31ddf99379d123c0db2e36600ba"></a><!-- doxytag: member="jsgf.h::jsgf_build_fsg_raw" ref="a5873c31ddf99379d123c0db2e36600ba" args="(jsgf_t *grammar, jsgf_rule_t *rule, logmath_t *lmath, float32 lw)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="structfsg__model__s.html">fsg_model_t</a>* jsgf_build_fsg_raw </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjsgf__s.html">jsgf_t</a> * </td>
<td class="paramname"><em>grammar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structjsgf__rule__s.html">jsgf_rule_t</a> * </td>
<td class="paramname"><em>rule</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structlogmath__s.html">logmath_t</a> * </td>
<td class="paramname"><em>lmath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float32 </td>
<td class="paramname"><em>lw</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build a Sphinx FSG object from a JSGF rule. </p>
<p>This differs from <a class="el" href="jsgf_8h.html#ac355893a25aa071eba6874fae1d51ad2" title="Build a Sphinx FSG object from a JSGF rule.">jsgf_build_fsg()</a> in that it does not do closure on epsilon transitions or any other postprocessing. For the time being this is necessary in order to write it to a file - the FSG code will be fixed soon. </p>
<p>Definition at line <a class="el" href="jsgf_8c_source.html#l00500">500</a> of file <a class="el" href="jsgf_8c_source.html">jsgf.c</a>.</p>
<p>Referenced by <a class="el" href="jsgf_8c_source.html#l00507">jsgf_write_fsg()</a>.</p>
</div>
</div>
<a class="anchor" id="a504181dfffafe125df5763e4b841b658"></a><!-- doxytag: member="jsgf.h::jsgf_grammar_new" ref="a504181dfffafe125df5763e4b841b658" args="(jsgf_t *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="structjsgf__s.html">jsgf_t</a>* jsgf_grammar_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjsgf__s.html">jsgf_t</a> * </td>
<td class="paramname"><em>parent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new JSGF grammar. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">parent</td><td>optional parent grammar for this one (NULL, usually). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>new JSGF grammar object, or NULL on failure. </dd></dl>
<p>Definition at line <a class="el" href="jsgf_8c_source.html#l00081">81</a> of file <a class="el" href="jsgf_8c_source.html">jsgf.c</a>.</p>
<p>References <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, <a class="el" href="ckd__alloc_8h_source.html#l00264">ckd_salloc</a>, <a class="el" href="glist_8c_source.html#l00074">glist_add_ptr()</a>, <a class="el" href="glist_8c_source.html#l00169">glist_reverse()</a>, <a class="el" href="hash__table_8c_source.html#l00158">hash_table_new()</a>, <a class="el" href="jsgf__internal_8h_source.html#l00076">jsgf_s::imports</a>, <a class="el" href="jsgf__internal_8h_source.html#l00077">jsgf_s::parent</a>, <a class="el" href="jsgf__internal_8h_source.html#l00075">jsgf_s::rules</a>, and <a class="el" href="jsgf__internal_8h_source.html#l00078">jsgf_s::searchpath</a>.</p>
<p>Referenced by <a class="el" href="jsgf_8c_source.html#l00699">jsgf_parse_file()</a>.</p>
</div>
</div>
<a class="anchor" id="ac67cab54fdb6ead62a3be79ccffb0836"></a><!-- doxytag: member="jsgf.h::jsgf_parse_file" ref="ac67cab54fdb6ead62a3be79ccffb0836" args="(const char *filename, jsgf_t *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="structjsgf__s.html">jsgf_t</a>* jsgf_parse_file </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structjsgf__s.html">jsgf_t</a> * </td>
<td class="paramname"><em>parent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse a JSGF grammar from a file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>the name of the file to parse. </td></tr>
<tr><td class="paramname">parent</td><td>optional parent grammar for this one (NULL, usually). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>new JSGF grammar object, or NULL on failure. </dd></dl>
<p>Definition at line <a class="el" href="jsgf_8c_source.html#l00699">699</a> of file <a class="el" href="jsgf_8c_source.html">jsgf.c</a>.</p>
<p>References <a class="el" href="jsgf_8c_source.html#l00127">jsgf_grammar_free()</a>, and <a class="el" href="jsgf_8c_source.html#l00081">jsgf_grammar_new()</a>.</p>
</div>
</div>
<a class="anchor" id="abc18712a5a7bda442a8afba38f5827e7"></a><!-- doxytag: member="jsgf.h::jsgf_write_fsg" ref="abc18712a5a7bda442a8afba38f5827e7" args="(jsgf_t *grammar, jsgf_rule_t *rule, FILE *outfh)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int jsgf_write_fsg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjsgf__s.html">jsgf_t</a> * </td>
<td class="paramname"><em>grammar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structjsgf__rule__s.html">jsgf_rule_t</a> * </td>
<td class="paramname"><em>rule</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>outfh</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a JSGF rule to Sphinx FSG text form. </p>
<p>This does a direct conversion without doing transitive closure on null transitions and so forth. </p>
<p>Definition at line <a class="el" href="jsgf_8c_source.html#l00507">507</a> of file <a class="el" href="jsgf_8c_source.html">jsgf.c</a>.</p>
<p>References <a class="el" href="jsgf_8c_source.html#l00500">jsgf_build_fsg_raw()</a>, <a class="el" href="logmath_8c_source.html#l00342">logmath_free()</a>, and <a class="el" href="logmath_8c_source.html#l00062">logmath_init()</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="jsgf_8h.html">jsgf.h</a> </li>
<li class="footer">Generated on Tue Apr 19 2011 for SphinxBase by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
0b420d0fce195cf4115dc6a3be5c2da2
>
files
>
258
