preprocessor cleanup and extended test coverage

src/Language/SystemVerilog/Parser/Preprocess.hs

@@ -38,14 +38,14 @@ data PP = PP
     , ppIncludePaths :: [FilePath] -- folders to search for includes
     , ppMacroStack   :: [[(String, String)]] -- arguments for in-progress macro expansions
     , ppIncludeStack :: [(FilePath, Env)] -- in-progress includes for loop detection
-    } deriving (Eq, Show)
+    }
 
 -- keeps track of the state of an if-else cascade level
 data Cond
     = CurrentlyTrue -- an active if/elsif/else branch (condition is met)
     | PreviouslyTrue -- an inactive else/elsif block due to an earlier if/elsif
     | NeverTrue -- an inactive if/elsif block; a subsequent else will be met
-    deriving (Eq, Show)
+    deriving Eq
 
 -- update a Cond for an `else block, where this block is active if and only if
 -- no previous block was active
@@ -288,8 +288,7 @@ takeThrough :: Char -> PPS String
 takeThrough goal = do
     str <- getInput
     if null str
-        then lexicalError $
-                "unexpected end of input, looking for " ++ (show goal)
+        then lexicalError $ "unexpected end of input, looking for " ++ show goal
         else do
             ch <- takeChar
             if ch == goal
@@ -366,24 +365,23 @@ takeMacroDefinition = do
             dropSpaces
             body <- takeUntilNewline
             argsWithDefaults <- mapM splitArg args
-            if null args
-                then lexicalError "macros cannot have 0 args"
-                else return (body, argsWithDefaults)
+            return (body, argsWithDefaults)
     where
         splitArg :: String -> PPS (String, Maybe String)
-        splitArg [] = lexicalError "macro defn. empty argument"
-        splitArg str = do
-            let (name, rest) = span isIdentChar str
-            if null name || not (all isIdentChar name) then
-                lexicalError $ "invalid macro arg name: " ++ show name
+        splitArg [] = lexicalError "macro definition missing argument name"
+        splitArg str =
+            if null name then
+                lexicalError $ "invalid macro definition argument: " ++ show str
             else if null rest then
                 return (name, Nothing)
-            else do
-                let leadCh : after = dropWhile isWhitespaceChar rest
-                let value = dropWhile isWhitespaceChar after
-                if leadCh /= '='
-                then lexicalError $ "bad char after arg name: " ++ (show leadCh)
-                else return (name, Just value)
+            else if leadCh /= '=' then
+                lexicalError $ "bad char after argument name: " ++ show leadCh
+            else
+                return (name, Just value)
+            where
+                (name, rest) = span isIdentChar str
+                leadCh : after = dropWhile isWhitespaceChar rest
+                value = dropWhile isWhitespaceChar after
 
 -- commas and right parens are forbidden outside matched pairs of: (), [], {},
 -- "", except to delimit arguments or end the list of arguments; see 22.5.1
@@ -393,7 +391,7 @@ takeMacroArguments = do
     leadCh <- takeChar
     if leadCh == '('
         then argLoop >>= mapM preprocessString
-        else lexicalError $ "expected begining of macro arguments, but found "
+        else lexicalError $ "expected beginning of macro arguments, but found "
                 ++ show leadCh
     where
         argLoop :: PPS [String]
@@ -466,12 +464,10 @@ dropWhitespace = do
     str <- getInput
     case str of
         ch : chs ->
-            if isWhitespaceChar ch
-                then do
-                    advancePosition ch
-                    setInput chs
-                    dropWhitespace
-                else return ()
+            when (isWhitespaceChar ch) $ do
+                advancePosition ch
+                setInput chs
+                dropWhitespace
         [] -> return ()
 
 -- directives that must always be processed even if the current code block is
@@ -617,7 +613,7 @@ handleString = do
                 [] -> lexicalError "unterminated string literal"
 
 -- preprocess a "backtick string", which begins and ends with a backtick
--- followed by a slash (`"), and withing which macros can be invoked as normal;
+-- followed by a slash (`"), and within which macros can be invoked as normal;
 -- otherwise, normal string literal rules apply, except that unescaped quotes
 -- are forbidden, and backticks must be escaped using a backslash to avoid being
 -- interpreted as a macro or marking the end of a string
@@ -733,9 +729,8 @@ handleDirective macrosOnly = do
             setFilePath filename
             let newPos = Position filename lineNumber 0
             setPosition newPos
-            if 0 <= levelNumber && levelNumber <= 2
-                then return ()
-                else lexicalError "line directive invalid level number"
+            when (levelNumber < 0 || 2 < levelNumber) $
+                lexicalError "line directive invalid level number"
 
         "include" -> do
             lineLookahead
@@ -884,9 +879,7 @@ advancePosition _ = do
 
 -- advances position for multiple characters
 advancePositions :: String -> PPS ()
-advancePositions str = do
-    _ <- mapM advancePosition str
-    return ()
+advancePositions = mapM_ advancePosition
 
 -- update the given position based on the movement of the given character
 advance :: Position -> Char -> Position
@@ -897,16 +890,13 @@ advance (Position f l c) _    = Position f l (c + 1)
 pushChar :: Char -> Position -> PPS ()
 pushChar c p = do
     condStack <- getCondStack
-    if any (/= CurrentlyTrue) condStack
-        then return ()
-        else do
-            output <- getOutput
-            setOutput $ (c, p) : output
+    when (all (== CurrentlyTrue) condStack) $ do
+        output <- getOutput
+        setOutput $ (c, p) : output
+
 -- adds a sequence of characters all at the same given position
 pushChars :: String -> Position -> PPS ()
-pushChars s p = do
-    _ <- mapM (flip pushChar p) s
-    return ()
+pushChars s p = mapM_ (flip pushChar p) s
 
 -- search for a pattern in the input and remove remove characters up to and
 -- including the first occurrence of the pattern

test/error/block_comment_eof.sv

@@ -0,0 +1,2 @@
+// pattern: Reached EOF while looking for: "\*/"
+/*

test/error/double_backtick.sv

@@ -0,0 +1,4 @@
+// pattern: Parse error: unexpected token '`'
+module top;
+    ``
+endmodule

test/error/include_filename_eof.sv

@@ -0,0 +1,2 @@
+// pattern: unexpected end of input, looking for '>'
+`include <foo

test/error/macro_arg_bad_eq.sv

@@ -0,0 +1,2 @@
+// pattern: bad char after argument name: '#'
+`define MACRO(a#)

test/error/macro_arg_bad_name.sv

@@ -0,0 +1,2 @@
+// pattern: invalid macro definition argument: "#"
+`define MACRO(#)

test/error/macro_args_empty.sv

@@ -0,0 +1,2 @@
+// pattern: macro definition missing argument name
+`define MACRO()

test/error/macro_illegal_name.sv

@@ -0,0 +1,2 @@
+// pattern: illegal macro name: define
+`define define

test/error/macro_overapplied.sv

@@ -0,0 +1,3 @@
+// pattern: too many macro arguments given
+`define MACRO(a, b)
+`MACRO(x, y, z)

test/error/macro_unapplied.sv

@@ -0,0 +1,3 @@
+// pattern: expected beginning of macro arguments, but found 'a'
+`define MACRO(a)
+`MACRO asdf

test/error/macro_unapplied_eof.sv

@@ -0,0 +1,3 @@
+// pattern: unexpected end of input
+`define MACRO(a)
+`MACRO

test/error/macro_underapplied.sv

@@ -0,0 +1,3 @@
+// pattern: too few macro arguments given
+`define MACRO(a, b)
+`MACRO(x)

test/error/string_directive.sv

@@ -0,0 +1,2 @@
+// pattern: compiler directives are forbidden inside strings
+`"asdf `line`"

test/error/string_literal_backtick_eof.sv

@@ -0,0 +1,2 @@
+// pattern: unterminated backtick string
+`"

test/error/string_literal_eof.sv

@@ -0,0 +1,2 @@
+// pattern: unterminated string literal
+"

test/error/unmatched_else.sv

@@ -0,0 +1,2 @@
+// pattern: `else directive outside of an `if/`endif block
+`else

test/error/unmatched_elsif.sv

@@ -0,0 +1,2 @@
+// pattern: `elsif directive outside of an `if/`endif block
+`elsif

test/lex/macro_arg_escape.sv

@@ -0,0 +1,5 @@
+module top;
+`define PRINT(str) initial $display(`"str`");
+`PRINT(a)
+`PRINT(\\)
+endmodule

test/lex/undefineall.sv

@@ -0,0 +1,7 @@
+`define A
+`undefineall
+`ifndef A
+module top;
+    initial $display("hi");
+endmodule
+`endif

test/lex/undefineall.v

@@ -0,0 +1,3 @@
+module top;
+    initial $display("hi");
+endmodule