mirror of
https://github.com/redmine/redmine.git
synced 2025-11-09 06:46:01 +01:00
Added syntax highlightment for repository files (using CodeRay).
Supported languages: c, ruby, rhtml, yaml, html, xml. git-svn-id: http://redmine.rubyforge.org/svn/trunk@644 e93f8b46-1217-0410-a6f0-8f06a7374b81
This commit is contained in:
189
vendor/plugins/coderay-0.7.6.227/lib/coderay/helpers/file_type.rb
vendored
Normal file
189
vendor/plugins/coderay-0.7.6.227/lib/coderay/helpers/file_type.rb
vendored
Normal file
@@ -0,0 +1,189 @@
|
||||
module CodeRay
|
||||
|
||||
# = FileType
|
||||
#
|
||||
# A simple filetype recognizer.
|
||||
#
|
||||
# Copyright (c) 2006 by murphy (Kornelius Kalnbach) <murphy rubychan de>
|
||||
#
|
||||
# License:: LGPL / ask the author
|
||||
# Version:: 0.1 (2005-09-01)
|
||||
#
|
||||
# == Documentation
|
||||
#
|
||||
# # determine the type of the given
|
||||
# lang = FileType[ARGV.first]
|
||||
#
|
||||
# # return :plaintext if the file type is unknown
|
||||
# lang = FileType.fetch ARGV.first, :plaintext
|
||||
#
|
||||
# # try the shebang line, too
|
||||
# lang = FileType.fetch ARGV.first, :plaintext, true
|
||||
module FileType
|
||||
|
||||
UnknownFileType = Class.new Exception
|
||||
|
||||
class << self
|
||||
|
||||
# Try to determine the file type of the file.
|
||||
#
|
||||
# +filename+ is a relative or absolute path to a file.
|
||||
#
|
||||
# The file itself is only accessed when +read_shebang+ is set to true.
|
||||
# That means you can get filetypes from files that don't exist.
|
||||
def [] filename, read_shebang = false
|
||||
name = File.basename filename
|
||||
ext = File.extname name
|
||||
ext.sub!(/^\./, '') # delete the leading dot
|
||||
|
||||
type =
|
||||
TypeFromExt[ext] ||
|
||||
TypeFromExt[ext.downcase] ||
|
||||
TypeFromName[name] ||
|
||||
TypeFromName[name.downcase]
|
||||
type ||= shebang(filename) if read_shebang
|
||||
|
||||
type
|
||||
end
|
||||
|
||||
def shebang filename
|
||||
begin
|
||||
File.open filename, 'r' do |f|
|
||||
first_line = f.gets
|
||||
first_line[TypeFromShebang]
|
||||
end
|
||||
rescue IOError
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
# This works like Hash#fetch.
|
||||
#
|
||||
# If the filetype cannot be found, the +default+ value
|
||||
# is returned.
|
||||
def fetch filename, default = nil, read_shebang = false
|
||||
if default and block_given?
|
||||
warn 'block supersedes default value argument'
|
||||
end
|
||||
|
||||
unless type = self[filename, read_shebang]
|
||||
return yield if block_given?
|
||||
return default if default
|
||||
raise UnknownFileType, 'Could not determine type of %p.' % filename
|
||||
end
|
||||
type
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
TypeFromExt = {
|
||||
'rb' => :ruby,
|
||||
'rbw' => :ruby,
|
||||
'rake' => :ruby,
|
||||
'mab' => :ruby,
|
||||
'cpp' => :c,
|
||||
'c' => :c,
|
||||
'h' => :c,
|
||||
'xml' => :xml,
|
||||
'htm' => :html,
|
||||
'html' => :html,
|
||||
'xhtml' => :xhtml,
|
||||
'raydebug' => :debug,
|
||||
'rhtml' => :rhtml,
|
||||
'ss' => :scheme,
|
||||
'sch' => :scheme,
|
||||
'yaml' => :yaml,
|
||||
'yml' => :yaml,
|
||||
}
|
||||
|
||||
TypeFromShebang = /\b(?:ruby|perl|python|sh)\b/
|
||||
|
||||
TypeFromName = {
|
||||
'Rakefile' => :ruby,
|
||||
'Rantfile' => :ruby,
|
||||
}
|
||||
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
if $0 == __FILE__
|
||||
$VERBOSE = true
|
||||
eval DATA.read, nil, $0, __LINE__+4
|
||||
end
|
||||
|
||||
__END__
|
||||
|
||||
require 'test/unit'
|
||||
|
||||
class TC_FileType < Test::Unit::TestCase
|
||||
|
||||
def test_fetch
|
||||
assert_raise FileType::UnknownFileType do
|
||||
FileType.fetch ''
|
||||
end
|
||||
|
||||
assert_throws :not_found do
|
||||
FileType.fetch '.' do
|
||||
throw :not_found
|
||||
end
|
||||
end
|
||||
|
||||
assert_equal :default, FileType.fetch('c', :default)
|
||||
|
||||
stderr, fake_stderr = $stderr, Object.new
|
||||
$err = ''
|
||||
def fake_stderr.write x
|
||||
$err << x
|
||||
end
|
||||
$stderr = fake_stderr
|
||||
FileType.fetch('c', :default) { }
|
||||
assert_equal "block supersedes default value argument\n", $err
|
||||
$stderr = stderr
|
||||
end
|
||||
|
||||
def test_ruby
|
||||
assert_equal :ruby, FileType['test.rb']
|
||||
assert_equal :ruby, FileType['C:\\Program Files\\x\\y\\c\\test.rbw']
|
||||
assert_equal :ruby, FileType['/usr/bin/something/Rakefile']
|
||||
assert_equal :ruby, FileType['~/myapp/gem/Rantfile']
|
||||
assert_equal :ruby, FileType['./lib/tasks\repository.rake']
|
||||
assert_not_equal :ruby, FileType['test_rb']
|
||||
assert_not_equal :ruby, FileType['Makefile']
|
||||
assert_not_equal :ruby, FileType['set.rb/set']
|
||||
assert_not_equal :ruby, FileType['~/projects/blabla/rb']
|
||||
end
|
||||
|
||||
def test_c
|
||||
assert_equal :c, FileType['test.c']
|
||||
assert_equal :c, FileType['C:\\Program Files\\x\\y\\c\\test.h']
|
||||
assert_not_equal :c, FileType['test_c']
|
||||
assert_not_equal :c, FileType['Makefile']
|
||||
assert_not_equal :c, FileType['set.h/set']
|
||||
assert_not_equal :c, FileType['~/projects/blabla/c']
|
||||
end
|
||||
|
||||
def test_html
|
||||
assert_equal :html, FileType['test.htm']
|
||||
assert_equal :xhtml, FileType['test.xhtml']
|
||||
assert_equal :xhtml, FileType['test.html.xhtml']
|
||||
assert_equal :rhtml, FileType['_form.rhtml']
|
||||
end
|
||||
|
||||
def test_yaml
|
||||
assert_equal :yaml, FileType['test.yml']
|
||||
assert_equal :yaml, FileType['test.yaml']
|
||||
assert_equal :yaml, FileType['my.html.yaml']
|
||||
assert_not_equal :yaml, FileType['YAML']
|
||||
end
|
||||
|
||||
def test_shebang
|
||||
dir = './test'
|
||||
if File.directory? dir
|
||||
Dir.chdir dir do
|
||||
assert_equal :c, FileType['test.c']
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
123
vendor/plugins/coderay-0.7.6.227/lib/coderay/helpers/gzip_simple.rb
vendored
Normal file
123
vendor/plugins/coderay-0.7.6.227/lib/coderay/helpers/gzip_simple.rb
vendored
Normal file
@@ -0,0 +1,123 @@
|
||||
# =GZip Simple
|
||||
#
|
||||
# A simplified interface to the gzip library +zlib+ (from the Ruby Standard Library.)
|
||||
#
|
||||
# Author: murphy (mail to murphy cYcnus de)
|
||||
#
|
||||
# Version: 0.2 (2005.may.28)
|
||||
#
|
||||
# ==Documentation
|
||||
#
|
||||
# See +GZip+ module and the +String+ extensions.
|
||||
#
|
||||
module GZip
|
||||
|
||||
require 'zlib'
|
||||
|
||||
# The default zipping level. 7 zips good and fast.
|
||||
DEFAULT_GZIP_LEVEL = 7
|
||||
|
||||
# Unzips the given string +s+.
|
||||
#
|
||||
# Example:
|
||||
# require 'gzip_simple'
|
||||
# print GZip.gunzip(File.read('adresses.gz'))
|
||||
def GZip.gunzip s
|
||||
Zlib::Inflate.inflate s
|
||||
end
|
||||
|
||||
# Zips the given string +s+.
|
||||
#
|
||||
# Example:
|
||||
# require 'gzip_simple'
|
||||
# File.open('adresses.gz', 'w') do |file
|
||||
# file.write GZip.gzip('Mum: 0123 456 789', 9)
|
||||
# end
|
||||
#
|
||||
# If you provide a +level+, you can control how strong
|
||||
# the string is compressed:
|
||||
# - 0: no compression, only convert to gzip format
|
||||
# - 1: compress fast
|
||||
# - 7: compress more, but still fast (default)
|
||||
# - 8: compress more, slower
|
||||
# - 9: compress best, very slow
|
||||
def GZip.gzip s, level = DEFAULT_GZIP_LEVEL
|
||||
Zlib::Deflate.new(level).deflate s, Zlib::FINISH
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
# String extensions to use the GZip module.
|
||||
#
|
||||
# The methods gzip and gunzip provide an even more simple
|
||||
# interface to the ZLib:
|
||||
#
|
||||
# # create a big string
|
||||
# x = 'a' * 1000
|
||||
#
|
||||
# # zip it
|
||||
# x_gz = x.gzip
|
||||
#
|
||||
# # test the result
|
||||
# puts 'Zipped %d bytes to %d bytes.' % [x.size, x_gz.size]
|
||||
# #-> Zipped 1000 bytes to 19 bytes.
|
||||
#
|
||||
# # unzipping works
|
||||
# p x_gz.gunzip == x #-> true
|
||||
class String
|
||||
# Returns the string, unzipped.
|
||||
# See GZip.gunzip
|
||||
def gunzip
|
||||
GZip.gunzip self
|
||||
end
|
||||
# Replaces the string with its unzipped value.
|
||||
# See GZip.gunzip
|
||||
def gunzip!
|
||||
replace gunzip
|
||||
end
|
||||
|
||||
# Returns the string, zipped.
|
||||
# +level+ is the gzip compression level, see GZip.gzip.
|
||||
def gzip level = GZip::DEFAULT_GZIP_LEVEL
|
||||
GZip.gzip self, level
|
||||
end
|
||||
# Replaces the string with its zipped value.
|
||||
# See GZip.gzip.
|
||||
def gzip!(*args)
|
||||
replace gzip(*args)
|
||||
end
|
||||
end
|
||||
|
||||
if $0 == __FILE__
|
||||
eval DATA.read, nil, $0, __LINE__+4
|
||||
end
|
||||
|
||||
__END__
|
||||
#CODE
|
||||
|
||||
# Testing / Benchmark
|
||||
x = 'a' * 1000
|
||||
x_gz = x.gzip
|
||||
puts 'Zipped %d bytes to %d bytes.' % [x.size, x_gz.size] #-> Zipped 1000 bytes to 19 bytes.
|
||||
p x_gz.gunzip == x #-> true
|
||||
|
||||
require 'benchmark'
|
||||
|
||||
INFO = 'packed to %0.3f%%' # :nodoc:
|
||||
|
||||
x = Array.new(100000) { rand(255).chr + 'aaaaaaaaa' + rand(255).chr }.join
|
||||
Benchmark.bm(10) do |bm|
|
||||
for level in 0..9
|
||||
bm.report "zip #{level}" do
|
||||
$x = x.gzip level
|
||||
end
|
||||
puts INFO % [100.0 * $x.size / x.size]
|
||||
end
|
||||
bm.report 'zip' do
|
||||
$x = x.gzip
|
||||
end
|
||||
puts INFO % [100.0 * $x.size / x.size]
|
||||
bm.report 'unzip' do
|
||||
$x.gunzip
|
||||
end
|
||||
end
|
||||
329
vendor/plugins/coderay-0.7.6.227/lib/coderay/helpers/plugin.rb
vendored
Normal file
329
vendor/plugins/coderay-0.7.6.227/lib/coderay/helpers/plugin.rb
vendored
Normal file
@@ -0,0 +1,329 @@
|
||||
module CodeRay
|
||||
|
||||
# = PluginHost
|
||||
#
|
||||
# $Id: plugin.rb 220 2007-01-01 02:58:58Z murphy $
|
||||
#
|
||||
# A simple subclass plugin system.
|
||||
#
|
||||
# Example:
|
||||
# class Generators < PluginHost
|
||||
# plugin_path 'app/generators'
|
||||
# end
|
||||
#
|
||||
# class Generator
|
||||
# extend Plugin
|
||||
# PLUGIN_HOST = Generators
|
||||
# end
|
||||
#
|
||||
# class FancyGenerator < Generator
|
||||
# register_for :fancy
|
||||
# end
|
||||
#
|
||||
# Generators[:fancy] #-> FancyGenerator
|
||||
# # or
|
||||
# require_plugin 'Generators/fancy'
|
||||
module PluginHost
|
||||
|
||||
# Raised if Encoders::[] fails because:
|
||||
# * a file could not be found
|
||||
# * the requested Encoder is not registered
|
||||
PluginNotFound = Class.new Exception
|
||||
HostNotFound = Class.new Exception
|
||||
|
||||
PLUGIN_HOSTS = []
|
||||
PLUGIN_HOSTS_BY_ID = {} # dummy hash
|
||||
|
||||
# Loads all plugins using list and load.
|
||||
def load_all
|
||||
for plugin in list
|
||||
load plugin
|
||||
end
|
||||
end
|
||||
|
||||
# Returns the Plugin for +id+.
|
||||
#
|
||||
# Example:
|
||||
# yaml_plugin = MyPluginHost[:yaml]
|
||||
def [] id, *args, &blk
|
||||
plugin = validate_id(id)
|
||||
begin
|
||||
plugin = plugin_hash.[] plugin, *args, &blk
|
||||
end while plugin.is_a? Symbol
|
||||
plugin
|
||||
end
|
||||
|
||||
# Alias for +[]+.
|
||||
alias load []
|
||||
|
||||
def require_helper plugin_id, helper_name
|
||||
path = path_to File.join(plugin_id, helper_name)
|
||||
require path
|
||||
end
|
||||
|
||||
class << self
|
||||
|
||||
# Adds the module/class to the PLUGIN_HOSTS list.
|
||||
def extended mod
|
||||
PLUGIN_HOSTS << mod
|
||||
end
|
||||
|
||||
# Warns you that you should not #include this module.
|
||||
def included mod
|
||||
warn "#{name} should not be included. Use extend."
|
||||
end
|
||||
|
||||
# Find the PluginHost for host_id.
|
||||
def host_by_id host_id
|
||||
unless PLUGIN_HOSTS_BY_ID.default_proc
|
||||
ph = Hash.new do |h, a_host_id|
|
||||
for host in PLUGIN_HOSTS
|
||||
h[host.host_id] = host
|
||||
end
|
||||
h.fetch a_host_id, nil
|
||||
end
|
||||
PLUGIN_HOSTS_BY_ID.replace ph
|
||||
end
|
||||
PLUGIN_HOSTS_BY_ID[host_id]
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# The path where the plugins can be found.
|
||||
def plugin_path *args
|
||||
unless args.empty?
|
||||
@plugin_path = File.expand_path File.join(*args)
|
||||
load_map
|
||||
end
|
||||
@plugin_path
|
||||
end
|
||||
|
||||
# The host's ID.
|
||||
#
|
||||
# If PLUGIN_HOST_ID is not set, it is simply the class name.
|
||||
def host_id
|
||||
if self.const_defined? :PLUGIN_HOST_ID
|
||||
self::PLUGIN_HOST_ID
|
||||
else
|
||||
name
|
||||
end
|
||||
end
|
||||
|
||||
# Map a plugin_id to another.
|
||||
#
|
||||
# Usage: Put this in a file plugin_path/_map.rb.
|
||||
#
|
||||
# class MyColorHost < PluginHost
|
||||
# map :navy => :dark_blue,
|
||||
# :maroon => :brown,
|
||||
# :luna => :moon
|
||||
# end
|
||||
def map hash
|
||||
for from, to in hash
|
||||
from = validate_id from
|
||||
to = validate_id to
|
||||
plugin_hash[from] = to unless plugin_hash.has_key? from
|
||||
end
|
||||
end
|
||||
|
||||
# Define the default plugin to use when no plugin is found
|
||||
# for a given id.
|
||||
#
|
||||
# See also map.
|
||||
#
|
||||
# class MyColorHost < PluginHost
|
||||
# map :navy => :dark_blue
|
||||
# default :gray
|
||||
# end
|
||||
def default id
|
||||
id = validate_id id
|
||||
plugin_hash[nil] = id
|
||||
end
|
||||
|
||||
# Every plugin must register itself for one or more
|
||||
# +ids+ by calling register_for, which calls this method.
|
||||
#
|
||||
# See Plugin#register_for.
|
||||
def register plugin, *ids
|
||||
for id in ids
|
||||
unless id.is_a? Symbol
|
||||
raise ArgumentError,
|
||||
"id must be a Symbol, but it was a #{id.class}"
|
||||
end
|
||||
plugin_hash[validate_id(id)] = plugin
|
||||
end
|
||||
end
|
||||
|
||||
# A Hash of plugion_id => Plugin pairs.
|
||||
def plugin_hash
|
||||
@plugin_hash ||= create_plugin_hash
|
||||
end
|
||||
|
||||
# Returns an array of all .rb files in the plugin path.
|
||||
#
|
||||
# The extension .rb is not included.
|
||||
def list
|
||||
Dir[path_to('*')].select do |file|
|
||||
File.basename(file)[/^(?!_)\w+\.rb$/]
|
||||
end.map do |file|
|
||||
File.basename file, '.rb'
|
||||
end
|
||||
end
|
||||
|
||||
# Makes a map of all loaded plugins.
|
||||
def inspect
|
||||
map = plugin_hash.dup
|
||||
map.each do |id, plugin|
|
||||
map[id] = plugin.to_s[/(?>[\w_]+)$/]
|
||||
end
|
||||
"#{name}[#{host_id}]#{map.inspect}"
|
||||
end
|
||||
|
||||
protected
|
||||
# Created a new plugin list and stores it to @plugin_hash.
|
||||
def create_plugin_hash
|
||||
@plugin_hash =
|
||||
Hash.new do |h, plugin_id|
|
||||
id = validate_id(plugin_id)
|
||||
path = path_to id
|
||||
begin
|
||||
require path
|
||||
rescue LoadError => boom
|
||||
if h.has_key? nil # default plugin
|
||||
h[id] = h[nil]
|
||||
else
|
||||
raise PluginNotFound, 'Could not load plugin %p: %s' % [id, boom]
|
||||
end
|
||||
else
|
||||
# Plugin should have registered by now
|
||||
unless h.has_key? id
|
||||
raise PluginNotFound,
|
||||
"No #{self.name} plugin for #{id.inspect} found in #{path}."
|
||||
end
|
||||
end
|
||||
h[id]
|
||||
end
|
||||
end
|
||||
|
||||
# Loads the map file (see map).
|
||||
#
|
||||
# This is done automatically when plugin_path is called.
|
||||
def load_map
|
||||
mapfile = path_to '_map'
|
||||
if File.exist? mapfile
|
||||
require mapfile
|
||||
elsif $DEBUG
|
||||
warn 'no _map.rb found for %s' % name
|
||||
end
|
||||
end
|
||||
|
||||
# Returns the Plugin for +id+.
|
||||
# Use it like Hash#fetch.
|
||||
#
|
||||
# Example:
|
||||
# yaml_plugin = MyPluginHost[:yaml, :default]
|
||||
def fetch id, *args, &blk
|
||||
plugin_hash.fetch validate_id(id), *args, &blk
|
||||
end
|
||||
|
||||
# Returns the expected path to the plugin file for the given id.
|
||||
def path_to plugin_id
|
||||
File.join plugin_path, "#{plugin_id}.rb"
|
||||
end
|
||||
|
||||
# Converts +id+ to a Symbol if it is a String,
|
||||
# or returns +id+ if it already is a Symbol.
|
||||
#
|
||||
# Raises +ArgumentError+ for all other objects, or if the
|
||||
# given String includes non-alphanumeric characters (\W).
|
||||
def validate_id id
|
||||
if id.is_a? Symbol or id.nil?
|
||||
id
|
||||
elsif id.is_a? String
|
||||
if id[/\w+/] == id
|
||||
id.to_sym
|
||||
else
|
||||
raise ArgumentError, "Invalid id: '#{id}' given."
|
||||
end
|
||||
else
|
||||
raise ArgumentError,
|
||||
"String or Symbol expected, but #{id.class} given."
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
|
||||
# = Plugin
|
||||
#
|
||||
# Plugins have to include this module.
|
||||
#
|
||||
# IMPORTANT: use extend for this module.
|
||||
#
|
||||
# Example: see PluginHost.
|
||||
module Plugin
|
||||
|
||||
def included mod
|
||||
warn "#{name} should not be included. Use extend."
|
||||
end
|
||||
|
||||
# Register this class for the given langs.
|
||||
# Example:
|
||||
# class MyPlugin < PluginHost::BaseClass
|
||||
# register_for :my_id
|
||||
# ...
|
||||
# end
|
||||
#
|
||||
# See PluginHost.register.
|
||||
def register_for *ids
|
||||
plugin_host.register self, *ids
|
||||
end
|
||||
|
||||
# The host for this Plugin class.
|
||||
def plugin_host host = nil
|
||||
if host and not host.is_a? PluginHost
|
||||
raise ArgumentError,
|
||||
"PluginHost expected, but #{host.class} given."
|
||||
end
|
||||
self.const_set :PLUGIN_HOST, host if host
|
||||
self::PLUGIN_HOST
|
||||
end
|
||||
|
||||
# Require some helper files.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# class MyPlugin < PluginHost::BaseClass
|
||||
# register_for :my_id
|
||||
# helper :my_helper
|
||||
#
|
||||
# The above example loads the file myplugin/my_helper.rb relative to the
|
||||
# file in which MyPlugin was defined.
|
||||
def helper *helpers
|
||||
for helper in helpers
|
||||
self::PLUGIN_HOST.require_helper plugin_id, helper.to_s
|
||||
end
|
||||
end
|
||||
|
||||
# Returns the pulgin id used by the engine.
|
||||
def plugin_id
|
||||
name[/[\w_]+$/].downcase
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Convenience method for plugin loading.
|
||||
# The syntax used is:
|
||||
#
|
||||
# CodeRay.require_plugin '<Host ID>/<Plugin ID>'
|
||||
#
|
||||
# Returns the loaded plugin.
|
||||
def require_plugin path
|
||||
host_id, plugin_id = path.split '/', 2
|
||||
host = PluginHost.host_by_id(host_id)
|
||||
raise PluginHost::HostNotFound,
|
||||
"No host for #{host_id.inspect} found." unless host
|
||||
host.load plugin_id
|
||||
end
|
||||
|
||||
end
|
||||
123
vendor/plugins/coderay-0.7.6.227/lib/coderay/helpers/word_list.rb
vendored
Normal file
123
vendor/plugins/coderay-0.7.6.227/lib/coderay/helpers/word_list.rb
vendored
Normal file
@@ -0,0 +1,123 @@
|
||||
module CodeRay
|
||||
|
||||
# = WordList
|
||||
#
|
||||
# <b>A Hash subclass designed for mapping word lists to token types.</b>
|
||||
#
|
||||
# Copyright (c) 2006 by murphy (Kornelius Kalnbach) <murphy rubychan de>
|
||||
#
|
||||
# License:: LGPL / ask the author
|
||||
# Version:: 1.1 (2006-Oct-19)
|
||||
#
|
||||
# A WordList is a Hash with some additional features.
|
||||
# It is intended to be used for keyword recognition.
|
||||
#
|
||||
# WordList is highly optimized to be used in Scanners,
|
||||
# typically to decide whether a given ident is a special token.
|
||||
#
|
||||
# For case insensitive words use CaseIgnoringWordList.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# # define word arrays
|
||||
# RESERVED_WORDS = %w[
|
||||
# asm break case continue default do else
|
||||
# ...
|
||||
# ]
|
||||
#
|
||||
# PREDEFINED_TYPES = %w[
|
||||
# int long short char void
|
||||
# ...
|
||||
# ]
|
||||
#
|
||||
# PREDEFINED_CONSTANTS = %w[
|
||||
# EOF NULL ...
|
||||
# ]
|
||||
#
|
||||
# # make a WordList
|
||||
# IDENT_KIND = WordList.new(:ident).
|
||||
# add(RESERVED_WORDS, :reserved).
|
||||
# add(PREDEFINED_TYPES, :pre_type).
|
||||
# add(PREDEFINED_CONSTANTS, :pre_constant)
|
||||
#
|
||||
# ...
|
||||
#
|
||||
# def scan_tokens tokens, options
|
||||
# ...
|
||||
#
|
||||
# elsif scan(/[A-Za-z_][A-Za-z_0-9]*/)
|
||||
# # use it
|
||||
# kind = IDENT_KIND[match]
|
||||
# ...
|
||||
class WordList < Hash
|
||||
|
||||
# Creates a new WordList with +default+ as default value.
|
||||
#
|
||||
# You can activate +caching+ to store the results for every [] request.
|
||||
#
|
||||
# With caching, methods like +include?+ or +delete+ may no longer behave
|
||||
# as you expect. Therefore, it is recommended to use the [] method only.
|
||||
def initialize default = false, caching = false, &block
|
||||
if block
|
||||
raise ArgumentError, 'Can\'t combine block with caching.' if caching
|
||||
super(&block)
|
||||
else
|
||||
if caching
|
||||
super() do |h, k|
|
||||
h[k] = h.fetch k, default
|
||||
end
|
||||
else
|
||||
super default
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Add words to the list and associate them with +kind+.
|
||||
#
|
||||
# Returns +self+, so you can concat add calls.
|
||||
def add words, kind = true
|
||||
words.each do |word|
|
||||
self[word] = kind
|
||||
end
|
||||
self
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
|
||||
# A CaseIgnoringWordList is like a WordList, only that
|
||||
# keys are compared case-insensitively.
|
||||
#
|
||||
# Ignoring the text case is realized by sending the +downcase+ message to
|
||||
# all keys.
|
||||
#
|
||||
# Caching usually makes a CaseIgnoringWordList faster, but it has to be
|
||||
# activated explicitely.
|
||||
class CaseIgnoringWordList < WordList
|
||||
|
||||
# Creates a new case-insensitive WordList with +default+ as default value.
|
||||
#
|
||||
# You can activate caching to store the results for every [] request.
|
||||
def initialize default = false, caching = false
|
||||
if caching
|
||||
super(default, false) do |h, k|
|
||||
h[k] = h.fetch k.downcase, default
|
||||
end
|
||||
else
|
||||
def self.[] key # :nodoc:
|
||||
super(key.downcase)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Add +words+ to the list and associate them with +kind+.
|
||||
def add words, kind = true
|
||||
words.each do |word|
|
||||
self[word.downcase] = kind
|
||||
end
|
||||
self
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
end
|
||||
Reference in New Issue
Block a user