coderay 0.7.1.147 → 0.7.2.165

data/lib/coderay/encoders/debug.rb

@@ -1,46 +1,46 @@
-module CodeRay
-module Encoders
-
-	# = Debug Encoder
-	#
-	# Fast encoder producing simple debug output.
-	#
-	# It is readable and diff-able and is used for testing.
-	#
-	# You cannot fully restore the tokens information from the
-	# output, because consecutive :space tokens are merged.
-	# Use Tokens#dump for caching purposes.
-	class Debug < Encoder
-
-		include Streamable
-		register_for :debug
-
-		FILE_EXTENSION = 'raydebug'
-
-	protected
-		def text_token text, kind
-			@out <<
-				if kind == :space
-					text
-				else
-					text = text.gsub(/[)\\]/, '\\\\\0')
-					"#{kind}(#{text})"
-				end					
-		end
-
-		def block_token action, kind
-			@out << super
-		end
-
-		def open_token kind
-			"#{kind}<"
-		end
-
-		def close_token kind
-			">"
-		end
-
-	end
-
-end
-end
+module CodeRay
+module Encoders
+
+  # = Debug Encoder
+  #
+  # Fast encoder producing simple debug output.
+  #
+  # It is readable and diff-able and is used for testing.
+  #
+  # You cannot fully restore the tokens information from the
+  # output, because consecutive :space tokens are merged.
+  # Use Tokens#dump for caching purposes.
+  class Debug < Encoder
+
+    include Streamable
+    register_for :debug
+
+    FILE_EXTENSION = 'raydebug'
+
+  protected
+    def text_token text, kind
+      @out <<
+        if kind == :space
+          text
+        else
+          text = text.gsub(/[)\\]/, '\\\\\0')
+          "#{kind}(#{text})"
+        end
+    end
+
+    def block_token action, kind
+      @out << super
+    end
+
+    def open_token kind
+      "#{kind}<"
+    end
+
+    def close_token kind
+      ">"
+    end
+
+  end
+
+end
+end

data/lib/coderay/encoders/div.rb

@@ -1,20 +1,20 @@
-module CodeRay
-module Encoders
-	
-	load :html
-
-	class Div < HTML
-
-		FILE_EXTENSION = 'div.html'
-
-		register_for :div
-
-		DEFAULT_OPTIONS = HTML::DEFAULT_OPTIONS.merge({
-			:css => :style,
-			:wrap => :div,
-		})
-
-	end
-
-end
-end
+module CodeRay
+module Encoders
+
+  load :html
+
+  class Div < HTML
+
+    FILE_EXTENSION = 'div.html'
+
+    register_for :div
+
+    DEFAULT_OPTIONS = HTML::DEFAULT_OPTIONS.merge({
+      :css => :style,
+      :wrap => :div,
+    })
+
+  end
+
+end
+end

data/lib/coderay/encoders/html.rb

