Improve error message when a synthesized method or noinline function uses a type lacking a Bit or SplitPorts instance

Author: krame505

src/comp/ContextErrors.hs

@@ -462,9 +462,17 @@ handleCtxRedPrimPort pos (vp, reduced_ps) userty =
 -- --------------------
 
 handleCtxRedWrapField:: Position -> (VPred, [VPred]) -> FString -> Type -> EMsg
-handleCtxRedWrapField pos (vp, reduced_ps) name userty =
-    (pos, EBadIfcType (getFString name)
-     "This method uses types that are not in the Bits or SplitPorts typeclasses.")
+handleCtxRedWrapField pos (vp, reduced_ps) name userty = 
+    (pos, EBadIfcType Nothing $
+     "The interface method `" ++ getFString name ++
+     "' uses type(s) that are not in the Bits or SplitPorts typeclasses: " ++
+     intercalate ", " (concatMap bitsPredType reduced_ps)
+     )
+    where
+      bitsPredType :: VPred -> [String]
+      bitsPredType (VPred _ (PredWithPositions (IsIn (Class { name=(CTypeclass cid) }) [t, _]) _))
+        | cid == idBits = [pfpString t]
+      bitsPredType _ = []
 
 
 -- ========================================================================

src/comp/Error.hs

@@ -805,7 +805,7 @@ data ErrMsg =
         | EPolyField
         | ENotKNum String
         | EBadGenArg String
-        | EBadIfcType String String
+        | EBadIfcType (Maybe String) String
         | EBadForeignIfcType String
         | ENoTypeSign String
         | EStmtContext String
@@ -2120,9 +2120,12 @@ getErrorText (ENotKNum t) =
     (Type 41, empty, s2par ("Only size polymorphism allowed in code generation: " ++ t))
 getErrorText (EBadGenArg i) =
     (Type 42, empty, s2par ("Bad argument in code generation: " ++ ishow i))
-getErrorText (EBadIfcType mod msg) =
+getErrorText (EBadIfcType (Just mod) msg) =
     (Type 43, empty,
      s2par ("Cannot synthesize " ++ quote mod ++ ": " ++ msg))
+getErrorText (EBadIfcType Nothing msg) =
+    (Type 43, empty,
+     s2par ("Cannot synthesize this module or function: " ++ msg))
 getErrorText (ENoTypeSign e) =
     (Type 44, empty, s2par ("Missing or bad type signature for a module: " ++ e))
 getErrorText (EStmtContext c) =

src/comp/GenWrap.hs

@@ -430,12 +430,12 @@ chkType def ty =
      Right ((_:_) :=> _) ->
         let ctx = if isClassic() then "context" else "proviso"
             msg = "It has a " ++ ctx ++ "."
-        in  bad (getPosition def, EBadIfcType (pfpString defId) msg)
+        in  bad (getPosition def, EBadIfcType (Just $ pfpString defId) msg)
      Right ([]    :=> t) ->
       do
         if not (null (tv t))
           then let msg = "Its interface is polymorphic."
-               in  bad (getPosition def, EBadIfcType (pfpString defId) msg)
+               in  bad (getPosition def, EBadIfcType (Just $ pfpString defId) msg)
           else
            do
              --traceM ("chkType: " ++ pfpReadable (t, getArrows t))
@@ -447,7 +447,7 @@ chkType def ty =
                     (f:_) -> let msg = "Its interface has a polymorphic field " ++
                                        quote (pfpString f) ++ "."
                              in  bad (getPosition def,
-                                      EBadIfcType (pfpString defId) msg)
+                                      EBadIfcType (Just $ pfpString defId) msg)
                     [] ->
                      do
                        ----traceM ("chkType 2: " ++ pfpReadable (chkInterface tr))
@@ -461,10 +461,10 @@ chkType def ty =
                                               quote (pfpString t) ++
                                               " is not an interface."
                                     in  bad (getPosition def,
-                                             EBadIfcType (pfpString defId) msg)
+                                             EBadIfcType (Just $ pfpString defId) msg)
                _ -> let msg = "It is not a module."
                     in  bad (getPosition def,
-                             EBadIfcType (pfpString defId) msg)
+                             EBadIfcType (Just $ pfpString defId) msg)
 
 -- Return a list of names of any fields which are polymorphic,
 -- if the given type is an interface; otherwise return an empty list.

src/comp/IExpand.hs

@@ -5227,7 +5227,7 @@ reportNonSynthTypeInMethod modId methId methExpr =
             let str = "The interface method " ++ quote (pfpString methId) ++
                       " uses type " ++ quote (pfpString v) ++
                       " which is not in the Bits class."
-            in  (modPos, EBadIfcType modName str)
+            in  (modPos, EBadIfcType (Just modName) str)
     in  case (getNonSynthTypes methExpr) of
             [] -> -- this shouldn't happen
                   (modPos, EPolyField)
@@ -5247,7 +5247,7 @@ reportNonSynthTypeInModuleArg modId modExpr =
             let str = "A parameter of the module uses the type " ++
                       quote (pfpString v) ++
                       " which is not in the Bits class."
-            in  (modPos, EBadIfcType modName str)
+            in  (modPos, EBadIfcType (Just modName) str)
     in  case (getNonSynthTypes modExpr) of
             [] -> internalError
                     ("IExpand: unexplained module with type parameter: " ++

testsuite/bsc.verilog/noinline/NoInline_ArgNotInBits.bsv.bsc-vcomp-out.expected

@@ -7,5 +7,6 @@ Error: Unknown position: (T0031)
   The proviso was implied by expressions at the following positions:
     "NoInline_ArgNotInBits.bsv", line 4, column 15
 Error: "NoInline_ArgNotInBits.bsv", line 4, column 15: (T0043)
-  Cannot synthesize `fnNoInline_ArgNotInBits': This method uses types that are
-  not in the Bits or SplitPorts typeclasses.
+  Cannot synthesize this module or function: The interface method
+  `fnNoInline_ArgNotInBits' uses type(s) that are not in the Bits or
+  SplitPorts typeclasses: NoInline_ArgNotInBits::L

testsuite/bsc.verilog/noinline/NoInline_ResNotInBits.bsv.bsc-vcomp-out.expected

@@ -7,8 +7,9 @@ Error: Unknown position: (T0031)
   The proviso was implied by expressions at the following positions:
     "NoInline_ResNotInBits.bsv", line 4, column 12
 Error: "NoInline_ResNotInBits.bsv", line 4, column 12: (T0043)
-  Cannot synthesize `fnNoInline_ResNotInBits': This method uses types that are
-  not in the Bits or SplitPorts typeclasses.
+  Cannot synthesize this module or function: The interface method
+  `fnNoInline_ResNotInBits' uses type(s) that are not in the Bits or
+  SplitPorts typeclasses: NoInline_ResNotInBits::L
 Error: "NoInline_ResNotInBits.bsv", line 4, column 12: (T0029)
   Signature mismatch (given too general):
   given: