OSDN Git Service

タグを打ち忘れていたついでに、html版ドキュメントを追加しました。
[ring-lang-081/ring.git] / docs / build / html / embedding.html
diff --git a/docs/build/html/embedding.html b/docs/build/html/embedding.html
new file mode 100644 (file)
index 0000000..271ad56
--- /dev/null
@@ -0,0 +1,271 @@
+<!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/html; charset=utf-8" />
+    
+    <title>C/C++ プログラムへ Ring を組み込むには &mdash; プログラミング言語 Ring 1.12 取扱説明書</title>
+    
+    <link rel="stylesheet" href="_static/bootstrap-astropy.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '1.12',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </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/translations.js"></script>
+    <link rel="top" title="プログラミング言語 Ring 1.12 取扱説明書" href="index.html" />
+    <link rel="next" title="C/C++ ライブラリ接続用コード生成器" href="codegenerator.html" />
+    <link rel="prev" title="C/C++ による拡張機能の開発方法" href="extension.html" />
+    <link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600' rel='stylesheet' type='text/css'/>
+
+  </head>
+  <body role="document">
+<div class="topbar">
+  <a class="brand" title="Documentation Home" href="index.html"><span id="logotext1">&#x1f369;Ring</span><span id="logotext2"> 1.12</span><span id="logotext3">:docs</span></a>
+  <ul>
+    
+    <li><a href="http://ring-lang.sourceforge.net/news.html">News</a></li>
+    <li><a href="http://ring-lang.sourceforge.net/download.html">Download</a></li>
+    <li><a href="https://groups.google.com/forum/#!forum/ring-lang">Get Help</a></li>
+    <li><a href="https://github.com/ring-lang/ring">Contribute</a></li>
+    <li><a href="http://ring-lang.sourceforge.net/resources.html">Resources</a></li>
+    <li><a href="http://ring-lang.sourceforge.net/team.html">Team</a></li>
+    
+    <li><a title="Ring Homepage" href="http://ring-lang.net/">Website</a></li>
+    <li><a title="総合索引" href="genindex.html">Index</a></li>
+    <li>
+      
+      
+<form action="search.html" method="get">
+  <input type="text" name="q" placeholder="Search" />
+  <input type="hidden" name="check_keywords" value="yes" />
+  <input type="hidden" name="area" value="default" />
+</form>
+      
+    </li>
+  </ul>
+</div>
+
+<div class="related">
+    <h3>ナビゲーション</h3>
+    <ul>
+      <li class="right">
+       <a href="codegenerator.html" title="C/C++ ライブラリ接続用コード生成器">
+         next &raquo;
+       </a>
+      </li>
+      <li class="right">
+       <a href="extension.html" title="C/C++ による拡張機能の開発方法">
+         &laquo; previous
+       </a>
+        |
+      </li>
+      <li>
+       <a href="index.html">プログラミング言語 Ring 1.12 取扱説明書</a>
+        &raquo;
+      </li>
+      
+      <li>C/C++ プログラムへ Ring を組み込むには</li> 
+    </ul>
+</div>
+  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="c-c-ring">
+<span id="index-0"></span><h1>C/C++ プログラムへ Ring を組み込むには<a class="headerlink" href="#c-c-ring" title="このヘッドラインへのパーマリンク">¶</a></h1>
+<p>この関数により C/C++ プログラムから Ring を使えます。</p>
+<div class="highlight-C"><div class="highlight"><pre><span class="n">RingState</span> <span class="o">*</span><span class="nf">ring_state_init</span><span class="p">();</span>
+<span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">RingState</span> <span class="o">*</span><span class="n">pState</span><span class="p">,</span><span class="k">const</span> <span class="kt">char</span> <span class="o">*</span><span class="n">cCode</span><span class="p">);</span>
+<span class="n">ring_state_delete</span><span class="p">(</span><span class="n">RingState</span> <span class="o">*</span><span class="n">pState</span><span class="p">);</span>
+</pre></div>
+</div>
+<div class="section" id="ring">
+<span id="index-1"></span><h2>Ring のステート<a class="headerlink" href="#ring" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>考えかたとしては ring_state_init() で Ring ステートの新規作成後に、
+ring_state_runcode() 関数を呼び出すことで、同一ステートの Ring コードの実行します。
+処理完了後に ring_state_delete() を呼び出して、メモリを解放します。</p>
+<p>用例:</p>
+<div class="highlight-C"><div class="highlight"><pre><span class="cp">#include &quot;ring.h&quot;</span>
+<span class="cp">#include &quot;stdlib.h&quot;</span>
+<span class="kt">int</span> <span class="nf">main</span><span class="p">(</span><span class="kt">int</span> <span class="n">argc</span><span class="p">,</span> <span class="kt">char</span> <span class="o">*</span><span class="n">argv</span><span class="p">[])</span>
+<span class="p">{</span>
+  <span class="n">RingState</span> <span class="o">*</span><span class="n">pState</span> <span class="o">=</span> <span class="n">ring_state_init</span><span class="p">();</span>
+  <span class="n">printf</span><span class="p">(</span><span class="s">&quot;welcome</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
+  <span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;see &#39;hello world from the ring programming language&#39;+nl&quot;</span><span class="p">);</span>
+  <span class="n">ring_state_delete</span><span class="p">(</span><span class="n">pState</span><span class="p">);</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>実行結果:</p>
+<div class="highlight-C"><div class="highlight"><pre><span class="n">welcome</span>
+<span class="n">hello</span> <span class="n">world</span> <span class="n">from</span> <span class="n">the</span> <span class="n">ring</span> <span class="n">programming</span> <span class="n">language</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="index-2">
+<span id="id1"></span><h2>Ring ステート関数<a class="headerlink" href="#index-2" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>Ring の API にはステートの作成と削除を行う関数です。
+また、新しい変数の作成と変数の値を取得するための関数もあります。</p>
+<div class="highlight-C"><div class="highlight"><pre><span class="n">RingState</span> <span class="o">*</span> <span class="nf">ring_state_init</span> <span class="p">(</span> <span class="kt">void</span> <span class="p">)</span> <span class="p">;</span>
+<span class="n">RingState</span> <span class="o">*</span> <span class="nf">ring_state_delete</span> <span class="p">(</span> <span class="n">RingState</span> <span class="o">*</span><span class="n">pRingState</span> <span class="p">)</span> <span class="p">;</span>
+<span class="kt">void</span> <span class="nf">ring_state_runcode</span> <span class="p">(</span> <span class="n">RingState</span> <span class="o">*</span><span class="n">pRingState</span><span class="p">,</span><span class="k">const</span> <span class="kt">char</span> <span class="o">*</span><span class="n">cStr</span> <span class="p">)</span> <span class="p">;</span>
+<span class="n">List</span> <span class="o">*</span> <span class="nf">ring_state_findvar</span> <span class="p">(</span> <span class="n">RingState</span> <span class="o">*</span><span class="n">pRingState</span><span class="p">,</span><span class="k">const</span> <span class="kt">char</span> <span class="o">*</span><span class="n">cStr</span> <span class="p">)</span> <span class="p">;</span>
+<span class="n">List</span> <span class="o">*</span> <span class="nf">ring_state_newvar</span> <span class="p">(</span> <span class="n">RingState</span> <span class="o">*</span><span class="n">pRingState</span><span class="p">,</span><span class="k">const</span> <span class="kt">char</span> <span class="o">*</span><span class="n">cStr</span> <span class="p">)</span> <span class="p">;</span>
+<span class="kt">void</span> <span class="nf">ring_state_main</span> <span class="p">(</span> <span class="kt">int</span> <span class="n">argc</span><span class="p">,</span> <span class="kt">char</span> <span class="o">*</span><span class="n">argv</span><span class="p">[]</span> <span class="p">)</span> <span class="p">;</span>
+<span class="kt">void</span> <span class="nf">ring_state_runfile</span> <span class="p">(</span> <span class="n">RingState</span> <span class="o">*</span><span class="n">pRingState</span><span class="p">,</span><span class="k">const</span> <span class="kt">char</span> <span class="o">*</span><span class="n">cFileName</span> <span class="p">)</span> <span class="p">;</span>
+<span class="kt">void</span> <span class="nf">ring_state_runobjectfile</span> <span class="p">(</span> <span class="n">RingState</span> <span class="o">*</span><span class="n">pRingState</span><span class="p">,</span><span class="k">const</span> <span class="kt">char</span> <span class="o">*</span><span class="n">cFileName</span> <span class="p">)</span> <span class="p">;</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="index-3">
+<span id="id2"></span><h2>Ring ステート変数<a class="headerlink" href="#index-3" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>同一プログラム内で複数の Ring のステートを作成できます。また、変数の作成と値の変更もできます。</p>
+<p>ring_state_findvar() 関数は変数のリストを取得します。</p>
+<p>ring_state_newvar() 関数は新しい変数を作成します。</p>
+<p>用例:</p>
+<div class="highlight-C"><div class="highlight"><pre><span class="cp">#include &quot;ring.h&quot;</span>
+<span class="cp">#include &quot;stdlib.h&quot;</span>
+
+<span class="kt">int</span> <span class="nf">main</span><span class="p">(</span><span class="kt">int</span> <span class="n">argc</span><span class="p">,</span> <span class="kt">char</span> <span class="o">*</span><span class="n">argv</span><span class="p">[])</span>
+<span class="p">{</span>
+  <span class="n">List</span> <span class="o">*</span><span class="n">pList</span><span class="p">;</span>
+
+  <span class="n">RingState</span> <span class="o">*</span><span class="n">pState</span> <span class="o">=</span> <span class="n">ring_state_init</span><span class="p">();</span>
+  <span class="n">RingState</span> <span class="o">*</span><span class="n">pState2</span> <span class="o">=</span> <span class="n">ring_state_init</span><span class="p">();</span>
+
+  <span class="n">printf</span><span class="p">(</span><span class="s">&quot;welcome</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
+  <span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;see &#39;hello world from the ring programming language&#39;+nl&quot;</span><span class="p">);</span>
+
+  <span class="n">printf</span><span class="p">(</span><span class="s">&quot;Again from C we will call ring code</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
+  <span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;for x = 1 to 10 see x + nl next&quot;</span><span class="p">);</span>
+
+  <span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">pState2</span><span class="p">,</span><span class="s">&quot;for x = 1 to 5 see x + nl next&quot;</span><span class="p">);</span>
+
+  <span class="n">printf</span><span class="p">(</span><span class="s">&quot;Now we will display the x variable value from ring code</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
+  <span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;see &#39;x value : &#39; + x + nl &quot;</span><span class="p">);</span>
+  <span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">pState2</span><span class="p">,</span><span class="s">&quot;see &#39;x value : &#39; + x + nl &quot;</span><span class="p">);</span>
+
+  <span class="n">pList</span> <span class="o">=</span> <span class="n">ring_state_findvar</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;x&quot;</span><span class="p">);</span>
+
+  <span class="n">printf</span><span class="p">(</span><span class="s">&quot;Printing Ring variable value from C , %.0f</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">,</span>
+                <span class="n">ring_list_getdouble</span><span class="p">(</span><span class="n">pList</span><span class="p">,</span><span class="n">RING_VAR_VALUE</span><span class="p">));</span>
+
+  <span class="n">printf</span><span class="p">(</span><span class="s">&quot;now we will set the ring variable value from C</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
+  <span class="n">ring_list_setdouble</span><span class="p">(</span><span class="n">pList</span><span class="p">,</span><span class="n">RING_VAR_VALUE</span><span class="p">,</span><span class="mi">20</span><span class="p">);</span>
+
+  <span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;see &#39;x value after update : &#39; + x + nl &quot;</span><span class="p">);</span>
+
+  <span class="n">pList</span> <span class="o">=</span> <span class="n">ring_state_newvar</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;v1&quot;</span><span class="p">);</span>
+  <span class="n">ring_list_setdouble</span><span class="p">(</span><span class="n">pList</span><span class="p">,</span><span class="n">RING_VAR_VALUE</span><span class="p">,</span><span class="mi">10</span><span class="p">);</span>
+
+  <span class="n">pList</span> <span class="o">=</span> <span class="n">ring_state_newvar</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;v2&quot;</span><span class="p">);</span>
+  <span class="n">ring_list_setdouble</span><span class="p">(</span><span class="n">pList</span><span class="p">,</span><span class="n">RING_VAR_VALUE</span><span class="p">,</span><span class="mi">20</span><span class="p">);</span>
+
+  <span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;see &#39;v1 + v2 = &#39; see v1+v2 see nl&quot;</span><span class="p">);</span>
+
+  <span class="n">ring_state_runcode</span><span class="p">(</span><span class="n">pState</span><span class="p">,</span><span class="s">&quot;see &#39;end of test&#39; + nl&quot;</span><span class="p">);</span>
+
+  <span class="n">ring_state_delete</span><span class="p">(</span><span class="n">pState</span><span class="p">);</span>
+  <span class="n">ring_state_delete</span><span class="p">(</span><span class="n">pState2</span><span class="p">);</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>実行結果:</p>
+<div class="highlight-ring"><div class="highlight"><pre><span class="n">welcome</span>
+<span class="n">hello</span> <span class="n">world</span> <span class="k">from</span> <span class="n">the</span> <span class="n">ring</span> <span class="n">programming</span> <span class="n">language</span>
+<span class="k">Again</span> <span class="k">from</span> <span class="n">C</span> <span class="n">we</span> <span class="n">will</span> <span class="k">call</span> <span class="n">ring</span> <span class="n">code</span>
+<span class="mi">1</span>
+<span class="mi">2</span>
+<span class="mi">3</span>
+<span class="mi">4</span>
+<span class="mi">5</span>
+<span class="mi">6</span>
+<span class="mi">7</span>
+<span class="mi">8</span>
+<span class="mi">9</span>
+<span class="mi">10</span>
+<span class="mi">1</span>
+<span class="mi">2</span>
+<span class="mi">3</span>
+<span class="mi">4</span>
+<span class="mi">5</span>
+<span class="n">Now</span> <span class="n">we</span> <span class="n">will</span> <span class="n">display</span> <span class="n">the</span> <span class="n">x</span> <span class="n">variable</span> <span class="n">value</span> <span class="k">from</span> <span class="n">ring</span> <span class="n">code</span>
+<span class="n">x</span> <span class="n">value</span> <span class="p">:</span> <span class="mi">11</span>
+<span class="n">x</span> <span class="n">value</span> <span class="p">:</span> <span class="mi">6</span>
+<span class="n">Printing</span> <span class="n">Ring</span> <span class="n">variable</span> <span class="n">value</span> <span class="k">from</span> <span class="n">C</span> <span class="p">,</span> <span class="mi">11</span>
+<span class="n">now</span> <span class="n">we</span> <span class="n">will</span> <span class="n">set</span> <span class="n">the</span> <span class="n">ring</span> <span class="n">variable</span> <span class="n">value</span> <span class="k">from</span> <span class="n">C</span>
+<span class="n">x</span> <span class="n">value</span> <span class="n">after</span> <span class="n">update</span> <span class="p">:</span> <span class="mi">20</span>
+<span class="n">v1</span> <span class="o">+</span> <span class="n">v2</span> <span class="o">=</span> <span class="mi">30</span>
+<span class="k">end</span> <span class="n">of</span> <span class="n">test</span>
+</pre></div>
+</div>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper"><h3>ページの内容</h3>
+<ul>
+<li><a class="reference internal" href="#">C/C++ プログラムへ Ring を組み込むには</a><ul>
+<li><a class="reference internal" href="#ring">Ring のステート</a></li>
+<li><a class="reference internal" href="#index-2">Ring ステート関数</a></li>
+<li><a class="reference internal" href="#index-3">Ring ステート変数</a></li>
+</ul>
+</li>
+</ul>
+
+
+  <h4>前のトピックへ</h4>
+  <p class="topless"><a href="extension.html"
+                        title="前の章へ">C/C++ による拡張機能の開発方法</a></p>
+  <h4>次のトピックへ</h4>
+  <p class="topless"><a href="codegenerator.html"
+                        title="次の章へ">C/C++ ライブラリ接続用コード生成器</a></p>
+  <div role="note" aria-label="source link">
+    <h3>このページ</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/embedding.txt"
+            rel="nofollow">ソースコードを表示</a></li>
+    </ul>
+   </div>
+      
+<form action="search.html" method="get">
+  <input type="text" name="q" placeholder="Search" />
+  <input type="hidden" name="check_keywords" value="yes" />
+  <input type="hidden" name="area" value="default" />
+</form>
+      
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+<footer class="footer">
+  <p class="pull-right">
+    <a href="_sources/embedding.txt"
+       rel="nofollow">Page Source</a> &nbsp;
+    <a href="#">Back to Top</a></p>
+  <p>
+    &copy; Copyright 2016-2020, Ring Team.<br/>
+    Created using <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> 1.3.6. / astropy-sphinx-theme 1.1 (isVowel)
+  </p>
+</footer>
+  </body>
+</html>
\ No newline at end of file