sass-site/source/documentation/Sass/Selector/Universal.html
2018-10-22 14:13:05 -07:00

696 lines
20 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::Selector::Universal
&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/Selector/Universal.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 (U)</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="../Selector.html" title="Sass::Selector (module)">Selector</a></span></span>
&raquo;
<span class="title">Universal</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::Selector::Universal
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="Simple.html" title="Sass::Selector::Simple (class)">Simple</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Simple.html" title="Sass::Selector::Simple (class)">Simple</a></span></li>
<li class="next">Sass::Selector::Universal</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/selector.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A universal selector (`*` in CSS).</p>
</div>
</div>
<div class="tags">
</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="#namespace-instance_method" title="#namespace (instance method)">#<strong>namespace</strong> &#x21d2; String<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The selector namespace.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Simple.html" title="Sass::Selector::Simple (class)">Simple</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Simple.html#filename-instance_method" title="Sass::Selector::Simple#filename (method)">#filename</a></span>, <span class='object_link'><a href="Simple.html#line-instance_method" title="Sass::Selector::Simple#line (method)">#line</a></span></p>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(namespace) &#x21d2; Universal </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Universal.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#specificity-instance_method" title="#specificity (instance method)">#<strong>specificity</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong>(opts = {}) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unify-instance_method" title="#unify (instance method)">#<strong>unify</strong>(sels) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Unification of a universal selector is somewhat complicated, especially
when a namespace is specified.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Simple.html" title="Sass::Selector::Simple (class)">Simple</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Simple.html#eql%3F-instance_method" title="Sass::Selector::Simple#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="Simple.html#hash-instance_method" title="Sass::Selector::Simple#hash (method)">#hash</a></span>, <span class='object_link'><a href="Simple.html#inspect-instance_method" title="Sass::Selector::Simple#inspect (method)">#inspect</a></span>, <span class='object_link'><a href="Simple.html#unique%3F-instance_method" title="Sass::Selector::Simple#unique? (method)">#unique?</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(namespace) &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Selector::Universal (class)">Universal</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Universal</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>namespace</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="#namespace-instance_method" title="Sass::Selector::Universal#namespace (method)">#namespace</a></span></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
149
150
151</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/selector.rb', line 149</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_namespace'>namespace</span><span class='rparen'>)</span>
<span class='ivar'>@namespace</span> <span class='op'>=</span> <span class='id identifier rubyid_namespace'>namespace</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(namespace) &#x21d2; <tt><span class='object_link'><a href="" title="Sass::Selector::Universal (class)">Universal</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Universal</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>namespace</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>See <span class='object_link'><a href="#namespace-instance_method" title="Sass::Selector::Universal#namespace (method)">#namespace</a></span></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
149
150
151</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/selector.rb', line 149</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_namespace'>namespace</span><span class='rparen'>)</span>
<span class='ivar'>@namespace</span> <span class='op'>=</span> <span class='id identifier rubyid_namespace'>namespace</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="namespace-instance_method">
#<strong>namespace</strong> &#x21d2; <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The selector namespace. `nil` means the default namespace, `“”` means no
namespace, `“*”` means any namespace.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
146
147
148</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/selector.rb', line 146</span>
<span class='kw'>def</span> <span class='id identifier rubyid_namespace'>namespace</span>
<span class='ivar'>@namespace</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="specificity-instance_method">
#<strong>specificity</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="AbstractSequence.html#specificity-instance_method" title="Sass::Selector::AbstractSequence#specificity (method)">AbstractSequence#specificity</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
200
201
202</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/selector.rb', line 200</span>
<span class='kw'>def</span> <span class='id identifier rubyid_specificity'>specificity</span>
<span class='int'>0</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
#<strong>to_s</strong>(opts = {}) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li>Selector#to_s</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
154
155
156</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/selector.rb', line 154</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</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='ivar'>@namespace</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@namespace</span><span class='embexpr_end'>}</span><span class='tstring_content'>|*</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unify-instance_method">
#<strong>unify</strong>(sels) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note todo">
<strong>TODO:</strong>
<div class='inline'>
<p>There are lots of cases that this documentation specifies; make sure we
thoroughly test **all of them**.</p>
</div>
</div>
<div class="note todo">
<strong>TODO:</strong>
<div class='inline'>
<p>Keep track of whether a default namespace has been declared and handle
namespace-unspecified selectors accordingly.</p>
</div>
</div>
<div class="note todo">
<strong>TODO:</strong>
<div class='inline'>
<p>If any branch of a CommaSequence ends up being just `“*”`, then all other
branches should be eliminated</p>
</div>
</div>
<p>Unification of a universal selector is somewhat complicated, especially
when a namespace is specified. If there is no namespace specified or any
namespace is specified (namespace `“*”`), then `sel` is returned without
change (unless it&#39;s empty, in which case `“*”` is required).</p>
<p>If a namespace is specified but `sel` does not specify a namespace, then
the given namespace is applied to `sel`, either by adding this <span class='object_link'><a href="" title="Sass::Selector::Universal (class)">Sass::Selector::Universal</a></span>
selector or applying this namespace to an existing <span class='object_link'><a href="Element.html" title="Sass::Selector::Element (class)">Element</a></span> selector.</p>
<p>If both this selector <strong>and</strong> `sel` specify namespaces, those
namespaces are unified via <span class='object_link'>Simple#unify_namespaces</span> and the unified
namespace is used, if possible.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li>Selector#unify</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/selector.rb', line 183</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unify'>unify</span><span class='lparen'>(</span><span class='id identifier rubyid_sels'>sels</span><span class='rparen'>)</span>
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span>
<span class='kw'>case</span> <span class='id identifier rubyid_sels'>sels</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="" title="Sass::Selector::Universal (class)">Universal</a></span></span><span class='semicolon'>;</span> <span class='symbol'>:universal</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="Element.html" title="Sass::Selector::Element (class)">Element</a></span></span><span class='semicolon'>;</span> <span class='id identifier rubyid_sels'>sels</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='kw'>else</span>
<span class='kw'>return</span> <span class='lbracket'>[</span><span class='kw'>self</span><span class='rbracket'>]</span> <span class='op'>+</span> <span class='id identifier rubyid_sels'>sels</span> <span class='kw'>unless</span> <span class='id identifier rubyid_namespace'>namespace</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_namespace'>namespace</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>*</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_sels'>sels</span> <span class='kw'>unless</span> <span class='id identifier rubyid_sels'>sels</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='kw'>return</span> <span class='lbracket'>[</span><span class='kw'>self</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ns'>ns</span><span class='comma'>,</span> <span class='id identifier rubyid_accept'>accept</span> <span class='op'>=</span> <span class='id identifier rubyid_unify_namespaces'>unify_namespaces</span><span class='lparen'>(</span><span class='id identifier rubyid_namespace'>namespace</span><span class='comma'>,</span> <span class='id identifier rubyid_sels'>sels</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_namespace'>namespace</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_accept'>accept</span>
<span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='symbol'>:universal</span> <span class='op'>?</span> <span class='const'><span class='object_link'><a href="" title="Sass::Selector::Universal (class)">Universal</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Sass::Selector::Universal#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ns'>ns</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="Element.html" title="Sass::Selector::Element (class)">Element</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Element.html#initialize-instance_method" title="Sass::Selector::Element#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_ns'>ns</span><span class='rparen'>)</span><span class='rbracket'>]</span> <span class='op'>+</span> <span class='id identifier rubyid_sels'>sels</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Oct 22 13:20:55 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>