Data.Fortune

Documentation

data FortuneFile

A handle to an open fortune database.

fortuneFilePath :: FortuneFile -> FilePath

Get the path of the text part of an open fortune database.

fortuneIndexPath :: FortuneFile -> FilePath

Get the path of the index part of an open fortune database.

openFortuneFile :: Char -> Bool -> FilePath -> IO FortuneFile

openFortuneFile path delim writeMode: Open a fortune file at path, using delim as the character between strings, allowing writing if writeMode is set. If no file exists at the specified path, an error will be thrown or the file will be created, depending on writeMode.

closeFortuneFile :: FortuneFile -> IO ()

Close a fortune file. Subsequent accesses will fail.

getIndex :: FortuneFile -> IO Index

Get the Index of a FortuneFile, opening it if necessary.

rebuildIndex :: FortuneFile -> IO ()

Clear a FortuneFiles Index and rebuild it from the contents of the text file.

getFortune :: FortuneFile -> Int -> IO Text

getFortune f i retrieves the text of the i'th fortune (according to the order in the index file) in the FortuneFile f.

getFortunes :: FortuneFile -> IO [Text]

Get the text of every fortune in a fortune file, in the order they occur in the file. Ignores the index entirely.

getNumFortunes :: FortuneFile -> IO Int

Get the number of fortunes in a fortune file, as recorded in the index.

appendFortune :: FortuneFile -> Text -> IO ()

Append a fortune to a fortune file, inserting a delimiter if needed and updating the index.

data Index

A handle to an open fortune index file.

openIndex :: FilePath -> Bool -> IO Index

openIndex path writeMode: Opens the index file at path. The Index will be writable if writeMode is True. If there is no index file at that path, an error will be thrown or the index will be created, depending on writeMode.

createVirtualIndex :: IO Index

Create an in-memory index - useful for working with files when, for whatever reason, you cannot create a valid index.

closeIndex :: Index -> IO ()

Close an index file. Subsequent accesses will fail.

getStats :: Index -> IO FortuneStats

Get some cached stats about the fortunes indexed in this file.

data StatsProblem

Errors that can be thrown when stats are read from an index file. These errors describe various logical inconsistencies that generally indicate that the index file is corrupted somehow.

Constructors

NegativeCount !Int

NegativeLength !Int

NegativeOffset !Int

LengthsWithoutEntries

EntriesWithoutLengths

MaxLengthLessThanMinLength

InconsistentLengthsForOneEntry

Instances

Eq StatsProblem

Defined in Data.Fortune.Stats

Methods

(==) :: StatsProblem -> StatsProblem -> Bool

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

Ord StatsProblem

Defined in Data.Fortune.Stats

Methods

compare :: StatsProblem -> StatsProblem -> Ordering

(<) :: StatsProblem -> StatsProblem -> Bool

(<=) :: StatsProblem -> StatsProblem -> Bool

(>) :: StatsProblem -> StatsProblem -> Bool

(>=) :: StatsProblem -> StatsProblem -> Bool

max :: StatsProblem -> StatsProblem -> StatsProblem

min :: StatsProblem -> StatsProblem -> StatsProblem

Read StatsProblem

Defined in Data.Fortune.Stats

Methods

readsPrec :: Int -> ReadS StatsProblem

readList :: ReadS [StatsProblem]

readPrec :: ReadPrec StatsProblem

readListPrec :: ReadPrec [StatsProblem]

Show StatsProblem

Defined in Data.Fortune.Stats

Methods

showsPrec :: Int -> StatsProblem -> ShowS

show :: StatsProblem -> String

showList :: [StatsProblem] -> ShowS

Exception StatsProblem

Defined in Data.Fortune.Index

Methods

toException :: StatsProblem -> SomeException

fromException :: SomeException -> Maybe StatsProblem

displayException :: StatsProblem -> String

data HeaderProblem

An exception type indicating things that can be wrong about an index file's header.

Constructors

BadMagicNumber !Word32

UnsupportedVersion !Word32

StatsProblem !StatsProblem

TableStartsBeforeHeaderEnds

Instances

Eq HeaderProblem

Defined in Data.Fortune.Index

Methods

(==) :: HeaderProblem -> HeaderProblem -> Bool

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

Ord HeaderProblem

Defined in Data.Fortune.Index

Methods

compare :: HeaderProblem -> HeaderProblem -> Ordering

