class TaskJuggler::RichTextScanner

The RichTextScanner is used by the RichTextParser to chop the input text into digestable tokens. It specializes the TextScanner class for RichText syntax. The scanner can operate in various modes. The current mode is context dependent. The following modes are supported:

:bop : at the begining of a paragraph. :bol : at the begining of a line. :inline : in the middle of a line :nowiki : ignoring all MediaWiki special tokens :html : read anything until </html> :ref : inside of a REF [[ .. ]] :href : inside of an HREF [ .. ] :func : inside of a block <[ .. ]> or inline <- .. -> function

Public Class Methods

new(masterFile, log) click to toggle source

Calls superclass method

# File lib/taskjuggler/RichText/Scanner.rb, line 34
def initialize(masterFile, log)
  tokenPatterns = [
    # :bol mode rules
    [ :LINEBREAK, /\s*\n/, :bol, method('linebreak') ],
    [ nil, /\s+/, :bol, method('inlineMode') ],

    # :bop mode rules
    [ :PRE, / [^\n]+\n?/, :bop, method('pre') ],
    [ nil, /\s*\n/, :bop, method('linebreak') ],

    # :inline mode rules
    [ :SPACE, /[ \t\n]+/, :inline, method('space') ],

    # :bop and :bol mode rules
    [ :INLINEFUNCSTART, /<-/, [ :bop, :bol, :inline ],
      method('functionStart') ],
    [ :BLOCKFUNCSTART, /<\[/, [ :bop, :bol ], method('functionStart') ],
    [ ':TITLE*', /={2,5}/, [ :bop, :bol ], method('titleStart') ],
    [ 'TITLE*END', /={2,5}/, :inline, method('titleEnd') ],
    [ 'BULLET*', /\*{1,4}[ \t]+/, [ :bop, :bol ], method('bullet') ],
    [ 'NUMBER*', /\#{1,4}[ \t]+/, [ :bop, :bol ], method('number') ],
    [ :HLINE, /----/, [ :bop, :bol ], method('inlineMode') ],

    # :bop, :bol and :inline mode rules
    # The <nowiki> token puts the scanner into :nowiki mode.
    [ nil, /<nowiki>/, [ :bop, :bol, :inline ], method('nowikiStart') ],
    [ nil, /<html>/, [ :bop, :bol, :inline ], method('htmlStart') ],
    [ :FCOLSTART, /<fcol:([a-z]+|#[0-9A-Fa-f]{3,6})>/, [ :bop, :bol,
      :inline ],
      method('fontColorStart') ],
    [ :FCOLEND, /<\/fcol>/, [ :bop, :bol, :inline ],
      method('fontColorEnd') ],
    [ :QUOTES, /'{2,5}/, [ :bop, :bol, :inline ], method('quotes') ],
    [ :REF, /\[\[/, [ :bop, :bol, :inline ], method('refStart') ],
    [ :HREF, /\[/, [ :bop, :bol, :inline], method('hrefStart') ],
    [ :WORD, /.[^ \n\t\[<']*/, [ :bop, :bol, :inline ],
      method('inlineMode') ],

    # :nowiki mode rules
    [ nil, /<\/nowiki>/, :nowiki, method('nowikiEnd') ],
    [ :WORD, /(<(?!\/nowiki>)|[^ \t\n<])+/, :nowiki ],
    [ :SPACE, /[ \t]+/, :nowiki ],
    [ :LINEBREAK, /\s*\n/, :nowiki ],

    # :html mode rules
    [ :HTMLBLOB, /(.|\n)*<\/html>/ , :html, method('htmlEnd') ],
    [ :HTMLBLOB, /.*\n/ , :html ],

    # :ref mode rules
    [ :REFEND, /\]\]/, :ref, method('refEnd') ],
    [ :WORD, /(<(?!-)|(\](?!\])|[^|<\]]))+/, :ref ],
    [ :QUERY, /<-\w+->/, :ref, method('query') ],
    [ :LITERAL, /./, :ref ],

    # :href mode rules
    [ :HREFEND, /\]/, :href, method('hrefEnd') ],
    [ :WORD, /(<(?!-)|[^ \t\n\]<])+/, :href ],
    [ :QUERY, /<-\w+->/, :href, method('query') ],
    [ :SPACE, /[ \t\n]+/, :href ],

    # :func mode rules
    [ :INLINEFUNCEND, /->/ , :func, method('functionEnd') ],
    [ :BLOCKFUNCEND, /\]>/, :func, method('functionEnd') ],
    [ :ID, /[a-zA-Z_]\w*/, :func ],
    [ :STRING, /"(\\"|[^"])*"/, :func, method('dqString') ],
    [ :STRING, /'(\\'|[^'])*'/, :func, method('sqString') ],
    [ nil, /[ \t\n]+/, :func ],
    [ :LITERAL, /./, :func ]
  ]
  super(masterFile, log, tokenPatterns, :bop)
end