stardict

README

GO STARDICT

To download and install this package run:

go get -u github.com/ilius/go-stardict

Source docs: http://godoc.org/github.com/ilius/go-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)
• 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

• Constants
• Variables
• func NewDictionary(path string, name string) (*dictionaryImp, error)
• func Open(dirPathList []string, order map[string]int) ([]common.Dictionary, error)
• type Dict
  • func ReadDict(filename string, info *Info) (*Dict, error)
  • func (d *Dict) Close()
  • func (d *Dict) GetSequence(offset uint64, size uint64) []byte
  • func (d *Dict) Open() error
• type DictFile
• type Idx
  • func ReadIndex(filename string, synPath string, info *Info) (*Idx, error)
  • func (idx *Idx) Add(term string, offset uint64, size uint64) int
• type IdxEntry
• type Info
  • func ReadInfo(filename string) (info *Info, err error)
  • func (info Info) Description() string
  • func (info Info) DictName() string
  • func (info Info) EntryCount() (int, error)
  • func (info Info) IndexFileSize() uint64
  • func (info Info) MaxIdxBytes() int
• type WordPrefixMap
  • func (wpm WordPrefixMap) Add(term string, termIndex int)

Constants

const (
	I_bookname    = "bookname"
	I_wordcount   = "wordcount"
	I_description = "description"
	I_idxfilesize = "idxfilesize"
)

Variables

var ErrorHandler = func(err error) {
	log.Println(err)
}

Functions

func NewDictionary

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

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

func Open

func Open(dirPathList []string, order map[string]int) ([]common.Dictionary, error)

Open open directories

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, error)

ReadDict creates Dict and opens .dict file

func (*Dict) Close

func (d *Dict) Close()

func (*Dict) GetSequence

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

GetSequence returns data at the given offset

func (*Dict) Open

func (d *Dict) Open() error

type DictFile

type DictFile interface {
	ReadAt(p []byte, off int64) (n int, err error)
	Close() error
}

type Idx

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

Idx implements an in-memory index for a dictionary

func ReadIndex

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

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

func (*Idx) Add

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

Add adds an item to in-memory index

type IdxEntry

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

type Info

type Info struct {
	Options map[string]string
	Version string
	Is64    bool
	// contains filtered or unexported fields
}

Info contains dictionary options

func ReadInfo

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

ReadInfo reads ifo file and collects dictionary options

func (Info) Description

func (info Info) Description() string

func (Info) DictName

func (info Info) DictName() string

func (Info) EntryCount

func (info Info) EntryCount() (int, error)

EntryCount returns number of words in the dictionary

func (Info) IndexFileSize

func (info Info) IndexFileSize() uint64

func (Info) MaxIdxBytes

func (info Info) MaxIdxBytes() int

type WordPrefixMap

type WordPrefixMap map[rune]map[int]bool

func (WordPrefixMap) Add

func (wpm WordPrefixMap) Add(term string, termIndex int)