prawn 0.15.0 → 1.0.0.rc1

data/lib/prawn/text.rb

@@ -5,18 +5,15 @@
 # Copyright May 2008, Gregory Brown. All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
-
+require "prawn/core/text"
+require "prawn/text/formatted"
+require "prawn/text/box"
 require "zlib"
 
-require "pdf/core/text"
-
-require_relative "text/formatted"
-require_relative "text/box"
-
 module Prawn
   module Text
 
-    include PDF::Core::Text
+    include Prawn::Core::Text
     include Prawn::Text::Formatted
 
     # No-Break Space
@@ -26,13 +23,11 @@ module Prawn
     # Soft Hyphen (invisible, except when causing a line break)
     Prawn::Text::SHY = "­"
 
-    # @group Stable API
-    
     # If you want text to flow onto a new page or between columns, this is the
     # method to use. If, instead, if you want to place bounded text outside of
     # the flow of a document (for captions, labels, charts, etc.), use Text::Box
     # or its convenience method text_box.
-    #
+    # 
     # Draws text on the page. Prawn attempts to wrap the text to fit within your
     # current bounding box (or margin_box if no bounding box is being used).
     # Text will flow onto the next page when it reaches the bottom of the
@@ -54,29 +49,28 @@ module Prawn
     # entire document, set default_kerning = false for that document
     #
     # === Text Positioning Details
-    #
+    # 
     # The text is positioned at font.ascender below the baseline,
     # making it easy to use this method within bounding boxes and spans.
     #
     # == Encoding
     #
     # Note that strings passed to this function should be encoded as UTF-8.
-    # If you get unexpected characters appearing in your rendered document,
+    # If you get unexpected characters appearing in your rendered document, 
     # check this.
     #
     # If the current font is a built-in one, although the string must be
     # encoded as UTF-8, only characters that are available in WinAnsi
     # are allowed.
     #
-    # If an empty box is rendered to your PDF instead of the character you
+    # If an empty box is rendered to your PDF instead of the character you 
     # wanted it usually means the current font doesn't include that character.
     #
     # == Options (default values marked in [])
     #
     # <tt>:inline_format</tt>::
     #      <tt>boolean</tt>. If true, then the string parameter is interpreted
-    #      as a HTML-esque string that recognizes the following tags
-    #      (assuming the default text formatter is used):
+    #      as a HTML-esque string that recognizes the following tags:
     #      <tt>\<b></b></tt>:: bold
     #      <tt>\<i></i></tt>:: italic
     #      <tt>\<u></u></tt>:: underline
@@ -103,8 +97,8 @@ module Prawn
     #            <tt>anchor="ToC"</tt>::
     #                where the value of the anchor attribute is the name of a
     #                destination that has already been or will be registered
-    #                using PDF::Core::Destinations#add_dest. A clickable link
-    #                will be created to that destination.
+    #                using Prawn::Core::Destinations#add_dest. A clickable link
+    #                will be created to that destination. 
     #          Note that you must explicitly underline and color using the
     #          appropriate tags if you which to draw attention to the link
     #
@@ -149,7 +143,7 @@ module Prawn
     #                  text should render with the fill color, stroke color or
     #                  both. See the comments to text_rendering_mode() to see
     #                  a list of valid options. [0]
-    #
+    #                        
     # == Exceptions
     #
     # Raises <tt>ArgumentError</tt> if <tt>:at</tt> option included
@@ -158,14 +152,12 @@ module Prawn
     # any text
     #
     def text(string, options={})
-      return false if string.nil?
       # we modify the options. don't change the user's hash
       options = options.dup
 
-      if p = options[:inline_format]
-        p = [] unless p.is_a?(Array)
+      if options[:inline_format]
         options.delete(:inline_format)
-        array = self.text_formatter.format(string, *p)
+        array = Text::Formatted::Parser.to_array(string)
       else
         array = [{ :text => string }]
       end
@@ -173,6 +165,7 @@ module Prawn
       formatted_text(array, options)
     end
 
+
     # Draws formatted text to the page.
     # Formatted text is comprised of an array of hashes, where each hash defines
     # text and format information. See Text::Formatted#formatted_text_box for
@@ -183,7 +176,7 @@ module Prawn
     #   text([{ :text => "hello" },
     #         { :text => "world",
     #           :size => 24,
-    #           :styles => [:bold, :italic] }])
+    #           :style => [:bold, :italic] }])
     #
     # == Options
     #
@@ -197,13 +190,13 @@ module Prawn
       options = inspect_options_for_text(options.dup)
 
       if color = options.delete(:color)
-        array = array.map do |fragment|
+        array = array.map do |fragment| 
           fragment[:color] ? fragment : fragment.merge(:color => color)
         end
       end
 
       if @indent_paragraphs
