Debug revamp, make all debug points explicit

release-notes.md

@@ -14,6 +14,13 @@ This document contains current and historical release notes information. They ar
 
 These release notes track our current efforts to document changes to the F# project over time. They are split into the language, core library, compiler/tools, and compiler service.
 
+### FSharp Compiler Service (main)
+
+* Some syntax tree nodes have changed, e.g. introduction of SyntaxTree trivia
+* Resolved expressions (FSharpExpr) now reveal debug points, you must match them explicitly using `DebugPoint(dp, expr)`
+* Some node types in FSharpExpr (e.g. Let, While, TryFinally, TryWith) reveal additional debug points
+* In FSharpExpr, FastIntegerForLoop has been renamed to IntegerForLoop 
+
 ### F# 6.0 / Visual Studio 17.0
 
 

src/fsharp/AttributeChecking.fs

@@ -51,7 +51,7 @@ let rec private evalILAttribElem e =
     | ILAttribElem.TypeRef None     -> null
 
 let rec private evalFSharpAttribArg g e = 
-    match e with
+    match stripDebugPoints e with
     | Expr.Const (c, _, _) -> 
         match c with 
         | Const.Bool b -> box b

src/fsharp/AugmentWithHashCompare.fs

@@ -158,10 +158,10 @@ let mkCompareTestConjuncts g m exprs =
         (a, b) ||> List.foldBack (fun e acc -> 
             let nv, ne = mkCompGenLocal m "n" g.int_ty
             mkCompGenLet m nv e
-              (mkCond DebugPointAtBinding.NoneAtSticky DebugPointAtTarget.No m g.int_ty
+              (mkCond DebugPointAtBinding.NoneAtSticky m g.int_ty
                  (mkClt g m ne (mkZero g m))
                  ne
-                 (mkCond DebugPointAtBinding.NoneAtSticky DebugPointAtTarget.No m g.int_ty 
+                 (mkCond DebugPointAtBinding.NoneAtSticky m g.int_ty 
                     (mkCgt g m ne (mkZero g m))
                     ne
                     acc)))
@@ -172,7 +172,7 @@ let mkEqualsTestConjuncts g m exprs =
     | [h] -> h
     | l -> 
         let a, b = List.frontAndBack l 
-        List.foldBack (fun e acc -> mkCond DebugPointAtBinding.NoneAtSticky DebugPointAtTarget.No m g.bool_ty e acc (mkFalse g m)) a b
+        List.foldBack (fun e acc -> mkCond DebugPointAtBinding.NoneAtSticky m g.bool_ty e acc (mkFalse g m)) a b
 
 let mkMinimalTy (g: TcGlobals) (tcref: TyconRef) = 
     if tcref.Deref.IsExceptionDecl then [], g.exn_ty 
@@ -304,9 +304,9 @@ let mkExnEquality (g: TcGlobals) exnref (exnc: Tycon) =
         let mbuilder = MatchBuilder(DebugPointAtBinding.NoneAtInvisible, m ) 
         let cases = 
             [ mkCase(DecisionTreeTest.IsInst(g.exn_ty, mkAppTy exnref []), 
-                     mbuilder.AddResultTarget(expr, DebugPointAtTarget.No)) ]
-        let dflt = Some(mbuilder.AddResultTarget(mkFalse g m, DebugPointAtTarget.No))
-        let dtree = TDSwitch(DebugPointAtSwitch.No, thate, cases, dflt, m)
+                     mbuilder.AddResultTarget(expr)) ]
+        let dflt = Some(mbuilder.AddResultTarget(mkFalse g m))
+        let dtree = TDSwitch(thate, cases, dflt, m)
         mbuilder.Close(dtree, m, g.bool_ty)
 
     let expr = mkBindThatNullEquals g m thise thate expr
@@ -327,9 +327,9 @@ let mkExnEqualityWithComparer g exnref (exnc: Tycon) (_thisv, thise) thatobje (t
         let mbuilder = MatchBuilder(DebugPointAtBinding.NoneAtInvisible, m ) 
         let cases =
             [ mkCase(DecisionTreeTest.IsInst(g.exn_ty, mkAppTy exnref []), 
-                     mbuilder.AddResultTarget(expr, DebugPointAtTarget.No)) ]
-        let dflt = mbuilder.AddResultTarget(mkFalse g m, DebugPointAtTarget.No)
-        let dtree = TDSwitch(DebugPointAtSwitch.No, thate, cases, Some dflt, m)
+                     mbuilder.AddResultTarget(expr)) ]
+        let dflt = mbuilder.AddResultTarget(mkFalse g m)
+        let dtree = TDSwitch(thate, cases, Some dflt, m)
         mbuilder.Close(dtree, m, g.bool_ty)
     let expr = mkBindThatAddr g m g.exn_ty thataddrv thatv thate expr
     let expr = mkIsInstConditional g m g.exn_ty thatobje thatv expr (mkFalse g m)
