origami 1.2.7 → 2.0.0

data/lib/origami/collections.rb

@@ -0,0 +1,144 @@
+=begin
+
+    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
+
+    class PDF
+        #
+        # Returns true if the document behaves as a portfolio for embedded files.
+        #
+        def portfolio?
+            self.Catalog.Collection.is_a?(Dictionary)
+        end
+    end
+
+    class Collection < Dictionary
+        include StandardObject
+        
+        module View
+            DETAILS = :D
+            TILE    = :T
+            HIDDEN  = :H
+        end
+
+        class Schema < Dictionary
+            include StandardObject
+
+            field   :Type,              :Type => Name, :Default => :CollectionSchema
+        end
+
+        class Navigator < Dictionary
+            include StandardObject
+            
+            module Type
+                FLEX    = :Module
+                FLASH   = :Default
+            end
+
+            field   :SWF,               :Type => String, :Required => true
+            field   :Name,              :Type => String, :Required => true
+            field   :Desc,              :Type => String
+            field   :Category,          :Type => String
+            field   :ID,                :Type => String, :Required => true
+            field   :Version,           :Type => String
+            field   :APIVersion,        :Type => String, :Required => true
+            field   :LoadType,          :Type => Name, :Default => Type::FLASH
+            field   :Icon,              :Type => String
+            field   :Locale,            :Type => String
+            field   :Strings,           :Type => NameTreeNode.of(String)
+            field   :InitialFields,     :Type => Schema
+            field   :Resources,         :Type => NameTreeNode.of(Stream), :Required => true
+        end
+
+        class Color < Dictionary
+            include StandardObject
+
+            field   :Background,        :Type => Array.of(Number, length: 3)
+            field   :CardBackground,    :Type => Array.of(Number, length: 3)
+            field   :CardBorder,        :Type => Array.of(Number, length: 3)
+            field   :PrimaryText,       :Type => Array.of(Number, length: 3)
+            field   :SecondaryText,     :Type => Array.of(Number, length: 3)
+        end
+
+        class Split < Dictionary
+            include StandardObject
+            
+            HORIZONTAL  = :H
+            VERTICAL    = :V
+            NONE        = :N
+
+            field   :Direction,         :Type => Name
+            field   :Position,          :Type => Number
+        end
+
+        class Item < Dictionary
+            include StandardObject
+
+            field   :Type,              :Type => Name, :Default => :CollectionItem
+        end
+
+        class Subitem < Dictionary
+            include StandardObject
+
+            field   :Type,              :Type => Name, :Default => :CollectionSubitem
+            field   :D,                 :Type => [ String, Number ]
+            field   :P,                 :Type => String
+        end
+
+        class Folder < Dictionary
+            include StandardObject
+
+            field   :Type,              :Type => Name, :Default => :Folder
+            field   :ID,                :Type => Integer, :Required => true
+            field   :Name,              :Type => String, :Required => true
+            field   :Parent,            :Type => Folder
+            field   :Child,             :Type => Folder
+            field   :Next,              :Type => Folder
+            field   :CI,                :Type => Item
+            field   :Desc,              :Type => String
+            field   :CreationDate,      :Type => String
+            field   :ModDate,           :Type => String
+            field   :Thumb,             :Type => Stream
+            field   :Free,              :Type => Array.of(Array.of(Integer, length: 2))
+        end
+
+        class Sort < Dictionary
+            include StandardObject
+
+            field   :Type,              :Type => Name, :Default => :CollectionSort
+            field   :S,                 :Type => [ Name, Array.of(Name) ]
+            field   :A,                 :Type => [ Boolean, Array.of(Boolean) ]
+        end
+
+        #
+        # Collection fields.
+        #
+        field   :Type,              :Type => Name, :Default => :Collection
+        field   :Schema,            :Type => Schema
+        field   :D,                 :Type => String
+        field   :View,              :Type => Name, :Default => View::DETAILS
+        field   :Sort,              :Type => Sort
+        field   :Navigator,         :Type => Navigator, :ExtensionLevel => 3
+        field   :Resources,         :Type => NameTreeNode.of(Stream), :ExtensionLevel => 3
+        field   :Colors,            :Type => Color, :ExtensionLevel => 3
+        field   :Folders,           :Type => Folder, :ExtensionLevel => 3
+        field   :Split,             :Type => Split, :ExtensionLevel => 3
+    end
+end

data/lib/origami/destinations.rb

@@ -1,213 +1,252 @@
 =begin
 
-= File
-	destinations.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
 
-  class PDF
+    class PDF
+        #
+        # Lookup destination in the destination name directory.
+        #
+        def get_destination_by_name(name)
+            resolve_name Names::DESTINATIONS, name
+        end
 
