Parent

Included Modules

Class/Module Index [+]

Quicksearch

Sass::Script::Lexer

The lexical analyzer for SassScript. It takes a raw string and converts it to individual tokens that are easier to parse.

Constants

IDENT_OP_NAMES

A sub-list of {OP_NAMES} that only includes operators with identifier names.

OPERATORS

A hash from operator strings to the corresponding token types.

OPERATORS_REVERSE
OP_NAMES

A list of operator strings ordered with longer names first so that `>` and `<` don't clobber `>=` and `<=`.

PARSEABLE_NUMBER
REGULAR_EXPRESSIONS

A hash of regular expressions that are used for tokenizing.

STRING_REGULAR_EXPRESSIONS

A hash of regular expressions that are used for tokenizing strings.

The key is a `[Symbol, Boolean]` pair. The symbol represents which style of quotation to use, while the boolean represents whether or not the string is following an interpolated segment.

TOKEN_NAMES
Token

A struct containing information about an individual token.

`type`: [`Symbol`] : The type of token.

`value`: [`Object`] : The Ruby object corresponding to the value of the token.

`source_range`: [`Sass::Source::Range`] : The range in the source file in which the token appeared.

`pos`: [`Fixnum`] : The scanner position at which the SassScript token appeared.

Public Class Methods

new(str, line, offset, options) click to toggle source

@param str [String, StringScanner] The source text to lex @param line [Fixnum] The 1-based line on which the SassScript appears.

Used for error reporting and sourcemap building

@param offset [Fixnum] The 1-based character (not byte) offset in the line in the source.

Used for error reporting and sourcemap building

@param options [{Symbol => Object}] An options hash;

see {file:SASS_REFERENCE.md#sass_options the Sass options documentation}
# File lib/sass/script/lexer.rb, line 151
def initialize(str, line, offset, options)
  @scanner = str.is_a?(StringScanner) ? str : Sass::Util::MultibyteStringScanner.new(str)
  @line = line
  @offset = offset
  @options = options
  @interpolation_stack = []
  @prev = nil
end

Public Instance Methods

after_interpolation?() click to toggle source

@return [Boolean] Whether or not the last token lexed was `:end_interpolation`.

# File lib/sass/script/lexer.rb, line 206
def after_interpolation?
  @prev && @prev.type == :end_interpolation
end
done?() click to toggle source

@return [Boolean] Whether or not there's more source text to lex.

# File lib/sass/script/lexer.rb, line 200
def done?
  whitespace unless after_interpolation? && @interpolation_stack.last
  @scanner.eos? && @tok.nil?
end
expected!(name) click to toggle source

Raise an error to the effect that `name` was expected in the input stream and wasn't found.

This calls {#unpeek!} to rewind the scanner to immediately after the last returned token.

@param name [String] The name of the entity that was expected but not found @raise [Sass::SyntaxError]

# File lib/sass/script/lexer.rb, line 218
def expected!(name)
  unpeek!
  Sass::SCSS::Parser.expected(@scanner, name, @line)
end
line() click to toggle source

The line number of the lexer's current position.

@return [Fixnum]

# File lib/sass/script/lexer.rb, line 29
def line
  return @line unless @tok
  @tok.source_range.start_pos.line
end
next() click to toggle source

Moves the lexer forward one token.

@return [Token] The token that was moved past

# File lib/sass/script/lexer.rb, line 163
def next
  @tok ||= read_token
  @tok, tok = nil, @tok
  @prev = tok
  tok
end
offset() click to toggle source

The number of bytes into the current line of the lexer's current position (1-based).

@return [Fixnum]

# File lib/sass/script/lexer.rb, line 38
def offset
  return @offset unless @tok
  @tok.source_range.start_pos.offset
end
peek() click to toggle source

Returns the next token without moving the lexer forward.

@return [Token] The next token

# File lib/sass/script/lexer.rb, line 185
def peek
  @tok ||= read_token
end
str() click to toggle source

Records all non-comment text the lexer consumes within the block and returns it as a string.

@yield A block in which text is recorded @return [String]

# File lib/sass/script/lexer.rb, line 228
def str
  old_pos = @tok ? @tok.pos : @scanner.pos
  yield
  new_pos = @tok ? @tok.pos : @scanner.pos
  @scanner.string[old_pos...new_pos]
end
unpeek!() click to toggle source

Rewinds the underlying StringScanner to before the token returned by {#peek}.

# File lib/sass/script/lexer.rb, line 191
def unpeek!
  if @tok
    @scanner.pos = @tok.pos
    @line = @tok.source_range.start_pos.line
    @offset = @tok.source_range.start_pos.offset
  end
end
whitespace?(tok = @tok) click to toggle source

Returns whether or not there's whitespace before the next token.

@return [Boolean]

# File lib/sass/script/lexer.rb, line 173
def whitespace?(tok = @tok)
  if tok
    @scanner.string[0...tok.pos] =~ /\s\Z/
  else
    @scanner.string[@scanner.pos, 1] =~ /^\s/ ||
      @scanner.string[@scanner.pos - 1, 1] =~ /\s\Z/
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.