View Source Expo.Message (expo v0.2.0)
Functions to work on message structs (Expo.Message.Singular and Expo.Message.Plural).
A message is a single PO message. For example:
```
msgid "Hello"
msgstr ""
```Message structs are used both to represent reference messages (where the msgstr is empty)
in POT files as well as actual translations.
Link to this section Summary
Functions
Appends the given flag to the given message.
Tells whether the given message has the given flag specified.
Returns a "key" that can be used to identify a message.
Tells whether two messages are the same message according to their
msgid.
Get the source line number of the message.
Link to this section Types
@opaque key()
The key that can be used to identify a message.
See key/1.
@type msgctxt() :: String.t()
@type msgid() :: [String.t()]
@type msgstr() :: [String.t()]
@type t() :: Expo.Message.Singular.t() | Expo.Message.Plural.t()
Link to this section Functions
Appends the given flag to the given message.
Keeps the line formatting intact.
examples
Examples
iex> message = %Expo.Message.Singular{msgid: [], flags: []}
iex> Expo.Message.append_flag(message, "foo")
%Expo.Message.Singular{msgid: [], flags: [["foo"]]}
Tells whether the given message has the given flag specified.
examples
Examples
iex> Expo.Message.has_flag?(%Expo.Message.Singular{msgid: [], flags: [["foo"]]}, "foo")
true
iex> Expo.Message.has_flag?(%Expo.Message.Singular{msgid: [], flags: [["foo"]]}, "bar")
false
Returns a "key" that can be used to identify a message.
This function returns a "key" that can be used to uniquely identify a
message assuming that no "same" messages exist; for what "same"
means, look at the documentation for same?/2.
The purpose of this function is to be used in situations where we'd like to group or sort messages but where we don't need the whole structs.
examples
Examples
iex> t1 = %Expo.Message.Singular{msgid: ["foo"]}
iex> t2 = %Expo.Message.Singular{msgid: ["", "foo"]}
iex> Expo.Message.key(t1) == Expo.Message.key(t2)
true
iex> t1 = %Expo.Message.Singular{msgid: ["foo"]}
iex> t2 = %Expo.Message.Singular{msgid: ["bar"]}
iex> Expo.Message.key(t1) == Expo.Message.key(t2)
false
Tells whether two messages are the same message according to their
msgid.
This function returns true if message1 and message2 are the same
message, where "the same" means they have the same msgid or the same
msgid and msgid_plural.
examples
Examples
iex> t1 = %Expo.Message.Singular{msgid: ["foo"]}
iex> t2 = %Expo.Message.Singular{msgid: ["", "foo"]}
iex> Expo.Message.same?(t1, t2)
true
iex> t1 = %Expo.Message.Singular{msgid: ["foo"]}
iex> t2 = %Expo.Message.Singular{msgid: ["bar"]}
iex> Expo.Message.same?(t1, t2)
false
@spec source_line_number( Expo.Message.Singular.t(), Expo.Message.Singular.block(), default ) :: non_neg_integer() | default when default: term()
@spec source_line_number( Expo.Message.Plural.t(), Expo.Message.Plural.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"
...> msgstr "bar"
...> """)
iex> Expo.Message.source_line_number(message, :msgid)
1