Support emitting a correct end column on SC2086

This does the necessary work to emit end columns on AST analyses. SC2086
is made to emit a correct end column as an illustrative example.

For example:
```
$ shellcheck -s bash -f json /dev/stdin <<< 'echo $1'
[{"file":"/dev/stdin","line":1,"endLine":1,"column":6,"endColumn":8,"level":"info","code":2086,"message":"Double quote to prevent globbing and word splitting."}]
```

This change deprecates the parser's getNextId and getNextIdAt, replacing
it with a new withNextId function. This function has the type signature:

withNextId :: Monad m => ParsecT s UserState (SCBase m) (Id -> b) -> ParsecT s UserState (SCBase m) b

Specifically, it should be used to wrap read* functions and will pass in
a newly generated Id which should be used to represent that node.
Sub-parsers will need their own call to withNextId in order to get a
unique Id.

In doing this, withNextId can now track both the entry and exit position
of every read* parser which uses it, enabling the tracking of end
columns throughout the application.

ShellCheck/Checker.hs

@@ -29,6 +29,7 @@ import Data.Functor
 import Data.List
 import Data.Maybe
 import Data.Ord
+import Control.Applicative
 import Control.Monad.Identity
 import qualified Data.Map as Map
 import qualified System.IO
@@ -37,11 +38,14 @@ import Control.Monad
 
 import Test.QuickCheck.All
 
-tokenToPosition map (TokenComment id c) = fromMaybe fail $ do
-    position <- Map.lookup id map
-    return $ PositionedComment position position c
+tokenToPosition startMap endMap (TokenComment id c) = fromMaybe fail $ do
+    position <- maybePosition
+    endPosition <- maybeEndPosition <|> maybePosition
+    return $ PositionedComment position endPosition c
   where
     fail = error "Internal shellcheck error: id doesn't exist. Please report!"
+    maybeEndPosition = Map.lookup id endMap
+    maybePosition = Map.lookup id startMap
 
 checkScript :: Monad m => SystemInterface m -> CheckSpec -> m CheckResult
 checkScript sys spec = do
@@ -61,7 +65,7 @@ checkScript sys spec = do
                 fromMaybe [] $
                     (arComments . analyzeScript . analysisSpec)
                         <$> prRoot result
-        let translator = tokenToPosition (prTokenPositions result)
+        let translator = tokenToPosition (prTokenPositions result) (prTokenEndPositions result)
         return . nub . sortMessages . filter shouldInclude $
             (parseMessages ++ map translator analysisMessages)
 

ShellCheck/Interface.hs