-        self.text_formatter.array_paragraphs(array).each do |paragraph|
+        Text::Formatted::Parser.array_paragraphs(array).each do |paragraph|
           options[:skip_encoding] = false
           remaining_text = draw_indented_formatted_line(paragraph, options)
           options[:skip_encoding] = true
@@ -230,7 +223,7 @@ module Prawn
 
     # Draws text on the page, beginning at the point specified by the :at option
     # the string is assumed to be pre-formatted to properly fit the page.
-    #
+    # 
     #   pdf.draw_text "Hello World", :at => [100,100]
     #   pdf.draw_text "Goodbye World", :at => [50,50], :size => 16
     #
@@ -252,14 +245,14 @@ module Prawn
     # == Encoding
     #
     # Note that strings passed to this function should be encoded as UTF-8.
-    # If you get unexpected characters appearing in your rendered document,
+    # If you get unexpected characters appearing in your rendered document, 
     # check this.
     #
     # If the current font is a built-in one, although the string must be
     # encoded as UTF-8, only characters that are available in WinAnsi
     # are allowed.
     #
-    # If an empty box is rendered to your PDF instead of the character you
+    # If an empty box is rendered to your PDF instead of the character you 
     # wanted it usually means the current font doesn't include that character.
     #
     # == Options (default values marked in [])
@@ -288,7 +281,7 @@ module Prawn
       text = text.to_s.dup
       save_font do
         process_text_options(options)
-        font.normalize_encoding!(text)
+        font.normalize_encoding!(text) unless @skip_encoding
         font_size(options[:size]) { draw_text!(text, options) }
       end
     end
@@ -321,7 +314,7 @@ module Prawn
     #   height_of_formatted([{ :text => "hello" },
     #                        { :text => "world",
     #                          :size => 24,
-    #                          :styles => [:bold, :italic] }])
+    #                          :style => [:bold, :italic] }])
     #
     def height_of_formatted(array, options={})
       if options[:indent_paragraphs]
@@ -332,7 +325,7 @@ module Prawn
       box = Text::Formatted::Box.new(array,
                           options.merge(:height   => 100000000,
                                         :document => self))
-      box.render(:dry_run => true)
+      printed = box.render(:dry_run => true)
 
       height = box.height
       height += box.line_gap + box.leading if @final_gap
@@ -388,7 +381,7 @@ module Prawn
       if options[:kerning].nil? then
         options[:kerning] = default_kerning?
       end
-      valid_options = PDF::Core::Text::VALID_OPTIONS + [:at, :rotate]
+      valid_options = Prawn::Core::Text::VALID_OPTIONS + [:at, :rotate]
       Prawn.verify_options(valid_options, options)
       options
     end

data/lib/prawn/text/box.rb

@@ -7,11 +7,8 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
 
-require_relative "formatted/box"
-
 module Prawn
   module Text
-    # @group Stable API
 
     # Draws the requested text into a box. When the text overflows
     # the rectangle, you shrink to fit, or truncate the text. Text
@@ -20,14 +17,14 @@ module Prawn
     # == Encoding
     #
     # Note that strings passed to this function should be encoded as UTF-8.
-    # If you get unexpected characters appearing in your rendered document,
+    # If you get unexpected characters appearing in your rendered document, 
     # check this.
     #
     # If the current font is a built-in one, although the string must be
     # encoded as UTF-8, only characters that are available in WinAnsi
     # are allowed.
     #
-    # If an empty box is rendered to your PDF instead of the character you
+    # If an empty box is rendered to your PDF instead of the character you 
     # wanted it usually means the current font doesn't include that character.
     #
     # == Options (default values marked in [])
@@ -70,7 +67,7 @@ module Prawn
     # <tt>:valign</tt>::
     #     <tt>:top</tt>, <tt>:center</tt>, or <tt>:bottom</tt>. Vertical
     #     alignment within the bounding box [:top]
-    #
+    #                   
     # <tt>:rotate</tt>::
     #     <tt>number</tt>. The angle to rotate the text
     # <tt>:rotate_around</tt>::
@@ -111,9 +108,8 @@ module Prawn
       options = options.dup
       options[:document] = self
 
-      box = if p = options.delete(:inline_format)
-              p = [] unless p.is_a?(Array)
-              array = self.text_formatter.format(string, *p)
+      box = if options.delete(:inline_format)
+              array = Text::Formatted::Parser.to_array(string)
               Text::Formatted::Box.new(array, options)
             else
               Text::Box.new(string, options)
@@ -122,10 +118,8 @@ module Prawn
       box.render
     end
 
-    # @group Experimental API
-
     # Generally, one would use the Prawn::Text#text_box convenience
