nurettin-prawn 1.0.0.rc1

data/lib/prawn/document/snapshot.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+# snapshot.rb : Implements transactional rendering for Prawn
+#
+# Copyright August 2009, Brad Ediger.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'delegate'
+
+module Prawn
+  class Document
+    module Snapshot
+
+      RollbackTransaction = Class.new(StandardError)
+
+      # Call this within a +transaction+ block to roll back the transaction and
+      # prevent any of its data from being rendered. You must reset the
+      # y-position yourself if you have performed any drawing operations that
+      # modify it.
+      #
+      def rollback
+        raise RollbackTransaction
+      end
+
+      # Run a block of drawing operations, to be completed atomically. If
+      # +rollback+ is called or a RollbackTransaction exception is raised
+      # inside the block, all actions taken inside the block will be rolled
+      # back (with the exception of y-position, which you must restore
+      # yourself). 
+      #
+      # Returns true on success, or false if the transaction was rolled back.
+      #
+      def transaction
+        snap = take_snapshot
+        yield
+        true
+      rescue RollbackTransaction
+        restore_snapshot(snap)
+        false
+      end
+
+      private
+      
+      # Takes a current snapshot of the document's state, sufficient to
+      # reconstruct it after it was amended.
+      #
+      def take_snapshot
+        # current_page holds a ref to the Pages dictionary which grows
+        # monotonically as data is added to the document, so we share that
+        # between the old and new copies.
+        {:page_content    => state.page.content.deep_copy,
+         :current_page    => state.page.dictionary.deep_copy(share=[:Parent]),
+         :bounds          => bounds.deep_copy,
+         :page_number     => page_number,
+         :page_kids       => state.store.pages.data[:Kids].compact.map{|kid| kid.identifier},
+         :dests           => names? && names.data[:Dests].deep_copy}
+      end
+
+      # Rolls the page state back to the state of the given snapshot.
+      #
+      def restore_snapshot(shot)
+        page = state.page
+        # Because these objects are referenced by identifier from the Pages
+        # dictionary, we can't just restore them over the current refs in
+        # page_content and current_page. We have to restore them over the old
+        # ones.
+        page.content = shot[:page_content].identifier
+        page.content.replace shot[:page_content]
+
+        page.dictionary = shot[:current_page].identifier
+        page.dictionary.replace shot[:current_page]
+        page.dictionary.data[:Contents] = page.content
+
+        self.page_number = shot[:page_number]
+
+        state.store.pages.data[:Kids] = shot[:page_kids].map{|id| state.store[id]}
+        state.store.pages.data[:Count] = shot[:page_kids].size
+
+        self.bounds = BoundingBox.restore_deep_copy(shot[:bounds], self)
+
+        if shot[:dests]
+          names.data[:Dests] = shot[:dests] 
+        end
+      end
+
+    end
+  end
+end

data/lib/prawn/document/span.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+# span.rb : Implements text columns
+#
+# Copyright September 2008, Gregory Brown. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  class Document
+    # A span is a special purpose bounding box that allows a column of 
+    # elements to be positioned relative to the margin_box.  
+    #
+    # Arguments:
+    # +width+:: The width of the column in PDF points
+    #
+    # Options:
+    # <tt>:position</tt>:: One of :left, :center, :right or an x offset
+    #
+    # This method is typically used for flowing a column of text from one 
+    # page to the next.
+    #
+    #  span(350, :position => :center) do
+    #    text "Here's some centered text in a 350 point column. " * 100
+    #  end
+    #  
+    def span(width, options={})
+      Prawn.verify_options [:position], options
+      original_position = self.y      
+     
+      # FIXME: Any way to move this upstream?
+      left_boundary = case(options[:position] || :left)
+      when :left
+        margin_box.absolute_left
+      when :center
+        margin_box.absolute_left + margin_box.width / 2.0 - width /2.0
+      when :right
+        margin_box.absolute_right - width
+      when Numeric
+        margin_box.absolute_left + options[:position]
+      else
+        raise ArgumentError, "Invalid option for :position"
+      end
+      
+      # we need to bust out of whatever nested bounding boxes we're in.
+      canvas do
+        bounding_box([left_boundary, 
+                      margin_box.absolute_top], :width => width) do
+          self.y = original_position
+          yield
+        end
+      end          
+    end
+  end
+end

