hexapdf 0.1.0

data/lib/hexapdf/font/true_type/table/maxp.rb

@@ -0,0 +1,112 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2016 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF 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 Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#++
+
+require 'hexapdf/font/true_type/table'
+
+module HexaPDF
+  module Font
+    module TrueType
+      class Table
+
+        # The 'maxp' (maximum profile) table contains the maxima for a number of parameters (e.g. to
+        # establish memory requirements).
+        #
+        # See: https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6maxp.html
+        class Maxp < Table
+
+          # The version of the table (a Rational).
+          attr_accessor :version
+
+          # The number of glyphs in the font.
+          attr_accessor :num_glyphs
+
+          # The maximum number of points in a non-compound glyph.
+          attr_accessor :max_points
+
+          # The maximum number of contours in a non-computed glyph.
+          attr_accessor :max_contours
+
+          # The maximum number of points in a compound glyph.
+          attr_accessor :max_component_points
+
+          # The maximum number of contours in a compound glyph.
+          attr_accessor :max_component_contours
+
+          # The maximum number of points used in Twilight Zone (Z0).
+          attr_accessor :max_twilight_points
+
+          # The maximum number of storage area locations.
+          attr_accessor :max_storage
+
+          # The maximum number of FDEFs (function definitions).
+          attr_accessor :max_function_defs
+
+          # The maximum number of IDEFs (instruction defintions).
+          attr_accessor :max_instruction_defs
+
+          # The maximum number of elements on the stack, i.e. the stack depth.
+          attr_accessor :max_stack_elements
+
+          # The maximum number of bytes for glyph instructions.
+          attr_accessor :max_size_of_instructions
+
+          # The maximum number of glyphs referenced at the top level.
+          attr_accessor :max_component_elements
+
+          # The levels of recursion (0 if the font has only simple glyphs).
+          attr_accessor :max_component_depth
+
+          private
+
+          def parse_table #:nodoc:
+            @version = read_fixed
+            @num_glyphs, @max_points, @max_contours, @max_component_points, @max_component_contours,
+              _unuse, @max_twilight_points, @max_storage, @max_function_defs, @max_instruction_defs,
+              @max_stack_elements, @max_size_of_instructions, @max_component_elements,
+              @max_component_depth = read_formatted(directory_entry.length - 4, 'n14')
+          end
+
+          def load_default #:nodoc:
+            @version = 1.to_r
+            @num_glyphs = @max_points = @max_contours = @max_component_points =
+              @max_component_contours = @max_twilight_points = @max_storage = @max_function_defs =
+              @max_instruction_defs = @max_stack_elements = @max_size_of_instructions =
+              @max_component_elements = @max_component_depth = 0
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/hexapdf/font/true_type/table/name.rb

