Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Fortune

Synopsis

data FortuneFile
fortuneFilePath :: FortuneFile -> FilePath
fortuneIndexPath :: FortuneFile -> FilePath
openFortuneFile :: Char -> Bool -> FilePath -> IO FortuneFile
closeFortuneFile :: FortuneFile -> IO ()
getIndex :: FortuneFile -> IO Index
rebuildIndex :: FortuneFile -> IO ()
getFortune :: FortuneFile -> Int -> IO Text
getFortunes :: FortuneFile -> IO [Text]
getNumFortunes :: FortuneFile -> IO Int
appendFortune :: FortuneFile -> Text -> IO ()
data Index
openIndex :: FilePath -> Bool -> IO Index
createVirtualIndex :: IO Index
closeIndex :: Index -> IO ()
getStats :: Index -> IO FortuneStats
data StatsProblem
- = NegativeCount !Int
- | NegativeLength !Int
- | NegativeOffset !Int
- | LengthsWithoutEntries
- | EntriesWithoutLengths
- | MaxLengthLessThanMinLength
- | InconsistentLengthsForOneEntry
data HeaderProblem
- = BadMagicNumber !Word32
- | UnsupportedVersion !Word32
- | StatsProblem !StatsProblem
- | TableStartsBeforeHeaderEnds
data IndexProblem
- = HeaderProblem !HeaderProblem
- | TableLongerThanFile
- | AccessToClosedIndex
checkIndex :: Index -> IO (Maybe IndexProblem)
data IndexEntry = IndexEntry {
- stringOffset :: !Int
- stringBytes :: !Int
- stringChars :: !Int
- stringLines :: !Int
}
indexEntryStats :: IndexEntry -> FortuneStats
getEntries :: Index -> IO (Vector IndexEntry)
getEntry :: Index -> Int -> IO IndexEntry
unfoldEntries :: Index -> IO (Maybe IndexEntry) -> IO ()
appendEntries :: Index -> Vector IndexEntry -> IO ()
appendEntry :: Index -> IndexEntry -> IO ()
clearIndex :: Index -> IO ()
rebuildStats :: Index -> IO ()
data FortuneStats
numFortunes :: FortuneStats -> Int
minChars :: FortuneStats -> Int
maxLines :: FortuneStats -> Int
minLines :: FortuneStats -> Int
maxChars :: FortuneStats -> Int
listFortuneFiles :: Bool -> FilePath -> IO [FilePath]
listFortuneFilesIn :: [(FilePath, Bool)] -> IO [FilePath]
findFortuneFile :: Bool -> FilePath -> String -> IO [FilePath]
findFortuneFileIn :: [(String, Bool)] -> String -> IO [FilePath]
findFortuneFilesIn :: [(String, Bool)] -> [String] -> IO [FilePath]
data FortuneType
- = All
- | Normal
- | Offensive
getFortuneDir :: FortuneType -> IO FilePath
defaultFortuneFiles :: FortuneType -> IO [FilePath]
defaultFortuneSearchPath :: FortuneType -> IO [(FilePath, Bool)]
getFortuneSearchPath :: FortuneType -> IO [(FilePath, Bool)]
resolveFortuneFile :: FortuneType -> String -> IO [FilePath]
resolveFortuneFiles :: FortuneType -> [String] -> IO [FilePath]
randomFortune :: [String] -> IO String
randomFortuneFromRandomFile :: RVar FortuneFile -> IO String
defaultFortuneDistribution :: [FortuneFile] -> IO (Categorical Float FortuneFile)
fortuneDistributionWhere :: (FortuneFile -> Int -> IndexEntry -> IO Bool) -> [FortuneFile] -> IO (Categorical Float (FortuneFile, Categorical Float Int))
withFortuneFile :: Char -> Bool -> FilePath -> (FortuneFile -> IO a) -> IO a
withFortuneFiles :: Char -> Bool -> [FilePath] -> ([FortuneFile] -> IO a) -> IO a
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 a, Enum a) => (IndexEntry -> IO Bool) -> FortuneFile -> IO [a]
filterFortunes :: (Num t, Enum t) => (IndexEntry -> Bool) -> FortuneFile -> IO [t]