@@ -1,245 +1,249 @@
-module CodeRay
-module Encoders
-
-	# = HTML Encoder
-	#
-	# This is CodeRay's most important highlighter:
-	# It provides save, fast XHTML generation and CSS support.
-	#
-	# == Usage
-	#
-	#  require 'coderay'
-	#  puts CodeRay.scan('Some /code/', :ruby).html  #-> a HTML page
-	#  puts CodeRay.scan('Some /code/', :ruby).html(:wrap => :span) #-> <span class="CodeRay"><span class="co">Some</span> /code/</span>
-	#  puts CodeRay.scan('Some /code/', :ruby).span  #-> the same
-	#  
-	#  puts CodeRay.scan('Some code', :ruby).html(
-	#    :wrap => nil,
-	#    :line_numbers => :inline,
-	#    :css => :style
-	#  )
-	#  #-> <span class="no">1</span>  <span style="color:#036; font-weight:bold;">Some</span> code
-	#
-	# == Options
-	#
-	# === :tab_width
-	# Convert \t characters to +n+ spaces (a number.)
-	# Default: 8
-	#
-	# === :css
-	# How to include the styles; can be :class or :style.
-	# 
-	# Default: :class
-	#
-	# === :wrap
-	# Wrap in :page, :div, :span or nil.
-	# 
-	# You can also use Encoders::Div and Encoders::Span.
-	# 
-	# Default: nil
-	# 
-	# === :line_numbers
-	# Include line numbers in :table, :inline, :list or nil (no line numbers)
-	# 
-	# Default: nil
-	# 
-	# === :line_number_start
-	# Where to start with line number counting.
-	# 
-	# Default: 1
-	# 
-	# === :bold_every
-	# Make every +n+-th number appear bold.
-	# 
-	# Default: 10
-	# 
-	# === :hint
-	# Include some information into the output using the title attribute.
-	# Can be :info (show token type on mouse-over), :info_long (with full path) or :debug (via inspect).
-	# 
-	# Default: false
-	class HTML < Encoder
-
-		include Streamable
-		register_for :html
-
-		FILE_EXTENSION = 'html'
-
-		DEFAULT_OPTIONS = {
-			:tab_width => 8,
-
-			:level => :xhtml,
-			:css => :class,
-
-			:style => :cycnus,
-			
-			:wrap => nil,
-
-			:line_numbers => nil,
-			:line_number_start => 1,
-			:bold_every => 10,
-
-			:hint => false,
-		}
-		
-		helper :classes, :output, :css
-
-		attr_reader :css
-
-	protected
-		
-		HTML_ESCAPE = {  #:nodoc:
-			'&' => '&amp;',
-			'"' => '&quot;',
-			'>' => '&gt;',
-			'<' => '&lt;',
-		}
-
-		# This was to prevent illegal HTML.
-		# Strange chars should still be avoided in codes.
-		evil_chars = Array(0x00...0x20) - [?\n, ?\t, ?\s]
-		evil_chars.each { |i| HTML_ESCAPE[i.chr] = ' ' }
-		#ansi_chars = Array(0x7f..0xff)
-		#ansi_chars.each { |i| HTML_ESCAPE[i.chr] = '&#%d;' % i }
-		# \x9 (\t) and \xA (\n) not included
-		#HTML_ESCAPE_PATTERN = /[\t&"><\0-\x8\xB-\x1f\x7f-\xff]/
-		HTML_ESCAPE_PATTERN = /[\t"&><\0-\x8\xB-\x1f]/
-
-		TOKEN_KIND_TO_INFO = Hash.new { |h, kind|
-			h[kind] =
-				case kind
-				when :pre_constant
-					'Predefined constant'
-				else
-					kind.to_s.gsub(/_/, ' ').gsub(/\b\w/) { $&.capitalize }
-				end
-		}
-
-		# Generate a hint about the given +classes+ in a +hint+ style.
-		# 
-		# +hint+ may be :info, :info_long or :debug.
-		def self.token_path_to_hint hint, classes
-			return '' unless hint
-			title =
-				case hint
-				when :info
-					TOKEN_KIND_TO_INFO[classes.first]
-				when :info_long
-					classes.reverse.map { |kind| TOKEN_KIND_TO_INFO[kind] }.join('/')
-				when :debug
-					classes.inspect
-				end
-			" title=\"#{title}\""
-		end
-
-		def setup options
-			super
-
-			@HTML_ESCAPE = HTML_ESCAPE.dup
-			@HTML_ESCAPE["\t"] = ' ' * options[:tab_width]
-			
-			@opened = [nil]
-			@css = CSS.new options[:style]
-
-			hint = options[:hint]
-			if hint and not [:debug, :info, :info_long].include? hint
-				raise ArgumentError, "Unknown value %p for :hint; expected :info, :debug, false or nil." % hint
-			end
-
-			case options[:css]
-			
-			when :class
-				@css_style = Hash.new do |h, k|
-					if k.is_a? Array
-						type = k.first
-					else
-						type = k
-					end
-					c = ClassOfKind[type]
-					if c == :NO_HIGHLIGHT and not hint
-						h[k] = false
-					else
-						title = HTML.token_path_to_hint hint, (k[1..-1] << k.first)
-						h[k] = '<span%s class="%s">' % [title, c]
-					end
-				end
-				
-			when :style
-				@css_style = Hash.new do |h, k|
-					if k.is_a? Array
-						styles = k.dup
-					else
-						styles = [k]
-					end
-					type = styles.first
-					classes = styles.map { |c| ClassOfKind[c] }
-					if classes.first == :NO_HIGHLIGHT and not hint
-						h[k] = false
-					else
-						styles.shift if [:delimiter, :modifier, :content, :escape].include? styles.first
-						title = HTML.token_path_to_hint hint, styles
-						classes.delete 'il'
-						style = @css[*classes]
-						h[k] =
-							if style
-								'<span%s style="%s">' % [title, style]
-							else
-								false
-							end
-					end
-				end
-				
-			else
-				raise ArgumentError, "Unknown value %p for :css." % options[:css]
-				
-			end
-		end
-
-		def finish options
-			not_needed = @opened.shift
-			@out << '</span>' * @opened.size
-			warn '%d tokens still open' % @opened.size unless @opened.empty?
-
-			@out.extend Output
-			@out.css = @css
-			@out.numerize! options[:line_numbers], options
-			@out.wrap! options[:wrap]
-
-			super
-		end
-
-		def token text, type
-			if text.is_a? ::String
-				if text =~ /#{HTML_ESCAPE_PATTERN}/o
-					text = text.gsub(/#{HTML_ESCAPE_PATTERN}/o) { |m| @HTML_ESCAPE[m] }
-				end
-				@opened[0] = type
-				if style = @css_style[@opened]
-					@out << style << text << '</span>'
-				else
-					@out << text
-				end
-			else
-				case text
-				when :open
-					@opened[0] = type
-					@out << (@css_style[@opened] || '<span>')
-					@opened << type
-				when :close
-					unless @opened.empty?
-						raise 'Malformed token stream: Trying to close a token that was never opened.' unless @opened.size > 1
-						@out << '</span>'
-						@opened.pop
-					end
-				when nil
-					raise 'Token with nil as text was given: %p' % [[text, type]]
-				else
-					raise 'unknown token kind: %p' % text
-				end
-			end
-		end
-		
-	end
-
-end
-end
+module CodeRay
+module Encoders
+
+  # = HTML Encoder
+  #
+  # This is CodeRay's most important highlighter:
+  # It provides save, fast XHTML generation and CSS support.
+  #
+  # == Usage
+  #
+  #  require 'coderay'
+  #  puts CodeRay.scan('Some /code/', :ruby).html  #-> a HTML page
+  #  puts CodeRay.scan('Some /code/', :ruby).html(:wrap => :span) #-> <span class="CodeRay"><span class="co">Some</span> /code/</span>
+  #  puts CodeRay.scan('Some /code/', :ruby).span  #-> the same
+  #  
+  #  puts CodeRay.scan('Some code', :ruby).html(
+  #    :wrap => nil,
+  #    :line_numbers => :inline,
+  #    :css => :style
+  #  )
+  #  #-> <span class="no">1</span>  <span style="color:#036; font-weight:bold;">Some</span> code
+  #
+  # == Options
+  #
+  # === :tab_width
+  # Convert \t characters to +n+ spaces (a number.)
+  # Default: 8
+  #
+  # === :css
+  # How to include the styles; can be :class or :style.
+  #
+  # Default: :class
+  #
+  # === :wrap
+  # Wrap in :page, :div, :span or nil.
+  #
+  # You can also use Encoders::Div and Encoders::Span.
+  #
+  # Default: nil
+  #
+  # === :line_numbers
+  # Include line numbers in :table, :inline, :list or nil (no line numbers)
+  #
+  # Default: nil
+  #
+  # === :line_number_start
+  # Where to start with line number counting.
+  #
+  # Default: 1
+  #
+  # === :bold_every
+  # Make every +n+-th number appear bold.
+  #
+  # Default: 10
+  #
+  # === :hint
+  # Include some information into the output using the title attribute.
+  # Can be :info (show token type on mouse-over), :info_long (with full path) or :debug (via inspect).
+  #
+  # Default: false
+  class HTML < Encoder
+
+    include Streamable
+    register_for :html
+
+    FILE_EXTENSION = 'html'
+
+    DEFAULT_OPTIONS = {
+      :tab_width => 8,
+
+      :level => :xhtml,
+      :css => :class,
+
+      :style => :cycnus,
+
+      :wrap => nil,
+
+      :line_numbers => nil,
+      :line_number_start => 1,
+      :bold_every => 10,
+
+      :hint => false,
+    }
+
+    helper :classes, :output, :css
+
+    attr_reader :css
+
+  protected
+
+    HTML_ESCAPE = {  #:nodoc:
+      '&' => '&amp;',
+      '"' => '&quot;',
+      '>' => '&gt;',
+      '<' => '&lt;',
+    }
+
+    # This was to prevent illegal HTML.
+    # Strange chars should still be avoided in codes.
+    evil_chars = Array(0x00...0x20) - [?\n, ?\t, ?\s]
+    evil_chars.each { |i| HTML_ESCAPE[i.chr] = ' ' }
+    #ansi_chars = Array(0x7f..0xff)
+    #ansi_chars.each { |i| HTML_ESCAPE[i.chr] = '&#%d;' % i }
+    # \x9 (\t) and \xA (\n) not included
+    #HTML_ESCAPE_PATTERN = /[\t&"><\0-\x8\xB-\x1f\x7f-\xff]/
+    HTML_ESCAPE_PATTERN = /[\t"&><\0-\x8\xB-\x1f]/
+
+    TOKEN_KIND_TO_INFO = Hash.new { |h, kind|
+      h[kind] =
+        case kind
+        when :pre_constant
+          'Predefined constant'
+        else
+          kind.to_s.gsub(/_/, ' ').gsub(/\b\w/) { $&.capitalize }
+        end
+    }
+
+    # Generate a hint about the given +classes+ in a +hint+ style.
+    #
+    # +hint+ may be :info, :info_long or :debug.
+    def self.token_path_to_hint hint, classes
+      return '' unless hint
+      title =
+        case hint
+        when :info
+          TOKEN_KIND_TO_INFO[classes.first]
+        when :info_long
+          classes.reverse.map { |kind| TOKEN_KIND_TO_INFO[kind] }.join('/')
+        when :debug
+          classes.inspect
+        end
+      " title=\"#{title}\""
+    end
+
+    def setup options
+      super
+
+      @HTML_ESCAPE = HTML_ESCAPE.dup
+      @HTML_ESCAPE["\t"] = ' ' * options[:tab_width]
+
+      @opened = [nil]
+      @css = CSS.new options[:style]
+
+      hint = options[:hint]
+      if hint and not [:debug, :info, :info_long].include? hint
+        raise ArgumentError, "Unknown value %p for :hint; expected :info, :debug, false or nil." % hint
+      end
+
+      case options[:css]
+
+      when :class
+        @css_style = Hash.new do |h, k|
+          if k.is_a? Array
+            type = k.first
+          else
+            type = k
+          end
+          c = ClassOfKind[type]
+          if c == :NO_HIGHLIGHT and not hint
+            h[k] = false
+          else
+            title = HTML.token_path_to_hint hint, (k[1..-1] << k.first)
+            h[k] = '<span%s class="%s">' % [title, c]
+          end
+        end
+
+      when :style
+        @css_style = Hash.new do |h, k|
+          if k.is_a? Array
+            styles = k.dup
+          else
+            styles = [k]
+          end
+          type = styles.first
+          classes = styles.map { |c| ClassOfKind[c] }
+          if classes.first == :NO_HIGHLIGHT and not hint
+            h[k] = false
+          else
+            styles.shift if [:delimiter, :modifier, :content, :escape].include? styles.first
+            title = HTML.token_path_to_hint hint, styles
+            classes.delete 'il'
+            style = @css[*classes]
+            h[k] =
+              if style
+                '<span%s style="%s">' % [title, style]
+              else
+                false
+              end
+          end
+        end
+
+      else
+        raise ArgumentError, "Unknown value %p for :css." % options[:css]
+
+      end
+    end
+
+    def finish options
+      not_needed = @opened.shift
+      @out << '</span>' * @opened.size
+      warn '%d tokens still open: %p' % [@opened.size, @opened] unless @opened.empty?
+
+      @out.extend Output
+      @out.css = @css
+      @out.numerize! options[:line_numbers], options
+      @out.wrap! options[:wrap]
+
+      super
+    end
+
+    def token text, type
+      if text.is_a? ::String
+        if text =~ /#{HTML_ESCAPE_PATTERN}/o
+          text = text.gsub(/#{HTML_ESCAPE_PATTERN}/o) { |m| @HTML_ESCAPE[m] }
+        end
+        @opened[0] = type
+        if style = @css_style[@opened]
+          @out << style << text << '</span>'
+        else
+          @out << text
+        end
+      else
+        case text
+        when :open
+          @opened[0] = type
+          @out << (@css_style[@opened] || '<span>')
+          @opened << type
+        when :close
+          if @opened.empty?
+            # nothing to close
+          else
+            if @opened.size == 1 or @opened.last != type
+              raise 'Malformed token stream: Trying to close a token (%p) that is not open. Open are: %p.' % [type, @opened[1..-1]] if $DEBUG
+            end
+            @out << '</span>'
+            @opened.pop
+          end
+        when nil
+          raise 'Token with nil as text was given: %p' % [[text, type]]
+        else
+          raise 'unknown token kind: %p' % text
+        end
+      end
+    end
+
+  end
+
+end
+end