Brassica.SFM.SFM

This module implements basic support for the SIL Standard Format Marker (SFM) format, used by dictionary software such as FieldWorks. This format forms the basis of standards such as Multi-Dictionary Formatter (MDF), implemented here in Brassica.SFM.MDF.

Linear SFM documents

data Field

A single field of an SFM file.

Constructors

Field

Fields

• fieldMarker :: String

  The field marker, ommitting the initial backslash

• fieldWhitespace :: String

  Whitespace after the field marker

• fieldSourcePos :: Maybe SourcePos

  Optionally, a Megaparsec SourcePos marking the start of the value (to enable further parsing)

• fieldValue :: String

  The value of the field, including all whitespace until the next marker

Instances

Show Field

Defined in Brassica.SFM.SFM

Methods

showsPrec :: Int -> Field -> ShowS

show :: Field -> String

showList :: [Field] -> ShowS

type SFM = [Field]

An SFM file, being a list of fields.

parseSFM

Arguments

:: String

Name of source file

-> String

Input SFM data to parse

-> Either (ParseErrorBundle String Void) SFM

Parse an SFM file to an SFM value.

exactPrintField :: Field -> String

Print a single field as String.

exactPrintSFM :: SFM -> String

Given an SFM, reconstruct the original file. A trivial wrapper around exactPrintField.

stripSourcePos :: Field -> Field

Set the fieldSourcePos of a Field to Nothing. Useful for making debug output shorter.

Hierarchies

type Hierarchy = Map String String

The hierarchy underlying an SFM document, defined as a map from field names to their parents. Fields which are absent from the map are treated as roots.

data SFMTree

Rose tree describing a hierarchical SFM document.

Constructors

Root [SFMTree]

Root node

Filled Field [SFMTree]

A Field with zero or more children.

Missing String [SFMTree]

A missing level of the hierarchy: a marker which is inferred from the presence of its children.

Instances

Show SFMTree

Defined in Brassica.SFM.SFM

Methods

showsPrec :: Int -> SFMTree -> ShowS

show :: SFMTree -> String

showList :: [SFMTree] -> ShowS

toTree :: Hierarchy -> SFM -> SFMTree

Generate a tree structure from an SFM document according to the given Hierarchy. Fields are converted to Filled nodes, containing as many following nodes as possible, until the next node which is at the same level of the hierarchy or lower. Missing nodes are created for any missing levels of the hierarchy.

fromTree :: SFMTree -> SFM

Inverse of toTree: convert an SFMTree back into a linear SFM document.

mapField :: (Field -> Field) -> SFMTree -> SFMTree

Map a function over all the Fields in an SFMTree.

searchField :: (Field -> Maybe a) -> SFMTree -> [a]

Depth-first search for fields under an SFMTree which satisfy the given predicate.