added --write directory mode with one file per module

CHANGELOG.md

@@ -6,6 +6,8 @@
   automatically load modules and interfaces used in the design that are not
   found in the provided input files
 * Added `--top` for pruning unneeded modules during conversion
+* Added `--write path/to/dir/` for creating an output `.v` in the specified
+  preexisting directory for each module in the converted result
 * The `string` data type is now dropped from parameters and localparams
 * Added support for passing through `sequence` and `property` declarations
 

README.md

@@ -104,9 +104,11 @@ Conversion:
   -E --exclude=CONV         Exclude a particular conversion (Always, Assert,
                             Interface, Logic, or UnbasedUnsized)
   -v --verbose              Retain certain conversion artifacts
-  -w --write=MODE/FILE      How to write output; default is 'stdout'; use
+  -w --write=MODE/FILE/DIR  How to write output; default is 'stdout'; use
                             'adjacent' to create a .v file next to each input;
-                            use a path ending in .v to write to a file
+                            use a path ending in .v to write to a file; use a
+                            path to an existing directory to create a .v within
+                            for each converted module
      --top=NAME             Remove uninstantiated modules except the given
                             top module; can be used multiple times
 Other:

src/Job.hs

@@ -8,6 +8,7 @@
 
 module Job where
 
+import Control.Monad (when)
 import Data.Char (toLower)
 import Data.List (isPrefixOf, isSuffixOf)
 import Data.Version (showVersion)
@@ -15,6 +16,7 @@ import GitHash (giDescribe, tGitInfoCwdTry)
 import qualified Paths_sv2v (version)
 import System.IO (stderr, hPutStr)
 import System.Console.CmdArgs
+import System.Directory (doesDirectoryExist)
 import System.Environment (getArgs, withArgs)
 import System.Exit (exitFailure)
 
@@ -31,6 +33,7 @@ data Write
     = Stdout
     | Adjacent
     | File FilePath
+    | Directory FilePath
     deriving (Typeable, Data)
 
 data Job = Job
@@ -75,10 +78,12 @@ defaultJob = Job
             ++ " Logic, or UnbasedUnsized)")
     , verbose = nam "verbose" &= help "Retain certain conversion artifacts"
     , write = Stdout &= ignore -- parsed from the flexible flag below
-    , writeRaw = "s" &= name "write" &= name "w" &= explicit &= typ "MODE/FILE"
+    , writeRaw = "s" &= name "write" &= name "w" &= explicit
+        &= typ "MODE/FILE/DIR"
         &= help ("How to write output; default is 'stdout'; use 'adjacent' to"
             ++ " create a .v file next to each input; use a path ending in .v"
-            ++ " to write to a file")
+            ++ " to write to a file; use a path to an existing directory to"
+            ++ " create a .v within for each converted module")
     , top = def &= name "top" &= explicit &= typ "NAME"
         &= help ("Remove uninstantiated modules except the given top module;"
             ++ " can be used multiple times")
@@ -108,9 +113,13 @@ parseWrite w | w `matches` "stdout" = return Stdout
 parseWrite w | w `matches` "adjacent" = return Adjacent
 parseWrite w | ".v" `isSuffixOf` w = return $ File w
 parseWrite w | otherwise = do
-    hPutStr stderr $ "invalid --write " ++ show w
-        ++ ", expected stdout, adjacent, or a path ending in .v"
-    exitFailure
+    isDir <- doesDirectoryExist w
+    when (not isDir) $ do
+        hPutStr stderr $ "invalid --write " ++ show w ++ ", expected stdout,"
+            ++ " adjacent, a path ending in .v, or a path to an existing"
+            ++ " directory"
+        exitFailure
+    return $ Directory w
 
 matches :: String -> String -> Bool
 matches = isPrefixOf . map toLower
@@ -142,11 +151,16 @@ readJob = do
         >>= flagRename "-e" "-E"
     withArgs strs' $ cmdArgs defaultJob
         >>= setWrite . setSuccinct
