poreader

a parser for GNU gettext Portable Objects (.po) files

Types

Comment

pub type Comment {
  Flag(String)
  Translator(String)
  Extracted(String)
  Reference(filename: String, line_number: option.Option(Int))
  Previous(String)
}

Constructors

```
Flag(String)
```
```
Translator(String)
```
```
Extracted(String)
```

Reference(filename: String, line_number: option.Option(Int))

```
Previous(String)
```

Message

</>

pub type Message {
  Singular(
    msgid: String,
    msgstr: String,
    msgctx: option.Option(String),
    comments: List(Comment),
  )
  Plural(
    msgid: String,
    msgid_plural: String,
    msgstr: dict.Dict(Int, String),
    msgctx: option.Option(String),
    comments: List(Comment),
  )
}

Constructors

Singular(
  msgid: String,
  msgstr: String,
  msgctx: option.Option(String),
  comments: List(Comment),
)

Plural(
  msgid: String,
  msgid_plural: String,
  msgstr: dict.Dict(Int, String),
  msgctx: option.Option(String),
  comments: List(Comment),
)

ParseError

</>

pub type ParseError {
  LexerError(row: Int, col: Int, lexeme: String)
  ParserError(List(String))
}

Constructors

LexerError(row: Int, col: Int, lexeme: String)

```
ParserError(List(String))
```

Values

get_comments

</>

pub fn get_comments(message: Message) -> List(Comment)

returns the comments of the message

get_context

</>

pub fn get_context(message: Message) -> option.Option(String)

returns the context of the message

get_id

</>

pub fn get_id(message: Message) -> String

returns the translation id of the message

get_plural_id

</>

pub fn get_plural_id(message: Message) -> option.Option(String)

returns the plural id of the message

get_plural_text

</>

pub fn get_plural_text(
  message: Message,
  idx: Int,
) -> option.Option(String)

returns the plural translation of the message when given a singular message, the single translation is returned

get_text

</>

pub fn get_text(message: Message) -> option.Option(String)

returns the text of the message when given a plural message, the first translation is returned

is_plural

</>

pub fn is_plural(message: Message) -> Bool

returns true when the message is of type plural

is_singular

</>

pub fn is_singular(message: Message) -> Bool

returns true when the message is of type singular

parse

</>

pub fn parse(
  content: String,
) -> Result(List(Message), ParseError)

parses the given string into a list of messages