View Source Expo.MO (expo v0.3.0)

File handling for MO (.mo) files.

Link to this section Summary

Functions

Composes a MO (.mo) file from the given messages.

Parses a string into a Expo.Messages struct, raising an exception if there are any errors.

Parses the given binary as an MO file.

Parses the contents of a file into a Expo.Messages struct, raising if there are any errors.

Parses the contents of the given file into a Expo.Messages struct.

Link to this section Types

@type compose_option() ::
  {:endianness, :little | :big}
  | {:use_fuzzy, boolean()}
  | {:statistics, boolean()}
@type parse_option() :: {:file, Path.t()}

Link to this section Functions

Link to this function

compose(messages, options \\ [])

View Source
@spec compose(Expo.Messages.t(), [compose_option()]) :: iodata()

Composes a MO (.mo) file from the given messages.

examples

Examples

iex> %Expo.Messages{
...>   headers: ["Last-Translator: Jane Doe"],
...>   messages: [
...>     %Expo.Message.Singular{msgid: ["foo"], msgstr: ["bar"], comments: "A comment"}
...>   ]
...> }
...> |> Expo.MO.compose()
...> |> IO.iodata_to_binary()
<<222, 18, 4, 149, 0, 0, 0, 0, 2, 0, 0, 0, 28, 0, 0, 0, 44, 0, 0, 0, 0, 0, 0, 0,
  60, 0, 0, 0, 0, 0, 0, 0, 60, 0, 0, 0, 3, 0, 0, 0, 61, 0, 0, 0, 25, 0, 0, 0,
  65, 0, 0, 0, 3, 0, 0, 0, 91, 0, 0, 0, 0, 102, 111, 111, 0, 76, 97, 115, 116,
  45, 84, 114, 97, 110, 115, 108, 97, 116, 111, 114, 58, 32, 74, 97, 110, 101,
  32, 68, 111, 101, 0, 98, 97, 114, 0>>
Link to this function

parse_binary!(binary, options \\ [])

View Source
@spec parse_binary!(binary(), [parse_option()]) :: Expo.Messages.t()

Parses a string into a Expo.Messages struct, raising an exception if there are any errors.

Works exactly like parse_binary/1, but returns a Expo.Messages struct if there are no errors or raises an exception if there are.

examples

Examples

iex> Expo.MO.parse_binary!(<<
...>   0xDE120495::size(4)-unit(8),
...>   0::little-unsigned-integer-size(2)-unit(8),
...>   0::little-unsigned-integer-size(2)-unit(8),
...>   0::little-unsigned-integer-size(4)-unit(8),
...>   28::little-unsigned-integer-size(4)-unit(8),
...>   28::little-unsigned-integer-size(4)-unit(8),
...>   28::little-unsigned-integer-size(4)-unit(8),
...>   0::little-unsigned-integer-size(4)-unit(8)
...> >>)
%Expo.Messages{headers: [], messages: []}

iex> Expo.MO.parse_binary!("invalid")
** (Expo.MO.InvalidFileError) invalid file
Link to this function

parse_binary(binary, options \\ [])

View Source
@spec parse_binary(binary(), [parse_option()]) ::
  {:ok, Expo.Messages.t()}
  | {:error, Expo.MO.InvalidFileError.t() | Expo.MO.UnsupportedVersionError.t()}

Parses the given binary as an MO file.

If successful, returns {:ok, messages} where messages is a Expo.Messages struct. If there's an error, {:error, error} is returned where error is an exception struct.

examples

Examples

iex> Expo.MO.parse_binary(<<
...>   0xDE120495::size(4)-unit(8),
...>   0::little-unsigned-integer-size(2)-unit(8),
...>   0::little-unsigned-integer-size(2)-unit(8),
...>   0::little-unsigned-integer-size(4)-unit(8),
...>   28::little-unsigned-integer-size(4)-unit(8),
...>   28::little-unsigned-integer-size(4)-unit(8),
...>   28::little-unsigned-integer-size(4)-unit(8),
...>   0::little-unsigned-integer-size(4)-unit(8)
...> >>)
{:ok, %Expo.Messages{headers: [], messages: []}}
Link to this function

parse_file!(path, options \\ [])

View Source
@spec parse_file!(Path.t(), [parse_option()]) :: Expo.Messages.t()

Parses the contents of a file into a Expo.Messages struct, raising if there are any errors.

Works like parse_file/1, except that it raises an exception if there's an error with parsing the file or a File.Error error if there's an error with reading the file.

examples

Examples

Expo.MO.parse_file!("nonexistent.po")
#=> ** (File.Error) could not parse "nonexistent.po": no such file or directory
Link to this function

parse_file(path, options \\ [])

View Source

Parses the contents of the given file into a Expo.Messages struct.

This function works similarly to parse_binary/1 except that it takes a file and parses the contents of that file as an MO file. It can return:

  • {:ok, po} if the parsing is successful

  • {:error, line, reason} if there is an error with the contents of the .mo file (for example, a syntax error)

  • {:error, reason} if there is an error with reading the file (this error is one of the errors that can be returned by File.read/1)

examples

Examples

{:ok, po} = Expo.MO.parse_file("messages.po")
po.file
#=> "messages.po"

Expo.MO.parse_file("nonexistent")
#=> {:error, :enoent}