Class: Sass::Tree::Visitors::ToCss

Inherits:
Base
  • Object
show all
Defined in:
lib/sass/tree/visitors/to_css.rb

Overview

A visitor for converting a Sass tree into CSS.

Constant Summary collapse

NEWLINE =

Avoid allocating lots of new strings for #output. This is important because #output is called all the time.

"\n"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

node_name, visit, #visit_children, #visit_if

Constructor Details

#initialize(build_source_mapping = false) ⇒ ToCss

Returns a new instance of ToCss.

Parameters:

  • build_source_mapping (Boolean) (defaults to: false) —

    Whether to build a Source::Map while creating the CSS output. The mapping will be available from #source_mapping after the visitor has completed.



11
12
13
14
15
16
17
 
# File 'lib/sass/tree/visitors/to_css.rb', line 11

def initialize(build_source_mapping = false)
  @tabs = 0
  @line = 1
  @offset = 1
  @result = ""
  @source_mapping = Sass::Source::Map.new if build_source_mapping
end

Instance Attribute Details

#source_mapping (readonly)

The source mapping for the generated CSS file. This is only set if build_source_mapping is passed to the constructor and Engine#render has been run.



6
7
8
 
# File 'lib/sass/tree/visitors/to_css.rb', line 6

def source_mapping
  @source_mapping
end

Instance Method Details

#erase!(chars) (protected)

Move the output cursor back chars characters.



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/sass/tree/visitors/to_css.rb', line 55

def erase!(chars)
  return if chars == 0
  str = @result.slice!(-chars..-1)
  newlines = str.count("\n")
  if newlines > 0
    @line -= newlines
    @offset = @result[@result.rindex("\n") || 0..-1].size
  else
    @offset -= chars
  end
end

#for_node(node, attr_prefix = nil) (protected)

Associate all output produced in a block with a given node. Used for source mapping.



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/sass/tree/visitors/to_css.rb', line 41

def for_node(node, attr_prefix = nil)
  return yield unless @source_mapping
  start_pos = Sass::Source::Position.new(@line, @offset)
  yield

  range_attr = attr_prefix ? :"#{attr_prefix}_source_range" : :source_range
  return if node.invisible? || !node.send(range_attr)
  source_range = node.send(range_attr)
  target_end_pos = Sass::Source::Position.new(@line, @offset)
  target_range = Sass::Source::Range.new(start_pos, target_end_pos, nil)
  @source_mapping.add(source_range, target_range)
end

#lstrip (protected)

lstrip the first output in the given block.



96
97
98
99
100
101
102
 
# File 'lib/sass/tree/visitors/to_css.rb', line 96

def lstrip
  old_lstrip = @lstrip
  @lstrip = true
  yield
ensure
  @lstrip = @lstrip && old_lstrip
end

#output(s) (protected)

Add s to the output string and update the line and offset information accordingly.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/sass/tree/visitors/to_css.rb', line 73

def output(s)
  if @lstrip
    s = s.gsub(/\A\s+/, "")
    @lstrip = false
  end

  newlines = s.count(NEWLINE)
  if newlines > 0
    @line += newlines
    @offset = s[s.rindex(NEWLINE)..-1].size
  else
    @offset += s.size
  end

  @result << s
end

#prepend!(prefix) (protected)

Prepend prefix to the output string.



105
106
107
108
109
110
111
112
113
 
# File 'lib/sass/tree/visitors/to_css.rb', line 105

def prepend!(prefix)
  @result.insert 0, prefix
  return unless @source_mapping

  line_delta = prefix.count("\n")
  offset_delta = prefix.gsub(/.*\n/, '').size
  @source_mapping.shift_output_offsets(offset_delta)
  @source_mapping.shift_output_lines(line_delta)
end

#rstrip! (protected)

Strip all trailing whitespace from the output string.



91
92
93
 
# File 'lib/sass/tree/visitors/to_css.rb', line 91

def rstrip!
  erase! @result.length - 1 - (@result.rindex(/[^\s]/) || -1)
end

#visit(node) ⇒ String

Runs the visitor on node.

Parameters:

Returns:

  • (String) —

    The CSS output.



