Safe Haskell	None
Language	Haskell2010

TreeSitter.Unmarshal

Synopsis

parseByteString :: (Unmarshal t, UnmarshalAnn a) => Ptr Language -> ByteString -> IO (Either String (t a))
data UnmarshalState = UnmarshalState {
- source :: !ByteString
- cursor :: !(Ptr Cursor)
}
newtype UnmarshalError = UnmarshalError {
- getUnmarshalError :: String
}
newtype FieldName = FieldName {
- getFieldName :: String
}
class SymbolMatching t => Unmarshal t where
- matchers' :: IntMap (Match t)
- matchers :: B (Int, Match t)
class UnmarshalAnn a where
- unmarshalAnn :: Node -> MatchM a
class UnmarshalField t where
- unmarshalField :: (Unmarshal f, UnmarshalAnn a) => String -> String -> [Node] -> MatchM (t (f a))
class SymbolMatching (a :: * -> *) where
- matchedSymbols :: Proxy a -> [Int]
- showFailure :: Proxy a -> Node -> String
newtype Match t = Match {
- runMatch :: forall a. UnmarshalAnn a => Node -> MatchM (t a)
}
hoist :: (forall x. t x -> t' x) -> Match t -> Match t'
lookupSymbol :: TSSymbol -> IntMap a -> Maybe a
unmarshalNode :: forall t a. (UnmarshalAnn a, Unmarshal t) => Node -> MatchM (t a)
class GHasAnn a t where
- gann :: t a -> a

Documentation

parseByteString :: (Unmarshal t, UnmarshalAnn a) => Ptr Language -> ByteString -> IO (Either String (t a)) Source #

data UnmarshalState Source #

Constructors

UnmarshalState
Fields source :: !ByteString cursor :: !(Ptr Cursor)

newtype UnmarshalError Source #

Constructors

UnmarshalError
Fields getUnmarshalError :: String

Instances

Instances details

Show UnmarshalError Source #
Instance details Defined in TreeSitter.Unmarshal Methods showsPrec :: Int -> UnmarshalError -> ShowS # show :: UnmarshalError -> String # showList :: [UnmarshalError] -> ShowS #
Exception UnmarshalError Source #
Instance details Defined in TreeSitter.Unmarshal Methods toException :: UnmarshalError -> SomeException # fromException :: SomeException -> Maybe UnmarshalError # displayException :: UnmarshalError -> String #

newtype FieldName Source #

Constructors

FieldName
Fields getFieldName :: String

Instances

Instances details

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

class SymbolMatching t => Unmarshal t where Source #

Unmarshalling is the process of iterating over tree-sitter’s parse trees using its tree cursor API and producing Haskell ASTs for the relevant nodes.

Datatypes which can be constructed from tree-sitter parse trees may use the default definition of matchers providing that they have a suitable Generic1 instance.

Minimal complete definition

Nothing

Methods

matchers' :: IntMap (Match t) Source #

matchers :: B (Int, Match t) Source #

default matchers :: (Generic1 t, GUnmarshal (Rep1 t)) => B (Int, Match t) Source #

Instances

Instances details

Unmarshal t => Unmarshal (Rec1 t) Source #
Instance details Defined in TreeSitter.Unmarshal Methods matchers' :: IntMap (Match (Rec1 t)) Source # matchers :: B (Int, Match (Rec1 t)) Source #
(KnownNat n, KnownSymbol sym) => Unmarshal (Token sym n) Source #
Instance details Defined in TreeSitter.Unmarshal Methods matchers' :: IntMap (Match (Token sym n)) Source # matchers :: B (Int, Match (Token sym n)) Source #
(Unmarshal f, Unmarshal g) => Unmarshal (f :+: g) Source #
Instance details Defined in TreeSitter.Unmarshal Methods matchers' :: IntMap (Match (f :+: g)) Source # matchers :: B (Int, Match (f :+: g)) Source #

class UnmarshalAnn a where Source #

Unmarshal an annotation field.

Leaf nodes have Text fields, and leaves, anonymous leaves, and products all have parametric annotation fields. All of these fields are unmarshalled using the metadata of the node, e.g. its start/end bytes, without reference to any child nodes it may contain.

Methods

unmarshalAnn :: Node -> MatchM a Source #

Instances

Instances details

UnmarshalAnn () Source #
Instance details Defined in TreeSitter.Unmarshal Methods unmarshalAnn :: Node -> MatchM () Source #
UnmarshalAnn Text Source #
Instance details Defined in TreeSitter.Unmarshal Methods unmarshalAnn :: Node -> MatchM Text Source #
UnmarshalAnn Loc Source #
Instance details Defined in TreeSitter.Unmarshal Methods unmarshalAnn :: Node -> MatchM Loc Source #
UnmarshalAnn Range Source #
Instance details Defined in TreeSitter.Unmarshal Methods unmarshalAnn :: Node -> MatchM Range Source #
UnmarshalAnn Span Source #
Instance details Defined in TreeSitter.Unmarshal Methods unmarshalAnn :: Node -> MatchM Span Source #
(UnmarshalAnn a, UnmarshalAnn b) => UnmarshalAnn (a, b) Source #	Instance for pairs of annotations
Instance details Defined in TreeSitter.Unmarshal Methods unmarshalAnn :: Node -> MatchM (a, b) Source #

class UnmarshalField t where Source #

Optional/repeated fields occurring in product datatypes are wrapped in type constructors, e.g. Maybe, '[]', or NonEmpty, and thus can unmarshal zero or more nodes for the same field name.

Methods

unmarshalField Source #

Arguments

:: (Unmarshal f, UnmarshalAnn a)
=> String	datatype name
-> String	field name
-> [Node]	nodes
-> MatchM (t (f a))

Instances

Instances details

UnmarshalField [] Source #
Instance details Defined in TreeSitter.Unmarshal Methods unmarshalField :: (Unmarshal f, UnmarshalAnn a) => String -> String -> [Node] -> MatchM [f a] Source #
UnmarshalField Maybe Source #
Instance details Defined in TreeSitter.Unmarshal Methods unmarshalField :: (Unmarshal f, UnmarshalAnn a) => String -> String -> [Node] -> MatchM (Maybe (f a)) Source #
UnmarshalField NonEmpty Source #
Instance details Defined in TreeSitter.Unmarshal Methods unmarshalField :: (Unmarshal f, UnmarshalAnn a) => String -> String -> [Node] -> MatchM (NonEmpty (f a)) Source #

class SymbolMatching (a :: * -> *) where Source #

Methods

matchedSymbols :: Proxy a -> [Int] Source #

showFailure :: Proxy a -> Node -> String Source #

Provide error message describing the node symbol vs. the symbols this can match

Instances

Instances details

SymbolMatching f => SymbolMatching (Rec1 f) Source #
Instance details Defined in TreeSitter.Unmarshal Methods matchedSymbols :: Proxy (Rec1 f) -> [Int] Source # showFailure :: Proxy (Rec1 f) -> Node -> String Source #
(KnownNat n, KnownSymbol sym) => SymbolMatching (Token sym n) Source #
Instance details Defined in TreeSitter.Unmarshal Methods matchedSymbols :: Proxy (Token sym n) -> [Int] Source # showFailure :: Proxy (Token sym n) -> Node -> String Source #
(SymbolMatching f, SymbolMatching g) => SymbolMatching (f :+: g) Source #
Instance details Defined in TreeSitter.Unmarshal Methods matchedSymbols :: Proxy (f :+: g) -> [Int] Source # showFailure :: Proxy (f :+: g) -> Node -> String Source #
SymbolMatching f => SymbolMatching (M1 i c f) Source #
Instance details Defined in TreeSitter.Unmarshal Methods matchedSymbols :: Proxy (M1 i c f) -> [Int] Source # showFailure :: Proxy (M1 i c f) -> Node -> String Source #

newtype Match t Source #

Constructors

Match
Fields runMatch :: forall a. UnmarshalAnn a => Node -> MatchM (t a)

hoist :: (forall x. t x -> t' x) -> Match t -> Match t' Source #

lookupSymbol :: TSSymbol -> IntMap a -> Maybe a Source #

unmarshalNode :: forall t a. (UnmarshalAnn a, Unmarshal t) => Node -> MatchM (t a) Source #

Unmarshal a node

class GHasAnn a t where Source #

Methods

gann :: t a -> a Source #

Instances

Instances details

HasField "ann" (t a) a => GHasAnn a t Source #
Instance details Defined in TreeSitter.Unmarshal Methods gann :: t a -> a Source #
(GHasAnn a l, GHasAnn a r) => GHasAnn a (l :+: r) Source #
Instance details Defined in TreeSitter.Unmarshal Methods gann :: (l :+: r) a -> a Source #
GHasAnn a f => GHasAnn a (M1 i c f) Source #
Instance details Defined in TreeSitter.Unmarshal Methods gann :: M1 i c f a -> a Source #