class Mustache::Parser
[:multi, [:static, “Hi ”], [:mustache, :etag, “thing”], [:static, “!n”]]
$ mustache –tokens test.mustache
mustache(1) command line tool:
You can see the array of tokens for any template with the
[:static, “!n”]]
[:mustache, :etag, “thing”],
[:static, “Hi ”],
[:multi,
Run through the Parser we’ll get these tokens:
Hi {{thing}}!
For example, given this template:
knows which sigil corresponds to which tag type.
raises SyntaxError if there is anything it doesn’t understand and
converting it into an array of tokens and, really, expressions. It
The Parser is responsible for taking a string template and
def compile(template)
def compile(template) if template.respond_to?(:encoding) @encoding = template.encoding template = template.dup.force_encoding("BINARY") else @encoding = nil end # Keeps information about opened sections. @sections = [] @result = [:multi] @scanner = StringScanner.new(template) # Scan until the end of the template. until @scanner.eos? scan_tags || scan_text end if !@sections.empty? # We have parsed the whole file, but there's still opened sections. type, pos, result = @sections.pop error "Unclosed section #{type.inspect}", pos end @result end
def ctag
def ctag @ctag ||= '}}' end
def error(message, pos = position)
error - other details such as line number and position are
Raises a SyntaxError. The message should be the name of the
def error(message, pos = position) raise SyntaxError.new(message, pos) end
def initialize(options = {})
Accepts an options hash which does nothing but may be used in
def initialize(options = {}) @options = {} end
def otag
def otag @otag ||= '{{' end
def position
def position # The rest of the current line rest = @scanner.check_until(/\n|\Z/).to_s.chomp # What we have parsed so far parsed = @scanner.string[0...@scanner.pos] lines = parsed.split("\n") [ lines.size, lines.last.size - 1, lines.last + rest ] end
def regexp(thing)
Used to quickly convert a string into a regular expression
def regexp(thing) /#{Regexp.escape(thing)}/ end
def scan_tags
def scan_tags # Scan until we hit an opening delimiter. start_of_line = @scanner.beginning_of_line? pre_match_position = @scanner.pos return unless x = @scanner.scan(/([ \t]*)?#{Regexp.escape(otag)}/) padding = @scanner[1] || '' # Don't touch the preceding whitespace unless we're matching the start # of a new line. unless start_of_line @result << [:static, padding] unless padding.empty? padding = '' end # Since {{= rewrites ctag, we store the ctag which should be used # when parsing this specific tag. current_ctag = self.ctag type = @scanner.scan(/#|\^|\/|=|!|<|>|&|\{/) @scanner.skip(/\s*/) # ANY_CONTENT tags allow any character inside of them, while # other tags (such as variables) are more strict. if ANY_CONTENT.include?(type) r = /\s*#{regexp(type)}?#{regexp(current_ctag)}/ content = scan_until_exclusive(r) else content = @scanner.scan(ALLOWED_CONTENT) end # We found {{ but we can't figure out what's going on inside. error "Illegal content in tag" if content.empty? # Based on the sigil, do what needs to be done. case type when '#' block = [:multi] @result << [:mustache, :section, content, block] @sections << [content, position, @result] @result = block when '^' block = [:multi] @result << [:mustache, :inverted_section, content, block] @sections << [content, position, @result] @result = block when '/' section, pos, result = @sections.pop raw = @scanner.pre_match[pos[3]...pre_match_position] + padding (@result = result).last << raw if section.nil? error "Closing unopened #{content.inspect}" elsif section != content error "Unclosed section #{section.inspect}", pos end when '!' # ignore comments when '=' self.otag, self.ctag = content.split(' ', 2) when '>', '<' @result << [:mustache, :partial, content, padding] when '{', '&' # The closing } in unescaped tags is just a hack for # aesthetics. type = "}" if type == "{" @result << [:mustache, :utag, content] else @result << [:mustache, :etag, content] end # Skip whitespace and any balancing sigils after the content # inside this tag. @scanner.skip(/\s+/) @scanner.skip(regexp(type)) if type # Try to find the closing tag. unless close = @scanner.scan(regexp(current_ctag)) error "Unclosed tag" end # If this tag was the only non-whitespace content on this line, strip # the remaining whitespace. If not, but we've been hanging on to padding # from the beginning of the line, re-insert the padding as static text. if start_of_line if SKIP_WHITESPACE.include?(type) @scanner.skip(/[ \t]*\n/) else @result.insert(-2, [:static, padding]) unless padding.empty? end end return unless @result == [:multi] # Store off the current scanner position now that we've closed the tag # and consumed any irrelevant whitespace. @sections.last[1] << @scanner.pos unless @sections.empty? end
def scan_text
def scan_text text = scan_until_exclusive(/(^[ \t]*)?#{Regexp.escape(otag)}/) if text.nil? # Couldn't find any otag, which means the rest is just static text. text = @scanner.rest # Mark as done. @scanner.terminate end text.force_encoding(@encoding) if @encoding @result << [:static, text] unless text.empty? end
def scan_until_exclusive(regexp)
*excluding* the end of the match, advancing the scan pointer to that
Scans the string until the pattern is matched. Returns the substring
def scan_until_exclusive(regexp) pos = @scanner.pos if @scanner.scan_until(regexp) @scanner.pos -= @scanner.matched.size @scanner.pre_match[pos..-1] end end