Final.hs

{-# OPTIONS_GHC -Wno-orphans #-}

-- | Working with the frontend AST after the final pass
--
-- Intended for unqualified import.
module HsBindgen.Frontend.Pass.Final (
    Final
  ) where

import GHC.Records

import HsBindgen.Frontend.Pass.MangleNames.IsPass qualified as MangleNames
import HsBindgen.Frontend.Pass.Select.IsPass
import HsBindgen.Frontend.Pass.TypecheckMacros.IsPass
import HsBindgen.IR.C qualified as C

{-------------------------------------------------------------------------------
  Definition
-------------------------------------------------------------------------------}

-- | Final frontend pass
--
-- Backend passes should refer to 'Final' instead of the actual name of the
-- final pass, so that if we add more passes, the backend is unaffected.
type Final = Select

{-------------------------------------------------------------------------------
  Annotations

  These virtual fields help protect the backend against changes in the frontend:
  if we add further annotations, these virtual fields can continue to
  exist.
-------------------------------------------------------------------------------}

instance HasField "names" (C.Struct Final) MangleNames.StructNames where
  getField struct = struct.ann

instance HasField "names" (C.Union Final) MangleNames.NewtypeNames where
  getField union = union.ann

instance HasField "names" (C.Enum Final) MangleNames.NewtypeNames where
  getField enum = enum.ann

instance HasField "names" (C.Typedef Final) MangleNames.TypedefNames where
  getField typedef = typedef.ann

instance HasField "names" (TypecheckedMacroType l Final) MangleNames.NewtypeNames where
  getField macro = macro.ann