@@ -0,0 +1,218 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2016 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF 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 Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#++
+
+require 'hexapdf/font/true_type/table'
+
+module HexaPDF
+  module Font
+    module TrueType
+      class Table
+
+        # The 'name' table contains the human-readable names for features, font names, style names,
+        # copyright notices and so on.
+        #
+        # See: https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6name.html
+        class Name < Table
+
+          # Table for mapping symbolic names to name_id codes.
+          NAME_MAP = {
+            copyright: 0,
+            font_family: 1,
+            font_subfamily: 2,
+            unique_subfamily: 3,
+            font_name: 4,
+            version: 5,
+            postscript_name: 6,
+            trademark: 7,
+            manufacturer: 8,
+            designer: 9,
+            description: 10,
+            vendor_url: 11,
+            designer_url: 12,
+            license: 13,
+            license_url: 14,
+            preferred_family: 16,
+            preferred_subfamily: 17,
+            compatible_full: 18,
+            sample_text: 19,
+            postscript_cid_name: 20,
+            wws_family: 21,
+            wws_subfamily: 22,
+          }
+
+          # Contains the information for a Name Record.
+          #
+          # The string value is converted to UTF-8 if possible, otherwise it stays in BINARY.
+          class Record < String
+
+            # Indicates Unicode version.
+            PLATFORM_UNICODE = 0
+
+            # QuickDraw Script Manager code for Macintosh.
+            PLATFORM_MACINTOSH = 1
+
+            # Microsoft encoding.
+            PLATFORM_MICROSOFT = 3
+
+            # The platform identifier code.
+            attr_reader :platform_id
+
+            # The platform specific encoding identified.
+            attr_reader :encoding_id
+
+            # The language identified.
+            attr_reader :language_id
+
+            # Create a new name record.
+            def initialize(text, pid, eid, lid)
+              @platform_id = pid
+              @encoding_id = eid
+              @language_id = lid
+
+              if platform?(:unicode) ||
+                  (platform?(:microsoft) && encoding_id == 1 || encoding_id == 10)
+                text.encode!(::Encoding::UTF_8, ::Encoding::UTF_16BE)
+              elsif platform?(:macintosh) && encoding_id == 0
+                text.encode!(::Encoding::UTF_8, ::Encoding::MACROMAN)
+              end
+
+              super(text)
+            end
+
+            # Returns +true+ if this record has the given platform identifier which can either be
+            # :unicode, :macintosh or :microsoft.
+            def platform?(identifier)
+              platform_id == case identifier
+                             when :unicode then PLATFORM_UNICODE
+                             when :macintosh then PLATFORM_MACINTOSH
+                             when :microsoft then PLATFORM_MICROSOFT
+                             else
+                               raise ArgumentError, "Unknown platform identifier: #{identifier}"
+                             end
+            end
+
+            # Returns +true+ if this record is a "preferred" one.
+            #
+            # The label "preferred" is set on a name if it represents the US English version of the
+            # name in a decodable encoding:
+            # * platform_id :macintosh, encoding_id 0 (Roman) and language_id 0 (English); or
+            # * platform_id :microsoft, encoding_id 1 (Unicode) and language_id 1033 (US English).
+            def preferred?
+              (platform_id == PLATFORM_MACINTOSH && encoding_id == 0 && language_id == 0) ||
+                (platform_id == PLATFORM_MICROSOFT && encoding_id == 1 && language_id == 1033)
+            end
+
+          end
+
+
+          # Holds records for the same name type (e.g. :font_name, :postscript_name, ...).
+          class Records < Array
+
+            # Returns the preferred record in this collection.
+            #
+            # This is either the first record where Record#preferred? is true or else just the first
+            # record in the collection.
+            def preferred_record
+              find(&:preferred?) || self[0]
+            end
+
+          end
+
+
+          # The format of the table.
+          attr_accessor :format
+
+          # The name records.
+          attr_accessor :records
+
+          # The mapping of language IDs starting from 0x8000 to language tags conforming to IETF BCP
+          # 47.
+          attr_accessor :language_tags
+
+          # Returns an array with all available entries for the given name identifier (either a
+          # symbol or an ID).
+          #
+          # See: NAME_MAP
+          def [](name_or_id)
+            @records[name_or_id.kind_of?(Symbol) ? NAME_MAP[name_or_id] : name_or_id]
+          end
+
+          # Adds a new record for the given name identifier (either a symbol or an ID).
+          #
+          # The optional platform, encoding and language IDs are preset to represent the text as
+          # English in Mac Roman encoding.
+          def add(name_or_id, text, platform_id: 1, encoding_id: 0, language_id: 0)
+            self[name_or_id] << Record.new(text, platform_id, encoding_id, language_id)
+          end
+
+          private
+
+          def parse_table #:nodoc:
+            @format, count, string_offset = read_formatted(6, 'n3')
+            string_offset += directory_entry.offset
+
+            @records = Hash.new {|h, k| h[k] = Records.new}
+            @language_tags = {}
+
+            record_rows = count.times.map { read_formatted(12, 'n6') }
+            if @format == 1
+              count = read_formatted(2, 'n').first
+              language_rows = count.times.map { read_formatted(4, 'n2') }
+            end
+
+            record_rows.each do |pid, eid, lid, nid, length, offset|
+              io.pos = string_offset + offset
+              @records[nid] << Record.new(io.read(length), pid, eid, lid)
+            end
+
+            if @format == 1
+              language_rows.each_with_index do |(length, offset), index|
+                io.pos = string_offset + offset
+                @language_tags[0x8000 + index] =
+                  io.read(length).encode!(::Encoding::UTF_8, ::Encoding::UTF_16BE)
+              end
+            end
+          end
+
+          def load_default #:nodoc:
+            @format = 0
+            @records = Hash.new {|h, k| h[k] = Records.new}
+            @language_tags = {}
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/hexapdf/font/true_type/table/os2.rb

