Class: Rouge::Lexers::PHP

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

Direct Known Subclasses

Hack

Constant Summary

Constants inherited from RegexLexer

RegexLexer::MAX_NULL_SCANS

Constants included from Token::Tokens

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

Instance Attribute Summary

Attributes inherited from Rouge::Lexer

#options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TemplateLexer

#parent

Methods inherited from RegexLexer

append, #delegate, #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, #as_bool, #as_lexer, #as_list, #as_string, #as_token, #bool_option, continue_lex, #continue_lex, debug_enabled?, demo, demo_file, desc, detectable?, disable_debug!, enable_debug!, filenames, find, find_fancy, guess, guess_by_filename, guess_by_mimetype, guess_by_source, guesses, #hash_option, lex, #lex, #lexer_option, #list_option, mimetypes, option, option_docs, #reset!, #stream_tokens, #string_option, tag, #tag, title, #token_option

Methods included from Token::Tokens

token

Constructor Details

#initializePHP

Returns a new instance of PHP


21
22
23
24
25
26
27
28
29
# File 'lib/rouge/lexers/php.rb', line 21

def initialize(*)
  super

  # if truthy, the lexer starts highlighting with php code
  # (no <?php required)
  @start_inline = bool_option(:start_inline) { :guess }
  @funcnamehighlighting = bool_option(:funcnamehighlighting) { true }
  @disabledmodules = list_option(:disabledmodules)
end

Class Method Details

.builtinsObject


31
32
33
34
# File 'lib/rouge/lexers/php.rb', line 31

def self.builtins
  load File.join(__dir__, 'php/builtins.rb')
  self.builtins
end

.detect?(text) ⇒ Boolean

Returns:

  • (Boolean)

79
80
81
82
83
# File 'lib/rouge/lexers/php.rb', line 79

def self.detect?(text)
  return true if text.shebang?('php')
  return false if /^<\?hh/ =~ text
  return true if /^<\?php/ =~ text
end

.keywordsObject


65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/rouge/lexers/php.rb', line 65

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


36
37
38
39
40
41
42
43
44
45
# File 'lib/rouge/lexers/php.rb', line 36

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