Text.Eros.Phraselist

If you want to make your own phraselist, you need to write a JSON file, in accordance with the schema. Once you do that, make a data type for your phraselist. Make your data type an instance of Phraselist, and you're good to go.

For example, let's say your phraselist is mylist.json, and it's all in accordance with the schema. Your code would look something like this:

data MyList = MyList

instance Phraselist MyList where
  phraselistPath MyList = getDataFileName "mylist.json"
  phraselistPath _      = undefined

Don't forget to add mylist.json to Data-Files in your .cabal file.

If you want to use one of the lists we already supply

Documentation

readPhraselist :: Phraselist t => t -> IO PhraseForest

Read a Phraselist, marshal it into a PhraseForest.

readPhraseMap :: Phraselist t => t -> IO PhraseMap

Load a Phraselist directly into a PhraseMap

servePhraselist :: Phraselist t => t -> IO ByteString

Read the phraselist from disk

class Phraselist t where

Methods

phraselistPath :: t -> IO FilePath

Instances

Phraselist ErosList

type PhraselistSet = Phraselist t => [t]

A set of Phraselists. Note that this is actually a list, and I'm calling it a "set" for purely lexical purposes.

data ErosList

The phraselists in res/. Each of these constructors correspond to one of the files here.

Gitlab has a terrible interface, so I won't provide links to each one of them.

Constructors

Chat

Conspiracy

DrugAdvocacy

Forums

Gambling

Games

Gore

IdTheft

IllegalDrugs

Intolerance

LegalDrugs

Malware

Music

News

Nudism

Peer2Peer

Personals

Pornography

Proxies

SecretSocieties

SelfLabeling

Sport

Translation

UpstreamFilter

Violence

WarezHacking

Weapons

Webmail

Instances

Eq ErosList

Phraselist ErosList

erosLists :: [ErosList]

A list of phraselists we provide.

erosListPaths :: IO [FilePath]

A list of the paths to the phraselists we provide.

erosListNames :: [Text]

erosListNamePairs :: [(ErosList, Text)]

You can't really order the lists, so we won't use Map

erosNameByList :: ErosList -> Maybe Text

erosNameListMap :: Map Text ErosList

erosListByName :: Text -> Maybe ErosList

data PhraseAlmostTree

Placeholder type used to read JSON. The JSON schema (currently, at least) is such that one needs this type to read the JSON. You can use fromPAT to convert this type into a PhraseTree

Constructors

PhraseAlmostTree

Fields

patPhrase :: Text

patScore :: Int

patForest :: [PhraseAlmostTree]

Instances

Read PhraseAlmostTree

Show PhraseAlmostTree

FromJSON PAT

You can read the JSON schema to see how this works.

type PAT = PhraseAlmostTree

Alias for PhraseAlmostTree

fromPAT :: PAT -> PhraseTree

Convert a PAT into a PhraseTree.

fromPhraseAlmostTree :: PAT -> PhraseTree

I figure some people like to type a lot.

loadPhraselist :: Phraselist t => t -> IO PhraseForest

Alias for readPhraselist

readPhraseFile :: Phraselist t => t -> IO PhraseForest

Alias for readPhraselist

loadPhraseFile :: Phraselist t => t -> IO PhraseForest

Alias for readPhraselist

readPhraseForest :: Phraselist t => t -> IO PhraseForest

Alias for readPhraselist

loadPhraseForest :: Phraselist t => t -> IO PhraseForest

Alias for readPhraselist

loadPhraseMap :: Phraselist t => t -> IO PhraseMap

Alias for readPhraseMap