-    # method. However, using Text::Box.new in conjunction with
+    # method. However, using Text::Box.new in conjunction with 
     # #render(:dry_run=> true) enables one to do look-ahead calculations prior
     # to placing text on the page, or to determine how much vertical space was
     # consumed by the printed text

data/lib/prawn/text/formatted.rb

@@ -1,5 +1,4 @@
-require_relative "formatted/wrap"
-
-require_relative "formatted/box"
-require_relative "formatted/parser"
-require_relative "formatted/fragment"
+require "prawn/core/text/formatted/wrap"
+require "prawn/text/formatted/box"
+require "prawn/text/formatted/parser"
+require "prawn/text/formatted/fragment"

data/lib/prawn/text/formatted/box.rb

@@ -10,8 +10,7 @@
 module Prawn
   module Text
     module Formatted
-      # @group Stable API
-      
+
       # Draws the requested formatted text into a box. When the text overflows
       # the rectangle shrink to fit or truncate the text. Text boxes are
       # independent of the document y position.
@@ -46,19 +45,10 @@ module Prawn
       #     the appropriate tags if you which to draw attention to the link
       # <tt>:anchor</tt>::
       #     a destination that has already been or will be registered using
-      #     PDF::Core::Destinations#add_dest. A clickable link will be
+      #     Prawn::Core::Destinations#add_dest. A clickable link will be
       #     created to that destination. Note that you must explicitly underline
       #     and color using the appropriate tags if you which to draw attention
       #     to the link
-      # <tt>:local</tt>::
-      #     a file or application to be opened locally. A clickable link will be
-      #     created to the provided local file or application. If the file is
-      #     another PDF, it will be opened in a new window. Note that you must
-      #     explicitly underline and color using the appropriate tags if you which
-      #     to draw attention to the link
-      # <tt>:draw_text_callback</tt>:
-      #     if provided, this Proc will be called instead of #draw_text! once
-      #     per fragment for every low-level addition of text to the page.
       # <tt>:callback</tt>::
       #     an object (or array of such objects) with two methods:
       #     #render_behind and #render_in_front, which are called immediately
@@ -99,9 +89,20 @@ module Prawn
       # vertical space was consumed by the printed text
       #
       class Box
-        include Prawn::Text::Formatted::Wrap
+        include Prawn::Core::Text::Formatted::Wrap
 
-        # @group Experimental API
+        def valid_options
+          Prawn::Core::Text::VALID_OPTIONS + [:at, :height, :width,
+                                              :align, :valign,
+                                              :rotate, :rotate_around,
+                                              :overflow, :min_font_size,
+                                              :leading, :character_spacing,
+                                              :mode, :single_line,
+                                              :skip_encoding,
+                                              :document,
+                                              :direction,
+                                              :fallback_fonts]
+        end
 
         # The text that was successfully printed (or, if <tt>dry_run</tt> was
         # used, the text that would have been successfully printed)
@@ -134,6 +135,42 @@ module Prawn
           line_height - (ascender + descender)
         end
 
+        #
+        # Example (see Prawn::Text::Core::Formatted::Wrap for what is required
+        # of the wrap method if you want to override the default wrapping
+        # algorithm):
+        # 
+        #
+        #   module MyWrap
+        #
+        #     def wrap(array)
+        #       initialize_wrap([{ :text => 'all your base are belong to us' }])
+        #       @line_wrap.wrap_line(:document => @document,
+        #                            :kerning => @kerning,
+        #                            :width => 10000,
+        #                            :arranger => @arranger)
+        #       fragment = @arranger.retrieve_fragment
+        #       format_and_draw_fragment(fragment, 0, @line_wrap.width, 0)
+        #       []
+        #     end
+        #
+        #   end
+        #
+        #   Prawn::Text::Formatted::Box.extensions << MyWrap
+        #
+        #   box = Prawn::Text::Formatted::Box.new('hello world')
+        #   box.render('why can't I print anything other than' +
+        #              '"all your base are belong to us"?')
+        #
+        #
+        def self.extensions
+          @extensions ||= []
+        end
+
+        def self.inherited(base) #:nodoc:
+          extensions.each { |e| base.extensions << e }
+        end
+
         # See Prawn::Text#text_box for valid options
         #
         def initialize(formatted_text, options={})
@@ -168,12 +205,6 @@ module Prawn
           @rotate_around     = options[:rotate_around] || :upper_left
           @single_line       = options[:single_line]
           @skip_encoding     = options[:skip_encoding] || @document.skip_encoding
-          @draw_text_callback = options[:draw_text_callback]
-
-          # if the text rendering mode is :unknown, force it back to :fill
-          if @mode == :unknown
-            @mode = :fill
-          end
 
           if @overflow == :expand
             # if set to expand, then we simply set the bottom
@@ -242,7 +273,7 @@ module Prawn
         end
 
         # The height actually used during the previous <tt>render</tt>
