cmListFileBacktrace: Refactor storage to provide efficient value semantics

Since commit v3.4.0-rc1~321^2~2 (Genex: Store a backtrace, not a pointer
to one, 2015-07-08) we treat cmListFileBacktrace instances as
lightweight values.  This was true at the time only because the
backtrace information was kept in the cmState snapshot hierarchy.
However, that forced us to accumulate a lot of otherwise short-lived
snapshots just to have the backtrace fields available for reference by
cmListFileBacktrace instances.  Recent refactoring made backtrace
instances independent of the snapshot hierarchy to avoid accumulating
short-lived snapshots.  This came at the cost of making backtrace values
heavy again, leading to lots of string coying and slower execution.

Fix this by refactoring cmListFileBacktrace to provide value semantics
with efficient shared storage underneath.  Teach cmMakefile to maintain
its call stack using an instance of cmListFileBacktrace.  This approach
allows the current backtrace to be efficiently saved whenever it is
needed.

Also teach cmListFileBacktrace the notion of a file-level scope.  This
is useful for messages about the whole file (e.g. during parsing) that
are not specific to any line within it.  Push the CMakeLists.txt scope
for each directory and never pop it.  This ensures that we always have
some context information and simplifies cmMakefile::IssueMessage.
Push/pop a file-level scope as each included file is processed.  This
supersedes cmParseFileScope and improves diagnostic message context
information in a few places.  Fix the corresponding test cases to expect
the improved output.

2 files changed, 5 insertions, 3 deletions

diff --git a/Tests/RunCMake/while/EndMismatch-stderr.txt b/Tests/RunCMake/while/EndMismatch-stderr.txt
index d7439e8..54d299f 100644
--- a/Tests/RunCMake/while/EndMismatch-stderr.txt
+++ b/Tests/RunCMake/while/EndMismatch-stderr.txt
@@ -1,4 +1,4 @@
-^CMake Warning \(dev\) at EndMismatch.cmake:3 \(include\):
+^CMake Warning \(dev\) in EndMismatch.cmake:
   A logical block opening on the line
 
     .*/Tests/RunCMake/while/EndMismatch.cmake:1 \(while\)
diff --git a/Tests/RunCMake/while/EndMissing-stderr.txt b/Tests/RunCMake/while/EndMissing-stderr.txt
index 099a8b2..964792f 100644
--- a/Tests/RunCMake/while/EndMissing-stderr.txt
+++ b/Tests/RunCMake/while/EndMissing-stderr.txt
@@ -1,6 +1,8 @@
-^CMake Error at CMakeLists.txt:3 \(include\):
+^CMake Error in EndMissing.cmake:
   A logical block opening on the line
 
     .*/Tests/RunCMake/while/EndMissing.cmake:1 \(while\)
 
-  is not closed.$
+  is not closed.
+Call Stack \(most recent call first\):
+  CMakeLists.txt:[0-9]+ \(include\)$