messages

Documentation

Overview

Package messages implements functions for extracting messages from source code files and compiling them to Go code.

Index

• func Compile(filename string, translations []*po.Po, opts *CompileOptions) error
• func DefaultTagFields() []string
• func DefaultTypes() []string
• func Write(w io.Writer, messages []*Message) error
• type CompileOptions
• type ExtractOptions
  • func DefaultExtractOptions() *ExtractOptions
• type Function
  • func DefaultFunctions() []*Function
• type Message
  • func Extract(dir string, opts *ExtractOptions) ([]*Message, error)
  • func (m *Message) Key() string
  • func (m *Message) Merge(o *Message, pos *Position) error
  • func (m *Message) String() string
• type Position
  • func (p *Position) String() string

Functions

func Compile

func Compile(filename string, translations []*po.Po, opts *CompileOptions) error

func DefaultTagFields

func DefaultTagFields() []string

func DefaultTypes

func DefaultTypes() []string

func Write

func Write(w io.Writer, messages []*Message) error

Types

type CompileOptions

type CompileOptions struct {
	DefaultContext string
}

type ExtractOptions

type ExtractOptions struct {
	Functions []*Function
	Types     []string
	TagFields []string
}

func DefaultExtractOptions

func DefaultExtractOptions() *ExtractOptions

type Function

type Function struct {
	// Qualified function name
	Name string
	// Wheter the function is a template function
	Template bool
	// Wheter the function has a context argument
	Context bool
	// Wheter the function has a plural form argument
	Plural bool
	// Position of the first translatable argument (0 indexed)
	Start int
}

func DefaultFunctions

func DefaultFunctions() []*Function

type Message

type Message struct {
	Context           string
	Singular          string
	Plural            string
	TranslatorComment string
	Positions         []*Position
	Translations      []string
}

func Extract

func Extract(dir string, opts *ExtractOptions) ([]*Message, error)

func (*Message) Key

func (m *Message) Key() string

func (*Message) Merge

func (m *Message) Merge(o *Message, pos *Position) error

func (*Message) String

func (m *Message) String() string

type Position

type Position struct {
	Filename string
	Line     int
	Comment  string
}

func (*Position) String

func (p *Position) String() string