# -*- 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-2025 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/type/annotations'

module HexaPDF
  module Type
    module Annotations

      # This is the base class for the polygon and polyline markup annotations which display either
      # a closed polygon or a polyline inside the annotation rectangle.
      #
      # The styling is done through methods included by various modules:
      #
      # * Changing the line width, line dash pattern and color is done using the method
      #   BorderStyling#border_style.  While that method allows special styling of the line (like
      #   :beveled), only a simple line dash pattern is supported.
      #
      # * The border effect can be changed through BorderEffect#border_effect. Note that cloudy
      #   borders are not supported.
      #
      # * The interior color can be changed through InteriorColor#interior_color.
      #
      # * The line ending style can be changed through LineEndingStyling#line_ending_style.
      #
      # See: PDF2.0 s12.5.6.9, HexaPDF::Type::Annotations::Polyline,
      # HexaPDF::Type::Annotations::Polygon, HexaPDF::Type::MarkupAnnotation
      class PolygonPolyline < MarkupAnnotation

        include BorderStyling
        include BorderEffect
        include InteriorColor
        include LineEndingStyling

        # Field Subtype is defined in the two subclasses
        define_field :Vertices, type: PDFArray, required: true
        define_field :LE, type: PDFArray, default: [:None, :None]
        define_field :BS, type: :Border
        define_field :IC, type: PDFArray
        define_field :BE, type: :XXBorderEffect, version: '1.5'
        define_field :IT, type: Symbol, version: '1.6',
                     allowed_values: [:PolygonCloud, :PolyLineDimension, :PolygonDimension]
        define_field :Measure, type: :Measure, version: '1.7'
        define_field :Path, type: PDFArray, version: '2.0'

        # :call-seq:
        #   annot.vertices            => [x0, y0, x1, y1, ...]
        #   annot.vertices(*points)   => annot
        #
        # Returns the array with the vertices, alternating between horizontal and vertical
        # coordinates, when no argument is given. Otherwise sets the vertices and returns self.
        #
        # This is the only required setting. Note, however, that without setting the appearance
        # style through convenience methods like #border_style nothing will be shown.
        #
        # Example:
        #
        #   #>pdf-small
        #   doc.annotations.
        #     create_polyline(doc.pages[0], 20, 20, 30, 70, 80, 60, 40, 30).
        #     regenerate_appearance
        def vertices(*points)
          if points.empty?
            self[:Vertices].to_ary
          elsif points.length % 2 != 0
            raise ArgumentError, "An even number of arguments must be provided"
          else
            self[:Vertices] = points
            self
          end
        end
      end

    end
  end
end