-    #
-    # Lookup destination in the destination name directory.
-    #
-    def get_destination_by_name(name)
-      resolve_name Names::Root::DESTS, name
+        #
+        # Calls block for each named destination.
+        #
+        def each_named_dest(&b)
+            each_name(Names::DESTINATIONS, &b)
+        end
     end
 
     #
-    # Calls block for each named destination.
+    # A destination represents a specified location into the document.
     #
-    def each_named_dest(&b)
-      each_name(Names::Root::DESTS, &b) 
-    end
-  end
-
-  #
-  # A destination represents a specified location into the document.
-  #
-  module Destination
-    
-    attr_reader :top, :left, :right, :bottom, :zoom
-  
-    #
-    # Class representing a Destination zooming on a part of a document.
-    #
-    class Zoom < Origami::Array
-      
-      include Destination
-      
-      #
-      # Creates a new zoom Destination.
-      # _pageref_:: A Reference to a Page.
-      # _left_, _top_:: Coords in the Page.
-      # _zoom_:: Zoom factor.
-      #
-      def initialize(pageref, left = 0, top = 0, zoom = 0)
-        
-        @left, @top, @zoom = left, top, zoom
-        
-        super([pageref, :XYZ, left, top, zoom])
-        
-      end
-      
-    end
-    
-    #
-    # Class representing a Destination showing a Page globally.
-    #
-    class GlobalFit < Origami::Array
-      
-      include Destination
-      
-      #
-      # Creates a new global fit Destination.
-      # _pageref_:: A Reference to a Page.
-      #
-      def initialize(pageref)
-        super([pageref, :Fit])
-      end
-      
-    end
-    
-    #
-    # Class representing a Destination fitting a Page horizontally.
-    #
-    class HorizontalFit < Origami::Array
-      
-      include Destination
-      
-      #
-      # Creates a new horizontal fit destination.
-      # _pageref_:: A Reference to a Page.
-      # _top_:: The vertical coord in the Page.
-      #
-      def initialize(pageref, top = 0)
-        
-        @top = top
-        super([pageref, :FitH, top])
-        
-      end
-    
-    end
+    class Destination < Origami::Array
+        attr_reader :page, :top, :left, :right, :bottom, :zoom
 