Documentation

data FortuneFile Source #

A handle to an open fortune database.

fortuneFilePath :: FortuneFile -> FilePath Source #

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

fortuneIndexPath :: FortuneFile -> FilePath Source #

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

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

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 () Source #

Close a fortune file. Subsequent accesses will fail.

getIndex :: FortuneFile -> IO Index Source #

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

rebuildIndex :: FortuneFile -> IO () Source #

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

getFortune :: FortuneFile -> Int -> IO Text Source #

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] Source #

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 Source #

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

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

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

data Index Source #

A handle to an open fortune index file.

openIndex :: FilePath -> Bool -> IO Index Source #

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 Source #

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

closeIndex :: Index -> IO () Source #

Close an index file. Subsequent accesses will fail.

getStats :: Index -> IO FortuneStats Source #

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

data StatsProblem Source #

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

Instances details

Exception StatsProblem Source #
Instance details Defined in Data.Fortune.Index Methods toException :: StatsProblem -> SomeException Source # fromException :: SomeException -> Maybe StatsProblem Source # displayException :: StatsProblem -> String Source #
Read StatsProblem Source #
Instance details Defined in Data.Fortune.Stats Methods readsPrec :: Int -> ReadS StatsProblem Source # readList :: ReadS [StatsProblem] Source # readPrec :: ReadPrec StatsProblem Source # readListPrec :: ReadPrec [StatsProblem] Source #
Show StatsProblem Source #
Instance details Defined in Data.Fortune.Stats Methods showsPrec :: Int -> StatsProblem -> ShowS Source # show :: StatsProblem -> String Source # showList :: [StatsProblem] -> ShowS Source #
Eq StatsProblem Source #
Instance details Defined in Data.Fortune.Stats Methods (==) :: StatsProblem -> StatsProblem -> Bool Source # (/=) :: StatsProblem -> StatsProblem -> Bool Source #
Ord StatsProblem Source #
Instance details Defined in Data.Fortune.Stats Methods compare :: StatsProblem -> StatsProblem -> Ordering Source # (<) :: StatsProblem -> StatsProblem -> Bool Source # (<=) :: StatsProblem -> StatsProblem -> Bool Source # (>) :: StatsProblem -> StatsProblem -> Bool Source # (>=) :: StatsProblem -> StatsProblem -> Bool Source # max :: StatsProblem -> StatsProblem -> StatsProblem Source # min :: StatsProblem -> StatsProblem -> StatsProblem Source #

data HeaderProblem Source #

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

Constructors

BadMagicNumber !Word32
UnsupportedVersion !Word32
StatsProblem !StatsProblem
TableStartsBeforeHeaderEnds

Instances

Instances details

Exception HeaderProblem Source #
Instance details Defined in Data.Fortune.Index Methods toException :: HeaderProblem -> SomeException Source # fromException :: SomeException -> Maybe HeaderProblem Source # displayException :: HeaderProblem -> String Source #
Read HeaderProblem Source #
Instance details Defined in Data.Fortune.Index Methods readsPrec :: Int -> ReadS HeaderProblem Source # readList :: ReadS [HeaderProblem] Source # readPrec :: ReadPrec HeaderProblem Source # readListPrec :: ReadPrec [HeaderProblem] Source #
Show HeaderProblem Source #
Instance details Defined in Data.Fortune.Index Methods showsPrec :: Int -> HeaderProblem -> ShowS Source # show :: HeaderProblem -> String Source # showList :: [HeaderProblem] -> ShowS Source #
Eq HeaderProblem Source #
Instance details Defined in Data.Fortune.Index Methods (==) :: HeaderProblem -> HeaderProblem -> Bool Source # (/=) :: HeaderProblem -> HeaderProblem -> Bool Source #
Ord HeaderProblem Source #
Instance details Defined in Data.Fortune.Index Methods compare :: HeaderProblem -> HeaderProblem -> Ordering Source # (<) :: HeaderProblem -> HeaderProblem -> Bool Source # (<=) :: HeaderProblem -> HeaderProblem -> Bool Source # (>) :: HeaderProblem -> HeaderProblem -> Bool Source # (>=) :: HeaderProblem -> HeaderProblem -> Bool Source # max :: HeaderProblem -> HeaderProblem -> HeaderProblem Source # min :: HeaderProblem -> HeaderProblem -> HeaderProblem Source #

