TreeSitter.Unmarshal

Documentation

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

data UnmarshalState

Constructors

UnmarshalState

Fields

• source :: !ByteString
• cursor :: !(Ptr Cursor)

newtype UnmarshalError

Constructors

UnmarshalError

Fields

• getUnmarshalError :: String

Instances

Show UnmarshalError

Defined in TreeSitter.Unmarshal

Methods

showsPrec :: Int -> UnmarshalError -> ShowS

show :: UnmarshalError -> String

showList :: [UnmarshalError] -> ShowS

Exception UnmarshalError

Defined in TreeSitter.Unmarshal

Methods

toException :: UnmarshalError -> SomeException

fromException :: SomeException -> Maybe UnmarshalError

displayException :: UnmarshalError -> String

newtype FieldName

Constructors

FieldName

Fields

• getFieldName :: String

Instances

Eq FieldName

Defined in TreeSitter.Unmarshal

Methods

(==) :: FieldName -> FieldName -> Bool

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

Ord FieldName

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

Defined in TreeSitter.Unmarshal

Methods

showsPrec :: Int -> FieldName -> ShowS

show :: FieldName -> String

showList :: [FieldName] -> ShowS

class SymbolMatching t => Unmarshal t where

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)

matchers :: B (Int, Match t)

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

Instances

Unmarshal t => Unmarshal (Rec1 t)

Defined in TreeSitter.Unmarshal

Methods

matchers' :: IntMap (Match (Rec1 t))

matchers :: B (Int, Match (Rec1 t))

(KnownNat n, KnownSymbol sym) => Unmarshal (Token sym n)

Defined in TreeSitter.Unmarshal

Methods

matchers' :: IntMap (Match (Token sym n))

matchers :: B (Int, Match (Token sym n))

(Unmarshal f, Unmarshal g) => Unmarshal (f :+: g)

Defined in TreeSitter.Unmarshal

Methods

matchers' :: IntMap (Match (f :+: g))

matchers :: B (Int, Match (f :+: g))

class UnmarshalAnn a where

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

Instances

UnmarshalAnn ()

Defined in TreeSitter.Unmarshal

Methods

unmarshalAnn :: Node -> MatchM ()

UnmarshalAnn Text

Defined in TreeSitter.Unmarshal

Methods

unmarshalAnn :: Node -> MatchM Text

UnmarshalAnn Loc

Defined in TreeSitter.Unmarshal

Methods

unmarshalAnn :: Node -> MatchM Loc

UnmarshalAnn Range

Defined in TreeSitter.Unmarshal

Methods

unmarshalAnn :: Node -> MatchM Range

UnmarshalAnn Span

Defined in TreeSitter.Unmarshal

Methods

unmarshalAnn :: Node -> MatchM Span

(UnmarshalAnn a, UnmarshalAnn b) => UnmarshalAnn (a, b)

Instance for pairs of annotations

Defined in TreeSitter.Unmarshal

Methods

unmarshalAnn :: Node -> MatchM (a, b)

class UnmarshalField t where

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

Arguments

:: (Unmarshal f, UnmarshalAnn a)

=> String

datatype name

-> String

field name

-> [Node]

nodes

-> MatchM (t (f a))

Instances

UnmarshalField []

Defined in TreeSitter.Unmarshal

Methods

unmarshalField :: (Unmarshal f, UnmarshalAnn a) => String -> String -> [Node] -> MatchM [f a]

UnmarshalField Maybe

Defined in TreeSitter.Unmarshal

Methods

unmarshalField :: (Unmarshal f, UnmarshalAnn a) => String -> String -> [Node] -> MatchM (Maybe (f a))

UnmarshalField NonEmpty

Defined in TreeSitter.Unmarshal

Methods

unmarshalField :: (Unmarshal f, UnmarshalAnn a) => String -> String -> [Node] -> MatchM (NonEmpty (f a))

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

Methods

matchedSymbols :: Proxy a -> [Int]

showFailure :: Proxy a -> Node -> String

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

Instances

SymbolMatching f => SymbolMatching (Rec1 f)

Defined in TreeSitter.Unmarshal

Methods

matchedSymbols :: Proxy (Rec1 f) -> [Int]

showFailure :: Proxy (Rec1 f) -> Node -> String

(KnownNat n, KnownSymbol sym) => SymbolMatching (Token sym n)

Defined in TreeSitter.Unmarshal

Methods

matchedSymbols :: Proxy (Token sym n) -> [Int]

showFailure :: Proxy (Token sym n) -> Node -> String

(SymbolMatching f, SymbolMatching g) => SymbolMatching (f :+: g)

Defined in TreeSitter.Unmarshal

Methods

matchedSymbols :: Proxy (f :+: g) -> [Int]

showFailure :: Proxy (f :+: g) -> Node -> String

SymbolMatching f => SymbolMatching (M1 i c f)

Defined in TreeSitter.Unmarshal

Methods

matchedSymbols :: Proxy (M1 i c f) -> [Int]

showFailure :: Proxy (M1 i c f) -> Node -> String

newtype Match t

Constructors

Match

Fields

• 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)

Unmarshal a node

class GHasAnn a t where

Methods

gann :: t a -> a

Instances

HasField "ann" (t a) a => GHasAnn a t

Defined in TreeSitter.Unmarshal

Methods

gann :: t a -> a

(GHasAnn a l, GHasAnn a r) => GHasAnn a (l :+: r)

Defined in TreeSitter.Unmarshal

Methods

gann :: (l :+: r) a -> a

GHasAnn a f => GHasAnn a (M1 i c f)

Defined in TreeSitter.Unmarshal

Methods

gann :: M1 i c f a -> a