-        #
+        # 
         def height
           return 0 if @baseline_y.nil? || @descender.nil?
           (@baseline_y - @descender).abs
@@ -279,71 +310,14 @@ module Prawn
             draw_fragment_underlays(fragment)
 
             @document.word_spacing(word_spacing) {
-              if @draw_text_callback
-                @draw_text_callback.call(fragment.text, :at => [x, y],
-                                         :kerning => @kerning)
-              else
-                @document.draw_text!(fragment.text, :at => [x, y],
-                                     :kerning => @kerning)
-              end
+              @document.draw_text!(fragment.text, :at => [x, y],
+                                   :kerning => @kerning)
             }
 
             draw_fragment_overlays(fragment)
           end
         end
 
-        # @group Extension API
-        
-        # Example (see Prawn::Text::Core::Formatted::Wrap for what is required
-        # of the wrap method if you want to override the default wrapping
-        # algorithm):
-        #
-        #
-        #   module MyWrap
-        #
-        #     def wrap(array)
-        #       initialize_wrap([{ :text => 'all your base are belong to us' }])
-        #       @line_wrap.wrap_line(:document => @document,
-        #                            :kerning => @kerning,
-        #                            :width => 10000,
-        #                            :arranger => @arranger)
-        #       fragment = @arranger.retrieve_fragment
-        #       format_and_draw_fragment(fragment, 0, @line_wrap.width, 0)
-        #       []
-        #     end
-        #
-        #   end
-        #
-        #   Prawn::Text::Formatted::Box.extensions << MyWrap
-        #
-        #   box = Prawn::Text::Formatted::Box.new('hello world')
-        #   box.render('why can't I print anything other than' +
-        #              '"all your base are belong to us"?')
-        #
-        #
-        def self.extensions
-          @extensions ||= []
-        end
-
-        # @private
-        def self.inherited(base)
-          extensions.each { |e| base.extensions << e }
-        end
-
-        def valid_options
-          PDF::Core::Text::VALID_OPTIONS + [:at, :height, :width,
-                                              :align, :valign,
-                                              :rotate, :rotate_around,
-                                              :overflow, :min_font_size,
-                                              :leading, :character_spacing,
-                                              :mode, :single_line,
-                                              :skip_encoding,
-                                              :document,
-                                              :direction,
-                                              :fallback_fonts,
-                                              :draw_text_callback]
-        end
-
         private
 
         def original_text
@@ -397,7 +371,8 @@ module Prawn
           # all fonts
           fallback_fonts << fragment_font
 
-          hash[:text].each_char do |char|
+          hash[:text].unpack("U*").each do |char_int|
+            char = [char_int].pack("U")
             @document.font(fragment_font)
             font_glyph_pairs << [find_font_for_this_glyph(char,
                                                           @document.font.family,
@@ -466,7 +441,7 @@ module Prawn
           # we need to wait until render() is called so that the fonts are set
           # up properly for wrapping. So guard with a boolean to ensure this is
           # only run once.
-          return if defined?(@vertical_alignment_processed) && @vertical_alignment_processed
+          return if @vertical_alignment_processed
           @vertical_alignment_processed = true
 
           return if @vertical_align == :top
@@ -537,7 +512,6 @@ module Prawn
           draw_fragment_overlay_styles(fragment)
           draw_fragment_overlay_link(fragment)
           draw_fragment_overlay_anchor(fragment)
-          draw_fragment_overlay_local(fragment)
           fragment.callback_objects.each do |obj|
             obj.render_in_front(fragment) if obj.respond_to?(:render_in_front)
           end
@@ -550,7 +524,7 @@ module Prawn
                                     :Border => [0, 0, 0],
                                     :A => { :Type => :Action,
                                             :S => :URI,
-                                            :URI => PDF::Core::LiteralString.new(fragment.link) })
+                                            :URI => Prawn::Core::LiteralString.new(fragment.link) })
         end
 
         def draw_fragment_overlay_anchor(fragment)
@@ -561,23 +535,12 @@ module Prawn
                                     :Dest => fragment.anchor)
         end
 
-        def draw_fragment_overlay_local(fragment)
-          return unless fragment.local
-          box = fragment.absolute_bounding_box
-          @document.link_annotation(box,
-                                    :Border => [0, 0, 0],
-                                    :A => { :Type => :Action,
-                                            :S => :Launch,
-                                            :F => PDF::Core::LiteralString.new(fragment.local),
-                                            :NewWindow => true })
-        end
-
         def draw_fragment_overlay_styles(fragment)
           underline = fragment.styles.include?(:underline)
           if underline
             @document.stroke_line(fragment.underline_points)
           end
-
+          
           strikethrough = fragment.styles.include?(:strikethrough)
           if strikethrough
             @document.stroke_line(fragment.strikethrough_points)