data/lib/prawn/encoding.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+#
+# Copyright September 2008, Gregory Brown, James Healy  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Encoding
+    # Map between unicode and WinAnsiEnoding
+    #
+    class WinAnsi #:nodoc:
+      CHARACTERS = %w[
+        .notdef       .notdef        .notdef        .notdef
+        .notdef       .notdef        .notdef        .notdef
+        .notdef       .notdef        .notdef        .notdef
+        .notdef       .notdef        .notdef        .notdef
+        .notdef       .notdef        .notdef        .notdef
+        .notdef       .notdef        .notdef        .notdef
+        .notdef       .notdef        .notdef        .notdef
+        .notdef       .notdef        .notdef        .notdef
+        
+        space         exclam         quotedbl       numbersign
+        dollar        percent        ampersand      quotesingle
+        parenleft     parenright     asterisk       plus
+        comma         hyphen         period         slash
+        zero          one            two            three
+        four          five           six            seven
+        eight         nine           colon          semicolon
+        less          equal          greater        question
+
+        at            A              B              C
+        D             E              F              G
+        H             I              J              K
+        L             M              N              O
+        P             Q              R              S
+        T             U              V              W
+        X             Y              Z              bracketleft
+        backslash     bracketright   asciicircum    underscore
+
+        grave         a              b              c
+        d             e              f              g
+        h             i              j              k
+        l             m              n              o
+        p             q              r              s
+        t             u              v              w
+        x             y              z              braceleft
+        bar           braceright     asciitilde     .notdef
+
+        Euro          .notdef        quotesinglbase florin
+        quotedblbase  ellipsis       dagger         daggerdbl
+        circumflex    perthousand    Scaron         guilsinglleft
+        OE            .notdef        Zcaron         .notdef
+        .notdef       quoteleft      quoteright     quotedblleft
+        quotedblright bullet         endash         emdash
+        tilde         trademark      scaron         guilsinglright
+        oe            .notdef        zcaron         ydieresis
+       
+        space         exclamdown     cent           sterling
+        currency      yen            brokenbar      section
+        dieresis      copyright      ordfeminine    guillemotleft
+        logicalnot    hyphen         registered     macron
+        degree        plusminus      twosuperior    threesuperior
+        acute         mu             paragraph      periodcentered
+        cedilla       onesuperior    ordmasculine   guillemotright
+        onequarter    onehalf        threequarters  questiondown
+
+        Agrave        Aacute         Acircumflex    Atilde
+        Adieresis     Aring          AE             Ccedilla
+        Egrave        Eacute         Ecircumflex    Edieresis
+        Igrave        Iacute         Icircumflex    Idieresis
+        Eth           Ntilde         Ograve         Oacute
+        Ocircumflex   Otilde         Odieresis      multiply
+        Oslash        Ugrave         Uacute         Ucircumflex
+        Udieresis     Yacute         Thorn          germandbls
+
+        agrave        aacute         acircumflex    atilde
+        adieresis     aring          ae             ccedilla
+        egrave        eacute         ecircumflex    edieresis
+        igrave        iacute         icircumflex    idieresis
+        eth           ntilde         ograve         oacute
+        ocircumflex   otilde         odieresis      divide
+        oslash        ugrave         uacute         ucircumflex
+        udieresis     yacute         thorn          ydieresis
+      ]    
+      
+      def initialize
+        @mapping_file = "#{Prawn::DATADIR}/encodings/win_ansi.txt"
+        load_mapping if self.class.mapping.empty?
+      end
+
+      # Converts a Unicode codepoint into a valid WinAnsi single byte character.
+      #
+      # If there is no WinAnsi equivlant for a character, a _ will be substituted.
+      #
+      def [](codepoint)
+        # unicode codepoints < 255 map directly to the single byte value in WinAnsi
+        return codepoint if codepoint <= 255
+
+        # There are a handful of codepoints > 255 that have equivilants in WinAnsi.
+        # Replace anything else with an underscore
+        self.class.mapping[codepoint] || 95
+      end
+      
+      def self.mapping
+        @mapping ||= {}
+      end
+
+      private
+
+      def load_mapping
+        RUBY_VERSION >= "1.9" ? mode = "r:BINARY" : mode = "r"
+        File.open(@mapping_file, mode) do |f|
+          f.each do |l|
+            m, single_byte, unicode = *l.match(/([0-9A-Za-z]+);([0-9A-F]{4})/)
+            self.class.mapping["0x#{unicode}".hex] = "0x#{single_byte}".hex if single_byte
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prawn/errors.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+#
+# errors.rb : Implements custom error classes for Prawn
+#
+# Copyright April 2008, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Errors
+     
+     # This error is raised when Prawn::PdfObject() encounters a Ruby object it
+     # cannot convert to PDF
+     #
+     FailedObjectConversion = Class.new(StandardError)
+     
+     # This error is raised when Document#page_layout is set to anything
+     # other than :portrait or :landscape            
+     #
+     InvalidPageLayout = Class.new(StandardError)       
+
+     # Raised when a table is spanned in an impossible way.
+     #
+     InvalidTableSpan = Class.new(StandardError)
+     
+     # This error is raised when a method requiring a current page is called 
+     # without being on a page.
+     #
+     NotOnPage = Class.new(StandardError)
+     
+     # This error is raised when Prawn cannot find a specified font   
+     #
+     UnknownFont = Class.new(StandardError)   
+
+     # Raised when Prawn is asked to draw something into a too-small box
+     #
+     CannotFit = Class.new(StandardError)
+
+     # Raised if group() is called with a block that is too big to be
+     # rendered in the current context.
+     #
+     CannotGroup = Class.new(StandardError) 
+
+     # This error is raised when Prawn is being used on a M17N aware VM,
+     # and the user attempts to add text that isn't compatible with UTF-8
+     # to their document
+     #
+     IncompatibleStringEncoding = Class.new(StandardError)
+     
+     # This error is raised when Prawn encounters an unknown key in functions
+     # that accept an options hash.  This usually means there is a typo in your
+     # code or that the option you are trying to use has a different name than
+     # what you have specified. 
+     #
+     UnknownOption = Class.new(StandardError)
+
+     # this error is raised when a user attempts to embed an image of an unsupported
+     # type. This can either a completely unsupported format, or a dialect of a
+     # supported format (ie. some types of PNG)
+     UnsupportedImageType = Class.new(StandardError)
+
+    # This error is raised when a named element has alredy been
+    # created. For example, in the stamp module, stamps must have
+    # unique names within a document
+    NameTaken = Class.new(StandardError)
+
+    # This error is raised when a name is not a valid format
+    InvalidName = Class.new(StandardError)
+
+    # This error is raised when an object is attempted to be
+    # referenced by name, but no such name is associated with an object
+    UndefinedObjectName = Class.new(StandardError)
+    
+    # This error is raised when a required option has not been set
+    RequiredOption = Class.new(StandardError)
+    
+    # This error is raised when a requested outline item with a given title does not exist
+    UnknownOutlineTitle = Class.new(StandardError)
+
+    # This error is raised when a block is required, but not provided
+    BlockRequired = Class.new(StandardError)
+    
+    # This error is rased when a graphics method is called with improper arguments
+    InvalidGraphicsPath = Class.new(StandardError)
+    
+    # This error is raised when Prawn fails to load a template file
+    #
+    TemplateError = Class.new(StandardError)
+    
+    # This error is raise when trying to restore a graphic state that 
+    #
+    EmptyGraphicStateStack = Class.new(StandardError)
+
+    # Raised when unrecognized content is provided for a table cell.
+    #
+    UnrecognizedTableContent = Class.new(StandardError)
+    
+  end
+end   

