origami 1.2.7 → 2.0.0

data/lib/origami/filters/runlength.rb

@@ -1,118 +1,117 @@
 =begin
 
-= File
-	filters/runlength.rb
-
-= Info
-	This file is part of Origami, PDF manipulation framework for Ruby
-	Copyright (C) 2010	Guillaume Delugré <guillaume AT security-labs DOT org>
-	All right reserved.
-	
-  Origami is free software: you can redistribute it and/or modify
-  it under the terms of the GNU Lesser General Public License as published by
-  the Free Software Foundation, either version 3 of the License, or
-  (at your option) any later version.
-
-  Origami is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public License
-  along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+    This file is part of Origami, PDF manipulation framework for Ruby
+    Copyright (C) 2016	Guillaume Delugré.
+
+    Origami is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Origami is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
 
 =end
 
 module Origami
-  
-  module Filter
-    
-    class InvalidRunLengthDataError < InvalidFilterDataError #:nodoc:
-    end
-    
-    #
-    # Class representing a Filter used to encode and decode data using RLE compression algorithm.
-    #
-    class RunLength
-      include Filter
-      
-      EOD = 128 #:nodoc:
-      
-      #
-      # Encodes data using RLE compression method.
-      # _stream_:: The data to encode.
-      #
-      def encode(stream)
-
-        result = ""
-        i = 0
-
-        while i < stream.size
-          
-          #
-          # How many identical bytes coming?
-          #
-          length = 1
-          while i+1 < stream.size and length < EOD and stream[i] == stream[i+1]
-            length = length + 1
-            i = i + 1
-          end
-
-          #
-          # If more than 1, then compress them.
-          #
-          if length > 1
-            result << (257 - length).chr << stream[i,1]
-
-          #
-          # Otherwise how many different bytes to copy ?
-          #
-          else
-            j = i
-            while j+1 < stream.size and (j - i + 1) < EOD and stream[j] != stream[j+1]
-              j = j + 1
-            end
 
-            length = j - i
-            result << length.chr << stream[i, length+1]
+    module Filter
 
-            i = j
-          end
-
-          i = i + 1
+        class InvalidRunLengthDataError < DecodeError #:nodoc:
         end
 
-        result << EOD.chr
-      end
-
-
-      #
-      # Decodes data using RLE decompression method.
-      # _stream_:: The data to decode.
-      #
-      def decode(stream)
-        raise InvalidRunLengthDataError, "No end marker" unless stream.include?(EOD.chr)
-        
-        i = 0
-        result = ""
-        until stream[i].ord == EOD do
-        
-          length = stream[i].ord
-          if length < EOD
-            result << stream[i + 1, length + 1]
-            i = i + length + 2
-          else
-            result << stream[i + 1,1] * (257 - length)
-            i = i + 2
-          end
-          
+        #
+        # Class representing a Filter used to encode and decode data using RLE compression algorithm.
+        #
+        class RunLength
+            include Filter
+
+            EOD = 128 #:nodoc:
+
+            #
+            # Encodes data using RLE compression method.
+            # _stream_:: The data to encode.
+            #
+            def encode(stream)
+                result = "".b
+                i = 0
+
+                while i < stream.size
+                    #
+                    # How many identical bytes coming?
+                    #
+                    length = 1
+                    while i+1 < stream.size and length < EOD and stream[i] == stream[i+1]
+                        length = length + 1
+                        i = i + 1
+                    end
+
+                    #
+                    # If more than 1, then compress them.
+                    #
+                    if length > 1
+                        result << (257 - length).chr << stream[i]
+                    #
+                    # Otherwise how many different bytes to copy?
+                    #
+                    else
+                        j = i
+                        while j+1 < stream.size and (j - i + 1) < EOD and stream[j] != stream[j+1]
+                            j = j + 1
+                        end
+
+                        length = j - i
+                        result << length.chr << stream[i, length+1]
+
+                        i = j
+                    end
+
+                    i = i + 1
+                end
+
+                result << EOD.chr
+            end
+
+            #
+            # Decodes data using RLE decompression method.
+            # _stream_:: The data to decode.
+            #
+            def decode(stream)
+                result = "".b
+                return result if stream.empty?
+
+                i = 0
+                until i >= stream.length or stream[i].ord == EOD do
+
+                    # At least two bytes are required.
+                    if i > stream.length - 2
+                        raise InvalidRunLengthDataError.new("Truncated run-length data", input_data: stream, decoded_data: result)
+                    end
+
+                    length = stream[i].ord
+                    if length < EOD
+                        result << stream[i + 1, length + 1]
+                        i = i + length + 2
+                    else
+                        result << stream[i + 1] * (257 - length)
+                        i = i + 2
+                    end
+                end
+
+                # Check if offset is beyond the end of data.
+                if i >= stream.length
+                    raise InvalidRunLengthDataError.new("Truncated run-length data", input_data: stream, decoded_data: result)
+                end
+
+                result
+            end
         end
