gettext

defmodule Gettext.PO.PluralTranslation do
  @moduledoc """
  A struct that holds information on a plural translation.

  This struct describes a translation which has a plural form, such as the one
  in the following snippet of `.po` file:

      msgid "There was an error"
      msgid_plural "There were %{count} errors"
      msgstr[0] "C'è stato un errore"
      msgstr[1] "Ci sono stati %{count} errori"

  This struct contains three fields:

    * `msgid` - the id of the singular translation.
    * `msgid_plural` - the id of the pluralized translation.
    * `msgstr` - a map which maps plural forms as keys to translated strings as
      values. The plural forms mentioned here are the ones described in
      `Gettext.Plural`.
    * `comments` - a list of comments as they are found in the PO file (for example,
      `["# foo"]`).
    * `extracted_comments` - a list of extracted comments (for example,
      `["#. foo", "#. bar"]`).
    * `references` - a list of references (files this translation comes from) in
      the form `{file, line}`.
    * `flags` - a set of flags for this translation.
    * `po_source_line` - the line this translation is on in the PO file where it
      comes from.

  """

  @type t :: %__MODULE__{
          msgid: [binary],
          msgid_plural: [binary] | nil,
          msgstr: %{non_neg_integer => [binary]},
          msgctxt: [binary] | nil,
          comments: [binary],
          extracted_comments: [binary],
          references: [{binary, pos_integer}],
          flags: MapSet.t(),
          po_source_line: pos_integer
        }

  @enforce_keys [:msgid, :msgid_plural]

  defstruct msgid: nil,
            msgid_plural: nil,
            msgstr: [],
            msgctxt: nil,
            comments: [],
            extracted_comments: [],
            references: [],
            flags: MapSet.new(),
            po_source_line: 1
end