OrgStat.Scope

This module defines how report input is formed.

Documentation

newtype AstPath

Path in org AST is just a list of paths, head ~ closer to tree root.

Constructors

AstPath

Fields

• getAstPath :: [Text]

Instances

Eq AstPath

Defined in OrgStat.Scope

Methods

(==) :: AstPath -> AstPath -> Bool

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

Ord AstPath

Defined in OrgStat.Scope

Methods

compare :: AstPath -> AstPath -> Ordering

(<) :: AstPath -> AstPath -> Bool

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

(>) :: AstPath -> AstPath -> Bool

(>=) :: AstPath -> AstPath -> Bool

max :: AstPath -> AstPath -> AstPath

min :: AstPath -> AstPath -> AstPath

Show AstPath

Defined in OrgStat.Scope

Methods

showsPrec :: Int -> AstPath -> ShowS

show :: AstPath -> String

showList :: [AstPath] -> ShowS

FromJSON AstPath

Defined in OrgStat.Config

Methods

parseJSON :: Value -> Parser AstPath

parseJSONList :: Value -> Parser [AstPath]

isSubPath :: AstPath -> AstPath -> Bool

existsPath :: AstPath -> Org -> Bool

Checks if something is on that path in given Org.

data ScopeModifier

Modificicators of org tree. They remove some subtrees

Constructors

ModPruneSubtree AstPath Int

Turns all subtrees starting with path and then on depth d into leaves.

ModFilterTag Text

Given text tag name, it leaves only those subtrees that have this tag (tags are inherited).

ModSquash AstPath

Starting at node on path A and depth n, turn A into set of nodes Aa1a2...an. Doesn't work/make sense for empty path.

ModSelectSubtree AstPath

Leaves only node at path, deletes all other subtrees.

Instances

Eq ScopeModifier

Defined in OrgStat.Scope

Methods

(==) :: ScopeModifier -> ScopeModifier -> Bool

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

Ord ScopeModifier

Defined in OrgStat.Scope

Methods

compare :: ScopeModifier -> ScopeModifier -> Ordering

(<) :: ScopeModifier -> ScopeModifier -> Bool

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

(>) :: ScopeModifier -> ScopeModifier -> Bool

(>=) :: ScopeModifier -> ScopeModifier -> Bool

max :: ScopeModifier -> ScopeModifier -> ScopeModifier

min :: ScopeModifier -> ScopeModifier -> ScopeModifier

Show ScopeModifier

Defined in OrgStat.Scope

Methods

showsPrec :: Int -> ScopeModifier -> ShowS

show :: ScopeModifier -> String

showList :: [ScopeModifier] -> ShowS

FromJSON ScopeModifier

Defined in OrgStat.Config

Methods

parseJSON :: Value -> Parser ScopeModifier

parseJSONList :: Value -> Parser [ScopeModifier]

applyModifiers :: Org -> [ScopeModifier] -> Either ModifierError Org

Generates an org to be processed by report generators from Scope.