hexapdf 0.17.2 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71e5d38f8a3d1a6b4371e5f8e2f991d36c0ea8c01ca5dc4ec1e132043fad00aa
-  data.tar.gz: cf78ef5b6fa915bac30fe75157fc414148c8bd2b8c5c7ee10fe4bb3cbf70076a
+  metadata.gz: 496c87d6cffcfde7b155fbfcdd78673fb34931d4d0fd997bcee934decfba175d
+  data.tar.gz: ce72598c9d33735c6ea4738c072b1f00202dc7bac24577c9c27a062add38ea8e
 SHA512:
-  metadata.gz: 2153a1c0eadc0ca940480502b42780717e2777416f1e85e1c9506b879e01df0b2bc4e6d838ecd140af4a62e93bd16aa08ab42bbf522f6bbd234c0d9da82e4115
-  data.tar.gz: e91b860ece2751633350739852b392719d9d09cb1bdd9e1c1896ef76e5828db9d2d0f9204b93521efbd6e5dcefc84b0451984392c2a4de3703a6060def1f5c75
+  metadata.gz: cee5a6f86084490ba5602c40ec48945b9a3c0bdecb22fe03e2d7b8b6ad02c791900f9fd7354557a9ac3dfdebb4a8d95c7335fc329c0054156082853f33717144
+  data.tar.gz: eaed67cce68e703eddbbb357e790a9f0bc62083ff8ba0b0856aa360d499f75e0e022b1ccd41ebcdd53e2fe269a93b5f587c47db41311c3f6a0beb9ed293e02cd

data/CHANGELOG.md

@@ -1,3 +1,70 @@
+## 0.19.1 - 2021-12-12
+
+### Added
+
+* [HexaPDF::Type::FontType3#bounding_box] to fix content stream processing error
+
+### Fixed
+
+* Calculation of scaled font size for [HexaPDF::Content::GraphicsState] and
+  [HexaPDF::Layout::Style] when Type3 fonts are used
+
+
+## 0.19.0 - 2021-11-24
+
+### Added
+
+* Page resource pruning to the optimization task
+* An option for page resources pruning to the optimization options of the
+  `hexapdf` command
+
+### Fixed
+
+* Handling of invalid date strings with a minute time zone offset greater than
+  59
+
+
+## 0.18.0 - 2021-11-04
+
+### Added
+
+* [HexaPDF::Content::ColorSpace::serialize_device_color] for serialization of
+  device colors in parts other than the canvas
+* [HexaPDF::Type::AcroForm::VariableTextField::create_appearance_string] for
+  centralized creation of appearance strings
+* [HexaPDF::Object::make_direct] for making objects and all parts of them direct
+  instead of indirect
+
+### Changed
+
+* [HexaPDF::Type::AcroForm::VariableTextField::parse_appearance_string] to also
+  return the font color
+* [HexaPDF::Type::AcroForm::VariableTextField#set_default_appearance_string] to
+  allow specifying the font color
+* [HexaPDF::Type::AcroForm::Form] methods to support new variable text field
+  methods
+* [HexaPDF::Type::AcroForm::AppearanceGenerator] to support the set font color
+  when creating text field appearances
+
+### Fixed
+
+* Writing of existing, encrypted PDF files where parts of the encryption
+  dictionary are indirect objects
+* [HexaPDF::Content::GraphicObject::EndpointArc] to correctly determine the
+  start and end points
+* HexaPDF::Dictionary#perform_validation to correctly handle objects that
+  should not be indirect objects
+
+
+## 0.17.3 - 2021-10-31
+
+### Fixed
+
+* Reconstruction of invalid PDF files where the PDF header is not at the start
+  of the file
+* Reconstruction of invalid PDF files where the first object is invalid
+
+
 ## 0.17.2 - 2021-10-26
 
 ### Fixed

data/lib/hexapdf/cli/command.rb

@@ -66,6 +66,7 @@ module HexaPDF
         @out_options.xref_streams = :preserve
         @out_options.streams = :preserve
         @out_options.optimize_fonts = false
+        @out_options.prune_page_resources = false
 
         @out_options.encryption = :preserve
         @out_options.enc_user_pwd = @out_options.enc_owner_pwd = nil
@@ -169,6 +170,10 @@ module HexaPDF
                    "time; default: #{@out_options.compress_pages})") do |c|
           @out_options.compress_pages = c
         end
+        options.on("--[no-]prune-page-resources", "Prunes unused objects from the page resources " \
+                   "(may take a long time; default: #{@out_options.prune_page_resources})") do |c|
+          @out_options.prune_page_resources = c
+        end
         options.on("--[no-]optimize-fonts", "Optimize embedded font files; " \
                    "default: #{@out_options.optimize_fonts})") do |o|
           @out_options.optimize_fonts = o
@@ -236,7 +241,8 @@ module HexaPDF
         doc.task(:optimize, compact: @out_options.compact,
                  object_streams: @out_options.object_streams,
                  xref_streams: @out_options.xref_streams,
-                 compress_pages: @out_options.compress_pages)
+                 compress_pages: @out_options.compress_pages,
+                 prune_page_resources: @out_options.prune_page_resources)
         if @out_options.streams != :preserve || @out_options.optimize_fonts
           doc.each(only_current: false) do |obj|
             optimize_stream(obj)

