Class: Rouge::Lexers::PHP

Inherits:
TemplateLexer show all
Defined in:
lib/rouge/lexers/php.rb,
lib/rouge/lexers/php/builtins.rb

Constant Summary

Constants inherited from RegexLexer

RegexLexer::MAX_NULL_SCANS

Constants included from Token::Tokens

Token::Tokens::Num, Token::Tokens::Str

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TemplateLexer

#parent

Methods inherited from RegexLexer

append, #delegate, get_state, #get_state, #goto, #group, #groups, #in_state?, #pop!, prepend, #push, #recurse, replace_state, #reset!, #reset_stack, #stack, start, start_procs, state, #state, #state?, state_definitions, states, #step, #stream_tokens, #token

Methods inherited from Rouge::Lexer

aliases, all, assert_utf8!, #debug, default_options, demo, demo_file, desc, filenames, find, find_fancy, guess, guess_by_filename, guess_by_mimetype, guess_by_source, guesses, lex, #lex, mimetypes, #option, #options, #reset!, #stream_tokens, tag, #tag, title

Methods included from Token::Tokens

token

Constructor Details

#initialize(opts = {}) ⇒ PHP

Returns a new instance of PHP.


18
19
20
21
22
23
24
25
26
# File 'lib/rouge/lexers/php.rb', line 18

def initialize(opts={})
  # if truthy, the lexer starts highlighting with php code
  # (no <?php required)
  @start_inline = opts.delete(:start_inline)
  @funcnamehighlighting = opts.delete(:funcnamehighlighting) { true }
  @disabledmodules = opts.delete(:disabledmodules) { [] }

  super(opts)
end

Class Method Details

.analyze_text(text) ⇒ Object


66
67
68
69
70
# File 'lib/rouge/lexers/php.rb', line 66

def self.analyze_text(text)
  return 1 if text.shebang?('php')
  return 0.3 if /<\?(?!xml)/ =~ text
  0
end

.builtinsObject


28
29
30
31
# File 'lib/rouge/lexers/php.rb', line 28

def self.builtins
  load Pathname.new(__FILE__).dirname.join('php/builtins.rb')
  self.builtins
end

.keywordsObject


52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/rouge/lexers/php.rb', line 52

def self.keywords
  @keywords ||= Set.new %w(
    and E_PARSE old_function E_ERROR or as E_WARNING parent eval
    PHP_OS break exit case extends PHP_VERSION cfunction FALSE
    print for require continue foreach require_once declare return
    default static do switch die stdClass echo else TRUE elseif
    var empty if xor enddeclare include virtual endfor include_once
    while endforeach global __FILE__ endif list __LINE__ endswitch
    new __sleep endwhile not array __wakeup E_ALL NULL final
    php_user_filter interface implements public private protected
    abstract clone try catch throw this use namespace yield
  )
end

Instance Method Details

#builtinsObject


33
34
35
36
37
38
39
40
41
42
# File 'lib/rouge/lexers/php.rb', line 33

def builtins
  return [] unless @funcnamehighlighting

  @builtins ||= Set.new.tap do |builtins|
    self.class.builtins.each do |mod, fns|
      next if @disabledmodules.include? mod
      builtins.merge(fns)
    end
  end
end

#start_inline?Boolean

Returns:

  • (Boolean)

44
45
46
# File 'lib/rouge/lexers/php.rb', line 44

def start_inline?
  !!@start_inline
end