| Safe Haskell | None |
|---|
Penny.Liberty
Contents
Description
Liberty - Penny command line parsing utilities
Both Cabin and Zinc share various functions that aid in parsing command lines. For instance both the Postings report and the Zinc postings filter use common command-line options. However, Zinc already depends on Cabin. To avoid a cyclic dependency whereby Cabin would also depend on Zinc, functions formerly in Zinc that Cabin will also find useful are relocated here, to Liberty.
- type MatcherFactory = CaseSensitive -> Text -> Exceptional Text (Text -> Bool)
- evaluate :: Foldable l => l (Token a) -> Maybe a
- data Token a
- = TokOperand a
- | TokUnaryPostfix (a -> a)
- | TokUnaryPrefix Precedence (a -> a)
- | TokBinary Precedence Associativity (a -> a -> a)
- | TokOpenParen
- | TokCloseParen
- newtype FilteredNum = FilteredNum {}
- newtype SortedNum = SortedNum {}
- data LibertyMeta
- xactionsToFiltered :: (PostFam -> Bool) -> [PostFilterFn] -> (PostFam -> PostFam -> Ordering) -> [Transaction] -> [Box LibertyMeta]
- newtype ListLength = ListLength {
- unListLength :: Int
- newtype ItemIndex = ItemIndex {
- unItemIndex :: Int
- type PostFilterFn = ListLength -> ItemIndex -> Bool
- parseComparer :: (Eq a, Ord a) => String -> Exceptional String (a -> a -> Bool)
- processPostFilters :: [PostFilterFn] -> [a] -> [a]
- parseTokenList :: [Token a] -> Maybe a
- parsePredicate :: [Token (a -> Bool)] -> Maybe (a -> Bool)
- parseInt :: String -> Exceptional String Int
- type Operand = Operand (PostFam -> Bool)
- operandSpecs :: DateTime -> [OptSpec (CaseSensitive -> MatcherFactory -> Exceptional String Operand)]
- postFilterSpecs :: (OptSpec (Exceptional String PostFilterFn), OptSpec (Exceptional String PostFilterFn))
- matcherSelectSpecs :: [OptSpec MatcherFactory]
- caseSelectSpecs :: [OptSpec CaseSensitive]
- operatorSpecs :: [OptSpec (Token (a -> Bool))]
Documentation
type MatcherFactory = CaseSensitive -> Text -> Exceptional Text (Text -> Bool)Source
evaluate :: Foldable l => l (Token a) -> Maybe aSource
Tokens should be enqueued from left to right, so that tokens on the left side of the sequence are those at the beginning of the expression.
Constructors
| TokOperand a | |
| TokUnaryPostfix (a -> a) | |
| TokUnaryPrefix Precedence (a -> a) | |
| TokBinary Precedence Associativity (a -> a -> a) | |
| TokOpenParen | |
| TokCloseParen |
newtype FilteredNum Source
A serial indicating how a post relates to all other postings that made it through the filtering phase.
Constructors
| FilteredNum | |
Fields | |
Instances
A serial indicating how a posting relates to all other postings that have been sorted.
Constructors
| SortedNum | |
Fields | |
Arguments
| :: (PostFam -> Bool) | The predicate to filter the transactions |
| -> [PostFilterFn] | Post filter specs |
| -> (PostFam -> PostFam -> Ordering) | The sorter |
| -> [Transaction] | The transactions to work on (probably parsed in from Copper) |
| -> [Box LibertyMeta] | Sorted, filtered postings |
Takes a list of transactions, splits them into PostingChild instances, filters them, post-filters them, sorts them, and places them in Box instances with Filtered serials.
Constructors
| ItemIndex | |
Fields
| |
type PostFilterFn = ListLength -> ItemIndex -> BoolSource
Specifies options for the post-filter stage.
parseComparer :: (Eq a, Ord a) => String -> Exceptional String (a -> a -> Bool)Source
Parses comparers given on command line to a function. Aborts if the string given is invalid.
processPostFilters :: [PostFilterFn] -> [a] -> [a]Source
parseTokenList :: [Token a] -> Maybe aSource
Parses a list of tokens. Returns Nothing if the token sequence is invalid (e.g. if two operators are next to each other) or if the resulting RPN expression is bad (there are tokens left on the stack after parsing). Otherwise, returns the expression.
An empty list will fail to parse. The function calling this one must deal with empty lists if those are a possibility.
parsePredicate :: [Token (a -> Bool)] -> Maybe (a -> Bool)Source
Parses a list of tokens to obtain a predicate. Deals with an empty list of tokens by returning a predicate that is always True. Fails if the list of tokens is not empty and the parse fails.
parseInt :: String -> Exceptional String IntSource
Parses exactly one integer; fails if it cannot read exactly one.
Parsers
operandSpecs :: DateTime -> [OptSpec (CaseSensitive -> MatcherFactory -> Exceptional String Operand)]Source
All operand OptSpec.
postFilterSpecs :: (OptSpec (Exceptional String PostFilterFn), OptSpec (Exceptional String PostFilterFn))Source
operatorSpecs :: [OptSpec (Token (a -> Bool))]Source