data/lib/hexapdf/content/canvas.rb

@@ -589,7 +589,7 @@ module HexaPDF
       #
       # The line cap style specifies how the ends of stroked open paths should look like.
       #
-      # The +style+ parameter can be one of:
+      # The +style+ parameter can be one of (also see LineCapStyle):
       #
       # :butt or 0::
       #     Stroke is squared off at the endpoint of a path.
@@ -641,7 +641,7 @@ module HexaPDF
       #
       # The line join style specifies the shape that is used at the corners of stroked paths.
       #
-      # The +style+ parameter can be one of:
+      # The +style+ parameter can be one of (also see LineJoinStyle):
       #
       # :miter or 0::
       #     The outer lines of the two segments continue until the meet at an angle.

data/lib/hexapdf/content/color_space.rb

@@ -35,7 +35,9 @@
 #++
 
 require 'hexapdf/error'
+require 'hexapdf/content'
 require 'hexapdf/configuration'
+require 'hexapdf/serializer'
 
 module HexaPDF
   module Content
@@ -304,6 +306,23 @@ module HexaPDF
         GlobalConfiguration.constantize('color_space.map', for_components(spec)).new.color(*spec)
       end
 
+      # Serializes the given device color into the form expected by PDF content streams.
+      #
+      # The +type+ argument can either be :stroke to serialize as stroke color operator or :fill as
+      # fill color operator.
+      def self.serialize_device_color(color, type: :fill)
+        operator = case color.color_space.family
+                   when :DeviceRGB then :rg
+                   when :DeviceGray then :g
+                   when :DeviceCMYK then :k
+                   else
+                     raise ArgumentError, "Device color object expected, got #{color.class}"
+                   end
+        operator = operator.upcase if type == :stroke
+        Content::Operator::DEFAULT_OPERATORS[operator].
+          serialize(HexaPDF::Serializer.new, *color.components)
+      end
+
       # Returns a device color object for the given components array without applying value
       # normalization.
       def self.prenormalized_device_color(components)

data/lib/hexapdf/content/graphic_object/arc.rb

@@ -51,8 +51,8 @@ module HexaPDF
       # Examples:
       #
       #   #>pdf-center
-      #   arc = canvas.graphic_object(:arc, a: 100, b: 50).stroke
-      #   arc.draw(canvas).stroke    # or: canvas.draw(arc).stroke
+      #   arc = canvas.graphic_object(:arc, a: 100, b: 50, end_angle: 150)
+      #   canvas.draw(arc).stroke
       #
       # See: ELL - https://spaceroots.org/documents/ellipse/elliptical-arc.pdf
       class Arc

data/lib/hexapdf/content/graphic_object/endpoint_arc.rb

@@ -49,8 +49,8 @@ module HexaPDF
       # Examples:
       #
       #   #>pdf-center
-      #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 10).stroke
-      #   arc.move_to(0, 0).draw(canvas).stroke    # or: canvas.draw(arc).stroke
+      #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 10)
+      #   canvas.move_to(0, 0).draw(arc).stroke
       #
       # See: GraphicObject::Arc, ARC - https://www.w3.org/TR/SVG/implnote.html#ArcImplementationNotes
       class EndpointArc
@@ -251,10 +251,10 @@ module HexaPDF
           cy = sin_theta * cxp + cos_theta * cyp + (y1 + y2) / 2.0
 
           # F.6.5.5