-    #
-    # Class representing a Destination fitting a Page vertically.
-    # _pageref_:: A Reference to a Page.
-    # _left_:: The horizontal coord in the Page.
-    #
-    class VerticalFit < Origami::Array
-      
-      include Destination
-      
-      def initialize(pageref, left = 0)
-        
-        @left = left
-        super([pageref, :FitV, left])
-        
-      end
-      
-    end
-    
-    #
-    # Class representing a Destination fitting the view on a rectangle in a Page.
-    #
-    class RectangleFit < Origami::Array
-      
-      include Destination
-      
-      #
-      # Creates a new rectangle fit Destination.
-      # _pageref_:: A Reference to a Page.
-      # _left_, _bottom_, _right_, _top_:: The rectangle to fit in.
-      #
-      def initialize(pageref, left = 0, bottom = 0, right = 0, top = 0)
-        
-        @left, @bottom, @right, @top = left, bottom, right, top
-        super([pageref, :FitR, left, bottom, right, top])
-        
-      end
-      
-    end
-    
-    #
-    # Class representing a Destination fitting the bounding box of a Page.
-    #
-    class GlobalBoundingBoxFit < Origami::Array
-      
-      include Destination
-      
-      #
-      # Creates a new bounding box fit Destination.
-      # _pageref_:: A Reference to a Page.
-      #
-      def initialize(pageref)
-        super([pageref, :FitB])
-      end
-      
-    end
-    
-    #
-    # Class representing a Destination fitting horizontally the bouding box a Page.
-    #
-    class HorizontalBoudingBoxFit < Origami::Array
-      
-      include Destination
-      
-      #
-      # Creates a new horizontal bounding box fit Destination.
-      # _pageref_:: A Reference to a Page.
-      # _top_:: The vertical coord.
-      #
-      def initialize(pageref, top = 0)
-        
-        @top = top
-        super([pageref, :FitBH, top])
-        
-      end
-      
+        #
+        # Class representing a Destination zooming on a part of a document.
+        #
+        class Zoom < Destination
+
+            def initialize(array)
+                super(array)
+
+                @page, _, @left, @top, @zoom = array
+            end
+
+            #
+            # Creates a new zoom Destination.
+            # _page_:: The destination Page.
+            # _left_, _top_:: Coords in the Page.
+            # _zoom_:: Zoom factor.
+            #
+            def self.[](page, left: 0, top: 0, zoom: 0)
+                self.new([page, :XYZ, left, top, zoom])
+            end
+        end
+
+        def self.Zoom(page, left: 0, top: 0, zoom: 0)
+            Zoom[page, left: left, top: top, zoom: zoom]
+        end
+
+
+        #
+        # Class representing a Destination showing a Page globally.
+        #
+        class GlobalFit < Destination
+
+            def initialize(array)
+                super(array)
+
+                @page, _ = array
+            end
+
+            #
+            # Creates a new global fit Destination.
+            # _page_:: The destination Page.
+            #
+            def self.[](page)
+                self.new([page, :Fit])
+            end
+        end
+
+        def self.GlobalFit(page)
+            GlobalFit[page]
+        end
+
+        #
+        # Class representing a Destination fitting a Page horizontally.
+        #
+        class HorizontalFit < Destination
+
+            def initialize(array)
+                super(array)
+
+                @page, _, @top = array
+            end
+
+            #
+            # Creates a new horizontal fit destination.
+            # _page_:: The destination Page.
+            # _top_:: The vertical coord in the Page.
+            #
+            def self.[](page, top: 0)
+                self.new([page, :FitH, top])
+            end
+        end
+
+        def self.HorizontalFit(page, top: 0)
+            HorizontalFit[page, top: top]
+        end
+
+        #
+        # Class representing a Destination fitting a Page vertically.
+        # _page_:: The destination Page.
+        # _left_:: The horizontal coord in the Page.
+        #
+        class VerticalFit < Destination
+
+            def initialize(array)
+                super(array)
+
+                @page, _,  @left = array
+            end
+
+            def self.[](page, left: 0)
+                self.new([page, :FitV, left])
+            end
+        end
+
+        def self.VerticalFit(page, left: 0)
+            VerticalFit[page, left: left]
+        end
+
+        #
+        # Class representing a Destination fitting the view on a rectangle in a Page.
+        #
+        class RectangleFit < Destination
+
+            def initialize(array)
+                super(array)
+
+                @page, _, @left, @bottom, @right, @top = array
+            end
+
+            #
+            # Creates a new rectangle fit Destination.
+            # _page_:: The destination Page.
+            # _left_, _bottom_, _right_, _top_:: The rectangle to fit in.
+            #
+            def self.[](page, left: 0, bottom: 0, right: 0, top: 0)
+                self.new([pageref, :FitR, left, bottom, right, top])
+            end
+        end
+
+        def self.RectangleFit(page, left: 0, bottom: 0, right: 0, top: 0)
+            RectangleFit[page, left: left, bottom: bottom, right: right, top: top]
+        end
+
+        #
+        # Class representing a Destination fitting the bounding box of a Page.
+        #
+        class GlobalBoundingBoxFit < Destination
+
+            def initialize(array)
+                super(array)
+
+                @page, _, = array
+            end
+
+            #
+            # Creates a new bounding box fit Destination.
+            # _page_:: The destination Page.
+            #
+            def self.[](page)
+                self.new([page, :FitB])
+            end
+        end
+
+        def self.GlobalBoundingBoxFit(page)
+            GlobalBoundingBoxFit[page]
+        end
+
+        #
+        # Class representing a Destination fitting horizontally the bouding box a Page.
+        #
+        class HorizontalBoudingBoxFit < Destination
+
+            def initialize(array)
+                super(array)
+
+                @page, _, @top = array
+            end
+
+            #
+            # Creates a new horizontal bounding box fit Destination.
+            # _page_:: The destination Page.
+            # _top_:: The vertical coord.
+            #
+            def self.[](page, top: 0)
+                self.new([page, :FitBH, top])
+            end
+        end
+
+        def self.HorizontalBoudingBoxFit(page, top: 0)
+            HorizontalBoudingBoxFit[page, top: top]
+        end
+
+        #
+        # Class representing a Destination fitting vertically the bounding box of a Page.
+        #
+        class VerticalBoundingBoxFit < Destination
+
+            def initialize(array)
+                super(array)
+
+                @page, _, @left = array
+            end
+
+            #
+            # Creates a new vertical bounding box fit Destination.
+            # _page_:: The destination Page.
+            # _left_:: The horizontal coord.
+            #
+            def self.[](page, left: 0)
+                self.new([pageref, :FitBV, left])
+            end
+        end
+
+        def self.VerticalBoundingBoxFit(page, left: 0)
+            VerticalBoundingBoxFit[page, left: left]
+        end
     end
-    
+
     #
-    # Class representing a Destination fitting vertically the bounding box of a Page.
+    # This kind of Dictionary is used in named destinations.
     #
-    class VerticalBoundingBoxFit < Origami::Array
-      
-      include Destination
-      
-      #
-      # Creates a new vertical bounding box fit Destination.
-      # _pageref_:: A Reference to a Page.
-      # _left_:: The horizontal coord.
-      #
-      def initialize(pageref, left = 0)
-        
-        @left = left
-        super([pageref, :FitBV, left])
-      
-      end
-    
+    class DestinationDictionary < Dictionary
+        include StandardObject
+
+        field   :D,         :Type => Destination, :Required => true
     end
-    
-  end
 
 end