23
24
25
26
27
28
 
# File 'lib/sass/tree/visitors/to_css.rb', line 23

def visit(node)
  super
rescue Sass::SyntaxError => e
  e.modify_backtrace(:filename => node.filename, :line => node.line)
  raise e
end

#visit_charset(node) (protected) 



148
149
150
 
# File 'lib/sass/tree/visitors/to_css.rb', line 148

def visit_charset(node)
  for_node(node) {output("@charset \"#{node.name}\";")}
end

#visit_comment(node) (protected) 



152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/sass/tree/visitors/to_css.rb', line 152

def visit_comment(node)
  return if node.invisible?
  spaces = ('  ' * [@tabs - node.resolved_value[/^ */].size, 0].max)

  content = node.resolved_value.gsub(/^/, spaces)
  if node.type == :silent
    content.gsub!(%r{^(\s*)//(.*)$}) {|md| "#{$1}/*#{$2} */"}
  end
  if (node.style == :compact || node.style == :compressed) && node.type != :loud
    content.gsub!(/\n +(\* *(?!\/))?/, ' ')
  end
  for_node(node) {output(content)}
end

#visit_cssimport(node) (protected) 



242
243
244
 
# File 'lib/sass/tree/visitors/to_css.rb', line 242

def visit_cssimport(node)
  visit_directive(node)
end

#visit_directive(node) (protected) 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/sass/tree/visitors/to_css.rb', line 168

def visit_directive(node)
  was_in_directive = @in_directive
  tab_str = '  ' * @tabs
  if !node.has_children || node.children.empty?
    output(tab_str)
    for_node(node) {output(node.resolved_value)}
    output(!node.has_children ? ";" : " {}")
    return
  end

  @in_directive = @in_directive || !node.is_a?(Sass::Tree::MediaNode)
  output(tab_str) if node.style != :compressed
  for_node(node) {output(node.resolved_value)}
  output(node.style == :compressed ? "{" : " {")
  output(node.style == :compact ? ' ' : "\n") if node.style != :compressed

  was_prop = false
  first = true
  node.children.each do |child|
    next if child.invisible?
    if node.style == :compact
      if child.is_a?(Sass::Tree::PropNode)
        with_tabs(first || was_prop ? 0 : @tabs + 1) do
          visit(child)
          output(' ')
        end
      else
        if was_prop
          erase! 1
          output "\n"
        end

        if first
          lstrip {with_tabs(@tabs + 1) {visit(child)}}
        else
          with_tabs(@tabs + 1) {visit(child)}
        end

        rstrip!
        output "\n"
      end
      was_prop = child.is_a?(Sass::Tree::PropNode)
      first = false
    elsif node.style == :compressed
      output(was_prop ? ";" : "")
      with_tabs(0) {visit(child)}
      was_prop = child.is_a?(Sass::Tree::PropNode)
    else
      with_tabs(@tabs + 1) {visit(child)}
      output "\n"
    end
  end
  rstrip!
  if node.style == :expanded
    output("\n#{tab_str}")
  elsif node.style != :compressed
    output(" ")
  end
  output("}")
ensure
  @in_directive = was_in_directive
end

#visit_keyframerule(node) (protected) 



353
354
355
 
# File 'lib/sass/tree/visitors/to_css.rb', line 353

def visit_keyframerule(node)
  visit_directive(node)
end

#visit_media(node) (protected) 



233
234
235
236
 
# File 'lib/sass/tree/visitors/to_css.rb', line 233

def visit_media(node)
  with_tabs(@tabs + node.tabs) {visit_directive(node)}
  output("\n") if node.style != :compressed && node.group_end
end

#visit_prop(node) (protected) 



246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/sass/tree/visitors/to_css.rb', line 246

def visit_prop(node)
  return if node.resolved_value.empty?
  tab_str = '  ' * (@tabs + node.tabs)
  output(tab_str)
  for_node(node, :name) {output(node.resolved_name)}
  if node.style == :compressed
    output(":")
    for_node(node, :value) {output(node.resolved_value)}
  else
    output(": ")
    for_node(node, :value) {output(node.resolved_value)}
    output(";")
  end
end

#visit_root(node) (protected) 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/sass/tree/visitors/to_css.rb', line 115

def visit_root(node)
  node.children.each do |child|
    next if child.invisible?
    visit(child)
    unless node.style == :compressed
      output "\n"
      if child.is_a?(Sass::Tree::DirectiveNode) && child.has_children && !child.bubbles?
        output "\n"
      end
    end
  end
  rstrip!
  return "" if @result.empty?

  output "\n"

  unless Sass::Util.ruby1_8? || @result.ascii_only?
    if node.style == :compressed
      # A byte order mark is sufficient to tell browsers that this
      # file is UTF-8 encoded, and will override any other detection
      # methods as per http://encoding.spec.whatwg.org/#decode-and-encode.
      prepend! "\uFEFF"
    else
      prepend! "@charset \"UTF-8\";\n"
    end
  end

  @result
rescue Sass::SyntaxError => e
  e.sass_template ||= node.template
  raise e
end

#visit_rule(node) (protected) 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/sass/tree/visitors/to_css.rb', line 263

def visit_rule(node)
  with_tabs(@tabs + node.tabs) do
    rule_separator = node.style == :compressed ? ',' : ', '
    line_separator =
      case node.style
      when :nested, :expanded; "\n"
      when :compressed; ""
      else; " "
      end
    rule_indent = '  ' * @tabs
    per_rule_indent, total_indent = if [:nested, :expanded].include?(node.style)
                                      [rule_indent, '']
                                    else
                                      ['', rule_indent]
                                    end

    joined_rules = node.resolved_rules.members.map do |seq|
      next if seq.has_placeholder?
      rule_part = seq.to_s
      if node.style == :compressed
        rule_part.gsub!(/([^,])\s*\n\s*/m, '\1 ')
        rule_part.gsub!(/\s*([,+>])\s*/m, '\1')
        rule_part.strip!
      end
      rule_part
    end.compact.join(rule_separator)

    joined_rules.lstrip!
    joined_rules.gsub!(/\s*\n\s*/, "#{line_separator}#{per_rule_indent}")

    old_spaces = '  ' * @tabs
    if node.style != :compressed
      if node.options[:debug_info] && !@in_directive
        visit(debug_info_rule(node.debug_info, node.options))
        output "\n"
      elsif node.options[:trace_selectors]
        output("#{old_spaces}/* ")
        output(node.stack_trace.gsub("\n", "\n   #{old_spaces}"))
        output(" */\n")
      elsif node.options[:line_comments]
        output("#{old_spaces}/* line #{node.line}")

        if node.filename
          relative_filename =
            if node.options[:css_filename]
              begin
                Sass::Util.relative_path_from(
                  node.filename, File.dirname(node.options[:css_filename])).to_s
              rescue ArgumentError
                nil
              end
            end
          relative_filename ||= node.filename
          output(", #{relative_filename}")
        end

        output(" */\n")
      end
    end

    end_props, trailer, tabs  = '', '', 0
    if node.style == :compact
      separator, end_props, bracket = ' ', ' ', ' { '
      trailer = "\n" if node.group_end
    elsif node.style == :compressed
      separator, bracket = ';', '{'
    else
      tabs = @tabs + 1
      separator, bracket = "\n", " {\n"
      trailer = "\n" if node.group_end
      end_props = (node.style == :expanded ? "\n" + old_spaces : ' ')
    end
    output(total_indent + per_rule_indent)
    for_node(node, :selector) {output(joined_rules)}
    output(bracket)

    with_tabs(tabs) do
      node.children.each_with_index do |child, i|
        output(separator) if i > 0
        visit(child)
      end
    end

    output(end_props)
    output("}" + trailer)
  end
end

#visit_supports(node) (protected) 



238
239
240
 
# File 'lib/sass/tree/visitors/to_css.rb', line 238

def visit_supports(node)
  visit_media(node)
end

#with_tabs(tabs) (protected) 



32
33
34
35
36
37
 
# File 'lib/sass/tree/visitors/to_css.rb', line 32

def with_tabs(tabs)
  old_tabs, @tabs = @tabs, tabs
  yield
ensure
  @tabs = old_tabs
end