Natvis: implement view() specifier, IncludeView/ExcludeView filtering, and CustomListItems loop engine

src/MIDebugEngine/AD7.Impl/AD7Property.cs

@@ -72,7 +72,7 @@ public DEBUG_PROPERTY_INFO ConstructDebugPropertyInfo(enum_DEBUGPROP_INFO_FLAGS
 
             if ((dwFields & enum_DEBUGPROP_INFO_FLAGS.DEBUGPROP_INFO_VALUE) != 0)
             {
-                (propertyInfo.bstrValue, _uiVisualizers) = _engine.DebuggedProcess.Natvis.FormatDisplayString(variable);
+                (propertyInfo.bstrValue, _uiVisualizers) = _engine.DebuggedProcess.Natvis.FormatDisplayString(variable, variable.NatvisView);
                 propertyInfo.dwFields |= enum_DEBUGPROP_INFO_FLAGS.DEBUGPROP_INFO_VALUE;
             }
 
@@ -154,7 +154,7 @@ public int EnumChildren(enum_DEBUGPROP_INFO_FLAGS dwFields, uint dwRadix, ref Gu
                 try
                 {
                     _engine.DebuggedProcess.Natvis.WaitDialog.ShowWaitDialog(_variableInformation.Name);
-                    var children = _engine.DebuggedProcess.Natvis.Expand(_variableInformation);
+                    var children = _engine.DebuggedProcess.Natvis.Expand(_variableInformation, _variableInformation.NatvisView);
 
                     // Count number of children that fit filter (results saved in "fitsFilter")
                     int propertyCount = children.Length;

src/MIDebugEngine/Engine.Impl/Variables.cs

@@ -35,6 +35,7 @@ internal interface IVariableInformation : IDisposable
         VariableInformation FindChildByName(string name);
         string EvalDependentExpression(string expr);
         bool IsVisualized { get; }
+        string NatvisView { get; }
         bool IsReadOnly();
         bool IsNullPointer();
         enum_DEBUGPROP_INFO_FLAGS PropertyInfoFlags { get; set; }
@@ -375,6 +376,7 @@ public VariableInformation FindChildByName(string name)
         private DeferedFormatExpression _deferedFormatExpression;
         private IVariableInformation _parent;
         private string _format;
+        private string _natvisView;  // view name from a "view(name)" format specifier
         private string _strippedName;  // "Name" stripped of format specifiers
         private string _fullname;
 
@@ -392,6 +394,8 @@ public enum NodeType
 
         public NodeType VariableNodeType { get; private set; }
 
+        public string NatvisView { get { return _natvisView; } }
+
         private static readonly string[] s_stringTypes = new string[] {
                                  @"^char *\*$",
                                  @"^char *\[[0-9]*\]$",
@@ -417,6 +421,17 @@ private string ProcessFormatSpecifiers(string exp, out string formatSpecifier)
             // Find the format specifier expression
             string expFS = exp.Substring(lastComma + 1).Trim();
 
+            // A view() specifier (e.g. "obj,view(simple)") selects a named natvis view; it is
+            // consumed by natvis formatting/expansion rather than the debugger. Handle it before
+            // the modifier stripping below, which could corrupt a view name that contains one of
+            // the modifier letter pairs (e.g. "view(second)").
+            string viewName = Natvis.Natvis.ExtractViewName(expFS);
+            if (viewName != null)
+            {
+                _natvisView = viewName;
+                return exp.Substring(0, lastComma);
+            }
+
             // Strip off modifiers that may be included together with another format specifier, e.g. 'nvoXb' is a valid format specifier, but we only care about the 'Xb' part
             // This is not quite the right fix -- really the below switch statement should be a series of if statements. But since none of the supported format specifiers
             // contain any of these characters we can fix this the simple way and remove them.