@@ -367,19 +367,19 @@ let mkUnionCompare g tcref (tycon: Tycon) =
                     mkCompGenLet m thisucv (mkUnionCaseProof (thise, cref, tinst, m))
                         (mkCompGenLet m thatucv (mkUnionCaseProof (thataddre, cref, tinst, m))
                             (mkCompareTestConjuncts g m (List.mapi (mkTest thisucve thatucve) rfields)))
-            Some (mkCase(DecisionTreeTest.UnionCase(cref, tinst), mbuilder.AddResultTarget(test, DebugPointAtTarget.No)))
+            Some (mkCase(DecisionTreeTest.UnionCase(cref, tinst), mbuilder.AddResultTarget(test)))
 
         let nullary, nonNullary = List.partition Option.isNone (List.map mkCase ucases)  
         if isNil nonNullary then mkZero g m else 
         let cases = nonNullary |> List.map (function Some c -> c | None -> failwith "mkUnionCompare")
-        let dflt = if isNil nullary then None else Some (mbuilder.AddResultTarget(mkZero g m, DebugPointAtTarget.No))
-        let dtree = TDSwitch(DebugPointAtSwitch.No, thise, cases, dflt, m) 
+        let dflt = if isNil nullary then None else Some (mbuilder.AddResultTarget(mkZero g m))
+        let dtree = TDSwitch(thise, cases, dflt, m) 
         mbuilder.Close(dtree, m, g.int_ty)
 
     let expr = 
         if ucases.Length = 1 then expr else
         let tagsEqTested = 
-            mkCond DebugPointAtBinding.NoneAtSticky DebugPointAtTarget.No m g.int_ty  
+            mkCond DebugPointAtBinding.NoneAtSticky m g.int_ty  
               (mkILAsmCeq g m thistage thattage)
               expr
               (mkAsmExpr ([ AI_sub  ], [], [thistage; thattage], [g.int_ty], m))in 