@@ -0,0 +1,200 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2016 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF 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 Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#++
+
+require 'hexapdf/font/true_type/table'
+require 'hexapdf/utils/bit_field'
+
+module HexaPDF
+  module Font
+    module TrueType
+      class Table
+
+        # The 'OS/2' table contains information required by Windows.
+        #
+        # Some attributes may be +nil+ when read from a file depending on the version of the table.
+        #
+        # See: https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6OS2.html
+        class OS2 < Table
+          extend HexaPDF::Utils::BitField
+
+          # The version of the table.
+          attr_accessor :version
+
+          # AVerage weighted advance width of lower case letters and space.
+          attr_accessor :x_avg_char_width
+
+          # Visual weight of stroke in glyphs.
+          attr_accessor :weight_class
+
+          # Relative change from the normal aspect ratio (width/height).
+          attr_accessor :width_class
+
+          # Characteristics and properties of this font.
+          attr_accessor :type
+          bit_field(:type, restricted_license_embedding: 1, preview_and_print_embedding: 2,
+                    editable_embedding: 3, no_subsetting: 8, bitmap_embedding_only: 9)
+
+          # Recommended horizontal size in pixels for subscripts
+          attr_accessor :subscript_x_size
+
+          # Recommended vertical size in pixels for subscripts
+          attr_accessor :subscript_y_size
+
+          # Recommended horizontal offset for subscripts.
+          attr_accessor :subscript_x_offset
+
+          # Recommended vertical offset from the baseline for subscripts.
+          attr_accessor :subscript_y_offset
+
+          # Recommended horizontal size in pixels for superscripts
+          attr_accessor :superscript_x_size
+
+          # Recommended vertical size in pixels for superscripts
+          attr_accessor :superscript_y_size
+
+          # Recommended horizontal offset for superscripts.
+          attr_accessor :superscript_x_offset
+
+          # Recommended vertical offset from the baseline for superscripts.
+          attr_accessor :superscript_y_offset
+
+          # Width of the strikeout stroke.
+          attr_accessor :strikeout_size
+
+          # Position of the strikeout stroke relative to the baseline.
+          attr_accessor :strikeout_position
+
+          # Classification of the font-family design.
+          attr_accessor :family_class
+
+          # Describes the visual characteristics of the given typeface.
+          attr_accessor :panose
+
+          # Describes the Unicode ranges covered by the font.
+          attr_accessor :unicode_range
+
+          # The four character identifier of the font vendor.
+          attr_accessor :vendor_id
+
+          # Information concerning the nature of the font patterns.
+          attr_accessor :selection
+          bit_field(:selection, italic: 0, underscore: 1, negative: 2, outlined: 3, strikeout: 4,
+                    bold: 5, regular: 6, use_typo_metrics: 7, wws: 8, oblique: 9)
+
+          # The minimum Unicode index in this font.
+          attr_accessor :first_char_index
+
+          # The maximum Unicode index in this font.
+          attr_accessor :last_char_index
+
+          # The typographic ascender. May not be the same as the ascender in the 'hhea' table.
+          attr_accessor :typo_ascender
+
+          # The typographic descender. May not be the same as the ascender in the 'hhea' table.
+          attr_accessor :typo_descender
+
+          # The typographic line gap. May not be the same as the ascender in the 'hhea' table.
+          attr_accessor :typo_line_gap
+
+          # The ascender metric for Windows.
+          attr_accessor :win_ascent
+
+          # The descender metric for Windows.
+          attr_accessor :win_descent
+
+          # The code page character range.
+          attr_accessor :code_page_range
+
+          # The distance between the baseline and the approximate height of non-ascending lowercase
+          # letters.
+          attr_accessor :x_height
+
+          # The distance between the baseline and the approximate height of uppercase letters.
+          attr_accessor :cap_height
+
+          # The default character displayed by Windows to represent an unsupported character.
+          attr_accessor :default_char
+
+          # The break character used by Windows.
+          attr_accessor :break_char
+
+          # The maximum length of an OpenType context for any feature in this font.
+          attr_accessor :max_context
+
+          # The lowest size at which the font starts to be used.
+          attr_accessor :lower_point_size
+
+          # The highest size at which the font starts to be used.
+          attr_accessor :upper_point_size
+
+          private
+
+          def parse_table #:nodoc:
+            @version, @x_avg_char_width, @weight_class, @width_class, @type, @subscript_x_size,
+              @subscript_y_size, @subscript_x_offset, @subscript_y_offset, @superscript_x_size,
+              @superscript_y_size, @superscript_x_offset, @superscript_y_offset, @strikeout_size,
+              @strikeout_position, @family_class, @panose =
+              read_formatted(42, 'ns>n2s>12a10')
+
+            @weight_class *= 100 if @weight_class < 100 # Normalize to standard weights
+
+            @unicode_range, temp = read_formatted(16, 'Q>2')
+            @unicode_range = @unicode_range << 64 & temp
+
+            @vendor_id, @selection,
+              @first_char_index, @last_char_index, @typo_ascender, @typo_descender, @typo_line_gap,
+              @win_ascent, @win_descent, @code_page_range, @x_height, @cap_height, @default_char,
+              @break_char, @max_context, @lower_point_size, @upper_point_size =
+              read_formatted(directory_entry.length - 58, 'a4n3s>3n2Q>s>2n5')
+          end
+
+          def load_default #:nodoc:
+            @version = 5
+            @panose = ''.b
+            @vendor_id = '    '.b
+            @x_avg_char_width = @weight_class = @width_class = @type = @subscript_x_size =
+              @subscript_y_size = @subscript_x_offset = @subscript_y_offset = @superscript_x_size =
+              @superscript_y_size = @superscript_x_offset = @superscript_y_offset =
+              @strikeout_size = @strikeout_position = @family_class = @unicode_range = @selection =
+              @first_char_index = @last_char_index = @typo_ascender = @typo_descender =
+              @typo_line_gap = @win_ascent = @win_descent = @code_page_range = @x_height =
+              @cap_height = @default_char = @break_char = @max_context = @lower_point_size =
+              @upper_point_size  = 0
+          end
+
+        end
+
+      end
+    end
+  end
+end