Text.CSL.Input.Identifier.Internal

Documentation

newtype Database

The data structure that carries the resolved references. Since the mapping Reference -> BibTeX is not the inverse of BibTeX -> Reference for the version citeproc-hs-0.3.8 and loses some information, we choose to store the original BibTeX string in the Database, rather than Reference.

Constructors

Database

Fields

_databaseMap :: Map String String

Instances

ToJSON Database

FromJSON Database

Default Database

HasDatabase Database

class HasDatabase t where

The lens for accessing the map within the Database.

Methods

database :: Lens' t Database

databaseMap :: Lens' t (Map String String)

Instances

HasDatabase Database

withDatabaseFile :: (MonadIO m, MonadState s m, HasDatabase s) => FilePath -> m a -> m a

Excecute the program using the given database file. The file will be created if it didn't exist.

type RM m a b = a -> EitherT String m b

Resolver Monad is a function that converts a key of type a to some other type b, which may fail with an error message.

liftIOE :: MonadIO m => IO (Either a b) -> EitherT a m b

Perform possibly failing IO within a monad

resolveBibtex :: MonadIO m => String -> RM m String Reference

parse a Bibtex entry that contains single reference.

resolveEither :: forall m s. (MonadIO m, MonadState s m, HasDatabase s) => String -> EitherT String m Reference

resolve a document url to a Reference, or emits a error message with reason why it fails.

resolveDOI :: MonadIO m => RM m String String

resolvers for specific document IDs.

resolveArXiv :: MonadIO m => RM m String String

resolveBibcode :: MonadIO m => RM m String String

resolveISBN :: MonadIO m => RM m String String

getDataFileName :: String -> IO String

a safer way to get data file name.

stringReplace :: String -> String -> String -> String

String version of replace.