data/lib/prawn/font.rb

@@ -0,0 +1,386 @@
+# encoding: utf-8
+#
+# font.rb : The Prawn font class
+#
+# Copyright May 2008, Gregory Brown / James Healy. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+require "prawn/font/afm"
+require "prawn/font/ttf"
+require "prawn/font/dfont"
+
+module Prawn
+
+  class Document
+    # Without arguments, this returns the currently selected font. Otherwise,
+    # it sets the current font. When a block is used, the font is applied
+    # transactionally and is rolled back when the block exits.
+    #
+    #   Prawn::Document.generate("font.pdf") do
+    #     text "Default font is Helvetica"
+    #
+    #     font "Times-Roman"
+    #     text "Now using Times-Roman"
+    #
+    #     font("Chalkboard.ttf") do
+    #       text "Using TTF font from file Chalkboard.ttf"
+    #       font "Courier", :style => :bold
+    #       text "You see this in bold Courier"
+    #     end
+    #
+    #     text "Times-Roman, again"
+    #   end
+    #
+    # The :name parameter must be a string. It can be one of the 14 built-in
+    # fonts supported by PDF, or the location of a TTF file. The Font::AFM::BUILT_INS
+    # array specifies the valid built in font values.
+    #
+    # If a ttf font is specified, the glyphs necessary to render your document
+    # will be embedded in the rendered PDF. This should be your preferred option
+    # in most cases. It will increase the size of the resulting file, but also 
+    # make it more portable.
+    #
+    # The options parameter is an optional hash providing size and style. To use
+    # the :style option you need to map those font styles to their respective font files.
+    # See font_families for more information.
+    #
+    def font(name=nil, options={})
+      return((defined?(@font) && @font) || font("Helvetica")) if name.nil?
+
+      if state.pages.empty? && !state.page.in_stamp_stream?
+        raise Prawn::Errors::NotOnPage 
+      end
+      
+      new_font = find_font(name.to_s, options)
+
+      if block_given?
+        save_font do
+          set_font(new_font, options[:size])
+          yield
+        end
+      else
+        set_font(new_font, options[:size])
+      end
+
+      @font
+    end
+
+    # When called with no argument, returns the current font size.
+    # When called with a single argument but no block, sets the current font
+    # size.  When a block is used, the font size is applied transactionally and
+    # is rolled back when the block exits.  You may still change the font size
+    # within a transactional block for individual text segments, or nested calls
+    # to font_size.
+    #
+    #   Prawn::Document.generate("font_size.pdf") do
+    #     font_size 16
+    #     text "At size 16"
+    #
+    #     font_size(10) do
+    #       text "At size 10"
+    #       text "At size 6", :size => 6
+    #       text "At size 10"
+    #     end
+    #
+    #     text "At size 16"
+    #   end
+    #
+    # When called without an argument, this method returns the current font
+    # size.
+    #
+    def font_size(points=nil)
+      return @font_size unless points
+      size_before_yield = @font_size
+      @font_size = points
+      block_given? ? yield : return
+      @font_size = size_before_yield
+    end
+
+    # Sets the font directly, given an actual Font object
+    # and size.
+    #
+    def set_font(font, size=nil) # :nodoc:
+      @font = font
+      @font_size = size if size
+    end
+
+    # Saves the current font, and then yields. When the block
+    # finishes, the original font is restored.
+    #
+    def save_font
+      @font ||= find_font("Helvetica")
+      original_font = @font
+      original_size = @font_size
+
+      yield
+    ensure
+      set_font(original_font, original_size) if original_font
+    end
+
+    # Looks up the given font using the given criteria. Once a font has been
+    # found by that matches the criteria, it will be cached to subsequent lookups
+    # for that font will return the same object.
+    #--
+    # Challenges involved: the name alone is not sufficient to uniquely identify
+    # a font (think dfont suitcases that can hold multiple different fonts in a
+    # single file). Thus, the :name key is included in the cache key.
+    #
+    # It is further complicated, however, since fonts in some formats (like the
+    # dfont suitcases) can be identified either by numeric index, OR by their
+    # name within the suitcase, and both should hash to the same font object
+    # (to avoid the font being embedded multiple times). This is not yet implemented,
+    # which means if someone selects a font both by name, and by index, the
+    # font will be embedded twice. Since we do font subsetting, this double
+    # embedding won't be catastrophic, just annoying.
+    # ++
+    def find_font(name, options={}) #:nodoc: 
+      if font_families.key?(name) 
+        family, name = name, font_families[name][options[:style] || :normal] 
+        if name.is_a?(Hash) 
+          options = options.merge(name) 
+          name = options[:file] 
+        end 
+      end 
+      key = "#{name}:#{options[:font] || 0}" 
+      font_registry[key] ||= Font.load(self, name, options.merge(:family => family)) 
+    end 
+    
+    # Hash of Font objects keyed by names
+    #
+    def font_registry #:nodoc:
+      @font_registry ||= {}
+    end
+
+    # Hash that maps font family names to their styled individual font names.
+    #
+    # To add support for another font family, append to this hash, e.g:
+    #
+    #   pdf.font_families.update(
+    #    "MyTrueTypeFamily" => { :bold        => "foo-bold.ttf",
+    #                            :italic      => "foo-italic.ttf",
+    #                            :bold_italic => "foo-bold-italic.ttf",
+    #                            :normal      => "foo.ttf" })
+    #
+    # This will then allow you to use the fonts like so:
+    #
+    #   pdf.font("MyTrueTypeFamily", :style => :bold)
+    #   pdf.text "Some bold text"
+    #   pdf.font("MyTrueTypeFamily")
+    #   pdf.text "Some normal text"
+    #
+    # This assumes that you have appropriate TTF fonts for each style you
+    # wish to support.
+    #
+    # By default the styles :bold, :italic, :bold_italic, and :normal are
+    # defined for fonts "Courier", "Times-Roman" and "Helvetica".
+    #
+    # You probably want to provide those four styles, but are free to define
+    # custom ones, like :thin, and use them in font calls.
+    #
+    def font_families
+      @font_families ||= Hash.new.merge!(
+        { "Courier"     => { :bold        => "Courier-Bold",
+                             :italic      => "Courier-Oblique",
+                             :bold_italic => "Courier-BoldOblique",
+                             :normal      => "Courier" },
+
+          "Times-Roman" => { :bold         => "Times-Bold",
+                             :italic       => "Times-Italic",
+                             :bold_italic  => "Times-BoldItalic",
+                             :normal       => "Times-Roman" },
+
+          "Helvetica"   => { :bold         => "Helvetica-Bold",
+                             :italic       => "Helvetica-Oblique",
+                             :bold_italic  => "Helvetica-BoldOblique",
+                             :normal       => "Helvetica" }
+        })
+    end
+
+    # Returns the width of the given string using the given font. If :size is not
+    # specified as one of the options, the string is measured using the current
+    # font size. You can also pass :kerning as an option to indicate whether
+    # kerning should be used when measuring the width (defaults to +false+).
+    #
+    # Note that the string _must_ be encoded properly for the font being used.
+    # For AFM fonts, this is WinAnsi. For TTF, make sure the font is encoded as
+    # UTF-8. You can use the Font#normalize_encoding method to make sure strings
+    # are in an encoding appropriate for the current font.
+    #--
+    # For the record, this method used to be a method of Font (and still delegates
+    # to width computations on Font). However, having the primary interface for
+    # calculating string widths exist on Font made it tricky to write extensions
+    # for Prawn in which widths are computed differently (e.g., taking formatting
+    # tags into account, or the like).
+    #
+    # By putting width_of here, on Document itself, extensions may easily override
+    # it and redefine the width calculation behavior.
+    #++
+    def width_of(string, options={})
+      if options[:inline_format]
+        # Build up an Arranger with the entire string on one line, finalize it,
+        # and find its width.
+        arranger = Core::Text::Formatted::Arranger.new(self, options)
+        arranger.consumed = Text::Formatted::Parser.to_array(string)
+        arranger.finalize_line
+
+        arranger.line_width
+      else
+        f = if options[:style]
+              # override style with :style => :bold
+              find_font(@font ? @font.name : 'Helvetica',
+                        :style => options[:style])
+            else
+              font
+            end
+        f.compute_width_of(string, options) +
+          (character_spacing * font.character_count(string))
+      end
+    end
+  end
+
+  # Provides font information and helper functions.
+  #
+  class Font
+
+    # The current font name
+    attr_reader :name
+
+    # The current font family
+    attr_reader :family
+
+    # The options hash used to initialize the font
+    attr_reader :options
+
+    # Shortcut interface for constructing a font object.  Filenames of the form
+    # *.ttf will call Font::TTF.new, *.dfont Font::DFont.new, and anything else
+    # will be passed through to Font::AFM.new()
+    #
+    def self.load(document,name,options={})
+      case name.to_s
+      when /\.ttf$/i   then TTF.new(document, name, options)
+      when /\.dfont$/i then DFont.new(document, name, options)
+      when /\.afm$/i   then AFM.new(document, name, options)
+      else                  AFM.new(document, name, options)
+      end
+    end
+
+    def initialize(document,name,options={}) #:nodoc:
+      @document   = document
+      @name       = name
+      @options    = options
+
+      @family     = options[:family]
+
+      @identifier = generate_unique_id
+
+      @references = {}
+    end
+
+    # The size of the font ascender in PDF points 
+    #
+    def ascender
+      @ascender / 1000.0 * size
+    end
+
+    # The size of the font descender in PDF points
+    #
+    def descender
+      -@descender / 1000.0 * size
+    end
+
+    # The size of the recommended gap between lines of text in PDF points
+    #
+    def line_gap
+      @line_gap / 1000.0 * size
+    end
+
+    def identifier_for(subset)
+      "#{@identifier}.#{subset}".to_sym
+    end
+
+    def inspect
+      "#{self.class.name}< #{name}: #{size} >"
+    end
+
+    # Normalizes the encoding of the string to an encoding supported by the
+    # font. The string is expected to be UTF-8 going in. It will be re-encoded
+    # and the new string will be returned. For an in-place (destructive)
+    # version, see normalize_encoding!.
+    def normalize_encoding(string)
+      raise NotImplementedError, "subclasses of Prawn::Font must implement #normalize_encoding"
+    end
+
+    # Destructive version of normalize_encoding; normalizes the encoding of a
+    # string in place.
+    #
+    def normalize_encoding!(str)
+      str.replace(normalize_encoding(str))
+    end
+
+    # Gets height of current font in PDF points at the given font size
+    #
+    def height_at(size)
+      @normalized_height ||= (@ascender - @descender + @line_gap) / 1000.0
+      @normalized_height * size
+    end
+
+    # Gets height of current font in PDF points at current font size
+    #
+    def height
+      height_at(size)
+    end
+
+    # Registers the given subset of the current font with the current PDF
+    # page. This is safe to call multiple times for a given font and subset,
+    # as it will only add the font the first time it is called.
+    #
+    def add_to_current_page(subset)
+      @references[subset] ||= register(subset)
+      @document.state.page.fonts.merge!(identifier_for(subset) => @references[subset])
+    end
+
+    def identifier_for(subset) #:nodoc:
+      "#{@identifier}.#{subset}"
+    end
+
+    def inspect #:nodoc:
+      "#{self.class.name}< #{name}: #{size} >"
+    end
+
+    private
+
+    # generate a font identifier that hasn't been used on the curretn page yet
+    #
+    def generate_unique_id
+      offset, id = 0, nil
+
+      while id.nil? || page_contains_font_id?(id)
+        offset += 1
+        id = :"F#{@document.font_registry.size + offset}"
+      end
+
+      id
+    end
+
+    # Returns true if the provided font identifier already exists in the document.
+    # This is used when adding new fonts to a document to ensure we don't step
+    # on fonts imported from a template.
+    #
+    #   page_contains_font_id?("F1")
+    #   => true
+    #
+    def page_contains_font_id?(id)
+      id = id.to_s
+      @document.state.page.fonts.keys.any? { |exist_id|
+        exist_id.to_s[0,id.size] == id
+      }
+    end
+
+    def size
+      @document.font_size
+    end
+
+  end
+
+end