Select Git revision
index.html 12.52 KiB
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Compiler options - RagConnect dev</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<link href="../css/version-select.css" rel="stylesheet" />
<script>
// Current page data
var mkdocs_page_name = "Compiler options";
var mkdocs_page_input_path = "compiler.md";
var mkdocs_page_url = null;
</script>
<script src="../js/jquery-2.1.1.min.js" defer></script>
<script src="../js/modernizr-2.8.3.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> RagConnect dev</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../using/">RagConnect by Example</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../use_cases/">Use Cases</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../adding/">Adding RagConnect to your project</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../dsl/">RagConnect Specification Language</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Compiler options</a>
<ul class="current">
</ul>
</li> </ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../inner-workings/">Inner workings</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../extending/">Extending RagConnect</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../changelog/">Changelog</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../ragdoc/">API documentation</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">RagConnect dev</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> »</li>
<li>Compiler options</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="compiler-options">Compiler options<a class="headerlink" href="#compiler-options" title="Permanent link"></a></h1>
<p>The compiler is JastAdd-compliant, i.e., it accepts all flags available for JastAdd, though there is no process how to chain pre-processors <em>yet</em>.
Additional options are as follows.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Required (Default)</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--rootNode</code></td>
<td>Yes</td>
<td>Root node in the base grammar.</td>
</tr>
<tr>
<td><code>--protocols</code></td>
<td>No (<code>mqtt</code>)</td><td>Protocols to enable, currently available: <code>mqtt, rest</code>.</td>
</tr>
<tr>
<td><code>--printYaml</code></td>
<td>No (false)</td>
<td>Print out YAML instead of generating files.</td>
</tr>
<tr>
<td><code>--verbose</code></td>
<td>No (false)</td>
<td>Print more messages while compiling.</td>
</tr>
<tr>
<td><code>--logReads</code></td>
<td>No (false)</td>
<td>Enable logging for every received message.</td>
</tr>
<tr>
<td><code>--logWrites</code></td>
<td>No (false)</td>
<td>Enable logging for every sent message.</td>
</tr>
<tr>
<td><code>--logIncremental</code></td>
<td>No (false)</td>
<td>Enable logging for observer in incremental dependency tracking.</td>
</tr>
<tr>
<td><code>--experimental-jastadd-329</code></td>
<td>No (false)</td>
<td>Use trace events <code>INC_FLUSH_START</code> and <code>INC_FLUSH_END</code> (<a href="https://bitbucket.org/jastadd/jastadd2/issues/329/add-event-for-completion-of-flush">JastAdd issue #329</a>), see <a href="/using#dependency-tracking-automatically-derived">section about automatic dependency tracking</a>.</td>
</tr>
<tr>
<td><code>--incremental</code></td>
<td>No (false)</td>
<td>Enables incremental dependency tracking (if <code>trace</code> is also set appropriately).</td>
</tr>
<tr>
<td><code>--trace[=flush]</code></td>
<td>No (false)</td>
<td>Enables incremental dependency tracking (if <code>incremental</code> is also set appropriately).</td>
</tr>
<tr>
<td><code>--version</code></td>
<td>No (false)</td>
<td>Print version info and exit (reused JastAdd option)</td>
</tr>
<tr>
<td><code>--o</code></td>
<td>No (<code>.</code>)</td>
<td>Output directory (reused JastAdd option)</td>
</tr>
</tbody>
</table>
<p>All files to be process have to be passed as arguments.
Their type is decided by the file extension (<code>ast</code> and <code>relast</code> for input grammars, <code>connect</code> and <code>ragconnect</code> for RagConnect definitions file).</p>
<h1 id="additional-software-dependencies">Additional software dependencies<a class="headerlink" href="#additional-software-dependencies" title="Permanent link"></a></h1>
<p>Using RagConnect itself does not introduce dependencies.
However, depending on the selected protocols and/or used features, additional dependencies are required when using the generated code.</p>
<h2 id="communication-protocol-characteristics">Communication protocol characteristics<a class="headerlink" href="#communication-protocol-characteristics" title="Permanent link"></a></h2>
<h3 id="mqtt">MQTT<a class="headerlink" href="#mqtt" title="Permanent link"></a></h3>
<ul>
<li>Protocol identifier: <code>mqtt</code></li>
<li>URI scheme: <code>mqtt://<broker-host>[:port]/<topic></code></li>
<li>Default port: 1883</li>
<li>Type for mapping definitions: <code>byte[]</code></li>
<li>Required runtime dependencies:<ul>
<li><code>group: 'org.fusesource.mqtt-client', name: 'mqtt-client', version: '1.15'</code></li>
</ul>
</li><li>Additional remarks:<ul>
<li>First leading slash not included in topic.</li>
<li>Mqtt is selected by default, so this dependency therefore is required "by default".</li>
<li>Might work with other versions of <code>org.fusesource.mqtt-client.mqtt.client</code> as well.</li>
</ul>
</li>
</ul>
<h3 id="rest">REST<a class="headerlink" href="#rest" title="Permanent link"></a></h3>
<ul>
<li>Protocol identifier: <code>rest</code></li>
<li>URI scheme: <code>rest://localhost[:port]/<path></code></li>
<li>Default port: 4567</li>
<li>Type for mapping definitions: <code>String</code></li>
<li>Required runtime dependencies:<ul>
<li><code>group: 'com.sparkjava', name: 'spark-core', version: '2.9.3'</code></li>
</ul>
</li>
<li>Additional remarks:<ul>
<li>Host is always <code>localhost</code>.</li>
<li>Might work with newer versions of <code>com.sparkjava.spark-core</code> as well.</li>
<li>For debugging, it is beneficial to include an implementation for <a href="http://www.slf4j.org/">SLF4J</a>.</li>
</ul>
</li>
</ul>
<h2 id="used-features">Used features<a class="headerlink" href="#used-features" title="Permanent link"></a></h2>
<h3 id="automatic-dependency-tracking">Automatic dependency tracking<a class="headerlink" href="#automatic-dependency-tracking" title="Permanent link"></a></h3>
<ul>
<li>Condition: When passing <code>--incremental</code> and <code>--trace=flush</code> to RagConnect</li>
<li>Required runtime dependencies: <em>none</em></li>
<li>Required options for RelAST compiler: <em>none</em></li>
<li>Required options for JastAdd:<ul>
<li><code>--incremental</code></li>
<li><code>--trace=flush</code></li>
</ul>
</li>
<li>Remarks:<ul>
<li>Other (additional) values passed to those two options must be equal (e.g., <code>--incremental=param</code> passed to RagConnect must be also passed to JastAdd)</li>
<li>Other values besides <code>flush</code> can be added to <code>--trace</code></li>
<li><a href="/using#dependency-tracking-automatically-derived">Feature description</a></li>
</ul>
</li>
</ul>
<h3 id="safer-automatic-dependency-tracking">(Safer) Automatic dependency tracking<a class="headerlink" href="#safer-automatic-dependency-tracking" title="Permanent link"></a></h3>
<ul>
<li>Condition: When passing <code>--experimental-jastadd-329</code> to RagConnect</li>
<li>Required runtime dependencies: <em>none</em></li>
<li>Required options for RelAST compiler: <em>none</em></li>
<li>Required options for JastAdd: <em>none</em></li>
<li>Remarks:<ul>
<li>JastAdd version has to support <code>INC_FLUSH_START</code> and <code>INC_FLUSH_END</code> (i.e., has <a href="https://bitbucket.org/jastadd/jastadd2/issues/329/add-event-for-completion-of-flush">issue #329</a> resolved)</li>
<li><a href="/using#dependency-tracking-automatically-derived">Feature description</a></li>
</ul>
</li>
</ul>
<h3 id="treelist-endpoints">Tree/List Endpoints<a class="headerlink" href="#treelist-endpoints" title="Permanent link"></a></h3>
<ul>
<li>Condition: When using <code>tree</code> or <code>list</code> endpoints along with default mappings</li>
<li>Required runtime dependencies:<ul>
<li><code>group: 'com.fasterxml.jackson.core', name: 'jackson-core', version: '2.12.1'</code></li>
<li><code>group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.12.1'</code></li>
</ul>
</li>
<li>Required options for RelAST compiler:<ul>
<li><code>--serializer=jackson</code></li>
</ul>
</li>
<li>Required options for JastAdd: <em>none</em></li>
<li>Remarks:<ul>
<li><a href="/using#an-advanced-example">Feature description</a></li>
</ul></li>
</ul>
</div>
</div>
<p>
<hr>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<small><br><i>Last updated <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime">November 24, 2021 09:05:52</span></i></small>
</p>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="../dsl/" style="color: #fcfcfc">« Previous</a></span>
<span><a href="../inner-workings/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script src="../js/version-select.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>