-        
-        result
-      end
+        RL = RunLength
 
     end
-    RL = RunLength
-  end
 end
-

data/lib/origami/font.rb

@@ -1,209 +1,196 @@
 =begin
 
-= File
-	font.rb
-
-= Info
-	This file is part of Origami, PDF manipulation framework for Ruby
-	Copyright (C) 2010	Guillaume Delugré <guillaume AT security-labs DOT org>
-	All right reserved.
-	
-  Origami is free software: you can redistribute it and/or modify
-  it under the terms of the GNU Lesser General Public License as published by
-  the Free Software Foundation, either version 3 of the License, or
-  (at your option) any later version.
-
-  Origami is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public License
-  along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+    This file is part of Origami, PDF manipulation framework for Ruby
+    Copyright (C) 2016	Guillaume Delugré.
+
+    Origami is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Origami is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
 
 =end
 
 module Origami
 
-  #
-  # Embedded font stream.
-  #
-  class FontStream < Stream
-    
-    field   :Subtype,                 :Type => Name
-    field   :Length1,                 :Type => Integer
-    field   :Length2,                 :Type => Integer
-    field   :Length3,                 :Type => Integer
-
-  end
-  
-  #
-  # Class representing a font details in a document.
-  #
-  class FontDescriptor < Dictionary
-    
-    include StandardObject
-    
-    FIXEDPITCH  = 1 << 1
-    SERIF       = 1 << 2
-    SYMBOLIC    = 1 << 3
-    SCRIPT      = 1 << 4
-    NONSYMBOLIC = 1 << 6
-    ITALIC      = 1 << 7
-    ALLCAP      = 1 << 17
-    SMALLCAP    = 1 << 18
-    FORCEBOLD   = 1 << 19
-
-    field   :Type,                    :Type => Name, :Default => :FontDescriptor, :Required => true
-    field   :FontName,                :Type => Name, :Required => true
-    field   :FontFamily,              :Type => ByteString, :Version => "1.5"
-    field   :FontStretch,             :Type => Name, :Default => :Normal, :Version => "1.5"
-    field   :FontWeight,              :Type => Integer, :Default => 400, :Version => "1.5"
-    field   :Flags,                   :Type => Integer, :Required => true
-    field   :FontBBox,                :Type => Array
-    field   :ItalicAngle,             :Type => Number, :Required => true
-    field   :Ascent,                  :Type => Number
-    field   :Descent,                 :Type => Number
-    field   :Leading,                 :Type => Number, :Default => 0
-    field   :CapHeight,               :Type => Number
-    field   :XHeight,                 :Type => Number, :Default => 0
-    field   :StemV,                   :Type => Number
-    field   :StemH,                   :Type => Number, :Default => 0
-    field   :AvgWidth,                :Type => Number, :Default => 0
-    field   :MaxWidth,                :Type => Number, :Default => 0
-    field   :MissingWidth,            :Type => Number, :Default => 0
-    field   :FontFile,                :Type => FontStream
-    field   :FontFile2,               :Type => FontStream, :Version => "1.1"
-    field   :FontFile3,               :Type => FontStream, :Version => "1.2"
-    field   :CharSet,                 :Type => ByteString, :Version => "1.1"
-    
-  end
-  
-  #
-  # Class representing a character encoding in a document.
-  #
-  class Encoding < Dictionary
-    
-    include StandardObject
-
-    field   :Type,                    :Type => Name, :Default => :Encoding
-    field   :BaseEncoding,            :Type => Name
-    field   :Differences,             :Type => Array
-   
-  end
- 
-  #
-  # Class representing a rendering font in a document.
-  #
-  class Font < Dictionary
-    
-    include StandardObject
-   
-    field   :Type,                    :Type => Name, :Default => :Font, :Required => true
-    field   :Subtype,                 :Type => Name, :Required => true
-    field   :Name,                    :Type => Name
-    field   :FirstChar,               :Type => Integer
-    field   :LastChar,                :Type => Integer
-    field   :Widths,                  :Type => Array
-    field   :FontDescriptor,          :Type => FontDescriptor
-    field   :Encoding,                :Type => [ Name, Encoding ], :Default => :MacRomanEncoding
-    field   :ToUnicode,               :Type => Stream, :Version => "1.2"
-   
-    # TODO: Type0 and CID Fonts
-
     #