-          start_angle = compute_angle_to_x_axis((x1p - cxp) / rx, (y1p - cyp) / ry)
+          start_angle = compute_angle_to_x_axis((x1p - cxp), (y1p - cyp)) % 360
 
           # F.6.5.6 (modified bc we just need the end angle)
-          end_angle = compute_angle_to_x_axis((-x1p - cxp) / rx, (-y1p - cyp) / ry)
+          end_angle = compute_angle_to_x_axis((-x1p - cxp), (-y1p - cyp)) % 360
 
           {cx: cx, cy: cy, a: rx, b: ry, start_angle: start_angle, end_angle: end_angle,
            inclination: @inclination, clockwise: @clockwise}

data/lib/hexapdf/content/graphic_object/solid_arc.rb

@@ -41,20 +41,45 @@ module HexaPDF
       # This graphic object represents a solid elliptical arc, i.e. an arc that has an inner and
       # an outer set of a/b values.
       #
+      # This graphic object is registered under the :solid_arc key for use with the
+      # HexaPDF::Content::Canvas class.
+      #
       # Thus it can be used to create
       #
-      # * an (elliptical) disk (when the inner a/b are zero and the difference between start and
+      # * an (*elliptical*) *disk* (when the inner a/b are zero and the difference between start and
       #   end angles is greater than or equal to 360),
       #
-      # * an (elliptical) sector (when the inner a/b are zero and the difference between start
+      #     #>pdf-center
+      #     canvas.fill_color("red").
+      #       draw(:solid_arc, outer_a: 80, outer_b: 50, end_angle: 360).
+      #       fill_stroke
+      #
+      # * an (*elliptical*) *sector* (when the inner a/b are zero and the difference between start
       #   and end angles is less than 360),
       #
-      # * an (elliptical) annulus (when the inner a/b are nonzero and the difference between
+      #     #>pdf-center
+      #     canvas.fill_color("red").
+      #       draw(:solid_arc, outer_a: 80, outer_b: 50, start_angle: 20, end_angle: 230).
+      #       fill_stroke
+      #
+      # * an (*elliptical*) *annulus* (when the inner a/b are nonzero and the difference between
       #   start and end angles is greater than or equal to 360), and
       #
-      # * an (elliptical) annular sector (when the inner a/b are nonzero and the difference
+      #     #>pdf-center
+      #     canvas.fill_color("red").
+      #       draw(:solid_arc, outer_a: 80, outer_b: 50, inner_a: 70, inner_b: 30,
+      #            end_angle: 360).
+      #       fill_stroke
+      #
+      # * an (*elliptical*) *annular sector* (when the inner a/b are nonzero and the difference
       #   between start and end angles is less than 360)
       #
+      #     #>pdf-center
+      #     canvas.fill_color("red").
+      #       draw(:solid_arc, outer_a: 80, outer_b: 50, inner_a: 70, inner_b: 30,
+      #            start_angle: 20, end_angle: 230).
+      #       fill_stroke
+      #
       # See: Arc
       class SolidArc
 
@@ -66,30 +91,106 @@ module HexaPDF
         end
 
         # x-coordinate of center point
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
+        #   canvas.stroke_color("red").draw(solid_arc, cx: 50).stroke
         attr_reader :cx
 
         # y-coordinate of center point
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
+        #   canvas.stroke_color("red").draw(solid_arc, cy: 50).stroke
         attr_reader :cy
 
-        # Length of inner semi-major axis
+        # Length of inner semi-major axis which (without altering the #inclination) is parallel to
+        # the x-axis
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
+        #   canvas.stroke_color("red").draw(solid_arc, inner_a: 5).stroke
         attr_reader :inner_a
 
-        # Length of inner semi-minor axis
+        # Length of inner semi-minor axis which (without altering the #inclination) is parallel to the
+        # y-axis
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
+        #   canvas.stroke_color("red").draw(solid_arc, inner_b: 20).stroke
         attr_reader :inner_b
 
-        # Length of outer semi-major axis
+        # Length of outer semi-major axis which (without altering the #inclination) is parallel to
+        # the x-axis
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
+        #   canvas.stroke_color("red").draw(solid_arc, outer_a: 45).stroke
         attr_reader :outer_a
 
-        # Length of outer semi-minor axis
+        # Length of outer semi-minor axis which (without altering the #inclination) is parallel to the
+        # y-axis
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
+        #   canvas.stroke_color("red").draw(solid_arc, outer_b: 40).stroke
         attr_reader :outer_b
 