@@ -428,19 +428,19 @@ let mkUnionCompareWithComparer g tcref (tycon: Tycon) (_thisv, thise) (_thatobjv
                         (mkCompGenLet m thatucv (mkUnionCaseProof (thataddre, cref, tinst, m))
                             (mkCompareTestConjuncts g m (List.mapi (mkTest thisucve thatucve) rfields)))
 
-            Some (mkCase(DecisionTreeTest.UnionCase(cref, tinst), mbuilder.AddResultTarget(test, DebugPointAtTarget.No)))
+            Some (mkCase(DecisionTreeTest.UnionCase(cref, tinst), mbuilder.AddResultTarget(test)))
 
         let nullary, nonNullary = List.partition Option.isNone (List.map mkCase ucases)  
         if isNil nonNullary then mkZero g m else 
         let cases = nonNullary |> List.map (function Some c -> c | None -> failwith "mkUnionCompare")
-        let dflt = if isNil nullary then None else Some (mbuilder.AddResultTarget(mkZero g m, DebugPointAtTarget.No))
-        let dtree = TDSwitch(DebugPointAtSwitch.No, thise, cases, dflt, m) 
+        let dflt = if isNil nullary then None else Some (mbuilder.AddResultTarget(mkZero g m))
+        let dtree = TDSwitch(thise, cases, dflt, m) 
         mbuilder.Close(dtree, m, g.int_ty)
 
     let expr = 
         if ucases.Length = 1 then expr else
         let tagsEqTested = 
-            mkCond DebugPointAtBinding.NoneAtSticky DebugPointAtTarget.No m g.int_ty  
+            mkCond DebugPointAtBinding.NoneAtSticky m g.int_ty  
               (mkILAsmCeq g m thistage thattage)
               expr
               (mkAsmExpr ([ AI_sub  ], [], [thistage; thattage], [g.int_ty], m))
@@ -488,19 +488,19 @@ let mkUnionEquality g tcref (tycon: Tycon) =
                         (mkCompGenLet m thatucv (mkUnionCaseProof (thataddre, cref, tinst, m))
                             (mkEqualsTestConjuncts g m (List.mapi (mkTest thisucve thatucve) rfields)))
 
-            Some (mkCase(DecisionTreeTest.UnionCase(cref, tinst), mbuilder.AddResultTarget(test, DebugPointAtTarget.No)))
+            Some (mkCase(DecisionTreeTest.UnionCase(cref, tinst), mbuilder.AddResultTarget(test)))
 
         let nullary, nonNullary = List.partition Option.isNone (List.map mkCase ucases)  
         if isNil nonNullary then mkTrue g m else 
         let cases = List.map (function Some c -> c | None -> failwith "mkUnionEquality") nonNullary
-        let dflt = (if isNil nullary then None else Some (mbuilder.AddResultTarget(mkTrue g m, DebugPointAtTarget.No)))
-        let dtree = TDSwitch(DebugPointAtSwitch.No, thise, cases, dflt, m) 
+        let dflt = (if isNil nullary then None else Some (mbuilder.AddResultTarget(mkTrue g m)))
+        let dtree = TDSwitch(thise, cases, dflt, m) 
         mbuilder.Close(dtree, m, g.bool_ty)
 
     let expr = 
         if ucases.Length = 1 then expr else
         let tagsEqTested = 
-          mkCond DebugPointAtBinding.NoneAtSticky DebugPointAtTarget.No m g.bool_ty  
+          mkCond DebugPointAtBinding.NoneAtSticky m g.bool_ty  
             (mkILAsmCeq g m thistage thattage)
             expr
             (mkFalse g m)
@@ -550,19 +550,19 @@ let mkUnionEqualityWithComparer g tcref (tycon: Tycon) (_thisv, thise) thatobje
                         (mkCompGenLet m thatucv (mkUnionCaseProof (thataddre, cref, tinst, m))
                             (mkEqualsTestConjuncts g m (List.mapi (mkTest thisucve thatucve) rfields)))
 
-            Some (mkCase(DecisionTreeTest.UnionCase(cref, tinst), mbuilder.AddResultTarget (test, DebugPointAtTarget.No)))
+            Some (mkCase(DecisionTreeTest.UnionCase(cref, tinst), mbuilder.AddResultTarget (test)))
 
         let nullary, nonNullary = List.partition Option.isNone (List.map mkCase ucases)  
         if isNil nonNullary then mkTrue g m else 
         let cases = List.map (function Some c -> c | None -> failwith "mkUnionEquality") nonNullary
-        let dflt = if isNil nullary then None else Some (mbuilder.AddResultTarget(mkTrue g m, DebugPointAtTarget.No))
-        let dtree = TDSwitch(DebugPointAtSwitch.No, thise, cases, dflt, m) 
+        let dflt = if isNil nullary then None else Some (mbuilder.AddResultTarget(mkTrue g m))
+        let dtree = TDSwitch(thise, cases, dflt, m) 
         mbuilder.Close(dtree, m, g.bool_ty)
 
     let expr = 
         if ucases.Length = 1 then expr else
         let tagsEqTested = 
-          mkCond DebugPointAtBinding.NoneAtSticky DebugPointAtTarget.No m g.bool_ty  
+          mkCond DebugPointAtBinding.NoneAtSticky m g.bool_ty  
             (mkILAsmCeq g m thistage thattage)
             expr
             (mkFalse g m)
@@ -649,7 +649,7 @@ let mkUnionHashWithComparer g tcref (tycon: Tycon) compe =
                         (mkCompGenSequential m 
                             (mkValSet m (mkLocalValRef accv) (mkInt g m i)) 
                             (mkCombineHashGenerators g m (List.mapi (mkHash ucve) ucase1.RecdFields) (mkLocalValRef accv) acce))
-            Some(mkCase(DecisionTreeTest.UnionCase(c1ref, tinst), mbuilder.AddResultTarget(test, DebugPointAtTarget.No)))
+            Some(mkCase(DecisionTreeTest.UnionCase(c1ref, tinst), mbuilder.AddResultTarget(test)))
 
     let nullary, nonNullary = ucases
                              |> List.mapi mkCase
@@ -658,8 +658,8 @@ let mkUnionHashWithComparer g tcref (tycon: Tycon) compe =
     let dflt = if isNil nullary then None 
                else 
                    let tag = mkUnionCaseTagGetViaExprAddr (thise, tcref, tinst, m)
-                   Some(mbuilder.AddResultTarget(tag, DebugPointAtTarget.No))
-    let dtree = TDSwitch(DebugPointAtSwitch.No, thise, cases, dflt, m)
+                   Some(mbuilder.AddResultTarget(tag))
+    let dtree = TDSwitch(thise, cases, dflt, m)
     let stmt = mbuilder.Close(dtree, m, g.int_ty)
     let expr = mkCompGenLet m accv (mkZero g m) stmt 
     let expr = if tycon.IsStructOrEnumTycon then expr else mkBindNullHash g m thise expr