prawn-git 2.0.1

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

@@ -0,0 +1,264 @@
+# encoding: utf-8
+
+# text/formatted/fragment.rb : Implements information about a formatted fragment
+#
+# Copyright March 2010, Daniel Nelson. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  module Text
+    module Formatted
+
+
+      # Prawn::Text::Formatted::Fragment is a state store for a formatted text
+      # fragment. It does not render anything.
+      #
+      # @private
+      class Fragment
+
+        attr_reader :format_state, :text
+        attr_writer :width
+        attr_accessor :line_height, :descender, :ascender
+        attr_accessor :word_spacing, :left, :baseline
+
+        def initialize(text, format_state, document)
+          @format_state = format_state
+          @document = document
+          @word_spacing = 0
+
+          # keep the original value of "text", so we can reinitialize @text if formatting parameters
+          #   like text direction are changed
+          @original_text = text
+          @text = process_text(@original_text)
+        end
+
+        def width
+          if @word_spacing == 0 then @width
+          else @width + @word_spacing * space_count
+          end
+        end
+
+        def height
+          top - bottom
+        end
+
+        def subscript?
+          styles.include?(:subscript)
+        end
+
+        def superscript?
+          styles.include?(:superscript)
+        end
+
+        def y_offset
+          if subscript? then -descender
+          elsif superscript? then 0.85 * ascender
+          else 0
+          end
+        end
+
+        def bounding_box
+          [left, bottom, right, top]
+        end
+
+        def absolute_bounding_box
+          box = bounding_box
+          box[0] += @document.bounds.absolute_left
+          box[2] += @document.bounds.absolute_left
+          box[1] += @document.bounds.absolute_bottom
+          box[3] += @document.bounds.absolute_bottom
+          box
+        end
+
+        def underline_points
+          y = baseline - 1.25
+          [[left, y], [right, y]]
+        end
+
+        def strikethrough_points
+          y = baseline + ascender * 0.3
+          [[left, y], [right, y]]
+        end
+
+        def styles
+          @format_state[:styles] || []
+        end
+
+        def link
+          @format_state[:link]
+        end
+
+        def anchor
+          @format_state[:anchor]
+        end
+
+        def local
+          @format_state[:local]
+        end
+
+        def color
+          @format_state[:color]
+        end
+
+        def font
+          @format_state[:font]
+        end
+
+        def size
+          @format_state[:size]
+        end
+
+        def character_spacing
+          @format_state[:character_spacing] ||
+            @document.character_spacing
+        end
+
+        def direction
+          @format_state[:direction]
+        end
+
+        def default_direction=(direction)
+          unless @format_state[:direction]
+            @format_state[:direction] = direction
+            @text = process_text(@original_text)
+          end
+        end
+
+        def include_trailing_white_space!
+          @format_state.delete(:exclude_trailing_white_space)
+          @text = process_text(@original_text)
+        end
+
+        def space_count
+          @text.count(" ")
+        end
+
+        def callback_objects
+          callback = @format_state[:callback]
+          if callback.nil?
+            []
+          elsif callback.is_a?(Array)
+            callback
+          else
+            [callback]
+          end
+        end
+
+        def right
+          left + width
+        end
+
+        def top
+          baseline + ascender
+        end
+
+        def bottom
+          baseline - descender
+        end
+
+        def top_left
+          [left, top]
+        end
+
+        def top_right
+          [right, top]
+        end
+
+        def bottom_right
+          [right, bottom]
+        end
+
+        def bottom_left
+          [left, bottom]
+        end
+
+        def absolute_left
+          absolute_bounding_box[0]
+        end
+
+        def absolute_right
+          absolute_bounding_box[2]
+        end
+
+        def absolute_top
+          absolute_bounding_box[3]
+        end
+
+        def absolute_bottom
+          absolute_bounding_box[1]
+        end
+
+        def absolute_top_left
+          [absolute_left, absolute_top]
+        end
+
+        def absolute_top_right
+          [absolute_right, absolute_top]
+        end
+
+        def absolute_bottom_left
+          [absolute_left, absolute_bottom]
+        end
+
+        def absolute_bottom_right
+          [absolute_right, absolute_bottom]
+        end
+
+        private
+
+        def process_text(text)
+          string = strip_zero_width_spaces(text)
+
+          if exclude_trailing_white_space?
+            string = string.rstrip
+
+            if soft_hyphens_need_processing?(string)
+              string = process_soft_hyphens(string[0..-2]) + string[-1..-1]
+            end
+          else
+            if soft_hyphens_need_processing?(string)
+              string = process_soft_hyphens(string)
+            end
+          end
+
+          case direction
+          when :rtl
+            string.reverse
+          else
+            string
+          end
+        end
+
+        def exclude_trailing_white_space?
+          @format_state[:exclude_trailing_white_space]
+        end
+
+        def soft_hyphens_need_processing?(string)
+          string.length > 0 && normalized_soft_hyphen
+        end
+
+        def normalized_soft_hyphen
+          @format_state[:normalized_soft_hyphen]
+        end
+
+        def process_soft_hyphens(string)
+          if string.encoding != normalized_soft_hyphen.encoding
+            string.force_encoding(normalized_soft_hyphen.encoding)
+          end
+
+          string.gsub(normalized_soft_hyphen, "")
+        end
+
+        def strip_zero_width_spaces(string)
+          if string.encoding == ::Encoding::UTF_8
+            string.gsub(Prawn::Text::ZWSP, "")
+          else
+            string
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,277 @@
+# encoding: utf-8
+
+# core/text/formatted/line_wrap.rb : Implements individual line wrapping of
+#                                    formatted text
+#
+# Copyright February 2010, Daniel Nelson. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+
+module Prawn
+  module Text
+    module Formatted #:nodoc:
+
+      # @private
+      class LineWrap #:nodoc:
+
+        # The width of the last wrapped line
+        #
+        def width
+          @accumulated_width || 0
+        end
+
+        # The number of spaces in the last wrapped line
+        attr_reader :space_count
+
+        # Whether this line is the last line in the paragraph
+        def paragraph_finished?
+          @newline_encountered || is_next_string_newline? || @arranger.finished?
+        end
+
+        def tokenize(fragment)
+          fragment.scan(scan_pattern)
+        end
+
+        # Work in conjunction with the PDF::Formatted::Arranger
+        # defined in the :arranger option to determine what formatted text
+        # will fit within the width defined by the :width option
+        #
+        def wrap_line(options)
+          initialize_line(options)
+
+          while fragment = @arranger.next_string
+            @fragment_output = ""
+
+            fragment.lstrip! if first_fragment_on_this_line?(fragment)
+            next if empty_line?(fragment)
+
+            unless apply_font_settings_and_add_fragment_to_line(fragment)
+              break
+            end
+          end
+          @arranger.finalize_line
+          @accumulated_width = @arranger.line_width
+          @space_count = @arranger.space_count
+          @arranger.line
+        end
+
+        private
+
+        def first_fragment_on_this_line?(fragment)
+          line_empty? && fragment != "\n"
+        end
+
+        def empty_line?(fragment)
+          empty = line_empty? && fragment.empty? && is_next_string_newline?
+          @arranger.update_last_string("", "", soft_hyphen) if empty
+          empty
+        end
+
+        def is_next_string_newline?
+          @arranger.preview_next_string == "\n"
+        end
+
+        def apply_font_settings_and_add_fragment_to_line(fragment)
+          result = nil
+          @arranger.apply_font_settings do
+            # if font has changed from Unicode to non-Unicode, or vice versa, the characters used for soft hyphens
+            #   and zero-width spaces will be different
+            set_soft_hyphen_and_zero_width_space
+            result = add_fragment_to_line(fragment)
+          end
+          result
+        end
+
+        # returns true if all text was printed without running into the end of
+        # the line
+        #
+        def add_fragment_to_line(fragment)
+          if fragment == ""
+            true
+          elsif fragment == "\n"
+            @newline_encountered = true
+            false
+          else
+            tokenize(fragment).each do |segment|
+              if segment == zero_width_space
+                segment_width = 0
+              else
+                segment_width = @document.width_of(segment, :kerning => @kerning)
+              end
+
+              if @accumulated_width + segment_width <= @width
+                @accumulated_width += segment_width
+                if segment[-1] == soft_hyphen
+                  sh_width = @document.width_of("#{soft_hyphen}", :kerning => @kerning)
+                  @accumulated_width -= sh_width
+                end
+                @fragment_output += segment
+              else
+                end_of_the_line_reached(segment)
+                fragment_finished(fragment)
+                return false
+              end
+            end
+
+            fragment_finished(fragment)
+            true
+          end
+        end
+
+        # The pattern used to determine chunks of text to place on a given line
+        #
+        def scan_pattern
+          pattern = "[^#{break_chars}]+#{soft_hyphen}|" +
+            "[^#{break_chars}]+#{hyphen}+|" +
+            "[^#{break_chars}]+|" +
+            "[#{whitespace}]+|" +
+            "#{hyphen}+[^#{break_chars}]*|" +
+            "#{soft_hyphen}"
+
+          Regexp.new(pattern)
+        end
+
+        # The pattern used to determine whether any word breaks exist on a
+        # current line, which in turn determines whether character level
+        # word breaking is needed
+        #
+        def word_division_scan_pattern
+          Regexp.new("\\s|[#{zero_width_space}#{soft_hyphen}#{hyphen}]")
+        end
+
+        def break_chars
+          "#{whitespace}#{soft_hyphen}#{hyphen}"
+        end
+
+        def whitespace
+          " \\t#{zero_width_space}"
+        end
+
+        def hyphen
+          "-"
+        end
+
+        def soft_hyphen
+          @soft_hyphen
+        end
+
+        def zero_width_space
+          @zero_width_space
+        end
+
+        def line_empty?
+          @line_empty && @accumulated_width == 0
+        end
+
+        def initialize_line(options)
+          @document = options[:document]
+          @kerning = options[:kerning]
+          @width = options[:width]
+
+          @disable_wrap_by_char = options[:disable_wrap_by_char]
+
+          @accumulated_width = 0
+          @line_empty = true
+          @line_contains_more_than_one_word = false
+
+          @arranger = options[:arranger]
+          @arranger.initialize_line
+
+          @newline_encountered = false
+          @line_full = false
+        end
+
+        def set_soft_hyphen_and_zero_width_space
+          # this is done once per fragment, after the font settings for the fragment are applied --
+          #   it could actually be skipped if the font hasn't changed
+          font = @document.font
+          @soft_hyphen = font.normalize_encoding(Prawn::Text::SHY)
+          @zero_width_space = font.unicode? ? Prawn::Text::ZWSP : ""
+        end
+
+        def fragment_finished(fragment)
+          if fragment == "\n"
+            @newline_encountered = true
+            @line_empty = false
+          else
+            update_output_based_on_last_fragment(fragment, soft_hyphen)
+            update_line_status_based_on_last_output
+            determine_whether_to_pull_preceding_fragment_to_join_this_one(fragment)
+          end
+          remember_this_fragment_for_backward_looking_ops
+        end
+
+        def update_output_based_on_last_fragment(fragment, normalized_soft_hyphen=nil)
+          remaining_text = fragment.slice(@fragment_output.length..fragment.length)
+          raise Prawn::Errors::CannotFit if line_finished? && line_empty? &&
+            @fragment_output.empty? && !fragment.strip.empty?
+          @arranger.update_last_string(@fragment_output, remaining_text, normalized_soft_hyphen)
+        end
+
+        def determine_whether_to_pull_preceding_fragment_to_join_this_one(current_fragment)
+          if @fragment_output.empty? &&
+              !current_fragment.empty? &&
+              @line_contains_more_than_one_word
+            unless previous_fragment_ended_with_breakable? ||
+                fragment_begins_with_breakable?(current_fragment)
+              @fragment_output = @previous_fragment_output_without_last_word
+              update_output_based_on_last_fragment(@previous_fragment)
+            end
+          end
+        end
+
+        def remember_this_fragment_for_backward_looking_ops
+          @previous_fragment = @fragment_output.dup
+          pf = @previous_fragment
+          @previous_fragment_ended_with_breakable = pf =~ /[#{break_chars}]$/
+          last_word = pf.slice(/[^#{break_chars}]*$/)
+          last_word_length = last_word.nil? ? 0 : last_word.length
+          @previous_fragment_output_without_last_word = pf.slice(0, pf.length - last_word_length)
+        end
+
+        def previous_fragment_ended_with_breakable?
+          @previous_fragment_ended_with_breakable
+        end
+
+        def fragment_begins_with_breakable?(fragment)
+          fragment =~ /^[#{break_chars}]/
+        end
+
+        def line_finished?
+          @line_full || paragraph_finished?
+        end
+
+        def update_line_status_based_on_last_output
+          @line_contains_more_than_one_word = true if @fragment_output =~ word_division_scan_pattern
+        end
+
+        def end_of_the_line_reached(segment)
+          update_line_status_based_on_last_output
+          wrap_by_char(segment) unless @disable_wrap_by_char || @line_contains_more_than_one_word
+          @line_full = true
+        end
+
+        def wrap_by_char(segment)
+          font = @document.font
+          segment.each_char do |char|
+            break unless append_char(char,font)
+          end
+        end
+
+        def append_char(char,font)
+          # kerning doesn't make sense in the context of a single character
+          char_width = font.compute_width_of(char)
+
+          if @accumulated_width + char_width <= @width
+            @accumulated_width += char_width
+            @fragment_output << char
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end