stardict

README

GO STARDICT

To download and install this package run:

go get -u github.com/kapmahc/stardict

Source docs: http://godoc.org/github.com/kapmahc/stardict

Disclaimer Sample code can be found in dict_test.go.

Project Overview

The project was started as an attempt to read stardict dictionaries in language learning webservice and grew into a tool supporting several dictionary formats.

Current limitations:

• Index file is loaded into memory for fast random access
• DictZip format is not supported, it is processed as a simple GZip format (means that no random blocks access is supported as in DictZip)
• Syn files are not processed
• There's no recovering from errors (means that dictionaries should be well formed)

Not tested but should be working in theory (I didn't find dictionaries with those properties in place):

• 64bit offsets
• multi typed dictionary fields

Thanks

• Format for StarDict dictionary files
• Dictionaries
• GO STARDICT

Documentation

Index

• type Dict
  • func ReadDict(filename string, info *Info) (dict *Dict, err error)
  • func (d Dict) GetSequence(offset uint64, size uint64) []byte
• type Dictionary
  • func NewDictionary(path string, name string) (*Dictionary, error)
  • func Open(d string) ([]*Dictionary, error)
  • func (d Dictionary) GetBookName() string
  • func (d Dictionary) GetWordCount() uint64
  • func (d Dictionary) SearchAuto(query string) []*SearchResult
  • func (d Dictionary) SearchContains(query string) []*SearchResult
  • func (d Dictionary) SearchPrefix(query string) []*SearchResult
  • func (d Dictionary) Translate(item string) (items []*Translation)
• type Idx
  • func NewIdx() *Idx
  • func ReadIndex(filename string, info *Info) (idx *Idx, err error)
  • func (idx *Idx) Add(item string, offset uint64, size uint64)
  • func (idx Idx) Get(item string) []*Sense
• type Info
  • func ReadInfo(filename string) (info *Info, err error)
• type SearchResult
• type Sense
• type Translation
• type TranslationItem

Types

type Dict

type Dict struct {
	// contains filtered or unexported fields
}

Dict implements in-memory dictionary

func ReadDict

func ReadDict(filename string, info *Info) (dict *Dict, err error)

ReadDict reads dictionary into memory

func (Dict) GetSequence

func (d Dict) GetSequence(offset uint64, size uint64) []byte

GetSequence returns data at the given offset

type Dictionary

type Dictionary struct {
	// contains filtered or unexported fields
}

Dictionary stardict dictionary

func NewDictionary

func NewDictionary(path string, name string) (*Dictionary, error)

NewDictionary returns a new Dictionary path - path to dictionary files name - name of dictionary to parse

func Open

func Open(d string) ([]*Dictionary, error)

Open open directories

func (Dictionary) GetBookName

func (d Dictionary) GetBookName() string

GetBookName returns book name

func (Dictionary) GetWordCount

func (d Dictionary) GetWordCount() uint64

GetWordCount returns number of words in the dictionary

func (Dictionary) SearchAuto

func (d Dictionary) SearchAuto(query string) []*SearchResult

SearchAuto: first try an exact match then search all translations for keywords that contain the query but sort the one that have it as prefix first

func (Dictionary) SearchContains

func (d Dictionary) SearchContains(query string) []*SearchResult

SearchContains: search all translations for keywords that contain the query

func (Dictionary) SearchPrefix

func (d Dictionary) SearchPrefix(query string) []*SearchResult

SearchPrefix: search all translations for keywords that start with query

func (Dictionary) Translate

func (d Dictionary) Translate(item string) (items []*Translation)

Translate translates given item

type Idx

type Idx struct {
	// contains filtered or unexported fields
}

Idx implements an in-memory index for a dictionary

func NewIdx

func NewIdx() *Idx

NewIdx initializes idx struct

func ReadIndex

func ReadIndex(filename string, info *Info) (idx *Idx, err error)

ReadIndex reads dictionary index into a memory and returns in-memory index structure

func (*Idx) Add

func (idx *Idx) Add(item string, offset uint64, size uint64)

Add adds an item to in-memory index

func (Idx) Get

func (idx Idx) Get(item string) []*Sense

Get gets all translations for an item

type Info

type Info struct {
	Version string
	Is64    bool
	Options map[string]string
}

Info contains dictionary options

func ReadInfo

func ReadInfo(filename string) (info *Info, err error)

ReadInfo reads ifo file and collects dictionary options

type SearchResult

type SearchResult struct {
	Keyword string
	Items   []*TranslationItem
}

type Sense

type Sense struct {
	Offset uint64
	Size   uint64
}

Sense has information belonging to single item position in dictionary

type Translation

type Translation struct {
	Parts []*TranslationItem
}

Translation contains translation items

type TranslationItem

type TranslationItem struct {
	Type rune
	Data []byte
}

TranslationItem contain single translation item