# encoding: utf-8
# frozen_string_literal: true

module Carbon
  module Concrete
    class Type
      # The function part of a type.  This comes after the module that it is
      # defined in, and contains three pieces of information: the name of the
      # function, the generics associated with the function, and the parameters
      # of the function.
      #
      # @todo TODO: add generic parameters.
      # @note
      #   **This class is frozen upon initialization.**  This means that any
      #   attempt to modify it will result in an error.  In most cases, the
      #   attributes on this class will also be frozen, as well.
      # @note
      #   This class does not include comparison methods; however, if they
      #   were to ever be needed, {#to_s} should be used for the basis of
      #   comparison.
      class Function
        # The name of the function.  This is normally a bland string.
        # Functions can have a variety of names to override default operations
        # in the language; even more so than ruby.
        #
        # @api public
        # @example
        #   type = Carbon::Type("A.+(A, B)")
        #   func = type.name.function
        #   func.name # => "+"
        # @return [::String] The name of the function.
        attr_reader :name

        # The parameters for the function.  These are the arguments that are
        # passed to the function when it's called.  This is included in the
        # definition for the name of the function to allow overloading.
        #
        # @api public
        # @example
        #   type = Carbon::Type("A.+(A, B)")
        #   func = type.name.function
        #   func.parameters
        #     # => [#<Carbon::Concrete::Type::Name A>,
        #     #   #<Carbon::Concrete::Type::Name B>]
        # @return [::Array<Type::Name>]
        attr_reader :parameters

        # Initialize the function.
        #
        # @see #name
        # @see #params
        # @param name [::String] The name of the function.
        # @param params [::Array<Type::Name>] The parameters of the function.
        #   This is frozen before stored.
        def initialize(name, params)
          @name = name
          @parameters = params
          deep_freeze!
        end

        # Returns a string representation of this function.  In contrast to
        # {#intern}, this includes generic information.
        #
        # @api public
        # @example
        #   func.name # => "+"
        #   func.parameters # => [#<Carbon::Concrete::Type::Name Test<T>>]
        #   func.to_s # => "+(Test<T>)"
        # @return [::String]
        def to_s
          "#{@name}(#{@parameters.map(&:to_s).join(', ')})".freeze
        end

        # Returns the interned version of this function.  In contrast to
        # {#to_s}, this does not include generic information.
        #
        # @api public
        # @note See {Item::Base#intern} For more information about interned
        #   names.
        # @example
        #   func.name # => "+"
        #   func.parameters # => [#<Carbon::Concrete::Type::Name Test<T>>]
        #   func.intern # => "+(Test)"
        # @return [::String]
        def intern
          "#{@name}(#{@parameters.map(&:intern).join(', ')})".freeze
        end
      end
    end
  end
end