-    # Type1 Fonts.
+    # Embedded font stream.
     #
-    class Type1 < Font
-
-      field   :BaseFont,              :Type => Name, :Required => true
-      field   :Subtype,               :Type => Name, :Default => :Type1, :Required => true
-      
-      #
-      # 14 standard Type1 fonts.
-      #
-      module Standard
-        
-        class TimesRoman < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Times-Roman", :Required => true
-        end
-
-        class Helvetica < Type1
-          field   :BaseFont,          :Type => Name, :Default => :Helvetica, :Required => true
-        end
-
-        class Courier < Type1
-          field   :BaseFont,          :Type => Name, :Default => :Courier, :Required => true
-        end
-
-        class Symbol < Type1
-          field   :BaseFont,          :Type => Name, :Default => :Symbol, :Required => true
-        end
-
-        class TimesBold < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Times-Bold", :Required => true
-        end
-
-        class HelveticaBold < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Helvetica-Bold", :Required => true
-        end
-
-        class CourierBold < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Courier-Bold", :Required => true
-        end
-
-        class ZapfDingbats < Type1
-          field   :BaseFont,          :Type => Name, :Default => :ZapfDingbats, :Required => true
-        end
-
-        class TimesItalic < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Times-Italic", :Required => true
-        end
-
-        class HelveticaOblique < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Helvetica-Oblique", :Required => true
-        end
-
-        class CourierOblique < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Courier-Oblique", :Required => true
-        end
-
-        class TimesBoldItalic < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Times-BoldItalic", :Required => true
-        end
-
-        class HelveticaBoldOblique < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Helvetica-BoldOblique", :Required => true
-        end
-
-        class CourierBoldOblique < Type1
-          field   :BaseFont,          :Type => Name, :Default => :"Courier-BoldOblique", :Required => true
-        end
-
-      end
+    class FontStream < Stream
+        field   :Subtype,                 :Type => Name
+        field   :Length1,                 :Type => Integer
+        field   :Length2,                 :Type => Integer
+        field   :Length3,                 :Type => Integer
+        field   :Metadata,                :Type => MetadataStream
+    end
 
+    #
+    # Class representing a font details in a document.
+    #
+    class FontDescriptor < Dictionary
+        include StandardObject
+
+        FIXEDPITCH  = 1 << 1
+        SERIF       = 1 << 2
+        SYMBOLIC    = 1 << 3
+        SCRIPT      = 1 << 4
+        NONSYMBOLIC = 1 << 6
+        ITALIC      = 1 << 7
+        ALLCAP      = 1 << 17
+        SMALLCAP    = 1 << 18
+        FORCEBOLD   = 1 << 19
+
+        field   :Type,                    :Type => Name, :Default => :FontDescriptor, :Required => true
+        field   :FontName,                :Type => Name, :Required => true
+        field   :FontFamily,              :Type => String, :Version => "1.5"
+        field   :FontStretch,             :Type => Name, :Default => :Normal, :Version => "1.5"
+        field   :FontWeight,              :Type => Integer, :Default => 400, :Version => "1.5"
+        field   :Flags,                   :Type => Integer, :Required => true
+        field   :FontBBox,                :Type => Rectangle
+        field   :ItalicAngle,             :Type => Number, :Required => true
+        field   :Ascent,                  :Type => Number
+        field   :Descent,                 :Type => Number
+        field   :Leading,                 :Type => Number, :Default => 0
+        field   :CapHeight,               :Type => Number
+        field   :XHeight,                 :Type => Number, :Default => 0
+        field   :StemV,                   :Type => Number
+        field   :StemH,                   :Type => Number, :Default => 0
+        field   :AvgWidth,                :Type => Number, :Default => 0
+        field   :MaxWidth,                :Type => Number, :Default => 0
+        field   :MissingWidth,            :Type => Number, :Default => 0
+        field   :FontFile,                :Type => FontStream
+        field   :FontFile2,               :Type => FontStream, :Version => "1.1"
+        field   :FontFile3,               :Type => FontStream, :Version => "1.2"
+        field   :CharSet,                 :Type => String, :Version => "1.1"
     end
 
     #
