# -*- encoding: utf-8; frozen_string_literal: true -*-
#
#--
# This file is part of HexaPDF.
#
# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
# Copyright (C) 2014-2024 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.
#
# If the GNU Affero General Public License doesn't fit your need,
# commercial licenses are available at <https://gettalong.at/hexapdf/>.
#++

require 'hexapdf/font/true_type_wrapper'

module HexaPDF
  module FontLoader

    # This module interprets the font name either as file name and tries to load it, or as TrueType
    # font object to be wrapped directly.
    module FromFile

      # :call-seq:
      #   FromFile.call(document, file_name, subset: true, **)           -> wrapped_font
      #   FromFile.call(document, font_object, subset: true, **)    -> wrapped_font
      #
      # Returns an appropriate font wrapper for the given file name or TrueType font object.
      #
      # If a file name is given, the file object representing the font file is *not* closed and if
      # needed must be closed by the caller once the font is not needed anymore.
      #
      # The first form using a file name is easier to use in one-off cases. However, if multiple
      # documents always refer to the same font, the second form is better to avoid re-parsing the
      # font file.
      #
      # +document+::
      #     The PDF document to associate the font wrapper with.
      #
      # +file_name+/+font_object+::
      #     The file name or a HexaPDF::Font::TrueType::Font object.
      #
      # +subset+::
      #     Specifies whether the font should be subset if possible.
      def self.call(document, name, subset: true, **)
        is_font = name.kind_of?(HexaPDF::Font::TrueType::Font)
        return nil unless is_font || File.file?(name)

        font = is_font ? name : HexaPDF::Font::TrueType::Font.new(File.open(name, 'rb'))
        HexaPDF::Font::TrueTypeWrapper.new(document, font, subset: subset)
      end

    end

  end
end