Merge pull request #4432 from JacquesCarette/mnmzDcDsc

Remove one (ab)use of mkDocDesc by minimizing its hack.

Author: JacquesCarette

code/drasil-docLang/lib/Drasil/DocumentLanguage.hs

@@ -63,7 +63,7 @@ import qualified Drasil.Sections.Stakeholders as Stk (stakeholderIntro,
 import qualified Drasil.DocumentLanguage.TraceabilityMatrix as TM (
   generateTraceTableView, traceMHeader, layoutUIDs)
 import qualified Drasil.DocumentLanguage.TraceabilityGraph as TG (traceMGF)
-import Drasil.DocumentLanguage.TraceabilityGraph (traceyGraphGetRefs)
+import Drasil.DocumentLanguage.TraceabilityGraph (traceyGraphGetRefs, genTraceGraphLabCons)
 import Drasil.Sections.TraceabilityMandGs (traceMatStandard)
 import Drasil.Sections.ReferenceMaterial (emptySectSentPlu)
 
@@ -91,43 +91,35 @@ mkDoc srs comb (si@SI {_sys = sys, _authors = docauthors}, dd) =
 -- traceability matrix information and 'IdeaDict's.
 fillcdbSRS :: SRSDecl -> System -> (System , DocDesc)
 fillcdbSRS srsDec si =
-  (fillSecAndLC dd $ fillReferences sections $ fillTraceSI dd si , dd)
+  (fillLC dd $ fillReferences sections $ fillTraceSI dd si , dd)
   where
     dd :: DocDesc
     dd = mkDocDesc si srsDec
     sections :: [Section]
     sections = mkSections si dd
 
 -- | Fill in the 'Section's and 'LabelledContent' maps of the 'ChunkDB' from the 'SRSDecl'.
-fillSecAndLC :: DocDesc -> System -> System
-fillSecAndLC dd si = si2
+fillLC :: DocDesc -> System -> System
+fillLC sd si@SI{ _sys = sn }
+  | containsTraceSec sd = si2
+  | otherwise = si
   where
-    -- Get current contents of si
     chkdb = si ^. systemdb
-    -- extract sections and labelledcontent
-    allSections = concatMap findAllSec $ mkSections si dd -- FIXME: `mkSections` on something particularly large that is immediately discarded is a sign that we're doing something wrong.
-    allLC = concatMap findAllLC allSections
+    -- Pre-generate a copy of all required LabelledContents (i.e., traceability
+    -- graphs) for insertion in the ChunkDB.
+    createdLCs = genTraceGraphLabCons $ programName sn
+    -- FIXME: This is a semi-hack. This is only strictly necessary for the
+    -- traceability graphs. Those are all chunks that should exist but not be
+    -- handled like this. They should be created and included in the
+    -- meta-ChunkDB of `drasil-docLang`.
     existingLC = map (fst . snd) $ Map.assocs $ labelledcontentTable chkdb
-    -- fill in the appropriate chunkdb fields
-    chkdb2 = chkdb { labelledcontentTable = idMap $ nub $ existingLC ++ allLC }
-    -- return the filled in system information
+    chkdb2 = chkdb { labelledcontentTable = idMap $ nub $ existingLC ++ createdLCs }
     si2 = set systemdb chkdb2 si
 
-    -- Helper and finder functions
-    findAllSec :: Section -> [Section]
-    findAllSec s@(Section _ cs _) = s : concatMap findAllSubSec cs
-
-    findAllSubSec :: SecCons -> [Section]
-    findAllSubSec (Sub s) = findAllSec s
-    findAllSubSec _ = []
-
-    findAllLC :: Section -> [LabelledContent]
-    findAllLC (Section _ cs _) = concatMap findLCSecCons cs
-
-    findLCSecCons :: SecCons -> [LabelledContent]
-    findLCSecCons (Sub s) = findAllLC s
-    findLCSecCons (Con (LlC lblcons@(LblC {_ctype = Figure {}}))) = [lblcons]
-    findLCSecCons _ = []
+    containsTraceSec :: DocDesc -> Bool
+    containsTraceSec ((TraceabilitySec _):_) = True
+    containsTraceSec (_:ss)                = containsTraceSec ss
+    containsTraceSec []                    = False
 
 -- | Takes in existing information from the Chunk database to construct a database of references.
 fillReferences :: [Section] -> System -> System

code/drasil-docLang/lib/Drasil/DocumentLanguage/TraceabilityGraph.hs

@@ -162,10 +162,15 @@ traceGLst = UlC $ ulcc $ Enumeration $ Bullet $ map (, Nothing) folderList'
 
 -- | The Traceability Graph contents.
 traceGCon :: String -> [Contents] -- FIXME: HACK: We're generating "LlC"s of the traceability graphs multiple times... See DocumentLanguage.hs' mkTraceabilitySec for the other spot.
-traceGCon ex = map LlC (zipWith (traceGraphLC ex) traceGFiles traceGUIDs)
+traceGCon ex = map LlC (genTraceGraphLabCons ex)
             ++ [mkParagraph $ S "For convenience, the following graphs can be\
                \ found at the links below:", traceGLst]
 
+-- | Generate the `LabelledContent` chunks, specialized to a specific example
+-- (and its path).
+genTraceGraphLabCons :: String -> [LabelledContent]
+genTraceGraphLabCons ex = zipWith (traceGraphLC ex) traceGFiles traceGUIDs
+
 -- | Generates traceability graphs as figures on an SRS document.
 traceGraphLC :: String -> FilePath -> UID -> LabelledContent
 traceGraphLC ex fp u = llcc (makeFigRef' u) $ fig (S $ show u) (traceyGraphPath ex fp)