Text.Bibutils

Here is a simple program using hs-bibutils to conver a MODS collection into a bibtex file, sending the output to stdout:

import Text.Bibutils

main :: IO ()
main = do
  bibl  <- bibl_init
  param <- bibl_initparams mods_in bibtex_out "mods2bibtex"
  setFormatOpts param [bibout_brackets, bibout_uppercase]
  setBOM        param
  setVerbose    param
  bibl_read     param bibl "/path/to/bibtex.bib"
  bibl_write    param bibl "-"
  bibl_free       bibl
  bibl_freeparams param

Basic Functions

data Bibl

A type for storing the C struct with the bibliography data. Mostly opaque to the Haskell side. See numberOfRefs to retrieve the number of references stored in the struct.

Instances

Storable Bibl

Defined in Text.Bibutils

Methods

sizeOf :: Bibl -> Int

alignment :: Bibl -> Int

peekElemOff :: Ptr Bibl -> Int -> IO Bibl

pokeElemOff :: Ptr Bibl -> Int -> Bibl -> IO ()

peekByteOff :: Ptr b -> Int -> IO Bibl

pokeByteOff :: Ptr b -> Int -> Bibl -> IO ()

peek :: Ptr Bibl -> IO Bibl

poke :: Ptr Bibl -> Bibl -> IO ()

data Param

A type for storing the Param C struct. It should be accessed with the functions provided, such as setCharsetIn, etc.

Constructors

Param

Fields

• redaformat :: CInt
• writeformat :: CInt
• charsetin :: CInt
• charsetin_src :: CUChar
• latexin :: CUChar
• utf8in :: CUChar
• xmlin :: CUChar
• nosplittitle :: CUChar
• charsetout :: CInt
• charsetout_src :: CUChar
• latexout :: CUChar
• utf8out :: CUChar
• utf8bom :: CUChar
• xmlout :: CUChar
• format_opts :: CInt
• addcount :: CInt
• output_raw :: CUChar
• verbose :: CUChar
• singlerefperfile :: CUChar

Instances

Show Param

Defined in Text.Bibutils

Methods

showsPrec :: Int -> Param -> ShowS

show :: Param -> String

showList :: [Param] -> ShowS

Storable Param

Defined in Text.Bibutils

Methods

sizeOf :: Param -> Int

alignment :: Param -> Int

peekElemOff :: Ptr Param -> Int -> IO Param

pokeElemOff :: Ptr Param -> Int -> Param -> IO ()

peekByteOff :: Ptr b -> Int -> IO Param

pokeByteOff :: Ptr b -> Int -> Param -> IO ()

peek :: Ptr Param -> IO Param

poke :: Ptr Param -> Param -> IO ()

bibl_init :: IO (ForeignPtr Bibl)

Initialize the Bibl C struct. Usually the first function being called.

bibl_initparams :: BiblioIn -> BiblioOut -> String -> IO (ForeignPtr Param)

Initialize the Param C struct, given the input bibliographic format, the output bibliographic format, and the program name to be used for displaying debugging information.

bibl_read :: ForeignPtr Param -> ForeignPtr Bibl -> FilePath -> IO Status

Given a Param C structure, a Bibl C structure, the path to the input file ("-" for the standard input), read the file, storing the data in the Bibl struct, and report a Status.

bibl_write :: ForeignPtr Param -> ForeignPtr Bibl -> FilePath -> IO Status

Given a Param C structure, a Bibl C structure, the path to an output file ("-" for the standard output), write the file returning a Status.

bibl_readasis :: ForeignPtr Param -> FilePath -> IO ()

bibl_addtoasis :: ForeignPtr Param -> String -> IO ()

bibl_readcorps :: ForeignPtr Param -> FilePath -> IO ()

bibl_addtocorps :: ForeignPtr Param -> String -> IO ()

bibl_free :: ForeignPtr Bibl -> IO ()

Free the Bibl C struct.

bibl_freeparams :: ForeignPtr Param -> IO ()

Free the Param C struct.

bibl_reporterr :: Status -> IO ()

Auxiliary Functions

numberOfRefs :: ForeignPtr Bibl -> IO Int

Retrieve the number of references from a Bibl C struct.

status :: Status -> CInt

Functions for Setting Parameters

setParam :: ForeignPtr Param -> (Param -> Param) -> IO ()

Set fields of the Param C struct directly.

setFormatOpts :: ForeignPtr Param -> [FormatOpt] -> IO ()

Set output format specific options. See FormatOpt.

setCharsetIn :: ForeignPtr Param -> Charset -> IO ()

Set the input charset. Default is Latin-1 (ISO8859-1). See Charset.

setCharsetOut :: ForeignPtr Param -> Charset -> IO ()

Set the output charset.

setBOM :: ForeignPtr Param -> IO ()

Write utf8 byte-order-mark.

unsetBOM :: ForeignPtr Param -> IO ()

setNoSplitTitle :: ForeignPtr Param -> IO ()

Do not split titles.

unsetNoSplitTitle :: ForeignPtr Param -> IO ()

Split titles.

setLatexOut :: ForeignPtr Param -> IO ()

Write Latex codes.

unsetLatexOut :: ForeignPtr Param -> IO ()

setXmlOut :: ForeignPtr Param -> IO ()

Write characters in XML entities.

unsetXmlOut :: ForeignPtr Param -> IO ()

setAddcount :: ForeignPtr Param -> IO ()

Add reference count to reference id.

unsetAddcount :: ForeignPtr Param -> IO ()

setSinglerefperfile :: ForeignPtr Param -> IO ()

Output a single reference for each file.

unsetSinglerefperfile :: ForeignPtr Param -> IO ()

setOutputRawOpts :: ForeignPtr Param -> [Raw] -> IO ()

Set the output charset.

setVerbose :: ForeignPtr Param -> IO ()

Verbose output.

setVerboseLevel :: ForeignPtr Param -> Int -> IO ()

Verbose output.

unsetVerbose :: ForeignPtr Param -> IO ()

Suppress verbose output.

Input Formats

data BiblioIn

Instances

Eq BiblioIn

Defined in Text.Bibutils

Methods

(==) :: BiblioIn -> BiblioIn -> Bool

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

mods_in :: BiblioIn

bibtex_in :: BiblioIn

ris_in :: BiblioIn

endnote_in :: BiblioIn

copac_in :: BiblioIn

isi_in :: BiblioIn

medline_in :: BiblioIn

biblatex_in :: BiblioIn

endnotexml_in :: BiblioIn

ebi_in :: BiblioIn

word_in :: BiblioIn

nbib_in :: BiblioIn

Output Formats

data BiblioOut

Instances

Eq BiblioOut

Defined in Text.Bibutils

Methods

(==) :: BiblioOut -> BiblioOut -> Bool

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

mods_out :: BiblioOut

bibtex_out :: BiblioOut

ris_out :: BiblioOut

endnote_out :: BiblioOut

isi_out :: BiblioOut

word2007_out :: BiblioOut

adsab_out :: BiblioOut

nbib_out :: BiblioOut

Options for Specific Output Formats

data FormatOpt

bibout_finalcomma :: FormatOpt

bibout_singledash :: FormatOpt

bibout_whitespace :: FormatOpt

bibout_brackets :: FormatOpt

bibout_uppercase :: FormatOpt

bibout_strictkey :: FormatOpt

bibout_shorttitle :: FormatOpt

bibout_dropkey :: FormatOpt

modsout_dropkey :: FormatOpt

Charsets

data Charset

Instances

Eq Charset

Defined in Text.Bibutils

Methods

(==) :: Charset -> Charset -> Bool

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

bibl_charset_unknown :: Charset

bibl_charset_unicode :: Charset

bibl_charset_gb18030 :: Charset

bibl_charset_default :: Charset

bibl_charset_utf8_default :: Charset

bibl_charset_bom_default :: Charset

Return Status

data Status

Instances

Eq Status

Defined in Text.Bibutils

Methods

(==) :: Status -> Status -> Bool

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

Show Status

Defined in Text.Bibutils

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

bibl_ok :: Status

bibl_err_badinput :: Status

bibl_err_memerr :: Status

bibl_err_cantopen :: Status

Raw

data Raw

Instances

Eq Raw

Defined in Text.Bibutils

Methods

(==) :: Raw -> Raw -> Bool

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

Show Raw

Defined in Text.Bibutils

Methods

showsPrec :: Int -> Raw -> ShowS

show :: Raw -> String

showList :: [Raw] -> ShowS

bibl_raw_with_charset_convert :: Raw

bibl_raw_with_make_ref_id :: Raw