Class: Sass::Tree::Node

Inherits:

Object

Object
Sass::Tree::Node

show all

Includes:

Enumerable

Defined in:

/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb

Overview

The abstract superclass of all parse-tree nodes.

Direct Known Subclasses

AtRootNode, CharsetNode, CommentNode, ContentNode, DebugNode, DirectiveNode, EachNode, ErrorNode, ExtendNode, ForNode, FunctionNode, IfNode, KeyframeRuleNode, MixinDefNode, MixinNode, PropNode, ReturnNode, RootNode, RuleNode, TraceNode, VariableNode, WarnNode, WhileNode

Instance Attribute Summary (collapse)

- (Array<Tree::Node>) children readonly

The child nodes of this node.
- (String) filename

The name of the document on which this node appeared.
- (Boolean) has_children

Whether or not this node has child nodes.
- (Fixnum) line

The line of the document on which this node appeared.
- ({Symbol => Object}) options

The options hash for the node.
- (Sass::Source::Range) source_range

The source range in the document on which this node appeared.

Instance Method Summary (collapse)

- <<(child)

Appends a child to the node.
- (Boolean) ==(other)

Compares this node and another object (only other Nodes will be equal).
- balance(*args) protected
- (Boolean) bubbles?

Whether or not this node bubbles up through RuleNodes.
- (String) css

Computes the CSS corresponding to this static CSS tree.
- ((String, Sass::Source::Map)) css_with_sourcemap

Computes the CSS corresponding to this static CSS tree, along with the respective source map.
- (Node) deep_copy

Return a deep clone of this node.
- each {|node| ... }

Iterates through each node in the tree rooted at this node in a pre-order walk.
- (Node) initialize constructor

A new instance of Node.
- (String) inspect

Returns a representation of the node for debugging purposes.
- (Boolean) invisible?

True if #to_s will return nil; that is, if the node shouldn’t be rendered.
- (Symbol) style

The output style.
- (String) to_sass(options = {})

Converts a node to Sass code that will generate it.
- (String) to_scss(options = {})

Converts a node to SCSS code that will generate it.

Constructor Details

- (`Node`) initialize

Returns a new instance of Node

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 91

def initialize
  @children = []
  @filename = nil
  @options = nil
end

Instance Attribute Details

- (`Array<Tree::Node>`) children

The child nodes of this node.

Returns:

(Array<Tree::Node>)



61
62
63

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 61

def children
  @children
end

- (`String`) filename

The name of the document on which this node appeared.

Returns:

(String)



114
115
116

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 114

def filename
  @filename || (@options && @options[:filename])
end

- (`Boolean`) has_children

Whether or not this node has child nodes. This may be true even when #children is empty, in which case this node has an empty block (e.g. {}).

Returns:

(Boolean)



68
69
70

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 68

def has_children
  @has_children
end

- (`Fixnum`) line

The line of the document on which this node appeared.

Returns:

(Fixnum)



73
74
75

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 73

def line
  @line
end

- (`{Symbol => Object}`) options

The options hash for the node. See the Sass options documentation.

Returns:

({Symbol => Object})



89
90
91

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 89

def options
  @options
end

- (`Sass::Source::Range`) source_range

The source range in the document on which this node appeared.

Returns:

(Sass::Source::Range)



78
79
80

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 78

def source_range
  @source_range
end

Instance Method Details

- <<(child)

Appends a child to the node.

Parameters:

child (Tree::Node, Array<Tree::Node>) —

The child node or nodes

Raises:

(Sass::SyntaxError) —

if child is invalid

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 122

def <<(child)
  return if child.nil?
  if child.is_a?(Array)
    child.each {|c| self << c}
  else
    self.has_children = true
    @children << child
  end
end

- (`Boolean`) ==(other)

Compares this node and another object (only other Sass::Tree::Nodes will be equal). This does a structural comparison; if the contents of the nodes and all the child nodes are equivalent, then the nodes are as well.

Only static nodes need to override this.

Parameters:

other (Object) —

The object to compare with

Returns:

(Boolean) —

Whether or not this node and the other object are the same

See Also:

Sass::Tree



143
144
145

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 143

def ==(other)
  self.class == other.class && other.children == children
end

- balance(*args) (protected)

Raises:

(Sass::SyntaxError) —

if the brackets aren’t balanced

See Also:

Shared.balance

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 233