-    # TrueType Fonts
+    # Class representing a character encoding in a document.
     #
-    class TrueType < Font
-      field   :Subtype,               :Type => Name, :Default => :TrueType, :Required => true
+    class Encoding < Dictionary
+        include StandardObject
+
+        field   :Type,                    :Type => Name, :Default => :Encoding
+        field   :BaseEncoding,            :Type => Name
+        field   :Differences,             :Type => Array
     end
 
     #
-    # Type 3 Fonts
+    # Class representing a rendering font in a document.
     #
-    class Type3 < Font
+    class Font < Dictionary
+        include StandardObject
+
+        field   :Type,                    :Type => Name, :Default => :Font, :Required => true
+        field   :Subtype,                 :Type => Name, :Required => true
+        field   :Name,                    :Type => Name
+        field   :FirstChar,               :Type => Integer
+        field   :LastChar,                :Type => Integer
+        field   :Widths,                  :Type => Array.of(Number)
+        field   :FontDescriptor,          :Type => FontDescriptor
+        field   :Encoding,                :Type => [ Name, Encoding ], :Default => :MacRomanEncoding
+        field   :ToUnicode,               :Type => Stream, :Version => "1.2"
+
+        # TODO: Type0 and CID Fonts
+
+        #
+        # Type1 Fonts.
+        #
+        class Type1 < Font
+
+            field   :BaseFont,              :Type => Name, :Required => true
+            field   :Subtype,               :Type => Name, :Default => :Type1, :Required => true
+
+            #
+            # 14 standard Type1 fonts.
+            #
+            module Standard
+
+                class TimesRoman < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Times-Roman", :Required => true
+                end
+
+                class Helvetica < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :Helvetica, :Required => true
+                end
+
+                class Courier < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :Courier, :Required => true
+                end
+
+                class Symbol < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :Symbol, :Required => true
+                end
+
+                class TimesBold < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Times-Bold", :Required => true
+                end
+
+                class HelveticaBold < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Helvetica-Bold", :Required => true
+                end
+
+                class CourierBold < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Courier-Bold", :Required => true
+                end
+
+                class ZapfDingbats < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :ZapfDingbats, :Required => true
+                end
+
+                class TimesItalic < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Times-Italic", :Required => true
+                end
+
+                class HelveticaOblique < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Helvetica-Oblique", :Required => true
+                end
+
+                class CourierOblique < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Courier-Oblique", :Required => true
+                end
+
+                class TimesBoldItalic < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Times-BoldItalic", :Required => true
+                end
+
+                class HelveticaBoldOblique < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Helvetica-BoldOblique", :Required => true
+                end
+
+                class CourierBoldOblique < Type1
+                    field   :BaseFont,          :Type => Name, :Default => :"Courier-BoldOblique", :Required => true
+                end
+            end
+        end
 
-      field   :Subtype,               :Type => Name, :Default => :Type3, :Required => true
-      field   :FontBBox,              :Type => Array, :Required => true
-      field   :FontMatrix,            :Type => Array, :Required => true
-      field   :CharProcs,             :Type => Dictionary, :Required => true
-      field   :Resources,             :Type => Dictionary, :Version => "1.2"
+        #
+        # TrueType Fonts
+        #
+        class TrueType < Font
+            field   :Subtype,               :Type => Name, :Default => :TrueType, :Required => true
+            field   :BaseFont,              :Type => Name, :Required => true
+        end
 
+        #
+        # Type 3 Fonts
+        #
+        class Type3 < Font
+            include ResourcesHolder
+
+            field   :Subtype,               :Type => Name, :Default => :Type3, :Required => true
+            field   :FontBBox,              :Type => Rectangle, :Required => true
+            field   :FontMatrix,            :Type => Array.of(Number, length: 6), :Required => true
+            field   :CharProcs,             :Type => Dictionary, :Required => true
+            field   :Resources,             :Type => Resources, :Version => "1.2"
+        end
     end
 
-  end
-
 end