View Source Expo.Message.Plural (expo v0.3.0)

Struct for plural messages.

For example:

```
msgid "Cat"
msgid_plural "Cats"
msgstr ""
```

All fields in this struct are public except for :__meta__. The :flags and :references fields are defined as lists of lists in order to represent lines in the original file. For example, this message:

```
#, flag1, flag2
#, flag3
#: a.ex:1
#: b.ex:2 c.ex:3
msgid "Hello"
msgstr ""
```

would have:

  • flags: [["flag1", "flag2"], ["flag3"]]
  • references: [["a.ex:1"], ["b.ex:2", "c.ex:3"]]

You can use Expo.Message.has_flag?/2 to make it easier to check whether a message has a given flag.

Link to this section Summary

Functions

Rebalances all strings

Get the source line number of the message.

Link to this section Types

@type block() :: :msgid | {:msgstr, non_neg_integer()} | :msgctxt | :msgid_plural
@opaque meta()
@type t() :: %Expo.Message.Plural{
  __meta__: meta(),
  comments: [String.t()],
  extracted_comments: [String.t()],
  flags: [[String.t()]],
  msgctxt: Expo.Message.msgctxt() | nil,
  msgid: Expo.Message.msgid(),
  msgid_plural: [Expo.Message.msgid()],
  msgstr: %{required(non_neg_integer()) => Expo.Message.msgstr()},
  obsolete: boolean(),
  previous_messages: [Expo.Message.t()],
  references: [
    [file :: String.t() | {file :: String.t(), line :: pos_integer()}]
  ]
}

Link to this section Functions

@spec rebalance(t()) :: t()

Rebalances all strings

  • Put one string per newline of msgid / msgid_plural / msgstr
  • Put all flags onto one line
  • Put all references onto a separate line

examples

Examples

iex> Expo.Message.Plural.rebalance(%Expo.Message.Plural{
...>   msgid: ["", "hello", "\n", "", "world", ""],
...>   msgid_plural: ["", "hello", "\n", "", "world", ""],
...>   msgstr: %{0 => ["", "hello", "\n", "", "world", ""]},
...>   flags: [["one", "two"], ["three"]],
...>   references: [[{"one", 1}, {"two", 2}], ["three"]]
...> })
%Plural{
  msgid: ["hello\n", "world"],
  msgid_plural: ["hello\n", "world"],
  msgstr: %{0 => ["hello\n", "world"]},
  flags: [["one", "two", "three"]],
  references: [[{"one", 1}], [{"two", 2}], ["three"]]
}
Link to this function

source_line_number(message, block, default \\ nil)

View Source
@spec source_line_number(t(), block(), default) :: non_neg_integer() | default
when default: term()

Get the source line number of the message.

examples

Examples

iex> %Expo.Messages{messages: [message]} = Expo.PO.parse_string!("""
...> msgid "foo"
...> msgid_plural "foos"
...> msgstr[0] "bar"
...> """)
iex> Expo.Message.Plural.source_line_number(message, :msgid)
1