def balance(*args)
  res = Sass::Shared.balance(*args)
  return res if res
  raise Sass::SyntaxError.new("Unbalanced brackets.", :line => line)
end

- (`Boolean`) bubbles?

Whether or not this node bubbles up through RuleNodes.

Returns:

(Boolean)



225
226
227

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 225

def bubbles?
  false
end

- (`String`) css

Computes the CSS corresponding to this static CSS tree.

Returns:

(String) —

The resulting CSS

See Also:

Sass::Tree



165
166
167

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 165

def css
  Sass::Tree::Visitors::ToCss.new.visit(self)
end

- (`(String, Sass::Source::Map)`) css_with_sourcemap

Computes the CSS corresponding to this static CSS tree, along with the respective source map.

Returns:

((String, Sass::Source::Map)) —

The resulting CSS and the source map

See Also:

Sass::Tree

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 174

def css_with_sourcemap
  visitor = Sass::Tree::Visitors::ToCss.new(:build_source_mapping)
  result = visitor.visit(self)
  return result, visitor.source_mapping
end

- (`Node`) deep_copy

Return a deep clone of this node. The child nodes are cloned, but options are not.

Returns:

(Node)



218
219
220

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 218

def deep_copy
  Sass::Tree::Visitors::DeepCopy.visit(self)
end

- each {|node| ... }

Iterates through each node in the tree rooted at this node in a pre-order walk.

Yields:

node

Yield Parameters:

node (Node) —

a node in the tree

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 193

def each
  yield self
  children.each {|c| c.each {|n| yield n}}
end

- (`String`) inspect

Returns a representation of the node for debugging purposes.

Returns:

(String)

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 183

def inspect
  return self.class.to_s unless has_children
  "(#{self.class} #{children.map {|c| c.inspect}.join(' ')})"
end

- (`Boolean`) invisible?

True if #to_s will return nil; that is, if the node shouldn’t be rendered. Should only be called in a static tree.

Returns:

(Boolean)

152	# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 152 def invisible?; false; end

- (`Symbol`) style

The output style. See the Sass options documentation.

Returns:

(Symbol)



157
158
159

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 157

def style
  @options[:style]
end

- (`String`) to_sass(options = {})

Converts a node to Sass code that will generate it.

Parameters:

options ({Symbol => Object}) (defaults to: {}) —

An options hash (see CSS#initialize)

Returns:

(String) —

The Sass code corresponding to the node



202
203
204

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 202

def to_sass(options = {})
  Sass::Tree::Visitors::Convert.visit(self, options, :sass)
end

- (`String`) to_scss(options = {})

Converts a node to SCSS code that will generate it.

Parameters:

options ({Symbol => Object}) (defaults to: {}) —

An options hash (see CSS#initialize)

Returns:

(String) —

The Sass code corresponding to the node



210
211
212

# File '/Users/ceppstei/Projects/sass-lang/.sass/lib/sass/tree/node.rb', line 210

def to_scss(options = {})
  Sass::Tree::Visitors::Convert.visit(self, options, :scss)
end

Class: Sass::Tree::Node

Overview

Direct Known Subclasses

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Node) initialize

Instance Attribute Details

- (Array<Tree::Node>) children

- (String) filename

- (Boolean) has_children

- (Fixnum) line

- ({Symbol => Object}) options

- (Sass::Source::Range) source_range

Instance Method Details

- <<(child)

- (Boolean) ==(other)

- balance(*args) (protected)

- (Boolean) bubbles?

- (String) css

- ((String, Sass::Source::Map)) css_with_sourcemap

- (Node) deep_copy

- each {|node| ... }

- (String) inspect

- (Boolean) invisible?

- (Symbol) style

- (String) to_sass(options = {})

- (String) to_scss(options = {})

- (`Node`) initialize

- (`Array<Tree::Node>`) children

- (`String`) filename

- (`Boolean`) has_children

- (`Fixnum`) line

- (`{Symbol => Object}`) options

- (`Sass::Source::Range`) source_range

- (`Boolean`) ==(other)

- (`Boolean`) bubbles?

- (`String`) css

- (`(String, Sass::Source::Map)`) css_with_sourcemap

- (`Node`) deep_copy

- (`String`) inspect

- (`Boolean`) invisible?

- (`Symbol`) style

- (`String`) to_sass(options = {})

- (`String`) to_scss(options = {})