Add code comments for unmodular code generation.

Author: balacij

code/drasil-code/lib/Language/Drasil/Choices.hs

@@ -209,13 +209,15 @@ makeDocConfig = DocConfig
 data Comments = CommentFunc -- ^ Function/method-level comments.
               | CommentClass -- ^ Class-level comments.
               | CommentMod -- ^ File/Module-level comments.
+              | CommentVarDecls -- ^ Variable declarations comments.
               deriving Eq
 
 -- | Renders options for implementation of comments.
 instance RenderChoices Comments where
   showChs CommentFunc = S "CommentFunc"
   showChs CommentClass = S "CommentClass"
   showChs CommentMod = S "CommentMod"
+  showChs CommentVarDecls = S "CommentVarDecls"
 
 -- | Doxygen file verbosity options.
 data Verbosity = Verbose | Quiet

code/drasil-code/lib/Language/Drasil/Code/Imperative/Modules.hs

@@ -62,7 +62,7 @@ import Drasil.GOOL (MSBody, MSBlock, SVariable, SValue, MSStatement,
   DeclStatement(..), OODeclStatement(..), objDecNewNoParams,
   extObjDecNewNoParams, IOStatement(..), ControlStatement(..), ifNoElse,
   VisibilitySym(..), MethodSym(..), StateVarSym(..), pubDVar, convType,
-    convTypeOO, VisibilityTag(..))
+    convTypeOO, VisibilityTag(..), CommentStatement(..))
 
 import qualified Drasil.GOOL as OO (SFile)
 import Drasil.GProc (ProcProg)
@@ -114,7 +114,7 @@ modularMainFunc = do
   varDef <- mapM genCalcCall (codeSpec g ^. execOrderO)
   wo <- genOutputCall
   let mainW = if CommentFunc `elem` commented g then docMain else mainFunction
-  return $ Just $ mainW $ bodyStatements $ 
+  return $ Just $ mainW $ bodyStatements $
     initLogFileVar (logKind g) mainFn ++ varDecDef v_filename mainFn (arg 0)
     : logInFile
     -- Constants must be declared before inputs because some derived input
@@ -134,7 +134,7 @@ unmodularMainFunc = do
   varDef <- mapM declVarCalc (codeSpec g ^. execOrderO)
   wo <- genOutputCall
   let mainW = if CommentFunc `elem` commented g then docMain else mainFunction
-  return $ Just $ mainW $ bodyStatements $ 
+  return $ Just $ mainW $ bodyStatements $
     initLogFileVar (logKind g) mainFn ++ varDecDef v_filename mainFn (arg 0)
     : logInFile
     -- Constants must be declared before inputs because some derived input
@@ -150,7 +150,10 @@ declVarCalc c = do
   val' <- convExpr val
   v <- mkVar (quantvar c)
   l <- maybeLog v
-  return $ pure ((multi . (: l) . varDecDef v scp) val')
+  cmnt <- getComment c
+  let cmnt' = [comment cmnt | CommentVarDecls `elem` commented g]
+      statements = cmnt' ++ varDecDef v scp val' : l  
+  return $ pure $ multi statements
 
 -- | If there are no inputs, the 'inParams' object still needs to be declared
 -- if inputs are 'Bundled', constants are stored 'WithInputs', and constant

code/drasil-example/projectile/lib/Drasil/Projectile/Choices.hs

@@ -117,7 +117,7 @@ baseChoices = defaultChoices {
   dataInfo = makeData Unbundled WithInputs Var,
   maps = makeMaps (matchConcepts [(piConst, [Pi])]) spaceToCodeType,
   optFeats = makeOptFeats
-    (makeDocConfig [CommentFunc, CommentClass, CommentMod] Quiet Hide)
+    (makeDocConfig [CommentFunc, CommentClass, CommentMod, CommentVarDecls] Quiet Hide)
     (makeLogConfig [] "log.txt")
     [SampleInput "../../../datafiles/projectile/sampleInput.txt", ReadME],
   srsConstraints = makeConstraints Warning Warning,