NLP.Dictionary.StarDict

Description

Tools for StarDict dictionaries. To load a dictionary you should call mkDictionary with path to .ifo file and render function. Every call of getEntry will perform file reading operation to retrieve requested data. For in-memory version see InMemory.

Documentation

data StarDict

Representation of the dictionary.

Constructors

StarDict

Fields

• sdIfoFile :: IfoFile
• sdIndex :: Index
• sdDataPath :: FilePath
• sdDataParser :: Get [DataEntry]
• sdRender :: Renderer

Instances

Dictionary StarDict

Methods

getEntries :: Text -> StarDict -> IO [Text]

data StarDictException

Exceptions that are thrown when something with this module went wrong.

Constructors

WrongIfoFormat FilePath String

Thrown when information file (.ifo) has unsupported format.

IndexNotFound FilePath

Thrown when index file (.idx, .idx.gz) is not found.

WrongIndexFormat FilePath String

Thrown when index file has unsupported format.

DictionaryNotFound FilePath

Thrown when dictionary file (.dict, .dict.dz) has unsupported format.

Instances

Eq StarDictException

Methods

(==) :: StarDictException -> StarDictException -> Bool

(/=) :: StarDictException -> StarDictException -> Bool

Show StarDictException

Methods

showsPrec :: Int -> StarDictException -> ShowS

show :: StarDictException -> String

showList :: [StarDictException] -> ShowS

Exception StarDictException

Methods

toException :: StarDictException -> SomeException

fromException :: SomeException -> Maybe StarDictException

displayException :: StarDictException -> String

mkDictionary :: (MonadThrow m, MonadIO m) => IfoFilePath -> Renderer -> m StarDict

Create dictionary.

mkDataParser :: Maybe String -> Get [DataEntry]

Returns parser based on description in .ifo file.

data DataEntry

Possible dictionary entry formats.

Constructors

UTF8Text Text

LocaleText Text

Pango Text

Phonetics Text

XDXF Text

CJK Text

PowerWord Text

MediaWiki Text

HTML Text

Resource [FilePath]

WAVEAudio ByteString

Picture ByteString

Reserved ByteString

Instances

Eq DataEntry

Methods

(==) :: DataEntry -> DataEntry -> Bool

(/=) :: DataEntry -> DataEntry -> Bool

Show DataEntry

Methods

showsPrec :: Int -> DataEntry -> ShowS

show :: DataEntry -> String

showList :: [DataEntry] -> ShowS

type Renderer = DataEntry -> Text

Type of function to transform dictionary entries to a text.

checkFiles :: IfoFilePath -> [FilePath] -> IO (Maybe FilePath)

Given .ifo file name and list of extensions, returns first existing file with the same basename.

checkGZFiles :: IfoFilePath -> [FilePath] -> [FilePath] -> IO (Maybe (Either FilePath FilePath))

Given .ifo file name and two lists of extensions, returns first existing file with with the same basename and extension from the first list or (if such file doesn't exists) from the second list.

data IfoFile

Representation of .ifo file.

Constructors

IfoFile

Fields

• ifoMagicData :: ByteString
• ifoVersion :: String
• ifoBookName :: Text
• ifoWordCount :: Int
• ifoIdxFileSize :: Int
• ifoIdxOffsetBits :: Maybe Int
• ifoSynWordCount :: Maybe Int
• ifoAuthor :: Maybe Text
• ifoEmail :: Maybe Text
• ifoWebsite :: Maybe Text
• ifoDescription :: Maybe Text
• ifoDate :: Maybe UTCTime
• ifoSameTypeSequence :: Maybe String
• ifoDictType :: Maybe String

Instances

Eq IfoFile

Methods

(==) :: IfoFile -> IfoFile -> Bool

(/=) :: IfoFile -> IfoFile -> Bool

Show IfoFile

Methods

showsPrec :: Int -> IfoFile -> ShowS

show :: IfoFile -> String

showList :: [IfoFile] -> ShowS

type IfoFilePath = FilePath

Type synonym to distinguish usage of paths.

readIfoFile :: (MonadThrow m, MonadIO m) => FilePath -> m IfoFile

Read .ifo file at the given path.

indexNumberParser :: IfoFile -> Get Int

Get 32-bit or 64-bit integer depending on description in the .ifo file.

ifoDateFormat :: String

Date format of ifoDate in IfoFile.

type Index = Map Text (Int, Int)

Representation of an .idx file.

type IndexEntry = (Text, (Int, Int))

Representation of an .idx file entry.

readIndexFile :: (MonadThrow m, MonadIO m) => IfoFilePath -> Get Int -> m Index

Read .idx (.idx.gz) file.

checkDataFile :: (MonadThrow m, MonadIO m) => IfoFilePath -> m FilePath

Returns path of decompressed dictionary.