-        # Start angle in degrees
+        # Start angle of the solid arc in degrees
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
+        #   canvas.stroke_color("red").draw(solid_arc, start_angle: 60).stroke
         attr_reader :start_angle
 
-        # End angle in degrees
+        # End angle  of the solid arc in degrees
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
+        #   canvas.stroke_color("red").draw(solid_arc, end_angle: 120).stroke
         attr_reader :end_angle
 
         # Inclination in degrees of semi-major axis in respect to x-axis
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   solid_arc = canvas.graphic_object(:solid_arc, outer_a: 30, outer_b: 20,
+        #                                     inner_a: 20, inner_b: 10)
+        #   canvas.draw(solid_arc).stroke
+        #   canvas.stroke_color("red").draw(solid_arc, inclination: 40).stroke
         attr_reader :inclination
 
         # Creates a solid arc with default values (a unit disk at the origin).

data/lib/hexapdf/content/graphics_state.rb

@@ -73,7 +73,7 @@ module HexaPDF
     end
 
     # Defines all available line cap styles as constants. Each line cap style is an instance of
-    # NamedValue. For use with Content::GraphicsState#line_cap_style.
+    # NamedValue, see ::normalize. For use with e.g. Content::Canvas#line_cap_style.
     #
     # See: PDF1.7 s8.4.3.3
     module LineCapStyle
@@ -95,18 +95,39 @@ module HexaPDF
       end
 
       # Stroke is squared off at the endpoint of a path.
+      #
+      # Specify as 0 or :butt.
+      #
+      #   #>pdf-small-hide
+      #   canvas.line_cap_style(:butt)
+      #   canvas.line_width(10).line(50, 20, 50, 80).stroke
+      #   canvas.stroke_color("white").line_width(1).line(50, 20, 50, 80).stroke
       BUTT_CAP = NamedValue.new(:butt, 0)
 
       # A semicircular arc is drawn at the endpoint of a path.
+      #
+      # Specify as 1 or :round.
+      #
+      #   #>pdf-small-hide
+      #   canvas.line_cap_style(:round)
+      #   canvas.line_width(10).line(50, 20, 50, 80).stroke
+      #   canvas.stroke_color("white").line_width(1).line(50, 20, 50, 80).stroke
       ROUND_CAP = NamedValue.new(:round, 1)
 
       # The stroke continues half the line width beyond the endpoint of a path.
+      #
+      # Specify as 2 or :projecting_square.
+      #
+      #   #>pdf-small-hide
+      #   canvas.line_cap_style(:projecting_square)
+      #   canvas.line_width(10).line(50, 20, 50, 80).stroke
+      #   canvas.stroke_color("white").line_width(1).line(50, 20, 50, 80).stroke
       PROJECTING_SQUARE_CAP = NamedValue.new(:projecting_square, 2)
 
     end
 
     # Defines all available line join styles as constants. Each line join style is an instance of
-    # NamedValue. For use with Content::GraphicsState#line_join_style.
+    # NamedValue, see ::normalize For use with e.g. Content::Canvas#line_join_style.
     #
     # See: PDF1.7 s8.4.3.4
     module LineJoinStyle
@@ -127,20 +148,47 @@ module HexaPDF
         end
       end
 
-      # The outer lines of the two segments continue until the meet at an angle.
+      # The outer lines of the two segments continue until they meet at an angle.
+      #
+      # Specify as 0 or :miter.
+      #
+      #   #>pdf-small-hide
+      #   canvas.line_join_style(:miter)
+      #   canvas.line_width(10).
+      #     polyline(20, 20, 50, 80, 80, 20).stroke
+      #   canvas.stroke_color("white").line_width(1).line_join_style(:bevel).
+      #     polyline(20, 20, 50, 80, 80, 20).stroke
       MITER_JOIN = NamedValue.new(:miter, 0)
 
       # An arc of a circle is drawn around the point where the segments meet.
+      #
+      # Specify as 1 or :round.
+      #
+      #   #>pdf-small-hide
+      #   canvas.line_join_style(:round)
+      #   canvas.line_width(10).
+      #     polyline(20, 20, 50, 80, 80, 20).stroke
+      #   canvas.stroke_color("white").line_width(1).line_join_style(:bevel).
+      #     polyline(20, 20, 50, 80, 80, 20).stroke
       ROUND_JOIN = NamedValue.new(:round, 1)
 
-      # The two segments are finished with butt caps and the space between the ends is filled with
-      # a triangle.
+      # The two segments are finished with butt caps and the space between the ends is filled with a
+      # triangle.
+      #
+      # Specify as 2 or :bevel.
+      #
+      #   #>pdf-small-hide
+      #   canvas.line_join_style(:bevel)
+      #   canvas.line_width(10).
+      #     polyline(20, 20, 50, 80, 80, 20).stroke
+      #   canvas.stroke_color("white").line_width(1).line_join_style(:bevel).
+      #     polyline(20, 20, 50, 80, 80, 20).stroke
       BEVEL_JOIN = NamedValue.new(:bevel, 2)
 
     end
 
-    # The line dash pattern defines how a line should be dashed. For use with
-    # Content::GraphicsState#line_dash_pattern.
+    # The line dash pattern defines how a line should be dashed. For use with e.g.
+    # Content::Canvas#line_dash_pattern.
     #
     # A dash pattern consists of two parts: the dash array and the dash phase. The dash array
     # defines the length of alternating dashes and gaps (important: starting with dashes). And the
@@ -159,6 +207,12 @@ module HexaPDF
     # See: PDF1.7 s8.4.3.6
     class LineDashPattern
 
+      # :call-seq:
+      #   LineDashPattern.normalize(line_dash_pattern)         -> line_dash_pattern
+      #   LineDashPattern.normalize(array, phase = 0)          -> LineDashPattern.new(array, phase)
+      #   LineDashPattern.normalize(number, phase = 0)         -> LineDashPattern.new([number], phase)
+      #   LineDashPattern.normalize(0)                         -> LineDashPattern.new
+      #
       # Returns the arguments normalized to a valid LineDashPattern instance.
       #
       # If +array+ is 0, the default line dash pattern representing a solid line will be used. If it
@@ -206,8 +260,8 @@ module HexaPDF
 
     end
 
-    # Defines all available rendering intents as constants. For use with
-    # Content::GraphicsState#rendering_intent.
+    # Defines all available rendering intents as constants. For use with e.g.
+    # Content::Canvas#rendering_intent.
     #
     # See: PDF1.7 s8.6.5.8
     module RenderingIntent
@@ -241,7 +295,7 @@ module HexaPDF
     end
 
     # Defines all available text rendering modes as constants. Each text rendering mode is an
-    # instance of NamedValue. For use with Content::GraphicsState#text_rendering_mode.
+    # instance of NamedValue. For use with e.g. Content::Canvas#text_rendering_mode.
     #
     # See: PDF1.7 s9.3.6
     module TextRenderingMode
@@ -272,28 +326,97 @@ module HexaPDF
         end
       end
 
-      # Fill text
+      # Fill text.
+      #
+      # Specify as 0 or :fill.
+      #
+      #   #>pdf-small-hide
+      #   canvas.font("Helvetica", size: 13)
+      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.text_rendering_mode(:fill)
+      #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
       FILL = NamedValue.new(:fill, 0)
 
-      # Stroke text
+      # Stroke text.
+      #
+      # Specify as 1 or :stroke.
+      #
+      #   #>pdf-small-hide
+      #   canvas.font("Helvetica", size: 13)
+      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.text_rendering_mode(:stroke)
+      #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
       STROKE = NamedValue.new(:stroke, 1)
 
-      # Fill, then stroke text
+      # Fill, then stroke text.
+      #
+      # Specify as 2 or :fill_stroke.
+      #
+      #   #>pdf-small-hide
+      #   canvas.font("Helvetica", size: 13)
+      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.text_rendering_mode(:fill_stroke)
+      #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
       FILL_STROKE = NamedValue.new(:fill_stroke, 2)
 
-      # Neither fill nor stroke text (invisible)
+      # Neither fill nor stroke text (invisible).
+      #
+      # Specify as 3 or :invisible.
+      #
+      #   #>pdf-small-hide
+      #   canvas.font("Helvetica", size: 13)
+      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.text_rendering_mode(:invisible)
+      #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
+      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
       INVISIBLE = NamedValue.new(:invisible, 3)
 
-      # Fill text and add to path for clipping
+      # Fill text and add to path for clipping.
+      #
+      # Specify as 4 or :fill_clip.
+      #
+      #   #>pdf-small-hide
+      #   canvas.font("Helvetica", size: 13)
+      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.text_rendering_mode(:fill_clip)
+      #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
+      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
       FILL_CLIP = NamedValue.new(:fill_clip, 4)
 
-      # Stroke text and add to path for clipping
+      # Stroke text and add to path for clipping.
+      #
+      # Specify as 5 or :stroke_clip.
+      #
+      #   #>pdf-small-hide
+      #   canvas.font("Helvetica", size: 13)
+      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.text_rendering_mode(:stroke_clip)
+      #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
+      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
       STROKE_CLIP = NamedValue.new(:stroke_clip, 5)
 
-      # Fill, then stroke text and add to path for clipping
+      # Fill, then stroke text and add to path for clipping.
+      #
+      # Specify as 6 or :fill_stroke_clip.
+      #
+      #   #>pdf-small-hide
+      #   canvas.font("Helvetica", size: 13)
+      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.text_rendering_mode(:fill_stroke_clip)
+      #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
+      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
       FILL_STROKE_CLIP = NamedValue.new(:fill_stroke_clip, 6)
 
-      # Add text to path for clipping
+      # Add text to path for clipping.
+      #
+      # Specify as 7 or :clip.
+      #
+      #   #>pdf-small-hide
+      #   canvas.font("Helvetica", size: 13)
+      #   canvas.stroke_color("green").line_width(0.5)
+      #   canvas.text_rendering_mode(:clip)
+      #   canvas.text("#{canvas.text_rendering_mode.name}", at: [10, 50])
+      #   canvas.stroke_color("red").line_width(20).line(30, 20, 30, 80).stroke
       CLIP = NamedValue.new(:clip, 7)
 
     end
@@ -389,7 +512,7 @@ module HexaPDF
       attr_accessor :leading
 
       # The font for the text.
-      attr_accessor :font
+      attr_reader :font
 
       # The font size.
       attr_reader :font_size
@@ -415,23 +538,25 @@ module HexaPDF
 
       # The scaled character spacing used in glyph displacement calculations.
       #
-      # This returns the value T_c multiplied by #scaled_horizontal_scaling.
+      # This returns the character spacing multiplied by #scaled_horizontal_scaling.
       #
       # See PDF1.7 s9.4.4
       attr_reader :scaled_character_spacing
 
       # The scaled word spacing used in glyph displacement calculations.
       #
-      # This returns the value T_w  multiplied by #scaled_horizontal_scaling.
+      # This returns the word spacing  multiplied by #scaled_horizontal_scaling.
       #
       # See PDF1.7 s9.4.4
       attr_reader :scaled_word_spacing
 
       # The scaled font size used in glyph displacement calculations.
       #
-      # This returns the value T_fs / 1000 multiplied by #scaled_horizontal_scaling.
+      # This returns the font size multiplied by the scaling factor from glyph space to text space
+      # (0.001 for all fonts except Type3 fonts or the scaling specified in /FontMatrix for Type3
+      # fonts) and multiplied by #scaled_horizontal_scaling.
       #
-      # See PDF1.7 s9.4.4
+      # See PDF1.7 s9.4.4, HexaPDF::Type::FontType3
       attr_reader :scaled_font_size
 
       # The scaled horizontal scaling used in glyph displacement calculations.
@@ -542,6 +667,15 @@ module HexaPDF
         self.fill_color = color_space.default_color
       end
 
+      ##
+      # :attr_writer: font
+      #
+      # Sets the font and updates the glyph space to text space scaling.
+      def font=(font)
+        @font = font
+        update_scaled_font_size
+      end
+
       ##
       # :attr_writer: character_spacing
       #
@@ -566,7 +700,7 @@ module HexaPDF
       # Sets the font size and updates the scaled font size.
       def font_size=(size)
         @font_size = size
-        @scaled_font_size = size / 1000.0 * @scaled_horizontal_scaling
+        update_scaled_font_size
       end
 
       ##
@@ -579,7 +713,15 @@ module HexaPDF
         @scaled_horizontal_scaling = scaling / 100.0
         @scaled_character_spacing = @character_spacing * @scaled_horizontal_scaling
         @scaled_word_spacing = @word_spacing * @scaled_horizontal_scaling
-        @scaled_font_size = @font_size / 1000.0 * @scaled_horizontal_scaling
+        update_scaled_font_size
+      end
+
+      private
+
+      # Updates the cached value for the scaled font size.
+      def update_scaled_font_size
+        @scaled_font_size = @font_size * (@font&.glyph_scaling_factor || 0.001) *
+          @scaled_horizontal_scaling
       end
 
     end