[WIP] golden test

Author: dschrempf

hs-bindgen/examples/golden/edge-cases/duplicate.h

@@ -0,0 +1,3 @@
+#include "duplicate_macro.h"
+
+void f(dup x);

hs-bindgen/examples/golden/edge-cases/duplicate_macro.h

@@ -0,0 +1,4 @@
+// Parsed success because required for scoping.
+typedef int dup;
+// Parse not attempted.
+#define dup dup

hs-bindgen/src-internal/HsBindgen/Frontend/Analysis/DeclIndex.hs

@@ -104,6 +104,10 @@ data DeclIndex = DeclIndex {
     }
   deriving stock (Show, Generic)
 
+-- TODO_PR: Add conflicts to decl index.
+
+-- TODO_PR: Succeeded, external, unusable.
+
 emptyIndex :: DeclIndex
 emptyIndex =
    DeclIndex Map.empty Map.empty Map.empty Map.empty Map.empty Set.empty
@@ -115,6 +119,10 @@ emptyIndex =
 -- | Construction state (internal type)
 data PartialIndex = PartialIndex{
       index  :: DeclIndex
+      -- TODO_PR.
+      -- indexDomain :: Set C.QualPrelimDeclId
+      -- State `indexDomain = union [succeeded, notAttempted, failed]`
+      -- conflicts :: Map C.QualPrelimDeclId (Set SingleLoc)
     , errors :: !(Map C.QualPrelimDeclId DeclIndexError)
     }
   deriving (Generic)
@@ -228,17 +236,22 @@ fromParseResults results =
                 -- for macros; for other kinds of declarations, clang will have
                 -- reported an error already.
                 --
-                -- TODO: there are cases where one declaration is an actual C
+                -- There are cases where one declaration is an actual C
                 -- construct like a variable declaration, but the new
                 -- declaration is a macro of the same name that simply defers to
                 -- the C construct. This is apparently a valid pattern, which
                 -- for example occurs in @stdio.h@:
                 --
                 -- > typedef int FILE;
                 -- > extern FILE *const stdin;
-                -- > #define stdin  (stdin)
+                -- > #define stdin (stdin)
                 --
-                -- See issue #1155.
+                -- Note that in examples like this, we will always "succeed" in
+                -- parsing the macro, because proper macro handling does not
+                -- happen until after the @DeclIndex@ has been built (at this
+                -- point the macro is merely a list of tokens). So whether the
+                -- macro is something we can handle or not is irrelevant at this
+                -- point.
                 failure $ Redeclaration{
                     redeclarationId  = C.declQualPrelimDeclId $ new.psDecl
                   , redeclarationOld = old.psDecl.declInfo.declLoc
@@ -276,9 +289,12 @@ sameMacro = (==) `on` (map tokenSpelling . unparsedTokens)
   Construction errors
 -------------------------------------------------------------------------------}
 
+-- TODO_PR: Delete completely or define "ConflictingDeclarations ::
+-- (C.QualPrelimDeclId, Set. SingleLoc)" type and reuse in selection.
 data DeclIndexError =
     Redeclaration {
         redeclarationId  :: C.QualPrelimDeclId
+        -- TODO_PR:
       , redeclarationOld :: SingleLoc
       , redeclarationNew :: SingleLoc
       }
@@ -289,12 +305,15 @@ data DeclIndexError =
 
 instance PrettyForTrace DeclIndexError where
   prettyForTrace = \case
+    -- TODO_PR:
     Redeclaration{..} -> PP.hcat [
         prettyForTrace (C.Located redeclarationOld redeclarationId)
       , " was redeclared at "
       , PP.showToCtxDoc redeclarationNew
       , ". No binding generated."
       ]
+    -- TODO_PR: Change wording (probably even use the same trace message
+    -- type).
     SharedKey{..} ->
       PP.hang "Duplicate in declaration index detected:" 2 $
         prettyForTrace sharedKeyParseResult

hs-bindgen/src-internal/HsBindgen/Frontend/Pass/Select.hs

@@ -51,6 +51,8 @@ type Decl = C.Decl Select
 --    transitive dependencies are available.
 --
 -- @TransitiveAvailability@ deals with the second type.
+
+-- TODO_PR: Let's call this transitive usability.
 data TransitiveAvailability =
     TransitivelyAvailable
     -- | For each transitive dependency, we try to give the root cause of

hs-bindgen/test/hs-bindgen/Test/HsBindgen/Golden.hs

@@ -205,6 +205,21 @@ test_documentation_data_kind_pragma =
 test_edge_cases_adios :: TestCase
 test_edge_cases_adios = defaultTest "edge-cases/adios"
 
+test_edge_cases_duplicate :: TestCase
+test_edge_cases_duplicate = (defaultTest "edge-cases/duplicate") {
+    testTracePredicate = customTracePredicate' [
+        "dup"
+      , "f"
+      ] $ \case
+      TraceFrontend (FrontendConstructTranslationUnit _) ->
+         Just $ Expected "dup"
+      TraceFrontend (FrontendSelect ()) ->
+         Just $ expectFromQualPrelimDeclId i
+      _otherwise ->
+         Nothing
+
+}
+
 test_edge_cases_distilled_lib_1 :: TestCase
 test_edge_cases_distilled_lib_1 = defaultTest "edge-cases/distilled_lib_1"
 
@@ -1034,6 +1049,7 @@ testCases = manualTestCases ++ [
     , test_documentation_data_kind_pragma
     , test_documentation_doxygen_docs
     , test_edge_cases_adios
+    , test_edge_cases_duplicate
     , test_edge_cases_distilled_lib_1
     , test_edge_cases_failing_select_no_match
     , test_edge_cases_failing_thread_local