data IndexProblem Source #

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

Constructors

HeaderProblem !HeaderProblem
TableLongerThanFile
AccessToClosedIndex

Instances

Instances details

Exception IndexProblem Source #
Instance details Defined in Data.Fortune.Index Methods toException :: IndexProblem -> SomeException Source # fromException :: SomeException -> Maybe IndexProblem Source # displayException :: IndexProblem -> String Source #
Read IndexProblem Source #
Instance details Defined in Data.Fortune.Index Methods readsPrec :: Int -> ReadS IndexProblem Source # readList :: ReadS [IndexProblem] Source # readPrec :: ReadPrec IndexProblem Source # readListPrec :: ReadPrec [IndexProblem] Source #
Show IndexProblem Source #
Instance details Defined in Data.Fortune.Index Methods showsPrec :: Int -> IndexProblem -> ShowS Source # show :: IndexProblem -> String Source # showList :: [IndexProblem] -> ShowS Source #
Eq IndexProblem Source #
Instance details Defined in Data.Fortune.Index Methods (==) :: IndexProblem -> IndexProblem -> Bool Source # (/=) :: IndexProblem -> IndexProblem -> Bool Source #
Ord IndexProblem Source #
Instance details Defined in Data.Fortune.Index Methods compare :: IndexProblem -> IndexProblem -> Ordering Source # (<) :: IndexProblem -> IndexProblem -> Bool Source # (<=) :: IndexProblem -> IndexProblem -> Bool Source # (>) :: IndexProblem -> IndexProblem -> Bool Source # (>=) :: IndexProblem -> IndexProblem -> Bool Source # max :: IndexProblem -> IndexProblem -> IndexProblem Source # min :: IndexProblem -> IndexProblem -> IndexProblem Source #

checkIndex :: Index -> IO (Maybe IndexProblem) Source #

Force a consistency check on an index file.

data IndexEntry Source #

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

Instances details

Show IndexEntry Source #
Instance details Defined in Data.Fortune.Index Methods showsPrec :: Int -> IndexEntry -> ShowS Source # show :: IndexEntry -> String Source # showList :: [IndexEntry] -> ShowS Source #
Eq IndexEntry Source #
Instance details Defined in Data.Fortune.Index Methods (==) :: IndexEntry -> IndexEntry -> Bool Source # (/=) :: IndexEntry -> IndexEntry -> Bool Source #
Ord IndexEntry Source #
Instance details Defined in Data.Fortune.Index Methods compare :: IndexEntry -> IndexEntry -> Ordering Source # (<) :: IndexEntry -> IndexEntry -> Bool Source # (<=) :: IndexEntry -> IndexEntry -> Bool Source # (>) :: IndexEntry -> IndexEntry -> Bool Source # (>=) :: IndexEntry -> IndexEntry -> Bool Source # max :: IndexEntry -> IndexEntry -> IndexEntry Source # min :: IndexEntry -> IndexEntry -> IndexEntry Source #

indexEntryStats :: IndexEntry -> FortuneStats Source #

Convert one index entry to a FortuneStats record describing it.

getEntries :: Index -> IO (Vector IndexEntry) Source #

Read all the entries in an Index

getEntry :: Index -> Int -> IO IndexEntry Source #

Read a specified entry from an Index.

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

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

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

Append all the given entries to the Index file.

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

Append a single IndexEntry to an Index file.

clearIndex :: Index -> IO () Source #

Delete all entries from an Index.

rebuildStats :: Index -> IO () Source #

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

data FortuneStats Source #

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

Instances details

Monoid FortuneStats Source #
Instance details Defined in Data.Fortune.Stats Methods mempty :: FortuneStats Source # mappend :: FortuneStats -> FortuneStats -> FortuneStats Source # mconcat :: [FortuneStats] -> FortuneStats Source #
Semigroup FortuneStats Source #
Instance details Defined in Data.Fortune.Stats Methods (<>) :: FortuneStats -> FortuneStats -> FortuneStats Source # sconcat :: NonEmpty FortuneStats -> FortuneStats Source # stimes :: Integral b => b -> FortuneStats -> FortuneStats Source #
Show FortuneStats Source #
Instance details Defined in Data.Fortune.Stats Methods showsPrec :: Int -> FortuneStats -> ShowS Source # show :: FortuneStats -> String Source # showList :: [FortuneStats] -> ShowS Source #
Eq FortuneStats Source #
Instance details Defined in Data.Fortune.Stats Methods (==) :: FortuneStats -> FortuneStats -> Bool Source # (/=) :: FortuneStats -> FortuneStats -> Bool Source #

numFortunes :: FortuneStats -> Int Source #

The number of fortune strings in the index

minChars :: FortuneStats -> Int Source #

The smallest number of characters in any string in the index

maxLines :: FortuneStats -> Int Source #

The greatest number of characters in any string in the index

minLines :: FortuneStats -> Int Source #

The smallest number of lines in any string in the index

maxChars :: FortuneStats -> Int Source #

The greatest number of lines in any string in the index

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

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] Source #

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] Source #

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

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

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

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

Like findFortuneFileIn but searches for multiple files in multiple directories.

data FortuneType Source #

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

Instances details

Bounded FortuneType Source #
Instance details Defined in Data.Fortune Methods minBound :: FortuneType Source # maxBound :: FortuneType Source #
Enum FortuneType Source #
Instance details Defined in Data.Fortune Methods succ :: FortuneType -> FortuneType Source # pred :: FortuneType -> FortuneType Source # toEnum :: Int -> FortuneType Source # fromEnum :: FortuneType -> Int Source # enumFrom :: FortuneType -> [FortuneType] Source # enumFromThen :: FortuneType -> FortuneType -> [FortuneType] Source # enumFromTo :: FortuneType -> FortuneType -> [FortuneType] Source # enumFromThenTo :: FortuneType -> FortuneType -> FortuneType -> [FortuneType] Source #
Read FortuneType Source #
Instance details Defined in Data.Fortune Methods readsPrec :: Int -> ReadS FortuneType Source # readList :: ReadS [FortuneType] Source # readPrec :: ReadPrec FortuneType Source # readListPrec :: ReadPrec [FortuneType] Source #
Show FortuneType Source #
Instance details Defined in Data.Fortune Methods showsPrec :: Int -> FortuneType -> ShowS Source # show :: FortuneType -> String Source # showList :: [FortuneType] -> ShowS Source #
Eq FortuneType Source #
Instance details Defined in Data.Fortune Methods (==) :: FortuneType -> FortuneType -> Bool Source # (/=) :: FortuneType -> FortuneType -> Bool Source #
Ord FortuneType Source #
Instance details Defined in Data.Fortune Methods compare :: FortuneType -> FortuneType -> Ordering Source # (<) :: FortuneType -> FortuneType -> Bool Source # (<=) :: FortuneType -> FortuneType -> Bool Source # (>) :: FortuneType -> FortuneType -> Bool Source # (>=) :: FortuneType -> FortuneType -> Bool Source # max :: FortuneType -> FortuneType -> FortuneType Source # min :: FortuneType -> FortuneType -> FortuneType Source #

getFortuneDir :: FortuneType -> IO FilePath Source #

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

defaultFortuneFiles :: FortuneType -> IO [FilePath] Source #

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

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

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

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

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] Source #

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

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

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

randomFortune :: [String] -> IO String Source #

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 Source #

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) Source #

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)) Source #

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 Source #

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 Source #

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] Source #

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

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

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

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

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

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

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