Permalink
Browse files

Added csd.sco.preprocessor to the docs.

  • Loading branch information...
1 parent c0c4fd4 commit 2757953d3f3bfc899d3111e7d0d4bd16fcec6a21 @jacobjoaquin committed Jul 28, 2009
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -26,6 +26,12 @@ event
.. automodule:: csd.sco.event
:members:
+preprocessor
+------------
+
+.. automodule:: csd.sco.preprocessor
+ :members:
+
selection
---------
@@ -35,7 +35,7 @@ def value_to_carry(score):
Macros do no carry as they may contain expressions.
- No-carrys are not carried.
+ No-carries are not carried.
'''
event_list = score.splitlines(True)
@@ -26,6 +26,12 @@ event
.. automodule:: csd.sco.event
:members:
+preprocessor
+------------
+
+.. automodule:: csd.sco.preprocessor
+ :members:
+
selection
---------
View
@@ -81,7 +81,7 @@
<dl class="function">
<dt id="csd.get_orchestra">
<tt class="descclassname">csd.</tt><tt class="descname">get_orchestra</tt><big>(</big><em>csd</em><big>)</big><a class="headerlink" href="#csd.get_orchestra" title="Permalink to this definition">¶</a></dt>
-<dd>Not implemented.</dd></dl>
+<dd>Returns the orchestra from a Csound CSD.</dd></dl>
<dl class="function">
<dt id="csd.get_sample_base64">
@@ -91,29 +91,17 @@
<dl class="function">
<dt id="csd.get_score">
<tt class="descclassname">csd.</tt><tt class="descname">get_score</tt><big>(</big><em>csd</em><big>)</big><a class="headerlink" href="#csd.get_score" title="Permalink to this definition">¶</a></dt>
-<dd><p>Pulls score data from inbetween the &lt;CsScore&gt; markup tags in a
-Csound csd.</p>
-<div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">This should really reside somewhere else, such as a
-csdparse module.</p>
-</div>
-<div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">There is an issue with an extra leading and extra
-trailing newline being introduced.</p>
-</div>
-</dd></dl>
+<dd>Returns the score from a Csound CSD.</dd></dl>
<dl class="function">
<dt id="csd.get_version">
<tt class="descclassname">csd.</tt><tt class="descname">get_version</tt><big>(</big><em>csd</em><big>)</big><a class="headerlink" href="#csd.get_version" title="Permalink to this definition">¶</a></dt>
<dd>Not implemented.</dd></dl>
<dl class="function">
-<dt id="csd.replace_score">
-<tt class="descclassname">csd.</tt><tt class="descname">replace_score</tt><big>(</big><em>csd</em>, <em>sco</em><big>)</big><a class="headerlink" href="#csd.replace_score" title="Permalink to this definition">¶</a></dt>
-<dd>Not implemented.</dd></dl>
+<dt id="csd.overwrite_score">
+<tt class="descclassname">csd.</tt><tt class="descname">overwrite_score</tt><big>(</big><em>csd</em>, <em>sco</em><big>)</big><a class="headerlink" href="#csd.overwrite_score" title="Permalink to this definition">¶</a></dt>
+<dd>Returns a new csd string with a new score.</dd></dl>
</div>
<div class="section" id="module-csd.sco">
@@ -496,6 +484,26 @@
</dd></dl>
</div>
+<div class="section" id="module-csd.sco.preprocessor">
+<h2>preprocessor<a class="headerlink" href="#module-csd.sco.preprocessor" title="Permalink to this headline">¶</a></h2>
+<p>Preprocessor functions.</p>
+<dl class="function">
+<dt id="csd.sco.preprocessor.carry_to_value">
+<tt class="descclassname">csd.sco.preprocessor.</tt><tt class="descname">carry_to_value</tt><big>(</big><em>score</em><big>)</big><a class="headerlink" href="#csd.sco.preprocessor.carry_to_value" title="Permalink to this definition">¶</a></dt>
+<dd>Not implemented.</dd></dl>
+
+<dl class="function">
+<dt id="csd.sco.preprocessor.value_to_carry">
+<tt class="descclassname">csd.sco.preprocessor.</tt><tt class="descname">value_to_carry</tt><big>(</big><em>score</em><big>)</big><a class="headerlink" href="#csd.sco.preprocessor.value_to_carry" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replaces subsequent repeated values with a carry (.)</p>
+<p>Identical expressions do no carry, as a carry only copies the first
+value output from an expression. This breaks the form when multiple
+random evaluations are part of the score.</p>
+<p>Macros do no carry as they may contain expressions.</p>
+<p>No-carries are not carried.</p>
+</dd></dl>
+
+</div>
<div class="section" id="module-csd.sco.selection">
<h2>selection<a class="headerlink" href="#module-csd.sco.selection" title="Permalink to this headline">¶</a></h2>
<p>These methods operate on selections.</p>
@@ -573,6 +581,7 @@
<li><a class="reference external" href="#module-csd.sco">sco</a></li>
<li><a class="reference external" href="#module-csd.sco.element">element</a></li>
<li><a class="reference external" href="#module-csd.sco.event">event</a></li>
+<li><a class="reference external" href="#module-csd.sco.preprocessor">preprocessor</a></li>
<li><a class="reference external" href="#module-csd.sco.selection">selection</a></li>
</ul>
</li>
View
@@ -129,7 +129,7 @@
</div>
<dl class="function">
<dt id="carry.replace">
-<tt class="descclassname">carry.</tt><tt class="descname">replace</tt><big>(</big><em>s</em><big>)</big><a class="headerlink" href="#carry.replace" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">carry.</tt><tt class="descname">replace</tt><big>(</big><em>score</em><big>)</big><a class="headerlink" href="#carry.replace" title="Permalink to this definition">¶</a></dt>
<dd>Replaces subsequent repeated values with a carry (.)</dd></dl>
</div>
View
@@ -43,7 +43,7 @@
<h1 id="index">Index</h1>
- <a href="#Symbols"><strong>Symbols</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a>
+ <a href="#Symbols"><strong>Symbols</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#V"><strong>V</strong></a>
<hr />
@@ -91,13 +91,15 @@ <h2 id="C">C</h2>
<dl>
<dt><a href="demo/index.html#module-carry">carry (module)</a></dt>
+<dt><a href="csd_sco_event.html#csd.sco.preprocessor.carry_to_value">carry_to_value() (in module csd.sco.preprocessor)</a></dt>
<dt><a href="glossary.html#term-csd">csd</a></dt>
<dd><dl>
<dt><a href="csd_sco_event.html#module-csd">(module)</a></dt>
</dl></dd>
<dt><a href="csd_sco_event.html#module-csd.sco">csd.sco (module)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="csd_sco_event.html#module-csd.sco.element">csd.sco.element (module)</a></dt>
<dt><a href="csd_sco_event.html#module-csd.sco.event">csd.sco.event (module)</a></dt>
+<dt><a href="csd_sco_event.html#module-csd.sco.preprocessor">csd.sco.preprocessor (module)</a></dt>
<dt><a href="csd_sco_event.html#module-csd.sco.selection">csd.sco.selection (module)</a></dt>
</dl></td></tr></table>
@@ -159,7 +161,8 @@ <h2 id="O">O</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
-<dt><a href="csd_sco_event.html#csd.sco.selection.operate_numeric">operate_numeric() (in module csd.sco.selection)</a></dt></dl></td><td width="33%" valign="top"><dl>
+<dt><a href="csd_sco_event.html#csd.sco.selection.operate_numeric">operate_numeric() (in module csd.sco.selection)</a></dt>
+<dt><a href="csd_sco_event.html#csd.overwrite_score">overwrite_score() (in module csd)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="P">P</h2>
@@ -189,7 +192,6 @@ <h2 id="R">R</h2>
<dd><dl>
<dt><a href="csd_sco_event.html#csd.sco.selection.replace">(in module csd.sco.selection)</a></dt>
</dl></dd></dl></td><td width="33%" valign="top"><dl>
-<dt><a href="csd_sco_event.html#csd.replace_score">replace_score() (in module csd)</a></dt>
</dl></td></tr></table>
<h2 id="S">S</h2>
@@ -236,6 +238,13 @@ <h2 id="T">T</h2>
<dt><a href="csd_sco_event.html#csd.sco.event.tokenize">tokenize() (in module csd.sco.event)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
+<h2 id="V">V</h2>
+<table width="100%" class="indextable"><tr><td width="33%" valign="top">
+<dl>
+
+<dt><a href="csd_sco_event.html#csd.sco.preprocessor.value_to_carry">value_to_carry() (in module csd.sco.preprocessor)</a></dt></dl></td><td width="33%" valign="top"><dl>
+</dl></td></tr></table>
+
</div>
View
@@ -58,6 +58,7 @@
<li class="toctree-l2"><a class="reference external" href="csd_sco_event.html#module-csd.sco">sco</a></li>
<li class="toctree-l2"><a class="reference external" href="csd_sco_event.html#module-csd.sco.element">element</a></li>
<li class="toctree-l2"><a class="reference external" href="csd_sco_event.html#module-csd.sco.event">event</a></li>
+<li class="toctree-l2"><a class="reference external" href="csd_sco_event.html#module-csd.sco.preprocessor">preprocessor</a></li>
<li class="toctree-l2"><a class="reference external" href="csd_sco_event.html#module-csd.sco.selection">selection</a></li>
</ul>
</li>
View
@@ -85,6 +85,10 @@ <h1 id="global-module-index">Global Module Index</h1>
<em></em></td></tr><tr class="cg-3">
<td></td>
<td>&nbsp;&nbsp;&nbsp;
+ <a href="csd_sco_event.html#module-csd.sco.preprocessor"><tt class="xref">csd.sco.preprocessor</tt></a></td><td>
+ <em></em></td></tr><tr class="cg-3">
+ <td></td>
+ <td>&nbsp;&nbsp;&nbsp;
<a href="csd_sco_event.html#module-csd.sco.selection"><tt class="xref">csd.sco.selection</tt></a></td><td>
<em></em></td></tr><tr class="pcap"><td></td><td>&nbsp;</td><td></td></tr>
<tr class="cap"><td></td><td><a name="cap-P"><strong>P</strong></a></td><td></td></tr><tr>
View
@@ -2,15 +2,16 @@
# Project: csd
# Version: 0.0.4
csd.sco.selection mod csd_sco_event.html
+csd.sco.preprocessor mod csd_sco_event.html
sco_align mod demo/index.html
csd.sco mod csd_sco_event.html
pfunc mod demo/index.html
csd mod csd_sco_event.html
score_from_csd mod demo/index.html
-carry mod demo/index.html
+arpeggiator mod demo/index.html
s_spacer mod demo/index.html
swap_columns mod demo/index.html
-arpeggiator mod demo/index.html
+carry mod demo/index.html
csd.sco.event mod csd_sco_event.html
csd.sco.element mod csd_sco_event.html
csd.sco.map_ function csd_sco_event.html
@@ -22,7 +23,9 @@ csd.sco.select function csd_sco_event.html
csd.get_options function csd_sco_event.html
csd.get_orchestra function csd_sco_event.html
csd.sco.element.is_valid function csd_sco_event.html
+csd.sco.preprocessor.carry_to_value function csd_sco_event.html
csd.get_midi_base64 function csd_sco_event.html
+csd.overwrite_score function csd_sco_event.html
csd.sco.select_all function csd_sco_event.html
csd.sco.event.match function csd_sco_event.html
csd.get_csound function csd_sco_event.html
@@ -37,6 +40,7 @@ csd.sco.selection.swap function csd_sco_event.html
csd.sco.event.tokenize function csd_sco_event.html
csd.sco.element.token_type function csd_sco_event.html
csd.sco.event.pop function csd_sco_event.html
+csd.sco.preprocessor.value_to_carry function csd_sco_event.html
csd.sco.event.number_of_pfields function csd_sco_event.html
csd.sco.event.statement_spacer function csd_sco_event.html
csd.sco.event.get function csd_sco_event.html
@@ -46,7 +50,6 @@ csd.sco.element.is_valid_pfield function csd_sco_event.html
csd.sco.selection.replace function csd_sco_event.html
csd.sco.merge function csd_sco_event.html
csd.sco.event.split function csd_sco_event.html
-csd.replace_score function csd_sco_event.html
csd.get_sample_base64 function csd_sco_event.html
csd.sco.event.set function csd_sco_event.html
sco_align.align function demo/index.html
Oops, something went wrong.

0 comments on commit 2757953

Please sign in to comment.