@@ -58,6 +58,7 @@ data ParseSpec = ParseSpec {
 data ParseResult = ParseResult {
     prComments :: [PositionedComment],
     prTokenPositions :: Map.Map Id Position,
+    prTokenEndPositions :: Map.Map Id Position,
     prRoot :: Maybe Token
 } deriving (Show, Eq)
 

ShellCheck/Parser.hs

@@ -133,6 +133,38 @@ almostSpace =
         char c
         return ' '
 
+withNextId :: Monad m => ParsecT s UserState (SCBase m) (Id -> b) -> ParsecT s UserState (SCBase m) b
+withNextId p = do
+    start <- getPosition
+    id <- createId
+    setStartPos id start
+    fn <- p
+    let t = fn id
+    end <- getPosition
+    setEndPos id end
+    return t
+  where
+    createId = do
+        state <- getState
+        let id = incId (lastId state)
+        putState $ state {
+            lastId = id
+        }
+        return id
+      where incId (Id n) = Id $ n+1
+    setStartPos id sourcepos = do
+      state <- getState
+      let newMap = Map.insert id sourcepos (positionMap state)
+      putState $ state {
+          positionMap = newMap
+      }
+    setEndPos id sourcepos = do
+      state <- getState
+      let newMap = Map.insert id sourcepos (positionEndMap state)
+      putState $ state {
+          positionEndMap = newMap
+      }
+
 --------- Message/position annotation on top of user state
 data Note = Note Id Severity Code String deriving (Show, Eq)
 data ParseNote = ParseNote SourcePos SourcePos Severity Code String deriving (Show, Eq)
@@ -150,6 +182,7 @@ data HereDocContext =
 data UserState = UserState {
     lastId :: Id,
     positionMap :: Map.Map Id SourcePos,
+    positionEndMap :: Map.Map Id SourcePos,
     parseNotes :: [ParseNote],
     hereDocMap :: Map.Map Id [Token],
     pendingHereDocs :: [HereDocContext]
@@ -157,6 +190,7 @@ data UserState = UserState {
 initialUserState = UserState {
     lastId = Id $ -1,
     positionMap = Map.empty,
+    positionEndMap = Map.empty,
     parseNotes = [],
     hereDocMap = Map.empty,
     pendingHereDocs = []
@@ -170,6 +204,7 @@ noteToParseNote map (Note id severity code message) =
 
 getLastId = lastId <$> getState
 
+-- Deprecated by withNextId
 getNextIdAt sourcepos = do
     state <- getState
     let newId = incId (lastId state)
@@ -181,6 +216,7 @@ getNextIdAt sourcepos = do
     return newId
   where incId (Id n) = Id $ n+1
 
+-- Deprecated by withNextId
 getNextId = do
     pos <- getPosition
     getNextIdAt pos
@@ -1083,8 +1119,7 @@ prop_readDoubleQuoted4 = isWarning readSimpleCommand "\"foo\nbar\"foo"
 prop_readDoubleQuoted5 = isOk readSimpleCommand "lol \"foo\nbar\" etc"
 prop_readDoubleQuoted6 = isOk readSimpleCommand "echo \"${ ls; }\""
 prop_readDoubleQuoted7 = isOk readSimpleCommand "echo \"${ ls;}bar\""
-readDoubleQuoted = called "double quoted string" $ do
-    id <- getNextId
+readDoubleQuoted = called "double quoted string" $ withNextId $ do
     startPos <- getPosition
     doubleQuote
     x <- many doubleQuotedPart
@@ -1094,7 +1129,7 @@ readDoubleQuoted = called "double quoted string" $ do
         try . lookAhead $ suspectCharAfterQuotes <|> oneOf "$\""
         when (any hasLineFeed x && not (startsWithLineFeed x)) $
             suggestForgotClosingQuote startPos endPos "double quoted string"
-    return $ T_DoubleQuoted id x
+    return $ \id -> T_DoubleQuoted id x
   where
     startsWithLineFeed (T_Literal _ ('\n':_):_) = True
     startsWithLineFeed _ = False
@@ -1410,16 +1445,18 @@ prop_readDollarVariable2 = isOk (readDollarVariable >> anyChar) "$?!"
 prop_readDollarVariable3 = isWarning (readDollarVariable >> anyChar) "$10"
 prop_readDollarVariable4 = isWarning (readDollarVariable >> string "[@]") "$arr[@]"
 
-readDollarVariable = do
-    id <- getNextId
+readDollarVariable :: Monad m => ParsecT String UserState (SCBase m) Token
+readDollarVariable = withNextId $ do
     pos <- getPosition
 
-    let singleCharred p = do
+    let
+      singleCharred p = do
         n <- p
         value <- wrap [n]
-        return (T_DollarBraced id value)
+        return $ \id -> (T_DollarBraced id value)
 
-    let positional = do
+    let
+      positional = do
         value <- singleCharred digit
         return value `attempting` do
             lookAhead digit
@@ -1430,17 +1467,15 @@ readDollarVariable = do
     let regular = do
         name <- readVariableName
         value <- wrap name
-        return (T_DollarBraced id value) `attempting` do
+        return (\id -> (T_DollarBraced id value)) `attempting` do
             lookAhead $ void (string "[@]") <|> void (string "[*]") <|> void readArrayIndex
             parseNoteAt pos ErrorC 1087 "Braces are required when expanding arrays, as in ${array[idx]}."
 
     try $ char '$' >> (positional <|> special <|> regular)
 
   where
-    wrap s = do
-        x <- getNextId
-        y <- getNextId
-        return $ T_NormalWord x [T_Literal y s]
+    wrap s = withNextId $ withNextId $ do
+        return $ \x y -> T_NormalWord x [T_Literal y s]
 
 readVariableName = do
     f <- variableStart
@@ -2619,6 +2654,7 @@ parseShell sys name contents = do
             return ParseResult {
                 prComments = map toPositionedComment $ nub $ parseNotes userstate ++ parseProblems state,
                 prTokenPositions = Map.map posToPos (positionMap userstate),
+                prTokenEndPositions = Map.map posToPos (positionEndMap userstate),
                 prRoot = Just $
                     reattachHereDocs script (hereDocMap userstate)
             }
@@ -2630,6 +2666,7 @@ parseShell sys name contents = do
                         ++ [makeErrorFor err]
                         ++ parseProblems state,
                 prTokenPositions = Map.empty,
+                prTokenEndPositions = Map.empty,
                 prRoot = Nothing
             }
   where