-    where
-        setWrite :: Job -> IO Job
-        setWrite job = do
-            w <- parseWrite $ writeRaw job
-            return $ job { write = w }
-        setSuccinct :: Job -> Job
-        setSuccinct job | verbose job = job { exclude = Succinct : exclude job }
-        setSuccinct job | otherwise = job
+
+setWrite :: Job -> IO Job
+setWrite job = do
+    w <- parseWrite $ writeRaw job
+    case (w, passThrough job) of
+        (Directory{}, True) -> do
+            hPutStr stderr "can't use --pass-through when writing to a dir"
+            exitFailure
+        _ -> return $ job { write = w }
+
+setSuccinct :: Job -> Job
+setSuccinct job | verbose job = job { exclude = Succinct : exclude job }
+setSuccinct job | otherwise = job

src/sv2v.hs

@@ -6,6 +6,7 @@
 
 import System.IO (hPrint, hPutStrLn, stderr, stdout)
 import System.Exit (exitFailure, exitSuccess)
+import System.FilePath (combine, splitExtension)
 
 import Control.Monad (when, zipWithM_)
 import Control.Monad.Except (runExceptT)
@@ -50,7 +51,18 @@ rewritePath path = do
     return $ base ++ ".v"
     where
         ext = ".sv"
-        (base, end) = splitAt (length path - length ext) path
+        (base, end) = splitExtension path
+
+splitModules :: FilePath -> AST -> [(FilePath, String)]
+splitModules dir (PackageItem (Decl CommentDecl{}) : ast) =
+    splitModules dir ast
+splitModules dir (description : ast) =
+    (path, output) : splitModules dir ast
+    where
+        Part _ _ Module _ name _ _ = description
+        path = combine dir $ name ++ ".v"
+        output = show description ++ "\n"
+splitModules _ [] = []
 
 writeOutput :: Write -> [FilePath] -> [AST] -> IO ()
 writeOutput _ [] [] =
@@ -63,6 +75,9 @@ writeOutput Adjacent inPaths asts = do
     outPaths <- mapM rewritePath inPaths
     let results = map (++ "\n") $ map show asts
     zipWithM_ writeFile outPaths results
+writeOutput (Directory d) _ asts = do
+    let (outPaths, outputs) = unzip $ splitModules d $ concat asts
+    zipWithM_ writeFile outPaths outputs
 
 main :: IO ()
 main = do

test/write/.gitignore

@@ -1 +1,2 @@
 *.v
+dirout

test/write/run.sh

@@ -2,6 +2,7 @@
 
 clearArtifacts() {
     rm -f one.v two.v
+    rm -rf dirout
 }
 
 createArtifacts() {
@@ -81,12 +82,40 @@ test_file() {
     clearArtifacts
 }
 
+test_directory() {
+    runAndCapture *.sv
+    expected="$stdout"
+
+    rm -f dirout/*
+    mkdir -p dirout
+
+    runAndCapture --pass-through --write dirout *.sv
+    assertFalse "directory conversion should succeed" $result
+    assertNull "stdout should be empty" "$stdout"
+    assertEquals "stderr should have expected message" \
+        "can't use --pass-through when writing to a dir" \
+        "$stderr"
+
+    runAndCapture --write dirout *.sv
+    assertTrue "directory conversion should succeed" $result
+    assertNull "stdout should be empty" "$stdout"
+    assertNull "stderr should be empty" "$stderr"
+
+    assertTrue "one.v should exist" "[ -f dirout/one.v ]"
+    assertTrue "two.v should exist" "[ -f dirout/two.v ]"
+    assertTrue "three.v should exist" "[ -f dirout/three.v ]"
+
+    actual=`cat dirout/*.v`
+    assertEquals "directory output should match combined" "$expected" "$actual"
+    clearArtifacts
+}
+
 test_unknown() {
     runAndCapture --write=unknown *.sv
     assertFalse "unknown write mode should fail" $result
     assertNull "stdout should be empty" "$stdout"
     assertEquals "stderr should list valid write modes" \
-        "invalid --write \"unknown\", expected stdout, adjacent, or a path ending in .v" \
+        "invalid --write \"unknown\", expected stdout, adjacent, a path ending in .v, or a path to an existing directory" \
         "$stderr"
 }
 

test/write/two.sv

@@ -1,3 +1,9 @@
+package P;
+    typedef logic T;
+endpackage
+module three;
+    P::T x;
+endmodule
 module two;
     logic x;
 endmodule