sass-site/source/documentation/Sass/Script/Tree/Node.html
2018-10-22 14:13:05 -07:00

923 lines
23 KiB
HTML

<!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" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Sass::Script::Tree::Node
&mdash; Documentation by YARD 0.9.12
</title>
<link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../../../assets/css/docs.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../../';
framesUrl = "../../../frames.html#!Sass/Script/Tree/Node.html";
</script>
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (N)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Script.html" title="Sass::Script (module)">Script</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Tree.html" title="Sass::Script::Tree (module)">Tree</a></span></span>
&raquo;
<span class="title">Node</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Sass::Script::Tree::Node
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Sass::Script::Tree::Node</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">.ruby-sass/lib/sass/script/tree/node.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The abstract superclass for SassScript parse tree nodes.</p>
<p>Use <span class='object_link'><a href="#perform-instance_method" title="Sass::Script::Tree::Node#perform (method)">#perform</a></span> to evaluate a parse tree.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Funcall.html" title="Sass::Script::Tree::Funcall (class)">Funcall</a></span>, <span class='object_link'><a href="Interpolation.html" title="Sass::Script::Tree::Interpolation (class)">Interpolation</a></span>, <span class='object_link'><a href="ListLiteral.html" title="Sass::Script::Tree::ListLiteral (class)">ListLiteral</a></span>, <span class='object_link'><a href="Literal.html" title="Sass::Script::Tree::Literal (class)">Literal</a></span>, <span class='object_link'><a href="MapLiteral.html" title="Sass::Script::Tree::MapLiteral (class)">MapLiteral</a></span>, <span class='object_link'><a href="Operation.html" title="Sass::Script::Tree::Operation (class)">Operation</a></span>, <span class='object_link'><a href="Selector.html" title="Sass::Script::Tree::Selector (class)">Selector</a></span>, <span class='object_link'><a href="StringInterpolation.html" title="Sass::Script::Tree::StringInterpolation (class)">StringInterpolation</a></span>, <span class='object_link'><a href="UnaryOperation.html" title="Sass::Script::Tree::UnaryOperation (class)">UnaryOperation</a></span>, <span class='object_link'><a href="Variable.html" title="Sass::Script::Tree::Variable (class)">Variable</a></span></p>
</div>
<div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Funcall.html" title="Sass::Script::Tree::Funcall (class)">Funcall</a></span>, <span class='object_link'><a href="Interpolation.html" title="Sass::Script::Tree::Interpolation (class)">Interpolation</a></span>, <span class='object_link'><a href="ListLiteral.html" title="Sass::Script::Tree::ListLiteral (class)">ListLiteral</a></span>, <span class='object_link'><a href="Literal.html" title="Sass::Script::Tree::Literal (class)">Literal</a></span>, <span class='object_link'><a href="MapLiteral.html" title="Sass::Script::Tree::MapLiteral (class)">MapLiteral</a></span>, <span class='object_link'><a href="Operation.html" title="Sass::Script::Tree::Operation (class)">Operation</a></span>, <span class='object_link'><a href="Selector.html" title="Sass::Script::Tree::Selector (class)">Selector</a></span>, <span class='object_link'><a href="StringInterpolation.html" title="Sass::Script::Tree::StringInterpolation (class)">StringInterpolation</a></span>, <span class='object_link'><a href="UnaryOperation.html" title="Sass::Script::Tree::UnaryOperation (class)">UnaryOperation</a></span>, <span class='object_link'><a href="Variable.html" title="Sass::Script::Tree::Variable (class)">Variable</a></span></p>
</div>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#filename-instance_method" title="#filename (instance method)">#<strong>filename</strong> &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The file name of the document on which this node appeared.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#line-instance_method" title="#line (instance method)">#<strong>line</strong> &#x21d2; Integer </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The line of the document on which this node appeared.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#options-instance_method" title="#options (instance method)">#<strong>options</strong> &#x21d2; {Symbol =&gt; Object} </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The options hash for this node.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#source_range-instance_method" title="#source_range (instance method)">#<strong>source_range</strong> &#x21d2; Sass::Source::Range </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The source range in the document on which this node appeared.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#children-instance_method" title="#children (instance method)">#<strong>children</strong> &#x21d2; Array&lt;Node&gt; </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns all child nodes of this node.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#deep_copy-instance_method" title="#deep_copy (instance method)">#<strong>deep_copy</strong> &#x21d2; Node </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns a deep clone of this node.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#force_division!-instance_method" title="#force_division! (instance method)">#<strong>force_division!</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Forces any division operations with number literals in this expression to
do real division, rather than returning strings.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#perform-instance_method" title="#perform (instance method)">#<strong>perform</strong>(environment) &#x21d2; Sass::Script::Value </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Evaluates the node.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_sass-instance_method" title="#to_sass (instance method)">#<strong>to_sass</strong>(opts = {}) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the text of this SassScript expression.</p>
</div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="filename=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="filename-instance_method">
#<strong>filename</strong> &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The file name of the document on which this node appeared.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/tree/node.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_filename'>filename</span>
<span class='ivar'>@filename</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="line=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="line-instance_method">
#<strong>line</strong> &#x21d2; <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The line of the document on which this node appeared.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/tree/node.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_line'>line</span>
<span class='ivar'>@line</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="options=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="options-instance_method">
#<strong>options</strong> &#x21d2; <tt>{Symbol =&gt; Object}</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The options hash for this node.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>{Symbol =&gt; Object}</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/tree/node.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
<span class='ivar'>@options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="source_range=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="source_range-instance_method">
#<strong>source_range</strong> &#x21d2; <tt><span class='object_link'><a href="../../Source/Range.html" title="Sass::Source::Range (class)">Sass::Source::Range</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>The source range in the document on which this node appeared.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../../Source/Range.html" title="Sass::Source::Range (class)">Sass::Source::Range</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/tree/node.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_source_range'>source_range</span>
<span class='ivar'>@source_range</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="children-instance_method">
#<strong>children</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="" title="Sass::Script::Tree::Node (class)">Node</a></span>&gt;</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns all child nodes of this node.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array&lt;<span class='object_link'><a href="" title="Sass::Script::Tree::Node (class)">Node</a></span>&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/tree/node.rb', line 59</span>
<span class='kw'>def</span> <span class='id identifier rubyid_children'>children</span>
<span class='const'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util.html" title="Sass::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_abstract'><span class='object_link'><a href="../../Util.html#abstract-instance_method" title="Sass::Util#abstract (method)">abstract</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="deep_copy-instance_method">
#<strong>deep_copy</strong> &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Script::Tree::Node (class)">Node</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a deep clone of this node. The child nodes are cloned, but options
are not.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Sass::Script::Tree::Node (class)">Node</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
78
79
80</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/tree/node.rb', line 78</span>
<span class='kw'>def</span> <span class='id identifier rubyid_deep_copy'>deep_copy</span>
<span class='const'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util.html" title="Sass::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_abstract'><span class='object_link'><a href="../../Util.html#abstract-instance_method" title="Sass::Util#abstract (method)">abstract</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="force_division!-instance_method">
#<strong>force_division!</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Forces any division operations with number literals in this expression to
do real division, rather than returning strings.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
84
85
86</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/tree/node.rb', line 84</span>
<span class='kw'>def</span> <span class='id identifier rubyid_force_division!'>force_division!</span>
<span class='id identifier rubyid_children'>children</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_force_division!'>force_division!</span><span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="perform-instance_method">
#<strong>perform</strong>(environment) &#x21d2; <tt><span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Sass::Script::Value</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Evaluates the node.</p>
<p><span class='object_link'><a href="#perform-instance_method" title="Sass::Script::Tree::Node#perform (method)">#perform</a></span> shouldn&#39;t be overridden directly; instead, override
<span class='object_link'>#_perform</span>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>environment</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Environment.html" title="Sass::Environment (class)">Sass::Environment</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The environment in which to evaluate the SassScript</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Value.html" title="Sass::Script::Value (module)">Sass::Script::Value</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The SassScript object that is the value of the SassScript</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51
52
53
54</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/tree/node.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_perform'>perform</span><span class='lparen'>(</span><span class='id identifier rubyid_environment'>environment</span><span class='rparen'>)</span>
<span class='id identifier rubyid__perform'>_perform</span><span class='lparen'>(</span><span class='id identifier rubyid_environment'>environment</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../SyntaxError.html" title="Sass::SyntaxError (class)">SyntaxError</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_modify_backtrace'>modify_backtrace</span><span class='lparen'>(</span><span class='symbol'>:line</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_line'>line</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_sass-instance_method">
#<strong>to_sass</strong>(opts = {}) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the text of this SassScript expression.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
70
71
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/tree/node.rb', line 70</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_sass'>to_sass</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Util.html" title="Sass::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_abstract'><span class='object_link'><a href="../../Util.html#abstract-instance_method" title="Sass::Util#abstract (method)">abstract</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Oct 22 13:20:53 2018 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.12 (ruby-2.5.3).
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-535380-14', 'sass-lang.com');
ga('send', 'pageview');
</script>
</body>
</html>