(<) :: HeaderProblem -> HeaderProblem -> Bool

(<=) :: HeaderProblem -> HeaderProblem -> Bool

(>) :: HeaderProblem -> HeaderProblem -> Bool

(>=) :: HeaderProblem -> HeaderProblem -> Bool

max :: HeaderProblem -> HeaderProblem -> HeaderProblem

min :: HeaderProblem -> HeaderProblem -> HeaderProblem

Read HeaderProblem

Defined in Data.Fortune.Index

Methods

readsPrec :: Int -> ReadS HeaderProblem

readList :: ReadS [HeaderProblem]

readPrec :: ReadPrec HeaderProblem

readListPrec :: ReadPrec [HeaderProblem]

Show HeaderProblem

Defined in Data.Fortune.Index

Methods

showsPrec :: Int -> HeaderProblem -> ShowS

show :: HeaderProblem -> String

showList :: [HeaderProblem] -> ShowS

Exception HeaderProblem

Defined in Data.Fortune.Index

Methods

toException :: HeaderProblem -> SomeException

fromException :: SomeException -> Maybe HeaderProblem

displayException :: HeaderProblem -> String

data IndexProblem

Errors that can be thrown indicating a problem with an index file.

Constructors

HeaderProblem !HeaderProblem

TableLongerThanFile

AccessToClosedIndex

Instances

Eq IndexProblem

Defined in Data.Fortune.Index

Methods

(==) :: IndexProblem -> IndexProblem -> Bool

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

Ord IndexProblem

Defined in Data.Fortune.Index

Methods

compare :: IndexProblem -> IndexProblem -> Ordering

(<) :: IndexProblem -> IndexProblem -> Bool

(<=) :: IndexProblem -> IndexProblem -> Bool

(>) :: IndexProblem -> IndexProblem -> Bool

(>=) :: IndexProblem -> IndexProblem -> Bool

max :: IndexProblem -> IndexProblem -> IndexProblem

min :: IndexProblem -> IndexProblem -> IndexProblem

Read IndexProblem

Defined in Data.Fortune.Index

Methods

readsPrec :: Int -> ReadS IndexProblem

readList :: ReadS [IndexProblem]

readPrec :: ReadPrec IndexProblem

readListPrec :: ReadPrec [IndexProblem]

Show IndexProblem

Defined in Data.Fortune.Index

Methods

showsPrec :: Int -> IndexProblem -> ShowS

show :: IndexProblem -> String

showList :: [IndexProblem] -> ShowS

Exception IndexProblem

Defined in Data.Fortune.Index

Methods

toException :: IndexProblem -> SomeException

fromException :: SomeException -> Maybe IndexProblem

displayException :: IndexProblem -> String

checkIndex :: Index -> IO (Maybe IndexProblem)

Force a consistency check on an index file.

data IndexEntry

Conceptually, an Index file is just a header containing FortuneStats and an array of these entries. An IndexEntry stores the information needed to locate one string in the fortune fiel, as well as some basic stats about that one file (from which the FortuneStats will be derived).

Constructors

IndexEntry

Fields

• stringOffset :: !Int

  The location of the string in the file, as a byte offset

• stringBytes :: !Int

  The number of bytes the string occupies.

• stringChars :: !Int

  The number of characters in the string.

• stringLines :: !Int

  The number of lines in the string.

Instances

Eq IndexEntry

Defined in Data.Fortune.Index

Methods

(==) :: IndexEntry -> IndexEntry -> Bool

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

Ord IndexEntry

Defined in Data.Fortune.Index

Methods

compare :: IndexEntry -> IndexEntry -> Ordering

(<) :: IndexEntry -> IndexEntry -> Bool

(<=) :: IndexEntry -> IndexEntry -> Bool

(>) :: IndexEntry -> IndexEntry -> Bool

(>=) :: IndexEntry -> IndexEntry -> Bool

max :: IndexEntry -> IndexEntry -> IndexEntry

min :: IndexEntry -> IndexEntry -> IndexEntry

Show IndexEntry

Defined in Data.Fortune.Index

Methods

showsPrec :: Int -> IndexEntry -> ShowS

show :: IndexEntry -> String

showList :: [IndexEntry] -> ShowS

indexEntryStats :: IndexEntry -> FortuneStats

Convert one index entry to a FortuneStats record describing it.

