Deduplicate AtomWrapper, Repeat, and SymFns code across macaw-*-symbolic packages

[RyanGlScott]

The macaw-*-symbolic suite of packages all define various boilerplate code in order to translate Macaw into Crucible, and each package in the suite duplicates all of this boilerplate. I propose that we deduplicate this code and put it in a better home (perhaps in macaw-symbolic, parameterized-utils, or elsewhere).

AtomWrapper

This is defined separately in macaw-aarch32-symbolic, macaw-ppc-symbolic, macaw-riscv-symbolic, and macaw-x86-symbolic:

macaw/macaw-aarch32-symbolic/src/Data/Macaw/AArch32/Symbolic/AtomWrapper.hs

Lines 17 to 29 in eb0a3c7

	newtype AtomWrapper (f :: C.CrucibleType -> Type) (tp :: MT.Type)
	= AtomWrapper (f (MS.ToCrucibleType tp))
	liftAtomMap :: (forall s. f s -> g s) -> AtomWrapper f t -> AtomWrapper g t
	liftAtomMap f (AtomWrapper x) = AtomWrapper (f x)
	liftAtomTrav ::
	Functor m =>
	(forall s. f s -> m (g s)) -> (AtomWrapper f t -> m (AtomWrapper g t))
	liftAtomTrav f (AtomWrapper x) = AtomWrapper <$> f x
	liftAtomIn :: (forall s. f s -> a) -> AtomWrapper f t -> a
	liftAtomIn f (AtomWrapper x) = f x

macaw/macaw-ppc-symbolic/src/Data/Macaw/PPC/Symbolic/AtomWrapper.hs

Lines 16 to 28 in eb0a3c7

	newtype AtomWrapper (f :: C.CrucibleType -> DK.Type) (tp :: MT.Type)
	= AtomWrapper (f (MS.ToCrucibleType tp))
	liftAtomMap :: (forall s. f s -> g s) -> AtomWrapper f t -> AtomWrapper g t
	liftAtomMap f (AtomWrapper x) = AtomWrapper (f x)
	liftAtomTrav ::
	Functor m =>
	(forall s. f s -> m (g s)) -> (AtomWrapper f t -> m (AtomWrapper g t))
	liftAtomTrav f (AtomWrapper x) = AtomWrapper <$> f x
	liftAtomIn :: (forall s. f s -> a) -> AtomWrapper f t -> a
	liftAtomIn f (AtomWrapper x) = f x

macaw/macaw-riscv-symbolic/src/Data/Macaw/RISCV/Symbolic/AtomWrapper.hs

Lines 17 to 29 in 1a2b928

	newtype AtomWrapper (f :: C.CrucibleType -> Type) (tp :: MT.Type)
	= AtomWrapper (f (MS.ToCrucibleType tp))
	liftAtomMap :: (forall s. f s -> g s) -> AtomWrapper f t -> AtomWrapper g t
	liftAtomMap f (AtomWrapper x) = AtomWrapper (f x)
	liftAtomTrav ::
	Functor m =>
	(forall s. f s -> m (g s)) -> (AtomWrapper f t -> m (AtomWrapper g t))
	liftAtomTrav f (AtomWrapper x) = AtomWrapper <$> f x
	liftAtomIn :: (forall s. f s -> a) -> AtomWrapper f t -> a
	liftAtomIn f (AtomWrapper x) = f x

macaw/x86_symbolic/src/Data/Macaw/X86/Crucible.hs

Lines 1059 to 1071 in eb0a3c7

	newtype AtomWrapper (f :: CrucibleType -> Type) (tp :: M.Type)
	= AtomWrapper (f (ToCrucibleType tp))
	liftAtomMap :: (forall s. f s -> g s) -> AtomWrapper f t -> AtomWrapper g t
	liftAtomMap f (AtomWrapper x) = AtomWrapper (f x)
	liftAtomTrav ::
	Functor m =>
	(forall s. f s -> m (g s)) -> (AtomWrapper f t -> m (AtomWrapper g t))
	liftAtomTrav f (AtomWrapper x) = AtomWrapper <$> f x
	liftAtomIn :: (forall s. f s -> a) -> AtomWrapper f t -> a
	liftAtomIn f (AtomWrapper x) = f x

Repeat

This is defined separately in macaw-ppc-symbolic, macaw-riscv-symbolic, and macaw-x86-symbolic:

macaw/macaw-ppc-symbolic/src/Data/Macaw/PPC/Symbolic/Repeat.hs

Lines 17 to 30 in eb0a3c7

	type family CtxRepeat (n :: Nat) (c :: k) :: Ctx.Ctx k where
	CtxRepeat 0 c = Ctx.EmptyCtx
	CtxRepeat n c = CtxRepeat (n - 1) c Ctx.::> c
	class RepeatAssign (tp :: k) (ctx :: Ctx.Ctx k) where
	repeatAssign :: (Int -> f tp) -> Ctx.Assignment f ctx
	instance RepeatAssign tp Ctx.EmptyCtx where
	repeatAssign _ = Ctx.Empty
	instance RepeatAssign tp ctx => RepeatAssign tp (ctx Ctx.::> tp) where
	repeatAssign f =
	let r = repeatAssign f
	in r Ctx.:> f (Ctx.sizeInt (Ctx.size r))

macaw/macaw-riscv-symbolic/src/Data/Macaw/RISCV/Symbolic/Repeat.hs

Lines 17 to 30 in 1a2b928

	type family CtxRepeat (n :: Nat) (c :: k) :: Ctx.Ctx k where
	CtxRepeat 0 c = Ctx.EmptyCtx
	CtxRepeat n c = CtxRepeat (n - 1) c Ctx.::> c
	class RepeatAssign (tp :: k) (ctx :: Ctx.Ctx k) where
	repeatAssign :: (Int -> f tp) -> Ctx.Assignment f ctx
	instance RepeatAssign tp Ctx.EmptyCtx where
	repeatAssign _ = Ctx.Empty
	instance RepeatAssign tp ctx => RepeatAssign tp (ctx Ctx.::> tp) where
	repeatAssign f =
	let r = repeatAssign f
	in r Ctx.:> f (Ctx.sizeInt (Ctx.size r))

macaw/x86_symbolic/src/Data/Macaw/X86/Symbolic.hs

Lines 67 to 80 in eb0a3c7

	type family CtxRepeat (n :: Nat) (c :: k) :: Ctx k where
	CtxRepeat 0 c = EmptyCtx
	CtxRepeat n c = CtxRepeat (n-1) c ::> c
	class RepeatAssign (tp :: k) (ctx :: Ctx k) where
	repeatAssign :: (Int -> f tp) -> Assignment f ctx
	instance RepeatAssign tp EmptyCtx where
	repeatAssign _ = Empty
	instance RepeatAssign tp ctx => RepeatAssign tp (ctx ::> tp) where
	repeatAssign f =
	let r = repeatAssign f
	in r :> f (sizeInt (Ctx.size r))

SymFns

This is defined separately in macaw-aarch32-symbolic and macaw-ppc-symbolic:

macaw/macaw-aarch32-symbolic/src/Data/Macaw/AArch32/Symbolic/Functions.hs

Lines 40 to 45 in eb0a3c7

	data SomeSymFun sym where
	SomeSymFun :: Ctx.Assignment WT.BaseTypeRepr ps -> WT.BaseTypeRepr r -> WI.SymFn sym ps r -> SomeSymFun sym
	data SymFuns sym =
	SymFuns { symFuns :: IOR.IORef (Map.Map String (SomeSymFun sym))
	}

macaw/macaw-ppc-symbolic/src/Data/Macaw/PPC/Symbolic/Functions.hs

Lines 47 to 52 in eb0a3c7

	data SomeSymFun sym where
	SomeSymFun :: Ctx.Assignment C.BaseTypeRepr ps -> C.BaseTypeRepr r -> C.SymFn sym ps r -> SomeSymFun sym
	data SymFuns sym =
	SymFuns { symFuns :: IO.IORef (M.Map String (SomeSymFun sym))
	}