HieAST.hs

data HieToken = HieToken
    { htkInfo :: TokenType
    , htkSpan :: Span
    , htkDetails :: Maybe TokenDetails
    , htkType :: Maybe TypeIndex
    }

data HieAST = 
    Leaf HieToken
  | Node
    { nodeInfo :: NodeInfo -- ^ Can include the type and constructor this node corresponds to in HsSyn
    , nodeSpan :: Span
    , nodeChildren :: [HieAST] -- ^ in the order they appear in the source, elements should have disjoin spans and be entirely contained in the parent span.
    } -- ^ Root Node will span the entire file 
    
-- flattenAST ast should be a superset of [RichToken] that is consumed by the haddock hyperlinker
flattenAST :: HieAST -> [HieToken]
flattenAST (Leaf a) = [a]
flattenAST (Node _ _ xs) = concatMap flattenAST xs
    
data HieFile = HieFile
    { hieVersion :: String
    , ghcVersion :: String
    , hsFile     :: String
    , hieTypes   :: Array TypeIndex GHC.Type
    , hieAST     :: HieAST
    , hsSrc      :: String -- ^ the original file source
    }

type NodeInfo = [String] -- ^ For now, might add type info

type Span = GHC.RealSrcSpan

type TypeIndex = Int

-- Stolen from haddock hyperlinker
data TokenType
    = TkIdentifier
    | TkKeyword
    | TkString
    | TkChar
    | TkNumber
    | TkOperator
    | TkGlyph
    | TkSpecial
    | TkSpace
    | TkComment
    | TkCpp
    | TkPragma
    | TkUnknown
    deriving (Show, Eq)

data TokenDetails
    = RtkVar GHC.Name
    | RtkType GHC.Name
    | RtkBind GHC.Name
    | RtkDecl GHC.Name
    | RtkModule GHC.ModuleName
    deriving (Eq)