getEntries :: Index -> IO (Vector IndexEntry)

Read all the entries in an Index

getEntry :: Index -> Int -> IO IndexEntry

Read a specified entry from an Index.

unfoldEntries :: Index -> IO (Maybe IndexEntry) -> IO ()

Repeatedly invoke a generator for index entries until it returns Nothing, appending all entries returned to the index file.

appendEntries :: Index -> Vector IndexEntry -> IO ()

Append all the given entries to the Index file.

appendEntry :: Index -> IndexEntry -> IO ()

Append a single IndexEntry to an Index file.

clearIndex :: Index -> IO ()

Delete all entries from an Index.

rebuildStats :: Index -> IO ()

All the operations here should preserve correctness of stats, but just in case... This procedure forces the stats to be recomputed.

data FortuneStats

Some statistics about the fortunes in a database. These are stored in the index file and used to speed up various calculations that would otherwise require re-reading lots of files.

Instances

Eq FortuneStats

Defined in Data.Fortune.Stats

Methods

(==) :: FortuneStats -> FortuneStats -> Bool

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

Show FortuneStats

Defined in Data.Fortune.Stats

Methods

showsPrec :: Int -> FortuneStats -> ShowS

show :: FortuneStats -> String

showList :: [FortuneStats] -> ShowS

Semigroup FortuneStats

Defined in Data.Fortune.Stats

Methods

(<>) :: FortuneStats -> FortuneStats -> FortuneStats

sconcat :: NonEmpty FortuneStats -> FortuneStats

stimes :: Integral b => b -> FortuneStats -> FortuneStats

Monoid FortuneStats

Defined in Data.Fortune.Stats

Methods

mempty :: FortuneStats

mappend :: FortuneStats -> FortuneStats -> FortuneStats

mconcat :: [FortuneStats] -> FortuneStats

numFortunes :: FortuneStats -> Int

The number of fortune strings in the index

minChars :: FortuneStats -> Int

The smallest number of characters in any string in the index

maxLines :: FortuneStats -> Int

The greatest number of characters in any string in the index

minLines :: FortuneStats -> Int

The smallest number of lines in any string in the index

maxChars :: FortuneStats -> Int

The greatest number of lines in any string in the index

listFortuneFiles :: Bool -> FilePath -> IO [FilePath]

List all the fortune files in a directory. The Bool value specifies whether to search subtrees as well.

Any file which does not have an extension of ".ix" or ".dat" will be reported as a fortune file (".dat" is not used by misfortune, but is ignored so that misfortune can share fortune databases with fortune).

listFortuneFilesIn :: [(FilePath, Bool)] -> IO [FilePath]

List all the fortune files in several directories. Each directory will be searched by listFortuneFiles (using the corresponding Bool value to control whether the directory is searched recursively) and all results will be combined.

findFortuneFile :: Bool -> FilePath -> String -> IO [FilePath]

Like listFortuneFiles except only returning paths with the specified file name.

findFortuneFileIn :: [(String, Bool)] -> String -> IO [FilePath]

Like listFortuneFilesIn except only returning paths with the specified file name.

findFortuneFilesIn :: [(String, Bool)] -> [String] -> IO [FilePath]

Like findFortuneFileIn but searches for multiple files in multiple directories.

data FortuneType

Three different search paths are supported, depending on the "type" of fortune requested. These are the types that can be requested.

Constructors

All

Normal

Offensive

Instances

Bounded FortuneType

Defined in Data.Fortune

Methods

minBound :: FortuneType

maxBound :: FortuneType

Enum FortuneType

Defined in Data.Fortune

Methods

succ :: FortuneType -> FortuneType

pred :: FortuneType -> FortuneType

toEnum :: Int -> FortuneType

fromEnum :: FortuneType -> Int

enumFrom :: FortuneType -> [FortuneType]

enumFromThen :: FortuneType -> FortuneType -> [FortuneType]

enumFromTo :: FortuneType -> FortuneType -> [FortuneType]

enumFromThenTo :: FortuneType -> FortuneType -> FortuneType -> [FortuneType]

Eq FortuneType

Defined in Data.Fortune

Methods

(==) :: FortuneType -> FortuneType -> Bool

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

Ord FortuneType

Defined in Data.Fortune

Methods

compare :: FortuneType -> FortuneType -> Ordering

(<) :: FortuneType -> FortuneType -> Bool

