Origin.hs

-- | Origin information
--
-- When we generate Haskell code, we keep a record of their \"origin\": what
-- part of the C input corresponds to these definitions? We need this
-- information for various purposes:
--
-- * Generating tests
-- * Generating external binding specification
-- * Generating documentation
--
-- Intended for qualified import.
--
-- > import HsBindgen.Backend.Hs.Origin qualified as Origin
--
-- TODO: <https://github.com/well-typed/hs-bindgen/issues/1448>
-- This entire module can go once we generate binding specs based on C decls,
-- rather than the generated Hs decls.
module HsBindgen.Backend.Hs.Origin (
    -- * Declarations
    Decl(..)
  , Struct(..)
  , Newtype(..)
  , EmptyData(..)
  , ForeignImport(..)
  , PatSyn(..)
    -- * Fields
  , Field(..)
  ) where

import HsBindgen.Frontend.Pass.Final
import HsBindgen.Frontend.Pass.ResolveBindingSpecs.IsPass
import HsBindgen.Frontend.Pass.TypecheckMacros.IsPass
import HsBindgen.Imports
import HsBindgen.IR.C qualified as C

{-------------------------------------------------------------------------------
  Declarations
-------------------------------------------------------------------------------}

data Decl a = Decl{
      info :: C.DeclInfo Final
    , kind :: a            -- ^ Kind-specific information
    , spec :: PrescriptiveDeclSpec
    }
  deriving stock (Generic, Show)

data Struct =
    Struct (C.Struct Final)
  deriving stock (Generic, Show)

data Newtype =
    Enum    (C.Enum                         Final)
  | Typedef (C.Typedef                      Final)
  | Union   (C.Union                        Final)
  | Aux     (C.Typedef                      Final)
  | forall l. Macro (TypecheckedMacroType l Final)

deriving stock instance Show Newtype

data EmptyData =
    Opaque C.NameKind
  deriving stock (Generic, Show)

data ForeignImport =
    Function   (C.Function Final)
  | Global     (C.Type     Final)
  | ToFunPtr   (C.Type     Final)
  | FromFunPtr (C.Type     Final)
  deriving stock (Generic, Show)

newtype PatSyn =
    EnumConstant (C.EnumConstant Final)
  deriving stock (Generic, Show)

{-------------------------------------------------------------------------------
  Fields
-------------------------------------------------------------------------------}

data Field =
    GeneratedField  -- ^ Field without a direct counterpart in C
  | StructField (C.Field Final)
  deriving stock (Generic, Show)