Merge pull request livecode#4551 from peter-b/bugfix-18463

peter-b · web-flow · commit 72899d37c3eb · 2016-09-27T13:34:44.000+01:00
[Bug 18463] lc-compile: Correct error position on lines with control chars
diff --git a/docs/lcb/notes/lc-compile-error-context.md b/docs/lcb/notes/lc-compile-error-context.md
@@ -5,3 +5,5 @@
 * Errors, warnings and informational messages now display the affected
   line of code and visually indicate the position where the problem
   was found.
+
+# [18463] Show correct error position when source line includes tabs
diff --git a/tests/_compilertestrunner.livecodescript b/tests/_compilertestrunner.livecodescript
@@ -352,7 +352,7 @@ private function doesCompilerOutputSatisfyAssertion pCompilerOutput, pCompilerEx
    put "search" into tState
    repeat for each line tOutputLine in pCompilerOutput
       local tFile, tLine, tColumn, tType, tMessage
-      local tSourceLine, tMarker
+      local tSourceLine, tCharOffset, tOutputChar, tMarker
 
       if tState is "search" then
          -- The format of each output line is:
@@ -383,13 +383,21 @@ private function doesCompilerOutputSatisfyAssertion pCompilerOutput, pCompilerEx
 
       else if tState is "source line" then
          -- The format of the source line output is a space followed
-         -- by the corresponding line of the input source file.
-
-         put " " & line tLine of pTestInfo["code"] into tSourceLine
+         -- by the corresponding line of the input source file.  The
+         -- compiler may replace any of the source characters with
+         -- spaces (for example, to remove control characters).
+
+        put " " & line tLine of pTestInfo["code"] into tSourceLine
+
+        repeat with tCharOffset = 1 to the number of chars in tOutputLine
+           put char tCharOffset of tOutputLine into tOutputChar
+           if tOutputChar is not " " and \
+                 tOutputChar is not char tCharOffset of tSourceLine then
+              return false
+           end if
+         end repeat
 
-         if tOutputLine is tSourceLine then
-            put "marker" into tState
-         end if
+         put "marker" into tState
 
       else if tState is "marker" then
          -- The marker should point at the correct column within the
@@ -402,6 +410,8 @@ private function doesCompilerOutputSatisfyAssertion pCompilerOutput, pCompilerEx
 
          if tOutputLine is tMarker then
             return true
+         else
+            return false
          end if
       end if
    end repeat
diff --git a/toolchain/lc-compile/src/LAYOUT.b b/toolchain/lc-compile/src/LAYOUT.b
@@ -1,2 +1,2 @@
 \  { AdvanceCurrentPosition(1); }
-\t {  }
+\t { AdvanceCurrentPosition(1); }
diff --git a/toolchain/lc-compile/src/report.c b/toolchain/lc-compile/src/report.c
@@ -21,6 +21,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdarg.h>
+#include <string.h>
 
 extern int IsDependencyCompile(void);
 
@@ -174,15 +175,31 @@ static void _PrintPosition(long p_position)
  * that the position specifies. */
 static void _PrintContext(long p_position)
 {
-	const char *t_text = NULL;
+	const char *t_raw_text = NULL;
+	char *t_text = NULL;
 	long t_column;
-	GetRowTextOfPosition(p_position, &t_text);
+	int i;
+	GetRowTextOfPosition(p_position, &t_raw_text);
 	GetColumnOfPosition(p_position, &t_column);
-	if (NULL != t_text)
+
+	if (NULL == t_raw_text)
+		return;
+
+	/* Replace ASCII control characters in the raw text with spaces.
+	 * This has two goals: it simplifies aligning the context
+	 * indicator caret, and it ensures that control characters in the
+	 * LCB source code can't screw with your terminal emulator.  Note
+	 * that this doesn't try to cope with invalid Unicode values. */
+	t_text = strdup(t_raw_text);
+	if (NULL == t_text)
+		Fatal_OutOfMemory();
+	for (i = 0; t_text[i] != 0; ++i)
 	{
-		fprintf(stderr, " %s\n", t_text);
-		fprintf(stderr, " %*c\n", (int)t_column, '^');
+		if (t_text[i] < 0x20 || t_text[i] == 0x7F)
+			t_text[i] = ' ';
 	}
+
+	fprintf(stderr, " %s\n %*c\n", t_text, (int)t_column, '^');
 }
 
 static void _Error(long p_position, const char *p_message)

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`\ { AdvanceCurrentPosition(1); }`
`2`		`-\t { }`
	`2`	`+\t { AdvanceCurrentPosition(1); }`