(<=) :: FortuneType -> FortuneType -> Bool

(>) :: FortuneType -> FortuneType -> Bool

(>=) :: FortuneType -> FortuneType -> Bool

max :: FortuneType -> FortuneType -> FortuneType

min :: FortuneType -> FortuneType -> FortuneType

Read FortuneType

Defined in Data.Fortune

Methods

readsPrec :: Int -> ReadS FortuneType

readList :: ReadS [FortuneType]

readPrec :: ReadPrec FortuneType

readListPrec :: ReadPrec [FortuneType]

Show FortuneType

Defined in Data.Fortune

Methods

showsPrec :: Int -> FortuneType -> ShowS

show :: FortuneType -> String

showList :: [FortuneType] -> ShowS

getFortuneDir :: FortuneType -> IO FilePath

Get the path of the directory containing built-in fortunes of the specified type.

defaultFortuneFiles :: FortuneType -> IO [FilePath]

Get a list of all fortune files on the configured search path (see getFortuneSearchPath)

defaultFortuneSearchPath :: FortuneType -> IO [(FilePath, Bool)]

Get the default search path for a specified fortune type (ignoring the MISFORTUNE_PATH environment variables)

getFortuneSearchPath :: FortuneType -> IO [(FilePath, Bool)]

Get the configured search path for a specified fortune type. If the environment variable MISFORTUNE_PATH_TYPE is set, it will be used. Otherwise, if MISFORTUNE_PATH is set, it will be used. Otherwise, the defaultFortuneSearchPath will be used.

Environment variables are interpreted by splitting on : and checking for an optional + or - prefix on each component (where + indicates recursive search of that directory). The default is non-recursive search for each component.

resolveFortuneFile :: FortuneType -> String -> IO [FilePath]

Search for all fortune files in the configured search path with the given name.

resolveFortuneFiles :: FortuneType -> [String] -> IO [FilePath]

Search for all fortune files in the configured search path with any of the given names.

randomFortune :: [String] -> IO String

Select a random fortune from all files matching any of a list of names (or if the list is empty, all fortune files on the search path). Every fortune string will have an equal probability of being selected.

randomFortuneFromRandomFile :: RVar FortuneFile -> IO String

Select a random fortune file from a specified distribution and then select a random fortune from that file (unformly).

defaultFortuneDistribution :: [FortuneFile] -> IO (Categorical Float FortuneFile)

Given a list of FortuneFiles, compute a distrubution over them weighted by the number of fortunes in each. If this distribution is used with randomFortuneFromRandomFile, the result will be a uniform selection over all the fortunes in all the files.

fortuneDistributionWhere :: (FortuneFile -> Int -> IndexEntry -> IO Bool) -> [FortuneFile] -> IO (Categorical Float (FortuneFile, Categorical Float Int))

Like defaultFortuneDistribution, but filtering the fortunes. In addition to the fortune file, the tuples in the distribution include a distribution over the matching fortune indices in that file, assigning equal weight to each.

withFortuneFile :: Char -> Bool -> FilePath -> (FortuneFile -> IO a) -> IO a

Perform an action with an open FortuneFile, ensuring the file is closed when the action finishes.

withFortuneFiles :: Char -> Bool -> [FilePath] -> ([FortuneFile] -> IO a) -> IO a

Perform an action with many open FortuneFiles, ensuring the files are closed when the action finishes.

mapFortunesWithIndexM :: (Num a, Enum a) => (a -> IndexEntry -> IO b) -> FortuneFile -> IO [b]

mapFortunesWithIndex :: (Num a, Enum a) => (a -> IO b) -> FortuneFile -> IO [b]

mapFortunesM :: (IndexEntry -> IO b) -> FortuneFile -> IO [b]

mapFortunes :: (IndexEntry -> b) -> FortuneFile -> IO [b]

filterFortunesWithIndexM :: (Num a, Enum a) => (a -> IndexEntry -> IO Bool) -> FortuneFile -> IO [a]

filterFortunesWithIndex :: (Num t, Enum t) => (t -> IndexEntry -> Bool) -> FortuneFile -> IO [t]

filterFortunesM :: (Num b, Enum b) => (IndexEntry -> IO Bool) -> FortuneFile -> IO [b]

filterFortunes :: (Num b, Enum b) => (IndexEntry -> Bool) -> FortuneFile -> IO [b]