From b64308ae9aa24f5c683fd6e6f15431812b32c383 Mon Sep 17 00:00:00 2001 From: nojaf Date: Thu, 6 Feb 2020 21:33:45 +0100 Subject: [PATCH 1/7] WIP --- docs/content/style.css | 29 +++++++++++++++++++++------ fcs/docsrc/content/caches.fsx | 2 +- fcs/docsrc/content/compiler.fsx | 2 +- fcs/docsrc/content/corelib.fsx | 2 +- fcs/docsrc/content/editor.fsx | 2 +- fcs/docsrc/content/filesystem.fsx | 2 +- fcs/docsrc/content/interactive.fsx | 2 +- fcs/docsrc/content/ja/compiler.fsx | 2 +- fcs/docsrc/content/ja/editor.fsx | 2 +- fcs/docsrc/content/ja/filesystem.fsx | 2 +- fcs/docsrc/content/ja/interactive.fsx | 2 +- fcs/docsrc/content/ja/project.fsx | 2 +- fcs/docsrc/content/ja/symbols.fsx | 2 +- fcs/docsrc/content/ja/tokenizer.fsx | 2 +- fcs/docsrc/content/ja/untypedtree.fsx | 2 +- fcs/docsrc/content/project.fsx | 2 +- fcs/docsrc/content/queue.fsx | 2 +- fcs/docsrc/content/react.fsx | 2 +- fcs/docsrc/content/symbols.fsx | 4 ++-- fcs/docsrc/content/tokenizer.fsx | 2 +- fcs/docsrc/content/typedtree.fsx | 4 ++-- fcs/docsrc/content/untypedtree.fsx | 2 +- fcs/docsrc/tools/generate.fsx | 10 +++++---- fcs/paket.dependencies | 3 ++- fcs/paket.lock | 14 +++++++------ 25 files changed, 62 insertions(+), 40 deletions(-) diff --git a/docs/content/style.css b/docs/content/style.css index 34e1828450..1dbbd0ca66 100644 --- a/docs/content/style.css +++ b/docs/content/style.css @@ -12,14 +12,31 @@ span.pf { color:#E0C57F; } span.e { color:#EA8675; } /* identifiers --- and styles for more specific identifier types */ -span.i { color:#d1d1d1; } -/* type or module */ -span.t { color:#43AEC6; } +span.id { color:#d1d1d1; } +/* module */ +span.m { color:#43AEC6; } +/* reference type */ +span.rt { color:#43AEC6; } +/* value type */ +span.vt { color:#43AEC6; } +/* interface */ +span.if{ color:#43AEC6; } +/* type argument */ +span.ta { color:#43AEC6; } +/* disposable */ +span.d { color:#43AEC6; } +/* property */ +span.prop { color:#43AEC6; } +/* punctuation */ +span.p { color:#43AEC6; } /* function */ span.f { color:#e1e1e1; } -/* DU case or active pattern */ -span.p { color:#4ec9b0; } - +/* active pattern */ +span.pat { color:#4ec9b0; } +/* union case */ +span.u { color:#4ec9b0; } +/* enumeration */ +span.e { color:#4ec9b0; } /* keywords */ span.k { color:#FAB11D; } /* comment */ diff --git a/fcs/docsrc/content/caches.fsx b/fcs/docsrc/content/caches.fsx index 2f63c4b394..7f8eaea65f 100644 --- a/fcs/docsrc/content/caches.fsx +++ b/fcs/docsrc/content/caches.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Notes on the FSharpChecker caches ================================================= diff --git a/fcs/docsrc/content/compiler.fsx b/fcs/docsrc/content/compiler.fsx index a7e5303a06..dc8d06cbcb 100644 --- a/fcs/docsrc/content/compiler.fsx +++ b/fcs/docsrc/content/compiler.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Hosted Compiler =============== diff --git a/fcs/docsrc/content/corelib.fsx b/fcs/docsrc/content/corelib.fsx index a0c1e85f02..8a7f33b16f 100644 --- a/fcs/docsrc/content/corelib.fsx +++ b/fcs/docsrc/content/corelib.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Notes on FSharp.Core.dll ================================================= diff --git a/fcs/docsrc/content/editor.fsx b/fcs/docsrc/content/editor.fsx index 46ddd882e5..26bb465dde 100644 --- a/fcs/docsrc/content/editor.fsx +++ b/fcs/docsrc/content/editor.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Editor services ================================== diff --git a/fcs/docsrc/content/filesystem.fsx b/fcs/docsrc/content/filesystem.fsx index ad0a57712b..b7d4426fbd 100644 --- a/fcs/docsrc/content/filesystem.fsx +++ b/fcs/docsrc/content/filesystem.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Virtualized File System ========================================== diff --git a/fcs/docsrc/content/interactive.fsx b/fcs/docsrc/content/interactive.fsx index 6226bcbee1..abd1c5761e 100644 --- a/fcs/docsrc/content/interactive.fsx +++ b/fcs/docsrc/content/interactive.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Interactive Service: Embedding F# Interactive ============================================= diff --git a/fcs/docsrc/content/ja/compiler.fsx b/fcs/docsrc/content/ja/compiler.fsx index 788c715294..c1fdf2ef62 100644 --- a/fcs/docsrc/content/ja/compiler.fsx +++ b/fcs/docsrc/content/ja/compiler.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../../artifacts/bin/fcs/net461" +#I "../../../../artifacts/bin/fcs/Release/net461" (** コンパイラの組み込み ==================== diff --git a/fcs/docsrc/content/ja/editor.fsx b/fcs/docsrc/content/ja/editor.fsx index f8a33e9a75..7075c15989 100644 --- a/fcs/docsrc/content/ja/editor.fsx +++ b/fcs/docsrc/content/ja/editor.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../../artifacts/bin/fcs/net461" +#I "../../../../artifacts/bin/fcs/Release/net461" (** コンパイラサービス: エディタサービス ==================================== diff --git a/fcs/docsrc/content/ja/filesystem.fsx b/fcs/docsrc/content/ja/filesystem.fsx index 0680f34122..eaa1634919 100644 --- a/fcs/docsrc/content/ja/filesystem.fsx +++ b/fcs/docsrc/content/ja/filesystem.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../../artifacts/bin/fcs/net461" +#I "../../../../artifacts/bin/fcs/Release/net461" (** コンパイラサービス: ファイルシステム仮想化 ========================================== diff --git a/fcs/docsrc/content/ja/interactive.fsx b/fcs/docsrc/content/ja/interactive.fsx index 59bae44f01..1824eda9ec 100644 --- a/fcs/docsrc/content/ja/interactive.fsx +++ b/fcs/docsrc/content/ja/interactive.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../../artifacts/bin/fcs/net461" +#I "../../../../artifacts/bin/fcs/Release/net461" (** インタラクティブサービス: F# Interactiveの組み込み ================================================== diff --git a/fcs/docsrc/content/ja/project.fsx b/fcs/docsrc/content/ja/project.fsx index 8b70e3df5f..47355d9326 100644 --- a/fcs/docsrc/content/ja/project.fsx +++ b/fcs/docsrc/content/ja/project.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../../artifacts/bin/fcs/net461" +#I "../../../../artifacts/bin/fcs/Release/net461" (** コンパイラサービス: プロジェクトの分析 ====================================== diff --git a/fcs/docsrc/content/ja/symbols.fsx b/fcs/docsrc/content/ja/symbols.fsx index ff62b0de6b..052a9b978c 100644 --- a/fcs/docsrc/content/ja/symbols.fsx +++ b/fcs/docsrc/content/ja/symbols.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../../artifacts/bin/fcs/net461" +#I "../../../../artifacts/bin/fcs/Release/net461" (** コンパイラサービス: シンボルの処理 ================================== diff --git a/fcs/docsrc/content/ja/tokenizer.fsx b/fcs/docsrc/content/ja/tokenizer.fsx index 4daf29b7ea..729964bad0 100644 --- a/fcs/docsrc/content/ja/tokenizer.fsx +++ b/fcs/docsrc/content/ja/tokenizer.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../../artifacts/bin/fcs/net461" +#I "../../../../artifacts/bin/fcs/Release/net461" (** コンパイラサービス：F#トークナイザを使用する ============================================ diff --git a/fcs/docsrc/content/ja/untypedtree.fsx b/fcs/docsrc/content/ja/untypedtree.fsx index 89cd2f1f9b..b6974d1306 100644 --- a/fcs/docsrc/content/ja/untypedtree.fsx +++ b/fcs/docsrc/content/ja/untypedtree.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../../artifacts/bin/fcs/net461" +#I "../../../../artifacts/bin/fcs/Release/net461" (** コンパイラサービス：型無し構文木の処理 ====================================== diff --git a/fcs/docsrc/content/project.fsx b/fcs/docsrc/content/project.fsx index 7573b7f9ba..e85bad35e0 100644 --- a/fcs/docsrc/content/project.fsx +++ b/fcs/docsrc/content/project.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Project Analysis ================================== diff --git a/fcs/docsrc/content/queue.fsx b/fcs/docsrc/content/queue.fsx index 7cf14a7b70..8de84c19e2 100644 --- a/fcs/docsrc/content/queue.fsx +++ b/fcs/docsrc/content/queue.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Notes on the FSharpChecker operations queue ================================================= diff --git a/fcs/docsrc/content/react.fsx b/fcs/docsrc/content/react.fsx index be108b92ad..f00f83c7d6 100644 --- a/fcs/docsrc/content/react.fsx +++ b/fcs/docsrc/content/react.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Reacting to Changes ============================================ diff --git a/fcs/docsrc/content/symbols.fsx b/fcs/docsrc/content/symbols.fsx index ab6b4657dc..50ca938387 100644 --- a/fcs/docsrc/content/symbols.fsx +++ b/fcs/docsrc/content/symbols.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Working with symbols ============================================ @@ -207,7 +207,7 @@ Now do it for a particular input: let tmpFile = Path.ChangeExtension(System.IO.Path.GetTempFileName() , "fs") File.WriteAllText(tmpFile, input2) -let projectResults = parseAndCheckScript(tmpFile, input2) +let projectResults = parseAndCheckScript(tmpFile, SourceText.ofString input2) (** diff --git a/fcs/docsrc/content/tokenizer.fsx b/fcs/docsrc/content/tokenizer.fsx index 93a1dd3bf1..2af11ad440 100644 --- a/fcs/docsrc/content/tokenizer.fsx +++ b/fcs/docsrc/content/tokenizer.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Using the F# tokenizer ========================================= diff --git a/fcs/docsrc/content/typedtree.fsx b/fcs/docsrc/content/typedtree.fsx index f373cc2395..3a10340a42 100644 --- a/fcs/docsrc/content/typedtree.fsx +++ b/fcs/docsrc/content/typedtree.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Processing typed expression tree ================================================= @@ -46,7 +46,7 @@ let parseAndCheckSingleFile (input) = checker.GetProjectOptionsFromScript(file, SourceText.ofString input) |> Async.RunSynchronously - let fprojOptions, _ = projOptions + let fprojOptions = projOptions checker.ParseAndCheckProject (fprojOptions) |> Async.RunSynchronously diff --git a/fcs/docsrc/content/untypedtree.fsx b/fcs/docsrc/content/untypedtree.fsx index 162fedfa19..a2a823ec3e 100644 --- a/fcs/docsrc/content/untypedtree.fsx +++ b/fcs/docsrc/content/untypedtree.fsx @@ -1,5 +1,5 @@ (*** hide ***) -#I "../../../artifacts/bin/fcs/net461" +#I "../../../artifacts/bin/fcs/Release/netcoreapp3.0" (** Compiler Services: Processing untyped syntax tree ================================================= diff --git a/fcs/docsrc/tools/generate.fsx b/fcs/docsrc/tools/generate.fsx index 09fa803a2f..aa1dde3f33 100644 --- a/fcs/docsrc/tools/generate.fsx +++ b/fcs/docsrc/tools/generate.fsx @@ -29,16 +29,17 @@ open Fake.IO.FileSystemOperators open Fake.IO open Fake.Core open FSharp.Literate +open FSharp.Formatting.Razor let root = "." // Paths with template/source/output locations -let bin = __SOURCE_DIRECTORY__ @@ "../../../release/fcs/net461" +let bin = __SOURCE_DIRECTORY__ @@ "../../../release/fcs/netcoreapp3.0" let content = __SOURCE_DIRECTORY__ @@ "../content" let output = __SOURCE_DIRECTORY__ @@ "../../../docs" let files = __SOURCE_DIRECTORY__ @@ "../files" let templates = __SOURCE_DIRECTORY__ @@ "templates" -let formatting = __SOURCE_DIRECTORY__ @@ "../../packages/FSharp.Formatting/" +let formatting = @"C:\Users\nojaf\.nuget\packages\fsharp.formatting\4.0.0-alpha02" // "__SOURCE_DIRECTORY__ @@ "../../packages/FSharp.Formatting/" let docTemplate = formatting @@ "templates/docpage.cshtml" // Where to look for *.csproj templates (in this order) @@ -55,8 +56,9 @@ let copyFiles () = Shell.copyRecursive (formatting @@ "styles") (output @@ "content") true |> Trace.tracefn "Copying styles and scripts: %A" -let clr = System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory() -let fsfmt = __SOURCE_DIRECTORY__ @@ ".." @@ ".." @@ @"packages" @@ "FSharp.Formatting" @@ "lib" @@ "net40" +let clr = System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory() +printfn "CLR: %s" clr +let fsfmt = @"C:\Users\nojaf\.nuget\packages\fsharp.formatting\4.0.0-alpha02\lib\netstandard2.0" // __SOURCE_DIRECTORY__ @@ ".." @@ ".." @@ @"packages" @@ "FSharp.Formatting" @@ "lib" @@ "net40" // Build API reference from XML comments let buildReference () = diff --git a/fcs/paket.dependencies b/fcs/paket.dependencies index c3d2f47304..62513947a5 100644 --- a/fcs/paket.dependencies +++ b/fcs/paket.dependencies @@ -26,4 +26,5 @@ nuget FSharp.Core nuget Fake.Core nuget Fake.IO.FileSystem nuget Fake.Core.Trace -nuget FSharp.Literate +nuget FSharp.Literate 4.0.0-alpha02 +nuget FSharp.Formatting 4.0.0-alpha02 diff --git a/fcs/paket.lock b/fcs/paket.lock index 13fe5c84cc..a45eaa81cc 100644 --- a/fcs/paket.lock +++ b/fcs/paket.lock @@ -792,8 +792,9 @@ NUGET FSharp.Core (>= 4.7) System.Diagnostics.FileVersionInfo (>= 4.3) System.IO.FileSystem.Watcher (>= 4.3) - FSharp.Compiler.Service (27.0.1) - FSharp.Core (>= 4.5.2) + FSharp.Compiler.Service (34.0.1) + FSharp.Core (>= 4.6.2) + System.Buffers (>= 4.5) System.Collections.Immutable (>= 1.5) System.Diagnostics.Process (>= 4.1) System.Diagnostics.TraceSource (>= 4.0) @@ -803,9 +804,11 @@ NUGET System.Runtime.Loader (>= 4.0) System.Security.Cryptography.Algorithms (>= 4.3) FSharp.Core (4.7) - FSharp.Literate (3.1) - FSharp.Compiler.Service (>= 27.0.1 < 28.0) - System.ValueTuple (>= 4.5 < 5.0) + FSharp.Formatting (4.0.0-alpha02) + FSharp.Compiler.Service (>= 33.0) + FSharp.Literate (4.0.0-alpha02) + FSharp.Compiler.Service (>= 33.0) + FSharp.Core (>= 4.7) Microsoft.NETCore.Platforms (3.0) Microsoft.NETCore.Targets (3.0) Microsoft.Win32.Primitives (4.3) @@ -1086,4 +1089,3 @@ NUGET System.Threading.ThreadPool (4.3) System.Runtime (>= 4.3) System.Runtime.Handles (>= 4.3) - System.ValueTuple (4.5) From 49a19ce7757c9d93401db2166954d991dce438e1 Mon Sep 17 00:00:00 2001 From: nojaf Date: Fri, 7 Feb 2020 18:03:22 +0100 Subject: [PATCH 2/7] Bumped FSharp.Formatting locally --- fcs/docsrc/tools/generate.fsx | 11 ++++++----- fcs/paket.dependencies | 5 +++-- fcs/paket.lock | 31 ++++++++++++++++--------------- 3 files changed, 25 insertions(+), 22 deletions(-) diff --git a/fcs/docsrc/tools/generate.fsx b/fcs/docsrc/tools/generate.fsx index aa1dde3f33..241133bff5 100644 --- a/fcs/docsrc/tools/generate.fsx +++ b/fcs/docsrc/tools/generate.fsx @@ -6,6 +6,7 @@ #r "paket: groupref generate //" #load "./.fake/generate.fsx/intellisense.fsx" + // Binaries that have XML documentation (in a corresponding generated XML file) let referenceBinaries = [ "FSharp.Compiler.Service.dll" ] // Web site location for the generated documentation @@ -39,7 +40,7 @@ let content = __SOURCE_DIRECTORY__ @@ "../content" let output = __SOURCE_DIRECTORY__ @@ "../../../docs" let files = __SOURCE_DIRECTORY__ @@ "../files" let templates = __SOURCE_DIRECTORY__ @@ "templates" -let formatting = @"C:\Users\nojaf\.nuget\packages\fsharp.formatting\4.0.0-alpha02" // "__SOURCE_DIRECTORY__ @@ "../../packages/FSharp.Formatting/" +let formatting = @"C:\Users\nojaf\.nuget\packages\fsharp.formatting\4.0.0-alpha03" // "__SOURCE_DIRECTORY__ @@ "../../packages/FSharp.Formatting/" let docTemplate = formatting @@ "templates/docpage.cshtml" // Where to look for *.csproj templates (in this order) @@ -76,13 +77,13 @@ let buildReference () = clr @@ "Microsoft.CSharp.dll" clr @@ "System.Linq.dll" clr @@ "System.dll" - bin @@ "System.Reflection.Metadata.dll" + clr @@ "System.Reflection.Metadata.dll" clr @@ "System.Numerics.dll" - bin @@ "System.Collections.Immutable.dll" + clr @@ "System.Collections.Immutable.dll" clr @@ "System.IO.dll" clr @@ "mscorlib.dll" fsfmt @@ "FSharp.MetadataFormat.dll" - fsfmt @@ "RazorEngine.dll" + fsfmt @@ "RazorEngine.NetCore.dll" bin @@ "FSharp.Core.dll" bin @@ "FSharp.Compiler.Service.dll" ] ) @@ -96,7 +97,7 @@ let buildDocumentation () = layoutRoots = layoutRoots, generateAnchors = true, processRecursive=false ) // Generate -copyFiles() +// copyFiles() buildDocumentation() buildReference() diff --git a/fcs/paket.dependencies b/fcs/paket.dependencies index 62513947a5..c3f2d642fb 100644 --- a/fcs/paket.dependencies +++ b/fcs/paket.dependencies @@ -18,6 +18,7 @@ nuget Fake.DotNet.Paket group generate source https://api.nuget.org/v3/index.json +source C:\Users\nojaf\Projects\FSharp.Formatting\artifacts storage: none framework: netstandard2.0 @@ -26,5 +27,5 @@ nuget FSharp.Core nuget Fake.Core nuget Fake.IO.FileSystem nuget Fake.Core.Trace -nuget FSharp.Literate 4.0.0-alpha02 -nuget FSharp.Formatting 4.0.0-alpha02 +nuget FSharp.Literate 4.0.0-alpha03 +nuget FSharp.Formatting 4.0.0-alpha03 diff --git a/fcs/paket.lock b/fcs/paket.lock index a45eaa81cc..d44f49c1d2 100644 --- a/fcs/paket.lock +++ b/fcs/paket.lock @@ -804,22 +804,17 @@ NUGET System.Runtime.Loader (>= 4.0) System.Security.Cryptography.Algorithms (>= 4.3) FSharp.Core (4.7) - FSharp.Formatting (4.0.0-alpha02) - FSharp.Compiler.Service (>= 33.0) - FSharp.Literate (4.0.0-alpha02) - FSharp.Compiler.Service (>= 33.0) - FSharp.Core (>= 4.7) Microsoft.NETCore.Platforms (3.0) Microsoft.NETCore.Targets (3.0) Microsoft.Win32.Primitives (4.3) Microsoft.NETCore.Platforms (>= 1.1) Microsoft.NETCore.Targets (>= 1.1) System.Runtime (>= 4.3) - Microsoft.Win32.Registry (4.6) + Microsoft.Win32.Registry (4.7) System.Buffers (>= 4.5) System.Memory (>= 4.5.3) - System.Security.AccessControl (>= 4.6) - System.Security.Principal.Windows (>= 4.6) + System.Security.AccessControl (>= 4.7) + System.Security.Principal.Windows (>= 4.7) runtime.debian.8-x64.runtime.native.System.Security.Cryptography.OpenSsl (4.3.3) runtime.debian.9-x64.runtime.native.System.Security.Cryptography.OpenSsl (4.3.3) runtime.fedora.23-x64.runtime.native.System.Security.Cryptography.OpenSsl (4.3.3) @@ -980,16 +975,16 @@ NUGET System.IO (>= 4.3) System.Reflection.Primitives (>= 4.3) System.Runtime (>= 4.3) - System.Reflection.Emit (4.6) - System.Reflection.Emit.ILGeneration (>= 4.6) - System.Reflection.Emit.ILGeneration (4.6) + System.Reflection.Emit (4.7) + System.Reflection.Emit.ILGeneration (>= 4.7) + System.Reflection.Emit.ILGeneration (4.7) System.Reflection.Metadata (1.7) System.Collections.Immutable (>= 1.6) System.Reflection.Primitives (4.3) Microsoft.NETCore.Platforms (>= 1.1) Microsoft.NETCore.Targets (>= 1.1) System.Runtime (>= 4.3) - System.Reflection.TypeExtensions (4.6) + System.Reflection.TypeExtensions (4.7) System.Resources.ResourceManager (4.3) Microsoft.NETCore.Platforms (>= 1.1) Microsoft.NETCore.Targets (>= 1.1) @@ -1024,8 +1019,8 @@ NUGET System.Resources.ResourceManager (>= 4.3) System.Runtime (>= 4.3) System.Runtime.Extensions (>= 4.3) - System.Security.AccessControl (4.6) - System.Security.Principal.Windows (>= 4.6) + System.Security.AccessControl (4.7) + System.Security.Principal.Windows (>= 4.7) System.Security.Cryptography.Algorithms (4.3.1) Microsoft.NETCore.Platforms (>= 1.1) runtime.native.System.Security.Cryptography.Apple (>= 4.3.1) @@ -1062,7 +1057,7 @@ NUGET System.Runtime (>= 4.3) System.Threading (>= 4.3) System.Threading.Tasks (>= 4.3) - System.Security.Principal.Windows (4.6) + System.Security.Principal.Windows (4.7) System.Text.Encoding (4.3) Microsoft.NETCore.Platforms (>= 1.1) Microsoft.NETCore.Targets (>= 1.1) @@ -1089,3 +1084,9 @@ NUGET System.Threading.ThreadPool (4.3) System.Runtime (>= 4.3) System.Runtime.Handles (>= 4.3) + remote: C:\Users\nojaf\Projects\FSharp.Formatting\artifacts + FSharp.Formatting (4.0.0-alpha03) + FSharp.Compiler.Service (>= 34.0.1) + FSharp.Literate (4.0.0-alpha03) + FSharp.Compiler.Service (>= 34.0.1) + FSharp.Core (>= 4.7) From 4bbbdda640db80bd53f1fd0eca030306e412f7b2 Mon Sep 17 00:00:00 2001 From: nojaf Date: Sun, 9 Feb 2020 12:04:54 +0100 Subject: [PATCH 3/7] Using FSharp.Formatting with FCS 34 --- docs/caches.html | 21 +- docs/compiler.html | 111 +- docs/corelib.html | 71 +- docs/devnotes.html | 23 +- docs/editor.html | 206 +- docs/filesystem.html | 370 +- docs/index.html | 27 +- docs/interactive.html | 307 +- docs/project.html | 507 +-- docs/queue.html | 19 +- docs/react.html | 45 +- ...rp-compiler-abstractil-il-ilalignment.html | 159 - ...ompiler-abstractil-il-ilargconvention.html | 187 - ...p-compiler-abstractil-il-ilarraybound.html | 173 - ...-compiler-abstractil-il-ilarraybounds.html | 97 - ...p-compiler-abstractil-il-ilarrayshape.html | 179 - ...ler-abstractil-il-ilassemblylongevity.html | 173 - ...iler-abstractil-il-ilassemblymanifest.html | 370 -- ...-compiler-abstractil-il-ilassemblyref.html | 248 -- ...p-compiler-abstractil-il-ilattribelem.html | 344 -- ...rp-compiler-abstractil-il-ilattribute.html | 194 - ...ler-abstractil-il-ilattributenamedarg.html | 97 - ...p-compiler-abstractil-il-ilattributes.html | 133 - ...iler-abstractil-il-ilattributesstored.html | 97 - ...rp-compiler-abstractil-il-ilbasictype.html | 299 -- ...sharp-compiler-abstractil-il-ilboxity.html | 131 - ...-compiler-abstractil-il-ilcallingconv.html | 238 - ...iler-abstractil-il-ilcallingsignature.html | 145 - .../fsharp-compiler-abstractil-il-ilcode.html | 159 - ...rp-compiler-abstractil-il-ilcodelabel.html | 97 - ...piler-abstractil-il-ilcomparisoninstr.html | 271 -- ...fsharp-compiler-abstractil-il-ilconst.html | 159 - ...bstractil-il-ildefaultpinvokeencoding.html | 147 - ...arp-compiler-abstractil-il-ilenuminfo.html | 133 - ...arp-compiler-abstractil-il-ileventdef.html | 313 -- ...rp-compiler-abstractil-il-ileventdefs.html | 134 - ...arp-compiler-abstractil-il-ileventref.html | 157 - ...piler-abstractil-il-ilexceptionclause.html | 159 - ...ompiler-abstractil-il-ilexceptionspec.html | 131 - ...stractil-il-ilexportedtypeorforwarder.html | 244 -- ...actil-il-ilexportedtypesandforwarders.html | 118 - ...arp-compiler-abstractil-il-ilfielddef.html | 473 -- ...rp-compiler-abstractil-il-ilfielddefs.html | 135 - ...rp-compiler-abstractil-il-ilfieldinit.html | 301 -- ...arp-compiler-abstractil-il-ilfieldref.html | 147 - ...rp-compiler-abstractil-il-ilfieldspec.html | 201 - ...-compiler-abstractil-il-ilgenericargs.html | 203 - ...piler-abstractil-il-ilgenericargslist.html | 201 - ...r-abstractil-il-ilgenericparameterdef.html | 254 -- ...-abstractil-il-ilgenericparameterdefs.html | 201 - ...piler-abstractil-il-ilgenericvariance.html | 145 - ...harp-compiler-abstractil-il-ilglobals.html | 407 -- .../fsharp-compiler-abstractil-il-ilguid.html | 97 - ...fsharp-compiler-abstractil-il-ilinstr.html | 1449 ------ ...mpiler-abstractil-il-illazymethodbody.html | 118 - ...fsharp-compiler-abstractil-il-illocal.html | 147 - ...mpiler-abstractil-il-illocaldebuginfo.html | 131 - ...ler-abstractil-il-illocaldebugmapping.html | 135 - ...sharp-compiler-abstractil-il-illocals.html | 201 - ...piler-abstractil-il-illocalsallocator.html | 156 - ...compiler-abstractil-il-ilmemberaccess.html | 203 - ...p-compiler-abstractil-il-ilmethodbody.html | 203 - ...rp-compiler-abstractil-il-ilmethoddef.html | 1007 ----- ...p-compiler-abstractil-il-ilmethoddefs.html | 151 - ...ompiler-abstractil-il-ilmethodimpldef.html | 133 - ...mpiler-abstractil-il-ilmethodimpldefs.html | 118 - ...rp-compiler-abstractil-il-ilmethodref.html | 249 -- ...p-compiler-abstractil-il-ilmethodspec.html | 249 -- ...ler-abstractil-il-ilmethodvirtualinfo.html | 159 - ...rp-compiler-abstractil-il-ilmoduledef.html | 457 -- ...rp-compiler-abstractil-il-ilmoduleref.html | 170 - ...mpiler-abstractil-il-ilnativeresource.html | 135 - ...p-compiler-abstractil-il-ilnativetype.html | 640 --- ...ompiler-abstractil-il-ilnativevariant.html | 719 --- ...er-abstractil-il-ilnestedexportedtype.html | 198 - ...r-abstractil-il-ilnestedexportedtypes.html | 118 - ...ompiler-abstractil-il-iloverridesspec.html | 156 - ...rp-compiler-abstractil-il-ilparameter.html | 256 -- ...p-compiler-abstractil-il-ilparameters.html | 201 - ...arp-compiler-abstractil-il-ilplatform.html | 145 - ...p-compiler-abstractil-il-ilpretypedef.html | 169 - ...-compiler-abstractil-il-ilpropertydef.html | 328 -- ...compiler-abstractil-il-ilpropertydefs.html | 134 - ...-compiler-abstractil-il-ilpropertyref.html | 157 - ...arp-compiler-abstractil-il-ilreadonly.html | 131 - ...p-compiler-abstractil-il-ilreferences.html | 131 - ...arp-compiler-abstractil-il-ilresource.html | 217 - ...mpiler-abstractil-il-ilresourceaccess.html | 131 - ...iler-abstractil-il-ilresourcelocation.html | 167 - ...rp-compiler-abstractil-il-ilresources.html | 120 - ...sharp-compiler-abstractil-il-ilreturn.html | 198 - ...arp-compiler-abstractil-il-ilscoperef.html | 249 -- ...mpiler-abstractil-il-ilsecurityaction.html | 355 -- ...compiler-abstractil-il-ilsecuritydecl.html | 117 - ...ompiler-abstractil-il-ilsecuritydecls.html | 121 - ...r-abstractil-il-ilsecuritydeclsstored.html | 97 - ...mpiler-abstractil-il-ilsourcedocument.html | 188 - ...compiler-abstractil-il-ilsourcemarker.html | 200 - ...arp-compiler-abstractil-il-iltailcall.html | 131 - ...mpiler-abstractil-il-ilthisconvention.html | 151 - ...fsharp-compiler-abstractil-il-iltoken.html | 145 - .../fsharp-compiler-abstractil-il-iltype.html | 377 -- ...harp-compiler-abstractil-il-iltypedef.html | 756 ---- ...ompiler-abstractil-il-iltypedefaccess.html | 147 - ...-compiler-abstractil-il-iltypedefkind.html | 175 - ...ompiler-abstractil-il-iltypedeflayout.html | 147 - ...ler-abstractil-il-iltypedeflayoutinfo.html | 131 - ...arp-compiler-abstractil-il-iltypedefs.html | 171 - ...ompiler-abstractil-il-iltypedefstored.html | 95 - ...arp-compiler-abstractil-il-iltypeinit.html | 133 - ...harp-compiler-abstractil-il-iltyperef.html | 229 - ...fsharp-compiler-abstractil-il-iltypes.html | 201 - ...arp-compiler-abstractil-il-iltypespec.html | 231 - ...harp-compiler-abstractil-il-ilvarargs.html | 171 - ...-compiler-abstractil-il-ilversioninfo.html | 95 - ...p-compiler-abstractil-il-ilvolatility.html | 131 - ...arp-compiler-abstractil-il-methodbody.html | 173 - ...compiler-abstractil-il-methodcodekind.html | 145 - ...arp-compiler-abstractil-il-methodkind.html | 173 - ...bstractil-il-pinvokecallingconvention.html | 189 - ...iler-abstractil-il-pinvokecharbestfit.html | 145 - ...ler-abstractil-il-pinvokecharencoding.html | 159 - ...-compiler-abstractil-il-pinvokemethod.html | 215 - ...actil-il-pinvokethrowonunmappablechar.html | 145 - ...ompiler-abstractil-il-primaryassembly.html | 168 - ...harp-compiler-abstractil-il-publickey.html | 221 - .../fsharp-compiler-abstractil-il.html | 3896 ----------------- ...tractil-ilbinaryreader-ilmodulereader.html | 138 - ...binaryreader-ilreadermetadatasnapshot.html | 97 - ...ractil-ilbinaryreader-ilreaderoptions.html | 182 - ...reader-ilreadertrygetmetadatasnapshot.html | 95 - ...actil-ilbinaryreader-metadataonlyflag.html | 131 - ...actil-ilbinaryreader-reducememoryflag.html | 131 - ...naryreader-shim-defaultassemblyreader.html | 95 - ...l-ilbinaryreader-shim-iassemblyreader.html | 118 - ...mpiler-abstractil-ilbinaryreader-shim.html | 143 - ...-abstractil-ilbinaryreader-statistics.html | 178 - ...rp-compiler-abstractil-ilbinaryreader.html | 216 - ...internal-library-anycallerthreadtoken.html | 120 - ...ler-abstractil-internal-library-array.html | 322 -- ...ractil-internal-library-cancellable-1.html | 121 - ...l-internal-library-cancellablebuilder.html | 252 -- ...il-internal-library-cancellablemodule.html | 299 -- ...ternal-library-compilationthreadtoken.html | 125 - ...bstractil-internal-library-dictionary.html | 120 - ...internal-library-dictionaryextensions.html | 154 - ...tractil-internal-library-eventually-1.html | 148 - ...il-internal-library-eventuallybuilder.html | 238 - ...til-internal-library-eventuallymodule.html | 281 -- ...actil-internal-library-executiontoken.html | 97 - ...il-internal-library-inlinedelayinit-1.html | 181 - ...al-library-ipartialequalitycomparer-1.html | 122 - ...rnal-library-ipartialequalitycomparer.html | 134 - ...tractil-internal-library-layeredmap-2.html | 148 - ...il-internal-library-layeredmultimap-2.html | 251 -- ...iler-abstractil-internal-library-lazy.html | 120 - ...il-internal-library-lazywithcontext-2.html | 259 -- ...ternal-library-lazywithcontextfailure.html | 164 - ...il-internal-library-list-frontandback.html | 121 - ...iler-abstractil-internal-library-list.html | 641 --- ...er-abstractil-internal-library-lock-1.html | 142 - ...abstractil-internal-library-locktoken.html | 98 - ...piler-abstractil-internal-library-map.html | 120 - ...l-internal-library-memoizationtable-2.html | 140 - ...bstractil-internal-library-multimap-2.html | 148 - ...actil-internal-library-multimapmodule.html | 190 - ...abstractil-internal-library-namemap-1.html | 148 - ...ractil-internal-library-namemapmodule.html | 504 --- ...actil-internal-library-namemultimap-1.html | 148 - ...l-internal-library-namemultimapmodule.html | 246 -- ...er-abstractil-internal-library-option.html | 134 - ...ler-abstractil-internal-library-order.html | 148 - ...stractil-internal-library-resizearray.html | 142 - ...-internal-library-resultorexception-1.html | 131 - ...ernal-library-resultorexceptionmodule.html | 177 - ...ternal-library-shim-defaultfilesystem.html | 118 - ...til-internal-library-shim-ifilesystem.html | 343 -- ...iler-abstractil-internal-library-shim.html | 166 - ...er-abstractil-internal-library-string.html | 401 -- ...er-abstractil-internal-library-tables.html | 120 - ...l-internal-library-undefinedexception.html | 95 - ...ternal-library-uniquestampgenerator-1.html | 155 - ...-internal-library-valueoptioninternal.html | 166 - ...l-internal-library-valueorcancelled-1.html | 131 - ...-compiler-abstractil-internal-library.html | 874 ---- .../fsharp-compiler-ast-blockseparator.html | 97 - .../fsharp-compiler-ast-customoperations.html | 120 - .../fsharp-compiler-ast-expratomicflag.html | 137 - .../fsharp-compiler-ast-fsharplib.html | 162 - docs/reference/fsharp-compiler-ast-ident.html | 156 - ...p-compiler-ast-lexbuflocalxmldocstore.html | 101 - .../fsharp-compiler-ast-lexcont.html | 118 - ...compiler-ast-lexerendlinecontinuation.html | 158 - ...arp-compiler-ast-lexerifdefexpression.html | 159 - .../fsharp-compiler-ast-lexerifdefstack.html | 118 - ...p-compiler-ast-lexerifdefstackentries.html | 201 - ...arp-compiler-ast-lexerifdefstackentry.html | 131 - ...piler-ast-lexerwhitespacecontinuation.html | 299 -- .../fsharp-compiler-ast-longident.html | 201 - ...fsharp-compiler-ast-longidentwithdots.html | 192 - .../fsharp-compiler-ast-memberflags.html | 173 - .../fsharp-compiler-ast-memberkind.html | 191 - ...fsharp-compiler-ast-nicenamegenerator.html | 161 - ...arp-compiler-ast-parsedfsiinteraction.html | 131 - ...harp-compiler-ast-parsedhashdirective.html | 117 - .../fsharp-compiler-ast-parsedimplfile.html | 117 - ...p-compiler-ast-parsedimplfilefragment.html | 145 - ...harp-compiler-ast-parsedimplfileinput.html | 117 - .../fsharp-compiler-ast-parsedinput.html | 154 - .../fsharp-compiler-ast-parsedsigfile.html | 117 - ...rp-compiler-ast-parsedsigfilefragment.html | 145 - ...sharp-compiler-ast-parsedsigfileinput.html | 117 - .../fsharp-compiler-ast-parserdetail.html | 131 - .../fsharp-compiler-ast-prexmldoc.html | 218 - ...harp-compiler-ast-qualifiednameoffile.html | 176 - .../fsharp-compiler-ast-recordfieldname.html | 97 - .../fsharp-compiler-ast-scopedpragma.html | 117 - .../fsharp-compiler-ast-seqexpronly.html | 121 - ...piler-ast-sequencepointinfoforbinding.html | 195 - ...piler-ast-sequencepointinfoforfinally.html | 131 - ...piler-ast-sequencepointinfoforforloop.html | 131 - ...-compiler-ast-sequencepointinfoforseq.html | 145 - ...mpiler-ast-sequencepointinfofortarget.html | 131 - ...-compiler-ast-sequencepointinfofortry.html | 145 - ...ler-ast-sequencepointinfoforwhileloop.html | 131 - ...compiler-ast-sequencepointinfoforwith.html | 131 - ...-compiler-ast-stablenicenamegenerator.html | 160 - .../fsharp-compiler-ast-synaccess.html | 145 - .../fsharp-compiler-ast-synarginfo.html | 119 - ...harp-compiler-ast-synargnamegenerator.html | 154 - .../fsharp-compiler-ast-synattribute.html | 177 - .../fsharp-compiler-ast-synattributes.html | 201 - .../fsharp-compiler-ast-synbinding.html | 170 - .../fsharp-compiler-ast-synbindingkind.html | 153 - ...arp-compiler-ast-synbindingreturninfo.html | 117 - .../fsharp-compiler-ast-syncomponentinfo.html | 146 - .../fsharp-compiler-ast-synconst.html | 467 -- ...sharp-compiler-ast-synconstructorargs.html | 131 - .../fsharp-compiler-ast-synenumcase.html | 142 - .../fsharp-compiler-ast-synenumcases.html | 201 - .../fsharp-compiler-ast-synexceptiondefn.html | 142 - ...arp-compiler-ast-synexceptiondefnrepr.html | 142 - .../fsharp-compiler-ast-synexceptionsig.html | 117 - .../fsharp-compiler-ast-synexpr.html | 1198 ----- .../fsharp-compiler-ast-synfield.html | 119 - .../fsharp-compiler-ast-synfields.html | 201 - .../fsharp-compiler-ast-synindexerarg.html | 169 - .../fsharp-compiler-ast-syninfo.html | 482 -- .../fsharp-compiler-ast-syninterfaceimpl.html | 117 - .../fsharp-compiler-ast-synmatchclause.html | 155 - .../fsharp-compiler-ast-synmeasure.html | 218 - .../fsharp-compiler-ast-synmemberdefn.html | 292 -- .../fsharp-compiler-ast-synmemberdefns.html | 201 - .../fsharp-compiler-ast-synmembersig.html | 176 - .../fsharp-compiler-ast-synmembersigs.html | 201 - .../fsharp-compiler-ast-synmoduledecl.html | 266 -- .../fsharp-compiler-ast-synmoduledecls.html | 201 - ...arp-compiler-ast-synmoduleornamespace.html | 140 - ...compiler-ast-synmoduleornamespacekind.html | 182 - ...-compiler-ast-synmoduleornamespacesig.html | 117 - .../fsharp-compiler-ast-synmodulesigdecl.html | 238 - ...fsharp-compiler-ast-synmodulesigdecls.html | 201 - .../reference/fsharp-compiler-ast-synpat.html | 406 -- .../fsharp-compiler-ast-synrationalconst.html | 147 - .../fsharp-compiler-ast-synreturninfo.html | 122 - .../fsharp-compiler-ast-synsimplepat.html | 156 - ...ler-ast-synsimplepatalternativeidinfo.html | 135 - .../fsharp-compiler-ast-synsimplepats.html | 136 - ...r-ast-synstaticoptimizationconstraint.html | 131 - .../fsharp-compiler-ast-syntaxerror.html | 136 - .../fsharp-compiler-ast-syntypar.html | 140 - .../fsharp-compiler-ast-syntypardecl.html | 119 - .../fsharp-compiler-ast-syntype.html | 394 -- ...fsharp-compiler-ast-syntypeconstraint.html | 281 -- .../fsharp-compiler-ast-syntypedefn.html | 140 - .../fsharp-compiler-ast-syntypedefnkind.html | 257 -- .../fsharp-compiler-ast-syntypedefnrepr.html | 168 - .../fsharp-compiler-ast-syntypedefnsig.html | 121 - ...sharp-compiler-ast-syntypedefnsigrepr.html | 176 - ...rp-compiler-ast-syntypedefnsimplerepr.html | 259 -- .../fsharp-compiler-ast-synunioncase.html | 142 - .../fsharp-compiler-ast-synunioncases.html | 201 - .../fsharp-compiler-ast-synunioncasetype.html | 138 - .../fsharp-compiler-ast-synvaldata.html | 117 - .../fsharp-compiler-ast-synvalinfo.html | 144 - .../fsharp-compiler-ast-synvalsig.html | 170 - .../fsharp-compiler-ast-synvaltypardecls.html | 119 - .../fsharp-compiler-ast-typarstaticreq.html | 131 - .../reference/fsharp-compiler-ast-xmldoc.html | 191 - .../fsharp-compiler-ast-xmldoccollector.html | 170 - .../fsharp-compiler-ast-xmldocstatics.html | 141 - docs/reference/fsharp-compiler-ast.html | 1983 --------- ...sharp-compiler-errorlogger-buildphase.html | 259 -- ...ler-errorlogger-buildphasesubcategory.html | 276 -- ...iler-errorlogger-capturingerrorlogger.html | 155 - ...sharp-compiler-errorlogger-deprecated.html | 131 - .../fsharp-compiler-errorlogger-error.html | 131 - ...harp-compiler-errorlogger-errorlogger.html | 171 - ...ler-errorlogger-errorloggerextensions.html | 251 -- ...sharp-compiler-errorlogger-errorstyle.html | 175 - ...iler-errorlogger-errorwithsuggestions.html | 159 - .../fsharp-compiler-errorlogger-exiter.html | 118 - ...arp-compiler-errorlogger-experimental.html | 131 - ...rrorlogger-fsharperrorseverityoptions.html | 210 - ...errorlogger-imperativeoperationresult.html | 95 - ...rp-compiler-errorlogger-internalerror.html | 131 - ...p-compiler-errorlogger-libraryuseonly.html | 117 - ...rp-compiler-errorlogger-numberederror.html | 131 - ...ompiler-errorlogger-operationresult-1.html | 131 - ...-compiler-errorlogger-operationresult.html | 120 - ...compiler-errorlogger-phaseddiagnostic.html | 232 - ...-errorlogger-possibleunverifiablecode.html | 117 - ...rp-compiler-errorlogger-reportederror.html | 124 - ...ompiler-errorlogger-stopprocessingexn.html | 119 - ...harp-compiler-errorlogger-suggestions.html | 95 - ...mpiler-errorlogger-trackerrorsbuilder.html | 252 -- ...r-errorlogger-unresolvedpathreference.html | 145 - ...logger-unresolvedpathreferencenorange.html | 131 - ...-errorlogger-unresolvedreferenceerror.html | 131 - ...rrorlogger-unresolvedreferencenorange.html | 117 - ...piler-errorlogger-usercompilermessage.html | 145 - ...arp-compiler-errorlogger-wrappederror.html | 133 - .../fsharp-compiler-errorlogger.html | 1142 ----- ...interactive-shell-compilerinputstream.html | 144 - ...nteractive-shell-compileroutputstream.html | 142 - ...interactive-shell-evaluationeventargs.html | 188 - ...nteractive-shell-fsievaluationsession.html | 530 --- ...-shell-fsievaluationsessionhostconfig.html | 455 -- ...p-compiler-interactive-shell-fsivalue.html | 139 - ...interactive-shell-settings-ieventloop.html | 157 - ...ve-shell-settings-interactivesettings.html | 519 --- ...p-compiler-interactive-shell-settings.html | 155 - .../fsharp-compiler-interactive-shell.html | 167 - .../fsharp-compiler-layout-layout.html | 95 - ...harp-compiler-layout-layoutrenderer-2.html | 180 - .../fsharp-compiler-layout-layouttag.html | 95 - .../fsharp-compiler-layout-leftl.html | 204 - ...p-compiler-layout-navigabletaggedtext.html | 141 - .../fsharp-compiler-layout-noresult.html | 117 - .../fsharp-compiler-layout-nostate.html | 117 - .../fsharp-compiler-layout-rightl.html | 204 - .../fsharp-compiler-layout-sepl.html | 260 -- .../fsharp-compiler-layout-taggedtext.html | 135 - ...ompiler-layout-taggedtextops-literals.html | 414 -- .../fsharp-compiler-layout-taggedtextops.html | 585 --- .../fsharp-compiler-layout-wordl.html | 498 --- docs/reference/fsharp-compiler-layout.html | 700 --- ...fsharp-compiler-logcompilerfunctionid.html | 177 - .../fsharp-compiler-partiallongname.html | 192 - ...mpiler-prettynaming-activepatterninfo.html | 185 - ...-prettynaming-invalidmangledstaticarg.html | 117 - ...p-compiler-prettynaming-namearitypair.html | 117 - .../fsharp-compiler-prettynaming.html | 851 ---- .../reference/fsharp-compiler-quickparse.html | 231 - .../fsharp-compiler-range-fileindex.html | 97 - .../reference/fsharp-compiler-range-line.html | 138 - .../fsharp-compiler-range-line0.html | 97 - .../fsharp-compiler-range-pos-0.html | 138 - docs/reference/fsharp-compiler-range-pos.html | 197 - .../fsharp-compiler-range-pos01.html | 97 - .../fsharp-compiler-range-range-0.html | 138 - .../fsharp-compiler-range-range.html | 351 -- .../fsharp-compiler-range-range01.html | 97 - docs/reference/fsharp-compiler-range.html | 589 --- ...ferenceresolver-resolutionenvironment.html | 135 - ...mpiler-referenceresolver-resolvedfile.html | 151 - ...p-compiler-referenceresolver-resolver.html | 161 - .../fsharp-compiler-referenceresolver.html | 126 - ...ecodeservices-assemblycontentprovider.html | 139 - ...ourcecodeservices-assemblycontenttype.html | 136 - ...piler-sourcecodeservices-assemblypath.html | 132 - ...ler-sourcecodeservices-assemblysymbol.html | 248 -- ...ervices-asttraversal-astvisitorbase-1.html | 403 -- ...odeservices-asttraversal-traversepath.html | 201 - ...odeservices-asttraversal-traversestep.html | 203 - ...piler-sourcecodeservices-asttraversal.html | 210 - ...iler-sourcecodeservices-basicpatterns.html | 876 ---- ...ourcecodeservices-compilerenvironment.html | 120 - ...odeservices-compilerenvironmentmodule.html | 156 - ...-sourcecodeservices-completioncontext.html | 225 - ...sourcecodeservices-completionitemkind.html | 200 - ...ler-sourcecodeservices-completionpath.html | 94 - ...ourcecodeservices-debuggerenvironment.html | 124 - ...rp-compiler-sourcecodeservices-entity.html | 184 - ...mpiler-sourcecodeservices-entitycache.html | 159 - ...ompiler-sourcecodeservices-entitykind.html | 158 - ...ompiler-sourcecodeservices-extensions.html | 309 -- ...ler-sourcecodeservices-externalsymbol.html | 188 - ...piler-sourcecodeservices-externaltype.html | 168 - ...sourcecodeservices-externaltypemodule.html | 97 - ...ecodeservices-fsharpabstractparameter.html | 206 - ...ecodeservices-fsharpabstractsignature.html | 206 - ...ourcecodeservices-fsharpaccessibility.html | 155 - ...odeservices-fsharpaccessibilityrights.html | 96 - ...ecodeservices-fsharpactivepatterncase.html | 206 - ...codeservices-fsharpactivepatterngroup.html | 189 - ...eservices-fsharpanonrecordtypedetails.html | 172 - ...ler-sourcecodeservices-fsharpassembly.html | 204 - ...cecodeservices-fsharpassemblycontents.html | 121 - ...ecodeservices-fsharpassemblysignature.html | 155 - ...er-sourcecodeservices-fsharpattribute.html | 188 - ...iler-sourcecodeservices-fsharpchecker.html | 899 ---- ...rcecodeservices-fsharpcheckfileanswer.html | 132 - ...cecodeservices-fsharpcheckfileresults.html | 467 -- ...odeservices-fsharpcheckprojectresults.html | 256 -- ...odeservices-fsharpdeclarationlistinfo.html | 173 - ...odeservices-fsharpdeclarationlistitem.html | 325 -- ...ecodeservices-fsharpdelegatesignature.html | 138 - ...urcecodeservices-fsharpdisplaycontext.html | 122 - ...odeservices-fsharpenclosingentitykind.html | 214 - ...piler-sourcecodeservices-fsharpentity.html | 1057 ----- ...er-sourcecodeservices-fsharperrorinfo.html | 237 - ...ourcecodeservices-fsharperrorseverity.html | 130 - ...ompiler-sourcecodeservices-fsharpexpr.html | 158 - ...mpiler-sourcecodeservices-fsharpfield.html | 445 -- ...eservices-fsharpfinddeclfailurereason.html | 168 - ...urcecodeservices-fsharpfinddeclresult.html | 152 - ...cecodeservices-fsharpgenericparameter.html | 240 - ...ices-fsharpgenericparameterconstraint.html | 427 -- ...pgenericparameterdefaultstoconstraint.html | 138 - ...arpgenericparameterdelegateconstraint.html | 138 - ...sharpgenericparametermemberconstraint.html | 189 - ...mpiler-sourcecodeservices-fsharpglyph.html | 396 -- ...ices-fsharpimplementationfilecontents.html | 189 - ...s-fsharpimplementationfiledeclaration.html | 152 - ...cecodeservices-fsharpinlineannotation.html | 182 - ...ourcecodeservices-fsharplinetokenizer.html | 161 - ...ervices-fsharpmemberorfunctionorvalue.html | 1074 ----- ...-sourcecodeservices-fsharpmethodgroup.html | 138 - ...rcecodeservices-fsharpmethodgroupitem.html | 258 -- ...rvices-fsharpmethodgroupitemparameter.html | 191 - ...vices-fsharpnavigationdeclarationitem.html | 254 -- ...s-fsharpnavigationdeclarationitemkind.html | 230 - ...rcecodeservices-fsharpnavigationitems.html | 121 - ...s-fsharpnavigationtopleveldeclaration.html | 133 - ...es-fsharpnoteworthyparaminfolocations.html | 247 -- ...codeservices-fsharpobjectexproverride.html | 172 - ...rcecodeservices-fsharpopendeclaration.html | 189 - ...er-sourcecodeservices-fsharpparameter.html | 240 - ...cecodeservices-fsharpparsefileresults.html | 237 - ...urcecodeservices-fsharpparsingoptions.html | 225 - ...urcecodeservices-fsharpprojectcontext.html | 137 - ...urcecodeservices-fsharpprojectoptions.html | 301 -- ...rcecodeservices-fsharpsourcetokenizer.html | 155 - ...rcecodeservices-fsharpstaticparameter.html | 204 - ...rvices-fsharpstructuredtooltipelement.html | 96 - ...eservices-fsharpstructuredtooltiptext.html | 94 - ...piler-sourcecodeservices-fsharpsymbol.html | 300 -- ...er-sourcecodeservices-fsharpsymboluse.html | 292 -- ...ourcecodeservices-fsharptokencharkind.html | 269 -- ...urcecodeservices-fsharptokencolorkind.html | 284 -- ...er-sourcecodeservices-fsharptokeninfo.html | 230 - ...odeservices-fsharptokenizercolorstate.html | 314 -- ...ecodeservices-fsharptokenizerlexstate.html | 177 - ...ler-sourcecodeservices-fsharptokentag.html | 1051 ----- ...ecodeservices-fsharptokentriggerclass.html | 224 - ...cecodeservices-fsharptooltipelement-1.html | 172 - ...urcecodeservices-fsharptooltipelement.html | 96 - ...deservices-fsharptooltipelementdata-1.html | 180 - ...ourcecodeservices-fsharptooltiptext-1.html | 120 - ...-sourcecodeservices-fsharptooltiptext.html | 94 - ...ompiler-sourcecodeservices-fsharptype.html | 547 --- ...er-sourcecodeservices-fsharpunioncase.html | 274 -- ...piler-sourcecodeservices-fsharpxmldoc.html | 152 - ...rcecodeservices-iassemblycontentcache.html | 138 - ...rp-compiler-sourcecodeservices-idents.html | 96 - ...sourcecodeservices-inheritancecontext.html | 144 - ...iler-sourcecodeservices-insertcontext.html | 136 - ...-compiler-sourcecodeservices-keywords.html | 153 - ...rp-compiler-sourcecodeservices-layout.html | 94 - ...ompiler-sourcecodeservices-lookuptype.html | 132 - ...urcecodeservices-maybeunresolvedident.html | 132 - ...rcecodeservices-maybeunresolvedidents.html | 96 - ...ompiler-sourcecodeservices-modulekind.html | 130 - ...urcecodeservices-navigateto-container.html | 131 - ...codeservices-navigateto-containertype.html | 173 - ...codeservices-navigateto-navigableitem.html | 173 - ...services-navigateto-navigableitemkind.html | 257 -- ...ompiler-sourcecodeservices-navigateto.html | 154 - ...eservices-openstatementinsertionpoint.html | 132 - ...er-sourcecodeservices-paramtypesymbol.html | 132 - ...rcecodeservices-paramtypesymbolmodule.html | 97 - ...mpiler-sourcecodeservices-parsedinput.html | 171 - ...-compiler-sourcecodeservices-position.html | 94 - ...piler-sourcecodeservices-prettynaming.html | 209 - ...arp-compiler-sourcecodeservices-range.html | 94 - ...iler-sourcecodeservices-recordcontext.html | 144 - ...compiler-sourcecodeservices-scopekind.html | 174 - ...deservices-semanticclassificationtype.html | 312 -- ...ompiler-sourcecodeservices-shortident.html | 132 - ...ompiler-sourcecodeservices-sourcefile.html | 139 - ...er-sourcecodeservices-stringlongident.html | 132 - ...sourcecodeservices-structure-collapse.html | 135 - ...er-sourcecodeservices-structure-scope.html | 763 ---- ...urcecodeservices-structure-scoperange.html | 166 - ...compiler-sourcecodeservices-structure.html | 159 - ...rp-compiler-sourcecodeservices-symbol.html | 752 ---- ...-compiler-sourcecodeservices-tooltips.html | 147 - ...ecodeservices-unresolvedreferencesset.html | 96 - ...r-sourcecodeservices-unresolvedsymbol.html | 144 - ...r-sourcecodeservices-untypedparseimpl.html | 189 - ...mpiler-sourcecodeservices-unusedopens.html | 121 - ...ompiler-sourcecodeservices-xmldocable.html | 118 - ...iler-sourcecodeservices-xmldoccomment.html | 121 - ...piler-sourcecodeservices-xmldocparser.html | 121 - docs/reference/index.html | 1534 ------- ...al-utilities-structuredformat-display.html | 265 -- ...lities-structuredformat-formatoptions.html | 311 -- ...ilities-structuredformat-ienvironment.html | 159 - ...rnal-utilities-structuredformat-joint.html | 147 - ...nal-utilities-structuredformat-layout.html | 161 - ...-utilities-structuredformat-layoutops.html | 571 --- ...-utilities-structuredformat-layouttag.html | 564 --- ...utilities-structuredformat-taggedtext.html | 134 - ...ructuredformat-taggedtextops-literals.html | 316 -- ...lities-structuredformat-taggedtextops.html | 528 --- ...ies-structuredformat-taggedtextwriter.html | 132 - ...interactive-shell-compilerinputstream.html | 96 - ...nteractive-shell-compileroutputstream.html | 94 - ...interactive-shell-evaluationeventargs.html | 94 - ...nteractive-shell-fsievaluationsession.html | 94 - ...-shell-fsievaluationsessionhostconfig.html | 94 - ...p-compiler-interactive-shell-fsivalue.html | 94 - ...p-compiler-interactive-shell-settings.html | 97 - ...ourcecodeservices-compilerenvironment.html | 94 - ...odeservices-compilerenvironmentmodule.html | 97 - ...ourcecodeservices-debuggerenvironment.html | 97 - ...iler-sourcecodeservices-fsharpchecker.html | 94 - ...rcecodeservices-fsharpcheckfileanswer.html | 94 - ...cecodeservices-fsharpcheckfileresults.html | 94 - ...odeservices-fsharpcheckprojectresults.html | 94 - ...eservices-fsharpfinddeclfailurereason.html | 94 - ...urcecodeservices-fsharpfinddeclresult.html | 94 - ...urcecodeservices-fsharpparsingoptions.html | 94 - ...urcecodeservices-fsharpprojectcontext.html | 94 - ...urcecodeservices-fsharpprojectoptions.html | 94 - ...piler-sourcecodeservices-prettynaming.html | 97 - ...deservices-semanticclassificationtype.html | 94 - ...ecodeservices-unresolvedreferencesset.html | 94 - docs/symbols.html | 379 +- docs/tokenizer.html | 101 +- docs/typedtree.html | 660 +-- docs/untypedtree.html | 327 +- fcs/docsrc/tools/generate.fsx | 30 +- fcs/paket.dependencies | 1 - 545 files changed, 1613 insertions(+), 116214 deletions(-) delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilalignment.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilargconvention.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilarraybound.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilarraybounds.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilarrayshape.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilassemblylongevity.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilassemblymanifest.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilassemblyref.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattribelem.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattribute.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattributenamedarg.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattributes.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattributesstored.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilbasictype.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilboxity.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcallingconv.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcallingsignature.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcode.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcodelabel.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcomparisoninstr.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilconst.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ildefaultpinvokeencoding.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilenuminfo.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ileventdef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ileventdefs.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ileventref.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilexceptionclause.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilexceptionspec.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilexportedtypeorforwarder.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilexportedtypesandforwarders.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfielddef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfielddefs.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfieldinit.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfieldref.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfieldspec.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericargs.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericargslist.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdefs.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericvariance.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilglobals.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilguid.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilinstr.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-illazymethodbody.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocal.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocaldebuginfo.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocaldebugmapping.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocals.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocalsallocator.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmemberaccess.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodbody.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethoddef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethoddefs.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldefs.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodref.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodspec.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodvirtualinfo.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmoduledef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmoduleref.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnativeresource.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnativetype.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnativevariant.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtype.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtypes.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iloverridesspec.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilparameter.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilparameters.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilplatform.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilpretypedef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilpropertydef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilpropertydefs.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilpropertyref.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilreadonly.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilreferences.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilresource.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilresourceaccess.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilresourcelocation.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilresources.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilreturn.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilscoperef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsecurityaction.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecl.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecls.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsecuritydeclsstored.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsourcedocument.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsourcemarker.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltailcall.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilthisconvention.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltoken.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltype.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedefaccess.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedefkind.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedeflayout.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedeflayoutinfo.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedefs.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedefstored.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypeinit.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltyperef.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypes.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypespec.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilvarargs.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilversioninfo.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilvolatility.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-methodbody.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-methodcodekind.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-methodkind.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokecallingconvention.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokecharbestfit.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokecharencoding.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokemethod.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokethrowonunmappablechar.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-primaryassembly.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il-publickey.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-il.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilmodulereader.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadermetadatasnapshot.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreaderoptions.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadertrygetmetadatasnapshot.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-metadataonlyflag.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-reducememoryflag.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-defaultassemblyreader.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-iassemblyreader.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-statistics.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-anycallerthreadtoken.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-array.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-cancellable-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-cancellablebuilder.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-cancellablemodule.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-compilationthreadtoken.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-dictionary.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-dictionaryextensions.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-eventually-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-eventuallybuilder.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-eventuallymodule.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-executiontoken.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-inlinedelayinit-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-layeredmap-2.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-layeredmultimap-2.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-lazy.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontext-2.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontextfailure.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-list-frontandback.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-list.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-lock-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-locktoken.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-map.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-memoizationtable-2.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-multimap-2.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-multimapmodule.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-namemap-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-namemapmodule.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-namemultimap-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-namemultimapmodule.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-option.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-order.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-resizearray.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-resultorexception-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-resultorexceptionmodule.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-shim-defaultfilesystem.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-shim-ifilesystem.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-shim.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-string.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-tables.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-undefinedexception.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-uniquestampgenerator-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-valueoptioninternal.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-valueorcancelled-1.html delete mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library.html delete mode 100644 docs/reference/fsharp-compiler-ast-blockseparator.html delete mode 100644 docs/reference/fsharp-compiler-ast-customoperations.html delete mode 100644 docs/reference/fsharp-compiler-ast-expratomicflag.html delete mode 100644 docs/reference/fsharp-compiler-ast-fsharplib.html delete mode 100644 docs/reference/fsharp-compiler-ast-ident.html delete mode 100644 docs/reference/fsharp-compiler-ast-lexbuflocalxmldocstore.html delete mode 100644 docs/reference/fsharp-compiler-ast-lexcont.html delete mode 100644 docs/reference/fsharp-compiler-ast-lexerendlinecontinuation.html delete mode 100644 docs/reference/fsharp-compiler-ast-lexerifdefexpression.html delete mode 100644 docs/reference/fsharp-compiler-ast-lexerifdefstack.html delete mode 100644 docs/reference/fsharp-compiler-ast-lexerifdefstackentries.html delete mode 100644 docs/reference/fsharp-compiler-ast-lexerifdefstackentry.html delete mode 100644 docs/reference/fsharp-compiler-ast-lexerwhitespacecontinuation.html delete mode 100644 docs/reference/fsharp-compiler-ast-longident.html delete mode 100644 docs/reference/fsharp-compiler-ast-longidentwithdots.html delete mode 100644 docs/reference/fsharp-compiler-ast-memberflags.html delete mode 100644 docs/reference/fsharp-compiler-ast-memberkind.html delete mode 100644 docs/reference/fsharp-compiler-ast-nicenamegenerator.html delete mode 100644 docs/reference/fsharp-compiler-ast-parsedfsiinteraction.html delete mode 100644 docs/reference/fsharp-compiler-ast-parsedhashdirective.html delete mode 100644 docs/reference/fsharp-compiler-ast-parsedimplfile.html delete mode 100644 docs/reference/fsharp-compiler-ast-parsedimplfilefragment.html delete mode 100644 docs/reference/fsharp-compiler-ast-parsedimplfileinput.html delete mode 100644 docs/reference/fsharp-compiler-ast-parsedinput.html delete mode 100644 docs/reference/fsharp-compiler-ast-parsedsigfile.html delete mode 100644 docs/reference/fsharp-compiler-ast-parsedsigfilefragment.html delete mode 100644 docs/reference/fsharp-compiler-ast-parsedsigfileinput.html delete mode 100644 docs/reference/fsharp-compiler-ast-parserdetail.html delete mode 100644 docs/reference/fsharp-compiler-ast-prexmldoc.html delete mode 100644 docs/reference/fsharp-compiler-ast-qualifiednameoffile.html delete mode 100644 docs/reference/fsharp-compiler-ast-recordfieldname.html delete mode 100644 docs/reference/fsharp-compiler-ast-scopedpragma.html delete mode 100644 docs/reference/fsharp-compiler-ast-seqexpronly.html delete mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforbinding.html delete mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforfinally.html delete mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforforloop.html delete mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforseq.html delete mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfofortarget.html delete mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfofortry.html delete mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforwhileloop.html delete mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforwith.html delete mode 100644 docs/reference/fsharp-compiler-ast-stablenicenamegenerator.html delete mode 100644 docs/reference/fsharp-compiler-ast-synaccess.html delete mode 100644 docs/reference/fsharp-compiler-ast-synarginfo.html delete mode 100644 docs/reference/fsharp-compiler-ast-synargnamegenerator.html delete mode 100644 docs/reference/fsharp-compiler-ast-synattribute.html delete mode 100644 docs/reference/fsharp-compiler-ast-synattributes.html delete mode 100644 docs/reference/fsharp-compiler-ast-synbinding.html delete mode 100644 docs/reference/fsharp-compiler-ast-synbindingkind.html delete mode 100644 docs/reference/fsharp-compiler-ast-synbindingreturninfo.html delete mode 100644 docs/reference/fsharp-compiler-ast-syncomponentinfo.html delete mode 100644 docs/reference/fsharp-compiler-ast-synconst.html delete mode 100644 docs/reference/fsharp-compiler-ast-synconstructorargs.html delete mode 100644 docs/reference/fsharp-compiler-ast-synenumcase.html delete mode 100644 docs/reference/fsharp-compiler-ast-synenumcases.html delete mode 100644 docs/reference/fsharp-compiler-ast-synexceptiondefn.html delete mode 100644 docs/reference/fsharp-compiler-ast-synexceptiondefnrepr.html delete mode 100644 docs/reference/fsharp-compiler-ast-synexceptionsig.html delete mode 100644 docs/reference/fsharp-compiler-ast-synexpr.html delete mode 100644 docs/reference/fsharp-compiler-ast-synfield.html delete mode 100644 docs/reference/fsharp-compiler-ast-synfields.html delete mode 100644 docs/reference/fsharp-compiler-ast-synindexerarg.html delete mode 100644 docs/reference/fsharp-compiler-ast-syninfo.html delete mode 100644 docs/reference/fsharp-compiler-ast-syninterfaceimpl.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmatchclause.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmeasure.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmemberdefn.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmemberdefns.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmembersig.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmembersigs.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmoduledecl.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmoduledecls.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmoduleornamespace.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmoduleornamespacekind.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmoduleornamespacesig.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmodulesigdecl.html delete mode 100644 docs/reference/fsharp-compiler-ast-synmodulesigdecls.html delete mode 100644 docs/reference/fsharp-compiler-ast-synpat.html delete mode 100644 docs/reference/fsharp-compiler-ast-synrationalconst.html delete mode 100644 docs/reference/fsharp-compiler-ast-synreturninfo.html delete mode 100644 docs/reference/fsharp-compiler-ast-synsimplepat.html delete mode 100644 docs/reference/fsharp-compiler-ast-synsimplepatalternativeidinfo.html delete mode 100644 docs/reference/fsharp-compiler-ast-synsimplepats.html delete mode 100644 docs/reference/fsharp-compiler-ast-synstaticoptimizationconstraint.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntaxerror.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntypar.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntypardecl.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntype.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntypeconstraint.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntypedefn.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnkind.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnrepr.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnsig.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnsigrepr.html delete mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnsimplerepr.html delete mode 100644 docs/reference/fsharp-compiler-ast-synunioncase.html delete mode 100644 docs/reference/fsharp-compiler-ast-synunioncases.html delete mode 100644 docs/reference/fsharp-compiler-ast-synunioncasetype.html delete mode 100644 docs/reference/fsharp-compiler-ast-synvaldata.html delete mode 100644 docs/reference/fsharp-compiler-ast-synvalinfo.html delete mode 100644 docs/reference/fsharp-compiler-ast-synvalsig.html delete mode 100644 docs/reference/fsharp-compiler-ast-synvaltypardecls.html delete mode 100644 docs/reference/fsharp-compiler-ast-typarstaticreq.html delete mode 100644 docs/reference/fsharp-compiler-ast-xmldoc.html delete mode 100644 docs/reference/fsharp-compiler-ast-xmldoccollector.html delete mode 100644 docs/reference/fsharp-compiler-ast-xmldocstatics.html delete mode 100644 docs/reference/fsharp-compiler-ast.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-buildphase.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-buildphasesubcategory.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-capturingerrorlogger.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-deprecated.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-error.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-errorlogger.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-errorloggerextensions.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-errorstyle.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-errorwithsuggestions.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-exiter.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-experimental.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-fsharperrorseverityoptions.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-imperativeoperationresult.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-internalerror.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-libraryuseonly.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-numberederror.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-operationresult-1.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-operationresult.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-phaseddiagnostic.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-possibleunverifiablecode.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-reportederror.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-stopprocessingexn.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-suggestions.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-trackerrorsbuilder.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-unresolvedpathreference.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-unresolvedpathreferencenorange.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-unresolvedreferenceerror.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-unresolvedreferencenorange.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-usercompilermessage.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger-wrappederror.html delete mode 100644 docs/reference/fsharp-compiler-errorlogger.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell-compilerinputstream.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell-compileroutputstream.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell-evaluationeventargs.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell-fsievaluationsession.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell-fsivalue.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell-settings-ieventloop.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell-settings-interactivesettings.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell-settings.html delete mode 100644 docs/reference/fsharp-compiler-interactive-shell.html delete mode 100644 docs/reference/fsharp-compiler-layout-layout.html delete mode 100644 docs/reference/fsharp-compiler-layout-layoutrenderer-2.html delete mode 100644 docs/reference/fsharp-compiler-layout-layouttag.html delete mode 100644 docs/reference/fsharp-compiler-layout-leftl.html delete mode 100644 docs/reference/fsharp-compiler-layout-navigabletaggedtext.html delete mode 100644 docs/reference/fsharp-compiler-layout-noresult.html delete mode 100644 docs/reference/fsharp-compiler-layout-nostate.html delete mode 100644 docs/reference/fsharp-compiler-layout-rightl.html delete mode 100644 docs/reference/fsharp-compiler-layout-sepl.html delete mode 100644 docs/reference/fsharp-compiler-layout-taggedtext.html delete mode 100644 docs/reference/fsharp-compiler-layout-taggedtextops-literals.html delete mode 100644 docs/reference/fsharp-compiler-layout-taggedtextops.html delete mode 100644 docs/reference/fsharp-compiler-layout-wordl.html delete mode 100644 docs/reference/fsharp-compiler-layout.html delete mode 100644 docs/reference/fsharp-compiler-logcompilerfunctionid.html delete mode 100644 docs/reference/fsharp-compiler-partiallongname.html delete mode 100644 docs/reference/fsharp-compiler-prettynaming-activepatterninfo.html delete mode 100644 docs/reference/fsharp-compiler-prettynaming-invalidmangledstaticarg.html delete mode 100644 docs/reference/fsharp-compiler-prettynaming-namearitypair.html delete mode 100644 docs/reference/fsharp-compiler-prettynaming.html delete mode 100644 docs/reference/fsharp-compiler-quickparse.html delete mode 100644 docs/reference/fsharp-compiler-range-fileindex.html delete mode 100644 docs/reference/fsharp-compiler-range-line.html delete mode 100644 docs/reference/fsharp-compiler-range-line0.html delete mode 100644 docs/reference/fsharp-compiler-range-pos-0.html delete mode 100644 docs/reference/fsharp-compiler-range-pos.html delete mode 100644 docs/reference/fsharp-compiler-range-pos01.html delete mode 100644 docs/reference/fsharp-compiler-range-range-0.html delete mode 100644 docs/reference/fsharp-compiler-range-range.html delete mode 100644 docs/reference/fsharp-compiler-range-range01.html delete mode 100644 docs/reference/fsharp-compiler-range.html delete mode 100644 docs/reference/fsharp-compiler-referenceresolver-resolutionenvironment.html delete mode 100644 docs/reference/fsharp-compiler-referenceresolver-resolvedfile.html delete mode 100644 docs/reference/fsharp-compiler-referenceresolver-resolver.html delete mode 100644 docs/reference/fsharp-compiler-referenceresolver.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-assemblycontentprovider.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-assemblycontenttype.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-assemblypath.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-assemblysymbol.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-astvisitorbase-1.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversepath.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversestep.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-asttraversal.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-basicpatterns.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironment.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-completioncontext.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-completionitemkind.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-completionpath.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-debuggerenvironment.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-entity.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-entitycache.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-entitykind.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-extensions.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-externalsymbol.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-externaltype.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-externaltypemodule.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractparameter.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractsignature.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibility.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibilityrights.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterncase.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterngroup.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpanonrecordtypedetails.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpassembly.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblycontents.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblysignature.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpattribute.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpchecker.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistinfo.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistitem.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpdelegatesignature.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpdisplaycontext.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpenclosingentitykind.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpentity.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorinfo.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorseverity.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpexpr.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpfield.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameter.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterconstraint.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdefaultstoconstraint.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdelegateconstraint.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparametermemberconstraint.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpglyph.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfilecontents.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfiledeclaration.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpinlineannotation.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharplinetokenizer.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpmemberorfunctionorvalue.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroup.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitem.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitemparameter.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitem.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitemkind.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationitems.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationtopleveldeclaration.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnoteworthyparaminfolocations.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpobjectexproverride.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpopendeclaration.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpparameter.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsefileresults.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpsourcetokenizer.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpstaticparameter.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltipelement.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltiptext.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymbol.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymboluse.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencharkind.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencolorkind.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokeninfo.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizercolorstate.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizerlexstate.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentag.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentriggerclass.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement-1.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelementdata-1.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext-1.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptype.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpunioncase.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpxmldoc.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-iassemblycontentcache.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-idents.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-inheritancecontext.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-insertcontext.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-keywords.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-layout.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-lookuptype.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedident.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedidents.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-modulekind.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto-container.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto-containertype.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitem.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitemkind.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-openstatementinsertionpoint.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbol.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbolmodule.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-parsedinput.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-position.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-prettynaming.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-range.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-recordcontext.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-scopekind.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-semanticclassificationtype.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-shortident.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-sourcefile.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-stringlongident.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-structure-collapse.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-structure-scope.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-structure-scoperange.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-structure.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-symbol.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-tooltips.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-unresolvedsymbol.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-untypedparseimpl.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-unusedopens.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-xmldocable.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-xmldoccomment.html delete mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-xmldocparser.html delete mode 100644 docs/reference/index.html delete mode 100644 docs/reference/internal-utilities-structuredformat-display.html delete mode 100644 docs/reference/internal-utilities-structuredformat-formatoptions.html delete mode 100644 docs/reference/internal-utilities-structuredformat-ienvironment.html delete mode 100644 docs/reference/internal-utilities-structuredformat-joint.html delete mode 100644 docs/reference/internal-utilities-structuredformat-layout.html delete mode 100644 docs/reference/internal-utilities-structuredformat-layoutops.html delete mode 100644 docs/reference/internal-utilities-structuredformat-layouttag.html delete mode 100644 docs/reference/internal-utilities-structuredformat-taggedtext.html delete mode 100644 docs/reference/internal-utilities-structuredformat-taggedtextops-literals.html delete mode 100644 docs/reference/internal-utilities-structuredformat-taggedtextops.html delete mode 100644 docs/reference/internal-utilities-structuredformat-taggedtextwriter.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-interactive-shell-compilerinputstream.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-interactive-shell-compileroutputstream.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-interactive-shell-evaluationeventargs.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-interactive-shell-fsievaluationsession.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-interactive-shell-fsivalue.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-interactive-shell-settings.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-compilerenvironment.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-debuggerenvironment.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpchecker.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-prettynaming.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-semanticclassificationtype.html delete mode 100644 docs/reference/microsoft-fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html diff --git a/docs/caches.html b/docs/caches.html index 2e33884aa5..ec2efa8514 100644 --- a/docs/caches.html +++ b/docs/caches.html @@ -25,22 +25,21 @@

F# Compiler Services

- -

Compiler Services: Notes on the FSharpChecker caches

+

Compiler Services: Notes on the FSharpChecker caches

This is a design note on the FSharpChecker component and its caches. See also the notes on the FSharpChecker operations queue

Each FSharpChecker object maintains a set of caches. These are

- Fork me on GitHub + Fork me on GitHub diff --git a/docs/compiler.html b/docs/compiler.html index 66d5568198..941bea658e 100644 --- a/docs/compiler.html +++ b/docs/compiler.html @@ -25,16 +25,15 @@

F# Compiler Services

- -

Hosted Compiler

+

Hosted Compiler

This tutorial demonstrates how to host the F# compiler.

NOTE: The FSharp.Compiler.Service API is subject to change when later versions of the nuget package are published

@@ -56,12 +55,12 @@

Hosted Comp 5: 6: -
#r "FSharp.Compiler.Service.dll"
-open System.IO
-open FSharp.Compiler.SourceCodeServices
+
#r "FSharp.Compiler.Service.dll"
+open System.IO
+open FSharp.Compiler.SourceCodeServices
 
 // Create an interactive checker instance 
-let checker = FSharpChecker.Create()
+let checker = FSharpChecker.Create()
 

 
 
@@ -79,18 +78,18 @@ 
Hosted Comp
 11: 
 12:
-
let fn = Path.GetTempFileName()
-let fn2 = Path.ChangeExtension(fn, ".fsx")
-let fn3 = Path.ChangeExtension(fn, ".dll")
+
let fn = Path.GetTempFileName()
+let fn2 = Path.ChangeExtension(fn, ".fsx")
+let fn3 = Path.ChangeExtension(fn, ".dll")
 
-File.WriteAllText(fn2, """
+File.WriteAllText(fn2, """
 module M
 
 type C() = 
    member x.P = 1
 
 let x = 3 + 4
-""")
+""")
 

 
 
@@ -99,9 +98,9 @@ 
Hosted Comp
 2: 
 3:
-
let errors1, exitCode1 = 
-    checker.Compile([| "fsc.exe"; "-o"; fn3; "-a"; fn2 |]) 
-    |> Async.RunSynchronously
+
let errors1, exitCode1 = 
+    checker.Compile([| "fsc.exe"; "-o"; fn3; "-a"; fn2 |]) 
+    |> Async.RunSynchronously
 

 
 
@@ -116,15 +115,15 @@ 
Hosted Comp
 8: 
 9:
-
File.WriteAllText(fn2, """
+
File.WriteAllText(fn2, """
 module M
 
 let x = 1.0 + "" // a type error
-""")
+""")
 
-let errors1b, exitCode1b = 
-    checker.Compile([| "fsc.exe"; "-o"; fn3; "-a"; fn2 |])
-    |> Async.RunSynchronously
+let errors1b, exitCode1b = 
+    checker.Compile([| "fsc.exe"; "-o"; fn3; "-a"; fn2 |])
+    |> Async.RunSynchronously
 

 
 
@@ -133,7 +132,7 @@ 

-
The 'None' option indicates that the initiatlization code for the assembly is not executed.

+
The 'None' option indicates that the initialization code for the assembly is not executed.

 
-
 1: 
  2: 
  3: 
@@ -145,16 +144,16 @@ 
 9: 
 10: 
 
let errors2, exitCode2, dynAssembly2 = 
-    checker.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], execute=None)
-     |> Async.RunSynchronously
+
let errors2, exitCode2, dynAssembly2 = 
+    checker.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], execute=None)
+     |> Async.RunSynchronously
 
 (*
-Passing 'Some' for the 'execute' parameter executes  the initiatlization code for the assembly.
+Passing 'Some' for the 'execute' parameter executes  the initialization code for the assembly.
 *)
-let errors3, exitCode3, dynAssembly3 = 
-    checker.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], Some(stdout,stderr))
-     |> Async.RunSynchronously
+let errors3, exitCode3, dynAssembly3 = 
+    checker.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], Some(stdout,stderr))
+     |> Async.RunSynchronously
 

 

 

@@ -164,35 +163,35 @@ 
Multiple items
namespace FSharp

--------------------
namespace Microsoft.FSharp

namespace FSharp.Compiler
namespace FSharp.Compiler.SourceCodeServices
-
val checker : FSharpChecker

Full name: Compiler.checker
-
type FSharpChecker
member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
member InvalidateAll : unit -> unit
member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
member StopBackgroundCompile : unit -> unit
member TokenizeFile : source:string -> FSharpTokenInfo [] []
member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
member WaitForBackgroundCompile : unit -> unit
member BeforeBackgroundFileCheck : IEvent<string * obj option>
member CurrentQueueLength : int
member FileChecked : IEvent<string * obj option>
member FileParsed : IEvent<string * obj option>
member private FrameworkImportsCache : FrameworkImportsCache
member ImplicitlyStartBackgroundWork : bool
member MaxMemory : int
member MaxMemoryReached : IEvent<unit>
member PauseBeforeBackgroundWork : int
member ProjectChecked : IEvent<string * obj option>
member private ReactorOps : IReactorOperations
member private ReferenceResolver : Resolver
member ImplicitlyStartBackgroundWork : bool with set
member MaxMemory : int with set
member PauseBeforeBackgroundWork : int with set
static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
static member GlobalForegroundParseCountStatistic : int
static member GlobalForegroundTypeCheckCountStatistic : int

Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
-
static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
-
val fn : string

Full name: Compiler.fn
-
type Path =
  static val DirectorySeparatorChar : char
  static val AltDirectorySeparatorChar : char
  static val VolumeSeparatorChar : char
  static val InvalidPathChars : char[]
  static val PathSeparator : char
  static member ChangeExtension : path:string * extension:string -> string
  static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
  static member GetDirectoryName : path:string -> string
  static member GetExtension : path:string -> string
  static member GetFileName : path:string -> string
  ...

Full name: System.IO.Path
+
val checker : FSharpChecker
+
type FSharpChecker =
  member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
  member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
  member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
  member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
  member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
  member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
  member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
  member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
  member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
  member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
  ...
+
static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
+
val fn : string
+
type Path =
  static val DirectorySeparatorChar : char
  static val AltDirectorySeparatorChar : char
  static val VolumeSeparatorChar : char
  static val PathSeparator : char
  static val InvalidPathChars : char[]
  static member ChangeExtension : path:string * extension:string -> string
  static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
  static member GetDirectoryName : path:string -> string + 1 overload
  static member GetExtension : path:string -> string + 1 overload
  static member GetFileName : path:string -> string + 1 overload
  ...
Path.GetTempFileName() : string
-
val fn2 : string

Full name: Compiler.fn2
+
val fn2 : string
Path.ChangeExtension(path: string, extension: string) : string
-
val fn3 : string

Full name: Compiler.fn3
-
type File =
  static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
  static member AppendAllText : path:string * contents:string -> unit + 1 overload
  static member AppendText : path:string -> StreamWriter
  static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
  static member Create : path:string -> FileStream + 3 overloads
  static member CreateText : path:string -> StreamWriter
  static member Decrypt : path:string -> unit
  static member Delete : path:string -> unit
  static member Encrypt : path:string -> unit
  static member Exists : path:string -> bool
  ...

Full name: System.IO.File
+
val fn3 : string
+
type File =
  static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
  static member AppendAllLinesAsync : path:string * contents:IEnumerable<string> * ?cancellationToken:CancellationToken -> Task + 1 overload
  static member AppendAllText : path:string * contents:string -> unit + 1 overload
  static member AppendAllTextAsync : path:string * contents:string * ?cancellationToken:CancellationToken -> Task + 1 overload
  static member AppendText : path:string -> StreamWriter
  static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
  static member Create : path:string -> FileStream + 2 overloads
  static member CreateText : path:string -> StreamWriter
  static member Decrypt : path:string -> unit
  static member Delete : path:string -> unit
  ...
File.WriteAllText(path: string, contents: string) : unit
File.WriteAllText(path: string, contents: string, encoding: System.Text.Encoding) : unit
-
val errors1 : obj

Full name: Compiler.errors1
-
val exitCode1 : obj

Full name: Compiler.exitCode1
+
val errors1 : FSharpErrorInfo []
+
val exitCode1 : int
member FSharpChecker.Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
member FSharpChecker.Compile : ast:FSharp.Compiler.Ast.ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
-
Multiple items

--------------------
type Async<'T>

Full name: Microsoft.FSharp.Control.Async<_>
-
-
val errors1b : obj

Full name: Compiler.errors1b
-
val exitCode1b : obj

Full name: Compiler.exitCode1b
-
val errors2 : obj

Full name: Compiler.errors2
-
val exitCode2 : obj

Full name: Compiler.exitCode2
-
val dynAssembly2 : obj

Full name: Compiler.dynAssembly2
+
Multiple items
type Async =
  static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
  static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
  static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
  static member AwaitTask : task:Task -> Async<unit>
  static member AwaitTask : task:Task<'T> -> Async<'T>
  static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
  static member CancelDefaultToken : unit -> unit
  static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
  static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
  static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
  ...

--------------------
type Async<'T> =
+
static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:System.Threading.CancellationToken -> 'T
+
val errors1b : FSharpErrorInfo []
+
val exitCode1b : int
+
val errors2 : FSharpErrorInfo []
+
val exitCode2 : int
+
val dynAssembly2 : System.Reflection.Assembly option
member FSharpChecker.CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * System.Reflection.Assembly option>
member FSharpChecker.CompileToDynamicAssembly : ast:FSharp.Compiler.Ast.ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * System.Reflection.Assembly option>
union case Option.None: Option<'T>
-
val errors3 : obj

Full name: Compiler.errors3
-
val exitCode3 : obj

Full name: Compiler.exitCode3
-
val dynAssembly3 : obj

Full name: Compiler.dynAssembly3
+
val errors3 : FSharpErrorInfo []
+
val exitCode3 : int
+
val dynAssembly3 : System.Reflection.Assembly option
union case Option.Some: Value: 'T -> Option<'T>
-
val stdout<'T> : TextWriter

Full name: Microsoft.FSharp.Core.Operators.stdout
-
val stderr<'T> : TextWriter

Full name: Microsoft.FSharp.Core.Operators.stderr
+
val stdout<'T> : TextWriter
+
val stderr<'T> : TextWriter
@@ -208,10 +207,10 @@

Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -240,6 +239,6 @@

    Fork me on GitHub + Fork me on GitHub diff --git a/docs/corelib.html b/docs/corelib.html index 08a1929dd5..8f99abab7c 100644 --- a/docs/corelib.html +++ b/docs/corelib.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Compiler Services: Notes on FSharp.Core.dll

    +

    Compiler Services: Notes on FSharp.Core.dll

    Shipping an FSharp.Core with your application

    When building applications or plug-in components which use FSharp.Compiler.Service.dll, you will normally also include a copy of FSharp.Core.dll as part of your application.

    @@ -42,7 +41,7 @@

    HostedCompiler.exe.

    Binding redirects for your application

    The FSharp.Compiler.Service.dll component depends on FSharp.Core 4.4.0.0. Normally your application will target -a later version of FSharp.Core, and you may need a binding redirect to ensure +a later version of FSharp.Core, and you may need a binding redirect to ensure that other versions of FSharp.Core forward to the final version of FSharp.Core.dll your application uses. Binding redirect files are normally generated automatically by build tools. If not, you can use one like this (if your tool is called HostedCompiler.exe, the binding redirect file is called HostedCompiler.exe.config)

    @@ -63,21 +62,21 @@

    14: 15: -
    <?xml version="1.0" encoding="utf-8" ?>
-<configuration>
-    <runtime>
-      <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
-        <dependentAssembly>
-          <assemblyIdentity name="FSharp.Core" publicKeyToken="b03f5f7f11d50a3a" culture="neutral"/>
-          <bindingRedirect oldVersion="2.0.0.0-4.4.0.0" newVersion="4.4.1.0"/>
-        </dependentAssembly>
-        <dependentAssembly>
-          <assemblyIdentity name="System.Collections.Immutable" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
-          <bindingRedirect oldVersion="1.0.0.0-1.2.0.0" newVersion="1.2.1.0" />
-        </dependentAssembly>
-      </assemblyBinding>
-    </runtime>	
-</configuration>
+
    <?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+    <runtime>
+      <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
+        <dependentAssembly>
+          <assemblyIdentity name="FSharp.Core" publicKeyToken="b03f5f7f11d50a3a" culture="neutral"/>
+          <bindingRedirect oldVersion="2.0.0.0-4.4.0.0" newVersion="4.4.1.0"/>
+        </dependentAssembly>
+        <dependentAssembly>
+          <assemblyIdentity name="System.Collections.Immutable" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
+          <bindingRedirect oldVersion="1.0.0.0-1.2.0.0" newVersion="1.2.1.0" />
+        </dependentAssembly>
+      </assemblyBinding>
+    </runtime>
+</configuration>
 
    
 
 
@@ -98,21 +97,21 @@ 
     9: 
 10:
    -
    [<Literal>]
-let fsharpCorePath = 
+
    [<Literal>]
+let fsharpCorePath =
     @"C:\Program Files (x86)\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.1.0\FSharp.Core.dll"
-let errors2, exitCode2 = 
-  scs.Compile(
-    [| "fsc.exe"; "--noframework"; 
-       "-r"; fsharpCorePath; 
-       "-r"; @"C:\Windows\Microsoft.NET\Framework\v4.0.30319\mscorlib.dll"; 
-       "-o"; fn3; 
-       "-a"; fn2 |])
+let errors2, exitCode2 =
+  scs.Compile(
+    [| "fsc.exe"; "--noframework";
+       "-r"; fsharpCorePath;
+       "-r"; @"C:\Windows\Microsoft.NET\Framework\v4.0.30319\mscorlib.dll";
+       "-o"; fn3;
+       "-a"; fn2 |])
 
    
 
 
 
    You will need to determine the location of these assemblies.  The easiest way to locate these DLLs in a cross-platform way and
-convert them to command-line arguments is to crack an F# project file.
    
+convert them to command-line arguments is to crack an F# project file.
 Alternatively you can compute SDK paths yourself, and some helpers to do this are in the tests for FSharp.Compiler.Service.dll.
    
 
    What about if I am processing a script or using GetCheckOptionsFromScriptRoot
    
 
    If you do not explicitly reference an FSharp.Core.dll from an SDK location, or if you are processing a script
@@ -137,7 +136,7 @@ 
    Summary
    
 
  • which FSharp.Core.dll and/or framework assemblies are  referenced during the checking and compilations performed by your tools.
    • 
 
 
-
    Multiple items
    type LiteralAttribute =
      inherit Attribute
      new : unit -> LiteralAttribute

    Full name: Microsoft.FSharp.Core.LiteralAttribute

    --------------------
    new : unit -> LiteralAttribute
    
+
    Multiple items
    type LiteralAttribute =
      inherit Attribute
      new : unit -> LiteralAttribute

    --------------------
    new : unit -> LiteralAttribute

    @@ -153,10 +152,10 @@

    Summary

  • Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -185,6 +184,6 @@

    Summary

    - Fork me on GitHub + Fork me on GitHub diff --git a/docs/devnotes.html b/docs/devnotes.html index 3fc4f8cb52..da1e7e5ffe 100644 --- a/docs/devnotes.html +++ b/docs/devnotes.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Developer notes

    +

    Developer notes

    Modified clone of F# compiler exposing additional functionality for editing clients and embedding F# compiler and F# interactive as services.

    Components

    @@ -55,7 +54,7 @@

    Components

  • Build script using FAKE that builds everything, produces NuGet package and -generates documentation, files for publising NuGet packages etc. +generates documentation, files for publishing NuGet packages etc. (following F# project scaffold)

  • @@ -65,7 +64,7 @@

    Components

  • Additions to compiler source code which improve the API for the use of F# editing clients
  • Additions to compiler source code which add new functionality to the compiler service API
    • -

    If language or compiler addiitons are committed to fsharp/fsharp, they should be merged into +

    If language or compiler additions are committed to fsharp/fsharp, they should be merged into this repo and a new NuGet package released.

    Building and NuGet

    The build process follows the standard recommended by F# project scaffold @@ -86,7 +85,7 @@

    Release
  • Update RELEASE_NOTES.md
  • Check the version numbers are correct across the source (some files duplicate them)
  • Commit and add the necessary tag to the repo
    • -
  • Publish the nupkgs for FSharp.Compiler.Service and FSharp.Compiler.Service.ProjectCracker once they appear in AppVeyor artifacts
    • +
  • Publish the nupkgs for FSharp.Compiler.Service once it appears in AppVeyor artifacts
    • @@ -104,10 +103,10 @@

    Release
  • Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -136,6 +135,6 @@

    Release

    - Fork me on GitHub + Fork me on GitHub diff --git a/docs/editor.html b/docs/editor.html index fc4aecb7b8..b6924661be 100644 --- a/docs/editor.html +++ b/docs/editor.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Compiler Services: Editor services

    +

    Compiler Services: Editor services

    This tutorial demonstrates how to use the editor services provided by the F# compiler. This API is used to provide auto-complete, tool-tips, parameter info help, matching of brackets and other functions in F# editors including Visual Studio, Xamarin Studio and Emacs @@ -56,15 +55,17 @@

    6: 7: 8: +9: 
    // Reference F# compiler API
-#r "FSharp.Compiler.Service.dll"
+#r "FSharp.Compiler.Service.dll"
 
-open System
-open FSharp.Compiler.SourceCodeServices
+open System
+open FSharp.Compiler.SourceCodeServices
+open FSharp.Compiler.Text
 
 // Create an interactive checker instance 
-let checker = FSharpChecker.Create()
+let checker = FSharpChecker.Create()
    @@ -92,7 +93,7 @@

    19: 
    // Sample input as a multi-line string
-let input = 
+let input = 
   """
   open System
 
@@ -102,14 +103,14 @@ 
          printfn "%s" msg.
   """
 // Split the input & define file name
-let inputLines = input.Split('\n')
-let file = "/home/user/Test.fsx"
+let inputLines = input.Split('\n')
+let file = "/home/user/Test.fsx"
 
-let projOptions, errors = 
-    checker.GetProjectOptionsFromScript(file, input)
-    |> Async.RunSynchronously
+let projOptions, errors = 
+    checker.GetProjectOptionsFromScript(file, SourceText.ofString input)
+    |> Async.RunSynchronously
 
-let parsingOptions, _errors = checker.GetParsingOptionsFromProjectOptions(projOptions)
+let parsingOptions, _errors = checker.GetParsingOptionsFromProjectOptions(projOptions)
    @@ -126,9 +127,9 @@ 

    // Perform parsing  
 
-let parseFileResults = 
-    checker.ParseFile(file, input, parsingOptions) 
-    |> Async.RunSynchronously
+let parseFileResults = 
+    checker.ParseFile(file, SourceText.ofString input, parsingOptions)
+    |> Async.RunSynchronously
    @@ -141,9 +142,9 @@

    4: 
    // Perform type checking
-let checkFileAnswer = 
-    checker.CheckFileInProject(parseFileResults, file, 0, input, projOptions) 
-    |> Async.RunSynchronously
+let checkFileAnswer = 
+    checker.CheckFileInProject(parseFileResults, file, 0, SourceText.ofString input, projOptions)
+    |> Async.RunSynchronously
    @@ -152,9 +153,9 @@

    2: 3: -
    let parseResults2, checkFileAnswer2 = 
-    checker.ParseAndCheckFileInProject(file, 0, input, projOptions) 
-    |> Async.RunSynchronously
+
    let parseResults2, checkFileAnswer2 = 
+    checker.ParseAndCheckFileInProject(file, 0, SourceText.ofString input, projOptions)
+    |> Async.RunSynchronously
 
    
 
 
@@ -166,10 +167,10 @@ 
    3: 
 4:
    -
    let checkFileResults = 
-    match checkFileAnswer with
-    | FSharpCheckFileAnswer.Succeeded(res) -> res
-    | res -> failwithf "Parsing did not finish... (%A)" res
+
    let checkFileResults = 
+    match checkFileAnswer with
+    | FSharpCheckFileAnswer.Succeeded(res) -> res
+    | res -> failwithf "Parsing did not finish... (%A)" res
 
    
 
 
@@ -196,12 +197,12 @@ 
    Getti
 7: 
 
    // Get tag of the IDENT token to be used as the last argument
-open FSharp.Compiler
-let identToken = FSharpTokenTag.Identifier
+open FSharp.Compiler
+let identToken = FSharpTokenTag.Identifier
 
 // Get tool tip at the specified location
-let tip = checkFileResults.GetToolTipText(4, 7, inputLines.[1], ["foo"], identToken)
-printfn "%A" tip
+let tip = checkFileResults.GetToolTipText(4, 7, inputLines.[1], ["foo"], identToken)
+printfn "%A" tip
    @@ -223,7 +224,7 @@

    ). The offsets are one-based, so the location is 7, 23. -We also need to specify a function that says that the text has not changed and the current identifer +We also need to specify a function that says that the text has not changed and the current identifier where we need to perform the completion.

    1: 
 2: 
@@ -236,14 +237,14 @@ 
    9: 
 
    // Get declarations (autocomplete) for a location
-let decls = 
-    checkFileResults.GetDeclarationListInfo
-      (Some parseFileResults, 7, inputLines.[6], PartialLongName.Empty 23, (fun () -> []), fun _ -> false)
-    |> Async.RunSynchronously
+let decls = 
+    checkFileResults.GetDeclarationListInfo
+      (Some parseFileResults, 7, inputLines.[6], PartialLongName.Empty 23, (fun () -> []), fun _ -> false)
+    |> Async.RunSynchronously
 
 // Print the names of available items
-for item in decls.Items do
-    printfn " - %s" item.Name
+for item in decls.Items do
+    printfn " - %s" item.Name
    @@ -275,15 +276,15 @@

    10: 
    // Get overloads of the String.Concat method
-let methods = 
-    checkFileResults.GetMethods(5, 27, inputLines.[4], Some ["String"; "Concat"])
-    |> Async.RunSynchronously
+let methods = 
+    checkFileResults.GetMethods(5, 27, inputLines.[4], Some ["String"; "Concat"])
+    |> Async.RunSynchronously
 
 // Print concatenated parameter lists
-for mi in methods.Methods do
-    [ for p in mi.Parameters -> p.Display ]
-    |> String.concat ", " 
-    |> printfn "%s(%s)" methods.MethodName
+for mi in methods.Methods do
+    [ for p in mi.Parameters -> p.Display ]
+    |> String.concat ", " 
+    |> printfn "%s(%s)" methods.MethodName
    @@ -319,53 +320,62 @@

    Summary

    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    namespace FSharp.Compiler
    namespace FSharp.Compiler.SourceCodeServices
    -
    val checker : FSharpChecker

    Full name: Editor.checker
    -
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    -
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    -
    val input : string

    Full name: Editor.input
    -
    val inputLines : string []

    Full name: Editor.inputLines
    -
    String.Split([<ParamArray>] separator: char []) : string []
    String.Split(separator: string [], options: StringSplitOptions) : string []
    String.Split(separator: char [], options: StringSplitOptions) : string []
    String.Split(separator: char [], count: int) : string []
    String.Split(separator: string [], count: int, options: StringSplitOptions) : string []
    String.Split(separator: char [], count: int, options: StringSplitOptions) : string []
    -
    val file : string

    Full name: Editor.file
    -
    val projOptions : FSharpProjectOptions

    Full name: Editor.projOptions
    -
    val errors : obj

    Full name: Editor.errors
    -
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    val parsingOptions : FSharpParsingOptions

    Full name: Editor.parsingOptions
    -
    member FSharpChecker.GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    -
    val parseFileResults : FSharpParseFileResults

    Full name: Editor.parseFileResults
    -
    member FSharpChecker.ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    -
    val checkFileAnswer : FSharpCheckFileAnswer

    Full name: Editor.checkFileAnswer
    -
    member FSharpChecker.CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    -
    val parseResults2 : obj

    Full name: Editor.parseResults2
    -
    val checkFileAnswer2 : obj

    Full name: Editor.checkFileAnswer2
    -
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    -
    val checkFileResults : FSharpCheckFileResults

    Full name: Editor.checkFileResults
    -
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults

    Full name: FSharp.Compiler.SourceCodeServices.FSharpCheckFileAnswer
    -
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    -
    val res : FSharpCheckFileResults
    -
    val res : FSharpCheckFileAnswer
    -
    val failwithf : format:Printf.StringFormat<'T,'Result> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.failwithf
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>

    Full name: FSharp.Compiler.SourceCodeServices.FSharpAttribute
    -
    val identToken : int

    Full name: Editor.identToken
    -
    module FSharpTokenTag

    from FSharp.Compiler.SourceCodeServices
    -
    val Identifier : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpTokenTag.Identifier
    -
    val tip : Async<FSharpToolTipText>

    Full name: Editor.tip
    -
    member FSharpCheckFileResults.GetToolTipText : line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * ?userOpName:string -> Async<FSharpToolTipText>
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    val decls : obj

    Full name: Editor.decls
    -
    member FSharpCheckFileResults.GetDeclarationListInfo : ParsedFileResultsOpt:FSharpParseFileResults option * line:int * lineText:string * partialName:PartialLongName * ?getAllEntities:(unit -> AssemblySymbol list) * ?hasTextChangedSinceLastTypecheck:(obj * Range.range -> bool) * ?userOpName:string -> Async<FSharpDeclarationListInfo>
    -
    union case Option.Some: Value: 'T -> Option<'T>
    -
    type PartialLongName =
      {QualifyingIdents: string list;
       PartialIdent: string;
       EndColumn: int;
       LastDotPos: int option;}
      static member Empty : endColumn:int -> PartialLongName

    Full name: FSharp.Compiler.PartialLongName
    -
    static member PartialLongName.Empty : endColumn:int -> PartialLongName
    -
    val item : Entity
    -
    Entity.Name: StringLongIdent
    -
    val methods : obj

    Full name: Editor.methods
    -
    member FSharpCheckFileResults.GetMethods : line:int * colAtEndOfNames:int * lineText:string * names:string list option * ?userOpName:string -> Async<FSharpMethodGroup>
    -
    val mi : obj
    -
    val p : obj
    -
    Multiple items
    type String =
      new : value:char -> string + 7 overloads
      member Chars : int -> char
      member Clone : unit -> obj
      member CompareTo : value:obj -> int + 1 overload
      member Contains : value:string -> bool
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EndsWith : value:string -> bool + 2 overloads
      member Equals : obj:obj -> bool + 2 overloads
      member GetEnumerator : unit -> CharEnumerator
      member GetHashCode : unit -> int
      ...

    Full name: System.String

    --------------------
    String(value: nativeptr<char>) : unit
    String(value: nativeptr<sbyte>) : unit
    String(value: char []) : unit
    String(c: char, count: int) : unit
    String(value: nativeptr<char>, startIndex: int, length: int) : unit
    String(value: nativeptr<sbyte>, startIndex: int, length: int) : unit
    String(value: char [], startIndex: int, length: int) : unit
    String(value: nativeptr<sbyte>, startIndex: int, length: int, enc: Text.Encoding) : unit
    -
    val concat : sep:string -> strings:seq<string> -> string

    Full name: Microsoft.FSharp.Core.String.concat
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>
    +
    namespace FSharp.Compiler.Text
    +
    val checker : FSharpChecker
    +
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    +
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    +
    val input : string
    +
    val inputLines : string []
    +
    String.Split([<ParamArray>] separator: char []) : string []
    String.Split(separator: string [], options: StringSplitOptions) : string []
    String.Split(separator: string,?options: StringSplitOptions) : string []
    String.Split(separator: char [], options: StringSplitOptions) : string []
    String.Split(separator: char [], count: int) : string []
    String.Split(separator: char,?options: StringSplitOptions) : string []
    String.Split(separator: string [], count: int, options: StringSplitOptions) : string []
    String.Split(separator: string, count: int,?options: StringSplitOptions) : string []
    String.Split(separator: char [], count: int, options: StringSplitOptions) : string []
    String.Split(separator: char, count: int,?options: StringSplitOptions) : string []
    +
    val file : string
    +
    val projOptions : FSharpProjectOptions
    +
    val errors : FSharpErrorInfo list
    +
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * sourceText:ISourceText * ?previewEnabled:bool * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?useSdkRefs:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    +
    module SourceText

    from FSharp.Compiler.Text
    +
    val ofString : string -> ISourceText
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    val parsingOptions : FSharpParsingOptions
    +
    val _errors : FSharpErrorInfo list
    +
    member FSharpChecker.GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    +
    val parseFileResults : FSharpParseFileResults
    +
    member FSharpChecker.ParseFile : filename:string * sourceText:ISourceText * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    +
    val checkFileAnswer : FSharpCheckFileAnswer
    +
    member FSharpChecker.CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    +
    val parseResults2 : FSharpParseFileResults
    +
    val checkFileAnswer2 : FSharpCheckFileAnswer
    +
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    +
    val checkFileResults : FSharpCheckFileResults
    +
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults
    +
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    +
    val res : FSharpCheckFileResults
    +
    val res : FSharpCheckFileAnswer
    +
    val failwithf : format:Printf.StringFormat<'T,'Result> -> 'T
    +
    val identToken : int
    +
    module FSharpTokenTag

    from FSharp.Compiler.SourceCodeServices
    +
    val Identifier : int
    +
    val tip : Async<FSharpToolTipText>
    +
    member FSharpCheckFileResults.GetToolTipText : line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * ?userOpName:string -> Async<FSharpToolTipText>
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    val decls : FSharpDeclarationListInfo
    +
    member FSharpCheckFileResults.GetDeclarationListInfo : ParsedFileResultsOpt:FSharpParseFileResults option * line:int * lineText:string * partialName:PartialLongName * ?getAllEntities:(unit -> AssemblySymbol list) * ?hasTextChangedSinceLastTypecheck:(obj * Range.range -> bool) * ?userOpName:string -> Async<FSharpDeclarationListInfo>
    +
    union case Option.Some: Value: 'T -> Option<'T>
    +
    type PartialLongName =
      { QualifyingIdents: string list
        PartialIdent: string
        EndColumn: int
        LastDotPos: int option }
        static member Empty : endColumn:int -> PartialLongName
    +
    static member PartialLongName.Empty : endColumn:int -> PartialLongName
    +
    val item : FSharpDeclarationListItem
    +
    property FSharpDeclarationListInfo.Items: FSharpDeclarationListItem [] with get
    +
    property FSharpDeclarationListItem.Name: string with get
    +
    val methods : FSharpMethodGroup
    +
    member FSharpCheckFileResults.GetMethods : line:int * colAtEndOfNames:int * lineText:string * names:string list option * ?userOpName:string -> Async<FSharpMethodGroup>
    +
    val mi : FSharpMethodGroupItem
    +
    property FSharpMethodGroup.Methods: FSharpMethodGroupItem [] with get
    +
    val p : FSharpMethodGroupItemParameter
    +
    property FSharpMethodGroupItem.Parameters: FSharpMethodGroupItemParameter [] with get
    +
    property FSharpMethodGroupItemParameter.Display: string with get
    +
    Multiple items
    type String =
      new : value:char[] -> string + 8 overloads
      member Chars : int -> char
      member Clone : unit -> obj
      member CompareTo : value:obj -> int + 1 overload
      member Contains : value:string -> bool + 3 overloads
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EndsWith : value:string -> bool + 3 overloads
      member Equals : obj:obj -> bool + 2 overloads
      member GetEnumerator : unit -> CharEnumerator
      member GetHashCode : unit -> int + 1 overload
      ...

    --------------------
    String(value: char []) : String
    String(value: nativeptr<char>) : String
    String(value: nativeptr<sbyte>) : String
    String(value: ReadOnlySpan<char>) : String
    String(c: char, count: int) : String
    String(value: char [], startIndex: int, length: int) : String
    String(value: nativeptr<char>, startIndex: int, length: int) : String
    String(value: nativeptr<sbyte>, startIndex: int, length: int) : String
    String(value: nativeptr<sbyte>, startIndex: int, length: int, enc: Text.Encoding) : String
    +
    val concat : sep:string -> strings:seq<string> -> string
    +
    property FSharpMethodGroup.MethodName: string with get

    @@ -381,10 +391,10 @@

    Summary

  • Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -413,6 +423,6 @@

    Summary

    - Fork me on GitHub + Fork me on GitHub diff --git a/docs/filesystem.html b/docs/filesystem.html index e4f345bcfb..4400998f03 100644 --- a/docs/filesystem.html +++ b/docs/filesystem.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Compiler Services: Virtualized File System

    +

    Compiler Services: Virtualized File System

    The FSharp.Compiler.Service component has a global variable representing the file system. By setting this variable you can host the compiler in situations where a file system is not available.

    @@ -120,82 +119,82 @@

    75: 76: -
    #r "FSharp.Compiler.Service.dll"
-open System
-open System.IO
-open System.Collections.Generic
-open System.Text
-open FSharp.Compiler.AbstractIL.Internal.Library
+
    #r "FSharp.Compiler.Service.dll"
+open System
+open System.IO
+open System.Collections.Generic
+open System.Text
+open FSharp.Compiler.AbstractIL.Internal.Library
 
-let defaultFileSystem = Shim.FileSystem
+let defaultFileSystem = Shim.FileSystem
 
-let fileName1 = @"c:\mycode\test1.fs" // note, the path doesn't exist
-let fileName2 = @"c:\mycode\test2.fs" // note, the path doesn't exist
+let fileName1 = @"c:\mycode\test1.fs" // note, the path doesn't exist
+let fileName2 = @"c:\mycode\test2.fs" // note, the path doesn't exist
 
-type MyFileSystem() = 
-    let file1 = """
+type MyFileSystem() = 
+    let file1 = """
 module File1
 
 let A = 1"""
-    let file2 = """
+    let file2 = """
 module File2
 let B = File1.A + File1.A"""
-    let files = dict [(fileName1, file1); (fileName2, file2)]
+    let files = dict [(fileName1, file1); (fileName2, file2)]
 
-    interface IFileSystem with
+    interface IFileSystem with
         // Implement the service to open files for reading and writing
-        member __.FileStreamReadShim(fileName) = 
-            match files.TryGetValue(fileName) with
-            | true, text -> new MemoryStream(Encoding.UTF8.GetBytes(text)) :> Stream
-            | _ -> defaultFileSystem.FileStreamReadShim(fileName)
+        member __.FileStreamReadShim(fileName) = 
+            match files.TryGetValue fileName with
+            | true, text -> new MemoryStream(Encoding.UTF8.GetBytes(text)) :> Stream
+            | _ -> defaultFileSystem.FileStreamReadShim(fileName)
 
-        member __.FileStreamCreateShim(fileName) = 
-            defaultFileSystem.FileStreamCreateShim(fileName)
+        member __.FileStreamCreateShim(fileName) = 
+            defaultFileSystem.FileStreamCreateShim(fileName)
 
-        member __.FileStreamWriteExistingShim(fileName) = 
-            defaultFileSystem.FileStreamWriteExistingShim(fileName)
+        member __.FileStreamWriteExistingShim(fileName) = 
+            defaultFileSystem.FileStreamWriteExistingShim(fileName)
 
-        member __.ReadAllBytesShim(fileName) = 
-            match files.TryGetValue(fileName) with
-            | true, text -> Encoding.UTF8.GetBytes(text)
-            | _ -> defaultFileSystem.ReadAllBytesShim(fileName)
+        member __.ReadAllBytesShim(fileName) = 
+            match files.TryGetValue fileName with
+            | true, text -> Encoding.UTF8.GetBytes(text)
+            | _ -> defaultFileSystem.ReadAllBytesShim(fileName)
 
         // Implement the service related to temporary paths and file time stamps
-        member __.GetTempPathShim() = 
-            defaultFileSystem.GetTempPathShim()
+        member __.GetTempPathShim() = 
+            defaultFileSystem.GetTempPathShim()
 
-        member __.GetLastWriteTimeShim(fileName) = 
-            defaultFileSystem.GetLastWriteTimeShim(fileName)
+        member __.GetLastWriteTimeShim(fileName) = 
+            defaultFileSystem.GetLastWriteTimeShim(fileName)
 
-        member __.GetFullPathShim(fileName) = 
-            defaultFileSystem.GetFullPathShim(fileName)
+        member __.GetFullPathShim(fileName) = 
+            defaultFileSystem.GetFullPathShim(fileName)
 
-        member __.IsInvalidPathShim(fileName) = 
-            defaultFileSystem.IsInvalidPathShim(fileName)
+        member __.IsInvalidPathShim(fileName) = 
+            defaultFileSystem.IsInvalidPathShim(fileName)
 
-        member __.IsPathRootedShim(fileName) = 
-            defaultFileSystem.IsPathRootedShim(fileName)
+        member __.IsPathRootedShim(fileName) = 
+            defaultFileSystem.IsPathRootedShim(fileName)
 
-        member __.IsStableFileHeuristic(fileName) = 
-            defaultFileSystem.IsStableFileHeuristic(fileName)
+        member __.IsStableFileHeuristic(fileName) = 
+            defaultFileSystem.IsStableFileHeuristic(fileName)
 
         // Implement the service related to file existence and deletion
-        member __.SafeExists(fileName) = 
-            files.ContainsKey(fileName) || defaultFileSystem.SafeExists(fileName)
+        member __.SafeExists(fileName) = 
+            files.ContainsKey(fileName) || defaultFileSystem.SafeExists(fileName)
 
-        member __.FileDelete(fileName) = 
-            defaultFileSystem.FileDelete(fileName)
+        member __.FileDelete(fileName) = 
+            defaultFileSystem.FileDelete(fileName)
 
         // Implement the service related to assembly loading, used to load type providers
         // and for F# interactive.
-        member __.AssemblyLoadFrom(fileName) = 
-            defaultFileSystem.AssemblyLoadFrom fileName
+        member __.AssemblyLoadFrom(fileName) = 
+            defaultFileSystem.AssemblyLoadFrom fileName
 
-        member __.AssemblyLoad(assemblyName) = 
-            defaultFileSystem.AssemblyLoad assemblyName 
+        member __.AssemblyLoad(assemblyName) = 
+            defaultFileSystem.AssemblyLoad assemblyName 
 
-let myFileSystem = MyFileSystem()
-Shim.FileSystem <- MyFileSystem() 
+let myFileSystem = MyFileSystem()
+Shim.FileSystem <- MyFileSystem() 
 
    
 
 
@@ -260,65 +259,65 @@ 
    58: 
 59:
    -
    open FSharp.Compiler.SourceCodeServices
+
    open FSharp.Compiler.SourceCodeServices
 
-let checker = FSharpChecker.Create()
+let checker = FSharpChecker.Create()
 
-let projectOptions = 
-    let sysLib nm = 
-        if System.Environment.OSVersion.Platform = System.PlatformID.Win32NT then // file references only valid on Windows 
-            System.Environment.GetFolderPath(System.Environment.SpecialFolder.ProgramFilesX86) +
-            @"\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\" + nm + ".dll"
+let projectOptions = 
+    let sysLib nm = 
+        if System.Environment.OSVersion.Platform = System.PlatformID.Win32NT then // file references only valid on Windows 
+            System.Environment.GetFolderPath(System.Environment.SpecialFolder.ProgramFilesX86) +
+            @"\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\" + nm + ".dll"
         else
-            let sysDir = System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory()
-            let (++) a b = System.IO.Path.Combine(a,b)
-            sysDir ++ nm + ".dll" 
+            let sysDir = System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory()
+            let (++) a b = System.IO.Path.Combine(a,b)
+            sysDir ++ nm + ".dll" 
 
-    let fsCore4300() = 
-        if System.Environment.OSVersion.Platform = System.PlatformID.Win32NT then // file references only valid on Windows 
-            System.Environment.GetFolderPath(System.Environment.SpecialFolder.ProgramFilesX86) +
+    let fsCore4300() = 
+        if System.Environment.OSVersion.Platform = System.PlatformID.Win32NT then // file references only valid on Windows 
+            System.Environment.GetFolderPath(System.Environment.SpecialFolder.ProgramFilesX86) +
             @"\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.0.0\FSharp.Core.dll"  
         else 
-            sysLib "FSharp.Core"
-
-    let allFlags = 
-        [| yield "--simpleresolution"; 
-           yield "--noframework"; 
-           yield "--debug:full"; 
-           yield "--define:DEBUG"; 
-           yield "--optimize-"; 
-           yield "--doc:test.xml"; 
-           yield "--warn:3"; 
-           yield "--fullpaths"; 
-           yield "--flaterrors"; 
-           yield "--target:library"; 
-           let references =
-             [ sysLib "mscorlib" 
-               sysLib "System"
-               sysLib "System.Core"
-               fsCore4300() ]
-           for r in references do 
-                 yield "-r:" + r |]
+            sysLib "FSharp.Core"
+
+    let allFlags = 
+        [| yield "--simpleresolution"; 
+           yield "--noframework"; 
+           yield "--debug:full"; 
+           yield "--define:DEBUG"; 
+           yield "--optimize-"; 
+           yield "--doc:test.xml"; 
+           yield "--warn:3"; 
+           yield "--fullpaths"; 
+           yield "--flaterrors"; 
+           yield "--target:library"; 
+           let references =
+             [ sysLib "mscorlib" 
+               sysLib "System"
+               sysLib "System.Core"
+               fsCore4300() ]
+           for r in references do 
+                 yield "-r:" + r |]
  
-    { ProjectFileName = @"c:\mycode\compilation.fsproj" // Make a name that is unique in this directory.
-      ProjectId = None
-      SourceFiles = [| fileName1; fileName2 |]
-      OriginalLoadReferences = []
-      ExtraProjectInfo=None
-      Stamp = None
-      OtherOptions = allFlags 
-      ReferencedProjects = [| |]
-      IsIncompleteTypeCheckEnvironment = false
-      UseScriptResolutionRules = true 
-      LoadTime = System.DateTime.Now // Note using 'Now' forces reloading
-      UnresolvedReferences = None }
-
-let results = checker.ParseAndCheckProject(projectOptions) |> Async.RunSynchronously
-
-results.Errors
-results.AssemblySignature.Entities.Count //2
-results.AssemblySignature.Entities.[0].MembersFunctionsAndValues.Count //1
-results.AssemblySignature.Entities.[0].MembersFunctionsAndValues.[0].DisplayName // "B"
+    { ProjectFileName = @"c:\mycode\compilation.fsproj" // Make a name that is unique in this directory.
+      ProjectId = None
+      SourceFiles = [| fileName1; fileName2 |]
+      OriginalLoadReferences = []
+      ExtraProjectInfo=None
+      Stamp = None
+      OtherOptions = allFlags 
+      ReferencedProjects = [| |]
+      IsIncompleteTypeCheckEnvironment = false
+      UseScriptResolutionRules = true 
+      LoadTime = System.DateTime.Now // Note using 'Now' forces reloading
+      UnresolvedReferences = None }
+
+let results = checker.ParseAndCheckProject(projectOptions) |> Async.RunSynchronously
+
+results.Errors
+results.AssemblySignature.Entities.Count //2
+results.AssemblySignature.Entities.[0].MembersFunctionsAndValues.Count //1
+results.AssemblySignature.Entities.[0].MembersFunctionsAndValues.[0].DisplayName // "B"
 
    
 
 
@@ -355,83 +354,82 @@ 
    Summary
    
 
    namespace FSharp.Compiler.AbstractIL
    
 
    namespace FSharp.Compiler.AbstractIL.Internal
    
 
    module Library

    from FSharp.Compiler.AbstractIL.Internal
    
-
    val defaultFileSystem : obj

    Full name: Filesystem.defaultFileSystem
    
-
    val fileName1 : string

    Full name: Filesystem.fileName1
    
-
    val fileName2 : string

    Full name: Filesystem.fileName2
    
-
    Multiple items
    type MyFileSystem =
      interface obj
      new : unit -> MyFileSystem
      override AssemblyLoad : assemblyName:'a -> 'b
      override AssemblyLoadFrom : fileName:'c -> 'd
      override FileDelete : fileName:'e -> 'f
      override FileStreamCreateShim : fileName:'a1 -> 'a2
      override FileStreamReadShim : fileName:obj -> Stream
      override FileStreamWriteExistingShim : fileName:'s -> 't
      override GetFullPathShim : fileName:'m -> 'n
      override GetLastWriteTimeShim : fileName:'o -> 'p
      ...

    Full name: Filesystem.MyFileSystem

    --------------------
    new : unit -> MyFileSystem
    
-
    val file1 : string
    
-
    val file2 : string
    
-
    val files : IDictionary<obj,obj>
    
-
    val dict : keyValuePairs:seq<'Key * 'Value> -> IDictionary<'Key,'Value> (requires equality)

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.dict
    
-
    override MyFileSystem.FileStreamReadShim : fileName:obj -> Stream

    Full name: Filesystem.MyFileSystem.FileStreamReadShim
    
-
    val fileName : obj
    
-
    IDictionary.TryGetValue(key: obj, value: byref<obj>) : bool
    
-
    val text : obj
    
-
    Multiple items
    type MemoryStream =
      inherit Stream
      new : unit -> MemoryStream + 6 overloads
      member CanRead : bool
      member CanSeek : bool
      member CanWrite : bool
      member Capacity : int with get, set
      member Flush : unit -> unit
      member GetBuffer : unit -> byte[]
      member Length : int64
      member Position : int64 with get, set
      member Read : buffer:byte[] * offset:int * count:int -> int
      ...

    Full name: System.IO.MemoryStream

    --------------------
    MemoryStream() : unit
    MemoryStream(capacity: int) : unit
    MemoryStream(buffer: byte []) : unit
    MemoryStream(buffer: byte [], writable: bool) : unit
    MemoryStream(buffer: byte [], index: int, count: int) : unit
    MemoryStream(buffer: byte [], index: int, count: int, writable: bool) : unit
    MemoryStream(buffer: byte [], index: int, count: int, writable: bool, publiclyVisible: bool) : unit
    
-
    type Encoding =
      member BodyName : string
      member Clone : unit -> obj
      member CodePage : int
      member DecoderFallback : DecoderFallback with get, set
      member EncoderFallback : EncoderFallback with get, set
      member EncodingName : string
      member Equals : value:obj -> bool
      member GetByteCount : chars:char[] -> int + 3 overloads
      member GetBytes : chars:char[] -> byte[] + 5 overloads
      member GetCharCount : bytes:byte[] -> int + 2 overloads
      ...

    Full name: System.Text.Encoding
    
-
    property Encoding.UTF8: Encoding
    
-
    Encoding.GetBytes(s: string) : byte []
    Encoding.GetBytes(chars: char []) : byte []
    Encoding.GetBytes(chars: char [], index: int, count: int) : byte []
    Encoding.GetBytes(chars: nativeptr<char>, charCount: int, bytes: nativeptr<byte>, byteCount: int) : int
    Encoding.GetBytes(s: string, charIndex: int, charCount: int, bytes: byte [], byteIndex: int) : int
    Encoding.GetBytes(chars: char [], charIndex: int, charCount: int, bytes: byte [], byteIndex: int) : int
    
-
    type Stream =
      inherit MarshalByRefObject
      member BeginRead : buffer:byte[] * offset:int * count:int * callback:AsyncCallback * state:obj -> IAsyncResult
      member BeginWrite : buffer:byte[] * offset:int * count:int * callback:AsyncCallback * state:obj -> IAsyncResult
      member CanRead : bool
      member CanSeek : bool
      member CanTimeout : bool
      member CanWrite : bool
      member Close : unit -> unit
      member CopyTo : destination:Stream -> unit + 1 overload
      member Dispose : unit -> unit
      member EndRead : asyncResult:IAsyncResult -> int
      ...

    Full name: System.IO.Stream
    
-
    val __ : MyFileSystem
    
-
    override MyFileSystem.FileStreamCreateShim : fileName:'a1 -> 'a2

    Full name: Filesystem.MyFileSystem.FileStreamCreateShim
    
-
    val fileName : 'a1
    
-
    override MyFileSystem.FileStreamWriteExistingShim : fileName:'s -> 't

    Full name: Filesystem.MyFileSystem.FileStreamWriteExistingShim
    
-
    val fileName : 's
    
-
    override MyFileSystem.ReadAllBytesShim : fileName:obj -> 'r

    Full name: Filesystem.MyFileSystem.ReadAllBytesShim
    
-
    override MyFileSystem.GetTempPathShim : unit -> 'q

    Full name: Filesystem.MyFileSystem.GetTempPathShim
    
-
    override MyFileSystem.GetLastWriteTimeShim : fileName:'o -> 'p

    Full name: Filesystem.MyFileSystem.GetLastWriteTimeShim
    
-
    val fileName : 'o
    
-
    override MyFileSystem.GetFullPathShim : fileName:'m -> 'n

    Full name: Filesystem.MyFileSystem.GetFullPathShim
    
-
    val fileName : 'm
    
-
    override MyFileSystem.IsInvalidPathShim : fileName:'k -> 'l

    Full name: Filesystem.MyFileSystem.IsInvalidPathShim
    
-
    val fileName : 'k
    
-
    override MyFileSystem.IsPathRootedShim : fileName:'i -> 'j

    Full name: Filesystem.MyFileSystem.IsPathRootedShim
    
-
    val fileName : 'i
    
-
    override MyFileSystem.IsStableFileHeuristic : fileName:'g -> 'h

    Full name: Filesystem.MyFileSystem.IsStableFileHeuristic
    
-
    val fileName : 'g
    
-
    override MyFileSystem.SafeExists : fileName:obj -> bool

    Full name: Filesystem.MyFileSystem.SafeExists
    
-
    IDictionary.ContainsKey(key: obj) : bool
    
-
    override MyFileSystem.FileDelete : fileName:'e -> 'f

    Full name: Filesystem.MyFileSystem.FileDelete
    
-
    val fileName : 'e
    
-
    override MyFileSystem.AssemblyLoadFrom : fileName:'c -> 'd

    Full name: Filesystem.MyFileSystem.AssemblyLoadFrom
    
-
    val fileName : 'c
    
-
    override MyFileSystem.AssemblyLoad : assemblyName:'a -> 'b

    Full name: Filesystem.MyFileSystem.AssemblyLoad
    
-
    val assemblyName : 'a
    
-
    val myFileSystem : MyFileSystem

    Full name: Filesystem.myFileSystem
    
-
    namespace FSharp.Compiler.SourceCodeServices
    
-
    val checker : FSharpChecker

    Full name: Filesystem.checker
    
-
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    
-
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    
-
    val projectOptions : FSharpProjectOptions

    Full name: Filesystem.projectOptions
    
-
    val sysLib : (string -> string)
    
-
    val nm : string
    
-
    type Environment =
      static member CommandLine : string
      static member CurrentDirectory : string with get, set
      static member Exit : exitCode:int -> unit
      static member ExitCode : int with get, set
      static member ExpandEnvironmentVariables : name:string -> string
      static member FailFast : message:string -> unit + 1 overload
      static member GetCommandLineArgs : unit -> string[]
      static member GetEnvironmentVariable : variable:string -> string + 1 overload
      static member GetEnvironmentVariables : unit -> IDictionary + 1 overload
      static member GetFolderPath : folder:SpecialFolder -> string + 1 overload
      ...
      nested type SpecialFolder
      nested type SpecialFolderOption

    Full name: System.Environment
    
-
    property Environment.OSVersion: OperatingSystem
    
-
    property OperatingSystem.Platform: PlatformID
    
-
    type PlatformID =
      | Win32S = 0
      | Win32Windows = 1
      | Win32NT = 2
      | WinCE = 3
      | Unix = 4
      | Xbox = 5
      | MacOSX = 6

    Full name: System.PlatformID
    
-
    field PlatformID.Win32NT = 2
    
-
    Environment.GetFolderPath(folder: Environment.SpecialFolder) : string
    Environment.GetFolderPath(folder: Environment.SpecialFolder, option: Environment.SpecialFolderOption) : string
    
-
    type SpecialFolder =
      | ApplicationData = 26
      | CommonApplicationData = 35
      | LocalApplicationData = 28
      | Cookies = 33
      | Desktop = 0
      | Favorites = 6
      | History = 34
      | InternetCache = 32
      | Programs = 2
      | MyComputer = 17
      ...

    Full name: System.Environment.SpecialFolder
    
-
    field Environment.SpecialFolder.ProgramFilesX86 = 42
    
-
    val sysDir : string
    
-
    namespace System.Runtime
    
-
    namespace System.Runtime.InteropServices
    
-
    type RuntimeEnvironment =
      new : unit -> RuntimeEnvironment
      static member FromGlobalAccessCache : a:Assembly -> bool
      static member GetRuntimeDirectory : unit -> string
      static member GetRuntimeInterfaceAsIntPtr : clsid:Guid * riid:Guid -> nativeint
      static member GetRuntimeInterfaceAsObject : clsid:Guid * riid:Guid -> obj
      static member GetSystemVersion : unit -> string
      static member SystemConfigurationFile : string

    Full name: System.Runtime.InteropServices.RuntimeEnvironment
    
-
    Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory() : string
    
-
    val a : string
    
-
    val b : string
    
-
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val InvalidPathChars : char[]
      static val PathSeparator : char
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string
      static member GetExtension : path:string -> string
      static member GetFileName : path:string -> string
      ...

    Full name: System.IO.Path
    
-
    Path.Combine([<ParamArray>] paths: string []) : string
    Path.Combine(path1: string, path2: string) : string
    Path.Combine(path1: string, path2: string, path3: string) : string
    Path.Combine(path1: string, path2: string, path3: string, path4: string) : string
    
-
    val fsCore4300 : (unit -> string)
    
-
    val allFlags : string []
    
-
    val references : string list
    
-
    union case Option.None: Option<'T>
    
-
    Multiple items
    type DateTime =
      struct
        new : ticks:int64 -> DateTime + 10 overloads
        member Add : value:TimeSpan -> DateTime
        member AddDays : value:float -> DateTime
        member AddHours : value:float -> DateTime
        member AddMilliseconds : value:float -> DateTime
        member AddMinutes : value:float -> DateTime
        member AddMonths : months:int -> DateTime
        member AddSeconds : value:float -> DateTime
        member AddTicks : value:int64 -> DateTime
        member AddYears : value:int -> DateTime
        ...
      end

    Full name: System.DateTime

    --------------------
    DateTime()
       (+0 other overloads)
    DateTime(ticks: int64) : unit
       (+0 other overloads)
    DateTime(ticks: int64, kind: DateTimeKind) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) : unit
       (+0 other overloads)
    
-
    property DateTime.Now: DateTime
    
-
    val results : obj

    Full name: Filesystem.results
    
-
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    
-
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    
-
    
+
    val defaultFileSystem : IFileSystem
    
+
    module Shim

    from FSharp.Compiler.AbstractIL.Internal.Library
    
+
    val mutable FileSystem : IFileSystem
    
+
    val fileName1 : string
    
+
    val fileName2 : string
    
+
    Multiple items
    type MyFileSystem =
      interface IFileSystem
      new : unit -> MyFileSystem

    --------------------
    new : unit -> MyFileSystem
    
+
    val file1 : string
    
+
    val file2 : string
    
+
    val files : IDictionary<string,string>
    
+
    val dict : keyValuePairs:seq<'Key * 'Value> -> IDictionary<'Key,'Value> (requires equality)
    
+
    type IFileSystem =
      interface
        abstract member AssemblyLoad : assemblyName:AssemblyName -> Assembly
        abstract member AssemblyLoadFrom : fileName:string -> Assembly
        abstract member FileDelete : fileName:string -> unit
        abstract member FileStreamCreateShim : fileName:string -> Stream
        abstract member FileStreamReadShim : fileName:string -> Stream
        abstract member FileStreamWriteExistingShim : fileName:string -> Stream
        abstract member GetFullPathShim : fileName:string -> string
        abstract member GetLastWriteTimeShim : fileName:string -> DateTime
        abstract member GetTempPathShim : unit -> string
        abstract member IsInvalidPathShim : filename:string -> bool
        ...
      end
    
+
    val fileName : string
    
+
    IDictionary.TryGetValue(key: string, value: byref<string>) : bool
    
+
    val text : string
    
+
    Multiple items
    type MemoryStream =
      inherit Stream
      new : unit -> MemoryStream + 6 overloads
      member CanRead : bool
      member CanSeek : bool
      member CanWrite : bool
      member Capacity : int with get, set
      member CopyTo : destination:Stream * bufferSize:int -> unit
      member CopyToAsync : destination:Stream * bufferSize:int * cancellationToken:CancellationToken -> Task
      member Flush : unit -> unit
      member FlushAsync : cancellationToken:CancellationToken -> Task
      member GetBuffer : unit -> byte[]
      ...

    --------------------
    MemoryStream() : MemoryStream
    MemoryStream(capacity: int) : MemoryStream
    MemoryStream(buffer: byte []) : MemoryStream
    MemoryStream(buffer: byte [], writable: bool) : MemoryStream
    MemoryStream(buffer: byte [], index: int, count: int) : MemoryStream
    MemoryStream(buffer: byte [], index: int, count: int, writable: bool) : MemoryStream
    MemoryStream(buffer: byte [], index: int, count: int, writable: bool, publiclyVisible: bool) : MemoryStream
    
+
    type Encoding =
      member BodyName : string
      member Clone : unit -> obj
      member CodePage : int
      member DecoderFallback : DecoderFallback with get, set
      member EncoderFallback : EncoderFallback with get, set
      member EncodingName : string
      member Equals : value:obj -> bool
      member GetByteCount : chars:char[] -> int + 5 overloads
      member GetBytes : chars:char[] -> byte[] + 7 overloads
      member GetCharCount : bytes:byte[] -> int + 3 overloads
      ...
    
+
    property Encoding.UTF8: Encoding with get
    
+
    Encoding.GetBytes(s: string) : byte []
    Encoding.GetBytes(chars: char []) : byte []
    Encoding.GetBytes(chars: ReadOnlySpan<char>, bytes: Span<byte>) : int
    Encoding.GetBytes(s: string, index: int, count: int) : byte []
    Encoding.GetBytes(chars: char [], index: int, count: int) : byte []
    Encoding.GetBytes(chars: nativeptr<char>, charCount: int, bytes: nativeptr<byte>, byteCount: int) : int
    Encoding.GetBytes(s: string, charIndex: int, charCount: int, bytes: byte [], byteIndex: int) : int
    Encoding.GetBytes(chars: char [], charIndex: int, charCount: int, bytes: byte [], byteIndex: int) : int
    
+
    type Stream =
      inherit MarshalByRefObject
      member BeginRead : buffer:byte[] * offset:int * count:int * callback:AsyncCallback * state:obj -> IAsyncResult
      member BeginWrite : buffer:byte[] * offset:int * count:int * callback:AsyncCallback * state:obj -> IAsyncResult
      member CanRead : bool
      member CanSeek : bool
      member CanTimeout : bool
      member CanWrite : bool
      member Close : unit -> unit
      member CopyTo : destination:Stream -> unit + 1 overload
      member CopyToAsync : destination:Stream -> Task + 3 overloads
      member Dispose : unit -> unit
      ...
    
+
    abstract member IFileSystem.FileStreamReadShim : fileName:string -> Stream
    
+
    val __ : MyFileSystem
    
+
    abstract member IFileSystem.FileStreamCreateShim : fileName:string -> Stream
    
+
    abstract member IFileSystem.FileStreamWriteExistingShim : fileName:string -> Stream
    
+
    abstract member IFileSystem.ReadAllBytesShim : fileName:string -> byte []
    
+
    abstract member IFileSystem.GetTempPathShim : unit -> string
    
+
    abstract member IFileSystem.GetLastWriteTimeShim : fileName:string -> DateTime
    
+
    abstract member IFileSystem.GetFullPathShim : fileName:string -> string
    
+
    abstract member IFileSystem.IsInvalidPathShim : filename:string -> bool
    
+
    abstract member IFileSystem.IsPathRootedShim : path:string -> bool
    
+
    abstract member IFileSystem.IsStableFileHeuristic : fileName:string -> bool
    
+
    IDictionary.ContainsKey(key: string) : bool
    
+
    abstract member IFileSystem.SafeExists : fileName:string -> bool
    
+
    abstract member IFileSystem.FileDelete : fileName:string -> unit
    
+
    abstract member IFileSystem.AssemblyLoadFrom : fileName:string -> Reflection.Assembly
    
+
    val assemblyName : Reflection.AssemblyName
    
+
    abstract member IFileSystem.AssemblyLoad : assemblyName:Reflection.AssemblyName -> Reflection.Assembly
    
+
    val myFileSystem : MyFileSystem
    
+
    namespace FSharp.Compiler.SourceCodeServices
    
+
    val checker : FSharpChecker
    
+
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    
+
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    
+
    val projectOptions : FSharpProjectOptions
    
+
    val sysLib : (string -> string)
    
+
    val nm : string
    
+
    type Environment =
      static member CommandLine : string
      static member CurrentDirectory : string with get, set
      static member CurrentManagedThreadId : int
      static member Exit : exitCode:int -> unit
      static member ExitCode : int with get, set
      static member ExpandEnvironmentVariables : name:string -> string
      static member FailFast : message:string -> unit + 1 overload
      static member GetCommandLineArgs : unit -> string[]
      static member GetEnvironmentVariable : variable:string -> string + 1 overload
      static member GetEnvironmentVariables : unit -> IDictionary + 1 overload
      ...
      nested type SpecialFolder
      nested type SpecialFolderOption
    
+
    property Environment.OSVersion: OperatingSystem with get
    
+
    property OperatingSystem.Platform: PlatformID with get
    
+
    type PlatformID =
      | Win32S = 0
      | Win32Windows = 1
      | Win32NT = 2
      | WinCE = 3
      | Unix = 4
      | Xbox = 5
      | MacOSX = 6
    
+
    field PlatformID.Win32NT: PlatformID = 2
    
+
    Environment.GetFolderPath(folder: Environment.SpecialFolder) : string
    Environment.GetFolderPath(folder: Environment.SpecialFolder, option: Environment.SpecialFolderOption) : string
    
+
    type SpecialFolder =
      | ApplicationData = 26
      | CommonApplicationData = 35
      | LocalApplicationData = 28
      | Cookies = 33
      | Desktop = 0
      | Favorites = 6
      | History = 34
      | InternetCache = 32
      | Programs = 2
      | MyComputer = 17
      ...
    
+
    field Environment.SpecialFolder.ProgramFilesX86: Environment.SpecialFolder = 42
    
+
    val sysDir : string
    
+
    namespace System.Runtime
    
+
    namespace System.Runtime.InteropServices
    
+
    type RuntimeEnvironment =
      static member FromGlobalAccessCache : a:Assembly -> bool
      static member GetRuntimeDirectory : unit -> string
      static member GetRuntimeInterfaceAsIntPtr : clsid:Guid * riid:Guid -> nativeint
      static member GetRuntimeInterfaceAsObject : clsid:Guid * riid:Guid -> obj
      static member GetSystemVersion : unit -> string
      static member SystemConfigurationFile : string
    
+
    Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory() : string
    
+
    val a : string
    
+
    val b : string
    
+
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val PathSeparator : char
      static val InvalidPathChars : char[]
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string + 1 overload
      static member GetExtension : path:string -> string + 1 overload
      static member GetFileName : path:string -> string + 1 overload
      ...
    
+
    Path.Combine([<ParamArray>] paths: string []) : string
    Path.Combine(path1: string, path2: string) : string
    Path.Combine(path1: string, path2: string, path3: string) : string
    Path.Combine(path1: string, path2: string, path3: string, path4: string) : string
    
+
    val fsCore4300 : (unit -> string)
    
+
    val allFlags : string []
    
+
    val references : string list
    
+
    val r : string
    
+
    union case Option.None: Option<'T>
    
+
    Multiple items
    type DateTime =
      struct
        new : ticks:int64 -> DateTime + 10 overloads
        member Add : value:TimeSpan -> DateTime
        member AddDays : value:float -> DateTime
        member AddHours : value:float -> DateTime
        member AddMilliseconds : value:float -> DateTime
        member AddMinutes : value:float -> DateTime
        member AddMonths : months:int -> DateTime
        member AddSeconds : value:float -> DateTime
        member AddTicks : value:int64 -> DateTime
        member AddYears : value:int -> DateTime
        ...
      end

    --------------------
    DateTime ()
       (+0 other overloads)
    DateTime(ticks: int64) : DateTime
       (+0 other overloads)
    DateTime(ticks: int64, kind: DateTimeKind) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) : DateTime
       (+0 other overloads)
    
+
    property DateTime.Now: DateTime with get
    
+
    val results : FSharpCheckProjectResults
    
+
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    
+
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    
+
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    
+
    property FSharpCheckProjectResults.Errors: FSharpErrorInfo [] with get
    
+
    property FSharpCheckProjectResults.AssemblySignature: FSharpAssemblySignature with get
    
+
    property FSharpAssemblySignature.Entities: IList<FSharpEntity> with get
    
+
    property ICollection.Count: int with get

    @@ -447,10 +445,10 @@

    Summary

  • Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -479,6 +477,6 @@

    Summary

    - Fork me on GitHub + Fork me on GitHub diff --git a/docs/index.html b/docs/index.html index 14bb720ea3..cbbd6ae863 100644 --- a/docs/index.html +++ b/docs/index.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    F# Compiler Services

    +

    F# Compiler Services

    The F# compiler services package is a component derived from the F# compiler source code that exposes additional functionality for implementing F# language bindings, additional tools based on the compiler or refactoring tools. The package also includes F# @@ -97,21 +96,21 @@

    Avail

    Projects using the F# Compiler Services

    Some of the projects using the F# Compiler Services are:

    Contributing and copyright

    @@ -136,10 +135,10 @@

    Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -168,6 +167,6 @@

    Fork me on GitHub + Fork me on GitHub diff --git a/docs/interactive.html b/docs/interactive.html index ccf4bdb1a4..782e59cc87 100644 --- a/docs/interactive.html +++ b/docs/interactive.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Interactive Service: Embedding F# Interactive

    +

    Interactive Service: Embedding F# Interactive

    This tutorial demonstrates how to embed F# interactive in your application. F# interactive is an interactive scripting environment that compiles F# code into highly efficient IL code and executes it on the fly. The F# interactive service allows you to embed F# evaluation in @@ -60,9 +59,9 @@

    2: 3: -
    #r "FSharp.Compiler.Service.dll"
-open FSharp.Compiler.SourceCodeServices
-open FSharp.Compiler.Interactive.Shell
+
    #r "FSharp.Compiler.Service.dll"
+open FSharp.Compiler.SourceCodeServices
+open FSharp.Compiler.Interactive.Shell
 
    
 
 
@@ -87,23 +86,23 @@ 
    16: 
 17:
    -
    open System
-open System.IO
-open System.Text
+
    open System
+open System.IO
+open System.Text
 
-// Intialize output and input streams
-let sbOut = new StringBuilder()
-let sbErr = new StringBuilder()
-let inStream = new StringReader("")
-let outStream = new StringWriter(sbOut)
-let errStream = new StringWriter(sbErr)
+// Initialize output and input streams
+let sbOut = new StringBuilder()
+let sbErr = new StringBuilder()
+let inStream = new StringReader("")
+let outStream = new StringWriter(sbOut)
+let errStream = new StringWriter(sbErr)
 
 // Build command line arguments & start FSI session
-let argv = [| "C:\\fsi.exe" |]
-let allArgs = Array.append argv [|"--noninteractive"|]
+let argv = [| "C:\\fsi.exe" |]
+let allArgs = Array.append argv [|"--noninteractive"|]
 
-let fsiConfig = FsiEvaluationSession.GetDefaultConfiguration()
-let fsiSession = FsiEvaluationSession.Create(fsiConfig, allArgs, inStream, outStream, errStream)  
+let fsiConfig = FsiEvaluationSession.GetDefaultConfiguration()
+let fsiSession = FsiEvaluationSession.Create(fsiConfig, allArgs, inStream, outStream, errStream)
 
    
 
 
@@ -118,17 +117,17 @@ 
    5: 
 
    /// Evaluate expression & return the result
-let evalExpression text =
-  match fsiSession.EvalExpression(text) with
-  | Some value -> printfn "%A" value.ReflectionValue
-  | None -> printfn "Got no result!"
+let evalExpression text =
+  match fsiSession.EvalExpression(text) with
+  | Some value -> printfn "%A" value.ReflectionValue
+  | None -> printfn "Got no result!"

    This takes a string as an argument and evaluates (i.e. executes) it as F# code.

    -
    1: 
 
    evalExpression "42+1" // prints '43'
+
    evalExpression "42+1" // prints '43'
    @@ -142,12 +141,12 @@

    7: 
    /// Evaluate expression & return the result, strongly typed
-let evalExpressionTyped<'T> (text) = 
-    match fsiSession.EvalExpression(text) with
-    | Some value -> value.ReflectionValue |> unbox<'T>
-    | None -> failwith "Got no result!"
+let evalExpressionTyped<'T> (text) =
+    match fsiSession.EvalExpression(text) with
+    | Some value -> value.ReflectionValue |> unbox<'T>
+    | None -> failwith "Got no result!"
 
-evalExpressionTyped<int> "42+1"  // gives '43'
+evalExpressionTyped<int> "42+1"  // gives '43'
    @@ -158,7 +157,7 @@ 

    1:
    -
    fsiSession.EvalInteraction "printfn \"bye\""
+
    fsiSession.EvalInteraction "printfn \"bye\""
 
    
 
 
@@ -166,8 +165,8 @@ 
    1: 
 2: 
 
    
-
    File.WriteAllText("sample.fsx", "let twenty = 10 + 10")
-fsiSession.EvalScript "sample.fsx"
+
    File.WriteAllText("sample.fsx", "let twenty = 10 + 10")
+fsiSession.EvalScript "sample.fsx"
 
    
 
 
@@ -180,7 +179,7 @@ 
    Catching er
 result and an exception.
    
 
    The result part of EvalExpression and EvalExpressionNonThrowing is an optional FSharpValue.
 If that value is not present then it just indicates that the expression didn't have a tangible
-result that could be represented as a .NET object.  This siutation shouldn't actually
+result that could be represented as a .NET object.  This situation shouldn't actually
 occur for any normal input expressions, and only for primitives used in libraries.
    
 
-
    1: 
 2: 
@@ -190,20 +189,20 @@ 
    Catching er
 6: 
 7: 
 
    File.WriteAllText("sample.fsx", "let twenty = 'a' + 10.0")
-let result, warnings = fsiSession.EvalScriptNonThrowing "sample.fsx"
+
    File.WriteAllText("sample.fsx", "let twenty = 'a' + 10.0")
+let result, warnings = fsiSession.EvalScriptNonThrowing "sample.fsx"
 
 // show the result
-match result with 
-| Choice1Of2 () -> printfn "checked and executed ok"
-| Choice2Of2 exn -> printfn "execution exception: %s" exn.Message
+match result with
+| Choice1Of2 () -> printfn "checked and executed ok"
+| Choice2Of2 exn -> printfn "execution exception: %s" exn.Message
 
    		
 
    
 
    
 
    Gives:
    
 
-
    1: 
 
    execution exception: Operation could not be completed due to earlier error
+
    execution exception: Operation could not be completed due to earlier error
 
    		
 
    
 
    
@@ -212,8 +211,8 @@ 
    Catching er
 3: 
 
    
 
    // show the errors and warnings
-for w in warnings do 
-   printfn "Warning %s at %d,%d" w.Message w.StartLineAlternate w.StartColumn 
+for w in warnings do
+   printfn "Warning %s at %d,%d" w.Message w.StartLineAlternate w.StartColumn
 
    
 
 
@@ -221,8 +220,8 @@ 
    Catching er
 
-
    1: 
 2: 
 
    Warning The type 'float' does not match the type 'char' at 1,19
-Warning The type 'float' does not match the type 'char' at 1,17
+
    Warning The type 'float' does not match the type 'char' at 1,19
+Warning The type 'float' does not match the type 'char' at 1,17
 
    		
 
    
 
    
@@ -238,16 +237,16 @@ 
    Catching er
  9: 
 10:
    -
    let evalExpressionTyped2<'T> text =
-   let res, warnings = fsiSession.EvalExpressionNonThrowing(text)
-   for w in warnings do 
-       printfn "Warning %s at %d,%d" w.Message w.StartLineAlternate w.StartColumn 
-   match res with 
-   | Choice1Of2 (Some value) -> value.ReflectionValue |> unbox<'T>
-   | Choice1Of2 None -> failwith "null or no result"
-   | Choice2Of2 (exn:exn) -> failwith (sprintf "exception %s" exn.Message)
+
    let evalExpressionTyped2<'T> text =
+   let res, warnings = fsiSession.EvalExpressionNonThrowing(text)
+   for w in warnings do
+       printfn "Warning %s at %d,%d" w.Message w.StartLineAlternate w.StartColumn
+   match res with
+   | Choice1Of2 (Some value) -> value.ReflectionValue |> unbox<'T>
+   | Choice1Of2 None -> failwith "null or no result"
+   | Choice2Of2 (exn:exn) -> failwith (sprintf "exception %s" exn.Message)
 
-evalExpressionTyped2<int> "42+1"  // gives '43'
+evalExpressionTyped2<int> "42+1"  // gives '43'
 
    
 
 
@@ -267,19 +266,19 @@ 
    12: 
 13:
    -
    open System.Threading.Tasks
+
    open System.Threading.Tasks
 
-let sampleLongRunningExpr = 
+let sampleLongRunningExpr =
     """
-async { 
+async {
     // The code of what you want to run
     do System.Threading.Thread.Sleep 5000
-    return 10 
+    return 10
 }
   |> Async.StartAsTask"""
 
-let task1 = evalExpressionTyped<Task<int>>(sampleLongRunningExpr)  
-let task2 = evalExpressionTyped<Task<int>>(sampleLongRunningExpr)  
+let task1 = evalExpressionTyped<Task<int>>(sampleLongRunningExpr)
+let task2 = evalExpressionTyped<Task<int>>(sampleLongRunningExpr)
 
    
 
 
@@ -287,8 +286,8 @@ 
    1: 
 2: 
 
    
-
    task1.Result // gives the result after completion (up to 5 seconds)
-task2.Result // gives the result after completion (up to 5 seconds)
+
    task1.Result // gives the result after completion (up to 5 seconds)
+task2.Result // gives the result after completion (up to 5 seconds)
 
    
 
 
@@ -298,7 +297,7 @@ 
    1: 
 
    
-
    fsiSession.EvalInteraction "let xxx = 1 + 1"
+
    fsiSession.EvalInteraction "let xxx = 1 + 1"
 
    
 
 
@@ -307,9 +306,9 @@ 
    2: 
 3: 
 
    
-
    let parseResults, checkResults, checkProjectResults = 
-    fsiSession.ParseAndCheckInteraction("xxx + xx")
-    |> Async.RunSynchronously
+
    let parseResults, checkResults, checkProjectResults =
+    fsiSession.ParseAndCheckInteraction("xxx + xx")
+    |> Async.RunSynchronously
 
    
 
 
@@ -317,7 +316,7 @@ 
    Editor. You can, for example, look at the type errors in the code:
    
 
-
    1: 
 
    checkResults.Errors.Length // 1
+
    checkResults.Errors.Length // 1
 
    		
 
    
 
    
@@ -330,24 +329,22 @@ 
    4: 
 5: 
 6: 
-7: 
 
    
-
    open FSharp.Compiler
+
    open FSharp.Compiler
 
 // get a tooltip
-checkResults.GetToolTipText(1, 2, "xxx + xx", ["xxx"], FSharpTokenTag.IDENT) 
+checkResults.GetToolTipText(1, 2, "xxx + xx", ["xxx"], FSharpTokenTag.IDENT)
 
-checkResults.GetSymbolUseAtLocation(1, 2, "xxx + xx", ["xxx"]) // symbol xxx
-  
+checkResults.GetSymbolUseAtLocation(1, 2, "xxx + xx", ["xxx"]) // symbol xxx
 
    
 
 
 
    The 'fsi' object
    
 
    If you want your scripting code to be able to access the 'fsi' object, you should pass in an implementation of this object explicitly.
-Normally the one fromm FSharp.Compiler.Interactive.Settings.dll is used.
    
+Normally the one from FSharp.Compiler.Interactive.Settings.dll is used.
    
 
-
    1: 
 
    let fsiConfig2 = FsiEvaluationSession.GetDefaultConfiguration(fsi)
+
    let fsiConfig2 = FsiEvaluationSession.GetDefaultConfiguration(fsiSession)
 
    		
 
    
 
    
@@ -356,7 +353,7 @@ 
    Restrictions on Collectible Assemblies.
    
+See also Restrictions on Collectible Assemblies.
    
 
    The example below shows the creation of 200 evaluation sessions. Note that collectible=true and
 use session = ... are both used.
    
 
    If collectible code is working correctly,
@@ -378,20 +375,20 @@ 
    15: 
 16: 
 
    
-
    let collectionTest() = 
+
    let collectionTest() =
+
+    for i in 1 .. 200 do
+        let defaultArgs = [|"fsi.exe";"--noninteractive";"--nologo";"--gui-"|]
+        use inStream = new StringReader("")
+        use outStream = new StringWriter()
+        use errStream = new StringWriter()
 
-    for i in 1 .. 200 do
-        let defaultArgs = [|"fsi.exe";"--noninteractive";"--nologo";"--gui-"|]
-        use inStream = new StringReader("")
-        use outStream = new StringWriter()
-        use errStream = new StringWriter()
+        let fsiConfig = FsiEvaluationSession.GetDefaultConfiguration()
+        use session = FsiEvaluationSession.Create(fsiConfig, defaultArgs, inStream, outStream, errStream, collectible=true)
 
-        let fsiConfig = FsiEvaluationSession.GetDefaultConfiguration()
-        use session = FsiEvaluationSession.Create(fsiConfig, defaultArgs, inStream, outStream, errStream, collectible=true)
-        
-        session.EvalInteraction (sprintf "type D = { v : int }")
-        let v = session.EvalExpression (sprintf "{ v = 42 * %d }" i)
-        printfn "iteration %d, result = %A" i v.Value.ReflectionValue
+        session.EvalInteraction (sprintf "type D = { v : int }")
+        let v = session.EvalExpression (sprintf "{ v = 42 * %d }" i)
+        printfn "iteration %d, result = %A" i v.Value.ReflectionValue
 
 // collectionTest()  <-- run the test like this
 
    
@@ -401,90 +398,88 @@ 
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    namespace FSharp.Compiler
    namespace FSharp.Compiler.SourceCodeServices
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>

    Full name: FSharp.Compiler.SourceCodeServices.FSharpAttribute
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>
    namespace FSharp.Compiler.Interactive
    module Shell

    from FSharp.Compiler.Interactive
    namespace System
    namespace System.IO
    namespace System.Text
    -
    val sbOut : StringBuilder

    Full name: Interactive.sbOut
    -
    Multiple items
    type StringBuilder =
      new : unit -> StringBuilder + 5 overloads
      member Append : value:string -> StringBuilder + 18 overloads
      member AppendFormat : format:string * arg0:obj -> StringBuilder + 4 overloads
      member AppendLine : unit -> StringBuilder + 1 overload
      member Capacity : int with get, set
      member Chars : int -> char with get, set
      member Clear : unit -> StringBuilder
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EnsureCapacity : capacity:int -> int
      member Equals : sb:StringBuilder -> bool
      ...

    Full name: System.Text.StringBuilder

    --------------------
    StringBuilder() : unit
    StringBuilder(capacity: int) : unit
    StringBuilder(value: string) : unit
    StringBuilder(value: string, capacity: int) : unit
    StringBuilder(capacity: int, maxCapacity: int) : unit
    StringBuilder(value: string, startIndex: int, length: int, capacity: int) : unit
    -
    val sbErr : StringBuilder

    Full name: Interactive.sbErr
    -
    val inStream : StringReader

    Full name: Interactive.inStream
    -
    Multiple items
    type StringReader =
      inherit TextReader
      new : s:string -> StringReader
      member Close : unit -> unit
      member Peek : unit -> int
      member Read : unit -> int + 1 overload
      member ReadLine : unit -> string
      member ReadToEnd : unit -> string

    Full name: System.IO.StringReader

    --------------------
    StringReader(s: string) : unit
    -
    val outStream : StringWriter

    Full name: Interactive.outStream
    -
    Multiple items
    type StringWriter =
      inherit TextWriter
      new : unit -> StringWriter + 3 overloads
      member Close : unit -> unit
      member Encoding : Encoding
      member GetStringBuilder : unit -> StringBuilder
      member ToString : unit -> string
      member Write : value:char -> unit + 2 overloads

    Full name: System.IO.StringWriter

    --------------------
    StringWriter() : unit
    StringWriter(formatProvider: IFormatProvider) : unit
    StringWriter(sb: StringBuilder) : unit
    StringWriter(sb: StringBuilder, formatProvider: IFormatProvider) : unit
    -
    val errStream : StringWriter

    Full name: Interactive.errStream
    -
    val argv : string []

    Full name: Interactive.argv
    -
    val allArgs : string []

    Full name: Interactive.allArgs
    -
    type Array =
      member Clone : unit -> obj
      member CopyTo : array:Array * index:int -> unit + 1 overload
      member GetEnumerator : unit -> IEnumerator
      member GetLength : dimension:int -> int
      member GetLongLength : dimension:int -> int64
      member GetLowerBound : dimension:int -> int
      member GetUpperBound : dimension:int -> int
      member GetValue : [<ParamArray>] indices:int[] -> obj + 7 overloads
      member Initialize : unit -> unit
      member IsFixedSize : bool
      ...

    Full name: System.Array
    -
    val append : array1:'T [] -> array2:'T [] -> 'T []

    Full name: Microsoft.FSharp.Collections.Array.append
    -
    val fsiConfig : FsiEvaluationSessionHostConfig

    Full name: Interactive.fsiConfig
    -
    type FsiEvaluationSession =
      interface IDisposable
      member EvalExpression : code:string -> FsiValue option
      member EvalExpressionNonThrowing : code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
      member EvalInteraction : code:string -> unit
      member EvalInteractionNonThrowing : code:string -> Choice<unit,exn> * FSharpErrorInfo []
      member EvalScript : filePath:string -> unit
      member EvalScriptNonThrowing : filePath:string -> Choice<unit,exn> * FSharpErrorInfo []
      member FormatValue : reflectionValue:obj * reflectionType:Type -> string
      member GetCompletions : longIdent:string -> seq<string>
      member Interrupt : unit -> unit
      ...

    Full name: FSharp.Compiler.Interactive.Shell.FsiEvaluationSession
    +
    val sbOut : StringBuilder
    +
    Multiple items
    type StringBuilder =
      new : unit -> StringBuilder + 5 overloads
      member Append : value:string -> StringBuilder + 22 overloads
      member AppendFormat : format:string * arg0:obj -> StringBuilder + 7 overloads
      member AppendJoin : separator:string * [<ParamArray>] values:obj[] -> StringBuilder + 5 overloads
      member AppendLine : unit -> StringBuilder + 1 overload
      member Capacity : int with get, set
      member Chars : int -> char with get, set
      member Clear : unit -> StringBuilder
      member CopyTo : sourceIndex:int * destination:Span<char> * count:int -> unit + 1 overload
      member EnsureCapacity : capacity:int -> int
      ...

    --------------------
    StringBuilder() : StringBuilder
    StringBuilder(capacity: int) : StringBuilder
    StringBuilder(value: string) : StringBuilder
    StringBuilder(value: string, capacity: int) : StringBuilder
    StringBuilder(capacity: int, maxCapacity: int) : StringBuilder
    StringBuilder(value: string, startIndex: int, length: int, capacity: int) : StringBuilder
    +
    val sbErr : StringBuilder
    +
    val inStream : StringReader
    +
    Multiple items
    type StringReader =
      inherit TextReader
      new : s:string -> StringReader
      member Close : unit -> unit
      member Peek : unit -> int
      member Read : unit -> int + 2 overloads
      member ReadAsync : buffer:Memory<char> * ?cancellationToken:CancellationToken -> ValueTask<int> + 1 overload
      member ReadBlock : buffer:Span<char> -> int
      member ReadBlockAsync : buffer:Memory<char> * ?cancellationToken:CancellationToken -> ValueTask<int> + 1 overload
      member ReadLine : unit -> string
      member ReadLineAsync : unit -> Task<string>
      member ReadToEnd : unit -> string
      ...

    --------------------
    StringReader(s: string) : StringReader
    +
    val outStream : StringWriter
    +
    Multiple items
    type StringWriter =
      inherit TextWriter
      new : unit -> StringWriter + 3 overloads
      member Close : unit -> unit
      member Encoding : Encoding
      member FlushAsync : unit -> Task
      member GetStringBuilder : unit -> StringBuilder
      member ToString : unit -> string
      member Write : value:char -> unit + 3 overloads
      member WriteAsync : value:char -> Task + 3 overloads
      member WriteLine : buffer:ReadOnlySpan<char> -> unit
      member WriteLineAsync : value:char -> Task + 3 overloads

    --------------------
    StringWriter() : StringWriter
    StringWriter(formatProvider: IFormatProvider) : StringWriter
    StringWriter(sb: StringBuilder) : StringWriter
    StringWriter(sb: StringBuilder, formatProvider: IFormatProvider) : StringWriter
    +
    val errStream : StringWriter
    +
    val argv : string []
    +
    val allArgs : string []
    +
    type Array =
      member Clone : unit -> obj
      member CopyTo : array:Array * index:int -> unit + 1 overload
      member GetEnumerator : unit -> IEnumerator
      member GetLength : dimension:int -> int
      member GetLongLength : dimension:int -> int64
      member GetLowerBound : dimension:int -> int
      member GetUpperBound : dimension:int -> int
      member GetValue : [<ParamArray>] indices:int[] -> obj + 7 overloads
      member Initialize : unit -> unit
      member IsFixedSize : bool
      ...
    +
    val append : array1:'T [] -> array2:'T [] -> 'T []
    +
    val fsiConfig : FsiEvaluationSessionHostConfig
    +
    type FsiEvaluationSession =
      interface IDisposable
      member EvalExpression : code:string -> FsiValue option
      member EvalExpressionNonThrowing : code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
      member EvalInteraction : code:string * ?cancellationToken:CancellationToken -> unit
      member EvalInteractionNonThrowing : code:string * ?cancellationToken:CancellationToken -> Choice<FsiValue option,exn> * FSharpErrorInfo []
      member EvalScript : filePath:string -> unit
      member EvalScriptNonThrowing : filePath:string -> Choice<unit,exn> * FSharpErrorInfo []
      member FormatValue : reflectionValue:obj * reflectionType:Type -> string
      member GetCompletions : longIdent:string -> seq<string>
      member Interrupt : unit -> unit
      ...
    static member FsiEvaluationSession.GetDefaultConfiguration : unit -> FsiEvaluationSessionHostConfig
    static member FsiEvaluationSession.GetDefaultConfiguration : fsiObj:obj -> FsiEvaluationSessionHostConfig
    static member FsiEvaluationSession.GetDefaultConfiguration : fsiObj:obj * useFsiAuxLib:bool -> FsiEvaluationSessionHostConfig
    -
    val fsiSession : FsiEvaluationSession

    Full name: Interactive.fsiSession
    +
    val fsiSession : FsiEvaluationSession
    static member FsiEvaluationSession.Create : fsiConfig:FsiEvaluationSessionHostConfig * argv:string [] * inReader:TextReader * outWriter:TextWriter * errorWriter:TextWriter * ?collectible:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver -> FsiEvaluationSession
    -
    val evalExpression : text:string -> unit

    Full name: Interactive.evalExpression


     Evaluate expression & return the result
    +
    val evalExpression : text:string -> unit


     Evaluate expression & return the result
    val text : string
    member FsiEvaluationSession.EvalExpression : code:string -> FsiValue option
    union case Option.Some: Value: 'T -> Option<'T>
    val value : FsiValue
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    property FsiValue.ReflectionValue: obj
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    property FsiValue.ReflectionValue: obj with get
    union case Option.None: Option<'T>
    -
    val evalExpressionTyped : text:string -> 'T

    Full name: Interactive.evalExpressionTyped


     Evaluate expression & return the result, strongly typed
    -
    val unbox : value:obj -> 'T

    Full name: Microsoft.FSharp.Core.Operators.unbox
    -
    val failwith : message:string -> 'T

    Full name: Microsoft.FSharp.Core.Operators.failwith
    -
    Multiple items
    val int : value:'T -> int (requires member op_Explicit)

    Full name: Microsoft.FSharp.Core.Operators.int

    --------------------
    type int = int32

    Full name: Microsoft.FSharp.Core.int

    --------------------
    type int<'Measure> = int

    Full name: Microsoft.FSharp.Core.int<_>
    -
    member FsiEvaluationSession.EvalInteraction : code:string -> unit
    -
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 3 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      static member Encrypt : path:string -> unit
      static member Exists : path:string -> bool
      ...

    Full name: System.IO.File
    +
    val evalExpressionTyped : text:string -> 'T


     Evaluate expression & return the result, strongly typed
    +
    val unbox : value:obj -> 'T
    +
    val failwith : message:string -> 'T
    +
    Multiple items
    val int : value:'T -> int (requires member op_Explicit)

    --------------------
    type int = int32

    --------------------
    type int<'Measure> = int
    +
    member FsiEvaluationSession.EvalInteraction : code:string * ?cancellationToken:Threading.CancellationToken -> unit
    +
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllLinesAsync : path:string * contents:IEnumerable<string> * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendAllTextAsync : path:string * contents:string * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 2 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      ...
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Encoding) : unit
    member FsiEvaluationSession.EvalScript : filePath:string -> unit
    -
    val result : Choice<unit,exn>

    Full name: Interactive.result
    -
    val warnings : FSharpErrorInfo []

    Full name: Interactive.warnings
    +
    val result : Choice<unit,exn>
    +
    val warnings : FSharpErrorInfo []
    member FsiEvaluationSession.EvalScriptNonThrowing : filePath:string -> Choice<unit,exn> * FSharpErrorInfo []
    union case Choice.Choice1Of2: 'T1 -> Choice<'T1,'T2>
    union case Choice.Choice2Of2: 'T2 -> Choice<'T1,'T2>
    -
    Multiple items
    val exn : exn

    --------------------
    type exn = Exception

    Full name: Microsoft.FSharp.Core.exn
    -
    property Exception.Message: string
    -
    val not : value:bool -> bool

    Full name: Microsoft.FSharp.Core.Operators.not
    +
    Multiple items
    val exn : exn

    --------------------
    type exn = Exception
    +
    property Exception.Message: string with get
    +
    val not : value:bool -> bool
    val w : FSharpErrorInfo
    -
    property FSharpErrorInfo.Message: string
    -
    property FSharpErrorInfo.StartLineAlternate: int
    -
    property FSharpErrorInfo.StartColumn: int
    -
    val evalExpressionTyped2 : text:string -> 'T

    Full name: Interactive.evalExpressionTyped2
    +
    property FSharpErrorInfo.Message: string with get
    +
    property FSharpErrorInfo.StartLineAlternate: int with get
    +
    property FSharpErrorInfo.StartColumn: int with get
    +
    val evalExpressionTyped2 : text:string -> 'T
    val res : Choice<FsiValue option,exn>
    -
    val warnings : FSharpErrorInfo []
    -
    member FsiEvaluationSession.EvalExpressionNonThrowing : code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
    -
    val sprintf : format:Printf.StringFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.sprintf
    -
    namespace System.Threading
    -
    namespace System.Threading.Tasks
    -
    val sampleLongRunningExpr : string

    Full name: Interactive.sampleLongRunningExpr
    -
    val task1 : Task<int>

    Full name: Interactive.task1
    -
    Multiple items
    type Task =
      new : action:Action -> Task + 7 overloads
      member AsyncState : obj
      member ContinueWith : continuationAction:Action<Task> -> Task + 9 overloads
      member CreationOptions : TaskCreationOptions
      member Dispose : unit -> unit
      member Exception : AggregateException
      member Id : int
      member IsCanceled : bool
      member IsCompleted : bool
      member IsFaulted : bool
      ...

    Full name: System.Threading.Tasks.Task

    --------------------
    type Task<'TResult> =
      inherit Task
      new : function:Func<'TResult> -> Task<'TResult> + 7 overloads
      member ContinueWith : continuationAction:Action<Task<'TResult>> -> Task + 9 overloads
      member Result : 'TResult with get, set
      static member Factory : TaskFactory<'TResult>

    Full name: System.Threading.Tasks.Task<_>

    --------------------
    Task(action: Action) : unit
    Task(action: Action, cancellationToken: Threading.CancellationToken) : unit
    Task(action: Action, creationOptions: TaskCreationOptions) : unit
    Task(action: Action<obj>, state: obj) : unit
    Task(action: Action, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : unit
    Task(action: Action<obj>, state: obj, cancellationToken: Threading.CancellationToken) : unit
    Task(action: Action<obj>, state: obj, creationOptions: TaskCreationOptions) : unit
    Task(action: Action<obj>, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : unit

    --------------------
    Task(function: Func<'TResult>) : unit
    Task(function: Func<'TResult>, cancellationToken: Threading.CancellationToken) : unit
    Task(function: Func<'TResult>, creationOptions: TaskCreationOptions) : unit
    Task(function: Func<obj,'TResult>, state: obj) : unit
    Task(function: Func<'TResult>, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : unit
    Task(function: Func<obj,'TResult>, state: obj, cancellationToken: Threading.CancellationToken) : unit
    Task(function: Func<obj,'TResult>, state: obj, creationOptions: TaskCreationOptions) : unit
    Task(function: Func<obj,'TResult>, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : unit
    -
    val task2 : Task<int>

    Full name: Interactive.task2
    -
    property Task.Result: int
    -
    val parseResults : obj

    Full name: Interactive.parseResults
    -
    val checkResults : obj

    Full name: Interactive.checkResults
    -
    val checkProjectResults : obj

    Full name: Interactive.checkProjectResults
    -
    member FsiEvaluationSession.ParseAndCheckInteraction : code:string -> Async<FSharpParseFileResults * FSharpCheckFileResults * FSharpCheckProjectResults>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    module FSharpTokenTag

    from FSharp.Compiler.SourceCodeServices
    -
    val IDENT : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpTokenTag.IDENT
    -
    val fsiConfig2 : FsiEvaluationSessionHostConfig

    Full name: Interactive.fsiConfig2
    -
    val fsi : Compiler.Interactive.InteractiveSession

    Full name: Microsoft.FSharp.Compiler.Interactive.Settings.fsi
    -
    val collectionTest : unit -> unit

    Full name: Interactive.collectionTest
    -
    val i : int32
    -
    val defaultArgs : string []
    -
    val inStream : StringReader
    -
    val outStream : StringWriter
    -
    val errStream : StringWriter
    -
    val fsiConfig : FsiEvaluationSessionHostConfig
    -
    val session : FsiEvaluationSession
    -
    static member FsiEvaluationSession.Create : fsiConfig:FsiEvaluationSessionHostConfig * argv:string [] * inReader:TextReader * outWriter:TextWriter * errorWriter:TextWriter * ?collectible:bool * ?legacyReferenceResolver:ReferenceResolver.Resolver -> FsiEvaluationSession
    -
    val v : FsiValue option
    -
    property Option.Value: FsiValue
    +
    member FsiEvaluationSession.EvalExpressionNonThrowing : code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
    +
    val sprintf : format:Printf.StringFormat<'T> -> 'T
    +
    namespace System.Threading
    +
    namespace System.Threading.Tasks
    +
    val sampleLongRunningExpr : string
    +
    val task1 : Task<int>
    +
    Multiple items
    type Task =
      new : action:Action -> Task + 7 overloads
      member AsyncState : obj
      member ConfigureAwait : continueOnCapturedContext:bool -> ConfiguredTaskAwaitable
      member ContinueWith : continuationAction:Action<Task> -> Task + 19 overloads
      member CreationOptions : TaskCreationOptions
      member Dispose : unit -> unit
      member Exception : AggregateException
      member GetAwaiter : unit -> TaskAwaiter
      member Id : int
      member IsCanceled : bool
      ...

    --------------------
    type Task<'TResult> =
      inherit Task
      new : function:Func<'TResult> -> Task<'TResult> + 7 overloads
      member ConfigureAwait : continueOnCapturedContext:bool -> ConfiguredTaskAwaitable<'TResult>
      member ContinueWith : continuationAction:Action<Task<'TResult>> -> Task + 19 overloads
      member GetAwaiter : unit -> TaskAwaiter<'TResult>
      member Result : 'TResult
      static member Factory : TaskFactory<'TResult>

    --------------------
    Task(action: Action) : Task
    Task(action: Action, cancellationToken: Threading.CancellationToken) : Task
    Task(action: Action, creationOptions: TaskCreationOptions) : Task
    Task(action: Action<obj>, state: obj) : Task
    Task(action: Action, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task
    Task(action: Action<obj>, state: obj, cancellationToken: Threading.CancellationToken) : Task
    Task(action: Action<obj>, state: obj, creationOptions: TaskCreationOptions) : Task
    Task(action: Action<obj>, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task

    --------------------
    Task(function: Func<'TResult>) : Task<'TResult>
    Task(function: Func<'TResult>, cancellationToken: Threading.CancellationToken) : Task<'TResult>
    Task(function: Func<'TResult>, creationOptions: TaskCreationOptions) : Task<'TResult>
    Task(function: Func<obj,'TResult>, state: obj) : Task<'TResult>
    Task(function: Func<'TResult>, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task<'TResult>
    Task(function: Func<obj,'TResult>, state: obj, cancellationToken: Threading.CancellationToken) : Task<'TResult>
    Task(function: Func<obj,'TResult>, state: obj, creationOptions: TaskCreationOptions) : Task<'TResult>
    Task(function: Func<obj,'TResult>, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task<'TResult>
    +
    val task2 : Task<int>
    +
    property Task.Result: int with get
    +
    val parseResults : FSharpParseFileResults
    +
    val checkResults : FSharpCheckFileResults
    +
    val checkProjectResults : FSharpCheckProjectResults
    +
    member FsiEvaluationSession.ParseAndCheckInteraction : code:string -> Async<FSharpParseFileResults * FSharpCheckFileResults * FSharpCheckProjectResults>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    property FSharpCheckFileResults.Errors: FSharpErrorInfo [] with get
    +
    property Array.Length: int with get
    +
    member FSharpCheckFileResults.GetToolTipText : line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * ?userOpName:string -> Async<FSharpToolTipText>
    +
    module FSharpTokenTag

    from FSharp.Compiler.SourceCodeServices
    +
    val IDENT : int
    +
    member FSharpCheckFileResults.GetSymbolUseAtLocation : line:int * colAtEndOfNames:int * lineText:string * names:string list * ?userOpName:string -> Async<FSharpSymbolUse option>
    +
    val fsiConfig2 : FsiEvaluationSessionHostConfig
    +
    val collectionTest : unit -> unit
    +
    val i : int32
    +
    val defaultArgs : string []
    +
    val session : FsiEvaluationSession
    +
    static member FsiEvaluationSession.Create : fsiConfig:FsiEvaluationSessionHostConfig * argv:string [] * inReader:TextReader * outWriter:TextWriter * errorWriter:TextWriter * ?collectible:bool * ?legacyReferenceResolver:ReferenceResolver.Resolver -> FsiEvaluationSession
    +
    val v : FsiValue option
    +
    property Option.Value: FsiValue with get
    @@ -500,10 +495,10 @@

    Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -532,6 +527,6 @@

    Fork me on GitHub + Fork me on GitHub diff --git a/docs/project.html b/docs/project.html index 5ae89f73be..354dd48aab 100644 --- a/docs/project.html +++ b/docs/project.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Compiler Services: Project Analysis

    +

    Compiler Services: Project Analysis

    This tutorial demonstrates how to can analyze a whole project using services provided by the F# compiler.

    NOTE: The FSharp.Compiler.Service API is subject to change when later versions of the nuget package are published.

    @@ -55,15 +54,15 @@

    10: 
    // Reference F# compiler API
-#r "FSharp.Compiler.Service.dll"
-#r "FSharp.Compiler.Service.ProjectCracker.dll"
+#r "FSharp.Compiler.Service.dll"
 
-open System
-open System.Collections.Generic
-open FSharp.Compiler.SourceCodeServices
+open System
+open System.Collections.Generic
+open FSharp.Compiler.SourceCodeServices
+open FSharp.Compiler.Text
 
 // Create an interactive checker instance 
-let checker = FSharpChecker.Create()
+let checker = FSharpChecker.Create()
    @@ -104,16 +103,16 @@

    34: 35: -
    module Inputs = 
-    open System.IO
+
    module Inputs = 
+    open System.IO
 
-    let base1 = Path.GetTempFileName()
-    let fileName1 = Path.ChangeExtension(base1, ".fs")
-    let base2 = Path.GetTempFileName()
-    let fileName2 = Path.ChangeExtension(base2, ".fs")
-    let dllName = Path.ChangeExtension(base2, ".dll")
-    let projFileName = Path.ChangeExtension(base2, ".fsproj")
-    let fileSource1 = """
+    let base1 = Path.GetTempFileName()
+    let fileName1 = Path.ChangeExtension(base1, ".fs")
+    let base2 = Path.GetTempFileName()
+    let fileName2 = Path.ChangeExtension(base2, ".fs")
+    let dllName = Path.ChangeExtension(base2, ".dll")
+    let projFileName = Path.ChangeExtension(base2, ".fsproj")
+    let fileSource1 = """
 module M
 
 type C() = 
@@ -122,9 +121,9 @@ 
    let xxx = 3 + 4
 let fff () = xxx + xxx
     """
-    File.WriteAllText(fileName1, fileSource1)
+    File.WriteAllText(fileName1, fileSource1)
 
-    let fileSource2 = """
+    let fileSource2 = """
 module N
 
 open M
@@ -138,7 +137,7 @@ 
    // Generate a warning
 let y2 = match 1 with 1 -> M.xxx
     """
-    File.WriteAllText(fileName2, fileSource2)
+    File.WriteAllText(fileName2, fileSource2)
 
    
 
 
@@ -185,54 +184,54 @@ 
    40: 
 41:
    -
    let projectOptions = 
-    let sysLib nm = 
-        if System.Environment.OSVersion.Platform = System.PlatformID.Win32NT then
+
    let projectOptions = 
+    let sysLib nm = 
+        if System.Environment.OSVersion.Platform = System.PlatformID.Win32NT then
             // file references only valid on Windows
-            System.Environment.GetFolderPath(System.Environment.SpecialFolder.ProgramFilesX86) +
-            @"\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\" + nm + ".dll"
+            System.Environment.GetFolderPath(System.Environment.SpecialFolder.ProgramFilesX86) +
+            @"\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\" + nm + ".dll"
         else
-            let sysDir = System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory()
-            let (++) a b = System.IO.Path.Combine(a,b)
-            sysDir ++ nm + ".dll" 
+            let sysDir = System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory()
+            let (++) a b = System.IO.Path.Combine(a,b)
+            sysDir ++ nm + ".dll" 
 
-    let fsCore4300() = 
-        if System.Environment.OSVersion.Platform = System.PlatformID.Win32NT then
+    let fsCore4300() = 
+        if System.Environment.OSVersion.Platform = System.PlatformID.Win32NT then
             // file references only valid on Windows
-            System.Environment.GetFolderPath(System.Environment.SpecialFolder.ProgramFilesX86) +
+            System.Environment.GetFolderPath(System.Environment.SpecialFolder.ProgramFilesX86) +
             @"\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.0.0\FSharp.Core.dll"  
         else 
-            sysLib "FSharp.Core"
+            sysLib "FSharp.Core"
 
-    checker.GetProjectOptionsFromCommandLineArgs
-       (Inputs.projFileName,
-        [| yield "--simpleresolution" 
+    checker.GetProjectOptionsFromCommandLineArgs
+       (Inputs.projFileName,
+        [| yield "--simpleresolution" 
            yield "--noframework" 
            yield "--debug:full" 
            yield "--define:DEBUG" 
            yield "--optimize-" 
-           yield "--out:" + Inputs.dllName
+           yield "--out:" + Inputs.dllName
            yield "--doc:test.xml" 
            yield "--warn:3" 
            yield "--fullpaths" 
            yield "--flaterrors" 
            yield "--target:library" 
-           yield Inputs.fileName1
-           yield Inputs.fileName2
-           let references =
-             [ sysLib "mscorlib" 
-               sysLib "System"
-               sysLib "System.Core"
-               fsCore4300() ]
-           for r in references do 
-                 yield "-r:" + r |])
+           yield Inputs.fileName1
+           yield Inputs.fileName2
+           let references =
+             [ sysLib "mscorlib" 
+               sysLib "System"
+               sysLib "System.Core"
+               fsCore4300() ]
+           for r in references do 
+                 yield "-r:" + r |])
 
    
 
 
 
    Now check the entire project (using the files saved on disk):
    
 
-
    1: 
 
    let wholeProjectResults = checker.ParseAndCheckProject(projectOptions) |> Async.RunSynchronously
+
    let wholeProjectResults = checker.ParseAndCheckProject(projectOptions) |> Async.RunSynchronously
 
    		
 
    
 
    
@@ -245,13 +244,13 @@ 
    6: 
 7:
    -
    wholeProjectResults .Errors.Length // 1
-wholeProjectResults.Errors.[0].Message.Contains("Incomplete pattern matches on this expression") // yes it does
+
    wholeProjectResults .Errors.Length // 1
+wholeProjectResults.Errors.[0].Message.Contains("Incomplete pattern matches on this expression") // yes it does
 
-wholeProjectResults.Errors.[0].StartLineAlternate // 13
-wholeProjectResults.Errors.[0].EndLineAlternate // 13
-wholeProjectResults.Errors.[0].StartColumn // 15
-wholeProjectResults.Errors.[0].EndColumn // 16
+wholeProjectResults.Errors.[0].StartLineAlternate // 13
+wholeProjectResults.Errors.[0].EndLineAlternate // 13
+wholeProjectResults.Errors.[0].StartColumn // 15
+wholeProjectResults.Errors.[0].EndColumn // 16
 
    
 
 
@@ -261,10 +260,10 @@ 
    3: 
 4:
    -
    [ for x in wholeProjectResults.AssemblySignature.Entities -> x.DisplayName ] // ["N"; "M"]
-[ for x in wholeProjectResults.AssemblySignature.Entities.[0].NestedEntities -> x.DisplayName ] // ["D1"; "D2"]
-[ for x in wholeProjectResults.AssemblySignature.Entities.[1].NestedEntities -> x.DisplayName ] // ["C"]
-[ for x in wholeProjectResults.AssemblySignature.Entities.[0].MembersFunctionsAndValues -> x.DisplayName ] // ["y"; "y2"]
+
    [ for x in wholeProjectResults.AssemblySignature.Entities -> x.DisplayName ] // ["N"; "M"]
+[ for x in wholeProjectResults.AssemblySignature.Entities.[0].NestedEntities -> x.DisplayName ] // ["D1"; "D2"]
+[ for x in wholeProjectResults.AssemblySignature.Entities.[1].NestedEntities -> x.DisplayName ] // ["C"]
+[ for x in wholeProjectResults.AssemblySignature.Entities.[0].MembersFunctionsAndValues -> x.DisplayName ] // ["y"; "y2"]
 
    
 
 
@@ -282,18 +281,18 @@ 
    11: 
 12:
    -
    let rec allSymbolsInEntities (entities: IList<FSharpEntity>) = 
-    [ for e in entities do 
-          yield (e :> FSharpSymbol) 
-          for x in e.MembersFunctionsAndValues do
-             yield (x :> FSharpSymbol)
-          for x in e.UnionCases do
-             yield (x :> FSharpSymbol)
-          for x in e.FSharpFields do
-             yield (x :> FSharpSymbol)
-          yield! allSymbolsInEntities e.NestedEntities ]
+
    let rec allSymbolsInEntities (entities: IList<FSharpEntity>) = 
+    [ for e in entities do 
+          yield (e :> FSharpSymbol) 
+          for x in e.MembersFunctionsAndValues do
+             yield (x :> FSharpSymbol)
+          for x in e.UnionCases do
+             yield (x :> FSharpSymbol)
+          for x in e.FSharpFields do
+             yield (x :> FSharpSymbol)
+          yield! allSymbolsInEntities e.NestedEntities ]
 
-let allSymbols = allSymbolsInEntities wholeProjectResults.AssemblySignature.Entities
+let allSymbols = allSymbolsInEntities wholeProjectResults.AssemblySignature.Entities
 
    
 
 
@@ -303,9 +302,9 @@ 
    2: 
 3:
    -
    let backgroundParseResults1, backgroundTypedParse1 = 
-    checker.GetBackgroundCheckResultsForFileInProject(Inputs.fileName1, projectOptions) 
-    |> Async.RunSynchronously
+
    let backgroundParseResults1, backgroundTypedParse1 = 
+    checker.GetBackgroundCheckResultsForFileInProject(Inputs.fileName1, projectOptions) 
+    |> Async.RunSynchronously
 
    
 
 
@@ -318,13 +317,13 @@ 
    6: 
 7:
    -
    let xSymbolUseOpt = 
-    backgroundTypedParse1.GetSymbolUseAtLocation(9,9,"",["xxx"])
-    |> Async.RunSynchronously
+
    let xSymbolUseOpt = 
+    backgroundTypedParse1.GetSymbolUseAtLocation(9,9,"",["xxx"])
+    |> Async.RunSynchronously
 
-let xSymbolUse = xSymbolUseOpt.Value
+let xSymbolUse = xSymbolUseOpt.Value
 
-let xSymbol = xSymbolUse.Symbol
+let xSymbol = xSymbolUse.Symbol
 
    
 
 
@@ -335,10 +334,10 @@ 
    4: 
 5:
    -
    let xSymbolAsValue = 
-    match xSymbol with 
-    | :? FSharpMemberOrFunctionOrValue as xSymbolAsVal -> xSymbolAsVal
-    | _ -> failwith "we expected this to be a member, function or value"
+
    let xSymbolAsValue = 
+    match xSymbol with 
+    | :? FSharpMemberOrFunctionOrValue as xSymbolAsVal -> xSymbolAsVal
+    | _ -> failwith "we expected this to be a member, function or value"
        
 
    
 
@@ -348,9 +347,9 @@ 
    2: 
 3:
    -
    let usesOfXSymbol = 
-    wholeProjectResults.GetUsesOfSymbol(xSymbol) 
-    |> Async.RunSynchronously
+
    let usesOfXSymbol = 
+    wholeProjectResults.GetUsesOfSymbol(xSymbol) 
+    |> Async.RunSynchronously
 
    
 
 
@@ -360,10 +359,10 @@ 
    3: 
 4:
    -
    let allUsesOfAllSignatureSymbols = 
-    [ for s in allSymbols do 
-         let uses = wholeProjectResults.GetUsesOfSymbol(s) |> Async.RunSynchronously 
-         yield s.ToString(), uses ]
+
    let allUsesOfAllSignatureSymbols = 
+    [ for s in allSymbols do 
+         let uses = wholeProjectResults.GetUsesOfSymbol(s) |> Async.RunSynchronously 
+         yield s.ToString(), uses ]
 
    
 
 
@@ -372,9 +371,9 @@ 
    2: 
 3:
    -
    let allUsesOfAllSymbols =  
-    wholeProjectResults.GetAllUsesOfAllSymbols()
-    |> Async.RunSynchronously
+
    let allUsesOfAllSymbols =  
+    wholeProjectResults.GetAllUsesOfAllSymbols()
+    |> Async.RunSynchronously
 
    
 
 
@@ -398,23 +397,23 @@ 
    16: 
 17:
    -
    let parseResults1, checkAnswer1 = 
-    checker.ParseAndCheckFileInProject(Inputs.fileName1, 0, Inputs.fileSource1, projectOptions) 
-    |> Async.RunSynchronously
+
    let parseResults1, checkAnswer1 = 
+    checker.ParseAndCheckFileInProject(Inputs.fileName1, 0, SourceText.ofString Inputs.fileSource1, projectOptions)
+    |> Async.RunSynchronously
 
-let checkResults1 = 
-    match checkAnswer1 with 
-    | FSharpCheckFileAnswer.Succeeded x ->  x 
-    | _ -> failwith "unexpected aborted"
+let checkResults1 = 
+    match checkAnswer1 with 
+    | FSharpCheckFileAnswer.Succeeded x ->  x 
+    | _ -> failwith "unexpected aborted"
 
-let parseResults2, checkAnswer2 = 
-    checker.ParseAndCheckFileInProject(Inputs.fileName2, 0, Inputs.fileSource2, projectOptions)
-    |> Async.RunSynchronously
+let parseResults2, checkAnswer2 = 
+    checker.ParseAndCheckFileInProject(Inputs.fileName2, 0, SourceText.ofString Inputs.fileSource2, projectOptions)
+    |> Async.RunSynchronously
 
-let checkResults2 = 
-    match checkAnswer2 with 
-    | FSharpCheckFileAnswer.Succeeded x ->  x 
-    | _ -> failwith "unexpected aborted"
+let checkResults2 = 
+    match checkAnswer2 with 
+    | FSharpCheckFileAnswer.Succeeded x ->  x 
+    | _ -> failwith "unexpected aborted"
 
    
 
 
@@ -431,17 +430,17 @@ 
    10: 
 11:
    -
    let xSymbolUse2Opt = 
-    checkResults1.GetSymbolUseAtLocation(9,9,"",["xxx"])
-    |> Async.RunSynchronously
+
    let xSymbolUse2Opt = 
+    checkResults1.GetSymbolUseAtLocation(9,9,"",["xxx"])
+    |> Async.RunSynchronously
 
-let xSymbolUse2 = xSymbolUse2Opt.Value
+let xSymbolUse2 = xSymbolUse2Opt.Value
 
-let xSymbol2 = xSymbolUse2.Symbol
+let xSymbol2 = xSymbolUse2.Symbol
 
-let usesOfXSymbol2 = 
-    wholeProjectResults.GetUsesOfSymbol(xSymbol2) 
-    |> Async.RunSynchronously
+let usesOfXSymbol2 = 
+    wholeProjectResults.GetUsesOfSymbol(xSymbol2) 
+    |> Async.RunSynchronously
 
    
 
 
@@ -450,9 +449,9 @@ 
    2: 
 3:
    -
    let allUsesOfAllSymbolsInFile1 = 
-    checkResults1.GetAllUsesOfAllSymbolsInFile()
-    |> Async.RunSynchronously
+
    let allUsesOfAllSymbolsInFile1 = 
+    checkResults1.GetAllUsesOfAllSymbolsInFile()
+    |> Async.RunSynchronously
 
    
 
 
@@ -465,13 +464,13 @@ 
    6: 
 7:
    -
    let allUsesOfXSymbolInFile1 = 
-    checkResults1.GetUsesOfSymbolInFile(xSymbol2)
-    |> Async.RunSynchronously
+
    let allUsesOfXSymbolInFile1 = 
+    checkResults1.GetUsesOfSymbolInFile(xSymbol2)
+    |> Async.RunSynchronously
 
-let allUsesOfXSymbolInFile2 = 
-    checkResults2.GetUsesOfSymbolInFile(xSymbol2)
-    |> Async.RunSynchronously
+let allUsesOfXSymbolInFile2 = 
+    checkResults2.GetUsesOfSymbolInFile(xSymbol2)
+    |> Async.RunSynchronously
 
    
 
 
@@ -495,53 +494,6 @@ 
    Cracking a legacy project file
    
-
    F# projects normally use the '.fsproj' project file format.
-A project cracking facility for legacy old-style .fsproj is provided as a separate NuGet package:
-FSharp.Compiler.Service.ProjectCracker.
    
-
    Projecet cracking for modern project files should be done using a library such as DotNetProjInfo.
-See FsAutoComplete for example code.
    
-
    The legacy NuGet package FSharp.Compiler.Service.ProjectCracker contains a
-library FSharp.Compiler.Service.ProjectCracker.dll, which should be
-referenced by your application directly, and an executable
-FSharp.Compiler.Service.ProjectCrackerTool.exe, which should be copied
-into the output folder of your application by the build process. If
-you install using Paket or NuGet, then this will be configured for you
-automatically. If not, you should reference the provided .targets
-file manually in your application. This can be found in the NuGet
-package at build/net45/FSharp.Compiler.Service.ProjectCrackerTool.targets.
    
-
    The reason for this split was so the analysis of an F# project
-file is performed out of process, in order that the necessary assembly
-binding redirects can be applied without requiring the caller to
-arrange this. In this way MSBuild versions from 4 up to 14 can be
-accommodated transparently.
    
-
    In this example we get the project options for one of the
-project files in the F# Compiler Service project itself - you should also be able to use this technique
-for any project that builds cleanly using the command line tools 'xbuild' or 'msbuild'.
    
-
-
-
-
    1: 
-2: 
-3: 
-
    let projectFile  = __SOURCE_DIRECTORY__ + @"/../../src/fsharp/FSharp.Compiler.Service/FSharp.Compiler.Service.fsproj"
-
-ProjectCracker.GetProjectOptionsFromProjectFile(projectFile)
-
    
-
    You can also request RELEASE mode and set other build configuration parameters:
    
-
-
-
-
    1: 
-
    ProjectCracker.GetProjectOptionsFromProjectFile(projectFile, [("Configuration", "Release")])
-
    
-
    For debugging purposes it is also possible to obtain a detailed log from the assembly resolution process.
    
-
-
-
-
    1: 
-
    let options, logs = ProjectCracker.GetProjectOptionsFromProjectFileLogged(projectFile, [("Configuration", "Release")])
-
    
 
    Summary
    
 
    As you have seen, the ParseAndCheckProject lets you access results of project-wide analysis
 such as symbol references. To learn more about working with symbols, see Symbols.
    
@@ -554,106 +506,115 @@ 
    Summary
    
 
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    
 
    namespace FSharp.Compiler
    
 
    namespace FSharp.Compiler.SourceCodeServices
    
-
    val checker : FSharpChecker

    Full name: Project.checker
    
-
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    
-
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    
-
    namespace System.IO
    
-
    val base1 : string

    Full name: Project.Inputs.base1
    
-
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val InvalidPathChars : char[]
      static val PathSeparator : char
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string
      static member GetExtension : path:string -> string
      static member GetFileName : path:string -> string
      ...

    Full name: System.IO.Path
    
-
    Path.GetTempFileName() : string
    
-
    val fileName1 : string

    Full name: Project.Inputs.fileName1
    
-
    Path.ChangeExtension(path: string, extension: string) : string
    
-
    val base2 : string

    Full name: Project.Inputs.base2
    
-
    val fileName2 : string

    Full name: Project.Inputs.fileName2
    
-
    val dllName : string

    Full name: Project.Inputs.dllName
    
-
    val projFileName : string

    Full name: Project.Inputs.projFileName
    
-
    val fileSource1 : string

    Full name: Project.Inputs.fileSource1
    
-
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 3 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      static member Encrypt : path:string -> unit
      static member Exists : path:string -> bool
      ...

    Full name: System.IO.File
    
-
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    
-
    val fileSource2 : string

    Full name: Project.Inputs.fileSource2
    
-
    val projectOptions : FSharpProjectOptions

    Full name: Project.projectOptions
    
-
    val sysLib : (string -> string)
    
-
    val nm : string
    
-
    type Environment =
      static member CommandLine : string
      static member CurrentDirectory : string with get, set
      static member Exit : exitCode:int -> unit
      static member ExitCode : int with get, set
      static member ExpandEnvironmentVariables : name:string -> string
      static member FailFast : message:string -> unit + 1 overload
      static member GetCommandLineArgs : unit -> string[]
      static member GetEnvironmentVariable : variable:string -> string + 1 overload
      static member GetEnvironmentVariables : unit -> IDictionary + 1 overload
      static member GetFolderPath : folder:SpecialFolder -> string + 1 overload
      ...
      nested type SpecialFolder
      nested type SpecialFolderOption

    Full name: System.Environment
    
-
    property Environment.OSVersion: OperatingSystem
    
-
    property OperatingSystem.Platform: PlatformID
    
-
    type PlatformID =
      | Win32S = 0
      | Win32Windows = 1
      | Win32NT = 2
      | WinCE = 3
      | Unix = 4
      | Xbox = 5
      | MacOSX = 6

    Full name: System.PlatformID
    
-
    field PlatformID.Win32NT = 2
    
-
    Environment.GetFolderPath(folder: Environment.SpecialFolder) : string
    Environment.GetFolderPath(folder: Environment.SpecialFolder, option: Environment.SpecialFolderOption) : string
    
-
    type SpecialFolder =
      | ApplicationData = 26
      | CommonApplicationData = 35
      | LocalApplicationData = 28
      | Cookies = 33
      | Desktop = 0
      | Favorites = 6
      | History = 34
      | InternetCache = 32
      | Programs = 2
      | MyComputer = 17
      ...

    Full name: System.Environment.SpecialFolder
    
-
    field Environment.SpecialFolder.ProgramFilesX86 = 42
    
-
    val sysDir : string
    
-
    namespace System.Runtime
    
-
    namespace System.Runtime.InteropServices
    
-
    type RuntimeEnvironment =
      new : unit -> RuntimeEnvironment
      static member FromGlobalAccessCache : a:Assembly -> bool
      static member GetRuntimeDirectory : unit -> string
      static member GetRuntimeInterfaceAsIntPtr : clsid:Guid * riid:Guid -> nativeint
      static member GetRuntimeInterfaceAsObject : clsid:Guid * riid:Guid -> obj
      static member GetSystemVersion : unit -> string
      static member SystemConfigurationFile : string

    Full name: System.Runtime.InteropServices.RuntimeEnvironment
    
-
    Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory() : string
    
-
    val a : string
    
-
    val b : string
    
-
    IO.Path.Combine([<ParamArray>] paths: string []) : string
    IO.Path.Combine(path1: string, path2: string) : string
    IO.Path.Combine(path1: string, path2: string, path3: string) : string
    IO.Path.Combine(path1: string, path2: string, path3: string, path4: string) : string
    
-
    val fsCore4300 : (unit -> string)
    
-
    member FSharpChecker.GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    
-
    module Inputs

    from Project
    
-
    val references : string list
    
-
    val wholeProjectResults : obj

    Full name: Project.wholeProjectResults
    
-
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    
-
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    
-
    
-
    val x : UnresolvedSymbol
    
-
    UnresolvedSymbol.DisplayName: string
    
-
    val allSymbolsInEntities : entities:IList<FSharpEntity> -> FSharpSymbol list

    Full name: Project.allSymbolsInEntities
    
-
    val entities : IList<FSharpEntity>
    
-
    type IList<'T> =
      member IndexOf : item:'T -> int
      member Insert : index:int * item:'T -> unit
      member Item : int -> 'T with get, set
      member RemoveAt : index:int -> unit

    Full name: System.Collections.Generic.IList<_>
    
-
    type FSharpEntity =
      inherit FSharpSymbol
      private new : SymbolEnv * EntityRef -> FSharpEntity
      member AbbreviatedType : FSharpType
      member AccessPath : string
      member Accessibility : FSharpAccessibility
      member ActivePatternCases : FSharpActivePatternCase list
      member AllCompilationPaths : string list
      member AllInterfaces : IList<FSharpType>
      member ArrayRank : int
      member Attributes : IList<FSharpAttribute>
      ...

    Full name: FSharp.Compiler.SourceCodeServices.FSharpEntity
    
-
    val e : FSharpEntity
    
-
    type FSharpSymbol =
      member GetEffectivelySameAsHash : unit -> int
      member IsAccessible : FSharpAccessibilityRights -> bool
      member IsEffectivelySameAs : other:FSharpSymbol -> bool
      member Assembly : FSharpAssembly
      member DeclarationLocation : range option
      member DisplayName : string
      member FullName : string
      member ImplementationLocation : range option
      member IsExplicitlySuppressed : bool
      member private Item : Item
      ...

    Full name: FSharp.Compiler.SourceCodeServices.FSharpSymbol
    
+
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>
    
+
    namespace FSharp.Compiler.Text
    
+
    val checker : FSharpChecker
    
+
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    
+
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    
+
    namespace System.IO
    
+
    val base1 : string
    
+
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val PathSeparator : char
      static val InvalidPathChars : char[]
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string + 1 overload
      static member GetExtension : path:string -> string + 1 overload
      static member GetFileName : path:string -> string + 1 overload
      ...
    
+
    Path.GetTempFileName() : string
    
+
    val fileName1 : string
    
+
    Path.ChangeExtension(path: string, extension: string) : string
    
+
    val base2 : string
    
+
    val fileName2 : string
    
+
    val dllName : string
    
+
    val projFileName : string
    
+
    val fileSource1 : string
    
+
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllLinesAsync : path:string * contents:IEnumerable<string> * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendAllTextAsync : path:string * contents:string * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 2 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      ...
    
+
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    
+
    val fileSource2 : string
    
+
    val projectOptions : FSharpProjectOptions
    
+
    val sysLib : (string -> string)
    
+
    val nm : string
    
+
    type Environment =
      static member CommandLine : string
      static member CurrentDirectory : string with get, set
      static member CurrentManagedThreadId : int
      static member Exit : exitCode:int -> unit
      static member ExitCode : int with get, set
      static member ExpandEnvironmentVariables : name:string -> string
      static member FailFast : message:string -> unit + 1 overload
      static member GetCommandLineArgs : unit -> string[]
      static member GetEnvironmentVariable : variable:string -> string + 1 overload
      static member GetEnvironmentVariables : unit -> IDictionary + 1 overload
      ...
      nested type SpecialFolder
      nested type SpecialFolderOption
    
+
    property Environment.OSVersion: OperatingSystem with get
    
+
    property OperatingSystem.Platform: PlatformID with get
    
+
    type PlatformID =
      | Win32S = 0
      | Win32Windows = 1
      | Win32NT = 2
      | WinCE = 3
      | Unix = 4
      | Xbox = 5
      | MacOSX = 6
    
+
    field PlatformID.Win32NT: PlatformID = 2
    
+
    Environment.GetFolderPath(folder: Environment.SpecialFolder) : string
    Environment.GetFolderPath(folder: Environment.SpecialFolder, option: Environment.SpecialFolderOption) : string
    
+
    type SpecialFolder =
      | ApplicationData = 26
      | CommonApplicationData = 35
      | LocalApplicationData = 28
      | Cookies = 33
      | Desktop = 0
      | Favorites = 6
      | History = 34
      | InternetCache = 32
      | Programs = 2
      | MyComputer = 17
      ...
    
+
    field Environment.SpecialFolder.ProgramFilesX86: Environment.SpecialFolder = 42
    
+
    val sysDir : string
    
+
    namespace System.Runtime
    
+
    namespace System.Runtime.InteropServices
    
+
    type RuntimeEnvironment =
      static member FromGlobalAccessCache : a:Assembly -> bool
      static member GetRuntimeDirectory : unit -> string
      static member GetRuntimeInterfaceAsIntPtr : clsid:Guid * riid:Guid -> nativeint
      static member GetRuntimeInterfaceAsObject : clsid:Guid * riid:Guid -> obj
      static member GetSystemVersion : unit -> string
      static member SystemConfigurationFile : string
    
+
    Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory() : string
    
+
    val a : string
    
+
    val b : string
    
+
    IO.Path.Combine([<ParamArray>] paths: string []) : string
    IO.Path.Combine(path1: string, path2: string) : string
    IO.Path.Combine(path1: string, path2: string, path3: string) : string
    IO.Path.Combine(path1: string, path2: string, path3: string, path4: string) : string
    
+
    val fsCore4300 : (unit -> string)
    
+
    member FSharpChecker.GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    
+
    module Inputs

    from Project
    
+
    val references : string list
    
+
    val r : string
    
+
    val wholeProjectResults : FSharpCheckProjectResults
    
+
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    
+
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    
+
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    
+
    property FSharpCheckProjectResults.Errors: FSharpErrorInfo [] with get
    
+
    val x : FSharpEntity
    
+
    property FSharpCheckProjectResults.AssemblySignature: FSharpAssemblySignature with get
    
+
    property FSharpAssemblySignature.Entities: IList<FSharpEntity> with get
    
+
    property FSharpEntity.DisplayName: string with get
    
 
    val x : FSharpMemberOrFunctionOrValue
    
-
    property FSharpEntity.MembersFunctionsAndValues: IList<FSharpMemberOrFunctionOrValue>
    
-
    val x : FSharpUnionCase
    
-
    property FSharpEntity.UnionCases: IList<FSharpUnionCase>
    
-
    val x : FSharpField
    
-
    property FSharpEntity.FSharpFields: IList<FSharpField>
    
-
    property FSharpEntity.NestedEntities: IList<FSharpEntity>
    
-
    val allSymbols : FSharpSymbol list

    Full name: Project.allSymbols
    
-
    val backgroundParseResults1 : obj

    Full name: Project.backgroundParseResults1
    
-
    val backgroundTypedParse1 : obj

    Full name: Project.backgroundTypedParse1
    
-
    member FSharpChecker.GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    
-
    val xSymbolUseOpt : obj

    Full name: Project.xSymbolUseOpt
    
-
    val xSymbolUse : AssemblySymbol

    Full name: Project.xSymbolUse
    
-
    val xSymbol : FSharpSymbol

    Full name: Project.xSymbol
    
-
    AssemblySymbol.Symbol: FSharpSymbol
    
-
    val xSymbolAsValue : FSharpMemberOrFunctionOrValue

    Full name: Project.xSymbolAsValue
    
-
    type FSharpMemberOrFunctionOrValue =
      inherit FSharpSymbol
      private new : SymbolEnv * MethInfo -> FSharpMemberOrFunctionOrValue
      private new : SymbolEnv * ValRef -> FSharpMemberOrFunctionOrValue
      member FormatLayout : context:FSharpDisplayContext -> Layout
      member Overloads : bool -> IList<FSharpMemberOrFunctionOrValue> option
      member Accessibility : FSharpAccessibility
      member ApparentEnclosingEntity : FSharpEntity
      member Attributes : IList<FSharpAttribute>
      member CompiledName : string
      member CurriedParameterGroups : IList<IList<FSharpParameter>>
      ...

    Full name: FSharp.Compiler.SourceCodeServices.FSharpMemberOrFunctionOrValue
    
-
    val xSymbolAsVal : FSharpMemberOrFunctionOrValue
    
-
    val failwith : message:string -> 'T

    Full name: Microsoft.FSharp.Core.Operators.failwith
    
-
    val usesOfXSymbol : obj

    Full name: Project.usesOfXSymbol
    
-
    val allUsesOfAllSignatureSymbols : obj list

    Full name: Project.allUsesOfAllSignatureSymbols
    
-
    val allUsesOfAllSymbols : obj

    Full name: Project.allUsesOfAllSymbols
    
-
    val parseResults1 : obj

    Full name: Project.parseResults1
    
-
    val checkAnswer1 : FSharpCheckFileAnswer

    Full name: Project.checkAnswer1
    
-
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    
-
    val checkResults1 : FSharpCheckFileResults

    Full name: Project.checkResults1
    
-
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults

    Full name: FSharp.Compiler.SourceCodeServices.FSharpCheckFileAnswer
    
-
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    
-
    val x : FSharpCheckFileResults
    
-
    val parseResults2 : obj

    Full name: Project.parseResults2
    
-
    val checkAnswer2 : FSharpCheckFileAnswer

    Full name: Project.checkAnswer2
    
-
    val checkResults2 : FSharpCheckFileResults

    Full name: Project.checkResults2
    
-
    val xSymbolUse2Opt : obj

    Full name: Project.xSymbolUse2Opt
    
-
    member FSharpCheckFileResults.GetSymbolUseAtLocation : line:int * colAtEndOfNames:int * lineText:string * names:string list * ?userOpName:string -> Async<FSharpSymbolUse option>
    
-
    val xSymbolUse2 : AssemblySymbol

    Full name: Project.xSymbolUse2
    
-
    val xSymbol2 : FSharpSymbol

    Full name: Project.xSymbol2
    
-
    val usesOfXSymbol2 : obj

    Full name: Project.usesOfXSymbol2
    
-
    val allUsesOfAllSymbolsInFile1 : obj

    Full name: Project.allUsesOfAllSymbolsInFile1
    
-
    member FSharpCheckFileResults.GetAllUsesOfAllSymbolsInFile : unit -> Async<FSharpSymbolUse []>
    
-
    val allUsesOfXSymbolInFile1 : obj

    Full name: Project.allUsesOfXSymbolInFile1
    
-
    member FSharpCheckFileResults.GetUsesOfSymbolInFile : symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    
-
    val allUsesOfXSymbolInFile2 : obj

    Full name: Project.allUsesOfXSymbolInFile2
    
-
    val projectFile : string

    Full name: Project.projectFile
    
-
    type ProjectCracker =
      static member GetProjectOptionsFromProjectFile : projectFileName:string * ?properties:(string * string) list * ?loadedTimeStamp:DateTime -> FSharpProjectOptions
      static member GetProjectOptionsFromProjectFileLogged : projectFileName:string * ?properties:(string * string) list * ?loadedTimeStamp:DateTime * ?enableLogging:bool -> FSharpProjectOptions * Map<string,string>

    Full name: FSharp.Compiler.SourceCodeServices.ProjectCracker
    
-
    static member ProjectCracker.GetProjectOptionsFromProjectFile : projectFileName:string * ?properties:(string * string) list * ?loadedTimeStamp:DateTime -> FSharpProjectOptions
    
-
    val options : FSharpProjectOptions

    Full name: Project.options
    
-
    val logs : Map<string,string>

    Full name: Project.logs
    
-
    static member ProjectCracker.GetProjectOptionsFromProjectFileLogged : projectFileName:string * ?properties:(string * string) list * ?loadedTimeStamp:DateTime * ?enableLogging:bool -> FSharpProjectOptions * Map<string,string>
    
+
    property FSharpMemberOrFunctionOrValue.DisplayName: string with get
    
+
    val allSymbolsInEntities : entities:IList<FSharpEntity> -> FSharpSymbol list
    
+
    val entities : IList<FSharpEntity>
    
+
    type IList<'T> =
      inherit ICollection<'T>
      inherit IEnumerable<'T>
      inherit IEnumerable
      member IndexOf : item:'T -> int
      member Insert : index:int * item:'T -> unit
      member Item : int -> 'T with get, set
      member RemoveAt : index:int -> unit
    
+
    type FSharpEntity =
      inherit FSharpSymbol
      private new : SymbolEnv * EntityRef -> FSharpEntity
      member AbbreviatedType : FSharpType
      member AccessPath : string
      member Accessibility : FSharpAccessibility
      member ActivePatternCases : FSharpActivePatternCase list
      member AllCompilationPaths : string list
      member AllInterfaces : IList<FSharpType>
      member ArrayRank : int
      member Attributes : IList<FSharpAttribute>
      ...
    
+
    val e : FSharpEntity
    
+
    type FSharpSymbol =
      member GetEffectivelySameAsHash : unit -> int
      member IsAccessible : FSharpAccessibilityRights -> bool
      member IsEffectivelySameAs : other:FSharpSymbol -> bool
      member Assembly : FSharpAssembly
      member DeclarationLocation : range option
      member DisplayName : string
      member FullName : string
      member ImplementationLocation : range option
      member IsExplicitlySuppressed : bool
      member private Item : Item
      ...
    
+
    property FSharpEntity.MembersFunctionsAndValues: IList<FSharpMemberOrFunctionOrValue> with get
    
+
    val x : FSharpUnionCase
    
+
    property FSharpEntity.UnionCases: IList<FSharpUnionCase> with get
    
+
    val x : FSharpField
    
+
    property FSharpEntity.FSharpFields: IList<FSharpField> with get
    
+
    property FSharpEntity.NestedEntities: IList<FSharpEntity> with get
    
+
    val allSymbols : FSharpSymbol list
    
+
    val backgroundParseResults1 : FSharpParseFileResults
    
+
    val backgroundTypedParse1 : FSharpCheckFileResults
    
+
    member FSharpChecker.GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    
+
    val xSymbolUseOpt : FSharpSymbolUse option
    
+
    member FSharpCheckFileResults.GetSymbolUseAtLocation : line:int * colAtEndOfNames:int * lineText:string * names:string list * ?userOpName:string -> Async<FSharpSymbolUse option>
    
+
    val xSymbolUse : FSharpSymbolUse
    
+
    property Option.Value: FSharpSymbolUse with get
    
+
    val xSymbol : FSharpSymbol
    
+
    property FSharpSymbolUse.Symbol: FSharpSymbol with get
    
+
    val xSymbolAsValue : FSharpMemberOrFunctionOrValue
    
+
    type FSharpMemberOrFunctionOrValue =
      inherit FSharpSymbol
      private new : SymbolEnv * MethInfo -> FSharpMemberOrFunctionOrValue
      private new : SymbolEnv * ValRef -> FSharpMemberOrFunctionOrValue
      member FormatLayout : context:FSharpDisplayContext -> Layout
      member Overloads : bool -> IList<FSharpMemberOrFunctionOrValue> option
      member Accessibility : FSharpAccessibility
      member ApparentEnclosingEntity : FSharpEntity
      member Attributes : IList<FSharpAttribute>
      member CompiledName : string
      member CurriedParameterGroups : IList<IList<FSharpParameter>>
      ...
    
+
    val xSymbolAsVal : FSharpMemberOrFunctionOrValue
    
+
    val failwith : message:string -> 'T
    
+
    val usesOfXSymbol : FSharpSymbolUse []
    
+
    member FSharpCheckProjectResults.GetUsesOfSymbol : symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    
+
    val allUsesOfAllSignatureSymbols : (string * FSharpSymbolUse []) list
    
+
    val s : FSharpSymbol
    
+
    val uses : FSharpSymbolUse []
    
+
    Object.ToString() : string
    
+
    val allUsesOfAllSymbols : FSharpSymbolUse []
    
+
    member FSharpCheckProjectResults.GetAllUsesOfAllSymbols : unit -> Async<FSharpSymbolUse []>
    
+
    val parseResults1 : FSharpParseFileResults
    
+
    val checkAnswer1 : FSharpCheckFileAnswer
    
+
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    
+
    module SourceText

    from FSharp.Compiler.Text
    
+
    val ofString : string -> ISourceText
    
+
    val checkResults1 : FSharpCheckFileResults
    
+
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults
    
+
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    
+
    val x : FSharpCheckFileResults
    
+
    val parseResults2 : FSharpParseFileResults
    
+
    val checkAnswer2 : FSharpCheckFileAnswer
    
+
    val checkResults2 : FSharpCheckFileResults
    
+
    val xSymbolUse2Opt : FSharpSymbolUse option
    
+
    val xSymbolUse2 : FSharpSymbolUse
    
+
    val xSymbol2 : FSharpSymbol
    
+
    val usesOfXSymbol2 : FSharpSymbolUse []
    
+
    val allUsesOfAllSymbolsInFile1 : FSharpSymbolUse []
    
+
    member FSharpCheckFileResults.GetAllUsesOfAllSymbolsInFile : unit -> Async<FSharpSymbolUse []>
    
+
    val allUsesOfXSymbolInFile1 : FSharpSymbolUse []
    
+
    member FSharpCheckFileResults.GetUsesOfSymbolInFile : symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    
+
    val allUsesOfXSymbolInFile2 : FSharpSymbolUse []

    @@ -669,10 +630,10 @@

    Summary

  • Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -701,6 +662,6 @@

    Summary

    - Fork me on GitHub + Fork me on GitHub diff --git a/docs/queue.html b/docs/queue.html index aebe7d3769..9739eb6b8c 100644 --- a/docs/queue.html +++ b/docs/queue.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - Fork me on GitHub + Fork me on GitHub diff --git a/docs/react.html b/docs/react.html index a53fdfb737..fb208ffea7 100644 --- a/docs/react.html +++ b/docs/react.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Compiler Services: Reacting to Changes

    +

    Compiler Services: Reacting to Changes

    This tutorial discusses some technical aspects of how to make sure the F# compiler service is providing up-to-date results especially when hosted in an IDE. See also project wide analysis for information on project analysis.

    @@ -49,7 +48,7 @@

    FSharpChecker does repeatedly ask for time stamps from the file system which it uses to decide if recomputation is needed. -FCS doesn�t listen for changes directly - for example, it creates no FileWatcher object (and the +FCS doesn't listen for changes directly - for example, it creates no FileWatcher object (and the IFileSystem API has no ability to create such objects). This is partly for legacy reasons, and partly because some hosts forbid the creation of FileWatcher objects.

    In most cases the repeated timestamp requests are sufficient. If you don't actively @@ -100,30 +99,30 @@

    16: 
        // Get the service
-    let vsFileWatch = fls.GetService(typeof<SVsFileChangeEx >) :?> IVsFileChangeEx
+    let vsFileWatch = fls.GetService(typeof<SVsFileChangeEx >) :?> IVsFileChangeEx
 
     // Watch the Add and Change events
-    let fileChangeFlags = 
-        uint32 (_VSFILECHANGEFLAGS.VSFILECHG_Add ||| 
+    let fileChangeFlags = 
+        uint32 (_VSFILECHANGEFLAGS.VSFILECHG_Add ||| 
                 // _VSFILECHANGEFLAGS.VSFILECHG_Del ||| // don't listen for deletes - if a file (such as a 'Clean'ed project reference) is deleted, just keep using stale info
-                _VSFILECHANGEFLAGS.VSFILECHG_Time)
+                _VSFILECHANGEFLAGS.VSFILECHG_Time)
 
     // Advise on file changes...
-    let cookie = Com.ThrowOnFailure1(vsFileWatch.AdviseFileChange(file, fileChangeFlags, changeEvents))
+    let cookie = Com.ThrowOnFailure1(vsFileWatch.AdviseFileChange(file, fileChangeFlags, changeEvents))
 
-    ...
+    ...
     
-    // Unadvise file changes...
-    Com.ThrowOnFailure0(vsFileWatch.UnadviseFileChange(cookie))
+    // Unadvised file changes...
+    Com.ThrowOnFailure0(vsFileWatch.UnadviseFileChange(cookie))
    -
    val vsFileWatch : obj

    Full name: react.vsFileWatch
    -
    val typeof<'T> : System.Type

    Full name: Microsoft.FSharp.Core.Operators.typeof
    -
    val fileChangeFlags : uint32

    Full name: react.fileChangeFlags
    -
    Multiple items
    val uint32 : value:'T -> uint32 (requires member op_Explicit)

    Full name: Microsoft.FSharp.Core.Operators.uint32

    --------------------
    type uint32 = System.UInt32

    Full name: Microsoft.FSharp.Core.uint32
    -
    val cookie : obj

    Full name: react.cookie
    +
    val vsFileWatch : obj
    +
    val typeof<'T> : System.Type
    +
    val fileChangeFlags : uint32
    +
    Multiple items
    val uint32 : value:'T -> uint32 (requires member op_Explicit)

    --------------------
    type uint32 = System.UInt32
    +
    val cookie : obj

    @@ -139,10 +138,10 @@

    Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -171,6 +170,6 @@

    Fork me on GitHub + Fork me on GitHub diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilalignment.html b/docs/reference/fsharp-compiler-abstractil-il-ilalignment.html deleted file mode 100644 index 366cfb72a8..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilalignment.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ILAlignment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILAlignment

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Aligned - -
    - Signature:
    -
    -     		- -
    - - - Unaligned1 - -
    - Signature:
    -
    -     		- -
    - - - Unaligned2 - -
    - Signature:
    -
    -     		- -
    - - - Unaligned4 - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilargconvention.html b/docs/reference/fsharp-compiler-abstractil-il-ilargconvention.html deleted file mode 100644 index 08e2c9fb23..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilargconvention.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - ILArgConvention - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILArgConvention

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - CDecl - -
    - Signature:
    -
    -     		- -
    - - - Default - -
    - Signature:
    -
    -     		- -
    - - - FastCall - -
    - Signature:
    -
    -     		- -
    - - - StdCall - -
    - Signature:
    -
    -     		- -
    - - - ThisCall - -
    - Signature:
    -
    -     		- -
    - - - VarArg - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilarraybound.html b/docs/reference/fsharp-compiler-abstractil-il-ilarraybound.html deleted file mode 100644 index bc315c3edc..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilarraybound.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - ILArrayBound - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILArrayBound

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Array shapes. For most purposes the rank is the only thing that matters.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - IsNone - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsNone

    -
    - - - IsSome - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSome

    -
    - - - Value - -
    - Signature: int32
    -
    -     		- -

    CompiledName: get_Value

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - None - -
    - Signature: int32 option
    -
    -     		- -

    CompiledName: get_None

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilarraybounds.html b/docs/reference/fsharp-compiler-abstractil-il-ilarraybounds.html deleted file mode 100644 index 15defa8f7a..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilarraybounds.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ILArrayBounds - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILArrayBounds

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Lower-bound/size pairs

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilarrayshape.html b/docs/reference/fsharp-compiler-abstractil-il-ilarrayshape.html deleted file mode 100644 index 4f8e860424..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilarrayshape.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - ILArrayShape - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILArrayShape

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - ILArrayShape(ILArrayBounds list) - -
    - Signature: ILArrayBounds list
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Rank - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Rank

    -
    -

    Static members

    - - - - - - - - - - - - - - -
    Static memberDescription
    - - - FromRank(arg1) - -
    - Signature: int -> ILArrayShape
    -
    -     		- -
    - - - SingleDimensional - -
    - Signature: ILArrayShape
    -
    -     		-

    Bounds for a single dimensional, zero based array

    - - -

    CompiledName: get_SingleDimensional

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilassemblylongevity.html b/docs/reference/fsharp-compiler-abstractil-il-ilassemblylongevity.html deleted file mode 100644 index 8990db5c41..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilassemblylongevity.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - ILAssemblyLongevity - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILAssemblyLongevity

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Library - -
    - Signature:
    -
    -     		- -
    - - - PlatformAppDomain - -
    - Signature:
    -
    -     		- -
    - - - PlatformProcess - -
    - Signature:
    -
    -     		- -
    - - - PlatformSystem - -
    - Signature:
    -
    -     		- -
    - - - Unspecified - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilassemblymanifest.html b/docs/reference/fsharp-compiler-abstractil-il-ilassemblymanifest.html deleted file mode 100644 index 6b417fde64..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilassemblymanifest.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - ILAssemblyManifest - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILAssemblyManifest

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    The main module of an assembly is a module plus some manifest information.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - AssemblyLongevity - -
    - Signature: ILAssemblyLongevity
    -
    -     		- -
    - - - AuxModuleHashAlgorithm - -
    - Signature: int32
    -
    -     		-

    This is the ID of the algorithm used for the hashes of auxiliary -files in the assembly. These hashes are stored in the -ILModuleRef.Hash fields of this assembly. These are not -cryptographic hashes: they are simple file hashes. The algorithm -is normally 0x00008004 indicating the SHA1 hash algorithm.

    - - -
    - - - CustomAttrsStored - -
    - Signature: ILAttributesStored
    -
    -     		- -
    - - - DisableJitOptimizations - -
    - Signature: bool
    -
    -     		- -
    - - - EntrypointElsewhere - -
    - Signature: ILModuleRef option
    -
    -     		-

    Records whether the entrypoint resides in another module.

    - - -
    - - - ExportedTypes - -
    - Signature: ILExportedTypesAndForwarders
    -
    -     		-

    Records the types implemented by this assembly in auxiliary -modules.

    - - -
    - - - IgnoreSymbolStoreSequencePoints - -
    - Signature: bool
    -
    -     		- -
    - - - JitTracking - -
    - Signature: bool
    -
    -     		- -
    - - - Locale - -
    - Signature: string option
    -
    -     		- -
    - - - MetadataIndex - -
    - Signature: int32
    -
    -     		- -
    - - - Name - -
    - Signature: string
    -
    -     		- -
    - - - PublicKey - -
    - Signature: byte [] option
    -
    -     		-

    This is the public key used to sign this -assembly (the signature itself is stored elsewhere: see the -binary format, and may not have been written if delay signing -is used). (member Name, member PublicKey) forms the full -public name of the assembly.

    - - -
    - - - Retargetable - -
    - Signature: bool
    -
    -     		- -
    - - - SecurityDeclsStored - -
    - Signature: ILSecurityDeclsStored
    -
    -     		- -
    - - - Version - -
    - Signature: ILVersionInfo option
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - SecurityDecls - -
    - Signature: ILSecurityDecls
    -
    -     		- -

    CompiledName: get_SecurityDecls

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilassemblyref.html b/docs/reference/fsharp-compiler-abstractil-il-ilassemblyref.html deleted file mode 100644 index e3ee964aed..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilassemblyref.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - ILAssemblyRef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILAssemblyRef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Hash - -
    - Signature: byte [] option
    -
    -     		- -

    CompiledName: get_Hash

    -
    - - - Locale - -
    - Signature: string option
    -
    -     		- -

    CompiledName: get_Locale

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - - - PublicKey - -
    - Signature: PublicKey option
    -
    -     		- -

    CompiledName: get_PublicKey

    -
    - - - QualifiedName - -
    - Signature: string
    -
    -     		-

    The fully qualified name of the assembly reference, e.g. mscorlib, Version=1.0.3705 etc.

    - - -

    CompiledName: get_QualifiedName

    -
    - - - Retargetable - -
    - Signature: bool
    -
    -     		-

    CLI says this indicates if the assembly can be retargeted (at runtime) to be from a different publisher.

    - - -

    CompiledName: get_Retargetable

    -
    - - - Version - -
    - Signature: ILVersionInfo option
    -
    -     		- -

    CompiledName: get_Version

    -
    -

    Static members

    - - - - - - - - - - - - - - -
    Static memberDescription
    - - - Create(...) - -
    - Signature: (name:string * hash:byte [] option * publicKey:PublicKey option * retargetable:bool * version:ILVersionInfo option * locale:string option) -> ILAssemblyRef
    -
    -     		- -
    - - - FromAssemblyName(arg1) - -
    - Signature: AssemblyName -> ILAssemblyRef
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattribelem.html b/docs/reference/fsharp-compiler-abstractil-il-ilattribelem.html deleted file mode 100644 index d8060be27d..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilattribelem.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - ILAttribElem - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILAttribElem

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Array(ILType,ILAttribElem list) - -
    - Signature: ILType * ILAttribElem list
    -
    -     		- -
    - - - Bool(bool) - -
    - Signature: bool
    -
    -     		- -
    - - - Byte(byte) - -
    - Signature: byte
    -
    -     		- -
    - - - Char(char) - -
    - Signature: char
    -
    -     		- -
    - - - Double(double) - -
    - Signature: double
    -
    -     		- -
    - - - Int16(int16) - -
    - Signature: int16
    -
    -     		- -
    - - - Int32(int32) - -
    - Signature: int32
    -
    -     		- -
    - - - Int64(int64) - -
    - Signature: int64
    -
    -     		- -
    - - - Null - -
    - Signature:
    -
    -     		- -
    - - - SByte(sbyte) - -
    - Signature: sbyte
    -
    -     		- -
    - - - Single(single) - -
    - Signature: single
    -
    -     		- -
    - - - String(string option) - -
    - Signature: string option
    -
    -     		-

    Represents a custom attribute parameter of type 'string'. These may be null, in which case they are encoded in a special -way as indicated by Ecma-335 Partition II.

    - - -
    - - - Type(ILType option) - -
    - Signature: ILType option
    -
    -     		- -
    - - - TypeRef(ILTypeRef option) - -
    - Signature: ILTypeRef option
    -
    -     		- -
    - - - UInt16(uint16) - -
    - Signature: uint16
    -
    -     		- -
    - - - UInt32(uint32) - -
    - Signature: uint32
    -
    -     		- -
    - - - UInt64(uint64) - -
    - Signature: uint64
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattribute.html b/docs/reference/fsharp-compiler-abstractil-il-ilattribute.html deleted file mode 100644 index f998a45ed3..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilattribute.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - ILAttribute - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILAttribute

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Custom attribute.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Decoded(method,fixedArgs,namedArgs) - -
    - Signature: ILMethodSpec * ILAttribElem list * ILAttributeNamedArg list
    -
    -     		-

    Attribute with args in decoded form.

    - - -
    - - - Encoded(method,data,elements) - -
    - Signature: ILMethodSpec * byte [] * ILAttribElem list
    -
    -     		-

    Attribute with args encoded to a binary blob according to ECMA-335 II.21 and II.23.3. -'decodeILAttribData' is used to parse the byte[] blob to ILAttribElem's as best as possible.

    - - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Elements - -
    - Signature: ILAttribElem list
    -
    -     		-

    Decoded arguments. May be empty in encoded attribute form.

    - - -

    CompiledName: get_Elements

    -
    - - - Method - -
    - Signature: ILMethodSpec
    -
    -     		-

    Attribute instance constructor.

    - - -

    CompiledName: get_Method

    -
    - - - WithMethod(method) - -
    - Signature: method:ILMethodSpec -> ILAttribute
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattributenamedarg.html b/docs/reference/fsharp-compiler-abstractil-il-ilattributenamedarg.html deleted file mode 100644 index 9ba1fc53ae..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilattributenamedarg.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ILAttributeNamedArg - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILAttributeNamedArg

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Named args: values and flags indicating if they are fields or properties.

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattributes.html b/docs/reference/fsharp-compiler-abstractil-il-ilattributes.html deleted file mode 100644 index 705caf1bc8..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilattributes.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - ILAttributes - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILAttributes

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AsArray - -
    - Signature: ILAttribute []
    -
    -     		- -

    CompiledName: get_AsArray

    -
    - - - AsList - -
    - Signature: ILAttribute list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattributesstored.html b/docs/reference/fsharp-compiler-abstractil-il-ilattributesstored.html deleted file mode 100644 index e03bef295a..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilattributesstored.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ILAttributesStored - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILAttributesStored

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Represents the efficiency-oriented storage of ILAttributes in another item.

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilbasictype.html b/docs/reference/fsharp-compiler-abstractil-il-ilbasictype.html deleted file mode 100644 index d6912b6862..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilbasictype.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - ILBasicType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILBasicType

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - DT_I - -
    - Signature:
    -
    -     		- -
    - - - DT_I1 - -
    - Signature:
    -
    -     		- -
    - - - DT_I2 - -
    - Signature:
    -
    -     		- -
    - - - DT_I4 - -
    - Signature:
    -
    -     		- -
    - - - DT_I8 - -
    - Signature:
    -
    -     		- -
    - - - DT_R - -
    - Signature:
    -
    -     		- -
    - - - DT_R4 - -
    - Signature:
    -
    -     		- -
    - - - DT_R8 - -
    - Signature:
    -
    -     		- -
    - - - DT_REF - -
    - Signature:
    -
    -     		- -
    - - - DT_U - -
    - Signature:
    -
    -     		- -
    - - - DT_U1 - -
    - Signature:
    -
    -     		- -
    - - - DT_U2 - -
    - Signature:
    -
    -     		- -
    - - - DT_U4 - -
    - Signature:
    -
    -     		- -
    - - - DT_U8 - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilboxity.html b/docs/reference/fsharp-compiler-abstractil-il-ilboxity.html deleted file mode 100644 index e0d8c05987..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilboxity.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ILBoxity - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILBoxity

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AsObject - -
    - Signature:
    -
    -     		- -
    - - - AsValue - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcallingconv.html b/docs/reference/fsharp-compiler-abstractil-il-ilcallingconv.html deleted file mode 100644 index b7cda60df5..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilcallingconv.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - ILCallingConv - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILCallingConv

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - Callconv(...) - -
    - Signature: ILThisConvention * ILArgConvention
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - BasicConv - -
    - Signature: ILArgConvention
    -
    -     		- -

    CompiledName: get_BasicConv

    -
    - - - IsInstance - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsInstance

    -
    - - - IsInstanceExplicit - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsInstanceExplicit

    -
    - - - IsStatic - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsStatic

    -
    - - - ThisConv - -
    - Signature: ILThisConvention
    -
    -     		- -

    CompiledName: get_ThisConv

    -
    -

    Static members

    - - - - - - - - - - - - - - -
    Static memberDescription
    - - - Instance - -
    - Signature: ILCallingConv
    -
    -     		- -

    CompiledName: get_Instance

    -
    - - - Static - -
    - Signature: ILCallingConv
    -
    -     		- -

    CompiledName: get_Static

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcallingsignature.html b/docs/reference/fsharp-compiler-abstractil-il-ilcallingsignature.html deleted file mode 100644 index bff7ee8c17..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilcallingsignature.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - ILCallingSignature - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILCallingSignature

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - ArgTypes - -
    - Signature: ILTypes
    -
    -     		- -
    - - - CallingConv - -
    - Signature: ILCallingConv
    -
    -     		- -
    - - - ReturnType - -
    - Signature: ILType
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcode.html b/docs/reference/fsharp-compiler-abstractil-il-ilcode.html deleted file mode 100644 index 8e886b8a39..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilcode.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ILCode - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILCode

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Exceptions - -
    - Signature: ILExceptionSpec list
    -
    -     		- -
    - - - Instrs - -
    - Signature: ILInstr []
    -
    -     		- -
    - - - Labels - -
    - Signature: Dictionary<ILCodeLabel,int>
    -
    -     		- -
    - - - Locals - -
    - Signature: ILLocalDebugInfo list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcodelabel.html b/docs/reference/fsharp-compiler-abstractil-il-ilcodelabel.html deleted file mode 100644 index e0636e9d49..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilcodelabel.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ILCodeLabel - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILCodeLabel

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    ILCode labels. In structured code each code label refers to a basic block somewhere in the code of the method.

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcomparisoninstr.html b/docs/reference/fsharp-compiler-abstractil-il-ilcomparisoninstr.html deleted file mode 100644 index 0b8715a874..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilcomparisoninstr.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - ILComparisonInstr - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILComparisonInstr

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - BI_beq - -
    - Signature:
    -
    -     		- -
    - - - BI_bge - -
    - Signature:
    -
    -     		- -
    - - - BI_bge_un - -
    - Signature:
    -
    -     		- -
    - - - BI_bgt - -
    - Signature:
    -
    -     		- -
    - - - BI_bgt_un - -
    - Signature:
    -
    -     		- -
    - - - BI_ble - -
    - Signature:
    -
    -     		- -
    - - - BI_ble_un - -
    - Signature:
    -
    -     		- -
    - - - BI_blt - -
    - Signature:
    -
    -     		- -
    - - - BI_blt_un - -
    - Signature:
    -
    -     		- -
    - - - BI_bne_un - -
    - Signature:
    -
    -     		- -
    - - - BI_brfalse - -
    - Signature:
    -
    -     		- -
    - - - BI_brtrue - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilconst.html b/docs/reference/fsharp-compiler-abstractil-il-ilconst.html deleted file mode 100644 index 06560eb2ed..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilconst.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ILConst - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILConst

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - I4(int32) - -
    - Signature: int32
    -
    -     		- -
    - - - I8(int64) - -
    - Signature: int64
    -
    -     		- -
    - - - R4(single) - -
    - Signature: single
    -
    -     		- -
    - - - R8(double) - -
    - Signature: double
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ildefaultpinvokeencoding.html b/docs/reference/fsharp-compiler-abstractil-il-ildefaultpinvokeencoding.html deleted file mode 100644 index 3d5866aba3..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ildefaultpinvokeencoding.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ILDefaultPInvokeEncoding - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILDefaultPInvokeEncoding

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Default Unicode encoding for P/Invoke within a type.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Ansi - -
    - Signature:
    -
    -     		- -
    - - - Auto - -
    - Signature:
    -
    -     		- -
    - - - Unicode - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilenuminfo.html b/docs/reference/fsharp-compiler-abstractil-il-ilenuminfo.html deleted file mode 100644 index 335a21f5fa..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilenuminfo.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - ILEnumInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILEnumInfo

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Decompose a type definition according to its kind.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - enumType - -
    - Signature: ILType
    -
    -     		- -
    - - - enumValues - -
    - Signature: (string * ILFieldInit) list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ileventdef.html b/docs/reference/fsharp-compiler-abstractil-il-ileventdef.html deleted file mode 100644 index a150be41eb..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ileventdef.html +++ /dev/null @@ -1,313 +0,0 @@ - - - - - ILEventDef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILEventDef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Event definitions.

    - -
    -

    Constructors

    - - - - - - - - - - - - - - -
    ConstructorDescription
    - - - new(...) - -
    - Signature: (eventType:ILType option * name:string * attributes:EventAttributes * addMethod:ILMethodRef * removeMethod:ILMethodRef * fireMethod:ILMethodRef option * otherMethods:ILMethodRef list * customAttrs:ILAttributes) -> ILEventDef
    -
    -     		-

    Functional creation of a value, immediate

    - - -

    CompiledName: .ctor

    -
    - - - new(...) - -
    - Signature: (eventType:ILType option * name:string * attributes:EventAttributes * addMethod:ILMethodRef * removeMethod:ILMethodRef * fireMethod:ILMethodRef option * otherMethods:ILMethodRef list * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILEventDef
    -
    -     		-

    Functional creation of a value, using delayed reading via a metadata index, for ilread.fs

    - - -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AddMethod - -
    - Signature: ILMethodRef
    -
    -     		- -

    CompiledName: get_AddMethod

    -
    - - - Attributes - -
    - Signature: EventAttributes
    -
    -     		- -

    CompiledName: get_Attributes

    -
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - EventType - -
    - Signature: ILType option
    -
    -     		- -

    CompiledName: get_EventType

    -
    - - - FireMethod - -
    - Signature: ILMethodRef option
    -
    -     		- -

    CompiledName: get_FireMethod

    -
    - - - IsRTSpecialName - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsRTSpecialName

    -
    - - - IsSpecialName - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSpecialName

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - - - OtherMethods - -
    - Signature: ILMethodRef list
    -
    -     		- -

    CompiledName: get_OtherMethods

    -
    - - - RemoveMethod - -
    - Signature: ILMethodRef
    -
    -     		- -

    CompiledName: get_RemoveMethod

    -
    - - - With(...) - -
    - Signature: (eventType:ILType option option * name:string option * attributes:EventAttributes option * addMethod:ILMethodRef option * removeMethod:ILMethodRef option * fireMethod:ILMethodRef option option * otherMethods:ILMethodRef list option * customAttrs:ILAttributes option) -> ILEventDef
    -
    -     		-

    Functional update of the value

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ileventdefs.html b/docs/reference/fsharp-compiler-abstractil-il-ileventdefs.html deleted file mode 100644 index 19a628b253..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ileventdefs.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - ILEventDefs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILEventDefs

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Table of those events in a type definition.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AsList - -
    - Signature: ILEventDef list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - - - LookupByName(arg1) - -
    - Signature: string -> ILEventDef list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ileventref.html b/docs/reference/fsharp-compiler-abstractil-il-ileventref.html deleted file mode 100644 index e62f6cc3de..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ileventref.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - ILEventRef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILEventRef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    A utility type provided for completeness

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DeclaringTypeRef - -
    - Signature: ILTypeRef
    -
    -     		- -

    CompiledName: get_DeclaringTypeRef

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Create(arg1, arg2) - -
    - Signature: (ILTypeRef * string) -> ILEventRef
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilexceptionclause.html b/docs/reference/fsharp-compiler-abstractil-il-ilexceptionclause.html deleted file mode 100644 index 8d7e6c1665..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilexceptionclause.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ILExceptionClause - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILExceptionClause

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Fault(ILCodeLabel * ILCodeLabel) - -
    - Signature: ILCodeLabel * ILCodeLabel
    -
    -     		- -
    - - - FilterCatch(...) - -
    - Signature: ILCodeLabel * ILCodeLabel * ILCodeLabel * ILCodeLabel
    -
    -     		- -
    - - - Finally(ILCodeLabel * ILCodeLabel) - -
    - Signature: ILCodeLabel * ILCodeLabel
    -
    -     		- -
    - - - TypeCatch(...) - -
    - Signature: ILType * ILCodeLabel * ILCodeLabel
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilexceptionspec.html b/docs/reference/fsharp-compiler-abstractil-il-ilexceptionspec.html deleted file mode 100644 index 3adc0e9703..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilexceptionspec.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ILExceptionSpec - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILExceptionSpec

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Clause - -
    - Signature: ILExceptionClause
    -
    -     		- -
    - - - Range - -
    - Signature: ILCodeLabel * ILCodeLabel
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypeorforwarder.html b/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypeorforwarder.html deleted file mode 100644 index d8d8a1ed18..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypeorforwarder.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - ILExportedTypeOrForwarder - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILExportedTypeOrForwarder

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    these are only found in the ILExportedTypesAndForwarders table in the manifest

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Attributes - -
    - Signature: TypeAttributes
    -
    -     		- -
    - - - CustomAttrsStored - -
    - Signature: ILAttributesStored
    -
    -     		- -
    - - - MetadataIndex - -
    - Signature: int32
    -
    -     		- -
    - - - Name - -
    - Signature: string
    -
    -     		-

    [Namespace.]Name

    - - -
    - - - Nested - -
    - Signature: ILNestedExportedTypes
    -
    -     		- -
    - - - ScopeRef - -
    - Signature: ILScopeRef
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Access - -
    - Signature: ILTypeDefAccess
    -
    -     		- -

    CompiledName: get_Access

    -
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - IsForwarder - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsForwarder

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypesandforwarders.html b/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypesandforwarders.html deleted file mode 100644 index ba69b9b746..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypesandforwarders.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - ILExportedTypesAndForwarders - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILExportedTypesAndForwarders

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - AsList - -
    - Signature: ILExportedTypeOrForwarder list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfielddef.html b/docs/reference/fsharp-compiler-abstractil-il-ilfielddef.html deleted file mode 100644 index e1947bf966..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilfielddef.html +++ /dev/null @@ -1,473 +0,0 @@ - - - - - ILFieldDef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILFieldDef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Field definitions.

    - -
    -

    Constructors

    - - - - - - - - - - - - - - -
    ConstructorDescription
    - - - new(...) - -
    - Signature: (name:string * fieldType:ILType * attributes:FieldAttributes * data:byte [] option * literalValue:ILFieldInit option * offset:int32 option * marshal:ILNativeType option * customAttrs:ILAttributes) -> ILFieldDef
    -
    -     		-

    Functional creation of a value, immediate

    - - -

    CompiledName: .ctor

    -
    - - - new(...) - -
    - Signature: (name:string * fieldType:ILType * attributes:FieldAttributes * data:byte [] option * literalValue:ILFieldInit option * offset:int32 option * marshal:ILNativeType option * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILFieldDef
    -
    -     		-

    Functional creation of a value using delayed reading via a metadata index

    - - -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Access - -
    - Signature: ILMemberAccess
    -
    -     		- -

    CompiledName: get_Access

    -
    - - - Attributes - -
    - Signature: FieldAttributes
    -
    -     		- -

    CompiledName: get_Attributes

    -
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - Data - -
    - Signature: byte [] option
    -
    -     		- -

    CompiledName: get_Data

    -
    - - - FieldType - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_FieldType

    -
    - - - IsInitOnly - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsInitOnly

    -
    - - - IsLiteral - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsLiteral

    -
    - - - IsSpecialName - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSpecialName

    -
    - - - IsStatic - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsStatic

    -
    - - - LiteralValue - -
    - Signature: ILFieldInit option
    -
    -     		- -

    CompiledName: get_LiteralValue

    -
    - - - Marshal - -
    - Signature: ILNativeType option
    -
    -     		- -

    CompiledName: get_Marshal

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - - - NotSerialized - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_NotSerialized

    -
    - - - Offset - -
    - Signature: int32 option
    -
    -     		-

    The explicit offset in bytes when explicit layout is used.

    - - -

    CompiledName: get_Offset

    -
    - - - With(...) - -
    - Signature: (name:string option * fieldType:ILType option * attributes:FieldAttributes option * data:byte [] option option * literalValue:ILFieldInit option option * offset:int32 option option * marshal:ILNativeType option option * customAttrs:ILAttributes option) -> ILFieldDef
    -
    -     		-

    Functional update of the value

    - - -
    - - - WithAccess(arg1) - -
    - Signature: ILMemberAccess -> ILFieldDef
    -
    -     		- -
    - - - WithFieldMarshal(arg1) - -
    - Signature: (ILNativeType option) -> ILFieldDef
    -
    -     		- -
    - - - WithInitOnly(arg1) - -
    - Signature: bool -> ILFieldDef
    -
    -     		- -
    - - - WithLiteralDefaultValue(arg1) - -
    - Signature: (ILFieldInit option) -> ILFieldDef
    -
    -     		- -
    - - - WithNotSerialized(arg1) - -
    - Signature: bool -> ILFieldDef
    -
    -     		- -
    - - - WithSpecialName(arg1) - -
    - Signature: bool -> ILFieldDef
    -
    -     		- -
    - - - WithStatic(arg1) - -
    - Signature: bool -> ILFieldDef
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfielddefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilfielddefs.html deleted file mode 100644 index 0e45b763c4..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilfielddefs.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - ILFieldDefs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILFieldDefs

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Tables of fields. Logically equivalent to a list of fields but the table is kept in -a form to allow efficient looking up fields by name.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AsList - -
    - Signature: ILFieldDef list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - - - LookupByName(arg1) - -
    - Signature: string -> ILFieldDef list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfieldinit.html b/docs/reference/fsharp-compiler-abstractil-il-ilfieldinit.html deleted file mode 100644 index 90dfb421d1..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilfieldinit.html +++ /dev/null @@ -1,301 +0,0 @@ - - - - - ILFieldInit - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILFieldInit

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Field Init

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Bool(bool) - -
    - Signature: bool
    -
    -     		- -
    - - - Char(uint16) - -
    - Signature: uint16
    -
    -     		- -
    - - - Double(double) - -
    - Signature: double
    -
    -     		- -
    - - - Int16(int16) - -
    - Signature: int16
    -
    -     		- -
    - - - Int32(int32) - -
    - Signature: int32
    -
    -     		- -
    - - - Int64(int64) - -
    - Signature: int64
    -
    -     		- -
    - - - Int8(sbyte) - -
    - Signature: sbyte
    -
    -     		- -
    - - - Null - -
    - Signature:
    -
    -     		- -
    - - - Single(single) - -
    - Signature: single
    -
    -     		- -
    - - - String(string) - -
    - Signature: string
    -
    -     		- -
    - - - UInt16(uint16) - -
    - Signature: uint16
    -
    -     		- -
    - - - UInt32(uint32) - -
    - Signature: uint32
    -
    -     		- -
    - - - UInt64(uint64) - -
    - Signature: uint64
    -
    -     		- -
    - - - UInt8(byte) - -
    - Signature: byte
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfieldref.html b/docs/reference/fsharp-compiler-abstractil-il-ilfieldref.html deleted file mode 100644 index 3f9913accc..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilfieldref.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ILFieldRef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILFieldRef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Formal identities of fields.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - DeclaringTypeRef - -
    - Signature: ILTypeRef
    -
    -     		- -
    - - - Name - -
    - Signature: string
    -
    -     		- -
    - - - Type - -
    - Signature: ILType
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfieldspec.html b/docs/reference/fsharp-compiler-abstractil-il-ilfieldspec.html deleted file mode 100644 index c6f5386294..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilfieldspec.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - ILFieldSpec - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILFieldSpec

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Field specs. The data given for a ldfld, stfld etc. instruction.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - DeclaringType - -
    - Signature: ILType
    -
    -     		- -
    - - - FieldRef - -
    - Signature: ILFieldRef
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - ActualType - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_ActualType

    -
    - - - DeclaringTypeRef - -
    - Signature: ILTypeRef
    -
    -     		- -

    CompiledName: get_DeclaringTypeRef

    -
    - - - FormalType - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_FormalType

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericargs.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericargs.html deleted file mode 100644 index 01a0d2ab69..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilgenericargs.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - ILGenericArgs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILGenericArgs

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Actual generic parameters are always types.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> ILType
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: ILType list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: ILType list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericargslist.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericargslist.html deleted file mode 100644 index 2e37c24157..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilgenericargslist.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - ILGenericArgsList - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILGenericArgsList

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> ILType
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: ILType list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: ILType list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdef.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdef.html deleted file mode 100644 index 9ae25aee74..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdef.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - ILGenericParameterDef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILGenericParameterDef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Generic parameters. Formal generic parameter declarations may include the bounds, if any, on the generic parameter.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Constraints - -
    - Signature: ILTypes
    -
    -     		-

    At most one is the parent type, the others are interface types.

    - - -
    - - - CustomAttrsStored - -
    - Signature: ILAttributesStored
    -
    -     		-

    Do not use this

    - - -
    - - - HasDefaultConstructorConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates the type argument must have a public nullary constructor.

    - - -
    - - - HasNotNullableValueTypeConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates the type argument must be a value type, but not Nullable.

    - - -
    - - - HasReferenceTypeConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates the type argument must be a reference type.

    - - -
    - - - MetadataIndex - -
    - Signature: int32
    -
    -     		-

    Do not use this

    - - -
    - - - Name - -
    - Signature: string
    -
    -     		- -
    - - - Variance - -
    - Signature: ILGenericVariance
    -
    -     		-

    Variance of type parameters, only applicable to generic parameters for generic interfaces and delegates.

    - - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdefs.html deleted file mode 100644 index 8bac81fe28..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdefs.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - ILGenericParameterDefs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILGenericParameterDefs

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: ILGenericParameterDef
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> ILGenericParameterDef
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: ILGenericParameterDef list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: ILGenericParameterDef list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericvariance.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericvariance.html deleted file mode 100644 index c5f8123225..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilgenericvariance.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - ILGenericVariance - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILGenericVariance

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ContraVariant - -
    - Signature:
    -
    -     		- -
    - - - CoVariant - -
    - Signature:
    -
    -     		- -
    - - - NonVariant - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilglobals.html b/docs/reference/fsharp-compiler-abstractil-il-ilglobals.html deleted file mode 100644 index b7c69d8f5a..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilglobals.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - ILGlobals - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILGlobals

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    A table of common references to items in primary assembly (System.Runtime or mscorlib). -If a particular version of System.Runtime.dll has been loaded then you should -reference items from it via an ILGlobals for that specific version built using mkILGlobals.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - primaryAssemblyName - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_primaryAssemblyName

    -
    - - - primaryAssemblyScopeRef - -
    - Signature: ILScopeRef
    -
    -     		- -

    CompiledName: get_primaryAssemblyScopeRef

    -
    - - - typ_Array - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Array

    -
    - - - typ_Bool - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Bool

    -
    - - - typ_Byte - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Byte

    -
    - - - typ_Char - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Char

    -
    - - - typ_Double - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Double

    -
    - - - typ_Int16 - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Int16

    -
    - - - typ_Int32 - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Int32

    -
    - - - typ_Int64 - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Int64

    -
    - - - typ_IntPtr - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_IntPtr

    -
    - - - typ_Object - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Object

    -
    - - - typ_SByte - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_SByte

    -
    - - - typ_Single - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Single

    -
    - - - typ_String - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_String

    -
    - - - typ_Type - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_Type

    -
    - - - typ_UInt16 - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_UInt16

    -
    - - - typ_UInt32 - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_UInt32

    -
    - - - typ_UInt64 - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_UInt64

    -
    - - - typ_UIntPtr - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_typ_UIntPtr

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilguid.html b/docs/reference/fsharp-compiler-abstractil-il-ilguid.html deleted file mode 100644 index 5c87f21852..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilguid.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ILGuid - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILGuid

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Represents guids

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilinstr.html b/docs/reference/fsharp-compiler-abstractil-il-ilinstr.html deleted file mode 100644 index 6a05ec052b..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilinstr.html +++ /dev/null @@ -1,1449 +0,0 @@ - - - - - ILInstr - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILInstr

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    The instruction set.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AI_add - -
    - Signature:
    -
    -     		- -
    - - - AI_add_ovf - -
    - Signature:
    -
    -     		- -
    - - - AI_add_ovf_un - -
    - Signature:
    -
    -     		- -
    - - - AI_and - -
    - Signature:
    -
    -     		- -
    - - - AI_ceq - -
    - Signature:
    -
    -     		- -
    - - - AI_cgt - -
    - Signature:
    -
    -     		- -
    - - - AI_cgt_un - -
    - Signature:
    -
    -     		- -
    - - - AI_ckfinite - -
    - Signature:
    -
    -     		- -
    - - - AI_clt - -
    - Signature:
    -
    -     		- -
    - - - AI_clt_un - -
    - Signature:
    -
    -     		- -
    - - - AI_conv(ILBasicType) - -
    - Signature: ILBasicType
    -
    -     		- -
    - - - AI_conv_ovf(ILBasicType) - -
    - Signature: ILBasicType
    -
    -     		- -
    - - - AI_conv_ovf_un(ILBasicType) - -
    - Signature: ILBasicType
    -
    -     		- -
    - - - AI_div - -
    - Signature:
    -
    -     		- -
    - - - AI_div_un - -
    - Signature:
    -
    -     		- -
    - - - AI_dup - -
    - Signature:
    -
    -     		- -
    - - - AI_ldc(ILBasicType,ILConst) - -
    - Signature: ILBasicType * ILConst
    -
    -     		- -
    - - - AI_ldnull - -
    - Signature:
    -
    -     		- -
    - - - AI_mul - -
    - Signature:
    -
    -     		- -
    - - - AI_mul_ovf - -
    - Signature:
    -
    -     		- -
    - - - AI_mul_ovf_un - -
    - Signature:
    -
    -     		- -
    - - - AI_neg - -
    - Signature:
    -
    -     		- -
    - - - AI_nop - -
    - Signature:
    -
    -     		- -
    - - - AI_not - -
    - Signature:
    -
    -     		- -
    - - - AI_or - -
    - Signature:
    -
    -     		- -
    - - - AI_pop - -
    - Signature:
    -
    -     		- -
    - - - AI_rem - -
    - Signature:
    -
    -     		- -
    - - - AI_rem_un - -
    - Signature:
    -
    -     		- -
    - - - AI_shl - -
    - Signature:
    -
    -     		- -
    - - - AI_shr - -
    - Signature:
    -
    -     		- -
    - - - AI_shr_un - -
    - Signature:
    -
    -     		- -
    - - - AI_sub - -
    - Signature:
    -
    -     		- -
    - - - AI_sub_ovf - -
    - Signature:
    -
    -     		- -
    - - - AI_sub_ovf_un - -
    - Signature:
    -
    -     		- -
    - - - AI_xor - -
    - Signature:
    -
    -     		- -
    - - - EI_ilzero(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - EI_ldlen_multi(int32,int32) - -
    - Signature: int32 * int32
    -
    -     		- -
    - - - I_arglist - -
    - Signature:
    -
    -     		- -
    - - - I_box(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - I_br(ILCodeLabel) - -
    - Signature: ILCodeLabel
    -
    -     		- -
    - - - I_brcmp(ILComparisonInstr,ILCodeLabel) - -
    - Signature: ILComparisonInstr * ILCodeLabel
    -
    -     		- -
    - - - I_break - -
    - Signature:
    -
    -     		- -
    - - - I_call(...) - -
    - Signature: ILTailcall * ILMethodSpec * ILVarArgs
    -
    -     		- -
    - - - I_callconstraint(...) - -
    - Signature: ILTailcall * ILType * ILMethodSpec * ILVarArgs
    -
    -     		- -
    - - - I_calli(...) - -
    - Signature: ILTailcall * ILCallingSignature * ILVarArgs
    -
    -     		- -
    - - - I_callvirt(...) - -
    - Signature: ILTailcall * ILMethodSpec * ILVarArgs
    -
    -     		- -
    - - - I_castclass(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - I_cpblk(ILAlignment,ILVolatility) - -
    - Signature: ILAlignment * ILVolatility
    -
    -     		- -
    - - - I_cpobj(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - I_endfilter - -
    - Signature:
    -
    -     		- -
    - - - I_endfinally - -
    - Signature:
    -
    -     		- -
    - - - I_initblk(ILAlignment,ILVolatility) - -
    - Signature: ILAlignment * ILVolatility
    -
    -     		- -
    - - - I_initobj(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - I_isinst(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - I_jmp(ILMethodSpec) - -
    - Signature: ILMethodSpec
    -
    -     		- -
    - - - I_ldarg(uint16) - -
    - Signature: uint16
    -
    -     		- -
    - - - I_ldarga(uint16) - -
    - Signature: uint16
    -
    -     		- -
    - - - I_ldelem(ILBasicType) - -
    - Signature: ILBasicType
    -
    -     		- -
    - - - I_ldelem_any(ILArrayShape,ILType) - -
    - Signature: ILArrayShape * ILType
    -
    -     		- -
    - - - I_ldelema(...) - -
    - Signature: ILReadonly * bool * ILArrayShape * ILType
    -
    -     		- -
    - - - I_ldfld(...) - -
    - Signature: ILAlignment * ILVolatility * ILFieldSpec
    -
    -     		- -
    - - - I_ldflda(ILFieldSpec) - -
    - Signature: ILFieldSpec
    -
    -     		- -
    - - - I_ldftn(ILMethodSpec) - -
    - Signature: ILMethodSpec
    -
    -     		- -
    - - - I_ldind(...) - -
    - Signature: ILAlignment * ILVolatility * ILBasicType
    -
    -     		- -
    - - - I_ldlen - -
    - Signature:
    -
    -     		- -
    - - - I_ldloc(uint16) - -
    - Signature: uint16
    -
    -     		- -
    - - - I_ldloca(uint16) - -
    - Signature: uint16
    -
    -     		- -
    - - - I_ldobj(ILAlignment,ILVolatility,ILType) - -
    - Signature: ILAlignment * ILVolatility * ILType
    -
    -     		- -
    - - - I_ldsfld(ILVolatility,ILFieldSpec) - -
    - Signature: ILVolatility * ILFieldSpec
    -
    -     		- -
    - - - I_ldsflda(ILFieldSpec) - -
    - Signature: ILFieldSpec
    -
    -     		- -
    - - - I_ldstr(string) - -
    - Signature: string
    -
    -     		- -
    - - - I_ldtoken(ILToken) - -
    - Signature: ILToken
    -
    -     		- -
    - - - I_ldvirtftn(ILMethodSpec) - -
    - Signature: ILMethodSpec
    -
    -     		- -
    - - - I_leave(ILCodeLabel) - -
    - Signature: ILCodeLabel
    -
    -     		- -
    - - - I_localloc - -
    - Signature:
    -
    -     		- -
    - - - I_mkrefany(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - I_newarr(ILArrayShape,ILType) - -
    - Signature: ILArrayShape * ILType
    -
    -     		- -
    - - - I_newobj(ILMethodSpec,ILVarArgs) - -
    - Signature: ILMethodSpec * ILVarArgs
    -
    -     		- -
    - - - I_refanytype - -
    - Signature:
    -
    -     		- -
    - - - I_refanyval(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - I_ret - -
    - Signature:
    -
    -     		- -
    - - - I_rethrow - -
    - Signature:
    -
    -     		- -
    - - - I_seqpoint(ILSourceMarker) - -
    - Signature: ILSourceMarker
    -
    -     		- -
    - - - I_sizeof(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - I_starg(uint16) - -
    - Signature: uint16
    -
    -     		- -
    - - - I_stelem(ILBasicType) - -
    - Signature: ILBasicType
    -
    -     		- -
    - - - I_stelem_any(ILArrayShape,ILType) - -
    - Signature: ILArrayShape * ILType
    -
    -     		- -
    - - - I_stfld(...) - -
    - Signature: ILAlignment * ILVolatility * ILFieldSpec
    -
    -     		- -
    - - - I_stind(...) - -
    - Signature: ILAlignment * ILVolatility * ILBasicType
    -
    -     		- -
    - - - I_stloc(uint16) - -
    - Signature: uint16
    -
    -     		- -
    - - - I_stobj(ILAlignment,ILVolatility,ILType) - -
    - Signature: ILAlignment * ILVolatility * ILType
    -
    -     		- -
    - - - I_stsfld(ILVolatility,ILFieldSpec) - -
    - Signature: ILVolatility * ILFieldSpec
    -
    -     		- -
    - - - I_switch(ILCodeLabel list) - -
    - Signature: ILCodeLabel list
    -
    -     		- -
    - - - I_throw - -
    - Signature:
    -
    -     		- -
    - - - I_unbox(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - - - I_unbox_any(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-illazymethodbody.html b/docs/reference/fsharp-compiler-abstractil-il-illazymethodbody.html deleted file mode 100644 index 991cbc1432..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-illazymethodbody.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - ILLazyMethodBody - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILLazyMethodBody

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Contents - -
    - Signature: MethodBody
    -
    -     		- -

    CompiledName: get_Contents

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocal.html b/docs/reference/fsharp-compiler-abstractil-il-illocal.html deleted file mode 100644 index 98706ccded..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-illocal.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ILLocal - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILLocal

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Local variables

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - DebugInfo - -
    - Signature: (string * int * int) option
    -
    -     		- -
    - - - IsPinned - -
    - Signature: bool
    -
    -     		- -
    - - - Type - -
    - Signature: ILType
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocaldebuginfo.html b/docs/reference/fsharp-compiler-abstractil-il-illocaldebuginfo.html deleted file mode 100644 index 5e59e660ae..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-illocaldebuginfo.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ILLocalDebugInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILLocalDebugInfo

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - DebugMappings - -
    - Signature: ILLocalDebugMapping list
    -
    -     		- -
    - - - Range - -
    - Signature: ILCodeLabel * ILCodeLabel
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocaldebugmapping.html b/docs/reference/fsharp-compiler-abstractil-il-illocaldebugmapping.html deleted file mode 100644 index 337427f764..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-illocaldebugmapping.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - ILLocalDebugMapping - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILLocalDebugMapping

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Indicates that a particular local variable has a particular source -language name within a given set of ranges. This does not effect local -variable numbering, which is global over the whole method.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - LocalIndex - -
    - Signature: int
    -
    -     		- -
    - - - LocalName - -
    - Signature: string
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocals.html b/docs/reference/fsharp-compiler-abstractil-il-illocals.html deleted file mode 100644 index ec022e4d91..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-illocals.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - ILLocals - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILLocals

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: ILLocal
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> ILLocal
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: ILLocal list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: ILLocal list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocalsallocator.html b/docs/reference/fsharp-compiler-abstractil-il-illocalsallocator.html deleted file mode 100644 index d533d46836..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-illocalsallocator.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - ILLocalsAllocator - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILLocalsAllocator

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Helpers for codegen: scopes for allocating new temporary variables.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(preAlloc) - -
    - Signature: preAlloc:int -> ILLocalsAllocator
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AllocLocal(arg1) - -
    - Signature: ILLocal -> uint16
    -
    -     		- -
    - - - Close() - -
    - Signature: unit -> ILLocal list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmemberaccess.html b/docs/reference/fsharp-compiler-abstractil-il-ilmemberaccess.html deleted file mode 100644 index cc86de545d..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmemberaccess.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - ILMemberAccess - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILMemberAccess

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Member Access

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Assembly - -
    - Signature:
    -
    -     		- -
    - - - CompilerControlled - -
    - Signature:
    -
    -     		- -
    - - - Family - -
    - Signature:
    -
    -     		- -
    - - - FamilyAndAssembly - -
    - Signature:
    -
    -     		- -
    - - - FamilyOrAssembly - -
    - Signature:
    -
    -     		- -
    - - - Private - -
    - Signature:
    -
    -     		- -
    - - - Public - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodbody.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodbody.html deleted file mode 100644 index 6f3263f826..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmethodbody.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - ILMethodBody - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILMethodBody

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    IL method bodies

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - AggressiveInlining - -
    - Signature: bool
    -
    -     		- -
    - - - Code - -
    - Signature: ILCode
    -
    -     		- -
    - - - IsZeroInit - -
    - Signature: bool
    -
    -     		- -
    - - - Locals - -
    - Signature: ILLocals
    -
    -     		- -
    - - - MaxStack - -
    - Signature: int32
    -
    -     		- -
    - - - NoInlining - -
    - Signature: bool
    -
    -     		- -
    - - - SourceMarker - -
    - Signature: ILSourceMarker option
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethoddef.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethoddef.html deleted file mode 100644 index e8f7dc97eb..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmethoddef.html +++ /dev/null @@ -1,1007 +0,0 @@ - - - - - ILMethodDef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILMethodDef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    IL Method definitions.

    - -
    -

    Constructors

    - - - - - - - - - - - - - - -
    ConstructorDescription
    - - - new(...) - -
    - Signature: (name:string * attributes:MethodAttributes * implAttributes:MethodImplAttributes * callingConv:ILCallingConv * parameters:ILParameters * ret:ILReturn * body:ILLazyMethodBody * isEntryPoint:bool * genericParams:ILGenericParameterDefs * securityDecls:ILSecurityDecls * customAttrs:ILAttributes) -> ILMethodDef
    -
    -     		-

    Functional creation of a value, immediate

    - - -

    CompiledName: .ctor

    -
    - - - new(...) - -
    - Signature: (name:string * attributes:MethodAttributes * implAttributes:MethodImplAttributes * callingConv:ILCallingConv * parameters:ILParameters * ret:ILReturn * body:ILLazyMethodBody * isEntryPoint:bool * genericParams:ILGenericParameterDefs * securityDeclsStored:ILSecurityDeclsStored * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILMethodDef
    -
    -     		-

    Functional creation of a value, with delayed reading of some elements via a metadata index

    - - -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Access - -
    - Signature: ILMemberAccess
    -
    -     		- -

    CompiledName: get_Access

    -
    - - - Attributes - -
    - Signature: MethodAttributes
    -
    -     		- -

    CompiledName: get_Attributes

    -
    - - - Body - -
    - Signature: ILLazyMethodBody
    -
    -     		- -

    CompiledName: get_Body

    -
    - - - CallingConv - -
    - Signature: ILCallingConv
    -
    -     		- -

    CompiledName: get_CallingConv

    -
    - - - CallingSignature - -
    - Signature: ILCallingSignature
    -
    -     		- -

    CompiledName: get_CallingSignature

    -
    - - - Code - -
    - Signature: ILCode option
    -
    -     		- -

    CompiledName: get_Code

    -
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - GenericParams - -
    - Signature: ILGenericParameterDefs
    -
    -     		- -

    CompiledName: get_GenericParams

    -
    - - - HasSecurity - -
    - Signature: bool
    -
    -     		-

    Some methods are marked "HasSecurity" even if there are no permissions attached, e.g. if they use SuppressUnmanagedCodeSecurityAttribute

    - - -

    CompiledName: get_HasSecurity

    -
    - - - ImplAttributes - -
    - Signature: MethodImplAttributes
    -
    -     		- -

    CompiledName: get_ImplAttributes

    -
    - - - IsAbstract - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsAbstract

    -
    - - - IsAggressiveInline - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsAggressiveInline

    -
    - - - IsCheckAccessOnOverride - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsCheckAccessOnOverride

    -
    - - - IsClassInitializer - -
    - Signature: bool
    -
    -     		-

    Indicates a .cctor method.

    - - -

    CompiledName: get_IsClassInitializer

    -
    - - - IsConstructor - -
    - Signature: bool
    -
    -     		-

    Indicates a .ctor method.

    - - -

    CompiledName: get_IsConstructor

    -
    - - - IsEntryPoint - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEntryPoint

    -
    - - - IsFinal - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsFinal

    -
    - - - IsForwardRef - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsForwardRef

    -
    - - - IsHideBySig - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsHideBySig

    -
    - - - IsIL - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsIL

    -
    - - - IsInternalCall - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsInternalCall

    -
    - - - IsManaged - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsManaged

    -
    - - - IsMustRun - -
    - Signature: bool
    -
    -     		-

    SafeHandle finalizer must be run.

    - - -

    CompiledName: get_IsMustRun

    -
    - - - IsNewSlot - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsNewSlot

    -
    - - - IsNoInline - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsNoInline

    -
    - - - IsNonVirtualInstance - -
    - Signature: bool
    -
    -     		-

    Indicates this is an instance methods that is not virtual.

    - - -

    CompiledName: get_IsNonVirtualInstance

    -
    - - - IsPreserveSig - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsPreserveSig

    -
    - - - IsReqSecObj - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsReqSecObj

    -
    - - - IsSpecialName - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSpecialName

    -
    - - - IsStatic - -
    - Signature: bool
    -
    -     		-

    Indicates a static method.

    - - -

    CompiledName: get_IsStatic

    -
    - - - IsSynchronized - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSynchronized

    -
    - - - IsUnmanagedExport - -
    - Signature: bool
    -
    -     		-

    The method is exported to unmanaged code using COM interop.

    - - -

    CompiledName: get_IsUnmanagedExport

    -
    - - - IsVirtual - -
    - Signature: bool
    -
    -     		-

    Indicates an instance methods that is virtual or abstract or implements an interface slot.

    - - -

    CompiledName: get_IsVirtual

    -
    - - - IsZeroInit - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsZeroInit

    -
    - - - Locals - -
    - Signature: ILLocals
    -
    -     		- -

    CompiledName: get_Locals

    -
    - - - MaxStack - -
    - Signature: int32
    -
    -     		- -

    CompiledName: get_MaxStack

    -
    - - - MethodBody - -
    - Signature: ILMethodBody
    -
    -     		- -

    CompiledName: get_MethodBody

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - - - Parameters - -
    - Signature: ILParameters
    -
    -     		- -

    CompiledName: get_Parameters

    -
    - - - ParameterTypes - -
    - Signature: ILTypes
    -
    -     		- -

    CompiledName: get_ParameterTypes

    -
    - - - Return - -
    - Signature: ILReturn
    -
    -     		- -

    CompiledName: get_Return

    -
    - - - SecurityDecls - -
    - Signature: ILSecurityDecls
    -
    -     		- -

    CompiledName: get_SecurityDecls

    -
    - - - With(...) - -
    - Signature: (name:string option * attributes:MethodAttributes option * implAttributes:MethodImplAttributes option * callingConv:ILCallingConv option * parameters:ILParameters option * ret:ILReturn option * body:ILLazyMethodBody option * securityDecls:ILSecurityDecls option * isEntryPoint:bool option * genericParams:ILGenericParameterDefs option * customAttrs:ILAttributes option) -> ILMethodDef
    -
    -     		-

    Functional update of the value

    - - -
    - - - WithAbstract(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - - - WithAccess(arg1) - -
    - Signature: ILMemberAccess -> ILMethodDef
    -
    -     		- -
    - - - WithAggressiveInlining(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - - - WithFinal(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - - - WithHideBySig(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - - - WithHideBySig() - -
    - Signature: unit -> ILMethodDef
    -
    -     		- -
    - - - WithNewSlot - -
    - Signature: ILMethodDef
    -
    -     		- -

    CompiledName: get_WithNewSlot

    -
    - - - WithNoInlining(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - - - WithPInvoke(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - - - WithPreserveSig(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - - - WithRuntime(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - - - WithSecurity(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - - - WithSpecialName - -
    - Signature: ILMethodDef
    -
    -     		- -

    CompiledName: get_WithSpecialName

    -
    - - - WithSynchronized(arg1) - -
    - Signature: bool -> ILMethodDef
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethoddefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethoddefs.html deleted file mode 100644 index cb429ba9cc..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmethoddefs.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - ILMethodDefs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILMethodDefs

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Tables of methods. Logically equivalent to a list of methods but -the table is kept in a form optimized for looking up methods by -name and arity.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AsArray - -
    - Signature: ILMethodDef []
    -
    -     		- -

    CompiledName: get_AsArray

    -
    - - - AsList - -
    - Signature: ILMethodDef list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - - - FindByName(arg1) - -
    - Signature: string -> ILMethodDef list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldef.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldef.html deleted file mode 100644 index 1bf548801e..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldef.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - ILMethodImplDef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILMethodImplDef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Method Impls

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - OverrideBy - -
    - Signature: ILMethodSpec
    -
    -     		- -
    - - - Overrides - -
    - Signature: ILOverridesSpec
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldefs.html deleted file mode 100644 index 62d18e90d8..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldefs.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - ILMethodImplDefs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILMethodImplDefs

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - AsList - -
    - Signature: ILMethodImplDef list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodref.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodref.html deleted file mode 100644 index fe2fdc3e62..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmethodref.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - ILMethodRef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILMethodRef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Formal identities of methods.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - ArgCount - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_ArgCount

    -
    - - - ArgTypes - -
    - Signature: ILTypes
    -
    -     		- -

    CompiledName: get_ArgTypes

    -
    - - - CallingConv - -
    - Signature: ILCallingConv
    -
    -     		- -

    CompiledName: get_CallingConv

    -
    - - - CallingSignature - -
    - Signature: ILCallingSignature
    -
    -     		- -

    CompiledName: get_CallingSignature

    -
    - - - DeclaringTypeRef - -
    - Signature: ILTypeRef
    -
    -     		- -

    CompiledName: get_DeclaringTypeRef

    -
    - - - GenericArity - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_GenericArity

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - - - ReturnType - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_ReturnType

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Create(...) - -
    - Signature: (enclosingTypeRef:ILTypeRef * callingConv:ILCallingConv * name:string * genericArity:int * argTypes:ILTypes * returnType:ILType) -> ILMethodRef
    -
    -     		-

    Functional creation

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodspec.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodspec.html deleted file mode 100644 index 6e3ec72742..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmethodspec.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - ILMethodSpec - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILMethodSpec

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    The information at the callsite of a method

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CallingConv - -
    - Signature: ILCallingConv
    -
    -     		- -

    CompiledName: get_CallingConv

    -
    - - - DeclaringType - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_DeclaringType

    -
    - - - FormalArgTypes - -
    - Signature: ILTypes
    -
    -     		- -

    CompiledName: get_FormalArgTypes

    -
    - - - FormalReturnType - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_FormalReturnType

    -
    - - - GenericArgs - -
    - Signature: ILGenericArgs
    -
    -     		- -

    CompiledName: get_GenericArgs

    -
    - - - GenericArity - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_GenericArity

    -
    - - - MethodRef - -
    - Signature: ILMethodRef
    -
    -     		- -

    CompiledName: get_MethodRef

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Create(arg1, arg2, arg3) - -
    - Signature: (ILType * ILMethodRef * ILGenericArgs) -> ILMethodSpec
    -
    -     		-

    Functional creation

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodvirtualinfo.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodvirtualinfo.html deleted file mode 100644 index d0737f80f9..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmethodvirtualinfo.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ILMethodVirtualInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILMethodVirtualInfo

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - IsAbstract - -
    - Signature: bool
    -
    -     		- -
    - - - IsCheckAccessOnOverride - -
    - Signature: bool
    -
    -     		- -
    - - - IsFinal - -
    - Signature: bool
    -
    -     		- -
    - - - IsNewSlot - -
    - Signature: bool
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmoduledef.html b/docs/reference/fsharp-compiler-abstractil-il-ilmoduledef.html deleted file mode 100644 index 922db1e98b..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmoduledef.html +++ /dev/null @@ -1,457 +0,0 @@ - - - - - ILModuleDef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILModuleDef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    One module in the "current" assembly, either a main-module or -an auxiliary module. The main module will have a manifest.

    -

    An assembly is built by joining together a "main" module plus -several auxiliary modules.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - CustomAttrsStored - -
    - Signature: ILAttributesStored
    -
    -     		- -
    - - - ImageBase - -
    - Signature: int32
    -
    -     		- -
    - - - Is32Bit - -
    - Signature: bool
    -
    -     		- -
    - - - Is32BitPreferred - -
    - Signature: bool
    -
    -     		- -
    - - - Is64Bit - -
    - Signature: bool
    -
    -     		- -
    - - - IsDLL - -
    - Signature: bool
    -
    -     		- -
    - - - IsILOnly - -
    - Signature: bool
    -
    -     		- -
    - - - Manifest - -
    - Signature: ILAssemblyManifest option
    -
    -     		- -
    - - - MetadataIndex - -
    - Signature: int32
    -
    -     		- -
    - - - MetadataVersion - -
    - Signature: string
    -
    -     		- -
    - - - Name - -
    - Signature: string
    -
    -     		- -
    - - - NativeResources - -
    - Signature: ILNativeResource list
    -
    -     		-

    e.g. win86 resources, as the exact contents of a .res or .obj file. Must be unlinked manually.

    - - -
    - - - PhysicalAlignment - -
    - Signature: int32
    -
    -     		- -
    - - - Platform - -
    - Signature: ILPlatform option
    -
    -     		- -
    - - - Resources - -
    - Signature: ILResources
    -
    -     		- -
    - - - StackReserveSize - -
    - Signature: int32 option
    -
    -     		- -
    - - - SubSystemFlags - -
    - Signature: int32
    -
    -     		- -
    - - - SubsystemVersion - -
    - Signature: int * int
    -
    -     		- -
    - - - TypeDefs - -
    - Signature: ILTypeDefs
    -
    -     		- -
    - - - UseHighEntropyVA - -
    - Signature: bool
    -
    -     		- -
    - - - VirtualAlignment - -
    - Signature: int32
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - HasManifest - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_HasManifest

    -
    - - - ManifestOfAssembly - -
    - Signature: ILAssemblyManifest
    -
    -     		- -

    CompiledName: get_ManifestOfAssembly

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmoduleref.html b/docs/reference/fsharp-compiler-abstractil-il-ilmoduleref.html deleted file mode 100644 index 0f3ac6a295..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilmoduleref.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - ILModuleRef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILModuleRef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Hash - -
    - Signature: byte [] option
    -
    -     		- -

    CompiledName: get_Hash

    -
    - - - HasMetadata - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_HasMetadata

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Create(name, hasMetadata, hash) - -
    - Signature: (name:string * hasMetadata:bool * hash:byte [] option) -> ILModuleRef
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnativeresource.html b/docs/reference/fsharp-compiler-abstractil-il-ilnativeresource.html deleted file mode 100644 index e7bc2cfc1a..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilnativeresource.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - ILNativeResource - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILNativeResource

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - In(...) - -
    - Signature: string * int * int * int
    -
    -     		-

    Represents a native resource to be read from the PE file

    - - -
    - - - Out(unlinkedResource) - -
    - Signature: byte []
    -
    -     		-

    Represents a native resource to be written in an output file

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnativetype.html b/docs/reference/fsharp-compiler-abstractil-il-ilnativetype.html deleted file mode 100644 index b0a8f791fa..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilnativetype.html +++ /dev/null @@ -1,640 +0,0 @@ - - - - - ILNativeType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILNativeType

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Native Types, for marshalling to the native C interface. -These are taken directly from the ILASM syntax, see ECMA Spec (Partition II, 7.4).

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ANSIBSTR - -
    - Signature:
    -
    -     		- -
    - - - Array(...) - -
    - Signature: ILNativeType option * (int32 * int32 option) option
    -
    -     		-

    optional idx of parameter giving size plus optional additive i.e. num elems

    - - -
    - - - AsAny - -
    - Signature:
    -
    -     		- -
    - - - Bool - -
    - Signature:
    -
    -     		- -
    - - - BSTR - -
    - Signature:
    -
    -     		- -
    - - - Byte - -
    - Signature:
    -
    -     		- -
    - - - ByValStr - -
    - Signature:
    -
    -     		- -
    - - - Currency - -
    - Signature:
    -
    -     		- -
    - - - Custom(ILGuid,string,string,byte []) - -
    - Signature: ILGuid * string * string * byte []
    -
    -     		- -
    - - - Double - -
    - Signature:
    -
    -     		- -
    - - - Empty - -
    - Signature:
    -
    -     		- -
    - - - Error - -
    - Signature:
    -
    -     		- -
    - - - FixedArray(int32) - -
    - Signature: int32
    -
    -     		- -
    - - - FixedSysString(int32) - -
    - Signature: int32
    -
    -     		- -
    - - - IDispatch - -
    - Signature:
    -
    -     		- -
    - - - Int - -
    - Signature:
    -
    -     		- -
    - - - Int16 - -
    - Signature:
    -
    -     		- -
    - - - Int32 - -
    - Signature:
    -
    -     		- -
    - - - Int64 - -
    - Signature:
    -
    -     		- -
    - - - Int8 - -
    - Signature:
    -
    -     		- -
    - - - Interface - -
    - Signature:
    -
    -     		- -
    - - - IUnknown - -
    - Signature:
    -
    -     		- -
    - - - LPSTR - -
    - Signature:
    -
    -     		- -
    - - - LPSTRUCT - -
    - Signature:
    -
    -     		- -
    - - - LPTSTR - -
    - Signature:
    -
    -     		- -
    - - - LPUTF8STR - -
    - Signature:
    -
    -     		- -
    - - - LPWSTR - -
    - Signature:
    -
    -     		- -
    - - - Method - -
    - Signature:
    -
    -     		- -
    - - - SafeArray(ILNativeVariant,string option) - -
    - Signature: ILNativeVariant * string option
    -
    -     		- -
    - - - Single - -
    - Signature:
    -
    -     		- -
    - - - Struct - -
    - Signature:
    -
    -     		- -
    - - - TBSTR - -
    - Signature:
    -
    -     		- -
    - - - UInt - -
    - Signature:
    -
    -     		- -
    - - - UInt16 - -
    - Signature:
    -
    -     		- -
    - - - UInt32 - -
    - Signature:
    -
    -     		- -
    - - - UInt64 - -
    - Signature:
    -
    -     		- -
    - - - VariantBool - -
    - Signature:
    -
    -     		- -
    - - - Void - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnativevariant.html b/docs/reference/fsharp-compiler-abstractil-il-ilnativevariant.html deleted file mode 100644 index de34f55965..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilnativevariant.html +++ /dev/null @@ -1,719 +0,0 @@ - - - - - ILNativeVariant - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILNativeVariant

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Array(ILNativeVariant) - -
    - Signature: ILNativeVariant
    -
    -     		- -
    - - - Blob - -
    - Signature:
    -
    -     		- -
    - - - BlobObject - -
    - Signature:
    -
    -     		- -
    - - - Bool - -
    - Signature:
    -
    -     		- -
    - - - BSTR - -
    - Signature:
    -
    -     		- -
    - - - Byref(ILNativeVariant) - -
    - Signature: ILNativeVariant
    -
    -     		- -
    - - - CArray - -
    - Signature:
    -
    -     		- -
    - - - CF - -
    - Signature:
    -
    -     		- -
    - - - CLSID - -
    - Signature:
    -
    -     		- -
    - - - Currency - -
    - Signature:
    -
    -     		- -
    - - - Date - -
    - Signature:
    -
    -     		- -
    - - - Decimal - -
    - Signature:
    -
    -     		- -
    - - - Double - -
    - Signature:
    -
    -     		- -
    - - - Empty - -
    - Signature:
    -
    -     		- -
    - - - Error - -
    - Signature:
    -
    -     		- -
    - - - FileTime - -
    - Signature:
    -
    -     		- -
    - - - HRESULT - -
    - Signature:
    -
    -     		- -
    - - - IDispatch - -
    - Signature:
    -
    -     		- -
    - - - Int - -
    - Signature:
    -
    -     		- -
    - - - Int16 - -
    - Signature:
    -
    -     		- -
    - - - Int32 - -
    - Signature:
    -
    -     		- -
    - - - Int64 - -
    - Signature:
    -
    -     		- -
    - - - Int8 - -
    - Signature:
    -
    -     		- -
    - - - IUnknown - -
    - Signature:
    -
    -     		- -
    - - - LPSTR - -
    - Signature:
    -
    -     		- -
    - - - LPWSTR - -
    - Signature:
    -
    -     		- -
    - - - Null - -
    - Signature:
    -
    -     		- -
    - - - PTR - -
    - Signature:
    -
    -     		- -
    - - - Record - -
    - Signature:
    -
    -     		- -
    - - - SafeArray - -
    - Signature:
    -
    -     		- -
    - - - Single - -
    - Signature:
    -
    -     		- -
    - - - Storage - -
    - Signature:
    -
    -     		- -
    - - - StoredObject - -
    - Signature:
    -
    -     		- -
    - - - Stream - -
    - Signature:
    -
    -     		- -
    - - - StreamedObject - -
    - Signature:
    -
    -     		- -
    - - - UInt - -
    - Signature:
    -
    -     		- -
    - - - UInt16 - -
    - Signature:
    -
    -     		- -
    - - - UInt32 - -
    - Signature:
    -
    -     		- -
    - - - UInt64 - -
    - Signature:
    -
    -     		- -
    - - - UInt8 - -
    - Signature:
    -
    -     		- -
    - - - UserDefined - -
    - Signature:
    -
    -     		- -
    - - - Variant - -
    - Signature:
    -
    -     		- -
    - - - Vector(ILNativeVariant) - -
    - Signature: ILNativeVariant
    -
    -     		- -
    - - - Void - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtype.html b/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtype.html deleted file mode 100644 index 44597d2c36..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtype.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - ILNestedExportedType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILNestedExportedType

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    these are only found in the "Nested" field of ILExportedTypeOrForwarder objects

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Access - -
    - Signature: ILMemberAccess
    -
    -     		- -
    - - - CustomAttrsStored - -
    - Signature: ILAttributesStored
    -
    -     		- -
    - - - MetadataIndex - -
    - Signature: int32
    -
    -     		- -
    - - - Name - -
    - Signature: string
    -
    -     		- -
    - - - Nested - -
    - Signature: ILNestedExportedTypes
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtypes.html b/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtypes.html deleted file mode 100644 index 230d9af8b2..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtypes.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - ILNestedExportedTypes - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILNestedExportedTypes

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - AsList - -
    - Signature: ILNestedExportedType list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iloverridesspec.html b/docs/reference/fsharp-compiler-abstractil-il-iloverridesspec.html deleted file mode 100644 index a5c6ead049..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iloverridesspec.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - ILOverridesSpec - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILOverridesSpec

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - OverridesSpec(ILMethodRef,ILType) - -
    - Signature: ILMethodRef * ILType
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DeclaringType - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_DeclaringType

    -
    - - - MethodRef - -
    - Signature: ILMethodRef
    -
    -     		- -

    CompiledName: get_MethodRef

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilparameter.html b/docs/reference/fsharp-compiler-abstractil-il-ilparameter.html deleted file mode 100644 index 222674da34..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilparameter.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - ILParameter - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILParameter

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Method parameters and return values.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - CustomAttrsStored - -
    - Signature: ILAttributesStored
    -
    -     		- -
    - - - Default - -
    - Signature: ILFieldInit option
    -
    -     		- -
    - - - IsIn - -
    - Signature: bool
    -
    -     		- -
    - - - IsOptional - -
    - Signature: bool
    -
    -     		- -
    - - - IsOut - -
    - Signature: bool
    -
    -     		- -
    - - - Marshal - -
    - Signature: ILNativeType option
    -
    -     		-

    Marshalling map for parameters. COM Interop only.

    - - -
    - - - MetadataIndex - -
    - Signature: int32
    -
    -     		- -
    - - - Name - -
    - Signature: string option
    -
    -     		- -
    - - - Type - -
    - Signature: ILType
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilparameters.html b/docs/reference/fsharp-compiler-abstractil-il-ilparameters.html deleted file mode 100644 index da2652b4e1..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilparameters.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - ILParameters - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILParameters

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: ILParameter
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> ILParameter
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: ILParameter list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: ILParameter list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilplatform.html b/docs/reference/fsharp-compiler-abstractil-il-ilplatform.html deleted file mode 100644 index e71ec29887..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilplatform.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - ILPlatform - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILPlatform

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AMD64 - -
    - Signature:
    -
    -     		- -
    - - - IA64 - -
    - Signature:
    -
    -     		- -
    - - - X86 - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilpretypedef.html b/docs/reference/fsharp-compiler-abstractil-il-ilpretypedef.html deleted file mode 100644 index cb7517a544..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilpretypedef.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - ILPreTypeDef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILPreTypeDef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Represents a prefix of information for ILTypeDef.

    -

    The information is enough to perform name resolution for the F# compiler, probe attributes -for ExtensionAttribute etc. This is key to the on-demand exploration of .NET metadata. -This information has to be "Goldilocks" - not too much, not too little, just right.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - GetTypeDef() - -
    - Signature: unit -> ILTypeDef
    -
    -     		-

    Realise the actual full typedef

    - - -
    - - - MetadataIndex - -
    - Signature: int32
    -
    -     		- -

    CompiledName: get_MetadataIndex

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - - - Namespace - -
    - Signature: string list
    -
    -     		- -

    CompiledName: get_Namespace

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilpropertydef.html b/docs/reference/fsharp-compiler-abstractil-il-ilpropertydef.html deleted file mode 100644 index 98f4e20180..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilpropertydef.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - ILPropertyDef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILPropertyDef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Property definitions

    - -
    -

    Constructors

    - - - - - - - - - - - - - - -
    ConstructorDescription
    - - - new(...) - -
    - Signature: (name:string * attributes:PropertyAttributes * setMethod:ILMethodRef option * getMethod:ILMethodRef option * callingConv:ILThisConvention * propertyType:ILType * init:ILFieldInit option * args:ILTypes * customAttrs:ILAttributes) -> ILPropertyDef
    -
    -     		-

    Functional creation of a value, immediate

    - - -

    CompiledName: .ctor

    -
    - - - new(...) - -
    - Signature: (name:string * attributes:PropertyAttributes * setMethod:ILMethodRef option * getMethod:ILMethodRef option * callingConv:ILThisConvention * propertyType:ILType * init:ILFieldInit option * args:ILTypes * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILPropertyDef
    -
    -     		-

    Functional creation of a value, using delayed reading via a metadata index, for ilread.fs

    - - -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Args - -
    - Signature: ILTypes
    -
    -     		- -

    CompiledName: get_Args

    -
    - - - Attributes - -
    - Signature: PropertyAttributes
    -
    -     		- -

    CompiledName: get_Attributes

    -
    - - - CallingConv - -
    - Signature: ILThisConvention
    -
    -     		- -

    CompiledName: get_CallingConv

    -
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - GetMethod - -
    - Signature: ILMethodRef option
    -
    -     		- -

    CompiledName: get_GetMethod

    -
    - - - Init - -
    - Signature: ILFieldInit option
    -
    -     		- -

    CompiledName: get_Init

    -
    - - - IsRTSpecialName - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsRTSpecialName

    -
    - - - IsSpecialName - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSpecialName

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - - - PropertyType - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_PropertyType

    -
    - - - SetMethod - -
    - Signature: ILMethodRef option
    -
    -     		- -

    CompiledName: get_SetMethod

    -
    - - - With(...) - -
    - Signature: (name:string option * attributes:PropertyAttributes option * setMethod:ILMethodRef option option * getMethod:ILMethodRef option option * callingConv:ILThisConvention option * propertyType:ILType option * init:ILFieldInit option option * args:ILTypes option * customAttrs:ILAttributes option) -> ILPropertyDef
    -
    -     		-

    Functional update of the value

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilpropertydefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilpropertydefs.html deleted file mode 100644 index e38df4ad48..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilpropertydefs.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - ILPropertyDefs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILPropertyDefs

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Table of properties in an IL type definition.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AsList - -
    - Signature: ILPropertyDef list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - - - LookupByName(arg1) - -
    - Signature: string -> ILPropertyDef list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilpropertyref.html b/docs/reference/fsharp-compiler-abstractil-il-ilpropertyref.html deleted file mode 100644 index c7b6ccbbdb..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilpropertyref.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - ILPropertyRef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILPropertyRef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    A utility type provided for completeness

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DeclaringTypeRef - -
    - Signature: ILTypeRef
    -
    -     		- -

    CompiledName: get_DeclaringTypeRef

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Create(arg1, arg2) - -
    - Signature: (ILTypeRef * string) -> ILPropertyRef
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilreadonly.html b/docs/reference/fsharp-compiler-abstractil-il-ilreadonly.html deleted file mode 100644 index e8ddb90a27..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilreadonly.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ILReadonly - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILReadonly

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - NormalAddress - -
    - Signature:
    -
    -     		- -
    - - - ReadonlyAddress - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilreferences.html b/docs/reference/fsharp-compiler-abstractil-il-ilreferences.html deleted file mode 100644 index 0d32c67319..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilreferences.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ILReferences - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILReferences

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - AssemblyReferences - -
    - Signature: ILAssemblyRef list
    -
    -     		- -
    - - - ModuleReferences - -
    - Signature: ILModuleRef list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilresource.html b/docs/reference/fsharp-compiler-abstractil-il-ilresource.html deleted file mode 100644 index 76ecc54230..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilresource.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - ILResource - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILResource

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    "Manifest ILResources" are chunks of resource data, being one of: -- the data section of the current module (byte[] of resource given directly). -- in an external file in this assembly (offset given in the ILResourceLocation field). -- as a resources in another assembly of the same name.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Access - -
    - Signature: ILResourceAccess
    -
    -     		- -
    - - - CustomAttrsStored - -
    - Signature: ILAttributesStored
    -
    -     		- -
    - - - Location - -
    - Signature: ILResourceLocation
    -
    -     		- -
    - - - MetadataIndex - -
    - Signature: int32
    -
    -     		- -
    - - - Name - -
    - Signature: string
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - GetBytes() - -
    - Signature: unit -> byte []
    -
    -     		-

    Read the bytes from a resource local to an assembly. Will fail for non-local resources.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilresourceaccess.html b/docs/reference/fsharp-compiler-abstractil-il-ilresourceaccess.html deleted file mode 100644 index bbb8fe1f9e..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilresourceaccess.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ILResourceAccess - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILResourceAccess

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Private - -
    - Signature:
    -
    -     		- -
    - - - Public - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilresourcelocation.html b/docs/reference/fsharp-compiler-abstractil-il-ilresourcelocation.html deleted file mode 100644 index 556ec56925..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilresourcelocation.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - ILResourceLocation - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILResourceLocation

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Assembly(ILAssemblyRef) - -
    - Signature: ILAssemblyRef
    -
    -     		-

    Represents a manifest resource in a different assembly

    - - -
    - - - File(ILModuleRef,int32) - -
    - Signature: ILModuleRef * int32
    -
    -     		-

    Represents a manifest resource in an associated file

    - - -
    - - - LocalIn(string,int,int) - -
    - Signature: string * int * int
    -
    -     		-

    Represents a manifest resource that can be read from within the PE file

    - - -
    - - - LocalOut(byte []) - -
    - Signature: byte []
    -
    -     		-

    Represents a manifest resource that is due to be written to the output PE file

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilresources.html b/docs/reference/fsharp-compiler-abstractil-il-ilresources.html deleted file mode 100644 index c13f282fbc..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilresources.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - ILResources - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILResources

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Table of resources in a module.

    - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - AsList - -
    - Signature: ILResource list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilreturn.html b/docs/reference/fsharp-compiler-abstractil-il-ilreturn.html deleted file mode 100644 index f87b94f1df..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilreturn.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - ILReturn - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILReturn

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Method return values.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - CustomAttrsStored - -
    - Signature: ILAttributesStored
    -
    -     		- -
    - - - Marshal - -
    - Signature: ILNativeType option
    -
    -     		- -
    - - - MetadataIndex - -
    - Signature: int32
    -
    -     		- -
    - - - Type - -
    - Signature: ILType
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - WithCustomAttrs(customAttrs) - -
    - Signature: customAttrs:ILAttributes -> ILReturn
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilscoperef.html b/docs/reference/fsharp-compiler-abstractil-il-ilscoperef.html deleted file mode 100644 index 6f7942cc42..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilscoperef.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - ILScopeRef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILScopeRef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Assembly(ILAssemblyRef) - -
    - Signature: ILAssemblyRef
    -
    -     		-

    A reference to a type in another assembly

    - - -
    - - - Local - -
    - Signature:
    -
    -     		-

    A reference to the type in the current module

    - - -
    - - - Module(ILModuleRef) - -
    - Signature: ILModuleRef
    -
    -     		-

    A reference to a type in a module in the same assembly

    - - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AssemblyRef - -
    - Signature: ILAssemblyRef
    -
    -     		- -

    CompiledName: get_AssemblyRef

    -
    - - - IsAssemblyRef - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsAssemblyRef

    -
    - - - IsLocalRef - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsLocalRef

    -
    - - - IsModuleRef - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsModuleRef

    -
    - - - ModuleRef - -
    - Signature: ILModuleRef
    -
    -     		- -

    CompiledName: get_ModuleRef

    -
    - - - QualifiedName - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_QualifiedName

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsecurityaction.html b/docs/reference/fsharp-compiler-abstractil-il-ilsecurityaction.html deleted file mode 100644 index 5757d70513..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilsecurityaction.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - ILSecurityAction - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILSecurityAction

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Assert - -
    - Signature:
    -
    -     		- -
    - - - Demand - -
    - Signature:
    -
    -     		- -
    - - - DemandChoice - -
    - Signature:
    -
    -     		- -
    - - - Deny - -
    - Signature:
    -
    -     		- -
    - - - InheritanceDemandChoice - -
    - Signature:
    -
    -     		- -
    - - - InheritCheck - -
    - Signature:
    -
    -     		- -
    - - - LinkCheck - -
    - Signature:
    -
    -     		- -
    - - - LinkDemandChoice - -
    - Signature:
    -
    -     		- -
    - - - NonCasDemand - -
    - Signature:
    -
    -     		- -
    - - - NonCasInheritance - -
    - Signature:
    -
    -     		- -
    - - - NonCasLinkDemand - -
    - Signature:
    -
    -     		- -
    - - - PermitOnly - -
    - Signature:
    -
    -     		- -
    - - - PreJitDeny - -
    - Signature:
    -
    -     		- -
    - - - PreJitGrant - -
    - Signature:
    -
    -     		- -
    - - - ReqMin - -
    - Signature:
    -
    -     		- -
    - - - ReqOpt - -
    - Signature:
    -
    -     		- -
    - - - ReqRefuse - -
    - Signature:
    -
    -     		- -
    - - - Request - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecl.html b/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecl.html deleted file mode 100644 index 5a70c30b78..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecl.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - ILSecurityDecl - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILSecurityDecl

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - ILSecurityDecl(ILSecurityAction,byte []) - -
    - Signature: ILSecurityAction * byte []
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecls.html b/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecls.html deleted file mode 100644 index 7c171ede2e..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecls.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - ILSecurityDecls - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILSecurityDecls

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Abstract type equivalent to ILSecurityDecl list - use helpers -below to construct/destruct these.

    - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - AsList - -
    - Signature: ILSecurityDecl list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydeclsstored.html b/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydeclsstored.html deleted file mode 100644 index 946c5d56a7..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydeclsstored.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ILSecurityDeclsStored - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILSecurityDeclsStored

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Represents the efficiency-oriented storage of ILSecurityDecls in another item.

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsourcedocument.html b/docs/reference/fsharp-compiler-abstractil-il-ilsourcedocument.html deleted file mode 100644 index de4ff329e4..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilsourcedocument.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - ILSourceDocument - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILSourceDocument

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Debug info. Values of type "source" can be attached at sequence -points and some other locations.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DocumentType - -
    - Signature: ILGuid option
    -
    -     		- -

    CompiledName: get_DocumentType

    -
    - - - File - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_File

    -
    - - - Language - -
    - Signature: ILGuid option
    -
    -     		- -

    CompiledName: get_Language

    -
    - - - Vendor - -
    - Signature: ILGuid option
    -
    -     		- -

    CompiledName: get_Vendor

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Create(...) - -
    - Signature: (language:ILGuid option * vendor:ILGuid option * documentType:ILGuid option * file:string) -> ILSourceDocument
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsourcemarker.html b/docs/reference/fsharp-compiler-abstractil-il-ilsourcemarker.html deleted file mode 100644 index dae6cc39b4..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilsourcemarker.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - ILSourceMarker - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILSourceMarker

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Column - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Column

    -
    - - - Document - -
    - Signature: ILSourceDocument
    -
    -     		- -

    CompiledName: get_Document

    -
    - - - EndColumn - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_EndColumn

    -
    - - - EndLine - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_EndLine

    -
    - - - Line - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Line

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Create(...) - -
    - Signature: (document:ILSourceDocument * line:int * column:int * endLine:int * endColumn:int) -> ILSourceMarker
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltailcall.html b/docs/reference/fsharp-compiler-abstractil-il-iltailcall.html deleted file mode 100644 index 8341ab3193..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltailcall.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ILTailcall - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTailcall

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Normalcall - -
    - Signature:
    -
    -     		- -
    - - - Tailcall - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilthisconvention.html b/docs/reference/fsharp-compiler-abstractil-il-ilthisconvention.html deleted file mode 100644 index a536b65641..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilthisconvention.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - ILThisConvention - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILThisConvention

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Instance - -
    - Signature:
    -
    -     		-

    accepts an implicit 'this' pointer

    - - -
    - - - InstanceExplicit - -
    - Signature:
    -
    -     		-

    accepts an explicit 'this' pointer

    - - -
    - - - Static - -
    - Signature:
    -
    -     		-

    no 'this' pointer is passed

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltoken.html b/docs/reference/fsharp-compiler-abstractil-il-iltoken.html deleted file mode 100644 index c668a732ae..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltoken.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - ILToken - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILToken

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ILField(ILFieldSpec) - -
    - Signature: ILFieldSpec
    -
    -     		- -
    - - - ILMethod(ILMethodSpec) - -
    - Signature: ILMethodSpec
    -
    -     		- -
    - - - ILType(ILType) - -
    - Signature: ILType
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltype.html b/docs/reference/fsharp-compiler-abstractil-il-iltype.html deleted file mode 100644 index 9d2af0da16..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltype.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - ILType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILType

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Array(ILArrayShape,ILType) - -
    - Signature: ILArrayShape * ILType
    -
    -     		-

    Array types

    - - -
    - - - Boxed(ILTypeSpec) - -
    - Signature: ILTypeSpec
    -
    -     		-

    Reference types. Also may be used for parents of members even if for members in value types.

    - - -
    - - - Byref(ILType) - -
    - Signature: ILType
    -
    -     		-

    Managed pointers.

    - - -
    - - - FunctionPointer(ILCallingSignature) - -
    - Signature: ILCallingSignature
    -
    -     		-

    ILCode pointers.

    - - -
    - - - Modified(bool,ILTypeRef,ILType) - -
    - Signature: bool * ILTypeRef * ILType
    -
    -     		-

    Custom modifiers.

    - - -
    - - - Ptr(ILType) - -
    - Signature: ILType
    -
    -     		-

    Unmanaged pointers. Nb. the type is used by tools and for binding only, not by the verifier.

    - - -
    - - - TypeVar(uint16) - -
    - Signature: uint16
    -
    -     		-

    Reference a generic arg.

    - - -
    - - - Value(ILTypeSpec) - -
    - Signature: ILTypeSpec
    -
    -     		-

    Unboxed types, including builtin types.

    - - -
    - - - Void - -
    - Signature:
    -
    -     		-

    Used only in return and pointer types.

    - - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - BasicQualifiedName - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_BasicQualifiedName

    -
    - - - Boxity - -
    - Signature: ILBoxity
    -
    -     		- -

    CompiledName: get_Boxity

    -
    - - - GenericArgs - -
    - Signature: ILGenericArgs
    -
    -     		- -

    CompiledName: get_GenericArgs

    -
    - - - IsNominal - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsNominal

    -
    - - - IsTyvar - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsTyvar

    -
    - - - QualifiedName - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_QualifiedName

    -
    - - - TypeRef - -
    - Signature: ILTypeRef
    -
    -     		- -

    CompiledName: get_TypeRef

    -
    - - - TypeSpec - -
    - Signature: ILTypeSpec
    -
    -     		-

    The type being modified.

    - - -

    CompiledName: get_TypeSpec

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedef.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedef.html deleted file mode 100644 index c5d0309b90..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypedef.html +++ /dev/null @@ -1,756 +0,0 @@ - - - - - ILTypeDef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeDef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Represents IL Type Definitions.

    - -
    -

    Constructors

    - - - - - - - - - - - - - - -
    ConstructorDescription
    - - - new(...) - -
    - Signature: (name:string * attributes:TypeAttributes * layout:ILTypeDefLayout * implements:ILTypes * genericParams:ILGenericParameterDefs * extends:ILType option * methods:ILMethodDefs * nestedTypes:ILTypeDefs * fields:ILFieldDefs * methodImpls:ILMethodImplDefs * events:ILEventDefs * properties:ILPropertyDefs * securityDecls:ILSecurityDecls * customAttrs:ILAttributes) -> ILTypeDef
    -
    -     		-

    Functional creation of a value, immediate

    - - -

    CompiledName: .ctor

    -
    - - - new(...) - -
    - Signature: (name:string * attributes:TypeAttributes * layout:ILTypeDefLayout * implements:ILTypes * genericParams:ILGenericParameterDefs * extends:ILType option * methods:ILMethodDefs * nestedTypes:ILTypeDefs * fields:ILFieldDefs * methodImpls:ILMethodImplDefs * events:ILEventDefs * properties:ILPropertyDefs * securityDeclsStored:ILSecurityDeclsStored * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILTypeDef
    -
    -     		-

    Functional creation of a value, using delayed reading via a metadata index, for ilread.fs

    - - -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Access - -
    - Signature: ILTypeDefAccess
    -
    -     		- -

    CompiledName: get_Access

    -
    - - - Attributes - -
    - Signature: TypeAttributes
    -
    -     		- -

    CompiledName: get_Attributes

    -
    - - - CustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -

    CompiledName: get_CustomAttrs

    -
    - - - Encoding - -
    - Signature: ILDefaultPInvokeEncoding
    -
    -     		- -

    CompiledName: get_Encoding

    -
    - - - Events - -
    - Signature: ILEventDefs
    -
    -     		- -

    CompiledName: get_Events

    -
    - - - Extends - -
    - Signature: ILType option
    -
    -     		- -

    CompiledName: get_Extends

    -
    - - - Fields - -
    - Signature: ILFieldDefs
    -
    -     		- -

    CompiledName: get_Fields

    -
    - - - GenericParams - -
    - Signature: ILGenericParameterDefs
    -
    -     		- -

    CompiledName: get_GenericParams

    -
    - - - HasSecurity - -
    - Signature: bool
    -
    -     		-

    Some classes are marked "HasSecurity" even if there are no permissions attached, -e.g. if they use SuppressUnmanagedCodeSecurityAttribute

    - - -

    CompiledName: get_HasSecurity

    -
    - - - Implements - -
    - Signature: ILTypes
    -
    -     		- -

    CompiledName: get_Implements

    -
    - - - IsAbstract - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsAbstract

    -
    - - - IsClass - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsClass

    -
    - - - IsComInterop - -
    - Signature: bool
    -
    -     		-

    Class or interface generated for COM interop.

    - - -

    CompiledName: get_IsComInterop

    -
    - - - IsDelegate - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsDelegate

    -
    - - - IsEnum - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEnum

    -
    - - - IsInterface - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsInterface

    -
    - - - IsSealed - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSealed

    -
    - - - IsSerializable - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSerializable

    -
    - - - IsSpecialName - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSpecialName

    -
    - - - IsStruct - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsStruct

    -
    - - - IsStructOrEnum - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsStructOrEnum

    -
    - - - Layout - -
    - Signature: ILTypeDefLayout
    -
    -     		- -

    CompiledName: get_Layout

    -
    - - - MethodImpls - -
    - Signature: ILMethodImplDefs
    -
    -     		- -

    CompiledName: get_MethodImpls

    -
    - - - Methods - -
    - Signature: ILMethodDefs
    -
    -     		- -

    CompiledName: get_Methods

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - - - NestedTypes - -
    - Signature: ILTypeDefs
    -
    -     		- -

    CompiledName: get_NestedTypes

    -
    - - - Properties - -
    - Signature: ILPropertyDefs
    -
    -     		- -

    CompiledName: get_Properties

    -
    - - - SecurityDecls - -
    - Signature: ILSecurityDecls
    -
    -     		- -

    CompiledName: get_SecurityDecls

    -
    - - - With(...) - -
    - Signature: (name:string option * attributes:TypeAttributes option * layout:ILTypeDefLayout option * implements:ILTypes option * genericParams:ILGenericParameterDefs option * extends:ILType option option * methods:ILMethodDefs option * nestedTypes:ILTypeDefs option * fields:ILFieldDefs option * methodImpls:ILMethodImplDefs option * events:ILEventDefs option * properties:ILPropertyDefs option * customAttrs:ILAttributes option * securityDecls:ILSecurityDecls option) -> ILTypeDef
    -
    -     		-

    Functional update

    - - -
    - - - WithAbstract(arg1) - -
    - Signature: bool -> ILTypeDef
    -
    -     		- -
    - - - WithAccess(arg1) - -
    - Signature: ILTypeDefAccess -> ILTypeDef
    -
    -     		- -
    - - - WithEncoding(arg1) - -
    - Signature: ILDefaultPInvokeEncoding -> ILTypeDef
    -
    -     		- -
    - - - WithHasSecurity(arg1) - -
    - Signature: bool -> ILTypeDef
    -
    -     		- -
    - - - WithImport(arg1) - -
    - Signature: bool -> ILTypeDef
    -
    -     		- -
    - - - WithInitSemantics(arg1) - -
    - Signature: ILTypeInit -> ILTypeDef
    -
    -     		- -
    - - - WithKind(arg1) - -
    - Signature: ILTypeDefKind -> ILTypeDef
    -
    -     		- -
    - - - WithLayout(arg1) - -
    - Signature: ILTypeDefLayout -> ILTypeDef
    -
    -     		- -
    - - - WithNestedAccess(arg1) - -
    - Signature: ILMemberAccess -> ILTypeDef
    -
    -     		- -
    - - - WithSealed(arg1) - -
    - Signature: bool -> ILTypeDef
    -
    -     		- -
    - - - WithSerializable(arg1) - -
    - Signature: bool -> ILTypeDef
    -
    -     		- -
    - - - WithSpecialName(arg1) - -
    - Signature: bool -> ILTypeDef
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedefaccess.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedefaccess.html deleted file mode 100644 index 9ed1a87ce5..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypedefaccess.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ILTypeDefAccess - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeDefAccess

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Type Access.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Nested(ILMemberAccess) - -
    - Signature: ILMemberAccess
    -
    -     		- -
    - - - Private - -
    - Signature:
    -
    -     		- -
    - - - Public - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedefkind.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedefkind.html deleted file mode 100644 index 05273497b4..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypedefkind.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - ILTypeDefKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeDefKind

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    A categorization of type definitions into "kinds"

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Class - -
    - Signature:
    -
    -     		- -
    - - - Delegate - -
    - Signature:
    -
    -     		- -
    - - - Enum - -
    - Signature:
    -
    -     		- -
    - - - Interface - -
    - Signature:
    -
    -     		- -
    - - - ValueType - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayout.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayout.html deleted file mode 100644 index c09ac6e772..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayout.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ILTypeDefLayout - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeDefLayout

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Type Layout information.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Auto - -
    - Signature:
    -
    -     		- -
    - - - Explicit(ILTypeDefLayoutInfo) - -
    - Signature: ILTypeDefLayoutInfo
    -
    -     		- -
    - - - Sequential(ILTypeDefLayoutInfo) - -
    - Signature: ILTypeDefLayoutInfo
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayoutinfo.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayoutinfo.html deleted file mode 100644 index c57c52238b..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayoutinfo.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ILTypeDefLayoutInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeDefLayoutInfo

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Pack - -
    - Signature: uint16 option
    -
    -     		- -
    - - - Size - -
    - Signature: int32 option
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedefs.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedefs.html deleted file mode 100644 index c2bb722aeb..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypedefs.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - ILTypeDefs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeDefs

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Tables of named type definitions.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AsArray - -
    - Signature: ILTypeDef []
    -
    -     		- -

    CompiledName: get_AsArray

    -
    - - - AsArrayOfPreTypeDefs - -
    - Signature: ILPreTypeDef []
    -
    -     		-

    Get some information about the type defs, but do not force the read of the type defs themselves.

    - - -

    CompiledName: get_AsArrayOfPreTypeDefs

    -
    - - - AsList - -
    - Signature: ILTypeDef list
    -
    -     		- -

    CompiledName: get_AsList

    -
    - - - FindByName(arg1) - -
    - Signature: string -> ILTypeDef
    -
    -     		-

    Calls to FindByName will result in any laziness in the overall -set of ILTypeDefs being read in in addition -to the details for the type found, but the remaining individual -type definitions will not be read.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedefstored.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedefstored.html deleted file mode 100644 index 57d4582db6..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypedefstored.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - ILTypeDefStored - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeDefStored

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypeinit.html b/docs/reference/fsharp-compiler-abstractil-il-iltypeinit.html deleted file mode 100644 index 5e663718ed..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypeinit.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - ILTypeInit - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeInit

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Indicate the initialization semantics of a type.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - BeforeField - -
    - Signature:
    -
    -     		- -
    - - - OnAny - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltyperef.html b/docs/reference/fsharp-compiler-abstractil-il-iltyperef.html deleted file mode 100644 index d3d2568375..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltyperef.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - ILTypeRef - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeRef

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Type refs, i.e. references to types in some .NET assembly

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - BasicQualifiedName - -
    - Signature: string
    -
    -     		-

    The name of the type in the assembly using the '+' notation for nested types.

    - - -

    CompiledName: get_BasicQualifiedName

    -
    - - - Enclosing - -
    - Signature: string list
    -
    -     		-

    The list of enclosing type names for a nested type. If non-nil then the first of these also contains the namespace.

    - - -

    CompiledName: get_Enclosing

    -
    - - - FullName - -
    - Signature: string
    -
    -     		-

    The name of the type in the assembly using the '.' notation for nested types.

    - - -

    CompiledName: get_FullName

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    The name of the type. This also contains the namespace if Enclosing is empty.

    - - -

    CompiledName: get_Name

    -
    - - - QualifiedName - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_QualifiedName

    -
    - - - Scope - -
    - Signature: ILScopeRef
    -
    -     		-

    Where is the type, i.e. is it in this module, in another module in this assembly or in another assembly?

    - - -

    CompiledName: get_Scope

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Create(scope, enclosing, name) - -
    - Signature: (scope:ILScopeRef * enclosing:string list * name:string) -> ILTypeRef
    -
    -     		-

    Create a ILTypeRef.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypes.html b/docs/reference/fsharp-compiler-abstractil-il-iltypes.html deleted file mode 100644 index 227df3acc3..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypes.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - ILTypes - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypes

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: ILType
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> ILType
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: ILType list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: ILType list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypespec.html b/docs/reference/fsharp-compiler-abstractil-il-iltypespec.html deleted file mode 100644 index f5959471f8..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-iltypespec.html +++ /dev/null @@ -1,231 +0,0 @@ - - - - - ILTypeSpec - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILTypeSpec

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    Type specs and types.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Enclosing - -
    - Signature: string list
    -
    -     		-

    The list of enclosing type names for a nested type. If non-nil then the first of these also contains the namespace.

    - - -

    CompiledName: get_Enclosing

    -
    - - - FullName - -
    - Signature: string
    -
    -     		-

    The name of the type in the assembly using the '.' notation for nested types.

    - - -

    CompiledName: get_FullName

    -
    - - - GenericArgs - -
    - Signature: ILGenericArgs
    -
    -     		-

    The type instantiation if the type is generic, otherwise empty

    - - -

    CompiledName: get_GenericArgs

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    The name of the type. This also contains the namespace if Enclosing is empty.

    - - -

    CompiledName: get_Name

    -
    - - - Scope - -
    - Signature: ILScopeRef
    -
    -     		-

    Where is the type, i.e. is it in this module, in another module in this assembly or in another assembly?

    - - -

    CompiledName: get_Scope

    -
    - - - TypeRef - -
    - Signature: ILTypeRef
    -
    -     		-

    Which type is being referred to?

    - - -

    CompiledName: get_TypeRef

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Create(typeRef, instantiation) - -
    - Signature: (typeRef:ILTypeRef * instantiation:ILGenericArgs) -> ILTypeSpec
    -
    -     		-

    Create an ILTypeSpec.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilvarargs.html b/docs/reference/fsharp-compiler-abstractil-il-ilvarargs.html deleted file mode 100644 index 704ef3d2c5..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilvarargs.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - ILVarArgs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILVarArgs

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - IsNone - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsNone

    -
    - - - IsSome - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSome

    -
    - - - Value - -
    - Signature: ILTypes
    -
    -     		- -

    CompiledName: get_Value

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - None - -
    - Signature: ILTypes option
    -
    -     		- -

    CompiledName: get_None

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilversioninfo.html b/docs/reference/fsharp-compiler-abstractil-il-ilversioninfo.html deleted file mode 100644 index 28b8b69fe1..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilversioninfo.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - ILVersionInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILVersionInfo

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilvolatility.html b/docs/reference/fsharp-compiler-abstractil-il-ilvolatility.html deleted file mode 100644 index df94802bbb..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-ilvolatility.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ILVolatility - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILVolatility

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Nonvolatile - -
    - Signature:
    -
    -     		- -
    - - - Volatile - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-methodbody.html b/docs/reference/fsharp-compiler-abstractil-il-methodbody.html deleted file mode 100644 index 76a591fa4e..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-methodbody.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - MethodBody - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MethodBody

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Abstract - -
    - Signature:
    -
    -     		- -
    - - - IL(ILMethodBody) - -
    - Signature: ILMethodBody
    -
    -     		- -
    - - - Native - -
    - Signature:
    -
    -     		- -
    - - - NotAvailable - -
    - Signature:
    -
    -     		- -
    - - - PInvoke(PInvokeMethod) - -
    - Signature: PInvokeMethod
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-methodcodekind.html b/docs/reference/fsharp-compiler-abstractil-il-methodcodekind.html deleted file mode 100644 index 388bfbb1b3..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-methodcodekind.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - MethodCodeKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MethodCodeKind

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - IL - -
    - Signature:
    -
    -     		- -
    - - - Native - -
    - Signature:
    -
    -     		- -
    - - - Runtime - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-methodkind.html b/docs/reference/fsharp-compiler-abstractil-il-methodkind.html deleted file mode 100644 index cf47d0f599..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-methodkind.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - MethodKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MethodKind

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Cctor - -
    - Signature:
    -
    -     		- -
    - - - Ctor - -
    - Signature:
    -
    -     		- -
    - - - NonVirtual - -
    - Signature:
    -
    -     		- -
    - - - Static - -
    - Signature:
    -
    -     		- -
    - - - Virtual(ILMethodVirtualInfo) - -
    - Signature: ILMethodVirtualInfo
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokecallingconvention.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokecallingconvention.html deleted file mode 100644 index c06f370291..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-pinvokecallingconvention.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - PInvokeCallingConvention - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PInvokeCallingConvention

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -

    PInvoke attributes.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Cdecl - -
    - Signature:
    -
    -     		- -
    - - - Fastcall - -
    - Signature:
    -
    -     		- -
    - - - None - -
    - Signature:
    -
    -     		- -
    - - - Stdcall - -
    - Signature:
    -
    -     		- -
    - - - Thiscall - -
    - Signature:
    -
    -     		- -
    - - - WinApi - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokecharbestfit.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokecharbestfit.html deleted file mode 100644 index 1f3eb7fb8f..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-pinvokecharbestfit.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - PInvokeCharBestFit - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PInvokeCharBestFit

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Disabled - -
    - Signature:
    -
    -     		- -
    - - - Enabled - -
    - Signature:
    -
    -     		- -
    - - - UseAssembly - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokecharencoding.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokecharencoding.html deleted file mode 100644 index d34a3de316..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-pinvokecharencoding.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - PInvokeCharEncoding - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PInvokeCharEncoding

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Ansi - -
    - Signature:
    -
    -     		- -
    - - - Auto - -
    - Signature:
    -
    -     		- -
    - - - None - -
    - Signature:
    -
    -     		- -
    - - - Unicode - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokemethod.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokemethod.html deleted file mode 100644 index 6859e1617c..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-pinvokemethod.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - PInvokeMethod - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PInvokeMethod

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - CallingConv - -
    - Signature: PInvokeCallingConvention
    -
    -     		- -
    - - - CharBestFit - -
    - Signature: PInvokeCharBestFit
    -
    -     		- -
    - - - CharEncoding - -
    - Signature: PInvokeCharEncoding
    -
    -     		- -
    - - - LastError - -
    - Signature: bool
    -
    -     		- -
    - - - Name - -
    - Signature: string
    -
    -     		- -
    - - - NoMangle - -
    - Signature: bool
    -
    -     		- -
    - - - ThrowOnUnmappableChar - -
    - Signature: PInvokeThrowOnUnmappableChar
    -
    -     		- -
    - - - Where - -
    - Signature: ILModuleRef
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokethrowonunmappablechar.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokethrowonunmappablechar.html deleted file mode 100644 index bd160bf3fa..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-pinvokethrowonunmappablechar.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - PInvokeThrowOnUnmappableChar - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PInvokeThrowOnUnmappableChar

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Disabled - -
    - Signature:
    -
    -     		- -
    - - - Enabled - -
    - Signature:
    -
    -     		- -
    - - - UseAssembly - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-primaryassembly.html b/docs/reference/fsharp-compiler-abstractil-il-primaryassembly.html deleted file mode 100644 index f50ea24c48..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-primaryassembly.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - PrimaryAssembly - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PrimaryAssembly

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Mscorlib - -
    - Signature:
    -
    -     		- -
    - - - NetStandard - -
    - Signature:
    -
    -     		- -
    - - - System_Runtime - -
    - Signature:
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-publickey.html b/docs/reference/fsharp-compiler-abstractil-il-publickey.html deleted file mode 100644 index 22e446154d..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il-publickey.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - PublicKey - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PublicKey

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: IL -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - PublicKey(byte []) - -
    - Signature: byte []
    -
    -     		- -
    - - - PublicKeyToken(byte []) - -
    - Signature: byte []
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - IsKey - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsKey

    -
    - - - IsKeyToken - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsKeyToken

    -
    - - - Key - -
    - Signature: byte []
    -
    -     		- -

    CompiledName: get_Key

    -
    - - - KeyToken - -
    - Signature: byte []
    -
    -     		- -

    CompiledName: get_KeyToken

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - KeyAsToken(arg1) - -
    - Signature: (byte []) -> PublicKey
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il.html b/docs/reference/fsharp-compiler-abstractil-il.html deleted file mode 100644 index 9b4ba9ecc0..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-il.html +++ /dev/null @@ -1,3896 +0,0 @@ - - - - - IL - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    IL

    -

    - Namespace: FSharp.Compiler.AbstractIL
    -

    -
    -

    The "unlinked" view of .NET metadata and code. Central to the Abstract IL library

    - -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - ILAlignment -
    - ILArgConvention -
    - ILArrayBound -

    Array shapes. For most purposes the rank is the only thing that matters.

    - -
    - ILArrayBounds -

    Lower-bound/size pairs

    - -
    - ILArrayShape -
    - ILAssemblyLongevity -
    - ILAssemblyManifest -

    The main module of an assembly is a module plus some manifest information.

    - -
    - ILAssemblyRef -
    - ILAttribElem -
    - ILAttribute -

    Custom attribute.

    - -
    - ILAttributeNamedArg -

    Named args: values and flags indicating if they are fields or properties.

    - -
    - ILAttributes -
    - ILAttributesStored -

    Represents the efficiency-oriented storage of ILAttributes in another item.

    - -
    - ILBasicType -
    - ILBoxity -
    - ILCallingConv -
    - ILCallingSignature -
    - ILCode -
    - ILCodeLabel -

    ILCode labels. In structured code each code label refers to a basic block somewhere in the code of the method.

    - -
    - ILComparisonInstr -
    - ILConst -
    - ILDefaultPInvokeEncoding -

    Default Unicode encoding for P/Invoke within a type.

    - -
    - ILEnumInfo -

    Decompose a type definition according to its kind.

    - -
    - ILEventDef -

    Event definitions.

    - -
    - ILEventDefs -

    Table of those events in a type definition.

    - -
    - ILEventRef -

    A utility type provided for completeness

    - -
    - ILExceptionClause -
    - ILExceptionSpec -
    - ILExportedTypeOrForwarder -

    these are only found in the ILExportedTypesAndForwarders table in the manifest

    - -
    - ILExportedTypesAndForwarders -
    - ILFieldDef -

    Field definitions.

    - -
    - ILFieldDefs -

    Tables of fields. Logically equivalent to a list of fields but the table is kept in -a form to allow efficient looking up fields by name.

    - -
    - ILFieldInit -

    Field Init

    - -
    - ILFieldRef -

    Formal identities of fields.

    - -
    - ILFieldSpec -

    Field specs. The data given for a ldfld, stfld etc. instruction.

    - -
    - ILGenericArgs -

    Actual generic parameters are always types.

    - -
    - ILGenericArgsList -
    - ILGenericParameterDef -

    Generic parameters. Formal generic parameter declarations may include the bounds, if any, on the generic parameter.

    - -
    - ILGenericParameterDefs -
    - ILGenericVariance -
    - ILGlobals -

    A table of common references to items in primary assembly (System.Runtime or mscorlib). -If a particular version of System.Runtime.dll has been loaded then you should -reference items from it via an ILGlobals for that specific version built using mkILGlobals.

    - -
    - ILGuid -

    Represents guids

    - -
    - ILInstr -

    The instruction set.

    - -
    - ILLazyMethodBody -
    - ILLocal -

    Local variables

    - -
    - ILLocalDebugInfo -
    - ILLocalDebugMapping -

    Indicates that a particular local variable has a particular source -language name within a given set of ranges. This does not effect local -variable numbering, which is global over the whole method.

    - -
    - ILLocals -
    - ILLocalsAllocator -

    Helpers for codegen: scopes for allocating new temporary variables.

    - -
    - ILMemberAccess -

    Member Access

    - -
    - ILMethodBody -

    IL method bodies

    - -
    - ILMethodDef -

    IL Method definitions.

    - -
    - ILMethodDefs -

    Tables of methods. Logically equivalent to a list of methods but -the table is kept in a form optimized for looking up methods by -name and arity.

    - -
    - ILMethodImplDef -

    Method Impls

    - -
    - ILMethodImplDefs -
    - ILMethodRef -

    Formal identities of methods.

    - -
    - ILMethodSpec -

    The information at the callsite of a method

    - -
    - ILMethodVirtualInfo -
    - ILModuleDef -

    One module in the "current" assembly, either a main-module or -an auxiliary module. The main module will have a manifest.

    -

    An assembly is built by joining together a "main" module plus -several auxiliary modules.

    - -
    - ILModuleRef -
    - ILNativeResource -
    - ILNativeType -

    Native Types, for marshalling to the native C interface. -These are taken directly from the ILASM syntax, see ECMA Spec (Partition II, 7.4).

    - -
    - ILNativeVariant -
    - ILNestedExportedType -

    these are only found in the "Nested" field of ILExportedTypeOrForwarder objects

    - -
    - ILNestedExportedTypes -
    - ILOverridesSpec - -
    - ILParameter -

    Method parameters and return values.

    - -
    - ILParameters -
    - ILPlatform -
    - ILPreTypeDef -

    Represents a prefix of information for ILTypeDef.

    -

    The information is enough to perform name resolution for the F# compiler, probe attributes -for ExtensionAttribute etc. This is key to the on-demand exploration of .NET metadata. -This information has to be "Goldilocks" - not too much, not too little, just right.

    - -
    - ILPropertyDef -

    Property definitions

    - -
    - ILPropertyDefs -

    Table of properties in an IL type definition.

    - -
    - ILPropertyRef -

    A utility type provided for completeness

    - -
    - ILReadonly -
    - ILReferences -
    - ILResource -

    "Manifest ILResources" are chunks of resource data, being one of: -- the data section of the current module (byte[] of resource given directly). -- in an external file in this assembly (offset given in the ILResourceLocation field). -- as a resources in another assembly of the same name.

    - -
    - ILResourceAccess -
    - ILResourceLocation -
    - ILResources -

    Table of resources in a module.

    - -
    - ILReturn -

    Method return values.

    - -
    - ILScopeRef -
    - ILSecurityAction -
    - ILSecurityDecl -
    - ILSecurityDecls -

    Abstract type equivalent to ILSecurityDecl list - use helpers -below to construct/destruct these.

    - -
    - ILSecurityDeclsStored -

    Represents the efficiency-oriented storage of ILSecurityDecls in another item.

    - -
    - ILSourceDocument -

    Debug info. Values of type "source" can be attached at sequence -points and some other locations.

    - -
    - ILSourceMarker -
    - ILTailcall -
    - ILThisConvention -
    - ILToken -
    - ILType -
    - ILTypeDef -

    Represents IL Type Definitions.

    - -
    - ILTypeDefAccess -

    Type Access.

    - -
    - ILTypeDefKind -

    A categorization of type definitions into "kinds"

    - -
    - ILTypeDefLayout -

    Type Layout information.

    - -
    - ILTypeDefLayoutInfo -
    - ILTypeDefStored -
    - ILTypeDefs -

    Tables of named type definitions.

    - -
    - ILTypeInit -

    Indicate the initialization semantics of a type.

    - -
    - ILTypeRef -

    Type refs, i.e. references to types in some .NET assembly

    - -
    - ILTypeSpec -

    Type specs and types.

    - -
    - ILTypes -
    - ILVarArgs -
    - ILVersionInfo -
    - ILVolatility -
    - MethodBody -
    - MethodCodeKind -
    - MethodKind -
    - PInvokeCallingConvention -

    PInvoke attributes.

    - -
    - PInvokeCharBestFit -
    - PInvokeCharEncoding -
    - PInvokeMethod -
    - PInvokeThrowOnUnmappableChar -
    - PrimaryAssembly -
    - PublicKey -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - addILTypeDef arg1 arg2 - -
    - Signature: ILTypeDef -> ILTypeDefs -> ILTypeDefs
    -
    -     		- -
    - - - andTailness arg1 arg2 - -
    - Signature: ILTailcall -> bool -> ILTailcall
    -
    -     		- -
    - - - buildILCode arg1 lab2pc instrs arg4 arg5 - -
    - Signature: string -> lab2pc:Dictionary<ILCodeLabel,int> -> instrs:ILInstr [] -> ILExceptionSpec list -> ILLocalDebugInfo list -> ILCode
    -
    -     		- -
    - - - compareILVersions arg1 arg2 - -
    - Signature: ILVersionInfo -> ILVersionInfo -> int
    -
    -     		- -
    - - - computeILEnumInfo (arg1, arg2) - -
    - Signature: (string * ILFieldDefs) -> ILEnumInfo
    -
    -     		- -
    - - - computeILRefs arg1 - -
    - Signature: ILModuleDef -> ILReferences
    -
    -     		-

    Find the full set of assemblies referenced by a module.

    - - -
    - - - decodeILAttribData arg1 arg2 - -
    - Signature: ILGlobals -> ILAttribute -> ILAttribElem list * ILAttributeNamedArg list
    -
    -     		-

    Not all custom attribute data can be decoded without binding types. In particular -enums must be bound in order to discover the size of the underlying integer. -The following assumes enums have size int32.

    - - -
    - - - destILArrTy arg1 - -
    - Signature: ILType -> ILArrayShape * ILType
    -
    -     		- -
    - - - destTypeDefsWithGlobalFunctionsFirst (...) - -
    - Signature: ILGlobals -> ILTypeDefs -> ILTypeDef list
    -
    -     		-

    When writing a binary the fake "toplevel" type definition (called ) -must come first. This function puts it first, and creates it in the returned -list as an empty typedef if it doesn't already exist.

    - - -
    - - - EcmaMscorlibILGlobals - -
    - Signature: ILGlobals
    -
    -     		- -
    - - - ecmaPublicKey - -
    - Signature: PublicKey
    -
    -     		-

    This is a 'vendor neutral' way of referencing mscorlib.

    - - -
    - - - emptyILCustomAttrs - -
    - Signature: ILAttributes
    -
    -     		- -
    - - - emptyILEvents - -
    - Signature: ILEventDefs
    -
    -     		- -
    - - - emptyILFields - -
    - Signature: ILFieldDefs
    -
    -     		- -
    - - - emptyILMethodImpls - -
    - Signature: ILMethodImplDefs
    -
    -     		- -
    - - - emptyILMethods - -
    - Signature: ILMethodDefs
    -
    -     		- -
    - - - emptyILProperties - -
    - Signature: ILPropertyDefs
    -
    -     		- -
    - - - emptyILRefs - -
    - Signature: ILReferences
    -
    -     		- -
    - - - emptyILSecurityDecls - -
    - Signature: ILSecurityDecls
    -
    -     		- -
    - - - emptyILTypeDefs - -
    - Signature: ILTypeDefs
    -
    -     		- -
    - - - formatCodeLabel arg1 - -
    - Signature: ILCodeLabel -> string
    -
    -     		- -
    - - - formatILVersion arg1 - -
    - Signature: ILVersionInfo -> string
    -
    -     		- -
    - - - generateCodeLabel () - -
    - Signature: unit -> ILCodeLabel
    -
    -     		-

    Making code.

    - - -
    - - - getCustomAttrData arg1 arg2 - -
    - Signature: ILGlobals -> ILAttribute -> byte []
    -
    -     		- -
    - - - getTyOfILEnumInfo arg1 - -
    - Signature: ILEnumInfo -> ILType
    -
    -     		- -
    - - - instILType arg1 arg2 - -
    - Signature: ILGenericArgs -> ILType -> ILType
    -
    -     		-

    Instantiate type variables that occur within types and other items.

    - - -
    - - - instILTypeAux arg1 arg2 arg3 - -
    - Signature: int -> ILGenericArgs -> ILType -> ILType
    -
    -     		-

    Instantiate type variables that occur within types and other items.

    - - -
    - - - isILArrTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILBoolTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILByteTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILCharTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILDoubleTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILInt16Ty arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILInt32Ty arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILInt64Ty arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILIntPtrTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILObjectTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		-

    Discriminating different important built-in types.

    - - -
    - - - isILSByteTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILSingleTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILStringTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILTypedReferenceTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILUInt16Ty arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILUInt32Ty arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILUInt64Ty arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isILUIntPtrTy arg1 - -
    - Signature: ILType -> bool
    -
    -     		- -
    - - - isTypeNameForGlobalFunctions arg1 - -
    - Signature: string -> bool
    -
    -     		- -
    - - - methBodyAbstract - -
    - Signature: ILLazyMethodBody
    -
    -     		- -
    - - - methBodyNative - -
    - Signature: ILLazyMethodBody
    -
    -     		- -
    - - - methBodyNotAvailable - -
    - Signature: ILLazyMethodBody
    -
    -     		- -
    - - - mkCallBaseConstructor (arg1, arg2) - -
    - Signature: (ILType * ILType list) -> ILInstr list
    -
    -     		- -
    - - - mkCtorMethSpecForDelegate (...) - -
    - Signature: ILGlobals -> (ILType * bool) -> ILMethodSpec
    -
    -     		-

    Given a delegate type definition which lies in a particular scope, -make a reference to its constructor.

    - - -
    - - - mkILArr1DTy arg1 - -
    - Signature: ILType -> ILType
    -
    -     		- -
    - - - mkILArrTy (arg1, arg2) - -
    - Signature: (ILType * ILArrayShape) -> ILType
    -
    -     		- -
    - - - mkILBoxedTy arg1 arg2 - -
    - Signature: ILTypeRef -> ILGenericArgsList -> ILType
    -
    -     		- -
    - - - mkILBoxedType arg1 - -
    - Signature: ILTypeSpec -> ILType
    -
    -     		- -
    - - - mkILCallSig (arg1, arg2, arg3) - -
    - Signature: (ILCallingConv * ILType list * ILType) -> ILCallingSignature
    -
    -     		- -
    - - - mkILClassCtor arg1 - -
    - Signature: MethodBody -> ILMethodDef
    -
    -     		- -
    - - - mkILCtor (arg1, arg2, arg3) - -
    - Signature: (ILMemberAccess * ILParameter list * MethodBody) -> ILMethodDef
    -
    -     		- -
    - - - mkILCtorMethSpecForTy (arg1, arg2) - -
    - Signature: (ILType * ILType list) -> ILMethodSpec
    -
    -     		-

    Construct references to constructors.

    - - -
    - - - mkILCustomAttribMethRef (...) - -
    - Signature: ILGlobals -> (ILMethodSpec * ILAttribElem list * ILAttributeNamedArg list) -> ILAttribute
    -
    -     		-

    Make custom attributes.

    - - -
    - - - mkILCustomAttribute (...) - -
    - Signature: ILGlobals -> (ILTypeRef * ILType list * ILAttribElem list * ILAttributeNamedArg list) -> ILAttribute
    -
    -     		- -
    - - - mkILCustomAttrs arg1 - -
    - Signature: ILAttribute list -> ILAttributes
    -
    -     		-

    Making tables of custom attributes, etc.

    - - -
    - - - mkILCustomAttrsFromArray arg1 - -
    - Signature: ILAttribute [] -> ILAttributes
    -
    -     		- -
    - - - mkILCustomAttrsReader arg1 - -
    - Signature: (int32 -> ILAttribute []) -> ILAttributesStored
    -
    -     		- -
    - - - mkILDelegateMethods (...) - -
    - Signature: ILMemberAccess -> ILGlobals -> (ILType * ILType) -> (ILParameter list * ILReturn) -> ILMethodDef list
    -
    -     		- -
    - - - mkILEmptyGenericParams - -
    - Signature: ILGenericParameterDefs
    -
    -     		-

    Make a formal generic parameters.

    - - -
    - - - mkILEvents arg1 - -
    - Signature: ILEventDef list -> ILEventDefs
    -
    -     		- -
    - - - mkILEventsLazy arg1 - -
    - Signature: Lazy<ILEventDef list> -> ILEventDefs
    -
    -     		- -
    - - - mkILExportedTypes arg1 - -
    - Signature: ILExportedTypeOrForwarder list -> ILExportedTypesAndForwarders
    -
    -     		- -
    - - - mkILExportedTypesLazy arg1 - -
    - Signature: Lazy<ILExportedTypeOrForwarder list> -> ILExportedTypesAndForwarders
    -
    -     		- -
    - - - mkILFieldRef (arg1, arg2, arg3) - -
    - Signature: (ILTypeRef * string * ILType) -> ILFieldRef
    -
    -     		-

    Construct references to fields.

    - - -
    - - - mkILFields arg1 - -
    - Signature: ILFieldDef list -> ILFieldDefs
    -
    -     		- -
    - - - mkILFieldsLazy arg1 - -
    - Signature: Lazy<ILFieldDef list> -> ILFieldDefs
    -
    -     		- -
    - - - mkILFieldSpec (arg1, arg2) - -
    - Signature: (ILFieldRef * ILType) -> ILFieldSpec
    -
    -     		- -
    - - - mkILFieldSpecInTy (arg1, arg2, arg3) - -
    - Signature: (ILType * string * ILType) -> ILFieldSpec
    -
    -     		- -
    - - - mkILFormalBoxedTy arg1 arg2 - -
    - Signature: ILTypeRef -> ILGenericParameterDef list -> ILType
    -
    -     		-

    Make generalized versions of possibly-generic types, e.g. Given the ILTypeDef for List, return the type "List".

    - - -
    - - - mkILFormalGenericArgs arg1 arg2 - -
    - Signature: int -> ILGenericParameterDefs -> ILGenericArgsList
    -
    -     		- -
    - - - mkILFormalNamedTy arg1 arg2 arg3 - -
    - Signature: ILBoxity -> ILTypeRef -> ILGenericParameterDef list -> ILType
    -
    -     		- -
    - - - mkILFormalTypars arg1 - -
    - Signature: ILType list -> ILGenericParameterDefs
    -
    -     		- -
    - - - mkILGenericClass (...) - -
    - Signature: (string * ILTypeDefAccess * ILGenericParameterDefs * ILType * ILType list * ILMethodDefs * ILFieldDefs * ILTypeDefs * ILPropertyDefs * ILEventDefs * ILAttributes * ILTypeInit) -> ILTypeDef
    -
    -     		-

    Make a type definition.

    - - -
    - - - mkILGenericNonVirtualMethod (...) - -
    - Signature: (string * ILMemberAccess * ILGenericParameterDefs * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    -
    -     		- -
    - - - mkILGenericVirtualMethod (...) - -
    - Signature: (string * ILMemberAccess * ILGenericParameterDefs * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    -
    -     		- -
    - - - mkILGlobals arg1 - -
    - Signature: ILScopeRef -> ILGlobals
    -
    -     		-

    Build the table of commonly used references given functions to find types in system assemblies

    - - -
    - - - mkILInstanceField (...) - -
    - Signature: (string * ILType * ILFieldInit option * ILMemberAccess) -> ILFieldDef
    -
    -     		-

    Make field definitions.

    - - -
    - - - mkILInstanceMethSpecInTy (...) - -
    - Signature: (ILType * string * ILType list * ILType * ILGenericArgsList) -> ILMethodSpec
    -
    -     		-

    Construct references to instance methods.

    - - -
    - - - mkILLiteralField (...) - -
    - Signature: (string * ILType * ILFieldInit * byte [] option * ILMemberAccess) -> ILFieldDef
    -
    -     		- -
    - - - mkILLocal arg1 arg2 - -
    - Signature: ILType -> (string * int * int) option -> ILLocal
    -
    -     		- -
    - - - mkILMethodBody (...) - -
    - Signature: (initlocals:bool * ILLocals * int * ILCode * ILSourceMarker option) -> ILMethodBody
    -
    -     		-

    Make method definitions.

    - - -
    - - - mkILMethodImpls arg1 - -
    - Signature: ILMethodImplDef list -> ILMethodImplDefs
    -
    -     		- -
    - - - mkILMethodImplsLazy arg1 - -
    - Signature: Lazy<ILMethodImplDef list> -> ILMethodImplDefs
    -
    -     		- -
    - - - mkILMethods arg1 - -
    - Signature: ILMethodDef list -> ILMethodDefs
    -
    -     		- -
    - - - mkILMethodsComputed arg1 - -
    - Signature: (unit -> ILMethodDef []) -> ILMethodDefs
    -
    -     		- -
    - - - mkILMethodsFromArray arg1 - -
    - Signature: ILMethodDef [] -> ILMethodDefs
    -
    -     		- -
    - - - mkILMethRef (...) - -
    - Signature: (ILTypeRef * ILCallingConv * string * int * ILType list * ILType) -> ILMethodRef
    -
    -     		-

    Make method references and specs.

    - - -
    - - - mkILMethSpec (arg1, arg2, arg3, arg4) - -
    - Signature: (ILMethodRef * ILBoxity * ILGenericArgsList * ILGenericArgsList) -> ILMethodSpec
    -
    -     		- -
    - - - mkILMethSpecForMethRefInTy (...) - -
    - Signature: (ILMethodRef * ILType * ILGenericArgsList) -> ILMethodSpec
    -
    -     		- -
    - - - mkILMethSpecInTy (...) - -
    - Signature: (ILType * ILCallingConv * string * ILType list * ILType * ILGenericArgsList) -> ILMethodSpec
    -
    -     		- -
    - - - mkILNamedTy arg1 arg2 arg3 - -
    - Signature: ILBoxity -> ILTypeRef -> ILGenericArgsList -> ILType
    -
    -     		- -
    - - - mkILNestedExportedTypes arg1 - -
    - Signature: ILNestedExportedType list -> ILNestedExportedTypes
    -
    -     		- -
    - - - mkILNestedExportedTypesLazy arg1 - -
    - Signature: Lazy<ILNestedExportedType list> -> ILNestedExportedTypes
    -
    -     		- -
    - - - mkILNestedTyRef (arg1, arg2, arg3) - -
    - Signature: (ILScopeRef * string list * string) -> ILTypeRef
    -
    -     		-

    Make type refs.

    - - -
    - - - mkILNonGenericBoxedTy arg1 - -
    - Signature: ILTypeRef -> ILType
    -
    -     		- -
    - - - mkILNonGenericEmptyCtor arg1 arg2 - -
    - Signature: ILSourceMarker option -> ILType -> ILMethodDef
    -
    -     		- -
    - - - mkILNonGenericInstanceMethod (...) - -
    - Signature: (string * ILMemberAccess * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    -
    -     		- -
    - - - mkILNonGenericInstanceMethSpecInTy (...) - -
    - Signature: (ILType * string * ILType list * ILType) -> ILMethodSpec
    -
    -     		-

    Construct references to instance methods.

    - - -
    - - - mkILNonGenericMethSpecInTy (...) - -
    - Signature: (ILType * ILCallingConv * string * ILType list * ILType) -> ILMethodSpec
    -
    -     		-

    Construct references to methods on a given type .

    - - -
    - - - mkILNonGenericStaticMethod (...) - -
    - Signature: (string * ILMemberAccess * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    -
    -     		- -
    - - - mkILNonGenericStaticMethSpecInTy (...) - -
    - Signature: (ILType * string * ILType list * ILType) -> ILMethodSpec
    -
    -     		-

    Construct references to static, non-generic methods.

    - - -
    - - - mkILNonGenericTySpec arg1 - -
    - Signature: ILTypeRef -> ILTypeSpec
    -
    -     		-

    Make type specs.

    - - -
    - - - mkILNonGenericValueTy arg1 - -
    - Signature: ILTypeRef -> ILType
    -
    -     		- -
    - - - mkILNonGenericVirtualMethod (...) - -
    - Signature: (string * ILMemberAccess * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    -
    -     		- -
    - - - mkILParam (arg1, arg2) - -
    - Signature: (string option * ILType) -> ILParameter
    -
    -     		-

    Derived functions for making return, parameter and local variable -objects for use in method definitions.

    - - -
    - - - mkILParamAnon arg1 - -
    - Signature: ILType -> ILParameter
    -
    -     		- -
    - - - mkILParamNamed (arg1, arg2) - -
    - Signature: (string * ILType) -> ILParameter
    -
    -     		- -
    - - - mkILPreTypeDef arg1 - -
    - Signature: ILTypeDef -> ILPreTypeDef
    -
    -     		- -
    - - - mkILPreTypeDefComputed (...) - -
    - Signature: (string list * string * (unit -> ILTypeDef)) -> ILPreTypeDef
    -
    -     		- -
    - - - mkILPreTypeDefRead (...) - -
    - Signature: (string list * string * int32 * ILTypeDefStored) -> ILPreTypeDef
    -
    -     		- -
    - - - mkILProperties arg1 - -
    - Signature: ILPropertyDef list -> ILPropertyDefs
    -
    -     		- -
    - - - mkILPropertiesLazy arg1 - -
    - Signature: Lazy<ILPropertyDef list> -> ILPropertyDefs
    -
    -     		- -
    - - - mkILResources arg1 - -
    - Signature: ILResource list -> ILResources
    -
    -     		- -
    - - - mkILReturn arg1 - -
    - Signature: ILType -> ILReturn
    -
    -     		- -
    - - - mkILSecurityDecls arg1 - -
    - Signature: ILSecurityDecl list -> ILSecurityDecls
    -
    -     		- -
    - - - mkILSecurityDeclsReader arg1 - -
    - Signature: (int32 -> ILSecurityDecl []) -> ILSecurityDeclsStored
    -
    -     		- -
    - - - mkILSimpleClass (...) - -
    - Signature: ILGlobals -> (string * ILTypeDefAccess * ILMethodDefs * ILFieldDefs * ILTypeDefs * ILPropertyDefs * ILEventDefs * ILAttributes * ILTypeInit) -> ILTypeDef
    -
    -     		- -
    - - - mkILSimpleModule (...) - -
    - Signature: assemblyName:string -> moduleName:string -> dll:bool -> subsystemVersion:(int * int) -> useHighEntropyVA:bool -> ILTypeDefs -> int32 option -> string option -> int -> ILExportedTypesAndForwarders -> string -> ILModuleDef
    -
    -     		-

    Making modules.

    - - -
    - - - mkILSimpleStorageCtor (...) - -
    - Signature: (ILSourceMarker option * ILTypeSpec option * ILType * ILParameter list * (string * ILType) list * ILMemberAccess) -> ILMethodDef
    -
    -     		- -
    - - - mkILSimpleStorageCtorWithParamNames (...) - -
    - Signature: (ILSourceMarker option * ILTypeSpec option * ILType * ILParameter list * (string * string * ILType) list * ILMemberAccess) -> ILMethodDef
    -
    -     		- -
    - - - mkILSimpleTypar arg1 - -
    - Signature: string -> ILGenericParameterDef
    -
    -     		- -
    - - - mkILStaticField (...) - -
    - Signature: (string * ILType * ILFieldInit option * byte [] option * ILMemberAccess) -> ILFieldDef
    -
    -     		- -
    - - - mkILStaticMethod (...) - -
    - Signature: (ILGenericParameterDefs * string * ILMemberAccess * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    -
    -     		- -
    - - - mkILStaticMethSpecInTy (...) - -
    - Signature: (ILType * string * ILType list * ILType * ILGenericArgsList) -> ILMethodSpec
    -
    -     		-

    Construct references to static methods.

    - - -
    - - - mkILStorageCtor (...) - -
    - Signature: (ILSourceMarker option * ILInstr list * ILType * (string * ILType) list * ILMemberAccess) -> ILMethodDef
    -
    -     		-

    Derived functions for making some simple constructors

    - - -
    - - - mkILTy arg1 arg2 - -
    - Signature: ILBoxity -> ILTypeSpec -> ILType
    -
    -     		-

    Make types.

    - - -
    - - - mkILTypeDefForGlobalFunctions (...) - -
    - Signature: ILGlobals -> (ILMethodDefs * ILFieldDefs) -> ILTypeDef
    -
    -     		- -
    - - - mkILTypeDefReader arg1 - -
    - Signature: (int32 -> ILTypeDef) -> ILTypeDefStored
    -
    -     		- -
    - - - mkILTypeDefs arg1 - -
    - Signature: ILTypeDef list -> ILTypeDefs
    -
    -     		- -
    - - - mkILTypeDefsComputed arg1 - -
    - Signature: (unit -> ILPreTypeDef []) -> ILTypeDefs
    -
    -     		-

    Create table of types which is loaded/computed on-demand, and whose individual -elements are also loaded/computed on-demand. Any call to tdefs.AsList will -result in the laziness being forced. Operations can examine the -custom attributes and name of each type in order to decide whether -to proceed with examining the other details of the type.

    -

    Note that individual type definitions may contain further delays -in their method, field and other tables.

    - - -
    - - - mkILTypeDefsFromArray arg1 - -
    - Signature: ILTypeDef [] -> ILTypeDefs
    -
    -     		- -
    - - - mkILTypeForGlobalFunctions arg1 - -
    - Signature: ILScopeRef -> ILType
    -
    -     		-

    The toplevel "class" for a module or assembly.

    - - -
    - - - mkILTyRef (arg1, arg2) - -
    - Signature: (ILScopeRef * string) -> ILTypeRef
    -
    -     		- -
    - - - mkILTyRefInTyRef (arg1, arg2) - -
    - Signature: (ILTypeRef * string) -> ILTypeRef
    -
    -     		- -
    - - - mkILTySpec (arg1, arg2) - -
    - Signature: (ILTypeRef * ILGenericArgsList) -> ILTypeSpec
    -
    -     		- -
    - - - mkILTyvarTy arg1 - -
    - Signature: uint16 -> ILType
    -
    -     		- -
    - - - mkILValueTy arg1 arg2 - -
    - Signature: ILTypeRef -> ILGenericArgsList -> ILType
    -
    -     		- -
    - - - mkLdarg arg1 - -
    - Signature: uint16 -> ILInstr
    -
    -     		- -
    - - - mkLdarg0 - -
    - Signature: ILInstr
    -
    -     		- -
    - - - mkLdcInt32 arg1 - -
    - Signature: int32 -> ILInstr
    -
    -     		- -
    - - - mkLdloc arg1 - -
    - Signature: uint16 -> ILInstr
    -
    -     		- -
    - - - mkMethBodyAux arg1 - -
    - Signature: MethodBody -> ILLazyMethodBody
    -
    -     		- -
    - - - mkMethBodyLazyAux arg1 - -
    - Signature: Lazy<MethodBody> -> ILLazyMethodBody
    -
    -     		- -
    - - - mkMethodBody (...) - -
    - Signature: (bool * ILLocals * int * ILCode * ILSourceMarker option) -> MethodBody
    -
    -     		- -
    - - - mkNormalCall arg1 - -
    - Signature: ILMethodSpec -> ILInstr
    -
    -     		-

    Derived functions for making some common patterns of instructions.

    - - -
    - - - mkNormalCallconstraint (arg1, arg2) - -
    - Signature: (ILType * ILMethodSpec) -> ILInstr
    -
    -     		- -
    - - - mkNormalCallvirt arg1 - -
    - Signature: ILMethodSpec -> ILInstr
    -
    -     		- -
    - - - mkNormalLdfld arg1 - -
    - Signature: ILFieldSpec -> ILInstr
    -
    -     		- -
    - - - mkNormalLdflda arg1 - -
    - Signature: ILFieldSpec -> ILInstr
    -
    -     		- -
    - - - mkNormalLdobj arg1 - -
    - Signature: ILType -> ILInstr
    -
    -     		- -
    - - - mkNormalLdsfld arg1 - -
    - Signature: ILFieldSpec -> ILInstr
    -
    -     		- -
    - - - mkNormalNewobj arg1 - -
    - Signature: ILMethodSpec -> ILInstr
    -
    -     		- -
    - - - mkNormalStfld arg1 - -
    - Signature: ILFieldSpec -> ILInstr
    -
    -     		- -
    - - - mkNormalStobj arg1 - -
    - Signature: ILType -> ILInstr
    -
    -     		- -
    - - - mkNormalStsfld arg1 - -
    - Signature: ILFieldSpec -> ILInstr
    -
    -     		- -
    - - - mkPermissionSet arg1 (arg2, arg3) - -
    - Signature: ILGlobals -> (ILSecurityAction * (ILTypeRef * (string * ILType * ILAttribElem) list) list) -> ILSecurityDecl
    -
    -     		- -
    - - - mkRawDataValueTypeDef (...) - -
    - Signature: ILType -> (string * size:int32 * pack:uint16) -> ILTypeDef
    -
    -     		-

    Make a type definition for a value type used to point to raw data. -These are useful when generating array initialization code -according to the -ldtoken field valuetype ''/'\[struct0x6000127-1' '<PrivateImplementationDetails>'::'\]method0x6000127-1' -call void System.Runtime.CompilerServices.RuntimeHelpers::InitializeArray(class System.Array,valuetype System.RuntimeFieldHandle) -idiom.

    - - -
    - - - mkRefForILField arg1 (arg2, arg3) arg4 - -
    - Signature: ILScopeRef -> (ILTypeDef list * ILTypeDef) -> ILFieldDef -> ILFieldRef
    -
    -     		- -
    - - - mkRefForILMethod arg1 (arg2, arg3) arg4 - -
    - Signature: ILScopeRef -> (ILTypeDef list * ILTypeDef) -> ILMethodDef -> ILMethodRef
    -
    -     		- -
    - - - mkRefForNestedILTypeDef (...) - -
    - Signature: ILScopeRef -> (ILTypeDef list * ILTypeDef) -> ILTypeRef
    -
    -     		-

    Generate references to existing type definitions, method definitions -etc. Useful for generating references, e.g. to a class we're processing -Also used to reference type definitions that we've generated. ILScopeRef -is normally ILScopeRef.Local, unless we've generated the ILTypeDef in -an auxiliary module or are generating multiple assemblies at -once.

    - - -
    - - - mkRefToILAssembly arg1 - -
    - Signature: ILAssemblyManifest -> ILAssemblyRef
    -
    -     		- -
    - - - mkRefToILField (arg1, arg2) - -
    - Signature: (ILTypeRef * ILFieldDef) -> ILFieldRef
    -
    -     		- -
    - - - mkRefToILMethod (arg1, arg2) - -
    - Signature: (ILTypeRef * ILMethodDef) -> ILMethodRef
    -
    -     		- -
    - - - mkRefToILModule arg1 - -
    - Signature: ILModuleDef -> ILModuleRef
    -
    -     		- -
    - - - mkSimpleAssemblyRef arg1 - -
    - Signature: string -> ILAssemblyRef
    -
    -     		-

    Generate simple references to assemblies and modules.

    - - -
    - - - mkSimpleModRef arg1 - -
    - Signature: string -> ILModuleRef
    -
    -     		- -
    - - - mkStloc arg1 - -
    - Signature: uint16 -> ILInstr
    -
    -     		- -
    - - - mkTypeForwarder arg1 arg2 arg3 arg4 arg5 - -
    - Signature: ILScopeRef -> string -> ILNestedExportedTypes -> ILAttributes -> ILTypeDefAccess -> ILExportedTypeOrForwarder
    -
    -     		- -
    - - - NoMetadataIdx - -
    - Signature: int32
    -
    -     		- -
    - - - nonBranchingInstrsToCode arg1 - -
    - Signature: ILInstr list -> ILCode
    -
    -     		-

    Make some code that is a straight line sequence of instructions. -The function will add a "return" if the last instruction is not an exiting instruction.

    - - -
    - - - parseILVersion arg1 - -
    - Signature: string -> ILVersionInfo
    -
    -     		-

    Get a version number from a CLR version string, e.g. 1.0.3705.0

    - - -
    - - - prependInstrsToClassCtor arg1 arg2 arg3 - -
    - Signature: ILInstr list -> ILSourceMarker option -> ILTypeDef -> ILTypeDef
    -
    -     		-

    Injecting initialization code into a class. -Add some code to the end of the .cctor for a type. Create a .cctor -if one doesn't exist already.

    - - -
    - - - prependInstrsToCode arg1 arg2 - -
    - Signature: ILInstr list -> ILCode -> ILCode
    -
    -     		-

    Injecting code into existing code blocks. A branch will -be added from the given instructions to the (unique) entry of -the code, and the first instruction will be the new entry -of the method. The instructions should be non-branching.

    - - -
    - - - prependInstrsToMethod arg1 arg2 - -
    - Signature: ILInstr list -> ILMethodDef -> ILMethodDef
    -
    -     		- -
    - - - rescopeILFieldRef arg1 arg2 - -
    - Signature: ILScopeRef -> ILFieldRef -> ILFieldRef
    -
    -     		-

    Rescoping. The first argument tells the function how to reference the original scope from -the new scope.

    - - -
    - - - rescopeILMethodRef arg1 arg2 - -
    - Signature: ILScopeRef -> ILMethodRef -> ILMethodRef
    -
    -     		-

    Rescoping. The first argument tells the function how to reference the original scope from -the new scope.

    - - -
    - - - rescopeILScopeRef arg1 arg2 - -
    - Signature: ILScopeRef -> ILScopeRef -> ILScopeRef
    -
    -     		-

    Rescoping. The first argument tells the function how to reference the original scope from -the new scope.

    - - -
    - - - rescopeILType arg1 arg2 - -
    - Signature: ILScopeRef -> ILType -> ILType
    -
    -     		-

    Rescoping. The first argument tells the function how to reference the original scope from -the new scope.

    - - -
    - - - rescopeILTypeSpec arg1 arg2 - -
    - Signature: ILScopeRef -> ILTypeSpec -> ILTypeSpec
    -
    -     		-

    Rescoping. The first argument tells the function how to reference the original scope from -the new scope.

    - - -
    - - - resolveILMethodRef arg1 arg2 - -
    - Signature: ILTypeDef -> ILMethodRef -> ILMethodDef
    -
    -     		-

    Find the method definition corresponding to the given property or -event operation. These are always in the same class as the property -or event. This is useful especially if your code is not using the Ilbind -API to bind references.

    - - -
    - - - resolveILMethodRefWithRescope (...) - -
    - Signature: (ILType -> ILType) -> ILTypeDef -> ILMethodRef -> ILMethodDef
    -
    -     		- -
    - - - runningOnMono - -
    - Signature: bool
    -
    -     		- -
    - - - sha1HashBytes arg1 - -
    - Signature: byte [] -> byte []
    -
    -     		-

    Get a public key token from a public key.

    - - -
    - - - sha1HashInt64 arg1 - -
    - Signature: byte [] -> int64
    -
    -     		- -
    - - - splitILTypeName arg1 - -
    - Signature: string -> string list * string
    -
    -     		-

    The splitILTypeName utility helps you split a string representing -a type name into the leading namespace elements (if any), the -names of any nested types and the type name itself. This function -memoizes and interns the splitting of the namespace portion of -the type name.

    - - -
    - - - splitILTypeNameWithPossibleStaticArguments (...) - -
    - Signature: string -> string [] * string
    -
    -     		- -
    - - - splitNamespace arg1 - -
    - Signature: string -> string list
    -
    -     		- -
    - - - splitNamespaceToArray arg1 - -
    - Signature: string -> string []
    -
    -     		- -
    - - - splitTypeNameRight arg1 - -
    - Signature: string -> string option * string
    -
    -     		- splitTypeNameRight is like splitILTypeName except the - namespace is kept as a whole string, rather than split at dots. - -
    - - - storeILCustomAttrs arg1 - -
    - Signature: ILAttributes -> ILAttributesStored
    -
    -     		- -
    - - - storeILSecurityDecls arg1 - -
    - Signature: ILSecurityDecls -> ILSecurityDeclsStored
    -
    -     		- -
    - - - typeNameForGlobalFunctions - -
    - Signature: string
    -
    -     		- -
    - - - typesOfILParams arg1 - -
    - Signature: ILParameters -> ILType list
    -
    -     		- -
    - - - unscopeILType arg1 - -
    - Signature: ILType -> ILType
    -
    -     		-

    Unscoping. Clears every scope information, use for looking up IL method references only.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilmodulereader.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilmodulereader.html deleted file mode 100644 index b33a55ea14..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilmodulereader.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - ILModuleReader - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILModuleReader

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: ILBinaryReader -

    -
    -

    Represents a reader of the metadata of a .NET binary. May also give some values (e.g. IL code) from the PE file -if it was provided.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - ILAssemblyRefs - -
    - Signature: ILAssemblyRef list
    - Modifiers: abstract
    -
    -     		- -

    CompiledName: get_ILAssemblyRefs

    -
    - - - ILModuleDef - -
    - Signature: ILModuleDef
    - Modifiers: abstract
    -
    -     		- -

    CompiledName: get_ILModuleDef

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadermetadatasnapshot.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadermetadatasnapshot.html deleted file mode 100644 index 83010f8729..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadermetadatasnapshot.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ILReaderMetadataSnapshot - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILReaderMetadataSnapshot

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: ILBinaryReader -

    -
    -

    Used to implement a Binary file over native memory, used by Roslyn integration

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreaderoptions.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreaderoptions.html deleted file mode 100644 index e427fe2f21..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreaderoptions.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - ILReaderOptions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILReaderOptions

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: ILBinaryReader -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - ilGlobals - -
    - Signature: ILGlobals
    -
    -     		- -
    - - - metadataOnly - -
    - Signature: MetadataOnlyFlag
    -
    -     		-

    Only open a metadata reader for the metadata portion of the .NET binary without keeping alive any data associated with the PE reader -- IL code will not be available (mdBody in ILMethodDef will return NotAvailable) -- Managed resources will be reported back as ILResourceLocation.LocalIn (as always) -- Native resources will not be available (none will be returned) -- Static data associated with fields will not be available

    - - -
    - - - pdbDirPath - -
    - Signature: string option
    -
    -     		- -
    - - - reduceMemoryUsage - -
    - Signature: ReduceMemoryFlag
    -
    -     		- -
    - - - tryGetMetadataSnapshot - -
    - Signature: ILReaderTryGetMetadataSnapshot
    -
    -     		-

    A function to call to try to get an object that acts as a snapshot of the metadata section of a .NET binary, -and from which we can read the metadata. Only used when metadataOnly=true.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadertrygetmetadatasnapshot.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadertrygetmetadatasnapshot.html deleted file mode 100644 index 842cc60176..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadertrygetmetadatasnapshot.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - ILReaderTryGetMetadataSnapshot - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILReaderTryGetMetadataSnapshot

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: ILBinaryReader -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-metadataonlyflag.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-metadataonlyflag.html deleted file mode 100644 index 43ecb00fb1..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-metadataonlyflag.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - MetadataOnlyFlag - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MetadataOnlyFlag

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: ILBinaryReader -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - No - -
    - Signature:
    -
    -     		- -
    - - - Yes - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-reducememoryflag.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-reducememoryflag.html deleted file mode 100644 index a61229961b..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-reducememoryflag.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ReduceMemoryFlag - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ReduceMemoryFlag

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: ILBinaryReader -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - No - -
    - Signature:
    -
    -     		- -
    - - - Yes - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-defaultassemblyreader.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-defaultassemblyreader.html deleted file mode 100644 index cc09376e94..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-defaultassemblyreader.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - DefaultAssemblyReader - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    DefaultAssemblyReader

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: Shim -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-iassemblyreader.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-iassemblyreader.html deleted file mode 100644 index 8c4f467b8f..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-iassemblyreader.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - IAssemblyReader - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    IAssemblyReader

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: Shim -

    -
    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - GetILModuleReader(...) - -
    - Signature: (filename:string * readerOptions:ILReaderOptions) -> ILModuleReader
    - Modifiers: abstract
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim.html deleted file mode 100644 index d048e0b8da..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - Shim - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Shim

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: ILBinaryReader -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - -
    TypeDescription
    - DefaultAssemblyReader -
    - IAssemblyReader -
    - -
    - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - AssemblyReader - -
    - Signature: IAssemblyReader
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-statistics.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-statistics.html deleted file mode 100644 index 999981b52a..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-statistics.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - Statistics - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Statistics

    -

    - Namespace: FSharp.Compiler.AbstractIL
    - Parent Module: ILBinaryReader -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - byteFileCount - -
    - Signature: int
    - Modifiers: mutable
    -
    -     		- -
    - - - memoryMapFileClosedCount - -
    - Signature: int
    - Modifiers: mutable
    -
    -     		- -
    - - - memoryMapFileOpenedCount - -
    - Signature: int
    - Modifiers: mutable
    -
    -     		- -
    - - - rawMemoryFileCount - -
    - Signature: int
    - Modifiers: mutable
    -
    -     		- -
    - - - weakByteFileCount - -
    - Signature: int
    - Modifiers: mutable
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader.html deleted file mode 100644 index 0b3f61db50..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - ILBinaryReader - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ILBinaryReader

    -

    - Namespace: FSharp.Compiler.AbstractIL
    -

    -
    -

    Binary reader. Read a .NET binary and concert it to Abstract IL data -structures.

    -

    NOTE: -- The metadata in the loaded modules will be relative to -those modules, e.g. ILScopeRef.Local will mean "local to -that module". You must use [rescopeILType] etc. if you want to include -(i.e. copy) the metadata into your own module.

    -
      -
    • -

      PDB (debug info) reading/folding: -The PDB reader is invoked if you give a PDB path -This indicates if you want to search for PDB files and have the -reader fold them in. You cannot currently name the pdb file -directly - you can only name the path. Giving "None" says -"do not read the PDB file even if one exists".

      -

      The debug info appears primarily as I_seqpoint annotations in -the instruction streams. Unfortunately the PDB information does -not, for example, tell you how to map back from a class definition -to a source code line number - you will need to explicitly search -for a sequence point in the code for one of the methods of the -class. That is not particularly satisfactory, and it may be -a good idea to build a small library which extracts the information -you need.

      -
      • -
    - -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - ILModuleReader -

    Represents a reader of the metadata of a .NET binary. May also give some values (e.g. IL code) from the PE file -if it was provided.

    - -
    - ILReaderMetadataSnapshot -

    Used to implement a Binary file over native memory, used by Roslyn integration

    - -
    - ILReaderOptions -
    - ILReaderTryGetMetadataSnapshot -
    - MetadataOnlyFlag -
    - ReduceMemoryFlag -
    - Statistics -
    - - - - - - - - - - -
    ModuleDescription
    - Shim -
    - -
    - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - GetStatistics () - -
    - Signature: unit -> Statistics
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-anycallerthreadtoken.html b/docs/reference/fsharp-compiler-abstractil-internal-library-anycallerthreadtoken.html deleted file mode 100644 index 6c8ad18262..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-anycallerthreadtoken.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - AnyCallerThreadToken - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    AnyCallerThreadToken

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Represents a token that indicates execution on a any of several potential user threads calling the F# compiler services.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> AnyCallerThreadToken
    -
    -     		- -

    CompiledName: .ctor

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-array.html b/docs/reference/fsharp-compiler-abstractil-internal-library-array.html deleted file mode 100644 index 33989af1e7..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-array.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - Array - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Array

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - areEqual xs ys - -
    - Signature: xs:'T [] -> ys:'T [] -> bool
    - Type parameters: 'T
    -     		-

    Optimized arrays equality. ~100x faster than array1 = array2 on strings. -~2x faster for floats -~0.8x slower for ints

    - - -
    - - - endsWith suffix whole - -
    - Signature: suffix:'a [] -> whole:'a [] -> bool
    - Type parameters: 'a
    -     		-

    Returns true if one array has trailing elements equal to another's.

    - - -
    - - - existsOne p l - -
    - Signature: p:('a -> bool) -> l:'a [] -> bool
    - Type parameters: 'a
    -     		- -
    - - - existsTrue arr - -
    - Signature: arr:bool [] -> bool
    -
    -     		- -
    - - - findFirstIndexWhereTrue arr p - -
    - Signature: arr:'a [] -> p:('a -> bool) -> int
    - Type parameters: 'a
    -     		- -
    - - - heads array - -
    - Signature: array:'T [] -> 'T [] []
    - Type parameters: 'T
    -     		-

    Returns all heads of a given array. -For [|1;2;3|] it returns [|[|1; 2; 3|]; [|1; 2|]; [|1|]|]

    - - -
    - - - isSubArray subArray wholeArray index - -
    - Signature: subArray:'T [] -> wholeArray:'T [] -> index:int -> bool
    - Type parameters: 'T
    -     		-

    check if subArray is found in the wholeArray starting -at the provided index

    - - -
    - - - lengthsEqAndForall2 p l1 l2 - -
    - Signature: p:('c -> 'd -> bool) -> l1:'c [] -> l2:'d [] -> bool
    - Type parameters: 'c, 'd
    -     		- -
    - - - mapAsync mapping array - -
    - Signature: mapping:('T -> Async<'U>) -> array:'T [] -> Async<'U []>
    - Type parameters: 'T, 'U
    -     		-

    Async implementation of Array.map.

    - - -
    - - - mapq f inp - -
    - Signature: f:('?17396 -> '?17396) -> inp:'?17396 [] -> '?17396 []
    - Type parameters: '?17396
    -     		- -
    - - - order eltOrder - -
    - Signature: eltOrder:IComparer<'T> -> IComparer<'T array>
    - Type parameters: 'T
    -     		- -
    - - - replace index value array - -
    - Signature: index:int -> value:'a -> array:'a [] -> 'a []
    - Type parameters: 'a
    -     		-

    Returns a new array with an element replaced with a given value.

    - - -
    - - - revInPlace array - -
    - Signature: array:'T [] -> unit
    - Type parameters: 'T
    -     		-

    pass an array byref to reverse it in place

    - - -
    - - - startsWith prefix whole - -
    - Signature: prefix:'a [] -> whole:'a [] -> bool
    - Type parameters: 'a
    -     		-

    Returns true if one array has another as its subset from index 0.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-cancellable-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-cancellable-1.html deleted file mode 100644 index 6ebeb4fb7a..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-cancellable-1.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - Cancellable<'TResult> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Cancellable<'TResult>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Represents a cancellable computation with explicit representation of a cancelled result.

    -

    A cancellable computation is passed may be cancelled via a CancellationToken, which is propagated implicitly.
    -If cancellation occurs, it is propagated as data rather than by raising an OperationCanceledException.

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - Cancellable(...) - -
    - Signature: CancellationToken -> ValueOrCancelled<'TResult>
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablebuilder.html b/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablebuilder.html deleted file mode 100644 index 1c3c8367a9..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablebuilder.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - CancellableBuilder - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CancellableBuilder

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> CancellableBuilder
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Bind(e, k) - -
    - Signature: (e:Cancellable<'a> * k:('a -> Cancellable<'b>)) -> Cancellable<'b>
    - Type parameters: 'a, 'b
    -     		- -
    - - - Combine(e1, e2) - -
    - Signature: (e1:Cancellable<unit> * e2:Cancellable<'a>) -> Cancellable<'a>
    - Type parameters: 'a
    -     		- -
    - - - Delay(f) - -
    - Signature: (f:(unit -> Cancellable<'a>)) -> Cancellable<'a>
    - Type parameters: 'a
    -     		- -
    - - - Return(v) - -
    - Signature: v:'a -> Cancellable<'a>
    - Type parameters: 'a
    -     		- -
    - - - ReturnFrom(v) - -
    - Signature: v:'a -> 'a
    - Type parameters: 'a
    -     		- -
    - - - TryFinally(e, compensation) - -
    - Signature: (e:Cancellable<'?17269> * compensation:(unit -> unit)) -> Cancellable<'?17269>
    - Type parameters: '?17269
    -     		- -
    - - - TryWith(e, handler) - -
    - Signature: (e:Cancellable<'a> * handler:(exn -> Cancellable<'a>)) -> Cancellable<'a>
    - Type parameters: 'a
    -     		- -
    - - - Using(resource, e) - -
    - Signature: (resource:'a * e:('a -> Cancellable<'b>)) -> Cancellable<'b>
    - Type parameters: 'a, 'b
    -     		- -
    - - - Zero() - -
    - Signature: unit -> Cancellable<unit>
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablemodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablemodule.html deleted file mode 100644 index a07bf0efab..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablemodule.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - Cancellable - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Cancellable

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - bind f comp1 - -
    - Signature: f:('?17627 -> Cancellable<'?17628>) -> comp1:Cancellable<'?17627> -> Cancellable<'?17628>
    - Type parameters: '?17627, '?17628
    -     		-

    Bind the result of a cancellable computation

    - - -
    - - - canceled () - -
    - Signature: unit -> Cancellable<'a>
    - Type parameters: 'a
    -     		-

    Represents a canceled computation

    - - -
    - - - delay f - -
    - Signature: f:(unit -> Cancellable<'T>) -> Cancellable<'T>
    - Type parameters: 'T
    -     		-

    Delay a cancellable computation

    - - -
    - - - each f seq - -
    - Signature: f:('a -> Cancellable<'b>) -> seq:seq<'a> -> Cancellable<'b list>
    - Type parameters: 'a, 'b
    -     		-

    Iterate a cancellable computation over a collection

    - - -
    - - - fold f acc seq - -
    - Signature: f:('a -> 'b -> Cancellable<'a>) -> acc:'a -> seq:seq<'b> -> Cancellable<'a>
    - Type parameters: 'a, 'b
    -     		-

    Fold a cancellable computation along a sequence of inputs

    - - -
    - - - map f oper - -
    - Signature: f:('?17630 -> '?17631) -> oper:Cancellable<'?17630> -> Cancellable<'?17631>
    - Type parameters: '?17630, '?17631
    -     		-

    Map the result of a cancellable computation

    - - -
    - - - ret x - -
    - Signature: x:'?17633 -> Cancellable<'?17633>
    - Type parameters: '?17633
    -     		-

    Return a simple value as the result of a cancellable computation

    - - -
    - - - run ct arg2 - -
    - Signature: ct:CancellationToken -> Cancellable<'a> -> ValueOrCancelled<'a>
    - Type parameters: 'a
    -     		-

    Run a cancellable computation using the given cancellation token

    - - -
    - - - runWithoutCancellation comp - -
    - Signature: comp:Cancellable<'a> -> 'a
    - Type parameters: 'a
    -     		-

    Run the computation in a mode where it may not be cancelled. The computation never results in a -ValueOrCancelled.Cancelled.

    - - -
    - - - token () - -
    - Signature: unit -> Cancellable<CancellationToken>
    -
    -     		-

    Bind the cancellation token associated with the computation

    - - -
    - - - tryFinally e compensation - -
    - Signature: e:Cancellable<'?17650> -> compensation:(unit -> unit) -> Cancellable<'?17650>
    - Type parameters: '?17650
    -     		-

    Implement try/finally for a cancellable computation

    - - -
    - - - tryWith e handler - -
    - Signature: e:Cancellable<'?17652> -> handler:(exn -> Cancellable<'?17652>) -> Cancellable<'?17652>
    - Type parameters: '?17652
    -     		-

    Implement try/with for a cancellable computation

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-compilationthreadtoken.html b/docs/reference/fsharp-compiler-abstractil-internal-library-compilationthreadtoken.html deleted file mode 100644 index bde97054fe..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-compilationthreadtoken.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - CompilationThreadToken - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompilationThreadToken

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Represents a token that indicates execution on the compilation thread, i.e. -- we have full access to the (partially mutable) TAST and TcImports data structures -- compiler execution may result in type provider invocations when resolving types and members -- we can access various caches in the SourceCodeServices

    -

    Like other execution tokens this should be passed via argument passing and not captured/stored beyond -the lifetime of stack-based calls. This is not checked, it is a discipline within the compiler code.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> CompilationThreadToken
    -
    -     		- -

    CompiledName: .ctor

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-dictionary.html b/docs/reference/fsharp-compiler-abstractil-internal-library-dictionary.html deleted file mode 100644 index 8bcaa02caa..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-dictionary.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - Dictionary - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Dictionary

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - newWithSize size - -
    - Signature: size:int -> Dictionary<'a,'b>
    - Type parameters: 'a, 'b
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-dictionaryextensions.html b/docs/reference/fsharp-compiler-abstractil-internal-library-dictionaryextensions.html deleted file mode 100644 index fba9bcbe25..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-dictionaryextensions.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - DictionaryExtensions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    DictionaryExtensions

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> DictionaryExtensions
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Static members

    - - - - - - - - - - - - - - -
    Static memberDescription
    - - - BagAdd(dic, key, value) - -
    - Signature: (dic:Dictionary<'key,'value list> * key:'key * value:'value) -> unit
    - Type parameters: 'key, 'value
    -     		- -
    - - - BagExistsValueForKey(dic, key, f) - -
    - Signature: (dic:Dictionary<'key,'value list> * key:'key * f:('value -> bool)) -> bool
    - Type parameters: 'key, 'value
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-eventually-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-eventually-1.html deleted file mode 100644 index 8995cfa4df..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-eventually-1.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - Eventually<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Eventually<'T>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Computations that can cooperatively yield by returning a continuation

    -
      -
    • -

      Any yield of a NotYetDone should typically be "abandonable" without adverse consequences. No resource release -will be called when the computation is abandoned.

      -
      • -
    • -

      Computations suspend via a NotYetDone may use local state (mutables), where these are -captured by the NotYetDone closure. Computations do not need to be restartable.

      -
      • -
    • -

      The key thing is that you can take an Eventually value and run it with -Eventually.repeatedlyProgressUntilDoneOrTimeShareOverOrCanceled

      -
      • -
    • Cancellation results in a suspended computation rather than complete abandonment
      • -
    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Done('T) - -
    - Signature: 'T
    -
    -     		- -
    - - - NotYetDone(...) - -
    - Signature: CompilationThreadToken -> Eventually<'T>
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallybuilder.html b/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallybuilder.html deleted file mode 100644 index 5f893330ef..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallybuilder.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - EventuallyBuilder - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    EventuallyBuilder

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> EventuallyBuilder
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Bind(e, k) - -
    - Signature: (e:Eventually<'a> * k:('a -> Eventually<'b>)) -> Eventually<'b>
    - Type parameters: 'a, 'b
    -     		- -
    - - - Combine(e1, e2) - -
    - Signature: (e1:Eventually<unit> * e2:Eventually<'a>) -> Eventually<'a>
    - Type parameters: 'a
    -     		- -
    - - - Delay(f) - -
    - Signature: (f:(unit -> Eventually<'a>)) -> Eventually<'a>
    - Type parameters: 'a
    -     		- -
    - - - Return(v) - -
    - Signature: v:'a -> Eventually<'a>
    - Type parameters: 'a
    -     		- -
    - - - ReturnFrom(v) - -
    - Signature: v:'a -> 'a
    - Type parameters: 'a
    -     		- -
    - - - TryFinally(e, compensation) - -
    - Signature: (e:Eventually<'?17287> * compensation:(unit -> unit)) -> Eventually<'?17287>
    - Type parameters: '?17287
    -     		- -
    - - - TryWith(e, handler) - -
    - Signature: (e:Eventually<'a> * handler:(Exception -> Eventually<'a>)) -> Eventually<'a>
    - Type parameters: 'a
    -     		- -
    - - - Zero() - -
    - Signature: unit -> Eventually<unit>
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallymodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallymodule.html deleted file mode 100644 index cfe4cb895d..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallymodule.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - Eventually - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Eventually

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - bind k e - -
    - Signature: k:('?17679 -> Eventually<'?17680>) -> e:Eventually<'?17679> -> Eventually<'?17680>
    - Type parameters: '?17679, '?17680
    -     		- -
    - - - box e - -
    - Signature: e:Eventually<'c> -> Eventually<obj>
    - Type parameters: 'c
    -     		- -
    - - - catch e - -
    - Signature: e:Eventually<'?17685> -> Eventually<ResultOrException<'?17685>>
    - Type parameters: '?17685
    -     		- -
    - - - delay f - -
    - Signature: f:(unit -> Eventually<'T>) -> Eventually<'T>
    - Type parameters: 'T
    -     		- -
    - - - fold f acc seq - -
    - Signature: f:('a -> 'b -> Eventually<'a>) -> acc:'a -> seq:seq<'b> -> Eventually<'a>
    - Type parameters: 'a, 'b
    -     		- -
    - - - force ctok e - -
    - Signature: ctok:CompilationThreadToken -> e:Eventually<'a> -> 'a
    - Type parameters: 'a
    -     		- -
    - - - forceAsync runner e - -
    - Signature: runner:((CompilationThreadToken -> Eventually<'T>) -> Async<Eventually<'T>>) -> e:Eventually<'T> -> Async<'T option>
    - Type parameters: 'T
    -     		-

    Keep running the asynchronous computation bit by bit. The runner gets called each time the computation is restarted. -Can be cancelled as an Async in the normal way.

    - - -
    - - - forceWhile ctok check e - -
    - Signature: ctok:CompilationThreadToken -> check:(unit -> bool) -> e:Eventually<'?17670> -> '?17670 option
    - Type parameters: '?17670
    -     		- -
    - - - repeatedlyProgressUntilDoneOrTimeShareOverOrCanceled (...) - -
    - Signature: timeShareInMilliseconds:int64 -> ct:CancellationToken -> runner:(CompilationThreadToken -> ('b -> Eventually<'c>) -> Eventually<'c>) -> e:Eventually<'c> -> Eventually<'c>
    - Type parameters: 'b, 'c
    -     		-

    Keep running the computation bit by bit until a time limit is reached. -The runner gets called each time the computation is restarted

    -

    If cancellation happens, the operation is left half-complete, ready to resume.

    - - -
    - - - token - -
    - Signature: Eventually<CompilationThreadToken>
    -
    -     		- -
    - - - tryFinally e compensation - -
    - Signature: e:Eventually<'?17689> -> compensation:(unit -> unit) -> Eventually<'?17689>
    - Type parameters: '?17689
    -     		- -
    - - - tryWith e handler - -
    - Signature: e:Eventually<'?17691> -> handler:(Exception -> Eventually<'?17691>) -> Eventually<'?17691>
    - Type parameters: '?17691
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-executiontoken.html b/docs/reference/fsharp-compiler-abstractil-internal-library-executiontoken.html deleted file mode 100644 index 340f20d76e..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-executiontoken.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ExecutionToken - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ExecutionToken

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Represents a permission active at this point in execution

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-inlinedelayinit-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-inlinedelayinit-1.html deleted file mode 100644 index 7c9cb685ec..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-inlinedelayinit-1.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - InlineDelayInit<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    InlineDelayInit<'T>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    An efficient lazy for inline storage in a class type. Results in fewer thunks.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - func - -
    - Signature: Func<'T>
    - Modifiers: mutable
    -
    -     		- -
    - - - store - -
    - Signature: 'T
    - Modifiers: mutable
    -
    -     		- -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(f) - -
    - Signature: (f:(unit -> 'T)) -> InlineDelayInit<'T>
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Value - -
    - Signature: 'T
    -
    -     		- -

    CompiledName: get_Value

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer-1.html deleted file mode 100644 index dfb16a42a5..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer-1.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - IPartialEqualityComparer<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    IPartialEqualityComparer<'T>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Interface that defines methods for comparing objects using partial equality relation

    - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - InEqualityRelation(arg1) - -
    - Signature: 'T -> bool
    - Modifiers: abstract
    -
    -     		-

    Can the specified object be tested for equality?

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer.html b/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer.html deleted file mode 100644 index 8b091a4745..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - IPartialEqualityComparer - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    IPartialEqualityComparer

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - On f c - -
    - Signature: f:('a -> 'b) -> c:IPartialEqualityComparer<'b> -> IPartialEqualityComparer<'a>
    - Type parameters: 'a, 'b
    -     		- -
    - - - partialDistinctBy per seq - -
    - Signature: per:IPartialEqualityComparer<'T> -> seq:'T list -> 'T list
    - Type parameters: 'T
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmap-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmap-2.html deleted file mode 100644 index 87c6f91f9a..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmap-2.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - LayeredMap<'Key, 'Value> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LayeredMap<'Key, 'Value>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Count - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Count

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [key] - -
    - Signature: key:'Key -> 'Value
    -
    -     		- -

    CompiledName: get_Item

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmultimap-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmultimap-2.html deleted file mode 100644 index f50b0b5ce1..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmultimap-2.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - LayeredMultiMap<'Key, 'Value> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LayeredMultiMap<'Key, 'Value>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Immutable map collection, with explicit flattening to a backing dictionary

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(contents) - -
    - Signature: (contents:LayeredMap<'Key,'Value list>) -> LayeredMultiMap<'Key,'Value>
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Add(k, v) - -
    - Signature: (k:'Key * v:'Value) -> LayeredMultiMap<'Key,'Value>
    -
    -     		- -
    - - - AddAndMarkAsCollapsible(kvs) - -
    - Signature: (kvs:KeyValuePair<'Key,'Value> []) -> LayeredMultiMap<'Key,'Value>
    -
    -     		- -
    - - - [k] - -
    - Signature: k:'Key -> 'Value list
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - MarkAsCollapsible() - -
    - Signature: unit -> LayeredMultiMap<'Key,'Value>
    -
    -     		- -
    - - - TryFind(k) - -
    - Signature: k:'Key -> 'Value list option
    -
    -     		- -
    - - - TryGetValue(k) - -
    - Signature: k:'Key -> bool * 'Value list
    -
    -     		- -
    - - - Values - -
    - Signature: 'Value list
    -
    -     		- -

    CompiledName: get_Values

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: LayeredMultiMap<'Key,'Value>
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-lazy.html b/docs/reference/fsharp-compiler-abstractil-internal-library-lazy.html deleted file mode 100644 index c62139156d..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-lazy.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - Lazy - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Lazy

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - force x - -
    - Signature: x:Lazy<'T> -> 'T
    - Type parameters: 'T
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontext-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontext-2.html deleted file mode 100644 index 23c7a6011c..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontext-2.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - LazyWithContext<'T, 'ctxt> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LazyWithContext<'T, 'ctxt>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Just like "Lazy" but EVERY forcer must provide an instance of "ctxt", e.g. to help track errors -on forcing back to at least one sensible user location

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - findOriginalException - -
    - Signature: exn -> exn
    -
    -     		-

    A helper to ensure we rethrow the "original" exception

    - - -
    - - - funcOrException - -
    - Signature: obj
    - Modifiers: mutable
    -
    -     		-

    This field holds either the function to run or a LazyWithContextFailure object recording the exception raised -from running the function. It is null if the thunk has been evaluated successfully.

    - - -
    - - - value - -
    - Signature: 'T
    - Modifiers: mutable
    -
    -     		-

    This field holds the result of a successful computation. It's initial value is Unchecked.defaultof

    - - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Force(ctxt) - -
    - Signature: ctxt:'ctxt -> 'T
    -
    -     		- -
    - - - IsDelayed - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsDelayed

    -
    - - - IsForced - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsForced

    -
    - - - UnsynchronizedForce(ctxt) - -
    - Signature: ctxt:'ctxt -> 'T
    -
    -     		- -
    -

    Static members

    - - - - - - - - - - - - - - -
    Static memberDescription
    - - - Create(f, findOriginalException) - -
    - Signature: (f:('ctxt -> 'T) * findOriginalException:(exn -> exn)) -> LazyWithContext<'T,'ctxt>
    -
    -     		- -
    - - - NotLazy(x) - -
    - Signature: x:'T -> LazyWithContext<'T,'ctxt>
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontextfailure.html b/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontextfailure.html deleted file mode 100644 index 46ac04677f..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontextfailure.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - LazyWithContextFailure - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LazyWithContextFailure

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(exn) - -
    - Signature: exn:exn -> LazyWithContextFailure
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Exception - -
    - Signature: exn
    -
    -     		- -

    CompiledName: get_Exception

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Undefined - -
    - Signature: LazyWithContextFailure
    -
    -     		- -

    CompiledName: get_Undefined

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-list-frontandback.html b/docs/reference/fsharp-compiler-abstractil-internal-library-list-frontandback.html deleted file mode 100644 index f4961df3ba..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-list-frontandback.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - FrontAndBack - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FrontAndBack

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: List -

    -
    -
    - - - -

    Active patterns

    - - - - - - - - - - -
    Active patternDescription
    - - - ( |NonEmpty|Empty| ) l - -
    - Signature: l:'?17530 list -> Choice<('?17530 list * '?17530),unit>
    - Type parameters: '?17530
    -     		- -

    CompiledName: |NonEmpty|Empty|

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-list.html b/docs/reference/fsharp-compiler-abstractil-internal-library-list.html deleted file mode 100644 index 8dc49813ca..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-list.html +++ /dev/null @@ -1,641 +0,0 @@ - - - - - List - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    List

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - -
    ModuleDescription
    - FrontAndBack -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - assoc x l - -
    - Signature: x:'d -> l:('d * 'e) list -> 'e
    - Type parameters: 'd, 'e
    -     		- -
    - - - checkq l1 l2 - -
    - Signature: l1:'?17451 list -> l2:'?17451 list -> bool
    - Type parameters: '?17451
    -     		- -
    - - - collect2 f xs ys - -
    - Signature: f:('?17501 -> '?17502 -> '?17503 list) -> xs:'?17501 list -> ys:'?17502 list -> '?17503 list
    - Type parameters: '?17501, '?17502, '?17503
    -     		- -
    - - - collectFold f s l - -
    - Signature: f:('a -> 'b -> 'c list * 'a) -> s:'a -> l:'b list -> 'c list * 'a
    - Type parameters: 'a, 'b, 'c
    -     		- -
    - - - collectSquared f xss - -
    - Signature: f:('a2 -> 'a3 list) -> xss:'a2 list list -> 'a3 list
    - Type parameters: 'a2, 'a3
    -     		- -
    - - - count pred xs - -
    - Signature: pred:('b -> bool) -> xs:'b list -> int
    - Type parameters: 'b
    -     		- -
    - - - drop n l - -
    - Signature: n:int -> l:'a list -> 'a list
    - Type parameters: 'a
    -     		- -
    - - - existsi f xs - -
    - Signature: f:(int -> 'a2 -> bool) -> xs:'a2 list -> bool
    - Type parameters: 'a2
    -     		- -
    - - - existsSquared f xss - -
    - Signature: f:('a -> bool) -> xss:'a list list -> bool
    - Type parameters: 'a
    -     		- -
    - - - existsTrue xs - -
    - Signature: xs:bool list -> bool
    -
    -     		- -
    - - - findi n f l - -
    - Signature: n:int -> f:('?17443 -> bool) -> l:'?17443 list -> ('?17443 * int) option
    - Type parameters: '?17443
    -     		- -
    - - - forallSquared f xss - -
    - Signature: f:('?17519 -> bool) -> xss:'?17519 list list -> bool
    - Type parameters: '?17519
    -     		- -
    - - - frontAndBack l - -
    - Signature: l:'a list -> 'a list * 'a
    - Type parameters: 'a
    -     		- -
    - - - headAndTail l - -
    - Signature: l:'a list -> 'a * 'a list
    - Type parameters: 'a
    -     		- -
    - - - indexNotFound () - -
    - Signature: unit -> '?17480
    - Type parameters: '?17480
    -     		- -
    - - - iter3 f l1 l2 l3 - -
    - Signature: f:('?17471 -> '?17472 -> '?17473 -> unit) -> l1:'?17471 list -> l2:'?17472 list -> l3:'?17473 list -> unit
    - Type parameters: '?17471, '?17472, '?17473
    -     		- -
    - - - iterSquared f xss - -
    - Signature: f:('a -> unit) -> xss:'a list list -> unit
    - Type parameters: 'a
    -     		- -
    - - - lengthsEqAndForall2 p l1 l2 - -
    - Signature: p:('a -> 'b -> bool) -> l1:'a list -> l2:'b list -> bool
    - Type parameters: 'a, 'b
    -     		- -
    - - - mapFoldSquared f z xss - -
    - Signature: f:('a2 -> 'a3 -> 'a4 * 'a2) -> z:'a2 -> xss:'a3 list list -> 'a4 list list * 'a2
    - Type parameters: 'a2, 'a3, 'a4
    -     		- -
    - - - mapHeadTail fhead ftail _arg1 - -
    - Signature: fhead:('a -> 'b) -> ftail:('a -> 'b) -> _arg1:'a list -> 'b list
    - Type parameters: 'a, 'b
    -     		- -
    - - - mapiFoldSquared f z xss - -
    - Signature: f:('a2 -> int * int * 'a3 -> 'a4 * 'a2) -> z:'a2 -> xss:'a3 list list -> 'a4 list list * 'a2
    - Type parameters: 'a2, 'a3, 'a4
    -     		- -
    - - - mapiSquared f xss - -
    - Signature: f:(int -> int -> 'a -> 'b) -> xss:'a list list -> 'b list list
    - Type parameters: 'a, 'b
    -     		- -
    - - - mapNth n f xs - -
    - Signature: n:int -> f:('a -> 'a) -> xs:'a list -> 'a list
    - Type parameters: 'a
    -     		- -
    - - - mapq f inp - -
    - Signature: f:('T -> 'T) -> inp:'T list -> 'T list
    - Type parameters: 'T
    -     		- -
    - - - mapSquared f xss - -
    - Signature: f:('a -> 'b) -> xss:'a list list -> 'b list list
    - Type parameters: 'a, 'b
    -     		- -
    - - - memAssoc x l - -
    - Signature: x:'d -> l:('d * 'e) list -> bool
    - Type parameters: 'd, 'e
    -     		- -
    - - - memq x l - -
    - Signature: x:'c -> l:'c list -> bool
    - Type parameters: 'c
    -     		- -
    - - - order eltOrder - -
    - Signature: eltOrder:IComparer<'T> -> IComparer<'T list>
    - Type parameters: 'T
    -     		- -
    - - - range n m - -
    - Signature: n:int -> m:int -> int list
    -
    -     		- -
    - - - sortWithOrder c elements - -
    - Signature: c:IComparer<'T> -> elements:'T list -> 'T list
    - Type parameters: 'T
    -     		- -
    - - - splitAfter n l - -
    - Signature: n:int -> l:'a list -> 'a list * 'a list
    - Type parameters: 'a
    -     		- -
    - - - splitChoose select l - -
    - Signature: select:('b -> Choice<'c,'d>) -> l:'b list -> 'c list * 'd list
    - Type parameters: 'b, 'c, 'd
    -     		- -
    - - - takeUntil p l - -
    - Signature: p:('a -> bool) -> l:'a list -> 'a list * 'a list
    - Type parameters: 'a
    -     		- -
    - - - toArraySquared xss - -
    - Signature: xss:'a2 list list -> 'a2 [] []
    - Type parameters: 'a2
    -     		- -
    - - - tryRemove f inp - -
    - Signature: f:('b -> bool) -> inp:'b list -> ('b * 'b list) option
    - Type parameters: 'b
    -     		- -
    - - - unzip4 l - -
    - Signature: l:('g * 'h * 'i * 'j) list -> 'g list * 'h list * 'i list * 'j list
    - Type parameters: 'g, 'h, 'i, 'j
    -     		- -
    - - - zip4 l1 l2 l3 l4 - -
    - Signature: l1:'a2 list -> l2:'a3 list -> l3:'a4 list -> l4:'a5 list -> ('a2 * 'a3 * 'a4 * 'a5) list
    - Type parameters: 'a2, 'a3, 'a4, 'a5
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-lock-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-lock-1.html deleted file mode 100644 index cd9645b971..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-lock-1.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - Lock<'LockTokenType> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Lock<'LockTokenType>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Encapsulates a lock associated with a particular token-type representing the acquisition of that lock.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> Lock<'LockTokenType>
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - AcquireLock(f) - -
    - Signature: (f:('LockTokenType -> 'a)) -> 'a
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-locktoken.html b/docs/reference/fsharp-compiler-abstractil-internal-library-locktoken.html deleted file mode 100644 index f5af8411d6..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-locktoken.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - - LockToken - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LockToken

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    A base type for various types of tokens that must be passed when a lock is taken. -Each different static lock should declare a new subtype of this type.

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-map.html b/docs/reference/fsharp-compiler-abstractil-internal-library-map.html deleted file mode 100644 index e02872f1a6..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-map.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - Map - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Map

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - tryFindMulti k map - -
    - Signature: k:'a -> map:Map<'a,'b list> -> 'b list
    - Type parameters: 'a, 'b
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-memoizationtable-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-memoizationtable-2.html deleted file mode 100644 index 6de4f56a87..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-memoizationtable-2.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - MemoizationTable<'T, 'U> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MemoizationTable<'T, 'U>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(compute, keyComparer, canMemoize) - -
    - Signature: (compute:('T -> 'U) * keyComparer:IEqualityComparer<'T> * canMemoize:('T -> bool) option) -> MemoizationTable<'T,'U>
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Apply(x) - -
    - Signature: x:'T -> 'U
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-multimap-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-multimap-2.html deleted file mode 100644 index 5985bde8bc..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-multimap-2.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - MultiMap<'T, 'U> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MultiMap<'T, 'U>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Count - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Count

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [key] - -
    - Signature: key:'T -> 'U list
    -
    -     		- -

    CompiledName: get_Item

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-multimapmodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-multimapmodule.html deleted file mode 100644 index 1c5f444f93..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-multimapmodule.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - MultiMap - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MultiMap

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - add v x m - -
    - Signature: v:'b -> x:'c -> m:MultiMap<'b,'c> -> Map<'b,'c list>
    - Type parameters: 'b, 'c
    -     		- -
    - - - empty - -
    - Signature: MultiMap<'b,'c>
    - Type parameters: 'b, 'c
    -     		- -
    - - - existsInRange f m - -
    - Signature: f:('?17873 -> bool) -> m:MultiMap<'?17874,'?17873> -> bool
    - Type parameters: '?17873, '?17874
    -     		- -
    - - - find v m - -
    - Signature: v:'b -> m:MultiMap<'b,'c> -> 'c list
    - Type parameters: 'b, 'c
    -     		- -
    - - - initBy f xs - -
    - Signature: f:('a -> 'b) -> xs:seq<'a> -> MultiMap<'b,'a>
    - Type parameters: 'a, 'b
    -     		- -
    - - - range m - -
    - Signature: m:MultiMap<'?17882,'?17883> -> '?17883 list
    - Type parameters: '?17882, '?17883
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-namemap-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-namemap-1.html deleted file mode 100644 index 185cbb06e2..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-namemap-1.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - NameMap<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NameMap<'T>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Count - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Count

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [key] - -
    - Signature: key:string -> 'T
    -
    -     		- -

    CompiledName: get_Item

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-namemapmodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-namemapmodule.html deleted file mode 100644 index ec2f221b85..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-namemapmodule.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - NameMap - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NameMap

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - add v x m - -
    - Signature: v:string -> x:'T -> m:NameMap<'T> -> Map<string,'T>
    - Type parameters: 'T
    -     		- -
    - - - empty - -
    - Signature: Map<'b,'c>
    - Type parameters: 'b, 'c
    -     		- -
    - - - exists f m - -
    - Signature: f:('a -> 'b -> bool) -> m:Map<'a,'b> -> bool
    - Type parameters: 'a, 'b
    -     		- -
    - - - existsInRange p m - -
    - Signature: p:('?17843 -> bool) -> m:Map<'?17844,'?17843> -> bool
    - Type parameters: '?17843, '?17844
    -     		- -
    - - - filterRange f l - -
    - Signature: f:('T -> bool) -> l:NameMap<'T> -> Map<string,'T>
    - Type parameters: 'T
    -     		- -
    - - - find v m - -
    - Signature: v:string -> m:NameMap<'T> -> 'T
    - Type parameters: 'T
    -     		- -
    - - - foldBack f m z - -
    - Signature: f:(string -> 'T -> '?17779 -> '?17779) -> m:NameMap<'T> -> z:'?17779 -> '?17779
    - Type parameters: 'T, '?17779
    -     		- -
    - - - foldBackRange f l acc - -
    - Signature: f:('T -> 'a -> 'a) -> l:NameMap<'T> -> acc:'a -> 'a
    - Type parameters: 'T, 'a
    -     		- -
    - - - forall f m - -
    - Signature: f:('?17781 -> '?17782 -> bool) -> m:Map<'?17781,'?17782> -> bool
    - Type parameters: '?17781, '?17782
    -     		- -
    - - - isEmpty m - -
    - Signature: m:NameMap<'T> -> bool
    - Type parameters: 'T
    -     		- -
    - - - iter f l - -
    - Signature: f:('T -> unit) -> l:NameMap<'T> -> unit
    - Type parameters: 'T
    -     		- -
    - - - layer m1 m2 - -
    - Signature: m1:NameMap<'T> -> m2:Map<string,'T> -> Map<string,'T>
    - Type parameters: 'T
    -     		- -
    - - - layerAdditive addf m1 m2 - -
    - Signature: addf:('a list -> 'b -> 'a list) -> m1:Map<'c,'b> -> m2:Map<'c,'a list> -> Map<'c,'a list>
    - Type parameters: 'a, 'b, 'c
    -     		-

    Not a very useful function - only called in one place - should be changed

    - - -
    - - - map f l - -
    - Signature: f:('T -> 'a) -> l:NameMap<'T> -> Map<string,'a>
    - Type parameters: 'T, 'a
    -     		- -
    - - - mapFilter f l - -
    - Signature: f:('T -> '?17824 option) -> l:NameMap<'T> -> Map<string,'?17824>
    - Type parameters: 'T, '?17824
    -     		- -
    - - - mapFold f s l - -
    - Signature: f:('?17814 -> string -> 'T -> '?17816 * '?17814) -> s:'?17814 -> l:NameMap<'T> -> Map<string,'?17816> * '?17814
    - Type parameters: '?17814, 'T, '?17816
    -     		- -
    - - - mem v m - -
    - Signature: v:string -> m:NameMap<'T> -> bool
    - Type parameters: 'T
    -     		- -
    - - - ofKeyedList f l - -
    - Signature: f:('a -> 'b) -> l:'a list -> Map<'b,'a>
    - Type parameters: 'a, 'b
    -     		- -
    - - - ofList l - -
    - Signature: l:(string * 'T) list -> NameMap<'T>
    - Type parameters: 'T
    -     		- -
    - - - ofSeq l - -
    - Signature: l:seq<string * 'T> -> NameMap<'T>
    - Type parameters: 'T
    -     		- -
    - - - partition f l - -
    - Signature: f:('T -> bool) -> l:NameMap<'T> -> Map<string,'T> * Map<string,'T>
    - Type parameters: 'T
    -     		- -
    - - - range m - -
    - Signature: m:Map<'a,'b> -> 'b list
    - Type parameters: 'a, 'b
    -     		- -
    - - - suball2 errf p m1 m2 - -
    - Signature: errf:('b -> 'c -> bool) -> p:('d -> 'c -> bool) -> m1:Map<'b,'d> -> m2:Map<'b,'c> -> bool
    - Type parameters: 'b, 'c, 'd
    -     		- -
    - - - subfold2 errf f m1 m2 acc - -
    - Signature: errf:('?17805 -> '?17806 -> '?17807) -> f:('?17805 -> '?17808 -> '?17806 -> '?17807 -> '?17807) -> m1:Map<'?17805,'?17808> -> m2:Map<'?17805,'?17806> -> acc:'?17807 -> '?17807
    - Type parameters: '?17805, '?17806, '?17807, '?17808
    -     		-

    For every entry in m2 find an entry in m1 and fold

    - - -
    - - - toList l - -
    - Signature: l:NameMap<'T> -> (string * 'T) list
    - Type parameters: 'T
    -     		- -
    - - - tryFind v m - -
    - Signature: v:string -> m:NameMap<'T> -> 'T option
    - Type parameters: 'T
    -     		- -
    - - - tryFindInRange p m - -
    - Signature: p:('?17846 -> bool) -> m:Map<'?17847,'?17846> -> '?17846 option
    - Type parameters: '?17846, '?17847
    -     		- -
    - - - union unionf ms - -
    - Signature: unionf:(seq<'a> -> 'b) -> ms:seq<NameMap<'a>> -> Map<string,'b>
    - Type parameters: 'a, 'b
    -     		-

    Union entries by identical key, using the provided function to union sets of values

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimap-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimap-1.html deleted file mode 100644 index b289d376f6..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimap-1.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - NameMultiMap<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NameMultiMap<'T>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Count - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Count

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [key] - -
    - Signature: key:string -> 'T list
    -
    -     		- -

    CompiledName: get_Item

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimapmodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimapmodule.html deleted file mode 100644 index 9aa054efad..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimapmodule.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - NameMultiMap - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NameMultiMap

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - add v x m - -
    - Signature: v:string -> x:'T -> m:NameMultiMap<'T> -> Map<string,'T list>
    - Type parameters: 'T
    -     		- -
    - - - chooseRange f m - -
    - Signature: f:('T -> 'b option) -> m:NameMultiMap<'T> -> 'b list
    - Type parameters: 'T, 'b
    -     		- -
    - - - empty - -
    - Signature: NameMultiMap<'T>
    - Type parameters: 'T
    -     		- -
    - - - existsInRange f m - -
    - Signature: f:('T -> bool) -> m:NameMultiMap<'T> -> bool
    - Type parameters: 'T
    -     		- -
    - - - find v m - -
    - Signature: v:string -> m:NameMultiMap<'T> -> 'T list
    - Type parameters: 'T
    -     		- -
    - - - initBy f xs - -
    - Signature: f:('T -> string) -> xs:seq<'T> -> NameMultiMap<'T>
    - Type parameters: 'T
    -     		- -
    - - - map f m - -
    - Signature: f:('T -> '?17864) -> m:NameMultiMap<'T> -> Map<string,'?17864 list>
    - Type parameters: 'T, '?17864
    -     		- -
    - - - ofList xs - -
    - Signature: xs:(string * 'T) list -> NameMultiMap<'T>
    - Type parameters: 'T
    -     		- -
    - - - range m - -
    - Signature: m:NameMultiMap<'T> -> 'T list
    - Type parameters: 'T
    -     		- -
    - - - rangeReversingEachBucket m - -
    - Signature: m:NameMultiMap<'T> -> 'T list
    - Type parameters: 'T
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-option.html b/docs/reference/fsharp-compiler-abstractil-internal-library-option.html deleted file mode 100644 index d912df4a21..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-option.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - Option - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Option

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - attempt f - -
    - Signature: f:(unit -> 'T) -> 'T option
    - Type parameters: 'T
    -     		- -
    - - - mapFold f s opt - -
    - Signature: f:('a -> 'b -> 'c * 'a) -> s:'a -> opt:'b option -> 'c option * 'a
    - Type parameters: 'a, 'b, 'c
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-order.html b/docs/reference/fsharp-compiler-abstractil-internal-library-order.html deleted file mode 100644 index 18883c8aa9..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-order.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - Order - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Order

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - orderBy p - -
    - Signature: p:('T -> 'U) -> IComparer<'T>
    - Type parameters: 'T, 'U
    -     		- -
    - - - orderOn p pxOrder - -
    - Signature: p:('T -> 'U) -> pxOrder:IComparer<'U> -> IComparer<'T>
    - Type parameters: 'T, 'U
    -     		- -
    - - - toFunction pxOrder x y - -
    - Signature: pxOrder:IComparer<'U> -> x:'U -> y:'U -> int
    - Type parameters: 'U
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-resizearray.html b/docs/reference/fsharp-compiler-abstractil-internal-library-resizearray.html deleted file mode 100644 index f3475d61c9..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-resizearray.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - ResizeArray - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ResizeArray

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - chunkBySize chunkSize f items - -
    - Signature: chunkSize:int -> f:('t -> '?17535) -> items:ResizeArray<'t> -> '?17535 [] []
    - Type parameters: 't, '?17535
    -     		-

    Split a ResizeArray into an array of smaller chunks. -This requires items/chunkSize Array copies of length chunkSize if items/chunkSize % 0 = 0, -otherwise items/chunkSize + 1 Array copies.

    - - -
    - - - mapToSmallArrayChunks f inp - -
    - Signature: f:('t -> 'a) -> inp:ResizeArray<'t> -> 'a [] []
    - Type parameters: 't, 'a
    -     		-

    Split a large ResizeArray into a series of array chunks that are each under the Large Object Heap limit. -This is done to help prevent a stop-the-world collection of the single large array, instead allowing for a greater -probability of smaller collections. Stop-the-world is still possible, just less likely.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexception-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexception-1.html deleted file mode 100644 index 9fa60bfc84..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexception-1.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ResultOrException<'TResult> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ResultOrException<'TResult>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Exception(Exception) - -
    - Signature: Exception
    -
    -     		- -
    - - - Result('TResult) - -
    - Signature: 'TResult
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexceptionmodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexceptionmodule.html deleted file mode 100644 index de3538e910..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexceptionmodule.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - ResultOrException - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ResultOrException

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - ( |?> ) res f - -
    - Signature: res:ResultOrException<'a> -> f:('a -> 'b) -> ResultOrException<'b>
    - Type parameters: 'a, 'b
    -     		- -

    CompiledName: op_BarQmarkGreater

    -
    - - - ForceRaise res - -
    - Signature: res:ResultOrException<'a> -> 'a
    - Type parameters: 'a
    -     		- -
    - - - otherwise f x - -
    - Signature: f:(unit -> ResultOrException<'a2>) -> x:ResultOrException<'a2> -> ResultOrException<'a2>
    - Type parameters: 'a2
    -     		- -
    - - - raze b - -
    - Signature: b:exn -> ResultOrException<'b>
    - Type parameters: 'b
    -     		- -
    - - - success a - -
    - Signature: a:'b -> ResultOrException<'b>
    - Type parameters: 'b
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-shim-defaultfilesystem.html b/docs/reference/fsharp-compiler-abstractil-internal-library-shim-defaultfilesystem.html deleted file mode 100644 index 9c02a96d43..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-shim-defaultfilesystem.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - DefaultFileSystem - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    DefaultFileSystem

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Shim -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> DefaultFileSystem
    -
    -     		- -

    CompiledName: .ctor

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-shim-ifilesystem.html b/docs/reference/fsharp-compiler-abstractil-internal-library-shim-ifilesystem.html deleted file mode 100644 index 149a9f0eb7..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-shim-ifilesystem.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - IFileSystem - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    IFileSystem

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Shim -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AssemblyLoad(assemblyName) - -
    - Signature: assemblyName:AssemblyName -> Assembly
    - Modifiers: abstract
    -
    -     		-

    Used to load a dependency for F# Interactive and in an unused corner-case of type provider loading

    - - -
    - - - AssemblyLoadFrom(fileName) - -
    - Signature: fileName:string -> Assembly
    - Modifiers: abstract
    -
    -     		-

    Used to load type providers and located assemblies in F# Interactive

    - - -
    - - - FileDelete(fileName) - -
    - Signature: fileName:string -> unit
    - Modifiers: abstract
    -
    -     		-

    A shim over File.Delete

    - - -
    - - - FileStreamCreateShim(fileName) - -
    - Signature: fileName:string -> Stream
    - Modifiers: abstract
    -
    -     		-

    A shim over FileStream with FileMode.Create,FileAccess.Write,FileShare.Read

    - - -
    - - - FileStreamReadShim(fileName) - -
    - Signature: fileName:string -> Stream
    - Modifiers: abstract
    -
    -     		-

    A shim over FileStream with FileMode.Open,FileAccess.Read,FileShare.ReadWrite

    - - -
    - - - FileStreamWriteExistingShim(fileName) - -
    - Signature: fileName:string -> Stream
    - Modifiers: abstract
    -
    -     		-

    A shim over FileStream with FileMode.Open,FileAccess.Write,FileShare.Read

    - - -
    - - - GetFullPathShim(fileName) - -
    - Signature: fileName:string -> string
    - Modifiers: abstract
    -
    -     		-

    Take in a filename with an absolute path, and return the same filename -but canonicalized with respect to extra path separators (e.g. C:\\foo.txt) -and '..' portions

    - - -
    - - - GetLastWriteTimeShim(fileName) - -
    - Signature: fileName:string -> DateTime
    - Modifiers: abstract
    -
    -     		-

    Utc time of the last modification

    - - -
    - - - GetTempPathShim() - -
    - Signature: unit -> string
    - Modifiers: abstract
    -
    -     		-

    A shim over Path.GetTempPath

    - - -
    - - - IsInvalidPathShim(filename) - -
    - Signature: filename:string -> bool
    - Modifiers: abstract
    -
    -     		-

    A shim over Path.IsInvalidPath

    - - -
    - - - IsPathRootedShim(path) - -
    - Signature: path:string -> bool
    - Modifiers: abstract
    -
    -     		-

    A shim over Path.IsPathRooted

    - - -
    - - - IsStableFileHeuristic(fileName) - -
    - Signature: fileName:string -> bool
    - Modifiers: abstract
    -
    -     		-

    Used to determine if a file will not be subject to deletion during the lifetime of a typical client process.

    - - -
    - - - ReadAllBytesShim(fileName) - -
    - Signature: fileName:string -> byte []
    - Modifiers: abstract
    -
    -     		-

    A shim over File.ReadAllBytes

    - - -
    - - - SafeExists(fileName) - -
    - Signature: fileName:string -> bool
    - Modifiers: abstract
    -
    -     		-

    A shim over File.Exists

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-shim.html b/docs/reference/fsharp-compiler-abstractil-internal-library-shim.html deleted file mode 100644 index 8e2b97b883..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-shim.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - Shim - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Shim

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - -
    TypeDescription
    - DefaultFileSystem -
    - IFileSystem -
    - -
    - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - FileSystem - -
    - Signature: IFileSystem
    -
    -     		- -
    -

    Type extensions

    - - - - - - - - - - -
    Type extensionDescription
    - - - ReadBinaryChunk(fileName, start, len) - -
    - Signature: (fileName:string * start:int * len:int) -> byte []
    -
    -     		- -

    CompiledName: File.ReadBinaryChunk.Static

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-string.html b/docs/reference/fsharp-compiler-abstractil-internal-library-string.html deleted file mode 100644 index 735cbb7af2..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-string.html +++ /dev/null @@ -1,401 +0,0 @@ - - - - - String - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    String

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - capitalize s - -
    - Signature: s:string -> string
    -
    -     		- -
    - - - contains s c - -
    - Signature: s:string -> c:char -> bool
    -
    -     		- -
    - - - dropPrefix s t - -
    - Signature: s:string -> t:string -> string
    -
    -     		- -
    - - - dropSuffix s t - -
    - Signature: s:string -> t:string -> string
    -
    -     		- -
    - - - extractTrailingIndex str - -
    - Signature: str:string -> string * int option
    -
    -     		- -
    - - - get str i - -
    - Signature: str:string -> i:int -> char
    -
    -     		- -
    - - - getLines str - -
    - Signature: str:string -> string []
    -
    -     		- -
    - - - isUpper s - -
    - Signature: s:string -> bool
    -
    -     		- -
    - - - lowercase s - -
    - Signature: s:string -> string
    -
    -     		- -
    - - - lowerCaseFirstChar str - -
    - Signature: str:string -> string
    -
    -     		- -
    - - - make n c - -
    - Signature: n:int -> c:char -> string
    -
    -     		- -
    - - - order - -
    - Signature: IComparer<string>
    -
    -     		- -
    - - - split options separator value - -
    - Signature: options:StringSplitOptions -> separator:string [] -> value:string -> string []
    -
    -     		-

    Splits a string into substrings based on the strings in the array separators

    - - -
    - - - sub s start len - -
    - Signature: s:string -> start:int -> len:int -> string
    -
    -     		- -
    - - - toCharArray str - -
    - Signature: str:string -> char []
    -
    -     		- -
    - - - trim value - -
    - Signature: value:string -> string
    -
    -     		-

    Remove all trailing and leading whitespace from the string -return null if the string is null

    - - -
    - - - uncapitalize s - -
    - Signature: s:string -> string
    -
    -     		- -
    - - - uppercase s - -
    - Signature: s:string -> string
    -
    -     		- -
    -

    Active patterns

    - - - - - - - - - - - - - - -
    Active patternDescription
    - - - ( |Contains|_| ) pattern value - -
    - Signature: pattern:string -> value:string -> unit option
    -
    -     		- -

    CompiledName: |Contains|_|

    -
    - - - ( |StartsWith|_| ) pattern value - -
    - Signature: pattern:string -> value:string -> unit option
    -
    -     		- -

    CompiledName: |StartsWith|_|

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-tables.html b/docs/reference/fsharp-compiler-abstractil-internal-library-tables.html deleted file mode 100644 index 63be969cc5..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-tables.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - Tables - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Tables

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - memoize f - -
    - Signature: f:('a -> 'b) -> 'a -> 'b
    - Type parameters: 'a, 'b
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-undefinedexception.html b/docs/reference/fsharp-compiler-abstractil-internal-library-undefinedexception.html deleted file mode 100644 index a2248087a8..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-undefinedexception.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - UndefinedException - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UndefinedException

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-uniquestampgenerator-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-uniquestampgenerator-1.html deleted file mode 100644 index 590d7269bc..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-uniquestampgenerator-1.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - UniqueStampGenerator<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UniqueStampGenerator<'T>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> UniqueStampGenerator<'T>
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Encode(str) - -
    - Signature: str:'T -> int
    -
    -     		- -
    - - - Table - -
    - Signature: KeyCollection<'T,int>
    -
    -     		- -

    CompiledName: get_Table

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-valueoptioninternal.html b/docs/reference/fsharp-compiler-abstractil-internal-library-valueoptioninternal.html deleted file mode 100644 index 89815c5c55..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-valueoptioninternal.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - ValueOptionInternal - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ValueOptionInternal

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -

    Because FSharp.Compiler.Service is a library that will target FSharp.Core 4.5.2 for the forseeable future, -we need to stick these functions in this module rather than using the module functions for ValueOption -that come after FSharp.Core 4.5.2.

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - bind f x - -
    - Signature: f:('b -> 'c voption) -> x:'b voption -> 'c voption
    - Type parameters: 'b, 'c
    -     		- -
    - - - isNone x - -
    - Signature: x:'a voption -> bool
    - Type parameters: 'a
    -     		- -
    - - - isSome x - -
    - Signature: x:'b voption -> bool
    - Type parameters: 'b
    -     		- -
    - - - ofOption x - -
    - Signature: x:'b option -> 'b voption
    - Type parameters: 'b
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-valueorcancelled-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-valueorcancelled-1.html deleted file mode 100644 index b1f92dee50..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library-valueorcancelled-1.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ValueOrCancelled<'TResult> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ValueOrCancelled<'TResult>

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    - Parent Module: Library -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Cancelled(OperationCanceledException) - -
    - Signature: OperationCanceledException
    -
    -     		- -
    - - - Value('TResult) - -
    - Signature: 'TResult
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library.html b/docs/reference/fsharp-compiler-abstractil-internal-library.html deleted file mode 100644 index ade421c4ad..0000000000 --- a/docs/reference/fsharp-compiler-abstractil-internal-library.html +++ /dev/null @@ -1,874 +0,0 @@ - - - - - Library - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Library

    -

    - Namespace: FSharp.Compiler.AbstractIL.Internal
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - AnyCallerThreadToken -

    Represents a token that indicates execution on a any of several potential user threads calling the F# compiler services.

    - -
    - Cancellable<'TResult> -

    Represents a cancellable computation with explicit representation of a cancelled result.

    -

    A cancellable computation is passed may be cancelled via a CancellationToken, which is propagated implicitly.
    -If cancellation occurs, it is propagated as data rather than by raising an OperationCanceledException.

    - -
    - CancellableBuilder -
    - CompilationThreadToken -

    Represents a token that indicates execution on the compilation thread, i.e. -- we have full access to the (partially mutable) TAST and TcImports data structures -- compiler execution may result in type provider invocations when resolving types and members -- we can access various caches in the SourceCodeServices

    -

    Like other execution tokens this should be passed via argument passing and not captured/stored beyond -the lifetime of stack-based calls. This is not checked, it is a discipline within the compiler code.

    - -
    - DictionaryExtensions -
    - Eventually<'T> -

    Computations that can cooperatively yield by returning a continuation

    -
      -
    • -

      Any yield of a NotYetDone should typically be "abandonable" without adverse consequences. No resource release -will be called when the computation is abandoned.

      -
      • -
    • -

      Computations suspend via a NotYetDone may use local state (mutables), where these are -captured by the NotYetDone closure. Computations do not need to be restartable.

      -
      • -
    • -

      The key thing is that you can take an Eventually value and run it with -Eventually.repeatedlyProgressUntilDoneOrTimeShareOverOrCanceled

      -
      • -
    • Cancellation results in a suspended computation rather than complete abandonment
      • -
    - -
    - EventuallyBuilder -
    - ExecutionToken -

    Represents a permission active at this point in execution

    - -
    - IPartialEqualityComparer<'T> -

    Interface that defines methods for comparing objects using partial equality relation

    - -
    - InlineDelayInit<'T> -

    An efficient lazy for inline storage in a class type. Results in fewer thunks.

    - -
    - LayeredMap<'Key, 'Value> -
    - LayeredMultiMap<'Key, 'Value> -

    Immutable map collection, with explicit flattening to a backing dictionary

    - -
    - LazyWithContext<'T, 'ctxt> -

    Just like "Lazy" but EVERY forcer must provide an instance of "ctxt", e.g. to help track errors -on forcing back to at least one sensible user location

    - -
    - LazyWithContextFailure -
    - Lock<'LockTokenType> -

    Encapsulates a lock associated with a particular token-type representing the acquisition of that lock.

    - -
    - LockToken -

    A base type for various types of tokens that must be passed when a lock is taken. -Each different static lock should declare a new subtype of this type.

    - -
    - MemoizationTable<'T, 'U> -
    - MultiMap<'T, 'U> -
    - NameMap<'T> -
    - NameMultiMap<'T> -
    - ResultOrException<'TResult> -
    - UndefinedException -
    - UniqueStampGenerator<'T> -
    - ValueOrCancelled<'TResult> -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ModuleDescription
    - Array -
    - Cancellable -
    - Dictionary -
    - Eventually -
    - IPartialEqualityComparer -
    - Lazy -
    - List -
    - Map -
    - MultiMap -
    - NameMap -
    - NameMultiMap -
    - Option -
    - Order -
    - ResizeArray -
    - ResultOrException -
    - Shim -
    - String -
    - Tables -
    - ValueOptionInternal -

    Because FSharp.Compiler.Service is a library that will target FSharp.Core 4.5.2 for the forseeable future, -we need to stick these functions in this module rather than using the module functions for ValueOption -that come after FSharp.Core 4.5.2.

    - -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - ( === ) x y - -
    - Signature: x:'a -> y:'a -> bool
    - Type parameters: 'a
    -     		- -

    CompiledName: op_EqualsEqualsEquals

    -
    - - - ( >>>& ) x n - -
    - Signature: x:int32 -> n:int32 -> int32
    -
    -     		- -

    CompiledName: op_GreaterGreaterGreaterAmp

    -
    - - - AssumeAnyCallerThreadWithoutEvidence () - -
    - Signature: unit -> AnyCallerThreadToken
    -
    -     		- -
    - - - AssumeCompilationThreadWithoutEvidence (...) - -
    - Signature: unit -> CompilationThreadToken
    -
    -     		-

    Represents a place in the compiler codebase where we assume we are executing on a compilation thread

    - - -
    - - - AssumeLockWithoutEvidence () - -
    - Signature: unit -> 'LockTokenType
    - Type parameters: 'LockTokenType
    -     		- -
    - - - cancellable - -
    - Signature: CancellableBuilder
    -
    -     		- -
    - - - DoesNotRequireCompilerThreadTokenAndCouldPossiblyBeMadeConcurrent (...) - -
    - Signature: _ctok:CompilationThreadToken -> unit
    -
    -     		-

    Represents a place in the compiler codebase where we are passed a CompilationThreadToken unnecessarily. -This reprents code that may potentially not need to be executed on the compilation thread.

    - - -
    - - - eventually - -
    - Signature: EventuallyBuilder
    -
    -     		- -
    - - - foldOn p f z x - -
    - Signature: p:('c -> 'd) -> f:('e -> 'd -> 'f) -> z:'e -> x:'c -> 'f
    - Type parameters: 'c, 'd, 'e, 'f
    -     		- -
    - - - getHole r - -
    - Signature: r:'a option ref -> 'a
    - Type parameters: 'a
    -     		-

    Get an initialization hole

    - - -
    - - - isNil l - -
    - Signature: l:'a list -> bool
    - Type parameters: 'a
    -     		- -
    - - - isNilOrSingleton l - -
    - Signature: l:'a list -> bool
    - Type parameters: 'a
    -     		-

    Returns true if the list has less than 2 elements. Otherwise false.

    - - -
    - - - isNonNull x - -
    - Signature: x:'a -> bool
    - Type parameters: 'a
    -     		- -
    - - - isSingleton l - -
    - Signature: l:'a list -> bool
    - Type parameters: 'a
    -     		-

    Returns true if the list contains exactly 1 element. Otherwise false.

    - - -
    - - - LOH_SIZE_THRESHOLD_BYTES - -
    - Signature: int
    -
    -     		-

    Per the docs the threshold for the Large Object Heap is 85000 bytes: https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/large-object-heap#how-an-object-ends-up-on-the-large-object-heap-and-how-gc-handles-them -We set the limit to slightly under that to allow for some 'slop'

    - - -
    - - - nonNull msg x - -
    - Signature: msg:string -> x:'?17180 -> '?17180
    - Type parameters: '?17180
    -     		- -
    - - - notFound () - -
    - Signature: unit -> 'd
    - Type parameters: 'd
    -     		- -
    - - - notlazy v - -
    - Signature: v:'a -> Lazy<'a>
    - Type parameters: 'a
    -     		- -
    - - - reportTime - -
    - Signature: bool -> string -> unit
    -
    -     		- -
    - - - RequireCompilationThread _ctok - -
    - Signature: _ctok:CompilationThreadToken -> unit
    -
    -     		-

    Represents a place where we are stating that execution on the compilation thread is required. The -reason why will be documented in a comment in the code at the callsite.

    - - -
    -

    Type extensions

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Type extensionDescription
    - - - AddAndMarkAsCollapsible(kvs) - -
    - Signature: (kvs:KeyValuePair<'Key,'Value> []) -> Map<'Key,'Value>
    -
    -     		- -

    CompiledName: Map`2.AddAndMarkAsCollapsible

    -
    - - - Empty - -
    - Signature: Map<'Key,'Value>
    -
    -     		- -

    CompiledName: Map`2.get_Empty.Static

    -
    - - - Empty - -
    - Signature: Map<'Key,'Value>
    -
    -     		- -

    CompiledName: Map`2.get_Empty.Static

    -
    - - - EndsWithOrdinal(value) - -
    - Signature: value:string -> bool
    -
    -     		- -

    CompiledName: String.EndsWithOrdinal

    -
    - - - LinearTryModifyThenLaterFlatten(key, f) - -
    - Signature: (key:'Key * f:('Value option -> 'Value)) -> Map<'Key,'Value>
    -
    -     		- -

    CompiledName: Map`2.LinearTryModifyThenLaterFlatten

    -
    - - - MarkAsCollapsible() - -
    - Signature: unit -> Map<'Key,'Value>
    -
    -     		- -

    CompiledName: Map`2.MarkAsCollapsible

    -
    - - - StartsWithOrdinal(value) - -
    - Signature: value:string -> bool
    -
    -     		- -

    CompiledName: String.StartsWithOrdinal

    -
    - - - Values - -
    - Signature: 'Value list
    -
    -     		- -

    CompiledName: Map`2.get_Values

    -
    - - - Values - -
    - Signature: 'Value list
    -
    -     		- -

    CompiledName: Map`2.get_Values

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-blockseparator.html b/docs/reference/fsharp-compiler-ast-blockseparator.html deleted file mode 100644 index ecc88154e0..0000000000 --- a/docs/reference/fsharp-compiler-ast-blockseparator.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - BlockSeparator - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    BlockSeparator

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    denotes location of the separator block + optional position of the semicolon (used for tooling support)

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-customoperations.html b/docs/reference/fsharp-compiler-ast-customoperations.html deleted file mode 100644 index 1ac6ba1869..0000000000 --- a/docs/reference/fsharp-compiler-ast-customoperations.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - CustomOperations - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CustomOperations

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - Into - -
    - Signature: string
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-expratomicflag.html b/docs/reference/fsharp-compiler-ast-expratomicflag.html deleted file mode 100644 index f4d3422e19..0000000000 --- a/docs/reference/fsharp-compiler-ast-expratomicflag.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - ExprAtomicFlag - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ExprAtomicFlag

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Atomic - -
    - Signature: ExprAtomicFlag
    - Modifiers: static
    -
    -     		-

    Says that the expression is an atomic expression, i.e. is of a form that has no whitespace unless -enclosed in parentheses, e.g. 1, "3", ident, ident.[expr] and (expr). If an atomic expression has -type T, then the largest expression ending at the same range as the atomic expression also has type T.

    - - -
    - - - NonAtomic - -
    - Signature: ExprAtomicFlag
    - Modifiers: static
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-fsharplib.html b/docs/reference/fsharp-compiler-ast-fsharplib.html deleted file mode 100644 index e100e03ac4..0000000000 --- a/docs/reference/fsharp-compiler-ast-fsharplib.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - FSharpLib - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpLib

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - Core - -
    - Signature: string
    -
    -     		- -
    - - - CorePath - -
    - Signature: string list
    -
    -     		- -
    - - - Root - -
    - Signature: string
    -
    -     		- -
    - - - RootPath - -
    - Signature: string list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-ident.html b/docs/reference/fsharp-compiler-ast-ident.html deleted file mode 100644 index 1be32322e5..0000000000 --- a/docs/reference/fsharp-compiler-ast-ident.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - Ident - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Ident

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(text, range) - -
    - Signature: (text:string * range:range) -> Ident
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - idRange - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_idRange

    -
    - - - idText - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_idText

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-lexbuflocalxmldocstore.html b/docs/reference/fsharp-compiler-ast-lexbuflocalxmldocstore.html deleted file mode 100644 index 090386605f..0000000000 --- a/docs/reference/fsharp-compiler-ast-lexbuflocalxmldocstore.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - - LexbufLocalXmlDocStore - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LexbufLocalXmlDocStore

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    XmlDoc F# lexer/parser state, held in the BufferLocalStore for the lexer. -This is the only use of the lexer BufferLocalStore in the codebase.

    - -
    - - - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-lexcont.html b/docs/reference/fsharp-compiler-ast-lexcont.html deleted file mode 100644 index 3cefb00238..0000000000 --- a/docs/reference/fsharp-compiler-ast-lexcont.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - LexCont - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LexCont

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - LexerIfdefStack - -
    - Signature: LexerIfdefStackEntries
    -
    -     		- -

    CompiledName: get_LexerIfdefStack

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-lexerendlinecontinuation.html b/docs/reference/fsharp-compiler-ast-lexerendlinecontinuation.html deleted file mode 100644 index 694b50b380..0000000000 --- a/docs/reference/fsharp-compiler-ast-lexerendlinecontinuation.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - LexerEndlineContinuation - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LexerEndlineContinuation

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    Specifies how the 'endline' function in the lexer should continue after -it reaches end of line or eof. The options are to continue with 'token' function -or to continue with 'skip' function.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Skip(LexerIfdefStackEntries,int,range) - -
    - Signature: LexerIfdefStackEntries * int * range
    -
    -     		- -
    - - - Token(LexerIfdefStackEntries) - -
    - Signature: LexerIfdefStackEntries
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - LexerIfdefStack - -
    - Signature: LexerIfdefStackEntries
    -
    -     		- -

    CompiledName: get_LexerIfdefStack

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-lexerifdefexpression.html b/docs/reference/fsharp-compiler-ast-lexerifdefexpression.html deleted file mode 100644 index f3c40a7a7d..0000000000 --- a/docs/reference/fsharp-compiler-ast-lexerifdefexpression.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - LexerIfdefExpression - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LexerIfdefExpression

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - IfdefAnd(...) - -
    - Signature: LexerIfdefExpression * LexerIfdefExpression
    -
    -     		- -
    - - - IfdefId(string) - -
    - Signature: string
    -
    -     		- -
    - - - IfdefNot(LexerIfdefExpression) - -
    - Signature: LexerIfdefExpression
    -
    -     		- -
    - - - IfdefOr(...) - -
    - Signature: LexerIfdefExpression * LexerIfdefExpression
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-lexerifdefstack.html b/docs/reference/fsharp-compiler-ast-lexerifdefstack.html deleted file mode 100644 index bb02109a17..0000000000 --- a/docs/reference/fsharp-compiler-ast-lexerifdefstack.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - LexerIfdefStack - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LexerIfdefStack

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Value() - -
    - Signature: unit -> unit
    -
    -     		- -

    CompiledName: get_Value

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-lexerifdefstackentries.html b/docs/reference/fsharp-compiler-ast-lexerifdefstackentries.html deleted file mode 100644 index 1d49728454..0000000000 --- a/docs/reference/fsharp-compiler-ast-lexerifdefstackentries.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - LexerIfdefStackEntries - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LexerIfdefStackEntries

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: LexerIfdefStackEntry * range
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> LexerIfdefStackEntry * range
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: (LexerIfdefStackEntry * range) list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: (LexerIfdefStackEntry * range) list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-lexerifdefstackentry.html b/docs/reference/fsharp-compiler-ast-lexerifdefstackentry.html deleted file mode 100644 index d3a2fa1a75..0000000000 --- a/docs/reference/fsharp-compiler-ast-lexerifdefstackentry.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - LexerIfdefStackEntry - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LexerIfdefStackEntry

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - IfDefElse - -
    - Signature:
    -
    -     		- -
    - - - IfDefIf - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-lexerwhitespacecontinuation.html b/docs/reference/fsharp-compiler-ast-lexerwhitespacecontinuation.html deleted file mode 100644 index f342ca41c7..0000000000 --- a/docs/reference/fsharp-compiler-ast-lexerwhitespacecontinuation.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - LexerWhitespaceContinuation - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LexerWhitespaceContinuation

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The parser defines a number of tokens for whitespace and -comments eliminated by the lexer. These carry a specification of -a continuation for the lexer for continued processing after we've dealt with -the whitespace.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Comment(ifdef,int,range) - -
    - Signature: LexerIfdefStackEntries * int * range
    -
    -     		- -
    - - - EndLine(LexerEndlineContinuation) - -
    - Signature: LexerEndlineContinuation
    -
    -     		- -
    - - - IfDefSkip(ifdef,int,range) - -
    - Signature: LexerIfdefStackEntries * int * range
    -
    -     		- -
    - - - MLOnly(ifdef,range) - -
    - Signature: LexerIfdefStackEntries * range
    -
    -     		- -
    - - - SingleLineComment(ifdef,int,range) - -
    - Signature: LexerIfdefStackEntries * int * range
    -
    -     		- -
    - - - String(ifdef,range) - -
    - Signature: LexerIfdefStackEntries * range
    -
    -     		- -
    - - - StringInComment(ifdef,int,range) - -
    - Signature: LexerIfdefStackEntries * int * range
    -
    -     		- -
    - - - Token(ifdef) - -
    - Signature: LexerIfdefStackEntries
    -
    -     		- -
    - - - TripleQuoteString(ifdef,range) - -
    - Signature: LexerIfdefStackEntries * range
    -
    -     		- -
    - - - TripleQuoteStringInComment(...) - -
    - Signature: LexerIfdefStackEntries * int * range
    -
    -     		- -
    - - - VerbatimString(ifdef,range) - -
    - Signature: LexerIfdefStackEntries * range
    -
    -     		- -
    - - - VerbatimStringInComment(ifdef,int,range) - -
    - Signature: LexerIfdefStackEntries * int * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - LexerIfdefStack - -
    - Signature: LexerIfdefStackEntries
    -
    -     		- -

    CompiledName: get_LexerIfdefStack

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-longident.html b/docs/reference/fsharp-compiler-ast-longident.html deleted file mode 100644 index 611ebaa399..0000000000 --- a/docs/reference/fsharp-compiler-ast-longident.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - LongIdent - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LongIdent

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: Ident
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> Ident
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: Ident list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: Ident list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-longidentwithdots.html b/docs/reference/fsharp-compiler-ast-longidentwithdots.html deleted file mode 100644 index 6b9be43e2c..0000000000 --- a/docs/reference/fsharp-compiler-ast-longidentwithdots.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - LongIdentWithDots - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LongIdentWithDots

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - LongIdentWithDots(id,dotms) - -
    - Signature: LongIdent * range list
    -
    -     		-

    LongIdentWithDots(lid, dotms) -Typically dotms.Length = lid.Length-1, but they may be same if (incomplete) code ends in a dot, e.g. "Foo.Bar." -The dots mostly matter for parsing, and are typically ignored by the typechecker, but -if dotms.Length = lid.Length, then the parser must have reported an error, so the typechecker is allowed -more freedom about typechecking these expressions. -LongIdent can be empty list - it is used to denote that name of some AST element is absent (i.e. empty type name in inherit)

    - - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Lid - -
    - Signature: LongIdent
    -
    -     		- -

    CompiledName: get_Lid

    -
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - - - RangeSansAnyExtraDot - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_RangeSansAnyExtraDot

    -
    - - - ThereIsAnExtraDotAtTheEnd - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_ThereIsAnExtraDotAtTheEnd

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-memberflags.html b/docs/reference/fsharp-compiler-ast-memberflags.html deleted file mode 100644 index 2e341e4197..0000000000 --- a/docs/reference/fsharp-compiler-ast-memberflags.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - MemberFlags - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MemberFlags

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - IsDispatchSlot - -
    - Signature: bool
    -
    -     		- -
    - - - IsFinal - -
    - Signature: bool
    -
    -     		- -
    - - - IsInstance - -
    - Signature: bool
    -
    -     		- -
    - - - IsOverrideOrExplicitImpl - -
    - Signature: bool
    -
    -     		- -
    - - - MemberKind - -
    - Signature: MemberKind
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-memberkind.html b/docs/reference/fsharp-compiler-ast-memberkind.html deleted file mode 100644 index 29366f4040..0000000000 --- a/docs/reference/fsharp-compiler-ast-memberkind.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - MemberKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MemberKind

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    Note the member kind is actually computed partially by a syntax tree transformation in tc.fs

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ClassConstructor - -
    - Signature:
    -
    -     		- -
    - - - Constructor - -
    - Signature:
    -
    -     		- -
    - - - Member - -
    - Signature:
    -
    -     		- -
    - - - PropertyGet - -
    - Signature:
    -
    -     		- -
    - - - PropertyGetSet - -
    - Signature:
    -
    -     		-

    An artificial member kind used prior to the point where a get/set property is split into two distinct members.

    - - -
    - - - PropertySet - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-nicenamegenerator.html b/docs/reference/fsharp-compiler-ast-nicenamegenerator.html deleted file mode 100644 index 810fa916da..0000000000 --- a/docs/reference/fsharp-compiler-ast-nicenamegenerator.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - NiceNameGenerator - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NiceNameGenerator

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    Generates compiler-generated names. Each name generated also includes the StartLine number of the range passed in -at the point of first generation.

    -

    This type may be accessed concurrently, though in practice it is only used from the compilation thread. -It is made concurrency-safe since a global instance of the type is allocated in tast.fs, and it is good -policy to make all globally-allocated objects concurrency safe in case future versions of the compiler -are used to host multiple concurrent instances of compilation.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> NiceNameGenerator
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - FreshCompilerGeneratedName(name, m) - -
    - Signature: (name:string * m:range) -> string
    -
    -     		- -
    - - - Reset() - -
    - Signature: unit -> unit
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parsedfsiinteraction.html b/docs/reference/fsharp-compiler-ast-parsedfsiinteraction.html deleted file mode 100644 index 93773527c0..0000000000 --- a/docs/reference/fsharp-compiler-ast-parsedfsiinteraction.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ParsedFsiInteraction - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedFsiInteraction

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - IDefns(SynModuleDecl list,range) - -
    - Signature: SynModuleDecl list * range
    -
    -     		- -
    - - - IHash(ParsedHashDirective,range) - -
    - Signature: ParsedHashDirective * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parsedhashdirective.html b/docs/reference/fsharp-compiler-ast-parsedhashdirective.html deleted file mode 100644 index a7b6d33a53..0000000000 --- a/docs/reference/fsharp-compiler-ast-parsedhashdirective.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - ParsedHashDirective - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedHashDirective

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - ParsedHashDirective(...) - -
    - Signature: string * string list * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parsedimplfile.html b/docs/reference/fsharp-compiler-ast-parsedimplfile.html deleted file mode 100644 index 884a2cc895..0000000000 --- a/docs/reference/fsharp-compiler-ast-parsedimplfile.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - ParsedImplFile - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedImplFile

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - ParsedImplFile(...) - -
    - Signature: ParsedHashDirective list * ParsedImplFileFragment list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parsedimplfilefragment.html b/docs/reference/fsharp-compiler-ast-parsedimplfilefragment.html deleted file mode 100644 index 2f8be29a25..0000000000 --- a/docs/reference/fsharp-compiler-ast-parsedimplfilefragment.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - ParsedImplFileFragment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedImplFileFragment

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AnonModule(SynModuleDecls,range) - -
    - Signature: SynModuleDecls * range
    -
    -     		- -
    - - - NamedModule(SynModuleOrNamespace) - -
    - Signature: SynModuleOrNamespace
    -
    -     		- -
    - - - NamespaceFragment(...) - -
    - Signature: LongIdent * bool * SynModuleOrNamespaceKind * SynModuleDecls * PreXmlDoc * SynAttributes * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parsedimplfileinput.html b/docs/reference/fsharp-compiler-ast-parsedimplfileinput.html deleted file mode 100644 index 2a6dcdebbd..0000000000 --- a/docs/reference/fsharp-compiler-ast-parsedimplfileinput.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - ParsedImplFileInput - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedImplFileInput

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - ParsedImplFileInput(...) - -
    - Signature: string * bool * QualifiedNameOfFile * ScopedPragma list * ParsedHashDirective list * SynModuleOrNamespace list * bool * bool
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parsedinput.html b/docs/reference/fsharp-compiler-ast-parsedinput.html deleted file mode 100644 index cb8bc00dc4..0000000000 --- a/docs/reference/fsharp-compiler-ast-parsedinput.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - ParsedInput - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedInput

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ImplFile(ParsedImplFileInput) - -
    - Signature: ParsedImplFileInput
    -
    -     		- -
    - - - SigFile(ParsedSigFileInput) - -
    - Signature: ParsedSigFileInput
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parsedsigfile.html b/docs/reference/fsharp-compiler-ast-parsedsigfile.html deleted file mode 100644 index 0006ac5b45..0000000000 --- a/docs/reference/fsharp-compiler-ast-parsedsigfile.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - ParsedSigFile - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedSigFile

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - ParsedSigFile(...) - -
    - Signature: ParsedHashDirective list * ParsedSigFileFragment list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parsedsigfilefragment.html b/docs/reference/fsharp-compiler-ast-parsedsigfilefragment.html deleted file mode 100644 index 1803fd8f10..0000000000 --- a/docs/reference/fsharp-compiler-ast-parsedsigfilefragment.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - ParsedSigFileFragment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedSigFileFragment

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AnonModule(SynModuleSigDecls,range) - -
    - Signature: SynModuleSigDecls * range
    -
    -     		- -
    - - - NamedModule(SynModuleOrNamespaceSig) - -
    - Signature: SynModuleOrNamespaceSig
    -
    -     		- -
    - - - NamespaceFragment(...) - -
    - Signature: LongIdent * bool * SynModuleOrNamespaceKind * SynModuleSigDecls * PreXmlDoc * SynAttributes * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parsedsigfileinput.html b/docs/reference/fsharp-compiler-ast-parsedsigfileinput.html deleted file mode 100644 index 1d3e9d93b4..0000000000 --- a/docs/reference/fsharp-compiler-ast-parsedsigfileinput.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - ParsedSigFileInput - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedSigFileInput

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - ParsedSigFileInput(...) - -
    - Signature: string * QualifiedNameOfFile * ScopedPragma list * ParsedHashDirective list * SynModuleOrNamespaceSig list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-parserdetail.html b/docs/reference/fsharp-compiler-ast-parserdetail.html deleted file mode 100644 index 816e541bf8..0000000000 --- a/docs/reference/fsharp-compiler-ast-parserdetail.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - ParserDetail - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParserDetail

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Ok - -
    - Signature:
    -
    -     		- -
    - - - ThereWereSignificantParseErrorsSoDoNotTypecheckThisNode - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-prexmldoc.html b/docs/reference/fsharp-compiler-ast-prexmldoc.html deleted file mode 100644 index 49b0f1b0c5..0000000000 --- a/docs/reference/fsharp-compiler-ast-prexmldoc.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - PreXmlDoc - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PreXmlDoc

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - PreXmlDoc(pos,XmlDocCollector) - -
    - Signature: pos * XmlDocCollector
    -
    -     		- -
    - - - PreXmlDocEmpty - -
    - Signature:
    -
    -     		- -
    - - - PreXmlMerge(PreXmlDoc,PreXmlDoc) - -
    - Signature: PreXmlDoc * PreXmlDoc
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - ToXmlDoc() - -
    - Signature: unit -> XmlDoc
    -
    -     		- -
    -

    Static members

    - - - - - - - - - - - - - - - - - - -
    Static memberDescription
    - - - CreateFromGrabPoint(...) - -
    - Signature: (collector:XmlDocCollector * grabPointPos:pos) -> PreXmlDoc
    -
    -     		- -
    - - - Empty - -
    - Signature: PreXmlDoc
    -
    -     		- -

    CompiledName: get_Empty

    -
    - - - Merge(a b) - -
    - Signature: a:PreXmlDoc -> b:PreXmlDoc -> PreXmlDoc
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-qualifiednameoffile.html b/docs/reference/fsharp-compiler-ast-qualifiednameoffile.html deleted file mode 100644 index 8865c92ee6..0000000000 --- a/docs/reference/fsharp-compiler-ast-qualifiednameoffile.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - QualifiedNameOfFile - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    QualifiedNameOfFile

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    QualifiedNameOfFile acts to fully-qualify module specifications and implementations, -most importantly the ones that simply contribute fragments to a namespace (i.e. the ParsedSigFileFragment.NamespaceFragment case) -There may be multiple such fragments in a single assembly. There may thus also -be multiple matching pairs of these in an assembly, all contributing types to the same -namespace.

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - QualifiedNameOfFile(Ident) - -
    - Signature: Ident
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Id - -
    - Signature: Ident
    -
    -     		- -

    CompiledName: get_Id

    -
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - - - Text - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Text

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-recordfieldname.html b/docs/reference/fsharp-compiler-ast-recordfieldname.html deleted file mode 100644 index 152f829a3b..0000000000 --- a/docs/reference/fsharp-compiler-ast-recordfieldname.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - RecordFieldName - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    RecordFieldName

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    stores pair: record field name + (true if given record field name is syntactically correct and can be used in name resolution)

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-scopedpragma.html b/docs/reference/fsharp-compiler-ast-scopedpragma.html deleted file mode 100644 index e488398e57..0000000000 --- a/docs/reference/fsharp-compiler-ast-scopedpragma.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - ScopedPragma - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ScopedPragma

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - WarningOff(range,int) - -
    - Signature: range * int
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-seqexpronly.html b/docs/reference/fsharp-compiler-ast-seqexpronly.html deleted file mode 100644 index fdb8198e38..0000000000 --- a/docs/reference/fsharp-compiler-ast-seqexpronly.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - SeqExprOnly - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SeqExprOnly

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    Indicates if a for loop is 'for x in e1 -> e2', only valid in sequence expressions

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SeqExprOnly(bool) - -
    - Signature: bool
    -
    -     		-

    Indicates if a for loop is 'for x in e1 -> e2', only valid in sequence expressions

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforbinding.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforbinding.html deleted file mode 100644 index cf3e3474ca..0000000000 --- a/docs/reference/fsharp-compiler-ast-sequencepointinfoforbinding.html +++ /dev/null @@ -1,195 +0,0 @@ - - - - - SequencePointInfoForBinding - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SequencePointInfoForBinding

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - NoSequencePointAtDoBinding - -
    - Signature:
    -
    -     		- -
    - - - NoSequencePointAtInvisibleBinding - -
    - Signature:
    -
    -     		- -
    - - - NoSequencePointAtLetBinding - -
    - Signature:
    -
    -     		- -
    - - - NoSequencePointAtStickyBinding - -
    - Signature:
    -
    -     		- -
    - - - SequencePointAtBinding(range) - -
    - Signature: range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Combine(y) - -
    - Signature: y:SequencePointInfoForBinding -> SequencePointInfoForBinding
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforfinally.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforfinally.html deleted file mode 100644 index 6a11dbd3cd..0000000000 --- a/docs/reference/fsharp-compiler-ast-sequencepointinfoforfinally.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - SequencePointInfoForFinally - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SequencePointInfoForFinally

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - NoSequencePointAtFinally - -
    - Signature:
    -
    -     		- -
    - - - SequencePointAtFinally(range) - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforforloop.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforforloop.html deleted file mode 100644 index cb7f56cdfd..0000000000 --- a/docs/reference/fsharp-compiler-ast-sequencepointinfoforforloop.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - SequencePointInfoForForLoop - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SequencePointInfoForForLoop

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - NoSequencePointAtForLoop - -
    - Signature:
    -
    -     		- -
    - - - SequencePointAtForLoop(range) - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforseq.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforseq.html deleted file mode 100644 index ab7dd15edb..0000000000 --- a/docs/reference/fsharp-compiler-ast-sequencepointinfoforseq.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - SequencePointInfoForSeq - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SequencePointInfoForSeq

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - SequencePointsAtSeq - -
    - Signature:
    -
    -     		- -
    - - - SuppressSequencePointOnExprOfSequential - -
    - Signature:
    -
    -     		- -
    - - - SuppressSequencePointOnStmtOfSequential - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfofortarget.html b/docs/reference/fsharp-compiler-ast-sequencepointinfofortarget.html deleted file mode 100644 index 14233dd95c..0000000000 --- a/docs/reference/fsharp-compiler-ast-sequencepointinfofortarget.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - SequencePointInfoForTarget - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SequencePointInfoForTarget

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - SequencePointAtTarget - -
    - Signature:
    -
    -     		- -
    - - - SuppressSequencePointAtTarget - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfofortry.html b/docs/reference/fsharp-compiler-ast-sequencepointinfofortry.html deleted file mode 100644 index d4fb17a231..0000000000 --- a/docs/reference/fsharp-compiler-ast-sequencepointinfofortry.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - SequencePointInfoForTry - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SequencePointInfoForTry

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - NoSequencePointAtTry - -
    - Signature:
    -
    -     		- -
    - - - SequencePointAtTry(range) - -
    - Signature: range
    -
    -     		- -
    - - - SequencePointInBodyOfTry - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforwhileloop.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforwhileloop.html deleted file mode 100644 index ecea59ffa7..0000000000 --- a/docs/reference/fsharp-compiler-ast-sequencepointinfoforwhileloop.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - SequencePointInfoForWhileLoop - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SequencePointInfoForWhileLoop

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - NoSequencePointAtWhileLoop - -
    - Signature:
    -
    -     		- -
    - - - SequencePointAtWhileLoop(range) - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforwith.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforwith.html deleted file mode 100644 index f2070a1d36..0000000000 --- a/docs/reference/fsharp-compiler-ast-sequencepointinfoforwith.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - SequencePointInfoForWith - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SequencePointInfoForWith

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - NoSequencePointAtWith - -
    - Signature:
    -
    -     		- -
    - - - SequencePointAtWith(range) - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-stablenicenamegenerator.html b/docs/reference/fsharp-compiler-ast-stablenicenamegenerator.html deleted file mode 100644 index 9a54245412..0000000000 --- a/docs/reference/fsharp-compiler-ast-stablenicenamegenerator.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - StableNiceNameGenerator - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    StableNiceNameGenerator

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    Generates compiler-generated names marked up with a source code location, but if given the same unique value then -return precisely the same name. Each name generated also includes the StartLine number of the range passed in -at the point of first generation.

    -

    This type may be accessed concurrently, though in practice it is only used from the compilation thread. -It is made concurrency-safe since a global instance of the type is allocated in tast.fs.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> StableNiceNameGenerator
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - GetUniqueCompilerGeneratedName(...) - -
    - Signature: (name:string * m:range * uniq:int64) -> string
    -
    -     		- -
    - - - Reset() - -
    - Signature: unit -> unit
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synaccess.html b/docs/reference/fsharp-compiler-ast-synaccess.html deleted file mode 100644 index 3a99cc99fa..0000000000 --- a/docs/reference/fsharp-compiler-ast-synaccess.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - SynAccess - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynAccess

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Internal - -
    - Signature:
    -
    -     		- -
    - - - Private - -
    - Signature:
    -
    -     		- -
    - - - Public - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synarginfo.html b/docs/reference/fsharp-compiler-ast-synarginfo.html deleted file mode 100644 index 0302180603..0000000000 --- a/docs/reference/fsharp-compiler-ast-synarginfo.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - SynArgInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynArgInfo

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The argument names and other metadata for a parameter for a member or function

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynArgInfo(...) - -
    - Signature: SynAttributes * bool * Ident option
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synargnamegenerator.html b/docs/reference/fsharp-compiler-ast-synargnamegenerator.html deleted file mode 100644 index 9861ed5378..0000000000 --- a/docs/reference/fsharp-compiler-ast-synargnamegenerator.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - SynArgNameGenerator - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynArgNameGenerator

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> SynArgNameGenerator
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - New() - -
    - Signature: unit -> string
    -
    -     		- -
    - - - Reset() - -
    - Signature: unit -> unit
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synattribute.html b/docs/reference/fsharp-compiler-ast-synattribute.html deleted file mode 100644 index e05361ad95..0000000000 --- a/docs/reference/fsharp-compiler-ast-synattribute.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - SynAttribute - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynAttribute

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - AppliesToGetterAndSetter - -
    - Signature: bool
    -
    -     		-

    Is this attribute being applied to a property getter or setter?

    - - -
    - - - ArgExpr - -
    - Signature: SynExpr
    -
    -     		- -
    - - - Range - -
    - Signature: range
    -
    -     		- -
    - - - Target - -
    - Signature: Ident option
    -
    -     		-

    Target specifier, e.g. "assembly","module",etc.

    - - -
    - - - TypeName - -
    - Signature: LongIdentWithDots
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synattributes.html b/docs/reference/fsharp-compiler-ast-synattributes.html deleted file mode 100644 index 45957d9721..0000000000 --- a/docs/reference/fsharp-compiler-ast-synattributes.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - SynAttributes - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynAttributes

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: SynAttribute
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> SynAttribute
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: SynAttribute list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: SynAttribute list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synbinding.html b/docs/reference/fsharp-compiler-ast-synbinding.html deleted file mode 100644 index 3953b198b3..0000000000 --- a/docs/reference/fsharp-compiler-ast-synbinding.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - SynBinding - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynBinding

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - Binding(...) - -
    - Signature: SynAccess option * SynBindingKind * bool * bool * SynAttributes * PreXmlDoc * SynValData * SynPat * SynBindingReturnInfo option * SynExpr * range * SequencePointInfoForBinding
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - RangeOfBindingAndRhs - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_RangeOfBindingAndRhs

    -
    - - - RangeOfBindingSansRhs - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_RangeOfBindingSansRhs

    -
    - - - RangeOfHeadPat - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_RangeOfHeadPat

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synbindingkind.html b/docs/reference/fsharp-compiler-ast-synbindingkind.html deleted file mode 100644 index 96420dbf44..0000000000 --- a/docs/reference/fsharp-compiler-ast-synbindingkind.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - SynBindingKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynBindingKind

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The kind associated with a binding - "let", "do" or a standalone expression

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - DoBinding - -
    - Signature:
    -
    -     		-

    A 'do' binding in a module. Must have type 'unit'

    - - -
    - - - NormalBinding - -
    - Signature:
    -
    -     		-

    A normal 'let' binding in a module

    - - -
    - - - StandaloneExpression - -
    - Signature:
    -
    -     		-

    A standalone expression in a module

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synbindingreturninfo.html b/docs/reference/fsharp-compiler-ast-synbindingreturninfo.html deleted file mode 100644 index 78eb258b85..0000000000 --- a/docs/reference/fsharp-compiler-ast-synbindingreturninfo.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - SynBindingReturnInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynBindingReturnInfo

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynBindingReturnInfo(...) - -
    - Signature: SynType * range * SynAttributes
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syncomponentinfo.html b/docs/reference/fsharp-compiler-ast-syncomponentinfo.html deleted file mode 100644 index 858ef22bac..0000000000 --- a/docs/reference/fsharp-compiler-ast-syncomponentinfo.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - SynComponentInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynComponentInfo

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The untyped, unchecked syntax tree associated with the name of a type definition or module -in signature or implementation.

    -

    This includes the name, attributes, type parameters, constraints, documentation and accessibility -for a type definition or module. For modules, entries such as the type parameters are -always empty.

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - ComponentInfo(...) - -
    - Signature: SynAttributes * SynTyparDecl list * SynTypeConstraint list * LongIdent * PreXmlDoc * bool * SynAccess option * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synconst.html b/docs/reference/fsharp-compiler-ast-synconst.html deleted file mode 100644 index cba79ffb35..0000000000 --- a/docs/reference/fsharp-compiler-ast-synconst.html +++ /dev/null @@ -1,467 +0,0 @@ - - - - - SynConst - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynConst

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The unchecked abstract syntax tree of constants in F# types and expressions.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Bool(bool) - -
    - Signature: bool
    -
    -     		-

    F# syntax: true, false

    - - -
    - - - Byte(byte) - -
    - Signature: byte
    -
    -     		-

    F# syntax: 13uy, 0x40uy, 0oFFuy, 0b0111101uy

    - - -
    - - - Bytes(bytes,range) - -
    - Signature: byte [] * range
    -
    -     		-

    F# syntax: verbatim or regular byte string, e.g. "abc"B.

    -

    Also used internally in the typechecker once an array of unit16 constants -is detected, to allow more efficient processing of large arrays of uint16 constants.

    - - -
    - - - Char(char) - -
    - Signature: char
    -
    -     		-

    F# syntax: 'a'

    - - -
    - - - Decimal(Decimal) - -
    - Signature: Decimal
    -
    -     		-

    F# syntax: 23.4M

    - - -
    - - - Double(double) - -
    - Signature: double
    -
    -     		-

    F# syntax: 1.30, 1.40e10 etc.

    - - -
    - - - Int16(int16) - -
    - Signature: int16
    -
    -     		-

    F# syntax: 13s, 0x4000s, 0o0777s, 0b0111101s

    - - -
    - - - Int32(int32) - -
    - Signature: int32
    -
    -     		-

    F# syntax: 13, 0x4000, 0o0777

    - - -
    - - - Int64(int64) - -
    - Signature: int64
    -
    -     		-

    F# syntax: 13L

    - - -
    - - - IntPtr(int64) - -
    - Signature: int64
    -
    -     		-

    F# syntax: 13n

    - - -
    - - - Measure(constant,SynMeasure) - -
    - Signature: SynConst * SynMeasure
    -
    -     		-

    Old comment: "we never iterate, so the const here is not another SynConst.Measure"

    - - -
    - - - SByte(sbyte) - -
    - Signature: sbyte
    -
    -     		-

    F# syntax: 13y, 0xFFy, 0o077y, 0b0111101y

    - - -
    - - - Single(single) - -
    - Signature: single
    -
    -     		-

    F# syntax: 1.30f, 1.40e10f etc.

    - - -
    - - - String(text,range) - -
    - Signature: string * range
    -
    -     		-

    F# syntax: verbatim or regular string, e.g. "abc"

    - - -
    - - - UInt16(uint16) - -
    - Signature: uint16
    -
    -     		-

    F# syntax: 13us, 0x4000us, 0o0777us, 0b0111101us

    - - -
    - - - UInt16s(uint16 []) - -
    - Signature: uint16 []
    -
    -     		-

    Used internally in the typechecker once an array of unit16 constants -is detected, to allow more efficient processing of large arrays of uint16 constants.

    - - -
    - - - UInt32(uint32) - -
    - Signature: uint32
    -
    -     		-

    F# syntax: 13u, 0x4000u, 0o0777u

    - - -
    - - - UInt64(uint64) - -
    - Signature: uint64
    -
    -     		-

    F# syntax: 13UL

    - - -
    - - - UIntPtr(uint64) - -
    - Signature: uint64
    -
    -     		-

    F# syntax: 13un

    - - -
    - - - Unit - -
    - Signature:
    -
    -     		-

    F# syntax: ()

    - - -
    - - - UserNum(value,suffix) - -
    - Signature: string * string
    -
    -     		-

    UserNum(value, suffix)

    -

    F# syntax: 1Q, 1Z, 1R, 1N, 1G

    - - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range(dflt) - -
    - Signature: dflt:range -> range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synconstructorargs.html b/docs/reference/fsharp-compiler-ast-synconstructorargs.html deleted file mode 100644 index 473f0d5b2f..0000000000 --- a/docs/reference/fsharp-compiler-ast-synconstructorargs.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - SynConstructorArgs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynConstructorArgs

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - NamePatPairs(...) - -
    - Signature: (Ident * SynPat) list * range
    -
    -     		- -
    - - - Pats(SynPat list) - -
    - Signature: SynPat list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synenumcase.html b/docs/reference/fsharp-compiler-ast-synenumcase.html deleted file mode 100644 index 3efe68d2ed..0000000000 --- a/docs/reference/fsharp-compiler-ast-synenumcase.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - SynEnumCase - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynEnumCase

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - EnumCase(...) - -
    - Signature: SynAttributes * Ident * SynConst * PreXmlDoc * range
    -
    -     		-

    The untyped, unchecked syntax tree for one case in an enum definition.

    - - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synenumcases.html b/docs/reference/fsharp-compiler-ast-synenumcases.html deleted file mode 100644 index 1b693c845e..0000000000 --- a/docs/reference/fsharp-compiler-ast-synenumcases.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - SynEnumCases - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynEnumCases

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: SynEnumCase
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> SynEnumCase
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: SynEnumCase list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: SynEnumCase list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synexceptiondefn.html b/docs/reference/fsharp-compiler-ast-synexceptiondefn.html deleted file mode 100644 index f4cd8ac98e..0000000000 --- a/docs/reference/fsharp-compiler-ast-synexceptiondefn.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - SynExceptionDefn - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynExceptionDefn

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    'exception E = ... with ...'

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynExceptionDefn(...) - -
    - Signature: SynExceptionDefnRepr * SynMemberDefns * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synexceptiondefnrepr.html b/docs/reference/fsharp-compiler-ast-synexceptiondefnrepr.html deleted file mode 100644 index dae25d2487..0000000000 --- a/docs/reference/fsharp-compiler-ast-synexceptiondefnrepr.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - SynExceptionDefnRepr - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynExceptionDefnRepr

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    'exception E = ... '

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynExceptionDefnRepr(...) - -
    - Signature: SynAttributes * SynUnionCase * LongIdent option * PreXmlDoc * SynAccess option * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synexceptionsig.html b/docs/reference/fsharp-compiler-ast-synexceptionsig.html deleted file mode 100644 index 60a87e5aa2..0000000000 --- a/docs/reference/fsharp-compiler-ast-synexceptionsig.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - SynExceptionSig - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynExceptionSig

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynExceptionSig(...) - -
    - Signature: SynExceptionDefnRepr * SynMemberSigs * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synexpr.html b/docs/reference/fsharp-compiler-ast-synexpr.html deleted file mode 100644 index db58dcf1ed..0000000000 --- a/docs/reference/fsharp-compiler-ast-synexpr.html +++ /dev/null @@ -1,1198 +0,0 @@ - - - - - SynExpr - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynExpr

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AddressOf(isByref,SynExpr,range,range) - -
    - Signature: bool * SynExpr * range * range
    -
    -     		-

    F# syntax: &expr, &&expr

    - - -
    - - - AnonRecd(...) - -
    - Signature: bool * (SynExpr * BlockSeparator) option * (Ident * SynExpr) list * range
    -
    -     		-

    F# syntax: {| id1=e1; ...; idN=eN |} -F# syntax: struct {| id1=e1; ...; idN=eN |}

    - - -
    - - - App(...) - -
    - Signature: ExprAtomicFlag * bool * SynExpr * SynExpr * range
    -
    -     		-

    App(exprAtomicFlag, isInfix, funcExpr, argExpr, m) -- exprAtomicFlag: indicates if the application is syntactically atomic, e.g. f.[1] is atomic, but 'f x' is not -- isInfix is true for the first app of an infix operator, e.g. 1+2 becomes App(App(+,1),2), where the inner node is marked isInfix -(or more generally, for higher operator fixities, if App(x,y) is such that y comes before x in the source code, then the node is marked isInfix=true)

    -

    F# syntax: f x

    - - -
    - - - ArbitraryAfterError(debugStr,range) - -
    - Signature: string * range
    -
    -     		-

    Inserted for error recovery

    - - -
    - - - ArrayOrList(isList,exprs,range) - -
    - Signature: bool * SynExpr list * range
    -
    -     		-

    F# syntax: [ e1; ...; en ], [| e1; ...; en |]

    - - -
    - - - ArrayOrListOfSeqExpr(isArray,expr,range) - -
    - Signature: bool * SynExpr * range
    -
    -     		-

    F# syntax: [ expr ], [| expr |]

    - - -
    - - - Assert(expr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    F# syntax: assert expr

    - - -
    - - - CompExpr(...) - -
    - Signature: bool * bool ref * SynExpr * range
    -
    -     		-

    CompExpr(isArrayOrList, isNotNakedRefCell, expr)

    -

    F# syntax: { expr }

    - - -
    - - - Const(constant,range) - -
    - Signature: SynConst * range
    -
    -     		-

    F# syntax: 1, 1.3, () etc.

    - - -
    - - - DiscardAfterMissingQualificationAfterDot(...) - -
    - Signature: SynExpr * range
    -
    -     		-

    Inserted for error recovery when there is "expr." and missing tokens or error recovery after the dot

    - - -
    - - - Do(expr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    F# syntax: do expr

    - - -
    - - - DoBang(expr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    F# syntax: do! expr -Computation expressions only

    - - -
    - - - DotGet(expr,rangeOfDot,longDotId,range) - -
    - Signature: SynExpr * range * LongIdentWithDots * range
    -
    -     		-

    DotGet(expr, rangeOfDot, lid, wholeRange)

    -

    F# syntax: expr.ident.ident

    - - -
    - - - DotIndexedGet(...) - -
    - Signature: SynExpr * SynIndexerArg list * range * range
    -
    -     		-

    F# syntax: expr.[expr,...,expr]

    - - -
    - - - DotIndexedSet(...) - -
    - Signature: SynExpr * SynIndexerArg list * SynExpr * range * range * range
    -
    -     		-

    DotIndexedSet (objectExpr, indexExprs, valueExpr, rangeOfLeftOfSet, rangeOfDot, rangeOfWholeExpr)

    -

    F# syntax: expr.[expr,...,expr] <- expr

    - - -
    - - - DotNamedIndexedPropertySet(...) - -
    - Signature: SynExpr * LongIdentWithDots * SynExpr * SynExpr * range
    -
    -     		-

    F# syntax: expr.Items(e1) <- e2 , rarely used named-property-setter notation, e.g. (stringExpr).Chars(3) <- 'a'

    - - -
    - - - DotSet(SynExpr,longDotId,SynExpr,range) - -
    - Signature: SynExpr * LongIdentWithDots * SynExpr * range
    -
    -     		-

    F# syntax: expr.ident...ident <- expr

    - - -
    - - - Downcast(expr,typeName,range) - -
    - Signature: SynExpr * SynType * range
    -
    -     		-

    F# syntax: expr :?> type

    - - -
    - - - Fixed(expr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    'use x = fixed expr'

    - - -
    - - - For(...) - -
    - Signature: SequencePointInfoForForLoop * Ident * SynExpr * bool * SynExpr * SynExpr * range
    -
    -     		-

    F# syntax: 'for i = ... to ... do ...'

    - - -
    - - - ForEach(...) - -
    - Signature: SequencePointInfoForForLoop * SeqExprOnly * bool * SynPat * SynExpr * SynExpr * range
    -
    -     		-

    SynExpr.ForEach (spBind, seqExprOnly, isFromSource, pat, enumExpr, bodyExpr, mWholeExpr).

    -

    F# syntax: 'for ... in ... do ...'

    - - -
    - - - FromParseError(expr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    Inserted for error recovery

    - - -
    - - - Ident(Ident) - -
    - Signature: Ident
    -
    -     		-

    F# syntax: ident -Optimized representation, = SynExpr.LongIdent(false,[id],id.idRange)

    - - -
    - - - IfThenElse(...) - -
    - Signature: SynExpr * SynExpr * SynExpr option * SequencePointInfoForBinding * bool * range * range
    -
    -     		-

    IfThenElse(exprGuard,exprThen,optionalExprElse,spIfToThen,isFromErrorRecovery,mIfToThen,mIfToEndOfLastBranch)

    -

    F# syntax: if expr then expr -F# syntax: if expr then expr else expr

    - - -
    - - - ImplicitZero(range) - -
    - Signature: range
    -
    -     		-

    F# syntax: -Computation expressions only, implied by final "do" or "do!"

    - - -
    - - - InferredDowncast(expr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    F# syntax: downcast expr

    - - -
    - - - InferredUpcast(expr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    F# syntax: upcast expr

    - - -
    - - - JoinIn(SynExpr,range,SynExpr,range) - -
    - Signature: SynExpr * range * SynExpr * range
    -
    -     		-

    F# syntax: ... in ... -Computation expressions only, based on JOIN_IN token from lex filter

    - - -
    - - - Lambda(...) - -
    - Signature: bool * bool * SynSimplePats * SynExpr * range
    -
    -     		-

    First bool indicates if lambda originates from a method. Patterns here are always "simple" -Second bool indicates if this is a "later" part of an iterated sequence of lambdas

    -

    F# syntax: fun pat -> expr

    - - -
    - - - Lazy(SynExpr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    F# syntax: lazy expr

    - - -
    - - - LetOrUse(...) - -
    - Signature: bool * bool * SynBinding list * SynExpr * range
    -
    -     		-

    LetOrUse(isRecursive, isUse, bindings, body, wholeRange)

    -

    F# syntax: let pat = expr in expr -F# syntax: let f pat1 .. patN = expr in expr -F# syntax: let rec f pat1 .. patN = expr in expr -F# syntax: use pat = expr in expr

    - - -
    - - - LetOrUseBang(...) - -
    - Signature: SequencePointInfoForBinding * bool * bool * SynPat * SynExpr * SynExpr * range
    -
    -     		-

    SynExpr.LetOrUseBang(spBind, isUse, isFromSource, pat, rhsExpr, bodyExpr, mWholeExpr).

    -

    F# syntax: let! pat = expr in expr -F# syntax: use! pat = expr in expr -Computation expressions only

    - - -
    - - - LibraryOnlyILAssembly(...) - -
    - Signature: ILInstr array * SynType list * SynExpr list * SynType list * range
    -
    -     		-

    Only used in FSharp.Core

    - - -
    - - - LibraryOnlyStaticOptimization(...) - -
    - Signature: SynStaticOptimizationConstraint list * SynExpr * SynExpr * range
    -
    -     		-

    Only used in FSharp.Core

    - - -
    - - - LibraryOnlyUnionCaseFieldGet(...) - -
    - Signature: SynExpr * LongIdent * int * range
    -
    -     		-

    Only used in FSharp.Core

    - - -
    - - - LibraryOnlyUnionCaseFieldSet(...) - -
    - Signature: SynExpr * LongIdent * int * SynExpr * range
    -
    -     		-

    Only used in FSharp.Core

    - - -
    - - - LongIdent(...) - -
    - Signature: bool * LongIdentWithDots * SynSimplePatAlternativeIdInfo ref option * range
    -
    -     		-

    F# syntax: ident.ident...ident -LongIdent(isOptional, longIdent, altNameRefCell, m) -isOptional: true if preceded by a '?' for an optional named parameter -altNameRefCell: Normally 'None' except for some compiler-generated variables in desugaring pattern matching. See SynSimplePat.Id

    - - -
    - - - LongIdentSet(longDotId,expr,range) - -
    - Signature: LongIdentWithDots * SynExpr * range
    -
    -     		-

    F# syntax: ident.ident...ident <- expr

    - - -
    - - - Match(matchSeqPoint,expr,clauses,range) - -
    - Signature: SequencePointInfoForBinding * SynExpr * SynMatchClause list * range
    -
    -     		-

    F# syntax: match expr with pat1 -> expr | ... | patN -> exprN

    - - -
    - - - MatchBang(...) - -
    - Signature: SequencePointInfoForBinding * SynExpr * SynMatchClause list * range
    -
    -     		-

    F# syntax: match! expr with pat1 -> expr | ... | patN -> exprN

    - - -
    - - - MatchLambda(...) - -
    - Signature: bool * range * SynMatchClause list * SequencePointInfoForBinding * range
    -
    -     		-

    F# syntax: function pat1 -> expr | ... | patN -> exprN

    - - -
    - - - NamedIndexedPropertySet(...) - -
    - Signature: LongIdentWithDots * SynExpr * SynExpr * range
    -
    -     		-

    F# syntax: Type.Items(e1) <- e2 , rarely used named-property-setter notation, e.g. Foo.Bar.Chars(3) <- 'a'

    - - -
    - - - New(isProtected,typeName,expr,range) - -
    - Signature: bool * SynType * SynExpr * range
    -
    -     		-

    F# syntax: new C(...) -The flag is true if known to be 'family' ('protected') scope

    - - -
    - - - Null(range) - -
    - Signature: range
    -
    -     		-

    F# syntax: null

    - - -
    - - - ObjExpr(...) - -
    - Signature: SynType * (SynExpr * Ident option) option * SynBinding list * SynInterfaceImpl list * range * range
    -
    -     		-

    SynExpr.ObjExpr(objTy,argOpt,binds,extraImpls,mNewExpr,mWholeExpr)

    -

    F# syntax: { new ... with ... }

    - - -
    - - - Paren(...) - -
    - Signature: SynExpr * range * range option * range
    -
    -     		-

    F# syntax: (expr)

    -

    Paren(expr, leftParenRange, rightParenRange, wholeRangeIncludingParentheses)

    -

    Parenthesized expressions. Kept in AST to distinguish A.M((x,y)) -from A.M(x,y), among other things.

    - - -
    - - - Quote(...) - -
    - Signature: SynExpr * bool * SynExpr * bool * range
    -
    -     		-

    F# syntax: <@ expr @>, <@@ expr @@>

    -

    Quote(operator,isRaw,quotedSynExpr,isFromQueryExpression,m)

    - - -
    - - - Record(...) - -
    - Signature: (SynType * SynExpr * range * BlockSeparator option * range) option * (SynExpr * BlockSeparator) option * (RecordFieldName * SynExpr option * BlockSeparator option) list * range
    -
    -     		-

    F# syntax: { f1=e1; ...; fn=en } -SynExpr.Record((baseType, baseCtorArgs, mBaseCtor, sepAfterBase, mInherits), (copyExpr, sepAfterCopyExpr), (recordFieldName, fieldValue, sepAfterField), mWholeExpr) -inherit includes location of separator (for tooling) -copyOpt contains range of the following WITH part (for tooling) -every field includes range of separator after the field (for tooling)

    - - -
    - - - Sequential(...) - -
    - Signature: SequencePointInfoForSeq * bool * SynExpr * SynExpr * range
    -
    -     		-

    Seq(seqPoint, isTrueSeq, e1, e2, m) -isTrueSeq: false indicates "let v = a in b; v"

    -

    F# syntax: expr; expr

    - - -
    - - - Set(SynExpr,SynExpr,range) - -
    - Signature: SynExpr * SynExpr * range
    -
    -     		-

    F# syntax: expr <- expr

    - - -
    - - - TraitCall(...) - -
    - Signature: SynTypar list * SynMemberSig * SynExpr * range
    -
    -     		-

    F# syntax: ((typar1 or ... or typarN): (member-dig) expr)

    - - -
    - - - TryFinally(...) - -
    - Signature: SynExpr * SynExpr * range * SequencePointInfoForTry * SequencePointInfoForFinally
    -
    -     		-

    F# syntax: try expr finally expr

    - - -
    - - - TryWith(...) - -
    - Signature: SynExpr * range * SynMatchClause list * range * range * SequencePointInfoForTry * SequencePointInfoForWith
    -
    -     		-

    F# syntax: try expr with pat -> expr

    - - -
    - - - Tuple(isStruct,exprs,commaRanges,range) - -
    - Signature: bool * SynExpr list * range list * range
    -
    -     		-

    F# syntax: e1, ..., eN

    - - -
    - - - TypeApp(...) - -
    - Signature: SynExpr * range * SynType list * range list * range option * range * range
    -
    -     		-

    TypeApp(expr, mLessThan, types, mCommas, mGreaterThan, mTypeArgs, mWholeExpr) -"mCommas" are the ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them

    -

    F# syntax: expr

    - - -
    - - - Typed(expr,typeName,range) - -
    - Signature: SynExpr * SynType * range
    -
    -     		-

    F# syntax: expr : type

    - - -
    - - - TypeTest(expr,typeName,range) - -
    - Signature: SynExpr * SynType * range
    -
    -     		-

    F# syntax: expr :? type

    - - -
    - - - Upcast(expr,typeName,range) - -
    - Signature: SynExpr * SynType * range
    -
    -     		-

    F# syntax: expr :> type

    - - -
    - - - While(...) - -
    - Signature: SequencePointInfoForWhileLoop * SynExpr * SynExpr * range
    -
    -     		-

    F# syntax: 'while ... do ...'

    - - -
    - - - YieldOrReturn(bool * bool,expr,range) - -
    - Signature: bool * bool * SynExpr * range
    -
    -     		-

    F# syntax: yield expr -F# syntax: return expr -Computation expressions only

    - - -
    - - - YieldOrReturnFrom(...) - -
    - Signature: bool * bool * SynExpr * range
    -
    -     		-

    F# syntax: yield! expr -F# syntax: return! expr -Computation expressions only

    - - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - IsArbExprAndThusAlreadyReportedError - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsArbExprAndThusAlreadyReportedError

    -
    - - - Range - -
    - Signature: range
    -
    -     		-

    Get the syntactic range of source code covered by this construct.

    - - -

    CompiledName: get_Range

    -
    - - - RangeOfFirstPortion - -
    - Signature: range
    -
    -     		-

    Attempt to get the range of the first token or initial portion only - this is extremely ad-hoc, just a cheap way to improve a certain 'query custom operation' error range

    - - -

    CompiledName: get_RangeOfFirstPortion

    -
    - - - RangeSansAnyExtraDot - -
    - Signature: range
    -
    -     		-

    range ignoring any (parse error) extra trailing dots

    - - -

    CompiledName: get_RangeSansAnyExtraDot

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synfield.html b/docs/reference/fsharp-compiler-ast-synfield.html deleted file mode 100644 index a8121219ab..0000000000 --- a/docs/reference/fsharp-compiler-ast-synfield.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - SynField - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynField

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The untyped, unchecked syntax tree for a field declaration in a record or class

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - Field(...) - -
    - Signature: SynAttributes * bool * Ident option * SynType * bool * PreXmlDoc * SynAccess option * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synfields.html b/docs/reference/fsharp-compiler-ast-synfields.html deleted file mode 100644 index a9d6d7019e..0000000000 --- a/docs/reference/fsharp-compiler-ast-synfields.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - SynFields - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynFields

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: SynField
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> SynField
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: SynField list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: SynField list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synindexerarg.html b/docs/reference/fsharp-compiler-ast-synindexerarg.html deleted file mode 100644 index 729050e0b2..0000000000 --- a/docs/reference/fsharp-compiler-ast-synindexerarg.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - SynIndexerArg - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynIndexerArg

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - One(SynExpr) - -
    - Signature: SynExpr
    -
    -     		- -
    - - - Two(SynExpr,SynExpr) - -
    - Signature: SynExpr * SynExpr
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Exprs - -
    - Signature: SynExpr list
    -
    -     		- -

    CompiledName: get_Exprs

    -
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syninfo.html b/docs/reference/fsharp-compiler-ast-syninfo.html deleted file mode 100644 index 3ac3791d75..0000000000 --- a/docs/reference/fsharp-compiler-ast-syninfo.html +++ /dev/null @@ -1,482 +0,0 @@ - - - - - SynInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynInfo

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    Operations related to the syntactic analysis of arguments of value, function and member definitions and signatures.

    -

    Function and member definitions have strongly syntactically constrained arities. We infer -the arity from the syntax.

    -

    For example, we record the arity for: -StaticProperty --> [1] -- for unit arg -this.InstanceProperty --> [1;1] -- for unit arg -StaticMethod(args) --> map InferSynArgInfoFromSimplePat args -this.InstanceMethod() --> 1 :: map InferSynArgInfoFromSimplePat args -this.InstanceProperty with get(argpat) --> 1 :: [InferSynArgInfoFromSimplePat argpat] -StaticProperty with get(argpat) --> [InferSynArgInfoFromSimplePat argpat] -this.InstanceProperty with get() --> 1 :: [InferSynArgInfoFromSimplePat argpat] -StaticProperty with get() --> [InferSynArgInfoFromSimplePat argpat]

    -

    this.InstanceProperty with set(argpat)(v) --> 1 :: [InferSynArgInfoFromSimplePat argpat; 1] -StaticProperty with set(argpat)(v) --> [InferSynArgInfoFromSimplePat argpat; 1] -this.InstanceProperty with set(v) --> 1 :: [1] -StaticProperty with set(v) --> [1]

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - AdjustArgsForUnitElimination (...) - -
    - Signature: infosForArgs:SynArgInfo list list -> SynArgInfo list list
    -
    -     		-

    Make sure only a solitary unit argument has unit elimination

    - - -
    - - - AdjustMemberArgs memFlags infosForArgs - -
    - Signature: memFlags:MemberKind -> infosForArgs:'a list list -> 'a list list
    - Type parameters: 'a
    -     		-

    Transform a property declared using '[static] member P = expr' to a method taking a "unit" argument. -This is similar to IncorporateEmptyTupledArgForPropertyGetter, but applies to member definitions -rather than member signatures.

    - - -
    - - - AritiesOfArgs arg1 - -
    - Signature: SynValInfo -> int list
    -
    -     		-

    Get the argument counts for each curried argument group. Used in some adhoc places in tc.fs.

    - - -
    - - - AttribsOfArgData arg1 - -
    - Signature: SynArgInfo -> SynAttributes
    -
    -     		-

    Get the argument attributes from the syntactic information for an argument.

    - - -
    - - - emptySynValData - -
    - Signature: SynValData
    -
    -     		- -
    - - - HasNoArgs arg1 - -
    - Signature: SynValInfo -> bool
    -
    -     		-

    Determine if a syntactic information represents a member without arguments (which is implicitly a property getter)

    - - -
    - - - HasOptionalArgs arg1 - -
    - Signature: SynValInfo -> bool
    -
    -     		-

    Check if there are any optional arguments in the syntactic argument information. Used when adjusting the -types of optional arguments for function and member signatures.

    - - -
    - - - IncorporateEmptyTupledArgForPropertyGetter (...) - -
    - Signature: SynValInfo -> SynValInfo
    -
    -     		-

    Add a parameter entry to the syntactic value information to represent the '()' argument to a property getter. This is -used for the implicit '()' argument in property getter signature specifications.

    - - -
    - - - IncorporateSelfArg arg1 - -
    - Signature: SynValInfo -> SynValInfo
    -
    -     		-

    Add a parameter entry to the syntactic value information to represent the 'this' argument. This is -used for the implicit 'this' argument in member signature specifications.

    - - -
    - - - IncorporateSetterArg arg1 - -
    - Signature: SynValInfo -> SynValInfo
    -
    -     		-

    Add a parameter entry to the syntactic value information to represent the value argument for a property setter. This is -used for the implicit value argument in property setter signature specifications.

    - - -
    - - - InferLambdaArgs origRhsExpr - -
    - Signature: origRhsExpr:SynExpr -> SynArgInfo list list
    -
    -     		-

    For 'let' definitions, we infer syntactic argument information from the r.h.s. of a definition, if it -is an immediate 'fun ... -> ...' or 'function ...' expression. This is noted in the F# language specification. -This does not apply to member definitions.

    - - -
    - - - InferSynArgInfoFromPat p - -
    - Signature: p:SynPat -> SynArgInfo list
    -
    -     		-

    Infer the syntactic argument info for one or more arguments a pattern.

    - - -
    - - - InferSynArgInfoFromSimplePat attribs p - -
    - Signature: attribs:SynAttributes -> p:SynSimplePat -> SynArgInfo
    -
    -     		-

    Infer the syntactic argument info for a single argument from a simple pattern.

    - - -
    - - - InferSynArgInfoFromSimplePats x - -
    - Signature: x:SynSimplePats -> SynArgInfo list
    -
    -     		-

    Infer the syntactic argument info for one or more arguments one or more simple patterns.

    - - -
    - - - InferSynReturnData retInfo - -
    - Signature: retInfo:SynReturnInfo option -> SynArgInfo
    -
    -     		- -
    - - - InferSynValData (...) - -
    - Signature: (memberFlagsOpt:MemberFlags option * pat:SynPat option * retInfo:SynReturnInfo option * origRhsExpr:SynExpr) -> SynValData
    -
    -     		-

    Infer the syntactic information for a 'let' or 'member' definition, based on the argument pattern, -any declared return information (e.g. .NET attributes on the return element), and the r.h.s. expression -in the case of 'let' definitions.

    - - -
    - - - IsOptionalArg arg1 - -
    - Signature: SynArgInfo -> bool
    -
    -     		-

    Check if one particular argument is an optional argument. Used when adjusting the -types of optional arguments for function and member signatures.

    - - -
    - - - selfMetadata - -
    - Signature: SynArgInfo list
    -
    -     		-

    The 'argument' information for the 'this'/'self' parameter in the cases where it is not given explicitly

    - - -
    - - - unitArgData - -
    - Signature: SynArgInfo list
    -
    -     		-

    The argument information for a '()' argument

    - - -
    - - - unnamedRetVal - -
    - Signature: SynArgInfo
    -
    -     		-

    The 'argument' information for a return value where no attributes are given for the return value (the normal case)

    - - -
    - - - unnamedTopArg - -
    - Signature: SynArgInfo list
    -
    -     		-

    The argument information for a curried argument without a name

    - - -
    - - - unnamedTopArg1 - -
    - Signature: SynArgInfo
    -
    -     		-

    The argument information for an argument without a name

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syninterfaceimpl.html b/docs/reference/fsharp-compiler-ast-syninterfaceimpl.html deleted file mode 100644 index ce50c865bd..0000000000 --- a/docs/reference/fsharp-compiler-ast-syninterfaceimpl.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - SynInterfaceImpl - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynInterfaceImpl

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - InterfaceImpl(...) - -
    - Signature: SynType * SynBinding list * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmatchclause.html b/docs/reference/fsharp-compiler-ast-synmatchclause.html deleted file mode 100644 index 424762ba35..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmatchclause.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - SynMatchClause - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynMatchClause

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - Clause(...) - -
    - Signature: SynPat * SynExpr option * SynExpr * range * SequencePointInfoForTarget
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - - - RangeOfGuardAndRhs - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_RangeOfGuardAndRhs

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmeasure.html b/docs/reference/fsharp-compiler-ast-synmeasure.html deleted file mode 100644 index ddfc57e9fa..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmeasure.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - SynMeasure - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynMeasure

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The unchecked abstract syntax tree of F# unit of measure annotations. -This should probably be merged with the representation of SynType.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Anon(range) - -
    - Signature: range
    -
    -     		- -
    - - - Divide(SynMeasure,SynMeasure,range) - -
    - Signature: SynMeasure * SynMeasure * range
    -
    -     		- -
    - - - Named(longId,range) - -
    - Signature: LongIdent * range
    -
    -     		- -
    - - - One - -
    - Signature:
    -
    -     		- -
    - - - Power(SynMeasure,SynRationalConst,range) - -
    - Signature: SynMeasure * SynRationalConst * range
    -
    -     		- -
    - - - Product(SynMeasure,SynMeasure,range) - -
    - Signature: SynMeasure * SynMeasure * range
    -
    -     		- -
    - - - Seq(SynMeasure list,range) - -
    - Signature: SynMeasure list * range
    -
    -     		- -
    - - - Var(SynTypar,range) - -
    - Signature: SynTypar * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmemberdefn.html b/docs/reference/fsharp-compiler-ast-synmemberdefn.html deleted file mode 100644 index 75d1557eb3..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmemberdefn.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - SynMemberDefn - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynMemberDefn

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AbstractSlot(...) - -
    - Signature: SynValSig * MemberFlags * range
    -
    -     		- -
    - - - AutoProperty(...) - -
    - Signature: SynAttributes * bool * Ident * SynType option * MemberKind * MemberKind -> MemberFlags * PreXmlDoc * SynAccess option * SynExpr * range option * range
    -
    -     		-

    SynMemberDefn.AutoProperty (attribs,isStatic,id,tyOpt,propKind,memberFlags,xmlDoc,access,synExpr,mGetSet,mWholeAutoProp).

    -

    F# syntax: 'member val X = expr'

    - - -
    - - - ImplicitCtor(...) - -
    - Signature: SynAccess option * SynAttributes * SynSimplePat list * Ident option * range
    -
    -     		-

    implicit ctor args as a defn line, 'as' specification

    - - -
    - - - ImplicitInherit(...) - -
    - Signature: SynType * SynExpr * Ident option * range
    -
    -     		-

    inherit (args...) as base

    - - -
    - - - Inherit(SynType,Ident option,range) - -
    - Signature: SynType * Ident option * range
    -
    -     		- -
    - - - Interface(...) - -
    - Signature: SynType * SynMemberDefns option * range
    -
    -     		- -
    - - - LetBindings(...) - -
    - Signature: SynBinding list * bool * bool * range
    -
    -     		-

    LetBindings(bindingList, isStatic, isRecursive, wholeRange)

    -

    localDefns

    - - -
    - - - Member(memberDefn,range) - -
    - Signature: SynBinding * range
    -
    -     		- -
    - - - NestedType(typeDefn,accessibility,range) - -
    - Signature: SynTypeDefn * SynAccess option * range
    -
    -     		-

    A feature that is not implemented

    - - -
    - - - Open(longId,range) - -
    - Signature: LongIdent * range
    -
    -     		- -
    - - - ValField(SynField,range) - -
    - Signature: SynField * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmemberdefns.html b/docs/reference/fsharp-compiler-ast-synmemberdefns.html deleted file mode 100644 index dc2a4dd834..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmemberdefns.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - SynMemberDefns - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynMemberDefns

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: SynMemberDefn
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> SynMemberDefn
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: SynMemberDefn list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: SynMemberDefn list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmembersig.html b/docs/reference/fsharp-compiler-ast-synmembersig.html deleted file mode 100644 index e4785b699d..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmembersig.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - SynMemberSig - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynMemberSig

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The untyped, unchecked syntax tree for a member signature, used in signature files, abstract member declarations -and member constraints.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Inherit(typeName,range) - -
    - Signature: SynType * range
    -
    -     		- -
    - - - Interface(typeName,range) - -
    - Signature: SynType * range
    -
    -     		- -
    - - - Member(SynValSig,MemberFlags,range) - -
    - Signature: SynValSig * MemberFlags * range
    -
    -     		- -
    - - - NestedType(SynTypeDefnSig,range) - -
    - Signature: SynTypeDefnSig * range
    -
    -     		- -
    - - - ValField(SynField,range) - -
    - Signature: SynField * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmembersigs.html b/docs/reference/fsharp-compiler-ast-synmembersigs.html deleted file mode 100644 index cf93845a52..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmembersigs.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - SynMemberSigs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynMemberSigs

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: SynMemberSig
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> SynMemberSig
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: SynMemberSig list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: SynMemberSig list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmoduledecl.html b/docs/reference/fsharp-compiler-ast-synmoduledecl.html deleted file mode 100644 index c678881a95..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmoduledecl.html +++ /dev/null @@ -1,266 +0,0 @@ - - - - - SynModuleDecl - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynModuleDecl

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Attributes(SynAttributes,range) - -
    - Signature: SynAttributes * range
    -
    -     		- -
    - - - DoExpr(...) - -
    - Signature: SequencePointInfoForBinding * SynExpr * range
    -
    -     		- -
    - - - Exception(SynExceptionDefn,range) - -
    - Signature: SynExceptionDefn * range
    -
    -     		- -
    - - - HashDirective(ParsedHashDirective,range) - -
    - Signature: ParsedHashDirective * range
    -
    -     		- -
    - - - Let(isRecursive,SynBinding list,range) - -
    - Signature: bool * SynBinding list * range
    -
    -     		- -
    - - - ModuleAbbrev(ident,longId,range) - -
    - Signature: Ident * LongIdent * range
    -
    -     		- -
    - - - NamespaceFragment(SynModuleOrNamespace) - -
    - Signature: SynModuleOrNamespace
    -
    -     		- -
    - - - NestedModule(...) - -
    - Signature: SynComponentInfo * bool * SynModuleDecls * bool * range
    -
    -     		- -
    - - - Open(longDotId,range) - -
    - Signature: LongIdentWithDots * range
    -
    -     		- -
    - - - Types(SynTypeDefn list,range) - -
    - Signature: SynTypeDefn list * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmoduledecls.html b/docs/reference/fsharp-compiler-ast-synmoduledecls.html deleted file mode 100644 index 2736b37c1c..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmoduledecls.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - SynModuleDecls - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynModuleDecls

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: SynModuleDecl
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> SynModuleDecl
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: SynModuleDecl list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: SynModuleDecl list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmoduleornamespace.html b/docs/reference/fsharp-compiler-ast-synmoduleornamespace.html deleted file mode 100644 index fef1c21035..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmoduleornamespace.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - SynModuleOrNamespace - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynModuleOrNamespace

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynModuleOrNamespace(...) - -
    - Signature: LongIdent * bool * SynModuleOrNamespaceKind * SynModuleDecls * PreXmlDoc * SynAttributes * SynAccess option * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmoduleornamespacekind.html b/docs/reference/fsharp-compiler-ast-synmoduleornamespacekind.html deleted file mode 100644 index 26d1356008..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmoduleornamespacekind.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - SynModuleOrNamespaceKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynModuleOrNamespaceKind

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AnonModule - -
    - Signature:
    -
    -     		- -
    - - - DeclaredNamespace - -
    - Signature:
    -
    -     		- -
    - - - GlobalNamespace - -
    - Signature:
    -
    -     		- -
    - - - NamedModule - -
    - Signature:
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - IsModule - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsModule

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmoduleornamespacesig.html b/docs/reference/fsharp-compiler-ast-synmoduleornamespacesig.html deleted file mode 100644 index 2791d78989..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmoduleornamespacesig.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - SynModuleOrNamespaceSig - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynModuleOrNamespaceSig

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynModuleOrNamespaceSig(...) - -
    - Signature: LongIdent * bool * SynModuleOrNamespaceKind * SynModuleSigDecls * PreXmlDoc * SynAttributes * SynAccess option * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmodulesigdecl.html b/docs/reference/fsharp-compiler-ast-synmodulesigdecl.html deleted file mode 100644 index 1c5e8bac90..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmodulesigdecl.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - SynModuleSigDecl - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynModuleSigDecl

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Exception(SynExceptionSig,range) - -
    - Signature: SynExceptionSig * range
    -
    -     		- -
    - - - HashDirective(ParsedHashDirective,range) - -
    - Signature: ParsedHashDirective * range
    -
    -     		- -
    - - - ModuleAbbrev(ident,longId,range) - -
    - Signature: Ident * LongIdent * range
    -
    -     		- -
    - - - NamespaceFragment(...) - -
    - Signature: SynModuleOrNamespaceSig
    -
    -     		- -
    - - - NestedModule(...) - -
    - Signature: SynComponentInfo * bool * SynModuleSigDecls * range
    -
    -     		- -
    - - - Open(longId,range) - -
    - Signature: LongIdent * range
    -
    -     		- -
    - - - Types(SynTypeDefnSig list,range) - -
    - Signature: SynTypeDefnSig list * range
    -
    -     		- -
    - - - Val(SynValSig,range) - -
    - Signature: SynValSig * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synmodulesigdecls.html b/docs/reference/fsharp-compiler-ast-synmodulesigdecls.html deleted file mode 100644 index e08d0bd7c7..0000000000 --- a/docs/reference/fsharp-compiler-ast-synmodulesigdecls.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - SynModuleSigDecls - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynModuleSigDecls

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: SynModuleSigDecl
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> SynModuleSigDecl
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: SynModuleSigDecl list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: SynModuleSigDecl list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synpat.html b/docs/reference/fsharp-compiler-ast-synpat.html deleted file mode 100644 index 4de8d8f4aa..0000000000 --- a/docs/reference/fsharp-compiler-ast-synpat.html +++ /dev/null @@ -1,406 +0,0 @@ - - - - - SynPat - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynPat

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Ands(SynPat list,range) - -
    - Signature: SynPat list * range
    -
    -     		- -
    - - - ArrayOrList(bool,SynPat list,range) - -
    - Signature: bool * SynPat list * range
    -
    -     		- -
    - - - Attrib(SynPat,SynAttributes,range) - -
    - Signature: SynPat * SynAttributes * range
    -
    -     		- -
    - - - Const(SynConst,range) - -
    - Signature: SynConst * range
    -
    -     		- -
    - - - DeprecatedCharRange(char,char,range) - -
    - Signature: char * char * range
    -
    -     		-

    Deprecated character range:ranges

    - - -
    - - - FromParseError(SynPat,range) - -
    - Signature: SynPat * range
    -
    -     		-

    A pattern arising from a parse error

    - - -
    - - - InstanceMember(...) - -
    - Signature: Ident * Ident * Ident option * SynAccess option * range
    -
    -     		-

    Used internally in the type checker

    - - -
    - - - IsInst(SynType,range) - -
    - Signature: SynType * range
    -
    -     		-

    ':? type '

    - - -
    - - - LongIdent(...) - -
    - Signature: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * SynAccess option * range
    -
    -     		- -
    - - - Named(...) - -
    - Signature: SynPat * Ident * bool * SynAccess option * range
    -
    -     		- -
    - - - Null(range) - -
    - Signature: range
    -
    -     		-

    'null'

    - - -
    - - - OptionalVal(Ident,range) - -
    - Signature: Ident * range
    -
    -     		-

    '?id' -- for optional argument names

    - - -
    - - - Or(SynPat,SynPat,range) - -
    - Signature: SynPat * SynPat * range
    -
    -     		- -
    - - - Paren(SynPat,range) - -
    - Signature: SynPat * range
    -
    -     		- -
    - - - QuoteExpr(SynExpr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    &lt;@ expr @&gt;, used for active pattern arguments

    - - -
    - - - Record(...) - -
    - Signature: ((LongIdent * Ident) * SynPat) list * range
    -
    -     		- -
    - - - Tuple(isStruct,SynPat list,range) - -
    - Signature: bool * SynPat list * range
    -
    -     		- -
    - - - Typed(SynPat,SynType,range) - -
    - Signature: SynPat * SynType * range
    -
    -     		- -
    - - - Wild(range) - -
    - Signature: range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synrationalconst.html b/docs/reference/fsharp-compiler-ast-synrationalconst.html deleted file mode 100644 index 4dc143146d..0000000000 --- a/docs/reference/fsharp-compiler-ast-synrationalconst.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - SynRationalConst - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynRationalConst

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The unchecked abstract syntax tree of F# unit of measure exponents.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Integer(int32) - -
    - Signature: int32
    -
    -     		- -
    - - - Negate(SynRationalConst) - -
    - Signature: SynRationalConst
    -
    -     		- -
    - - - Rational(int32,int32,range) - -
    - Signature: int32 * int32 * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synreturninfo.html b/docs/reference/fsharp-compiler-ast-synreturninfo.html deleted file mode 100644 index 41c42cd188..0000000000 --- a/docs/reference/fsharp-compiler-ast-synreturninfo.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - SynReturnInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynReturnInfo

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The syntactic elements associated with the "return" of a function or method. Some of this is -mostly dummy information to make the return element look like an argument, -the important thing is that (a) you can give a return type for the function or method, and -(b) you can associate .NET attributes to return of a function or method and these get stored in .NET metadata.

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynReturnInfo(...) - -
    - Signature: SynType * SynArgInfo * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synsimplepat.html b/docs/reference/fsharp-compiler-ast-synsimplepat.html deleted file mode 100644 index 8f33f82e8b..0000000000 --- a/docs/reference/fsharp-compiler-ast-synsimplepat.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - SynSimplePat - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynSimplePat

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Attrib(SynSimplePat,SynAttributes,range) - -
    - Signature: SynSimplePat * SynAttributes * range
    -
    -     		- -
    - - - Id(...) - -
    - Signature: Ident * SynSimplePatAlternativeIdInfo ref option * bool * bool * bool * range
    -
    -     		-

    Id (ident, altNameRefCell, isCompilerGenerated, isThisVar, isOptArg, range)

    -

    Indicates a simple pattern variable.

    -

    altNameRefCell -Normally 'None' except for some compiler-generated variables in desugaring pattern matching. -Pattern processing sets this reference for hidden variable introduced by desugaring pattern matching in arguments. -The info indicates an alternative (compiler generated) identifier to be used because the name of the identifier is already bound. -See Product Studio FSharp 1.0, bug 6389.

    -

    isCompilerGenerated : true if a compiler generated name -isThisVar: true if 'this' variable in member -isOptArg: true if a '?' is in front of the name

    - - -
    - - - Typed(SynSimplePat,SynType,range) - -
    - Signature: SynSimplePat * SynType * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synsimplepatalternativeidinfo.html b/docs/reference/fsharp-compiler-ast-synsimplepatalternativeidinfo.html deleted file mode 100644 index 652f558403..0000000000 --- a/docs/reference/fsharp-compiler-ast-synsimplepatalternativeidinfo.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - SynSimplePatAlternativeIdInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynSimplePatAlternativeIdInfo

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Decided(Ident) - -
    - Signature: Ident
    -
    -     		-

    We have decided to use an alternative name in tha pattern and related expression

    - - -
    - - - Undecided(Ident) - -
    - Signature: Ident
    -
    -     		-

    We have not decided to use an alternative name in tha pattern and related expression

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synsimplepats.html b/docs/reference/fsharp-compiler-ast-synsimplepats.html deleted file mode 100644 index ff68c23282..0000000000 --- a/docs/reference/fsharp-compiler-ast-synsimplepats.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - SynSimplePats - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynSimplePats

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    Represents a simple set of variable bindings a, (a,b) or (a:Type,b:Type) at a lambda, -function definition or other binding point, after the elimination of pattern matching -from the construct, e.g. after changing a "function pat1 -> rule1 | ..." to a -"fun v -> match v with ..."

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - SimplePats(SynSimplePat list,range) - -
    - Signature: SynSimplePat list * range
    -
    -     		- -
    - - - Typed(SynSimplePats,SynType,range) - -
    - Signature: SynSimplePats * SynType * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synstaticoptimizationconstraint.html b/docs/reference/fsharp-compiler-ast-synstaticoptimizationconstraint.html deleted file mode 100644 index bd8b296658..0000000000 --- a/docs/reference/fsharp-compiler-ast-synstaticoptimizationconstraint.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - SynStaticOptimizationConstraint - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynStaticOptimizationConstraint

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - WhenTyparIsStruct(SynTypar,range) - -
    - Signature: SynTypar * range
    -
    -     		- -
    - - - WhenTyparTyconEqualsTycon(...) - -
    - Signature: SynTypar * SynType * range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntaxerror.html b/docs/reference/fsharp-compiler-ast-syntaxerror.html deleted file mode 100644 index 30bda9cec8..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntaxerror.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - SyntaxError - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SyntaxError

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The error raised by the parseerrorrich function, which is called by the parser engine -when a syntax error occurs. The first object is the ParseErrorContext which contains a dump of -information about the grammar at the point where the error occurred, e.g. what tokens -are valid to shift next at that point in the grammar. This information is processed in CompileOps.fs.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: obj
    -
    -     		- -
    - - - range - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntypar.html b/docs/reference/fsharp-compiler-ast-syntypar.html deleted file mode 100644 index e88a2a9035..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntypar.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - SynTypar - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynTypar

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - Typar(ident,staticReq,isCompGen) - -
    - Signature: Ident * TyparStaticReq * bool
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntypardecl.html b/docs/reference/fsharp-compiler-ast-syntypardecl.html deleted file mode 100644 index 6a0c1480f4..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntypardecl.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - SynTyparDecl - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynTyparDecl

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    Represents the explicit declaration of a type parameter

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - TyparDecl(attributes,SynTypar) - -
    - Signature: SynAttributes * SynTypar
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntype.html b/docs/reference/fsharp-compiler-ast-syntype.html deleted file mode 100644 index cb9079cc0f..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntype.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - SynType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynType

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The unchecked abstract syntax tree of F# types

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Anon(range) - -
    - Signature: range
    -
    -     		-

    F# syntax : _

    - - -
    - - - AnonRecd(isStruct,typeNames,range) - -
    - Signature: bool * (Ident * SynType) list * range
    -
    -     		-

    F# syntax : {| id: type; ...; id: type |} -F# syntax : struct {| id: type; ...; id: type |}

    - - -
    - - - App(...) - -
    - Signature: SynType * range option * SynType list * range list * range option * bool * range
    -
    -     		-

    App(typeName, LESSm, typeArgs, commasm, GREATERm, isPostfix, m)

    -

    F# syntax : type or type type or (type,...,type) type -isPostfix: indicates a postfix type application e.g. "int list" or "(int,string) dict" -commasm: ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them

    - - -
    - - - Array(int,elementType,range) - -
    - Signature: int * SynType * range
    -
    -     		-

    F# syntax : type[]

    - - -
    - - - Fun(argType,returnType,range) - -
    - Signature: SynType * SynType * range
    -
    -     		-

    F# syntax : type -> type

    - - -
    - - - HashConstraint(SynType,range) - -
    - Signature: SynType * range
    -
    -     		-

    F# syntax : #type

    - - -
    - - - LongIdent(longDotId) - -
    - Signature: LongIdentWithDots
    -
    -     		-

    F# syntax : A.B.C

    - - -
    - - - LongIdentApp(...) - -
    - Signature: SynType * LongIdentWithDots * range option * SynType list * range list * range option * range
    -
    -     		-

    LongIdentApp(typeName, longId, LESSm, tyArgs, commasm, GREATERm, wholem)

    -

    F# syntax : type.A.B.C -commasm: ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them

    - - -
    - - - MeasureDivide(...) - -
    - Signature: SynType * SynType * range
    -
    -     		-

    F# syntax : for units of measure e.g. m / s

    - - -
    - - - MeasurePower(...) - -
    - Signature: SynType * SynRationalConst * range
    -
    -     		-

    F# syntax : for units of measure e.g. m^3, kg^1/2

    - - -
    - - - StaticConstant(constant,range) - -
    - Signature: SynConst * range
    -
    -     		-

    F# syntax : 1, "abc" etc, used in parameters to type providers -For the dimensionless units i.e. 1 , and static parameters to provided types

    - - -
    - - - StaticConstantExpr(expr,range) - -
    - Signature: SynExpr * range
    -
    -     		-

    F# syntax : const expr, used in static parameters to type providers

    - - -
    - - - StaticConstantNamed(expr,SynType,range) - -
    - Signature: SynType * SynType * range
    -
    -     		-

    F# syntax : ident=1 etc., used in static parameters to type providers

    - - -
    - - - Tuple(isStruct,typeNames,range) - -
    - Signature: bool * (bool * SynType) list * range
    -
    -     		-

    F# syntax : type ... type -F# syntax : struct (type ... type)

    - - -
    - - - Var(genericName,range) - -
    - Signature: SynTypar * range
    -
    -     		-

    F# syntax : 'Var

    - - -
    - - - WithGlobalConstraints(...) - -
    - Signature: SynType * SynTypeConstraint list * range
    -
    -     		-

    F# syntax : typ with constraints

    - - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		-

    Get the syntactic range of source code covered by this construct.

    - - -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntypeconstraint.html b/docs/reference/fsharp-compiler-ast-syntypeconstraint.html deleted file mode 100644 index e44836d2b1..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntypeconstraint.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - SynTypeConstraint - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynTypeConstraint

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The unchecked abstract syntax tree of F# type constraints

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - WhereTyparDefaultsToType(...) - -
    - Signature: SynTypar * SynType * range
    -
    -     		-

    F# syntax is default ^T : type

    - - -
    - - - WhereTyparIsComparable(...) - -
    - Signature: SynTypar * range
    -
    -     		-

    F# syntax is 'typar : comparison

    - - -
    - - - WhereTyparIsDelegate(...) - -
    - Signature: SynTypar * SynType list * range
    -
    -     		-

    F# syntax is 'typar : delegate<'Args,unit>

    - - -
    - - - WhereTyparIsEnum(...) - -
    - Signature: SynTypar * SynType list * range
    -
    -     		-

    F# syntax is 'typar : enum<'UnderlyingType>

    - - -
    - - - WhereTyparIsEquatable(genericName,range) - -
    - Signature: SynTypar * range
    -
    -     		-

    F# syntax is 'typar : equality

    - - -
    - - - WhereTyparIsReferenceType(...) - -
    - Signature: SynTypar * range
    -
    -     		-

    F# syntax : is 'typar : not struct

    - - -
    - - - WhereTyparIsUnmanaged(genericName,range) - -
    - Signature: SynTypar * range
    -
    -     		-

    F# syntax is 'typar : unmanaged

    - - -
    - - - WhereTyparIsValueType(genericName,range) - -
    - Signature: SynTypar * range
    -
    -     		-

    F# syntax : is 'typar : struct

    - - -
    - - - WhereTyparSubtypeOfType(...) - -
    - Signature: SynTypar * SynType * range
    -
    -     		-

    F# syntax is 'typar :> type

    - - -
    - - - WhereTyparSupportsMember(...) - -
    - Signature: SynType list * SynMemberSig * range
    -
    -     		-

    F# syntax is ^T : (static member MemberName : ^T * int -> ^T)

    - - -
    - - - WhereTyparSupportsNull(...) - -
    - Signature: SynTypar * range
    -
    -     		-

    F# syntax is 'typar : null

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntypedefn.html b/docs/reference/fsharp-compiler-ast-syntypedefn.html deleted file mode 100644 index 747af2406a..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntypedefn.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - SynTypeDefn - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynTypeDefn

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - TypeDefn(...) - -
    - Signature: SynComponentInfo * SynTypeDefnRepr * SynMemberDefns * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnkind.html b/docs/reference/fsharp-compiler-ast-syntypedefnkind.html deleted file mode 100644 index 0b58a6e10b..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntypedefnkind.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - SynTypeDefnKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynTypeDefnKind

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - TyconAbbrev - -
    - Signature:
    -
    -     		- -
    - - - TyconAugmentation - -
    - Signature:
    -
    -     		- -
    - - - TyconClass - -
    - Signature:
    -
    -     		- -
    - - - TyconDelegate(SynType,SynValInfo) - -
    - Signature: SynType * SynValInfo
    -
    -     		- -
    - - - TyconHiddenRepr - -
    - Signature:
    -
    -     		- -
    - - - TyconILAssemblyCode - -
    - Signature:
    -
    -     		- -
    - - - TyconInterface - -
    - Signature:
    -
    -     		- -
    - - - TyconRecord - -
    - Signature:
    -
    -     		- -
    - - - TyconStruct - -
    - Signature:
    -
    -     		- -
    - - - TyconUnion - -
    - Signature:
    -
    -     		- -
    - - - TyconUnspecified - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnrepr.html b/docs/reference/fsharp-compiler-ast-syntypedefnrepr.html deleted file mode 100644 index 7631a01a2c..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntypedefnrepr.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - SynTypeDefnRepr - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynTypeDefnRepr

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Exception(SynExceptionDefnRepr) - -
    - Signature: SynExceptionDefnRepr
    -
    -     		- -
    - - - ObjectModel(...) - -
    - Signature: SynTypeDefnKind * SynMemberDefns * range
    -
    -     		- -
    - - - Simple(SynTypeDefnSimpleRepr,range) - -
    - Signature: SynTypeDefnSimpleRepr * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnsig.html b/docs/reference/fsharp-compiler-ast-syntypedefnsig.html deleted file mode 100644 index 8465708a2f..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntypedefnsig.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - SynTypeDefnSig - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynTypeDefnSig

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The untyped, unchecked syntax tree for a type definition in a signature

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - TypeDefnSig(...) - -
    - Signature: SynComponentInfo * SynTypeDefnSigRepr * SynMemberSigs * range
    -
    -     		-

    The information for a type definition in a signature

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnsigrepr.html b/docs/reference/fsharp-compiler-ast-syntypedefnsigrepr.html deleted file mode 100644 index 172ceb7cf2..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntypedefnsigrepr.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - SynTypeDefnSigRepr - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynTypeDefnSigRepr

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The untyped, unchecked syntax tree for the right-hand-side of a type definition in a signature. -Note: in practice, using a discriminated union to make a distinction between -"simple" types and "object oriented" types is not particularly useful.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Exception(SynExceptionDefnRepr) - -
    - Signature: SynExceptionDefnRepr
    -
    -     		- -
    - - - ObjectModel(...) - -
    - Signature: SynTypeDefnKind * SynMemberSigs * range
    -
    -     		-

    Indicates the right right-hand-side is a class, struct, interface or other object-model type

    - - -
    - - - Simple(SynTypeDefnSimpleRepr,range) - -
    - Signature: SynTypeDefnSimpleRepr * range
    -
    -     		-

    Indicates the right right-hand-side is a record, union or other simple type.

    - - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnsimplerepr.html b/docs/reference/fsharp-compiler-ast-syntypedefnsimplerepr.html deleted file mode 100644 index 05ae734f5c..0000000000 --- a/docs/reference/fsharp-compiler-ast-syntypedefnsimplerepr.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - SynTypeDefnSimpleRepr - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynTypeDefnSimpleRepr

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The untyped, unchecked syntax tree for the core of a simple type definition, in either signature -or implementation.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Enum(SynEnumCases,range) - -
    - Signature: SynEnumCases * range
    -
    -     		-

    An enum type definition, type X = A = 1 | B = 2

    - - -
    - - - Exception(SynExceptionDefnRepr) - -
    - Signature: SynExceptionDefnRepr
    -
    -     		-

    An exception definition , "exception E = ..."

    - - -
    - - - General(...) - -
    - Signature: SynTypeDefnKind * (SynType * range * Ident option) list * (SynValSig * MemberFlags) list * SynField list * bool * bool * SynSimplePat list option * range
    -
    -     		-

    An object oriented type definition. This is not a parse-tree form, but represents the core -type representation which the type checker splits out from the "ObjectModel" cases of type definitions.

    - - -
    - - - LibraryOnlyILAssembly(ILType,range) - -
    - Signature: ILType * range
    -
    -     		-

    A type defined by using an IL assembly representation. Only used in FSharp.Core.

    -

    F# syntax: "type X = (# "..."#)

    - - -
    - - - None(range) - -
    - Signature: range
    -
    -     		-

    An abstract definition , "type X"

    - - -
    - - - Record(accessibility,recordFields,range) - -
    - Signature: SynAccess option * SynFields * range
    -
    -     		-

    A record type definition, type X = { A : int; B : int }

    - - -
    - - - TypeAbbrev(ParserDetail,SynType,range) - -
    - Signature: ParserDetail * SynType * range
    -
    -     		-

    A type abbreviation, "type X = A.B.C"

    - - -
    - - - Union(accessibility,unionCases,range) - -
    - Signature: SynAccess option * SynUnionCases * range
    -
    -     		-

    A union type definition, type X = A | B

    - - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synunioncase.html b/docs/reference/fsharp-compiler-ast-synunioncase.html deleted file mode 100644 index 7a9a7f6c61..0000000000 --- a/docs/reference/fsharp-compiler-ast-synunioncase.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - SynUnionCase - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynUnionCase

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - UnionCase(...) - -
    - Signature: SynAttributes * Ident * SynUnionCaseType * PreXmlDoc * SynAccess option * range
    -
    -     		-

    The untyped, unchecked syntax tree for one case in a union definition.

    - - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synunioncases.html b/docs/reference/fsharp-compiler-ast-synunioncases.html deleted file mode 100644 index ae115cd71c..0000000000 --- a/docs/reference/fsharp-compiler-ast-synunioncases.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - SynUnionCases - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynUnionCases

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: SynUnionCase
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> SynUnionCase
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: SynUnionCase list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: SynUnionCase list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synunioncasetype.html b/docs/reference/fsharp-compiler-ast-synunioncasetype.html deleted file mode 100644 index a2a7aeb7e1..0000000000 --- a/docs/reference/fsharp-compiler-ast-synunioncasetype.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - SynUnionCaseType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynUnionCaseType

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The untyped, unchecked syntax tree for the right-hand-side of union definition, excluding members, -in either a signature or implementation.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - UnionCaseFields(cases) - -
    - Signature: SynField list
    -
    -     		-

    Normal style declaration

    - - -
    - - - UnionCaseFullType(SynType * SynValInfo) - -
    - Signature: SynType * SynValInfo
    -
    -     		-

    Full type spec given by 'UnionCase : ty1 * tyN -> rty'. Only used in FSharp.Core, otherwise a warning.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synvaldata.html b/docs/reference/fsharp-compiler-ast-synvaldata.html deleted file mode 100644 index 9f1c27507d..0000000000 --- a/docs/reference/fsharp-compiler-ast-synvaldata.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - SynValData - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynValData

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynValData(...) - -
    - Signature: MemberFlags option * SynValInfo * Ident option
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synvalinfo.html b/docs/reference/fsharp-compiler-ast-synvalinfo.html deleted file mode 100644 index b538c698e6..0000000000 --- a/docs/reference/fsharp-compiler-ast-synvalinfo.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - SynValInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynValInfo

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The argument names and other metadata for a member or function

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynValInfo(...) - -
    - Signature: SynArgInfo list list * SynArgInfo
    -
    -     		-

    SynValInfo(curriedArgInfos, returnInfo)

    - - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - ArgInfos - -
    - Signature: SynArgInfo list list
    -
    -     		- -

    CompiledName: get_ArgInfos

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synvalsig.html b/docs/reference/fsharp-compiler-ast-synvalsig.html deleted file mode 100644 index 0f64e63ead..0000000000 --- a/docs/reference/fsharp-compiler-ast-synvalsig.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - SynValSig - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynValSig

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - ValSpfn(...) - -
    - Signature: SynAttributes * Ident * SynValTyparDecls * SynType * SynValInfo * bool * bool * PreXmlDoc * SynAccess option * SynExpr option * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - RangeOfId - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_RangeOfId

    -
    - - - SynInfo - -
    - Signature: SynValInfo
    -
    -     		- -

    CompiledName: get_SynInfo

    -
    - - - SynType - -
    - Signature: SynType
    -
    -     		- -

    CompiledName: get_SynType

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-synvaltypardecls.html b/docs/reference/fsharp-compiler-ast-synvaltypardecls.html deleted file mode 100644 index 10aa0e1782..0000000000 --- a/docs/reference/fsharp-compiler-ast-synvaltypardecls.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - SynValTyparDecls - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SynValTyparDecls

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    The names and other metadata for the type parameters for a member or function

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - SynValTyparDecls(...) - -
    - Signature: SynTyparDecl list * bool * SynTypeConstraint list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-typarstaticreq.html b/docs/reference/fsharp-compiler-ast-typarstaticreq.html deleted file mode 100644 index 281daccdfd..0000000000 --- a/docs/reference/fsharp-compiler-ast-typarstaticreq.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - TyparStaticReq - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    TyparStaticReq

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - HeadTypeStaticReq - -
    - Signature:
    -
    -     		- -
    - - - NoStaticReq - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-xmldoc.html b/docs/reference/fsharp-compiler-ast-xmldoc.html deleted file mode 100644 index 44b54aded9..0000000000 --- a/docs/reference/fsharp-compiler-ast-xmldoc.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - XmlDoc - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    XmlDoc

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - XmlDoc(string []) - -
    - Signature: string []
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - NonEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_NonEmpty

    -
    -

    Static members

    - - - - - - - - - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: XmlDoc
    -
    -     		- -

    CompiledName: get_Empty

    -
    - - - Merge(arg1 arg2) - -
    - Signature: XmlDoc -> XmlDoc -> XmlDoc
    -
    -     		- -
    - - - Process(arg1) - -
    - Signature: XmlDoc -> XmlDoc
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-xmldoccollector.html b/docs/reference/fsharp-compiler-ast-xmldoccollector.html deleted file mode 100644 index 0f9dab6638..0000000000 --- a/docs/reference/fsharp-compiler-ast-xmldoccollector.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - XmlDocCollector - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    XmlDocCollector

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -

    Used to collect XML documentation during lexing and parsing.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> XmlDocCollector
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AddGrabPoint(pos) - -
    - Signature: pos:pos -> unit
    -
    -     		- -
    - - - AddXmlDocLine(line, pos) - -
    - Signature: (line:string * pos:pos) -> unit
    -
    -     		- -
    - - - LinesBefore(grabPointPos) - -
    - Signature: grabPointPos:pos -> string []
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast-xmldocstatics.html b/docs/reference/fsharp-compiler-ast-xmldocstatics.html deleted file mode 100644 index f8e2828b7a..0000000000 --- a/docs/reference/fsharp-compiler-ast-xmldocstatics.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - XmlDocStatics - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    XmlDocStatics

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Ast -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> XmlDocStatics
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: XmlDoc
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-ast.html b/docs/reference/fsharp-compiler-ast.html deleted file mode 100644 index 46323fdcae..0000000000 --- a/docs/reference/fsharp-compiler-ast.html +++ /dev/null @@ -1,1983 +0,0 @@ - - - - - Ast - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Ast

    -

    - Namespace: FSharp.Compiler
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - BlockSeparator -

    denotes location of the separator block + optional position of the semicolon (used for tooling support)

    - -
    - ExprAtomicFlag -
    - Ident -
    - LexCont -
    - LexerEndlineContinuation -

    Specifies how the 'endline' function in the lexer should continue after -it reaches end of line or eof. The options are to continue with 'token' function -or to continue with 'skip' function.

    - -
    - LexerIfdefExpression -
    - LexerIfdefStack -
    - LexerIfdefStackEntries -
    - LexerIfdefStackEntry -
    - LexerWhitespaceContinuation -

    The parser defines a number of tokens for whitespace and -comments eliminated by the lexer. These carry a specification of -a continuation for the lexer for continued processing after we've dealt with -the whitespace.

    - -
    - LongIdent -
    - LongIdentWithDots -
    - MemberFlags -
    - MemberKind -

    Note the member kind is actually computed partially by a syntax tree transformation in tc.fs

    - -
    - NiceNameGenerator -

    Generates compiler-generated names. Each name generated also includes the StartLine number of the range passed in -at the point of first generation.

    -

    This type may be accessed concurrently, though in practice it is only used from the compilation thread. -It is made concurrency-safe since a global instance of the type is allocated in tast.fs, and it is good -policy to make all globally-allocated objects concurrency safe in case future versions of the compiler -are used to host multiple concurrent instances of compilation.

    - -
    - ParsedFsiInteraction -
    - ParsedHashDirective -
    - ParsedImplFile -
    - ParsedImplFileFragment -
    - ParsedImplFileInput -
    - ParsedInput -
    - ParsedSigFile -
    - ParsedSigFileFragment -
    - ParsedSigFileInput -
    - ParserDetail -
    - PreXmlDoc -
    - QualifiedNameOfFile -

    QualifiedNameOfFile acts to fully-qualify module specifications and implementations, -most importantly the ones that simply contribute fragments to a namespace (i.e. the ParsedSigFileFragment.NamespaceFragment case) -There may be multiple such fragments in a single assembly. There may thus also -be multiple matching pairs of these in an assembly, all contributing types to the same -namespace.

    - -
    - RecordFieldName -

    stores pair: record field name + (true if given record field name is syntactically correct and can be used in name resolution)

    - -
    - ScopedPragma -
    - SeqExprOnly -

    Indicates if a for loop is 'for x in e1 -> e2', only valid in sequence expressions

    - -
    - SequencePointInfoForBinding -
    - SequencePointInfoForFinally -
    - SequencePointInfoForForLoop -
    - SequencePointInfoForSeq -
    - SequencePointInfoForTarget -
    - SequencePointInfoForTry -
    - SequencePointInfoForWhileLoop -
    - SequencePointInfoForWith -
    - StableNiceNameGenerator -

    Generates compiler-generated names marked up with a source code location, but if given the same unique value then -return precisely the same name. Each name generated also includes the StartLine number of the range passed in -at the point of first generation.

    -

    This type may be accessed concurrently, though in practice it is only used from the compilation thread. -It is made concurrency-safe since a global instance of the type is allocated in tast.fs.

    - -
    - SynAccess -
    - SynArgInfo -

    The argument names and other metadata for a parameter for a member or function

    - -
    - SynArgNameGenerator -
    - SynAttribute -
    - SynAttributes -
    - SynBinding -
    - SynBindingKind -

    The kind associated with a binding - "let", "do" or a standalone expression

    - -
    - SynBindingReturnInfo -
    - SynComponentInfo -

    The untyped, unchecked syntax tree associated with the name of a type definition or module -in signature or implementation.

    -

    This includes the name, attributes, type parameters, constraints, documentation and accessibility -for a type definition or module. For modules, entries such as the type parameters are -always empty.

    - -
    - SynConst -

    The unchecked abstract syntax tree of constants in F# types and expressions.

    - -
    - SynConstructorArgs -
    - SynEnumCase -
    - SynEnumCases -
    - SynExceptionDefn -

    'exception E = ... with ...'

    - -
    - SynExceptionDefnRepr -

    'exception E = ... '

    - -
    - SynExceptionSig -
    - SynExpr -
    - SynField -

    The untyped, unchecked syntax tree for a field declaration in a record or class

    - -
    - SynFields -
    - SynIndexerArg -
    - SynInterfaceImpl -
    - SynMatchClause -
    - SynMeasure -

    The unchecked abstract syntax tree of F# unit of measure annotations. -This should probably be merged with the representation of SynType.

    - -
    - SynMemberDefn -
    - SynMemberDefns -
    - SynMemberSig -

    The untyped, unchecked syntax tree for a member signature, used in signature files, abstract member declarations -and member constraints.

    - -
    - SynMemberSigs -
    - SynModuleDecl -
    - SynModuleDecls -
    - SynModuleOrNamespace -
    - SynModuleOrNamespaceKind -
    - SynModuleOrNamespaceSig -
    - SynModuleSigDecl -
    - SynModuleSigDecls -
    - SynPat -
    - SynRationalConst -

    The unchecked abstract syntax tree of F# unit of measure exponents.

    - -
    - SynReturnInfo -

    The syntactic elements associated with the "return" of a function or method. Some of this is -mostly dummy information to make the return element look like an argument, -the important thing is that (a) you can give a return type for the function or method, and -(b) you can associate .NET attributes to return of a function or method and these get stored in .NET metadata.

    - -
    - SynSimplePat -
    - SynSimplePatAlternativeIdInfo -
    - SynSimplePats -

    Represents a simple set of variable bindings a, (a,b) or (a:Type,b:Type) at a lambda, -function definition or other binding point, after the elimination of pattern matching -from the construct, e.g. after changing a "function pat1 -> rule1 | ..." to a -"fun v -> match v with ..."

    - -
    - SynStaticOptimizationConstraint -
    - SynTypar -
    - SynTyparDecl -

    Represents the explicit declaration of a type parameter

    - -
    - SynType -

    The unchecked abstract syntax tree of F# types

    - -
    - SynTypeConstraint -

    The unchecked abstract syntax tree of F# type constraints

    - -
    - SynTypeDefn -
    - SynTypeDefnKind -
    - SynTypeDefnRepr -
    - SynTypeDefnSig -

    The untyped, unchecked syntax tree for a type definition in a signature

    - -
    - SynTypeDefnSigRepr -

    The untyped, unchecked syntax tree for the right-hand-side of a type definition in a signature. -Note: in practice, using a discriminated union to make a distinction between -"simple" types and "object oriented" types is not particularly useful.

    - -
    - SynTypeDefnSimpleRepr -

    The untyped, unchecked syntax tree for the core of a simple type definition, in either signature -or implementation.

    - -
    - SynUnionCase -
    - SynUnionCaseType -

    The untyped, unchecked syntax tree for the right-hand-side of union definition, excluding members, -in either a signature or implementation.

    - -
    - SynUnionCases -
    - SynValData -
    - SynValInfo -

    The argument names and other metadata for a member or function

    - -
    - SynValSig -
    - SynValTyparDecls -

    The names and other metadata for the type parameters for a member or function

    - -
    - SyntaxError -

    The error raised by the parseerrorrich function, which is called by the parser engine -when a syntax error occurs. The first object is the ParseErrorContext which contains a dump of -information about the grammar at the point where the error occurred, e.g. what tokens -are valid to shift next at that point in the grammar. This information is processed in CompileOps.fs.

    - -
    - TyparStaticReq -
    - XmlDoc -
    - XmlDocCollector -

    Used to collect XML documentation during lexing and parsing.

    - -
    - XmlDocStatics -
    - - - - - - - - - - - - - - - - - - - - - - -
    ModuleDescription
    - CustomOperations -
    - FSharpLib -
    - LexbufLocalXmlDocStore -

    XmlDoc F# lexer/parser state, held in the BufferLocalStore for the lexer. -This is the only use of the lexer BufferLocalStore in the codebase.

    - -
    - SynInfo -

    Operations related to the syntactic analysis of arguments of value, function and member definitions and signatures.

    -

    Function and member definitions have strongly syntactically constrained arities. We infer -the arity from the syntax.

    -

    For example, we record the arity for: -StaticProperty --> [1] -- for unit arg -this.InstanceProperty --> [1;1] -- for unit arg -StaticMethod(args) --> map InferSynArgInfoFromSimplePat args -this.InstanceMethod() --> 1 :: map InferSynArgInfoFromSimplePat args -this.InstanceProperty with get(argpat) --> 1 :: [InferSynArgInfoFromSimplePat argpat] -StaticProperty with get(argpat) --> [InferSynArgInfoFromSimplePat argpat] -this.InstanceProperty with get() --> 1 :: [InferSynArgInfoFromSimplePat argpat] -StaticProperty with get() --> [InferSynArgInfoFromSimplePat argpat]

    -

    this.InstanceProperty with set(argpat)(v) --> 1 :: [InferSynArgInfoFromSimplePat argpat; 1] -StaticProperty with set(argpat)(v) --> [InferSynArgInfoFromSimplePat argpat; 1] -this.InstanceProperty with set(v) --> 1 :: [1] -StaticProperty with set(v) --> [1]

    - -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - AbstractMemberFlags k - -
    - Signature: k:MemberKind -> MemberFlags
    -
    -     		- -
    - - - appFunOpt funOpt x - -
    - Signature: funOpt:('?15316 -> '?15316) option -> x:'?15316 -> '?15316
    - Type parameters: '?15316
    -     		- -
    - - - arbExpr (debugStr, range) - -
    - Signature: (debugStr:string * range:range) -> SynExpr
    -
    -     		- -
    - - - arrPathOfLid lid - -
    - Signature: lid:Ident list -> string []
    -
    -     		- -
    - - - ClassCtorMemberFlags - -
    - Signature: MemberFlags
    -
    -     		- -
    - - - composeFunOpt funOpt1 funOpt2 - -
    - Signature: funOpt1:('?15318 -> '?15318) option -> funOpt2:('?15318 -> '?15318) option -> ('?15318 -> '?15318) option
    - Type parameters: '?15318
    -     		- -
    - - - CtorMemberFlags - -
    - Signature: MemberFlags
    -
    -     		- -
    - - - FsiDynamicModulePrefix - -
    - Signature: string
    -
    -     		-

    The prefix of the names used for the fake namespace path added to all dynamic code entries in FSI.EXE

    - - -
    - - - ident (s, r) - -
    - Signature: (s:string * r:range) -> Ident
    -
    -     		- -
    - - - inferredTyparDecls - -
    - Signature: SynValTyparDecls
    -
    -     		- -
    - - - IsControlFlowExpression e - -
    - Signature: e:SynExpr -> bool
    -
    -     		-

    This affects placement of sequence points

    - - -
    - - - LexerIfdefEval lookup _arg1 - -
    - Signature: lookup:(string -> bool) -> _arg1:LexerIfdefExpression -> bool
    -
    -     		- -
    - - - mkAnonField ty - -
    - Signature: ty:SynType -> SynField
    -
    -     		- -
    - - - mkNamedField (ident, ty) - -
    - Signature: (ident:Ident * ty:SynType) -> SynField
    -
    -     		- -
    - - - mkSynApp1 f x1 m - -
    - Signature: f:SynExpr -> x1:SynExpr -> m:range -> SynExpr
    -
    -     		- -
    - - - mkSynApp2 f x1 x2 m - -
    - Signature: f:SynExpr -> x1:SynExpr -> x2:SynExpr -> m:range -> SynExpr
    -
    -     		- -
    - - - mkSynApp3 f x1 x2 x3 m - -
    - Signature: f:SynExpr -> x1:SynExpr -> x2:SynExpr -> x3:SynExpr -> m:range -> SynExpr
    -
    -     		- -
    - - - mkSynApp4 f x1 x2 x3 x4 m - -
    - Signature: f:SynExpr -> x1:SynExpr -> x2:SynExpr -> x3:SynExpr -> x4:SynExpr -> m:range -> SynExpr
    -
    -     		- -
    - - - mkSynApp5 f x1 x2 x3 x4 x5 m - -
    - Signature: f:SynExpr -> x1:SynExpr -> x2:SynExpr -> x3:SynExpr -> x4:SynExpr -> x5:SynExpr -> m:range -> SynExpr
    -
    -     		- -
    - - - mkSynAssign l r - -
    - Signature: l:SynExpr -> r:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynBifix m oper x1 x2 - -
    - Signature: m:range -> oper:string -> x1:SynExpr -> x2:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynBinding (...) - -
    - Signature: (xmlDoc:PreXmlDoc * headPat:SynPat) -> (vis:SynAccess option * isInline:bool * isMutable:bool * mBind:range * spBind:SequencePointInfoForBinding * retInfo:SynReturnInfo option * origRhsExpr:SynExpr * mRhs:range * staticOptimizations:(SynStaticOptimizationConstraint list * SynExpr) list * attrs:SynAttributes * memberFlagsOpt:MemberFlags option) -> SynBinding
    -
    -     		- -
    - - - mkSynBindingRhs (...) - -
    - Signature: staticOptimizations:(SynStaticOptimizationConstraint list * SynExpr) list -> rhsExpr:SynExpr -> mRhs:range -> retInfo:SynReturnInfo option -> SynExpr * SynBindingReturnInfo option
    -
    -     		- -
    - - - mkSynCaseName m n - -
    - Signature: m:range -> n:string -> Ident list
    -
    -     		- -
    - - - mkSynCompGenSimplePatVar id - -
    - Signature: id:Ident -> SynSimplePat
    -
    -     		- -
    - - - mkSynDelay m e - -
    - Signature: m:range -> e:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynDot dotm m l r - -
    - Signature: dotm:range -> m:range -> l:SynExpr -> r:Ident -> SynExpr
    -
    -     		- -
    - - - mkSynDotBrackGet m mDot a b - -
    - Signature: m:range -> mDot:range -> a:SynExpr -> b:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynDotBrackSeqSliceGet (...) - -
    - Signature: m:range -> mDot:range -> arr:SynExpr -> argslist:SynIndexerArg list -> SynExpr
    -
    -     		- -
    - - - mkSynDotBrackSliceGet (...) - -
    - Signature: m:range -> mDot:range -> arr:SynExpr -> sliceArg:SynIndexerArg -> SynExpr
    -
    -     		- -
    - - - mkSynDotMissing dotm m l - -
    - Signature: dotm:range -> m:range -> l:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynDotParenGet lhsm dotm a b - -
    - Signature: lhsm:range -> dotm:range -> a:SynExpr -> b:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynDotParenSet m a b c - -
    - Signature: m:range -> a:SynExpr -> b:SynExpr -> c:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynFunMatchLambdas (...) - -
    - Signature: synArgNameGenerator:SynArgNameGenerator -> isMember:bool -> wholem:range -> ps:SynPat list -> e:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynId m s - -
    - Signature: m:range -> s:string -> Ident
    -
    -     		- -
    - - - mkSynIdGet m n - -
    - Signature: m:range -> n:string -> SynExpr
    -
    -     		- -
    - - - mkSynIdGetWithAlt m id altInfo - -
    - Signature: m:range -> id:Ident -> altInfo:SynSimplePatAlternativeIdInfo ref option -> SynExpr
    -
    -     		- -
    - - - mkSynInfix opm l oper r - -
    - Signature: opm:range -> l:SynExpr -> oper:string -> r:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynLidGet m path n - -
    - Signature: m:range -> path:string list -> n:string -> SynExpr
    -
    -     		- -
    - - - mkSynOperator opm oper - -
    - Signature: opm:range -> oper:string -> SynExpr
    -
    -     		- -
    - - - mkSynPatMaybeVar lidwd vis m - -
    - Signature: lidwd:LongIdentWithDots -> vis:SynAccess option -> m:range -> SynPat
    -
    -     		- -
    - - - mkSynPatVar vis id - -
    - Signature: vis:SynAccess option -> id:Ident -> SynPat
    -
    -     		- -
    - - - mkSynPrefix opm m oper x - -
    - Signature: opm:range -> m:range -> oper:string -> x:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynPrefixPrim opm m oper x - -
    - Signature: opm:range -> m:range -> oper:string -> x:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynQMarkSet m a b c - -
    - Signature: m:range -> a:SynExpr -> b:SynExpr -> c:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynSimplePatVar isOpt id - -
    - Signature: isOpt:bool -> id:Ident -> SynSimplePat
    -
    -     		- -
    - - - mkSynThisPatVar id - -
    - Signature: id:Ident -> SynPat
    -
    -     		- -
    - - - mkSynTrifix m oper x1 x2 x3 - -
    - Signature: m:range -> oper:string -> x1:SynExpr -> x2:SynExpr -> x3:SynExpr -> SynExpr
    -
    -     		- -
    - - - mkSynUnit m - -
    - Signature: m:range -> SynExpr
    -
    -     		- -
    - - - mkSynUnitPat m - -
    - Signature: m:range -> SynPat
    -
    -     		- -
    - - - noInferredTypars - -
    - Signature: SynValTyparDecls
    -
    -     		- -
    - - - NonVirtualMemberFlags k - -
    - Signature: k:MemberKind -> MemberFlags
    -
    -     		- -
    - - - opNameParenGet - -
    - Signature: string
    -
    -     		- -
    - - - opNameQMark - -
    - Signature: string
    -
    -     		- -
    - - - OverrideMemberFlags k - -
    - Signature: k:MemberKind -> MemberFlags
    -
    -     		- -
    - - - ParseAssemblyCodeInstructions s m - -
    - Signature: s:string -> m:range -> ILInstr array
    -
    -     		-

    Helper for parsing the inline IL fragments.

    - - -
    - - - ParseAssemblyCodeType s m - -
    - Signature: s:string -> m:range -> ILType
    -
    -     		-

    Helper for parsing the inline IL fragments.

    - - -
    - - - pathOfLid lid - -
    - Signature: lid:Ident list -> string list
    -
    -     		- -
    - - - pathToSynLid m p - -
    - Signature: m:range -> p:string list -> Ident list
    -
    -     		- -
    - - - PushCurriedPatternsToExpr (...) - -
    - Signature: synArgNameGenerator:SynArgNameGenerator -> wholem:range -> isMember:bool -> pats:SynPat list -> rhs:SynExpr -> SynSimplePats list * SynExpr
    -
    -     		-

    "fun (UnionCase x) (UnionCase y) -> body" -==> -"fun tmp1 tmp2 -> -let (UnionCase x) = tmp1 in -let (UnionCase y) = tmp2 in -body"

    - - -
    - - - PushPatternToExpr (...) - -
    - Signature: synArgNameGenerator:SynArgNameGenerator -> isMember:bool -> pat:SynPat -> rhs:SynExpr -> SynSimplePats * SynExpr
    -
    -     		- -
    - - - rangeOfLid lid - -
    - Signature: lid:Ident list -> range
    -
    -     		- -
    - - - SimplePatOfPat synArgNameGenerator p - -
    - Signature: synArgNameGenerator:SynArgNameGenerator -> p:SynPat -> SynSimplePat * (SynExpr -> SynExpr) option
    -
    -     		-

    Push non-simple parts of a patten match over onto the r.h.s. of a lambda. -Return a simple pattern and a function to build a match on the r.h.s. if the pattern is complex

    - - -
    - - - SimplePatsOfPat synArgNameGenerator p - -
    - Signature: synArgNameGenerator:SynArgNameGenerator -> p:SynPat -> SynSimplePats * (SynExpr -> SynExpr) option
    -
    -     		- -
    - - - StaticMemberFlags k - -
    - Signature: k:MemberKind -> MemberFlags
    -
    -     		- -
    - - - synExprContainsError inpExpr - -
    - Signature: inpExpr:SynExpr -> bool
    -
    -     		- -
    - - - textOfId id - -
    - Signature: id:Ident -> string
    -
    -     		- -
    - - - textOfLid lid - -
    - Signature: lid:Ident list -> string
    -
    -     		- -
    - - - textOfPath path - -
    - Signature: path:seq<string> -> string
    -
    -     		- -
    -

    Active patterns

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Active patternDescription
    - - - ( |LongOrSingleIdent|_| ) inp - -
    - Signature: inp:SynExpr -> (bool * LongIdentWithDots * SynSimplePatAlternativeIdInfo ref option * range) option
    -
    -     		-

    Match a long identifier, including the case for single identifiers which gets a more optimized node in the syntax tree.

    - - -

    CompiledName: |LongOrSingleIdent|_|

    -
    - - - ( |SingleIdent|_| ) inp - -
    - Signature: inp:SynExpr -> Ident option
    -
    -     		- -

    CompiledName: |SingleIdent|_|

    -
    - - - ( |SynExprErrorSkip| ) p - -
    - Signature: p:SynExpr -> SynExpr
    -
    -     		- -

    CompiledName: |SynExprErrorSkip|

    -
    - - - ( |SynExprParen|_| ) e - -
    - Signature: e:SynExpr -> (SynExpr * range * range option * range) option
    -
    -     		- -

    CompiledName: |SynExprParen|_|

    -
    - - - ( |SynPatErrorSkip| ) p - -
    - Signature: p:SynPat -> SynPat
    -
    -     		- -

    CompiledName: |SynPatErrorSkip|

    -
    - - - ( |SynPatForConstructorDecl|_| ) x - -
    - Signature: x:SynPat -> SynPat option
    -
    -     		-

    Extract the argument for patterns corresponding to the declaration of 'new ... = ...'

    - - -

    CompiledName: |SynPatForConstructorDecl|_|

    -
    - - - ( |SynPatForNullaryArgs|_| ) x - -
    - Signature: x:SynPat -> unit option
    -
    -     		-

    Recognize the '()' in 'new()'

    - - -

    CompiledName: |SynPatForNullaryArgs|_|

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-buildphase.html b/docs/reference/fsharp-compiler-errorlogger-buildphase.html deleted file mode 100644 index 82fba4b5da..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-buildphase.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - BuildPhase - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    BuildPhase

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -

    Closed enumeration of build phases.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - CodeGen - -
    - Signature:
    -
    -     		- -
    - - - Compile - -
    - Signature:
    -
    -     		- -
    - - - DefaultPhase - -
    - Signature:
    -
    -     		- -
    - - - IlGen - -
    - Signature:
    -
    -     		- -
    - - - IlxGen - -
    - Signature:
    -
    -     		- -
    - - - Interactive - -
    - Signature:
    -
    -     		- -
    - - - Optimize - -
    - Signature:
    -
    -     		- -
    - - - Output - -
    - Signature:
    -
    -     		- -
    - - - Parameter - -
    - Signature:
    -
    -     		- -
    - - - Parse - -
    - Signature:
    -
    -     		- -
    - - - TypeCheck - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-buildphasesubcategory.html b/docs/reference/fsharp-compiler-errorlogger-buildphasesubcategory.html deleted file mode 100644 index 6e0d03c9ab..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-buildphasesubcategory.html +++ /dev/null @@ -1,276 +0,0 @@ - - - - - BuildPhaseSubcategory - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    BuildPhaseSubcategory

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -

    Literal build phase subcategory strings.

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - CodeGen - -
    - Signature: string
    -
    -     		- -
    - - - Compile - -
    - Signature: string
    -
    -     		- -
    - - - DefaultPhase - -
    - Signature: string
    -
    -     		- -
    - - - IlGen - -
    - Signature: string
    -
    -     		- -
    - - - IlxGen - -
    - Signature: string
    -
    -     		- -
    - - - Interactive - -
    - Signature: string
    -
    -     		- -
    - - - Internal - -
    - Signature: string
    -
    -     		- -
    - - - Optimize - -
    - Signature: string
    -
    -     		- -
    - - - Output - -
    - Signature: string
    -
    -     		- -
    - - - Parameter - -
    - Signature: string
    -
    -     		- -
    - - - Parse - -
    - Signature: string
    -
    -     		- -
    - - - TypeCheck - -
    - Signature: string
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-capturingerrorlogger.html b/docs/reference/fsharp-compiler-errorlogger-capturingerrorlogger.html deleted file mode 100644 index f207b683de..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-capturingerrorlogger.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - CapturingErrorLogger - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CapturingErrorLogger

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(nm) - -
    - Signature: nm:string -> CapturingErrorLogger
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CommitDelayedDiagnostics(errorLogger) - -
    - Signature: errorLogger:ErrorLogger -> unit
    -
    -     		- -
    - - - Diagnostics - -
    - Signature: (PhasedDiagnostic * bool) list
    -
    -     		- -

    CompiledName: get_Diagnostics

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-deprecated.html b/docs/reference/fsharp-compiler-errorlogger-deprecated.html deleted file mode 100644 index 03a75a6209..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-deprecated.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - Deprecated - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Deprecated

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: string
    -
    -     		- -
    - - - Data1 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-error.html b/docs/reference/fsharp-compiler-errorlogger-error.html deleted file mode 100644 index 855bf635f6..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-error.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - Error - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Error

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: int * string
    -
    -     		- -
    - - - Data1 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-errorlogger.html b/docs/reference/fsharp-compiler-errorlogger-errorlogger.html deleted file mode 100644 index 28dfd2e232..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-errorlogger.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - ErrorLogger - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ErrorLogger

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(nameForDebugging) - -
    - Signature: nameForDebugging:string -> ErrorLogger
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DebugDisplay() - -
    - Signature: unit -> string
    -
    -     		- -
    - - - DiagnosticSink(phasedError, isError) - -
    - Signature: (phasedError:PhasedDiagnostic * isError:bool) -> unit
    - Modifiers: abstract
    -
    -     		- -
    - - - ErrorCount - -
    - Signature: int
    - Modifiers: abstract
    -
    -     		- -

    CompiledName: get_ErrorCount

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-errorloggerextensions.html b/docs/reference/fsharp-compiler-errorlogger-errorloggerextensions.html deleted file mode 100644 index e3023337ee..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-errorloggerextensions.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - ErrorLoggerExtensions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ErrorLoggerExtensions

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - PreserveStackTrace exn - -
    - Signature: exn:'a -> unit
    - Type parameters: 'a
    -     		-

    Instruct the exception not to reset itself when thrown again.

    - - -
    - - - ReraiseIfWatsonable exn - -
    - Signature: exn:exn -> unit
    -
    -     		-

    Reraise an exception if it is one we want to report to Watson.

    - - -
    -

    Type extensions

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Type extensionDescription
    - - - Error(exn) - -
    - Signature: exn:exn -> 'a
    - Type parameters: 'a
    -     		- -

    CompiledName: ErrorLogger.Error

    -
    - - - ErrorR(exn) - -
    - Signature: exn:exn -> unit
    -
    -     		- -

    CompiledName: ErrorLogger.ErrorR

    -
    - - - ErrorRecovery(exn m) - -
    - Signature: exn:exn -> m:range -> unit
    -
    -     		- -

    CompiledName: ErrorLogger.ErrorRecovery

    -
    - - - ErrorRecoveryNoRange(exn) - -
    - Signature: exn:exn -> unit
    -
    -     		- -

    CompiledName: ErrorLogger.ErrorRecoveryNoRange

    -
    - - - SimulateError(ph) - -
    - Signature: ph:PhasedDiagnostic -> '?19329
    - Type parameters: '?19329
    -     		- -

    CompiledName: ErrorLogger.SimulateError

    -
    - - - StopProcessingRecovery(exn m) - -
    - Signature: exn:exn -> m:range -> unit
    -
    -     		- -

    CompiledName: ErrorLogger.StopProcessingRecovery

    -
    - - - Warning(exn) - -
    - Signature: exn:exn -> unit
    -
    -     		- -

    CompiledName: ErrorLogger.Warning

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-errorstyle.html b/docs/reference/fsharp-compiler-errorlogger-errorstyle.html deleted file mode 100644 index c47f7bb75b..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-errorstyle.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - ErrorStyle - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ErrorStyle

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -

    Represents the style being used to format errors

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - DefaultErrors - -
    - Signature:
    -
    -     		- -
    - - - EmacsErrors - -
    - Signature:
    -
    -     		- -
    - - - GccErrors - -
    - Signature:
    -
    -     		- -
    - - - TestErrors - -
    - Signature:
    -
    -     		- -
    - - - VSErrors - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-errorwithsuggestions.html b/docs/reference/fsharp-compiler-errorlogger-errorwithsuggestions.html deleted file mode 100644 index fbddd3f096..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-errorwithsuggestions.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ErrorWithSuggestions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ErrorWithSuggestions

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: int * string
    -
    -     		- -
    - - - Data1 - -
    - Signature: range
    -
    -     		- -
    - - - Data2 - -
    - Signature: string
    -
    -     		- -
    - - - Data3 - -
    - Signature: Suggestions
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-exiter.html b/docs/reference/fsharp-compiler-errorlogger-exiter.html deleted file mode 100644 index 19472c32b9..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-exiter.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - Exiter - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Exiter

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Exit(arg1) - -
    - Signature: int -> 'T
    - Modifiers: abstract
    - Type parameters: 'T
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-experimental.html b/docs/reference/fsharp-compiler-errorlogger-experimental.html deleted file mode 100644 index 793b4f5191..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-experimental.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - Experimental - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Experimental

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: string
    -
    -     		- -
    - - - Data1 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-fsharperrorseverityoptions.html b/docs/reference/fsharp-compiler-errorlogger-fsharperrorseverityoptions.html deleted file mode 100644 index b949a2a780..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-fsharperrorseverityoptions.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - FSharpErrorSeverityOptions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpErrorSeverityOptions

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - GlobalWarnAsError - -
    - Signature: bool
    -
    -     		- -
    - - - WarnAsError - -
    - Signature: int list
    -
    -     		- -
    - - - WarnAsWarn - -
    - Signature: int list
    -
    -     		- -
    - - - WarnLevel - -
    - Signature: int
    -
    -     		- -
    - - - WarnOff - -
    - Signature: int list
    -
    -     		- -
    - - - WarnOn - -
    - Signature: int list
    -
    -     		- -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Default - -
    - Signature: FSharpErrorSeverityOptions
    -
    -     		- -

    CompiledName: get_Default

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-imperativeoperationresult.html b/docs/reference/fsharp-compiler-errorlogger-imperativeoperationresult.html deleted file mode 100644 index 0ae690280b..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-imperativeoperationresult.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - ImperativeOperationResult - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ImperativeOperationResult

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-internalerror.html b/docs/reference/fsharp-compiler-errorlogger-internalerror.html deleted file mode 100644 index 83eb2a3b83..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-internalerror.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - InternalError - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    InternalError

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data1 - -
    - Signature: range
    -
    -     		- -
    - - - msg - -
    - Signature: string
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-libraryuseonly.html b/docs/reference/fsharp-compiler-errorlogger-libraryuseonly.html deleted file mode 100644 index f822928e09..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-libraryuseonly.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - LibraryUseOnly - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LibraryUseOnly

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-numberederror.html b/docs/reference/fsharp-compiler-errorlogger-numberederror.html deleted file mode 100644 index f4f3e33deb..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-numberederror.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - NumberedError - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NumberedError

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: int * string
    -
    -     		- -
    - - - Data1 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-operationresult-1.html b/docs/reference/fsharp-compiler-errorlogger-operationresult-1.html deleted file mode 100644 index 3680082bcc..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-operationresult-1.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - OperationResult<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    OperationResult<'T>

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ErrorResult(exn list,exn) - -
    - Signature: exn list * exn
    -
    -     		- -
    - - - OkResult(exn list,'T) - -
    - Signature: exn list * 'T
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-operationresult.html b/docs/reference/fsharp-compiler-errorlogger-operationresult.html deleted file mode 100644 index 2cd6ed87db..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-operationresult.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - OperationResult - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    OperationResult

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - ignore(res) - -
    - Signature: res:OperationResult<'a> -> OperationResult<unit>
    - Type parameters: 'a
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-phaseddiagnostic.html b/docs/reference/fsharp-compiler-errorlogger-phaseddiagnostic.html deleted file mode 100644 index f670ffe8b6..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-phaseddiagnostic.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - PhasedDiagnostic - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PhasedDiagnostic

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Exception - -
    - Signature: exn
    -
    -     		- -
    - - - Phase - -
    - Signature: BuildPhase
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DebugDisplay() - -
    - Signature: unit -> string
    -
    -     		- -
    - - - IsPhaseInCompile() - -
    - Signature: unit -> bool
    -
    -     		-

    the language service knows about.

    - - -
    - - - Subcategory() - -
    - Signature: unit -> string
    -
    -     		-

    This is the textual subcategory to display in error and warning messages (shows only under --vserrors):

    - - - -
    1: 
-
    file1.fs(72): subcategory warning FS0072: This is a warning message
-
    - - -
    -

    Static members

    - - - - - - - - - - - - - - -
    Static memberDescription
    - - - Create(exn, phase) - -
    - Signature: (exn:exn * phase:BuildPhase) -> PhasedDiagnostic
    -
    -     		-

    Construct a phased error

    - - -
    - - - IsSubcategoryOfCompile(subcategory) - -
    - Signature: subcategory:string -> bool
    -
    -     		-

    Return true if the textual phase given is from the compile part of the build process. -This set needs to be equal to the set of subcategories that the language service can produce.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-possibleunverifiablecode.html b/docs/reference/fsharp-compiler-errorlogger-possibleunverifiablecode.html deleted file mode 100644 index a06e0f725f..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-possibleunverifiablecode.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - PossibleUnverifiableCode - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PossibleUnverifiableCode

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-reportederror.html b/docs/reference/fsharp-compiler-errorlogger-reportederror.html deleted file mode 100644 index 28b22209ab..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-reportederror.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - ReportedError - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ReportedError

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -

    Thrown when immediate, local error recovery is not possible. This indicates -we've reported an error but need to make a non-local transfer of control. -Error recovery may catch this and continue (see 'errorRecovery')

    -

    The exception that caused the report is carried as data because in some -situations (LazyWithContext) we may need to re-report the original error -when a lazy thunk is re-evaluated.

    - -
    -

    Record Fields

    - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: exn option
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-stopprocessingexn.html b/docs/reference/fsharp-compiler-errorlogger-stopprocessingexn.html deleted file mode 100644 index ba58e4fc91..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-stopprocessingexn.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - StopProcessingExn - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    StopProcessingExn

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -

    Thrown when we stop processing the F# Interactive entry or #load.

    - -
    -

    Record Fields

    - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: exn option
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-suggestions.html b/docs/reference/fsharp-compiler-errorlogger-suggestions.html deleted file mode 100644 index b2fa97e16d..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-suggestions.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - Suggestions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Suggestions

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-trackerrorsbuilder.html b/docs/reference/fsharp-compiler-errorlogger-trackerrorsbuilder.html deleted file mode 100644 index ba189c02c3..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-trackerrorsbuilder.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - TrackErrorsBuilder - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    TrackErrorsBuilder

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> TrackErrorsBuilder
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Bind(res, k) - -
    - Signature: (res:OperationResult<'a> * k:('a -> OperationResult<'b>)) -> OperationResult<'b>
    - Type parameters: 'a, 'b
    -     		- -
    - - - Combine(expr1, expr2) - -
    - Signature: (expr1:OperationResult<'h> * expr2:('h -> OperationResult<'i>)) -> OperationResult<'i>
    - Type parameters: 'h, 'i
    -     		- -
    - - - Delay(fn) - -
    - Signature: (fn:(unit -> 'a)) -> unit -> 'a
    - Type parameters: 'a
    -     		- -
    - - - For(seq, k) - -
    - Signature: (seq:'a list * k:('a -> OperationResult<unit>)) -> OperationResult<unit>
    - Type parameters: 'a
    -     		- -
    - - - Return(res) - -
    - Signature: res:'h -> OperationResult<'h>
    - Type parameters: 'h
    -     		- -
    - - - ReturnFrom(res) - -
    - Signature: res:'a -> 'a
    - Type parameters: 'a
    -     		- -
    - - - Run(fn) - -
    - Signature: (fn:(unit -> 'a)) -> 'a
    - Type parameters: 'a
    -     		- -
    - - - While(gd, k) - -
    - Signature: (gd:(unit -> bool) * k:(unit -> OperationResult<unit>)) -> OperationResult<unit>
    -
    -     		- -
    - - - Zero() - -
    - Signature: unit -> OperationResult<unit>
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreference.html b/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreference.html deleted file mode 100644 index 55eae73e6b..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreference.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - UnresolvedPathReference - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UnresolvedPathReference

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: string
    -
    -     		- -
    - - - Data1 - -
    - Signature: string
    -
    -     		- -
    - - - Data2 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreferencenorange.html b/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreferencenorange.html deleted file mode 100644 index cc0271c5e6..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreferencenorange.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - UnresolvedPathReferenceNoRange - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UnresolvedPathReferenceNoRange

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: string
    -
    -     		- -
    - - - Data1 - -
    - Signature: string
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-unresolvedreferenceerror.html b/docs/reference/fsharp-compiler-errorlogger-unresolvedreferenceerror.html deleted file mode 100644 index 87d7bef297..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-unresolvedreferenceerror.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - UnresolvedReferenceError - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UnresolvedReferenceError

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: string
    -
    -     		- -
    - - - Data1 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-unresolvedreferencenorange.html b/docs/reference/fsharp-compiler-errorlogger-unresolvedreferencenorange.html deleted file mode 100644 index b83c81955c..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-unresolvedreferencenorange.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - UnresolvedReferenceNoRange - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UnresolvedReferenceNoRange

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: string
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-usercompilermessage.html b/docs/reference/fsharp-compiler-errorlogger-usercompilermessage.html deleted file mode 100644 index 46d4b7e549..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-usercompilermessage.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - UserCompilerMessage - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UserCompilerMessage

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: string
    -
    -     		- -
    - - - Data1 - -
    - Signature: int
    -
    -     		- -
    - - - Data2 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger-wrappederror.html b/docs/reference/fsharp-compiler-errorlogger-wrappederror.html deleted file mode 100644 index 447cb0ce2d..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger-wrappederror.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - WrappedError - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    WrappedError

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ErrorLogger -

    -
    -

    Thrown when we want to add some range information to a .NET exception

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: exn
    -
    -     		- -
    - - - Data1 - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-errorlogger.html b/docs/reference/fsharp-compiler-errorlogger.html deleted file mode 100644 index a06e33d777..0000000000 --- a/docs/reference/fsharp-compiler-errorlogger.html +++ /dev/null @@ -1,1142 +0,0 @@ - - - - - ErrorLogger - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ErrorLogger

    -

    - Namespace: FSharp.Compiler
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - BuildPhase -

    Closed enumeration of build phases.

    - -
    - CapturingErrorLogger -
    - Deprecated -
    - Error -
    - ErrorLogger -
    - ErrorStyle -

    Represents the style being used to format errors

    - -
    - ErrorWithSuggestions -
    - Exiter -
    - Experimental -
    - FSharpErrorSeverityOptions -
    - ImperativeOperationResult -
    - InternalError -
    - LibraryUseOnly -
    - NumberedError -
    - OperationResult<'T> -
    - PhasedDiagnostic -
    - PossibleUnverifiableCode -
    - ReportedError -

    Thrown when immediate, local error recovery is not possible. This indicates -we've reported an error but need to make a non-local transfer of control. -Error recovery may catch this and continue (see 'errorRecovery')

    -

    The exception that caused the report is carried as data because in some -situations (LazyWithContext) we may need to re-report the original error -when a lazy thunk is re-evaluated.

    - -
    - StopProcessingExn -

    Thrown when we stop processing the F# Interactive entry or #load.

    - -
    - Suggestions -
    - TrackErrorsBuilder -
    - UnresolvedPathReference -
    - UnresolvedPathReferenceNoRange -
    - UnresolvedReferenceError -
    - UnresolvedReferenceNoRange -
    - UserCompilerMessage -
    - WrappedError -

    Thrown when we want to add some range information to a .NET exception

    - -
    - - - - - - - - - - - - - - - - - - -
    ModuleDescription
    - BuildPhaseSubcategory -

    Literal build phase subcategory strings.

    - -
    - ErrorLoggerExtensions -
    - OperationResult -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - ( ++ ) res f - -
    - Signature: res:OperationResult<'a> -> f:('a -> OperationResult<'b>) -> OperationResult<'b>
    - Type parameters: 'a, 'b
    -     		-

    The bind in the monad. Stop on first error. Accumulate warnings and continue.

    - - -

    CompiledName: op_PlusPlus

    -
    - - - AssertFalseErrorLogger - -
    - Signature: ErrorLogger
    -
    -     		- -
    - - - AtLeastOneD f l - -
    - Signature: f:('h -> OperationResult<bool>) -> l:'h list -> OperationResult<bool>
    - Type parameters: 'h
    -     		- -
    - - - AttachRange m exn - -
    - Signature: m:range -> exn:exn -> exn
    -
    -     		- -
    - - - CheckNoErrorsAndGetWarnings res - -
    - Signature: res:OperationResult<'c> -> exn list option
    - Type parameters: 'c
    -     		- -
    - - - CommitOperationResult res - -
    - Signature: res:OperationResult<'a> -> 'a
    - Type parameters: 'a
    -     		- -
    - - - CompleteD - -
    - Signature: OperationResult<unit>
    -
    -     		- -
    - - - conditionallySuppressErrorReporting (...) - -
    - Signature: cond:bool -> f:(unit -> 'a2) -> 'a2
    - Type parameters: 'a2
    -     		- -
    - - - deprecatedOperator m - -
    - Signature: m:range -> unit
    -
    -     		- -
    - - - deprecatedWithError s m - -
    - Signature: s:string -> m:range -> unit
    -
    -     		- -
    - - - diagnosticSink (phasedError, isError) - -
    - Signature: (phasedError:PhasedDiagnostic * isError:bool) -> unit
    -
    -     		- -
    - - - DiscardErrorsLogger - -
    - Signature: ErrorLogger
    -
    -     		- -
    - - - error exn - -
    - Signature: exn:exn -> 'a
    - Type parameters: 'a
    -     		-

    Raises a special exception and returns 'T - can be caught later at an errorRecovery point.

    - - -
    - - - ErrorD err - -
    - Signature: err:exn -> OperationResult<'a>
    - Type parameters: 'a
    -     		- -
    - - - errorR exn - -
    - Signature: exn:exn -> unit
    -
    -     		-

    Raises an exception with error recovery and returns unit.

    - - -
    - - - errorRecovery exn m - -
    - Signature: exn:exn -> m:range -> unit
    -
    -     		- -
    - - - errorRecoveryNoRange exn - -
    - Signature: exn:exn -> unit
    -
    -     		- -
    - - - errorSink pe - -
    - Signature: pe:PhasedDiagnostic -> unit
    -
    -     		- -
    - - - findOriginalException err - -
    - Signature: err:exn -> exn
    -
    -     		- -
    - - - Iterate2D f xs ys - -
    - Signature: f:('h -> 'i -> OperationResult<unit>) -> xs:'h list -> ys:'i list -> OperationResult<unit>
    - Type parameters: 'h, 'i
    -     		-

    Stop on first error. Accumulate warnings and continue.

    - - -
    - - - IterateD f xs - -
    - Signature: f:('h -> OperationResult<unit>) -> xs:'h list -> OperationResult<unit>
    - Type parameters: 'h
    -     		-

    Stop on first error. Accumulate warnings and continue.

    - - -
    - - - IterateIdxD f xs - -
    - Signature: f:(int -> 'h -> OperationResult<unit>) -> xs:'h list -> OperationResult<unit>
    - Type parameters: 'h
    -     		-

    Stop on first error. Report index

    - - -
    - - - libraryOnlyError m - -
    - Signature: m:range -> unit
    -
    -     		- -
    - - - libraryOnlyWarning m - -
    - Signature: m:range -> unit
    -
    -     		- -
    - - - MapD f xs - -
    - Signature: f:('?19234 -> OperationResult<'?19235>) -> xs:'?19234 list -> OperationResult<'?19235 list>
    - Type parameters: '?19234, '?19235
    -     		- -
    - - - mlCompatWarning s m - -
    - Signature: s:String -> m:range -> unit
    -
    -     		- -
    - - - NewlineifyErrorString message - -
    - Signature: message:string -> string
    -
    -     		- -
    - - - NormalizeErrorString text - -
    - Signature: text:string -> string
    -
    -     		-

    fixes given string by replacing all control chars with spaces. -NOTE: newlines are recognized and replaced with stringThatIsAProxyForANewlineInFlatErrors (ASCII 29, the 'group separator'), -which is decoded by the IDE with 'NewlineifyErrorString' back into newlines, so that multi-line errors can be displayed in QuickInfo

    - - -
    - - - NoSuggestions () - -
    - Signature: unit -> HashSet<string>
    -
    -     		- -
    - - - OptionD f xs - -
    - Signature: f:('?19257 -> OperationResult<unit>) -> xs:'?19257 option -> OperationResult<unit>
    - Type parameters: '?19257
    -     		-

    Stop on first error. Accumulate warnings and continue.

    - - -
    - - - protectAssemblyExploration dflt f - -
    - Signature: dflt:'a -> f:(unit -> 'a) -> 'a
    - Type parameters: 'a
    -     		- -
    - - - protectAssemblyExplorationF dflt f - -
    - Signature: dflt:(string * string -> 'b) -> f:(unit -> 'b) -> 'b
    - Type parameters: 'b
    -     		- -
    - - - protectAssemblyExplorationNoReraise (...) - -
    - Signature: dflt1:'a -> dflt2:'a -> f:(unit -> 'a) -> 'a
    - Type parameters: 'a
    -     		- -
    - - - PushErrorLoggerPhaseUntilUnwind (...) - -
    - Signature: errorLoggerTransformer:(ErrorLogger -> 'a) -> IDisposable
    - Type parameters: 'a
    -     		-

    NOTE: The change will be undone when the returned "unwind" object disposes

    - - -
    - - - PushThreadBuildPhaseUntilUnwind phase - -
    - Signature: phase:BuildPhase -> IDisposable
    -
    -     		-

    NOTE: The change will be undone when the returned "unwind" object disposes

    - - -
    - - - QuitProcessExiter - -
    - Signature: Exiter
    -
    -     		- -
    - - - RaiseOperationResult res - -
    - Signature: res:OperationResult<unit> -> unit
    -
    -     		- -
    - - - RepeatWhileD ndeep body - -
    - Signature: ndeep:int -> body:(int -> OperationResult<bool>) -> OperationResult<unit>
    -
    -     		- -
    - - - report f - -
    - Signature: f:(unit -> '?19203) -> '?19203
    - Type parameters: '?19203
    -     		- -
    - - - reportLibraryOnlyFeatures - -
    - Signature: bool
    -
    -     		- -
    - - - ReportWarnings warns - -
    - Signature: warns:'b list -> unit
    - Type parameters: 'b
    -     		- -
    - - - ResultD x - -
    - Signature: x:'h -> OperationResult<'h>
    - Type parameters: 'h
    -     		- -
    - - - SetThreadBuildPhaseNoUnwind phase - -
    - Signature: phase:BuildPhase -> unit
    -
    -     		- -
    - - - SetThreadErrorLoggerNoUnwind errorLogger - -
    - Signature: errorLogger:ErrorLogger -> unit
    -
    -     		- -
    - - - simulateError p - -
    - Signature: p:PhasedDiagnostic -> 'a
    - Type parameters: 'a
    -     		-

    Simulates an error. For test purposes only.

    - - -
    - - - StopProcessing - -
    - Signature: exn
    - Type parameters: 'T
    -     		- -
    - - - stopProcessingRecovery exn m - -
    - Signature: exn:exn -> m:range -> unit
    -
    -     		- -
    - - - stringThatIsAProxyForANewlineInFlatErrors (...) - -
    - Signature: String
    -
    -     		- -
    - - - suppressErrorReporting f - -
    - Signature: f:(unit -> 'a2) -> 'a2
    - Type parameters: 'a2
    -     		- -
    - - - trackErrors - -
    - Signature: TrackErrorsBuilder
    -
    -     		- -
    - - - TryD f g - -
    - Signature: f:(unit -> OperationResult<'h>) -> g:(exn -> OperationResult<'h>) -> OperationResult<'h>
    - Type parameters: 'h
    -     		-

    Keep the warnings, propagate the error to the exception continuation.

    - - -
    - - - WarnD err - -
    - Signature: err:exn -> OperationResult<unit>
    -
    -     		- -
    - - - warning exn - -
    - Signature: exn:exn -> unit
    -
    -     		-

    Raises a warning with error recovery and returns unit.

    - - -
    - - - warnSink pe - -
    - Signature: pe:PhasedDiagnostic -> unit
    -
    -     		- -
    - - - WhileD gd body - -
    - Signature: gd:(unit -> bool) -> body:(unit -> OperationResult<unit>) -> OperationResult<unit>
    -
    -     		- -
    -

    Active patterns

    - - - - - - - - - - -
    Active patternDescription
    - - - ( |StopProcessing|_| ) exn - -
    - Signature: exn:exn -> unit option
    -
    -     		- -

    CompiledName: |StopProcessing|_|

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell-compilerinputstream.html b/docs/reference/fsharp-compiler-interactive-shell-compilerinputstream.html deleted file mode 100644 index e425ae8bf6..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell-compilerinputstream.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - CompilerInputStream - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompilerInputStream

    -

    - Namespace: FSharp.Compiler.Interactive
    - Parent Module: Shell -

    -
    -

    Defines a read-only input stream used to feed content to the hosted F# Interactive dynamic compiler.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> CompilerInputStream
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Add(str) - -
    - Signature: str:string -> unit
    -
    -     		-

    Feeds content into the stream.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell-compileroutputstream.html b/docs/reference/fsharp-compiler-interactive-shell-compileroutputstream.html deleted file mode 100644 index 57889aeb29..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell-compileroutputstream.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - CompilerOutputStream - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompilerOutputStream

    -

    - Namespace: FSharp.Compiler.Interactive
    - Parent Module: Shell -

    -
    -

    Defines a write-only stream used to capture output of the hosted F# Interactive dynamic compiler.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> CompilerOutputStream
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Read() - -
    - Signature: unit -> string
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell-evaluationeventargs.html b/docs/reference/fsharp-compiler-interactive-shell-evaluationeventargs.html deleted file mode 100644 index c8f898b9b5..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell-evaluationeventargs.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - EvaluationEventArgs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    EvaluationEventArgs

    -

    - Namespace: FSharp.Compiler.Interactive
    - Parent Module: Shell -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - FsiValue - -
    - Signature: FsiValue option
    -
    -     		-

    The value of the symbol defined, if any

    - - -

    CompiledName: get_FsiValue

    -
    - - - ImplementationDeclaration - -
    - Signature: FSharpImplementationFileDeclaration
    -
    -     		-

    The details of the expression defined

    - - -

    CompiledName: get_ImplementationDeclaration

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    The display name of the symbol defined

    - - -

    CompiledName: get_Name

    -
    - - - Symbol - -
    - Signature: FSharpSymbol
    -
    -     		-

    The symbol defined

    - - -

    CompiledName: get_Symbol

    -
    - - - SymbolUse - -
    - Signature: FSharpSymbolUse
    -
    -     		-

    The FSharpSymbolUse for the symbol defined

    - - -

    CompiledName: get_SymbolUse

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsession.html b/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsession.html deleted file mode 100644 index 07b7ea2990..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsession.html +++ /dev/null @@ -1,530 +0,0 @@ - - - - - FsiEvaluationSession - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FsiEvaluationSession

    -

    - Namespace: FSharp.Compiler.Interactive
    - Parent Module: Shell -

    -
    -

    Represents an F# Interactive evaluation session.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CurrentPartialAssemblySignature - -
    - Signature: FSharpAssemblySignature
    -
    -     		-

    Get a handle to the resolved view of the current signature of the incrementally generated assembly.

    - - -

    CompiledName: get_CurrentPartialAssemblySignature

    -
    - - - DynamicAssembly - -
    - Signature: Assembly
    -
    -     		-

    Get a handle to the dynamicly generated assembly

    - - -

    CompiledName: get_DynamicAssembly

    -
    - - - EvalExpression(code) - -
    - Signature: code:string -> FsiValue option
    -
    -     		-

    Execute the code as if it had been entered as one or more interactions, with an -implicit termination at the end of the input. Stop on first error, discarding the rest -of the input. Errors are sent to the output writer. Parsing is performed on the current thread, and execution is performed -sycnhronously on the 'main' thread.

    -

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered -by input from 'stdin'.

    - - -
    - - - EvalExpressionNonThrowing(code) - -
    - Signature: code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
    -
    -     		-

    Execute the code as if it had been entered as one or more interactions, with an -implicit termination at the end of the input. Stop on first error, discarding the rest -of the input. Errors and warnings are collected apart from any exception arising from execution -which is returned via a Choice. Parsing is performed on the current thread, and execution is performed -sycnhronously on the 'main' thread.

    -

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered -by input from 'stdin'.

    - - -
    - - - EvalInteraction(code) - -
    - Signature: code:string -> unit
    -
    -     		-

    Execute the code as if it had been entered as one or more interactions, with an -implicit termination at the end of the input. Stop on first error, discarding the rest -of the input. Errors are sent to the output writer, a 'true' return value indicates there -were no errors overall. Execution is performed on the 'Run()' thread.

    -

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered -by input from 'stdin'.

    - - -
    - - - EvalInteractionNonThrowing(code) - -
    - Signature: code:string -> Choice<unit,exn> * FSharpErrorInfo []
    -
    -     		-

    Execute the code as if it had been entered as one or more interactions, with an -implicit termination at the end of the input. Stop on first error, discarding the rest -of the input. Errors and warnings are collected apart from any exception arising from execution -which is returned via a Choice. Execution is performed on the 'Run()' thread.

    -

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered -by input from 'stdin'.

    - - -
    - - - EvalScript(filePath) - -
    - Signature: filePath:string -> unit
    -
    -     		-

    Execute the given script. Stop on first error, discarding the rest -of the script. Errors are sent to the output writer, a 'true' return value indicates there -were no errors overall. Execution is performed on the 'Run()' thread.

    -

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered -by input from 'stdin'.

    - - -
    - - - EvalScriptNonThrowing(filePath) - -
    - Signature: filePath:string -> Choice<unit,exn> * FSharpErrorInfo []
    -
    -     		-

    Execute the given script. Stop on first error, discarding the rest -of the script. Errors and warnings are collected apart from any exception arising from execution -which is returned via a Choice. Execution is performed on the 'Run()' thread.

    -

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered -by input from 'stdin'.

    - - -
    - - - FormatValue(...) - -
    - Signature: (reflectionValue:obj * reflectionType:Type) -> string
    -
    -     		-

    Format a value to a string using the current PrintDepth, PrintLength etc settings provided by the active fsi configuration object

    - - -
    - - - GetCompletions(longIdent) - -
    - Signature: longIdent:string -> seq<string>
    -
    -     		-

    A host calls this to get the completions for a long identifier, e.g. in the console

    -

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered -by input from 'stdin'.

    - - -
    - - - InteractiveChecker - -
    - Signature: FSharpChecker
    -
    -     		-

    The single, global interactive checker to use in conjunction with other operations -on the FsiEvaluationSession.

    -

    If you are using an FsiEvaluationSession in this process, you should only use this InteractiveChecker -for additional checking operations.

    - - -

    CompiledName: get_InteractiveChecker

    -
    - - - Interrupt() - -
    - Signature: unit -> unit
    -
    -     		-

    A host calls this to request an interrupt on the evaluation thread.

    - - -
    - - - IsGui - -
    - Signature: bool
    -
    -     		-

    A host calls this to determine if the --gui parameter is active

    - - -

    CompiledName: get_IsGui

    -
    - - - LCID - -
    - Signature: int option
    -
    -     		-

    A host calls this to get the active language ID if provided by fsi-server-lcid

    - - -

    CompiledName: get_LCID

    -
    - - - ParseAndCheckInteraction(code) - -
    - Signature: code:string -> Async<FSharpParseFileResults * FSharpCheckFileResults * FSharpCheckProjectResults>
    -
    -     		-

    Typecheck the given script fragment in the type checking context implied by the current state -of F# Interactive. The results can be used to access intellisense, perform resolutions, -check brace matching and other information.

    -

    Operations may be run concurrently with other requests to the InteractiveChecker.

    -

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered -by input from 'stdin'.

    - - -
    - - - PartialAssemblySignatureUpdated - -
    - Signature: IEvent<unit>
    -
    -     		-

    Raised when an interaction is successfully typechecked and executed, resulting in an update to the -type checking state.

    -

    This event is triggered after parsing and checking, either via input from 'stdin', or via a call to EvalInteraction.

    - - -

    CompiledName: get_PartialAssemblySignatureUpdated

    -
    - - - ReportUnhandledException(exn) - -
    - Signature: exn:exn -> unit
    -
    -     		-

    A host calls this to report an unhandled exception in a standard way, e.g. an exception on the GUI thread gets printed to stderr

    - - -
    - - - Run() - -
    - Signature: unit -> unit
    -
    -     		-

    Load the dummy interaction, load the initial files, and, -if interacting, start the background thread to read the standard input.

    -

    Performs these steps: -- Load the dummy interaction, if any -- Set up exception handling, if any -- Load the initial files, if any -- Start the background thread to read the standard input, if any -- Sit in the GUI event loop indefinitely, if needed

    - - -
    -

    Static members

    - - - - - - - - - - - - - - - - - - - - - - -
    Static memberDescription
    - - - Create(...) - -
    - Signature: (fsiConfig:FsiEvaluationSessionHostConfig * argv:string [] * inReader:TextReader * outWriter:TextWriter * errorWriter:TextWriter * collectible:bool option * legacyReferenceResolver:Resolver option) -> FsiEvaluationSession
    -
    -     		-

    Create an FsiEvaluationSession, reading from the given text input, writing to the given text output and error writers.

    -Create an FsiEvaluationSession, reading from the given text input, writing to the given text output and error writers -The dynamic configuration of the evaluation session -The commmand line arguments for the evaluation session -Read input from the given reader -Write output to the given writer -Optionally make the dynamic assmbly for the session collectible - - -
    - - - GetDefaultConfiguration() - -
    - Signature: unit -> FsiEvaluationSessionHostConfig
    -
    -     		-

    Get a configuration that uses a private inbuilt implementation of the 'fsi' object and does not -implicitly reference FSharp.Compiler.Interactive.Settings.dll.

    - - -
    - - - GetDefaultConfiguration(fsiObj) - -
    - Signature: fsiObj:obj -> FsiEvaluationSessionHostConfig
    -
    -     		-

    Get a configuration that uses the 'fsi' object (normally from FSharp.Compiler.Interactive.Settings.dll, -an object from another DLL with identical characteristics) to provide an implementation of the configuration. -FSharp.Compiler.Interactive.Settings.dll is referenced by default.

    - - -
    - - - GetDefaultConfiguration(...) - -
    - Signature: (fsiObj:obj * useFsiAuxLib:bool) -> FsiEvaluationSessionHostConfig
    -
    -     		-

    Get a configuration that uses the 'fsi' object (normally from FSharp.Compiler.Interactive.Settings.dll, -an object from another DLL with identical characteristics) to provide an implementation of the configuration. -The flag indicates if FSharp.Compiler.Interactive.Settings.dll is referenced by default.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html b/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html deleted file mode 100644 index 16e7a378d3..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html +++ /dev/null @@ -1,455 +0,0 @@ - - - - - FsiEvaluationSessionHostConfig - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FsiEvaluationSessionHostConfig

    -

    - Namespace: FSharp.Compiler.Interactive
    - Parent Module: Shell -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> FsiEvaluationSessionHostConfig
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AddedPrinters - -
    - Signature: Choice<(Type * (obj -> string)),(Type * (obj -> obj))> list
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_AddedPrinters

    -
    - - - EventLoopInvoke(codeToRun) - -
    - Signature: (codeToRun:(unit -> 'T)) -> 'T
    - Modifiers: abstract
    - Type parameters: 'T
    -     		-

    Request that the given operation be run synchronously on the event loop.

    - - -
    - - - EventLoopRun() - -
    - Signature: unit -> bool
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host to enter a dispatch loop like Application.Run(). -Only called if --gui option is used (which is the default). -Gets called towards the end of startup and every time a ThreadAbort escaped to the backup driver loop. -Return true if a 'restart' is required, which is a bit meaningless.

    - - -
    - - - EventLoopScheduleRestart() - -
    - Signature: unit -> unit
    - Modifiers: abstract
    -
    -     		-

    Schedule a restart for the event loop.

    - - -
    - - - FloatingPointFormat - -
    - Signature: string
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_FloatingPointFormat

    -
    - - - FormatProvider - -
    - Signature: IFormatProvider
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_FormatProvider

    -
    - - - GetOptionalConsoleReadLine(...) - -
    - Signature: probeToSeeIfConsoleWorks:bool -> (unit -> string) option
    - Modifiers: abstract
    -
    -     		-

    Indicate a special console "readline" reader for the evaluation session, if any. A "console" gets used if --readline is specified (the default on Windows + .NET); and --fsi-server is not -given (always combine with --readline-), and OptionalConsoleReadLine is given. -When a console is used, special rules apply to "peekahead", which allows early typing on the console. -Peekahead happens if --peekahead- is not specified (the default). -In this case, a prompt is printed early, a background thread is created and -the OptionalConsoleReadLine is used to read the first line. -If a console is not used, then inReader.Peek() is called early instead. -Further lines are read using OptionalConsoleReadLine(). -If not provided, lines are read using inReader.ReadLine().

    - - -
    - - - OnEvaluation - -
    - Signature: IEvent<EvaluationEventArgs>
    -
    -     		-

    Hook for listening for evaluation bindings

    - - -

    CompiledName: get_OnEvaluation

    -
    - - - PrintDepth - -
    - Signature: int
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_PrintDepth

    -
    - - - PrintLength - -
    - Signature: int
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_PrintLength

    -
    - - - PrintSize - -
    - Signature: int
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_PrintSize

    -
    - - - PrintWidth - -
    - Signature: int
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_PrintWidth

    -
    - - - ReportUserCommandLineArgs(arg1) - -
    - Signature: (string []) -> unit
    - Modifiers: abstract
    -
    -     		-

    The evaluation session calls this to report the preferred view of the command line arguments after -stripping things like "/use:file.fsx", "-r:Foo.dll" etc.

    - - -
    - - - ShowDeclarationValues - -
    - Signature: bool
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_ShowDeclarationValues

    -
    - - - ShowIEnumerable - -
    - Signature: bool
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_ShowIEnumerable

    -
    - - - ShowProperties - -
    - Signature: bool
    - Modifiers: abstract
    -
    -     		-

    Called by the evaluation session to ask the host for parameters to format text for output

    - - -

    CompiledName: get_ShowProperties

    -
    - - - StartServer(fsiServerName) - -
    - Signature: fsiServerName:string -> unit
    - Modifiers: abstract
    -
    -     		-

    The evaluation session calls this at an appropriate point in the startup phase if the --fsi-server parameter was given

    - - -
    - - - UseFsiAuxLib - -
    - Signature: bool
    - Modifiers: abstract
    -
    -     		-

    Implicitly reference FSharp.Compiler.Interactive.Settings.dll

    - - -

    CompiledName: get_UseFsiAuxLib

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell-fsivalue.html b/docs/reference/fsharp-compiler-interactive-shell-fsivalue.html deleted file mode 100644 index 279583ee87..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell-fsivalue.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - FsiValue - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FsiValue

    -

    - Namespace: FSharp.Compiler.Interactive
    - Parent Module: Shell -

    -
    -

    Represents an evaluated F# value

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - ReflectionType - -
    - Signature: Type
    -
    -     		-

    The type of the value, from the point of view of the .NET type system

    - - -

    CompiledName: get_ReflectionType

    -
    - - - ReflectionValue - -
    - Signature: obj
    -
    -     		-

    The value, as an object

    - - -

    CompiledName: get_ReflectionValue

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell-settings-ieventloop.html b/docs/reference/fsharp-compiler-interactive-shell-settings-ieventloop.html deleted file mode 100644 index 0cef481c49..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell-settings-ieventloop.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - IEventLoop - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    IEventLoop

    -

    - Namespace: FSharp.Compiler.Interactive
    - Parent Module: Settings -

    -
    -

    An event loop used by the currently executing F# Interactive session to execute code -in the context of a GUI or another event-based system.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Invoke(arg1) - -
    - Signature: ((unit -> 'T)) -> 'T
    - Modifiers: abstract
    - Type parameters: 'T
    -     		-

    Request that the given operation be run synchronously on the event loop.

    - - -
    - - - Run() - -
    - Signature: unit -> bool
    - Modifiers: abstract
    -
    -     		-

    Run the event loop.

    - - -
    - - - ScheduleRestart() - -
    - Signature: unit -> unit
    - Modifiers: abstract
    -
    -     		-

    Schedule a restart for the event loop.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell-settings-interactivesettings.html b/docs/reference/fsharp-compiler-interactive-shell-settings-interactivesettings.html deleted file mode 100644 index ac0b6d9c8f..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell-settings-interactivesettings.html +++ /dev/null @@ -1,519 +0,0 @@ - - - - - InteractiveSettings - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    InteractiveSettings

    -

    - Namespace: FSharp.Compiler.Interactive
    - Parent Module: Settings -

    -
    -

    Operations supported by the currently executing F# Interactive session.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AddPrinter(arg1) - -
    - Signature: (('T -> string)) -> unit
    - Type parameters: 'T
    -     		-

    Register a printer that controls the output of the interactive session.

    - - -
    - - - AddPrintTransformer(arg1) - -
    - Signature: (('T -> obj)) -> unit
    - Type parameters: 'T
    -     		-

    Register a print transformer that controls the output of the interactive session.

    - - -
    - - - CommandLineArgs() - -
    - Signature: unit -> string []
    -
    -     		-

    The command line arguments after ignoring the arguments relevant to the interactive -environment and replacing the first argument with the name of the last script file, -if any. Thus 'fsi.exe test1.fs test2.fs -- hello goodbye' will give arguments -'test2.fs', 'hello', 'goodbye'. This value will normally be different to those -returned by System.Environment.GetCommandLineArgs.

    - - -

    CompiledName: set_CommandLineArgs

    -
    - - - CommandLineArgs() - -
    - Signature: unit -> unit
    -
    -     		-

    The command line arguments after ignoring the arguments relevant to the interactive -environment and replacing the first argument with the name of the last script file, -if any. Thus 'fsi.exe test1.fs test2.fs -- hello goodbye' will give arguments -'test2.fs', 'hello', 'goodbye'. This value will normally be different to those -returned by System.Environment.GetCommandLineArgs.

    - - -

    CompiledName: get_CommandLineArgs

    -
    - - - EventLoop() - -
    - Signature: unit -> IEventLoop
    -
    -     		-

    Gets or sets a the current event loop being used to process interactions.

    - - -

    CompiledName: set_EventLoop

    -
    - - - EventLoop() - -
    - Signature: unit -> unit
    -
    -     		-

    Gets or sets a the current event loop being used to process interactions.

    - - -

    CompiledName: get_EventLoop

    -
    - - - FloatingPointFormat() - -
    - Signature: unit -> string
    -
    -     		-

    Get or set the floating point format used in the output of the interactive session.

    - - -

    CompiledName: set_FloatingPointFormat

    -
    - - - FloatingPointFormat() - -
    - Signature: unit -> unit
    -
    -     		-

    Get or set the floating point format used in the output of the interactive session.

    - - -

    CompiledName: get_FloatingPointFormat

    -
    - - - FormatProvider() - -
    - Signature: unit -> IFormatProvider
    -
    -     		-

    Get or set the format provider used in the output of the interactive session.

    - - -

    CompiledName: set_FormatProvider

    -
    - - - FormatProvider() - -
    - Signature: unit -> unit
    -
    -     		-

    Get or set the format provider used in the output of the interactive session.

    - - -

    CompiledName: get_FormatProvider

    -
    - - - PrintDepth() - -
    - Signature: unit -> int
    -
    -     		-

    Get or set the print depth of the interactive session.

    - - -

    CompiledName: set_PrintDepth

    -
    - - - PrintDepth() - -
    - Signature: unit -> unit
    -
    -     		-

    Get or set the print depth of the interactive session.

    - - -

    CompiledName: get_PrintDepth

    -
    - - - PrintLength() - -
    - Signature: unit -> int
    -
    -     		-

    Get or set the total print length of the interactive session.

    - - -

    CompiledName: set_PrintLength

    -
    - - - PrintLength() - -
    - Signature: unit -> unit
    -
    -     		-

    Get or set the total print length of the interactive session.

    - - -

    CompiledName: get_PrintLength

    -
    - - - PrintSize() - -
    - Signature: unit -> int
    -
    -     		-

    Get or set the total print size of the interactive session.

    - - -

    CompiledName: set_PrintSize

    -
    - - - PrintSize() - -
    - Signature: unit -> unit
    -
    -     		-

    Get or set the total print size of the interactive session.

    - - -

    CompiledName: get_PrintSize

    -
    - - - PrintWidth() - -
    - Signature: unit -> int
    -
    -     		-

    Get or set the print width of the interactive session.

    - - -

    CompiledName: set_PrintWidth

    -
    - - - PrintWidth() - -
    - Signature: unit -> unit
    -
    -     		-

    Get or set the print width of the interactive session.

    - - -

    CompiledName: get_PrintWidth

    -
    - - - ShowDeclarationValues() - -
    - Signature: unit -> bool
    -
    -     		-

    When set to 'false', disables the display of declaration values in the output of the interactive session.

    - - -

    CompiledName: set_ShowDeclarationValues

    -
    - - - ShowDeclarationValues() - -
    - Signature: unit -> unit
    -
    -     		-

    When set to 'false', disables the display of declaration values in the output of the interactive session.

    - - -

    CompiledName: get_ShowDeclarationValues

    -
    - - - ShowIEnumerable() - -
    - Signature: unit -> bool
    -
    -     		-

    When set to 'false', disables the display of sequences in the output of the interactive session.

    - - -

    CompiledName: set_ShowIEnumerable

    -
    - - - ShowIEnumerable() - -
    - Signature: unit -> unit
    -
    -     		-

    When set to 'false', disables the display of sequences in the output of the interactive session.

    - - -

    CompiledName: get_ShowIEnumerable

    -
    - - - ShowProperties() - -
    - Signature: unit -> bool
    -
    -     		-

    When set to 'false', disables the display of properties of evaluated objects in the output of the interactive session.

    - - -

    CompiledName: set_ShowProperties

    -
    - - - ShowProperties() - -
    - Signature: unit -> unit
    -
    -     		-

    When set to 'false', disables the display of properties of evaluated objects in the output of the interactive session.

    - - -

    CompiledName: get_ShowProperties

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell-settings.html b/docs/reference/fsharp-compiler-interactive-shell-settings.html deleted file mode 100644 index bbda2c6fb0..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell-settings.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - Settings - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Settings

    -

    - Namespace: FSharp.Compiler.Interactive
    - Parent Module: Shell -

    -
    -

    A default implementation of the 'fsi' object, used by GetDefaultConfiguration()

    - -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - -
    TypeDescription
    - IEventLoop -

    An event loop used by the currently executing F# Interactive session to execute code -in the context of a GUI or another event-based system.

    - -
    - InteractiveSettings -

    Operations supported by the currently executing F# Interactive session.

    - -
    - -
    - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - fsi - -
    - Signature: InteractiveSettings
    -
    -     		-

    A default implementation of the 'fsi' object, used by GetDefaultConfiguration(). Note this -is a different object to FSharp.Compiler.Interactive.Settings.fsi in FSharp.Compiler.Interactive.Settings.dll, -which can be used as an alternative implementation of the interactiev settings if passed as a parameter -to GetDefaultConfiguration(fsiObj).

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-interactive-shell.html b/docs/reference/fsharp-compiler-interactive-shell.html deleted file mode 100644 index b5343fc6b6..0000000000 --- a/docs/reference/fsharp-compiler-interactive-shell.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - Shell - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Shell

    -

    - Namespace: FSharp.Compiler.Interactive
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - CompilerInputStream -

    Defines a read-only input stream used to feed content to the hosted F# Interactive dynamic compiler.

    - -
    - CompilerOutputStream -

    Defines a write-only stream used to capture output of the hosted F# Interactive dynamic compiler.

    - -
    - EvaluationEventArgs -
    - FsiEvaluationSession -

    Represents an F# Interactive evaluation session.

    - -
    - FsiEvaluationSessionHostConfig -
    - FsiValue -

    Represents an evaluated F# value

    - -
    - - - - - - - - - - -
    ModuleDescription
    - Settings -

    A default implementation of the 'fsi' object, used by GetDefaultConfiguration()

    - -
    - -
    - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-layout.html b/docs/reference/fsharp-compiler-layout-layout.html deleted file mode 100644 index 6ea8ff0891..0000000000 --- a/docs/reference/fsharp-compiler-layout-layout.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - layout - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    layout

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-layoutrenderer-2.html b/docs/reference/fsharp-compiler-layout-layoutrenderer-2.html deleted file mode 100644 index 223a8f0faa..0000000000 --- a/docs/reference/fsharp-compiler-layout-layoutrenderer-2.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - LayoutRenderer<'a, 'b> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LayoutRenderer<'a, 'b>

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -

    render a Layout yielding an 'a using a 'b (hidden state) type

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AddBreak(arg1 arg2) - -
    - Signature: 'b -> int -> 'b
    - Modifiers: abstract
    -
    -     		- -
    - - - AddTag(arg1 (arg2, arg3, arg4)) - -
    - Signature: 'b -> (string * (string * string) list * bool) -> 'b
    - Modifiers: abstract
    -
    -     		- -
    - - - AddText(arg1 arg2) - -
    - Signature: 'b -> TaggedText -> 'b
    - Modifiers: abstract
    -
    -     		- -
    - - - Finish(arg1) - -
    - Signature: 'b -> 'a
    - Modifiers: abstract
    -
    -     		- -
    - - - Start() - -
    - Signature: unit -> 'b
    - Modifiers: abstract
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-layouttag.html b/docs/reference/fsharp-compiler-layout-layouttag.html deleted file mode 100644 index abd98cd16d..0000000000 --- a/docs/reference/fsharp-compiler-layout-layouttag.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - LayoutTag - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LayoutTag

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-leftl.html b/docs/reference/fsharp-compiler-layout-leftl.html deleted file mode 100644 index a3df777112..0000000000 --- a/docs/reference/fsharp-compiler-layout-leftl.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - LeftL - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LeftL

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - colon - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordTypedefof - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordTypeof - -
    - Signature: Layout
    -
    -     		- -
    - - - leftBracketAngle - -
    - Signature: Layout
    -
    -     		- -
    - - - leftBracketBar - -
    - Signature: Layout
    -
    -     		- -
    - - - leftParen - -
    - Signature: Layout
    -
    -     		- -
    - - - questionMark - -
    - Signature: Layout
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-navigabletaggedtext.html b/docs/reference/fsharp-compiler-layout-navigabletaggedtext.html deleted file mode 100644 index 2776077883..0000000000 --- a/docs/reference/fsharp-compiler-layout-navigabletaggedtext.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - NavigableTaggedText - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NavigableTaggedText

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(arg1, arg2) - -
    - Signature: (TaggedText * range) -> NavigableTaggedText
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-noresult.html b/docs/reference/fsharp-compiler-layout-noresult.html deleted file mode 100644 index 660550d086..0000000000 --- a/docs/reference/fsharp-compiler-layout-noresult.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - NoResult - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NoResult

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - NoResult - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-nostate.html b/docs/reference/fsharp-compiler-layout-nostate.html deleted file mode 100644 index 5c2bbeb2ad..0000000000 --- a/docs/reference/fsharp-compiler-layout-nostate.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - NoState - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NoState

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - NoState - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-rightl.html b/docs/reference/fsharp-compiler-layout-rightl.html deleted file mode 100644 index 8c7a91790c..0000000000 --- a/docs/reference/fsharp-compiler-layout-rightl.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - RightL - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    RightL

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - colon - -
    - Signature: Layout
    -
    -     		- -
    - - - comma - -
    - Signature: Layout
    -
    -     		- -
    - - - rightAngle - -
    - Signature: Layout
    -
    -     		- -
    - - - rightBracket - -
    - Signature: Layout
    -
    -     		- -
    - - - rightBracketAngle - -
    - Signature: Layout
    -
    -     		- -
    - - - rightBracketBar - -
    - Signature: Layout
    -
    -     		- -
    - - - rightParen - -
    - Signature: Layout
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-sepl.html b/docs/reference/fsharp-compiler-layout-sepl.html deleted file mode 100644 index 6faad4e280..0000000000 --- a/docs/reference/fsharp-compiler-layout-sepl.html +++ /dev/null @@ -1,260 +0,0 @@ - - - - - SepL - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SepL

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - colon - -
    - Signature: Layout
    -
    -     		- -
    - - - comma - -
    - Signature: Layout
    -
    -     		- -
    - - - dot - -
    - Signature: Layout
    -
    -     		- -
    - - - leftAngle - -
    - Signature: Layout
    -
    -     		- -
    - - - leftBracket - -
    - Signature: Layout
    -
    -     		- -
    - - - leftParen - -
    - Signature: Layout
    -
    -     		- -
    - - - lineBreak - -
    - Signature: Layout
    -
    -     		- -
    - - - questionMark - -
    - Signature: Layout
    -
    -     		- -
    - - - rightParen - -
    - Signature: Layout
    -
    -     		- -
    - - - space - -
    - Signature: Layout
    -
    -     		- -
    - - - star - -
    - Signature: Layout
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-taggedtext.html b/docs/reference/fsharp-compiler-layout-taggedtext.html deleted file mode 100644 index 33255c90b6..0000000000 --- a/docs/reference/fsharp-compiler-layout-taggedtext.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - TaggedText - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    TaggedText

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Tag - -
    - Signature: LayoutTag
    - Modifiers: abstract
    -
    -     		- -

    CompiledName: get_Tag

    -
    - - - Text - -
    - Signature: string
    - Modifiers: abstract
    -
    -     		- -

    CompiledName: get_Text

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-taggedtextops-literals.html b/docs/reference/fsharp-compiler-layout-taggedtextops-literals.html deleted file mode 100644 index a3b67ca14d..0000000000 --- a/docs/reference/fsharp-compiler-layout-taggedtextops-literals.html +++ /dev/null @@ -1,414 +0,0 @@ - - - - - Literals - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Literals

    -

    - Namespace: FSharp.Compiler
    - Parent Module: TaggedTextOps -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - arrow - -
    - Signature: TaggedText
    -
    -     		- -
    - - - colon - -
    - Signature: TaggedText
    -
    -     		- -
    - - - comma - -
    - Signature: TaggedText
    -
    -     		- -
    - - - dot - -
    - Signature: TaggedText
    -
    -     		- -
    - - - equals - -
    - Signature: TaggedText
    -
    -     		- -
    - - - keywordFalse - -
    - Signature: TaggedText
    -
    -     		- -
    - - - keywordTrue - -
    - Signature: TaggedText
    -
    -     		- -
    - - - leftAngle - -
    - Signature: TaggedText
    -
    -     		- -
    - - - leftBrace - -
    - Signature: TaggedText
    -
    -     		- -
    - - - leftBraceBar - -
    - Signature: TaggedText
    -
    -     		- -
    - - - leftBracket - -
    - Signature: TaggedText
    -
    -     		- -
    - - - leftParen - -
    - Signature: TaggedText
    -
    -     		- -
    - - - lineBreak - -
    - Signature: TaggedText
    -
    -     		- -
    - - - minus - -
    - Signature: TaggedText
    -
    -     		- -
    - - - questionMark - -
    - Signature: TaggedText
    -
    -     		- -
    - - - rightAngle - -
    - Signature: TaggedText
    -
    -     		- -
    - - - rightBrace - -
    - Signature: TaggedText
    -
    -     		- -
    - - - rightBraceBar - -
    - Signature: TaggedText
    -
    -     		- -
    - - - rightBracket - -
    - Signature: TaggedText
    -
    -     		- -
    - - - rightParen - -
    - Signature: TaggedText
    -
    -     		- -
    - - - semicolon - -
    - Signature: TaggedText
    -
    -     		- -
    - - - space - -
    - Signature: TaggedText
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-taggedtextops.html b/docs/reference/fsharp-compiler-layout-taggedtextops.html deleted file mode 100644 index 6301552904..0000000000 --- a/docs/reference/fsharp-compiler-layout-taggedtextops.html +++ /dev/null @@ -1,585 +0,0 @@ - - - - - TaggedTextOps - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    TaggedTextOps

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - -
    ModuleDescription
    - Literals -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - tagActivePatternCase - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagActivePatternResult - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagAlias - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagClass - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagDelegate - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagEnum - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagEvent - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagField - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagInterface - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagKeyword - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagLineBreak - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagLocal - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagMember - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagMethod - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagModule - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagModuleBinding - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagNamespace - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagNumericLiteral - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagOperator - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagParameter - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagProperty - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagPunctuation - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagRecord - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagRecordField - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagSpace - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagStringLiteral - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagStruct - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagText - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagTypeParameter - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagUnion - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagUnionCase - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagUnknownEntity - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagUnknownType - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout-wordl.html b/docs/reference/fsharp-compiler-layout-wordl.html deleted file mode 100644 index 394f55db94..0000000000 --- a/docs/reference/fsharp-compiler-layout-wordl.html +++ /dev/null @@ -1,498 +0,0 @@ - - - - - WordL - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    WordL

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Layout -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - arrow - -
    - Signature: Layout
    -
    -     		- -
    - - - bar - -
    - Signature: Layout
    -
    -     		- -
    - - - colon - -
    - Signature: Layout
    -
    -     		- -
    - - - equals - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordAbstract - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordDelegate - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordEnd - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordEnum - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordEvent - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordFalse - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordGet - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordInherit - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordInternal - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordMember - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordNested - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordNew - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordOf - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordOverride - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordPrivate - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordSet - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordStatic - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordStruct - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordTrue - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordType - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordVal - -
    - Signature: Layout
    -
    -     		- -
    - - - keywordWith - -
    - Signature: Layout
    -
    -     		- -
    - - - star - -
    - Signature: Layout
    -
    -     		- -
    - - - structUnit - -
    - Signature: Layout
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-layout.html b/docs/reference/fsharp-compiler-layout.html deleted file mode 100644 index 4e6b05ca03..0000000000 --- a/docs/reference/fsharp-compiler-layout.html +++ /dev/null @@ -1,700 +0,0 @@ - - - - - Layout - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Layout

    -

    - Namespace: FSharp.Compiler
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - LayoutRenderer<'a, 'b> -

    render a Layout yielding an 'a using a 'b (hidden state) type

    - -
    - LayoutTag -
    - NavigableTaggedText -
    - NoResult -
    - NoState -
    - TaggedText -
    - layout -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ModuleDescription
    - LeftL -
    - RightL -
    - SepL -
    - TaggedTextOps -
    - WordL -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - ( -- ) arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -

    CompiledName: op_MinusMinus

    -
    - - - ( --- ) arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -

    CompiledName: op_MinusMinusMinus

    -
    - - - ( ---- ) arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -

    CompiledName: op_MinusMinusMinusMinus

    -
    - - - ( ----- ) arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -

    CompiledName: op_MinusMinusMinusMinusMinus

    -
    - - - ( @@ ) arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -

    CompiledName: op_AtAt

    -
    - - - ( @@- ) arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -

    CompiledName: op_AtAtMinus

    -
    - - - ( @@-- ) arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -

    CompiledName: op_AtAtMinusMinus

    -
    - - - ( ^^ ) arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -

    CompiledName: op_HatHat

    -
    - - - ( ++ ) arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -

    CompiledName: op_PlusPlus

    -
    - - - aboveL arg1 arg2 - -
    - Signature: Layout -> Layout -> Layout
    -
    -     		- -
    - - - aboveListL arg1 - -
    - Signature: Layout list -> Layout
    -
    -     		- -
    - - - bracketL arg1 - -
    - Signature: Layout -> Layout
    -
    -     		- -
    - - - bufferL arg1 arg2 - -
    - Signature: StringBuilder -> Layout -> unit
    -
    -     		- -
    - - - bufferR arg1 - -
    - Signature: StringBuilder -> LayoutRenderer<NoResult,NoState>
    -
    -     		- -
    - - - channelR arg1 - -
    - Signature: TextWriter -> LayoutRenderer<NoResult,NoState>
    -
    -     		- -
    - - - commaListL arg1 - -
    - Signature: Layout list -> Layout
    -
    -     		- -
    - - - emptyL - -
    - Signature: Layout
    -
    -     		- -
    - - - isEmptyL arg1 - -
    - Signature: Layout -> bool
    -
    -     		- -
    - - - leftL arg1 - -
    - Signature: TaggedText -> Layout
    -
    -     		- -
    - - - listL arg1 arg2 - -
    - Signature: ('a -> Layout) -> 'a list -> Layout
    - Type parameters: 'a
    -     		- -
    - - - mkNav arg1 arg2 - -
    - Signature: range -> TaggedText -> TaggedText
    -
    -     		- -
    - - - optionL arg1 arg2 - -
    - Signature: ('a -> Layout) -> 'a option -> Layout
    - Type parameters: 'a
    -     		- -
    - - - outL arg1 arg2 - -
    - Signature: TextWriter -> Layout -> unit
    -
    -     		- -
    - - - renderL arg1 arg2 - -
    - Signature: LayoutRenderer<'b,'a> -> Layout -> 'b
    - Type parameters: 'b, 'a
    -     		-

    Run a render on a Layout

    - - -
    - - - rightL arg1 - -
    - Signature: TaggedText -> Layout
    -
    -     		- -
    - - - semiListL arg1 - -
    - Signature: Layout list -> Layout
    -
    -     		- -
    - - - sepL arg1 - -
    - Signature: TaggedText -> Layout
    -
    -     		- -
    - - - sepListL arg1 arg2 - -
    - Signature: Layout -> Layout list -> Layout
    -
    -     		- -
    - - - showL arg1 - -
    - Signature: Layout -> string
    -
    -     		- -
    - - - spaceListL arg1 - -
    - Signature: Layout list -> Layout
    -
    -     		- -
    - - - squashTo arg1 arg2 - -
    - Signature: int -> Layout -> Layout
    -
    -     		- -
    - - - stringR - -
    - Signature: LayoutRenderer<string,string list>
    -
    -     		-

    Primitive renders

    - - -
    - - - taggedTextListR collector - -
    - Signature: collector:(TaggedText -> unit) -> LayoutRenderer<NoResult,NoState>
    -
    -     		- -
    - - - tupleL arg1 - -
    - Signature: Layout list -> Layout
    -
    -     		- -
    - - - wordL arg1 - -
    - Signature: TaggedText -> Layout
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-logcompilerfunctionid.html b/docs/reference/fsharp-compiler-logcompilerfunctionid.html deleted file mode 100644 index 7f891740dd..0000000000 --- a/docs/reference/fsharp-compiler-logcompilerfunctionid.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - LogCompilerFunctionId - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LogCompilerFunctionId

    -

    - Namespace: FSharp.Compiler
    -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - CompileOps_TypeCheckOneInputAndFinishEventually - -
    - Signature: LogCompilerFunctionId
    - Modifiers: static
    -
    -     		- -
    - - - Service_CheckOneFile - -
    - Signature: LogCompilerFunctionId
    - Modifiers: static
    -
    -     		- -
    - - - Service_IncrementalBuildersCache_BuildingNewCache - -
    - Signature: LogCompilerFunctionId
    - Modifiers: static
    -
    -     		- -
    - - - Service_IncrementalBuildersCache_GettingCache - -
    - Signature: LogCompilerFunctionId
    - Modifiers: static
    -
    -     		- -
    - - - Service_ParseAndCheckFileInProject - -
    - Signature: LogCompilerFunctionId
    - Modifiers: static
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-partiallongname.html b/docs/reference/fsharp-compiler-partiallongname.html deleted file mode 100644 index d1b9aed20b..0000000000 --- a/docs/reference/fsharp-compiler-partiallongname.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - PartialLongName - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PartialLongName

    -

    - Namespace: FSharp.Compiler
    -

    -
    -

    Qualified long name.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - EndColumn - -
    - Signature: int
    -
    -     		-

    The column number at the end of full partial name.

    - - -
    - - - LastDotPos - -
    - Signature: int option
    -
    -     		-

    Position of the last dot.

    - - -
    - - - PartialIdent - -
    - Signature: string
    -
    -     		-

    Last part of long ident.

    - - -
    - - - QualifyingIdents - -
    - Signature: string list
    -
    -     		-

    Qualifying idents, prior to the last dot, not including the last part.

    - - -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty(endColumn) - -
    - Signature: endColumn:int -> PartialLongName
    -
    -     		-

    Empty patial long name.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-prettynaming-activepatterninfo.html b/docs/reference/fsharp-compiler-prettynaming-activepatterninfo.html deleted file mode 100644 index 3acf4c082e..0000000000 --- a/docs/reference/fsharp-compiler-prettynaming-activepatterninfo.html +++ /dev/null @@ -1,185 +0,0 @@ - - - - - ActivePatternInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ActivePatternInfo

    -

    - Namespace: FSharp.Compiler
    - Parent Module: PrettyNaming -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - APInfo(bool,(string * range) list,range) - -
    - Signature: bool * (string * range) list * range
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - ActiveTags - -
    - Signature: string list
    -
    -     		- -

    CompiledName: get_ActiveTags

    -
    - - - ActiveTagsWithRanges - -
    - Signature: (string * range) list
    -
    -     		- -

    CompiledName: get_ActiveTagsWithRanges

    -
    - - - IsTotal - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsTotal

    -
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-prettynaming-invalidmangledstaticarg.html b/docs/reference/fsharp-compiler-prettynaming-invalidmangledstaticarg.html deleted file mode 100644 index e136888158..0000000000 --- a/docs/reference/fsharp-compiler-prettynaming-invalidmangledstaticarg.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - InvalidMangledStaticArg - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    InvalidMangledStaticArg

    -

    - Namespace: FSharp.Compiler
    - Parent Module: PrettyNaming -

    -
    -
    -

    Record Fields

    - - - - - - - - - - -
    Record FieldDescription
    - - - Data0 - -
    - Signature: string
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-prettynaming-namearitypair.html b/docs/reference/fsharp-compiler-prettynaming-namearitypair.html deleted file mode 100644 index 2e5d6abe16..0000000000 --- a/docs/reference/fsharp-compiler-prettynaming-namearitypair.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - NameArityPair - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NameArityPair

    -

    - Namespace: FSharp.Compiler
    - Parent Module: PrettyNaming -

    -
    -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - NameArityPair(string,int) - -
    - Signature: string * int
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-prettynaming.html b/docs/reference/fsharp-compiler-prettynaming.html deleted file mode 100644 index 2e65c88367..0000000000 --- a/docs/reference/fsharp-compiler-prettynaming.html +++ /dev/null @@ -1,851 +0,0 @@ - - - - - PrettyNaming - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PrettyNaming

    -

    - Namespace: FSharp.Compiler
    -

    -
    -

    Anything to do with special names of identifiers and other lexical rules

    - -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - ActivePatternInfo -
    - InvalidMangledStaticArg -
    - NameArityPair -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - ActivePatternInfoOfValName nm m - -
    - Signature: nm:string -> m:range -> ActivePatternInfo option
    -
    -     		- -
    - - - ChopPropertyName s - -
    - Signature: s:string -> string
    -
    -     		-

    Try to chop "get" or "set" from a string. -If the string does not start with "get" or "set", this function raises an exception.

    - - -
    - - - CompileOpName - -
    - Signature: string -> string
    -
    -     		-

    Compiles an operator into a mangled operator name. -For example, "!%" becomes "op_DereferencePercent". -This function accepts both built-in and custom operators.

    - - -
    - - - CompilerGeneratedName nm - -
    - Signature: nm:string -> string
    -
    -     		- -
    - - - CompilerGeneratedNameSuffix (...) - -
    - Signature: basicName:string -> suffix:string -> string
    -
    -     		- -
    - - - computeMangledNameWithoutDefaultArgValues (...) - -
    - Signature: (nm:string * staticArgs:obj [] * defaultArgValues:(string * string option) []) -> string
    -
    -     		-

    Mangle the static parameters for a provided type or method

    - - -
    - - - DecodeGenericTypeName pos mangledName - -
    - Signature: pos:int -> mangledName:string -> NameArityPair
    -
    -     		- -
    - - - DecompileOpName - -
    - Signature: string -> string
    -
    -     		-

    Decompiles a mangled operator name back into an operator. -For example, "op_DereferencePercent" becomes "!%". -This function accepts mangled names for both built-in and custom operators.

    - - -
    - - - DemangleGenericTypeName mangledName - -
    - Signature: mangledName:string -> string
    -
    -     		- -
    - - - DemangleGenericTypeNameWithPos (...) - -
    - Signature: pos:int -> mangledName:string -> string
    -
    -     		- -
    - - - DemangleOperatorName nm - -
    - Signature: nm:string -> string
    -
    -     		- -
    - - - DemangleOperatorNameAsLayout (...) - -
    - Signature: nonOpTagged:(string -> 'a) -> nm:string -> Layout
    - Type parameters: 'a
    -     		- -
    - - - demangleProvidedTypeName typeLogicalName - -
    - Signature: typeLogicalName:string -> string * (string * string) []
    -
    -     		-

    Demangle the static parameters

    - - -
    - - - FSharpModuleSuffix - -
    - Signature: string
    -
    -     		- -
    - - - GetBasicNameOfPossibleCompilerGeneratedName (...) - -
    - Signature: name:string -> string
    -
    -     		- -
    - - - IllegalCharactersInTypeAndNamespaceNames (...) - -
    - Signature: char []
    -
    -     		- -
    - - - IsActivePatternName nm - -
    - Signature: nm:string -> bool
    -
    -     		-

    Determines if the specified name is a valid name for an active pattern.

    - - -
    - - - IsCompilerGeneratedName nm - -
    - Signature: nm:string -> bool
    -
    -     		- -
    - - - IsIdentifierFirstCharacter c - -
    - Signature: c:char -> bool
    -
    -     		-

    The characters that are allowed to be the first character of an identifier.

    - - -
    - - - IsIdentifierPartCharacter c - -
    - Signature: c:char -> bool
    -
    -     		-

    The characters that are allowed to be in an identifier.

    - - -
    - - - IsInfixOperator - -
    - Signature: string -> bool
    -
    -     		- -
    - - - IsLongIdentifierPartCharacter c - -
    - Signature: c:char -> bool
    -
    -     		-

    Is this character a part of a long identifier?

    - - -
    - - - IsMangledOpName n - -
    - Signature: n:string -> bool
    -
    -     		- -
    - - - IsOperatorName name - -
    - Signature: name:string -> bool
    -
    -     		-

    Returns true if given string is an operator display name, e.g. ( |>> )

    - - -
    - - - IsOperatorOrBacktickedName name - -
    - Signature: name:string -> bool
    -
    -     		-

    Returns true if given string is an operator or double backticked name, e.g. ( |>> ) or ( long identifier ). -(where ( long identifier ) is the display name for long identifier).

    - - -
    - - - IsPrefixOperator s - -
    - Signature: s:string -> bool
    -
    -     		- -
    - - - IsPunctuation s - -
    - Signature: s:string -> bool
    -
    -     		- -
    - - - IsTernaryOperator s - -
    - Signature: s:string -> bool
    -
    -     		- -
    - - - IsValidPrefixOperatorDefinitionName s - -
    - Signature: s:string -> bool
    -
    -     		- -
    - - - IsValidPrefixOperatorUse s - -
    - Signature: s:string -> bool
    -
    -     		- -
    - - - MangledGlobalName - -
    - Signature: string
    -
    -     		- -
    - - - mangleProvidedTypeName (...) - -
    - Signature: (typeLogicalName:string * nonDefaultArgs:(string * string) []) -> string
    -
    -     		-

    Mangle the static parameters for a provided type or method

    - - -
    - - - opNameCons - -
    - Signature: string
    -
    -     		- -
    - - - opNameEquals - -
    - Signature: string
    -
    -     		- -
    - - - opNameEqualsNullable - -
    - Signature: string
    -
    -     		- -
    - - - opNameNil - -
    - Signature: string
    -
    -     		- -
    - - - opNameNullableEquals - -
    - Signature: string
    -
    -     		- -
    - - - opNameNullableEqualsNullable - -
    - Signature: string
    -
    -     		- -
    - - - opNamePrefix - -
    - Signature: string
    -
    -     		-

    Prefix for compiled (mangled) operator names.

    - - -
    - - - outArgCompilerGeneratedName - -
    - Signature: string
    -
    -     		- -
    - - - parenGet - -
    - Signature: string
    -
    -     		- -
    - - - parenSet - -
    - Signature: string
    -
    -     		- -
    - - - qmark - -
    - Signature: string
    -
    -     		- -
    - - - qmarkSet - -
    - Signature: string
    -
    -     		- -
    - - - SplitNamesForILPath s - -
    - Signature: s:string -> string list
    -
    -     		- -
    - - - TryChopPropertyName s - -
    - Signature: s:string -> string option
    -
    -     		-

    Try to chop "get" or "set" from a string

    - - -
    - - - TryDemangleGenericNameAndPos n - -
    - Signature: n:string -> int voption
    -
    -     		- -
    -

    Active patterns

    - - - - - - - - - - -
    Active patternDescription
    - - - ( |Control|Equality|Relational|Indexer|FixedTypes|Other| ) (...) - -
    - Signature: opName:string -> Choice<unit,unit,unit,unit,unit,unit>
    -
    -     		- -

    CompiledName: |Control|Equality|Relational|Indexer|FixedTypes|Other|

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-quickparse.html b/docs/reference/fsharp-compiler-quickparse.html deleted file mode 100644 index 4b8b75a847..0000000000 --- a/docs/reference/fsharp-compiler-quickparse.html +++ /dev/null @@ -1,231 +0,0 @@ - - - - - QuickParse - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    QuickParse

    -

    - Namespace: FSharp.Compiler
    -

    -
    -

    Methods for cheaply and innacurately parsing F#.

    -

    These methods are very old and are mostly to do with extracting "long identifier islands" -A.B.C -from F# source code, an approach taken from pre-F# VS samples for implementing intelliense.

    -

    This code should really no longer be needed since the language service has access to -parsed F# source code ASTs. However, the long identifiers are still passed back to GetDeclarations and friends in the -F# Compiler Service and it's annoyingly hard to remove their use completely.

    -

    In general it is unlikely much progress will be made by fixing this code - it will be better to -extract more information from the F# ASTs.

    -

    It's also surprising how hard even the job of getting long identifier islands can be. For example the code -below is inaccurate for long identifier chains involving ... identifiers. And there are special cases -for active pattern names and so on.

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - CorrectIdentifierToken (...) - -
    - Signature: tokenText:string -> tokenTag:int -> int
    -
    -     		- -
    - - - GetCompleteIdentifierIsland (...) - -
    - Signature: tolerateJustAfter:bool -> tokenText:string -> index:int -> (string * int * bool) option
    -
    -     		-

    Given a string and a position in that string, find an identifier as -expected by GotoDefinition. This will work when the cursor is -immediately before the identifier, within the identifier, or immediately -after the identifier.

    -

    'tolerateJustAfter' indicates that we tolerate being one character after the identifier, used -for goto-definition

    -

    In general, only identifiers composed from upper/lower letters and '.' are supported, but there -are a couple of explicitly handled exceptions to allow some common scenarios: -- When the name contains only letters and '|' symbol, it may be an active pattern, so we -treat it as a valid identifier - e.g. let ( |Identitiy| ) a = a -(but other identifiers that include '|' are not allowed - e.g. '||' operator) -- It searches for double tick () to see if the identifier could be something likea b``

    -

    REVIEW: Also support, e.g., operators, performing the necessary mangling. -(i.e., I would like that the name returned here can be passed as-is -(post .-chopping) to `GetDeclarationLocation.)

    -

    In addition, return the position where a . would go if we were making -a call to DeclItemsForNamesAtPosition for intellisense. This will -allow us to use find the correct qualified items rather than resorting -to the more expensive and less accurate environment lookup.

    - - -
    - - - GetPartialLongName (lineStr, index) - -
    - Signature: (lineStr:string * index:int) -> string list * string
    -
    -     		-

    Get the partial long name of the identifier to the left of index.

    - - -
    - - - GetPartialLongNameEx (lineStr, index) - -
    - Signature: (lineStr:string * index:int) -> PartialLongName
    -
    -     		-

    Get the partial long name of the identifier to the left of index. -For example, for System.DateTime.Now it returns PartialLongName ([|"System"; "DateTime"|], "Now", Some 32), where "32" pos of the last dot.

    - - -
    - - - MagicalAdjustmentConstant - -
    - Signature: int
    -
    -     		-

    Puts us after the last character.

    - - -
    - - - TestMemberOrOverrideDeclaration tokens - -
    - Signature: tokens:FSharpTokenInfo [] -> bool
    -
    -     		-

    Tests whether the user is typing something like "member x." or "override (comment) x."

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range-fileindex.html b/docs/reference/fsharp-compiler-range-fileindex.html deleted file mode 100644 index 5d5cc2d8e0..0000000000 --- a/docs/reference/fsharp-compiler-range-fileindex.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - FileIndex - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FileIndex

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Range -

    -
    -

    An index into a global tables of filenames

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range-line.html b/docs/reference/fsharp-compiler-range-line.html deleted file mode 100644 index 2a14415662..0000000000 --- a/docs/reference/fsharp-compiler-range-line.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - Line - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Line

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Range -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - fromZ arg1 - -
    - Signature: Line0 -> int
    -
    -     		-

    Convert a line number from zero-based line counting (used by Visual Studio) to one-based line counting (used internally in the F# compiler and in F# error messages)

    - - -
    - - - toZ arg1 - -
    - Signature: int -> Line0
    -
    -     		-

    Convert a line number from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio)

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range-line0.html b/docs/reference/fsharp-compiler-range-line0.html deleted file mode 100644 index d94885736a..0000000000 --- a/docs/reference/fsharp-compiler-range-line0.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Line0 - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Line0

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Range -

    -
    -

    Represents a line number when using zero-based line counting (used by Visual Studio)

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range-pos-0.html b/docs/reference/fsharp-compiler-range-pos-0.html deleted file mode 100644 index af1bd2f23a..0000000000 --- a/docs/reference/fsharp-compiler-range-pos-0.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - Pos - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Pos

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Range -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - fromZ line column - -
    - Signature: line:Line0 -> column:int -> pos
    -
    -     		-

    Convert a position from zero-based line counting (used by Visual Studio) to one-based line counting (used internally in the F# compiler and in F# error messages)

    - - -
    - - - toZ arg1 - -
    - Signature: pos -> Pos01
    -
    -     		-

    Convert a position from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio)

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range-pos.html b/docs/reference/fsharp-compiler-range-pos.html deleted file mode 100644 index fe86159e4d..0000000000 --- a/docs/reference/fsharp-compiler-range-pos.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - pos - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    pos

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Range -

    -
    -

    Represents a position in a file

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Column - -
    - Signature: int
    -
    -     		-

    The column number for the position

    - - -

    CompiledName: get_Column

    -
    - - - Encoding - -
    - Signature: int64
    -
    -     		-

    The encoding of the position as a 64-bit integer

    - - -

    CompiledName: get_Encoding

    -
    - - - Line - -
    - Signature: int
    -
    -     		-

    The line number for the position

    - - -

    CompiledName: get_Line

    -
    -

    Static members

    - - - - - - - - - - - - - - -
    Static memberDescription
    - - - Decode(arg1) - -
    - Signature: int64 -> pos
    -
    -     		-

    Decode a position fro a 64-bit integer

    - - -
    - - - EncodingSize - -
    - Signature: int
    -
    -     		-

    The maximum number of bits needed to store an encoded position

    - - -

    CompiledName: get_EncodingSize

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range-pos01.html b/docs/reference/fsharp-compiler-range-pos01.html deleted file mode 100644 index 97b2fa4dbb..0000000000 --- a/docs/reference/fsharp-compiler-range-pos01.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Pos01 - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Pos01

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Range -

    -
    -

    Represents a position using zero-based line counting (used by Visual Studio)

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range-range-0.html b/docs/reference/fsharp-compiler-range-range-0.html deleted file mode 100644 index 2423de8693..0000000000 --- a/docs/reference/fsharp-compiler-range-range-0.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - Range - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Range

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Range -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - toFileZ arg1 - -
    - Signature: range -> string * Range01
    -
    -     		-

    Convert a range from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio)

    - - -
    - - - toZ arg1 - -
    - Signature: range -> Range01
    -
    -     		-

    Convert a range from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio)

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range-range.html b/docs/reference/fsharp-compiler-range-range.html deleted file mode 100644 index 538c5343ab..0000000000 --- a/docs/reference/fsharp-compiler-range-range.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - range - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    range

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Range -

    -
    -

    Represents a range within a known file

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - End - -
    - Signature: pos
    -
    -     		-

    The end position of the range

    - - -

    CompiledName: get_End

    -
    - - - EndColumn - -
    - Signature: int
    -
    -     		-

    The column number for the end position of the range

    - - -

    CompiledName: get_EndColumn

    -
    - - - EndLine - -
    - Signature: int
    -
    -     		-

    The line number for the end position of the range

    - - -

    CompiledName: get_EndLine

    -
    - - - EndRange - -
    - Signature: range
    -
    -     		-

    The empty range that is located at the end position of the range

    - - -

    CompiledName: get_EndRange

    -
    - - - FileIndex - -
    - Signature: int
    -
    -     		-

    The file index for the range

    - - -

    CompiledName: get_FileIndex

    -
    - - - FileName - -
    - Signature: string
    -
    -     		-

    The file name for the file of the range

    - - -

    CompiledName: get_FileName

    -
    - - - IsSynthetic - -
    - Signature: bool
    -
    -     		-

    Synthetic marks ranges which are produced by intermediate compilation phases. This -bit signifies that the range covers something that should not be visible to language -service operations like dot-completion.

    - - -

    CompiledName: get_IsSynthetic

    -
    - - - MakeSynthetic() - -
    - Signature: unit -> range
    -
    -     		-

    Convert a range to be synthetic

    - - -
    - - - Start - -
    - Signature: pos
    -
    -     		-

    The start position of the range

    - - -

    CompiledName: get_Start

    -
    - - - StartColumn - -
    - Signature: int
    -
    -     		-

    The start column of the range

    - - -

    CompiledName: get_StartColumn

    -
    - - - StartLine - -
    - Signature: int
    -
    -     		-

    The start line of the range

    - - -

    CompiledName: get_StartLine

    -
    - - - StartRange - -
    - Signature: range
    -
    -     		-

    The empty range that is located at the start position of the range

    - - -

    CompiledName: get_StartRange

    -
    - - - ToShortString() - -
    - Signature: unit -> string
    -
    -     		-

    Convert a range to string

    - - -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Zero - -
    - Signature: range
    -
    -     		-

    The range where all values are zero

    - - -

    CompiledName: get_Zero

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range-range01.html b/docs/reference/fsharp-compiler-range-range01.html deleted file mode 100644 index 37ef3a4b11..0000000000 --- a/docs/reference/fsharp-compiler-range-range01.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Range01 - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Range01

    -

    - Namespace: FSharp.Compiler
    - Parent Module: Range -

    -
    -

    Represents a range using zero-based line counting (used by Visual Studio)

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-range.html b/docs/reference/fsharp-compiler-range.html deleted file mode 100644 index 22c0d92b0f..0000000000 --- a/docs/reference/fsharp-compiler-range.html +++ /dev/null @@ -1,589 +0,0 @@ - - - - - Range - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Range

    -

    - Namespace: FSharp.Compiler
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - FileIndex -

    An index into a global tables of filenames

    - -
    - Line0 -

    Represents a line number when using zero-based line counting (used by Visual Studio)

    - -
    - Pos01 -

    Represents a position using zero-based line counting (used by Visual Studio)

    - -
    - Range01 -

    Represents a range using zero-based line counting (used by Visual Studio)

    - -
    - pos -

    Represents a position in a file

    - -
    - range -

    Represents a range within a known file

    - -
    - - - - - - - - - - - - - - - - - - -
    ModuleDescription
    - Line -
    - Pos -
    - Range -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - fileIndexOfFile filePath - -
    - Signature: filePath:string -> FileIndex
    -
    -     		-

    Convert a file path to an index

    - - -
    - - - fileOfFileIndex arg1 - -
    - Signature: FileIndex -> string
    -
    -     		-

    Convert an index into a file path

    - - -
    - - - mkFileIndexRange arg1 arg2 arg3 - -
    - Signature: FileIndex -> pos -> pos -> range
    -
    -     		-

    This view of range marks uses file indexes explicitly

    - - -
    - - - mkPos line column - -
    - Signature: line:int -> column:int -> pos
    -
    -     		-

    Create a position for the given line and column

    - - -
    - - - mkRange arg1 arg2 arg3 - -
    - Signature: string -> pos -> pos -> range
    -
    -     		-

    This view hides the use of file indexes and just uses filenames

    - - -
    - - - outputPos arg1 arg2 - -
    - Signature: TextWriter -> pos -> unit
    -
    -     		-

    Output a position

    - - -
    - - - outputRange arg1 arg2 - -
    - Signature: TextWriter -> range -> unit
    -
    -     		-

    Output a range

    - - -
    - - - pos0 - -
    - Signature: pos
    -
    -     		-

    The zero position

    - - -
    - - - posEq arg1 arg2 - -
    - Signature: pos -> pos -> bool
    -
    -     		-

    Compare positions for equality

    - - -
    - - - posGeq arg1 arg2 - -
    - Signature: pos -> pos -> bool
    -
    -     		-

    Compare positions for greater-than-or-equal-to

    - - -
    - - - posGt arg1 arg2 - -
    - Signature: pos -> pos -> bool
    -
    -     		-

    Compare positions for greater-than

    - - -
    - - - posLt arg1 arg2 - -
    - Signature: pos -> pos -> bool
    -
    -     		-

    Compare positions for less-than

    - - -
    - - - posOrder - -
    - Signature: IComparer<pos>
    -
    -     		-

    Ordering on positions

    - - -
    - - - range0 - -
    - Signature: range
    -
    -     		-

    The zero range

    - - -
    - - - rangeBeforePos arg1 arg2 - -
    - Signature: range -> pos -> bool
    -
    -     		-

    Test to see if a range occurs fully before a position

    - - -
    - - - rangeCmdArgs - -
    - Signature: range
    -
    -     		-

    A range associated with a dummy file for the command line arguments

    - - -
    - - - rangeContainsPos arg1 arg2 - -
    - Signature: range -> pos -> bool
    -
    -     		-

    Test to see if a range contains a position

    - - -
    - - - rangeContainsRange arg1 arg2 - -
    - Signature: range -> range -> bool
    -
    -     		-

    Test to see if one range contains another range

    - - -
    - - - rangeN arg1 arg2 - -
    - Signature: string -> int -> range
    -
    -     		-

    Make a dummy range for a file

    - - -
    - - - rangeOrder - -
    - Signature: IComparer<range>
    -
    -     		-

    not a total order, but enough to sort on ranges

    - - -
    - - - rangeStartup - -
    - Signature: range
    -
    -     		-

    A range associated with a dummy file called "startup"

    - - -
    - - - stringOfPos arg1 - -
    - Signature: pos -> string
    -
    -     		-

    Convert a position to a string

    - - -
    - - - stringOfRange arg1 - -
    - Signature: range -> string
    -
    -     		-

    Convert a range to a string

    - - -
    - - - trimRangeToLine arg1 - -
    - Signature: range -> range
    -
    -     		-

    Reduce a range so it only covers a line

    - - -
    - - - unionRanges arg1 arg2 - -
    - Signature: range -> range -> range
    -
    -     		-

    Union two ranges, taking their first occurring start position and last occurring end position

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-referenceresolver-resolutionenvironment.html b/docs/reference/fsharp-compiler-referenceresolver-resolutionenvironment.html deleted file mode 100644 index 750433247a..0000000000 --- a/docs/reference/fsharp-compiler-referenceresolver-resolutionenvironment.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - ResolutionEnvironment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ResolutionEnvironment

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ReferenceResolver -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - CompilationAndEvaluation - -
    - Signature:
    -
    -     		-

    Indicates a script or source being dynamically compiled and executed. Uses implementation assemblies.

    - - -
    - - - EditingOrCompilation(isEditing) - -
    - Signature: bool
    -
    -     		-

    Indicates a script or source being edited or compiled. Uses reference assemblies (not implementation assemblies).

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-referenceresolver-resolvedfile.html b/docs/reference/fsharp-compiler-referenceresolver-resolvedfile.html deleted file mode 100644 index c1f7dd2c2b..0000000000 --- a/docs/reference/fsharp-compiler-referenceresolver-resolvedfile.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - ResolvedFile - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ResolvedFile

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ReferenceResolver -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - baggage - -
    - Signature: string
    -
    -     		-

    Round-tripped baggage

    - - -
    - - - itemSpec - -
    - Signature: string
    -
    -     		-

    Item specification.

    - - -
    - - - prepareToolTip - -
    - Signature: string * string -> string
    -
    -     		-

    Prepare textual information about where the assembly was resolved from, used for tooltip output

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-referenceresolver-resolver.html b/docs/reference/fsharp-compiler-referenceresolver-resolver.html deleted file mode 100644 index 46d8aa38fe..0000000000 --- a/docs/reference/fsharp-compiler-referenceresolver-resolver.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - Resolver - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Resolver

    -

    - Namespace: FSharp.Compiler
    - Parent Module: ReferenceResolver -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DotNetFrameworkReferenceAssembliesRootDirectory(...) - -
    - Signature: string
    - Modifiers: abstract
    -
    -     		-

    Get the Reference Assemblies directory for the .NET Framework (on Windows) -This is added to the default resolution path for -design-time compilations.

    - - -

    CompiledName: get_DotNetFrameworkReferenceAssembliesRootDirectory

    -
    - - - HighestInstalledNetFrameworkVersion() - -
    - Signature: unit -> string
    - Modifiers: abstract
    -
    -     		-

    Get the "v4.5.1"-style moniker for the highest installed .NET Framework version. -This is the value passed back to Resolve if no explicit "mscorlib" has been given.

    -

    Note: If an explicit "mscorlib" is given, then --noframework is being used, and the whole ReferenceResolver logic is essentially -unused. However in the future an option may be added to allow an explicit specification of -a .NET Framework version to use for scripts.

    - - -
    - - - Resolve(...) - -
    - Signature: (resolutionEnvironment:ResolutionEnvironment * references:(string * string) [] * targetFrameworkVersion:string * targetFrameworkDirectories:string list * targetProcessorArchitecture:string * fsharpCoreDir:string * explicitIncludeDirs:string list * implicitIncludeDir:string * logMessage:(string -> unit) * logDiagnostic:(bool -> string -> string -> unit)) -> ResolvedFile []
    - Modifiers: abstract
    -
    -     		-

    Perform assembly resolution on the given references under the given conditions

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-referenceresolver.html b/docs/reference/fsharp-compiler-referenceresolver.html deleted file mode 100644 index a438905c29..0000000000 --- a/docs/reference/fsharp-compiler-referenceresolver.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - ReferenceResolver - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ReferenceResolver

    -

    - Namespace: FSharp.Compiler
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - ResolutionEnvironment -
    - ResolvedFile -
    - Resolver -
    - -
    - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontentprovider.html b/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontentprovider.html deleted file mode 100644 index ddf5dbc60d..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontentprovider.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - AssemblyContentProvider - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    AssemblyContentProvider

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Provides assembly content.

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - getAssemblyContent (...) - -
    - Signature: withCache:((IAssemblyContentCache -> AssemblySymbol list) -> AssemblySymbol list) -> contentType:AssemblyContentType -> fileName:string option -> assemblies:FSharpAssembly list -> AssemblySymbol list
    -
    -     		-

    Returns (possibly cached) assembly content.

    - - -
    - - - getAssemblySignatureContent arg1 arg2 - -
    - Signature: AssemblyContentType -> FSharpAssemblySignature -> AssemblySymbol list
    -
    -     		-

    Given a FSharpAssemblySignature, returns assembly content.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontenttype.html b/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontenttype.html deleted file mode 100644 index 70b20db92a..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontenttype.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - AssemblyContentType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    AssemblyContentType

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Assembly content type.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Full - -
    - Signature:
    -
    -     		-

    All assembly content.

    - - -
    - - - Public - -
    - Signature:
    -
    -     		-

    Public assembly content only.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-assemblypath.html b/docs/reference/fsharp-compiler-sourcecodeservices-assemblypath.html deleted file mode 100644 index a356a4a1cf..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-assemblypath.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - AssemblyPath - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    AssemblyPath

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Assembly path.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Chars(arg1) - -
    - Signature: int -> char
    -
    -     		- -
    - - - Length - -
    - Signature: int
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-assemblysymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-assemblysymbol.html deleted file mode 100644 index 36a2797ccd..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-assemblysymbol.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - AssemblySymbol - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    AssemblySymbol

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents type, module, member, function or value in a compiled assembly.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - AutoOpenParent - -
    - Signature: Idents option
    -
    -     		-

    Parent module that has AutoOpen attribute.

    - - -
    - - - CleanedIdents - -
    - Signature: Idents
    -
    -     		-

    Entity name parts with removed module suffixes (Ns.M1Module.M2Module.M3.entity -> Ns.M1.M2.M3.entity) -and replaced compiled names with display names (FSharpEntity.DisplayName, FSharpValueOrFucntion.DisplayName). -Note: all parts are cleaned, not the last one.

    - - -
    - - - FullName - -
    - Signature: string
    -
    -     		-

    Full entity name as it's seen in compiled code (raw FSharpEntity.FullName, FSharpValueOrFunction.FullName).

    - - -
    - - - Kind - -
    - Signature: LookupType -> EntityKind
    -
    -     		-

    Function that returns EntityKind based of given LookupKind.

    - - -
    - - - Namespace - -
    - Signature: Idents option
    -
    -     		-

    FSharpEntity.Namespace.

    - - -
    - - - NearestRequireQualifiedAccessParent - -
    - Signature: Idents option
    -
    -     		-

    The most narrative parent module that has RequireQualifiedAccess attribute.

    - - -
    - - - Symbol - -
    - Signature: FSharpSymbol
    -
    -     		- -
    - - - TopRequireQualifiedAccessParent - -
    - Signature: Idents option
    -
    -     		-

    Parent module that has the largest scope and has RequireQualifiedAccess attribute.

    - - -
    - - - UnresolvedSymbol - -
    - Signature: UnresolvedSymbol
    -
    -     		-

    Cache display name and namespace, used for completion.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-astvisitorbase-1.html b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-astvisitorbase-1.html deleted file mode 100644 index fa629bffb3..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-astvisitorbase-1.html +++ /dev/null @@ -1,403 +0,0 @@ - - - - - AstVisitorBase<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    AstVisitorBase<'T>

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: AstTraversal -

    -
    -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> AstVisitorBase<'T>
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - VisitBinding(arg1, arg2) - -
    - Signature: ((SynBinding -> 'T option) * SynBinding) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitBinding allows overriding binding behavior (note: by default it would defaultTraverse expression)

    - - -
    - - - VisitComponentInfo(arg1) - -
    - Signature: SynComponentInfo -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitComponentInfo allows overriding behavior when visiting type component infos

    - - -
    - - - VisitExpr(arg1, arg2, arg3, arg4) - -
    - Signature: (TraversePath * (SynExpr -> 'T option) * (SynExpr -> 'T option) * SynExpr) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitExpr(path, traverseSynExpr, defaultTraverse, expr) -controls the behavior when a SynExpr is reached; it can just do -defaultTraverse(expr) if you have no special logic for this node, and want the default processing to pick which sub-node to dive deeper into -or can inject non-default behavior, which might incorporate: -traverseSynExpr(subExpr) to recurse deeper on some particular sub-expression based on your own logic -path helps to track AST nodes that were passed during traversal

    - - -
    - - - VisitHashDirective(arg1) - -
    - Signature: range -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitHashDirective allows overriding behavior when visiting hash directives in FSX scripts, like #r, #load and #I.

    - - -
    - - - VisitImplicitInherit(...) - -
    - Signature: ((SynExpr -> 'T option) * SynType * SynExpr * range) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitImplicitInherit(defaultTraverse,ty,expr,m), defaults to just visiting expr

    - - -
    - - - VisitInheritSynMemberDefn(...) - -
    - Signature: (SynComponentInfo * SynTypeDefnKind * SynType * SynMemberDefns * range) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitInheritSynMemberDefn allows overriding inherit behavior (by default do nothing)

    - - -
    - - - VisitInterfaceSynMemberDefnType(arg1) - -
    - Signature: SynType -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitInterfaceSynMemberDefnType allows overriding behavior for visiting interface member in types (by default - do nothing)

    - - -
    - - - VisitLetOrUse(arg1, arg2, arg3, arg4) - -
    - Signature: (TraversePath * (SynBinding -> 'T option) * SynBinding list * range) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitLetOrUse allows overriding behavior when visiting module or local let or use bindings

    - - -
    - - - VisitMatchClause(arg1, arg2) - -
    - Signature: ((SynMatchClause -> 'T option) * SynMatchClause) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitMatchClause allows overriding clause behavior (note: by default it would defaultTraverse expression)

    - - -
    - - - VisitModuleDecl(arg1, arg2) - -
    - Signature: ((SynModuleDecl -> 'T option) * SynModuleDecl) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitModuleDecl allows overriding module declaration behavior

    - - -
    - - - VisitModuleOrNamespace(arg1) - -
    - Signature: SynModuleOrNamespace -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitModuleOrNamespace allows overriding behavior when visiting module or namespaces

    - - -
    - - - VisitPat(arg1, arg2) - -
    - Signature: ((SynPat -> 'T option) * SynPat) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitPat allows overriding behavior when visiting patterns

    - - -
    - - - VisitRecordField(arg1, arg2, arg3) - -
    - Signature: (TraversePath * SynExpr option * LongIdentWithDots option) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitRecordField allows overriding behavior when visiting l.h.s. of constructed record instances

    - - -
    - - - VisitSimplePats(arg1) - -
    - Signature: (SynSimplePat list) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitType allows overriding behavior when visiting simple pats

    - - -
    - - - VisitType(arg1, arg2) - -
    - Signature: ((SynType -> 'T option) * SynType) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitType allows overriding behavior when visiting type hints (x: ..., etc.)

    - - -
    - - - VisitTypeAbbrev(arg1, arg2) - -
    - Signature: (SynType * range) -> 'T option
    - Modifiers: abstract
    -
    -     		-

    VisitTypeAbbrev(ty,m), defaults to ignoring this leaf of the AST

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversepath.html b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversepath.html deleted file mode 100644 index 87809a78ce..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversepath.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - TraversePath - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    TraversePath

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: AstTraversal -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Head - -
    - Signature: TraverseStep
    -
    -     		- -

    CompiledName: get_Head

    -
    - - - IsEmpty - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsEmpty

    -
    - - - [index] - -
    - Signature: index:int -> TraverseStep
    -
    -     		- -

    CompiledName: get_Item

    -
    - - - Length - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_Length

    -
    - - - Tail - -
    - Signature: TraverseStep list
    -
    -     		- -

    CompiledName: get_Tail

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: TraverseStep list
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversestep.html b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversestep.html deleted file mode 100644 index 439f8f2975..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversestep.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - TraverseStep - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    TraverseStep

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: AstTraversal -

    -
    -

    used to track route during traversal AST

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Binding(SynBinding) - -
    - Signature: SynBinding
    -
    -     		- -
    - - - Expr(SynExpr) - -
    - Signature: SynExpr
    -
    -     		- -
    - - - MatchClause(SynMatchClause) - -
    - Signature: SynMatchClause
    -
    -     		- -
    - - - MemberDefn(SynMemberDefn) - -
    - Signature: SynMemberDefn
    -
    -     		- -
    - - - Module(SynModuleDecl) - -
    - Signature: SynModuleDecl
    -
    -     		- -
    - - - ModuleOrNamespace(SynModuleOrNamespace) - -
    - Signature: SynModuleOrNamespace
    -
    -     		- -
    - - - TypeDefn(SynTypeDefn) - -
    - Signature: SynTypeDefn
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal.html b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal.html deleted file mode 100644 index 464749c161..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - AstTraversal - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    AstTraversal

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A range of utility functions to assist with traversing an AST

    - -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - AstVisitorBase<'T> -
    - TraversePath -
    - TraverseStep -

    used to track route during traversal AST

    - -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - dive node range project - -
    - Signature: node:'d -> range:'e -> project:('d -> 'f) -> 'e * (unit -> 'f)
    - Type parameters: 'd, 'e, 'f
    -     		- -
    - - - pick (...) - -
    - Signature: pos:pos -> outerRange:range -> _debugObj:obj -> diveResults:(range * (unit -> 'c option)) list -> 'c option
    - Type parameters: 'c
    -     		- -
    - - - rangeContainsPosEdgesExclusive m1 p - -
    - Signature: m1:range -> p:pos -> bool
    -
    -     		- -
    - - - rangeContainsPosLeftEdgeInclusive m1 p - -
    - Signature: m1:range -> p:pos -> bool
    -
    -     		- -
    - - - Traverse (pos, parseTree, visitor) - -
    - Signature: (pos:pos * parseTree:ParsedInput * visitor:AstVisitorBase<'T>) -> 'T option
    - Type parameters: 'T
    -     		-

    traverse an implementation file walking all the way down to SynExpr or TypeAbbrev at a particular location

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-basicpatterns.html b/docs/reference/fsharp-compiler-sourcecodeservices-basicpatterns.html deleted file mode 100644 index 0397865046..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-basicpatterns.html +++ /dev/null @@ -1,876 +0,0 @@ - - - - - BasicPatterns - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    BasicPatterns

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A collection of active patterns to analyze expressions

    - -
    - - - -

    Active patterns

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Active patternDescription
    - - - ( |AddressOf|_| ) arg1 - -
    - Signature: FSharpExpr -> FSharpExpr option
    -
    -     		-

    Matches expressions which take the address of a location

    - - -

    CompiledName: |AddressOf|_|

    -
    - - - ( |AddressSet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    -
    -     		-

    Matches expressions which set the contents of an address

    - - -

    CompiledName: |AddressSet|_|

    -
    - - - ( |AnonRecordGet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpType * int) option
    -
    -     		-

    Matches expressions getting a field from an anonymous record. The integer represents the -index into the sorted fields of the anonymous record.

    - - -

    CompiledName: |AnonRecordGet|_|

    -
    - - - ( |Application|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpType list * FSharpExpr list) option
    -
    -     		-

    Matches expressions which are the application of function values

    - - -

    CompiledName: |Application|_|

    -
    - - - ( |BaseValue|_| ) arg1 - -
    - Signature: FSharpExpr -> FSharpType option
    -
    -     		-

    Matches expressions which are uses of the 'base' value

    - - -

    CompiledName: |BaseValue|_|

    -
    - - - ( |Call|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr option * FSharpMemberOrFunctionOrValue * FSharpType list * FSharpType list * FSharpExpr list) option
    -
    -     		-

    Matches expressions which are calls to members or module-defined functions. When calling curried functions and members the -arguments are collapsed to a single collection of arguments, as done in the compiled version of these.

    - - -

    CompiledName: |Call|_|

    -
    - - - ( |Coerce|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * FSharpExpr) option
    -
    -     		-

    Matches expressions which coerce the type of a value

    - - -

    CompiledName: |Coerce|_|

    -
    - - - ( |Const|_| ) arg1 - -
    - Signature: FSharpExpr -> (obj * FSharpType) option
    -
    -     		-

    Matches constant expressions, including signed and unsigned integers, strings, characters, booleans, arrays -of bytes and arrays of unit16.

    - - -

    CompiledName: |Const|_|

    -
    - - - ( |DecisionTree|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * (FSharpMemberOrFunctionOrValue list * FSharpExpr) list) option
    -
    -     		-

    Matches expressions with a decision expression, each branch of which ends in DecisionTreeSuccess pasing control and values to one of the targets.

    - - -

    CompiledName: |DecisionTree|_|

    -
    - - - ( |DecisionTreeSuccess|_| ) arg1 - -
    - Signature: FSharpExpr -> (int * FSharpExpr list) option
    -
    -     		-

    Special expressions at the end of a conditional decision structure in the decision expression node of a DecisionTree . -The given expressions are passed as values to the decision tree target.

    - - -

    CompiledName: |DecisionTreeSuccess|_|

    -
    - - - ( |DefaultValue|_| ) arg1 - -
    - Signature: FSharpExpr -> FSharpType option
    -
    -     		-

    Matches default-value expressions, including null expressions

    - - -

    CompiledName: |DefaultValue|_|

    -
    - - - ( |FastIntegerForLoop|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpExpr * FSharpExpr * bool) option
    -
    -     		-

    Matches fast-integer loops (up or down)

    - - -

    CompiledName: |FastIntegerForLoop|_|

    -
    - - - ( |FSharpFieldGet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr option * FSharpType * FSharpField) option
    -
    -     		-

    Matches expressions which get a field from a record or class

    - - -

    CompiledName: |FSharpFieldGet|_|

    -
    - - - ( |FSharpFieldSet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr option * FSharpType * FSharpField * FSharpExpr) option
    -
    -     		-

    Matches expressions which set a field in a record or class

    - - -

    CompiledName: |FSharpFieldSet|_|

    -
    - - - ( |IfThenElse|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpExpr * FSharpExpr) option
    -
    -     		-

    Matches expressions which are conditionals

    - - -

    CompiledName: |IfThenElse|_|

    -
    - - - ( |ILAsm|_| ) arg1 - -
    - Signature: FSharpExpr -> (string * FSharpType list * FSharpExpr list) option
    -
    -     		-

    Matches expressions which are IL assembly code

    - - -

    CompiledName: |ILAsm|_|

    -
    - - - ( |ILFieldGet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr option * FSharpType * string) option
    -
    -     		-

    Matches expressions which fetch a field from a .NET type

    - - -

    CompiledName: |ILFieldGet|_|

    -
    - - - ( |ILFieldSet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr option * FSharpType * string * FSharpExpr) option
    -
    -     		-

    Matches expressions which set a field in a .NET type

    - - -

    CompiledName: |ILFieldSet|_|

    -
    - - - ( |Lambda|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpExpr) option
    -
    -     		-

    Matches expressions which are lambda abstractions

    - - -

    CompiledName: |Lambda|_|

    -
    - - - ( |Let|_| ) arg1 - -
    - Signature: FSharpExpr -> ((FSharpMemberOrFunctionOrValue * FSharpExpr) * FSharpExpr) option
    -
    -     		-

    Matches expressions which are let definitions

    - - -

    CompiledName: |Let|_|

    -
    - - - ( |LetRec|_| ) arg1 - -
    - Signature: FSharpExpr -> ((FSharpMemberOrFunctionOrValue * FSharpExpr) list * FSharpExpr) option
    -
    -     		-

    Matches expressions which are let-rec definitions

    - - -

    CompiledName: |LetRec|_|

    -
    - - - ( |NewAnonRecord|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * FSharpExpr list) option
    -
    -     		-

    Matches anonymous record expressions

    - - -

    CompiledName: |NewAnonRecord|_|

    -
    - - - ( |NewArray|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * FSharpExpr list) option
    -
    -     		-

    Matches array expressions

    - - -

    CompiledName: |NewArray|_|

    -
    - - - ( |NewDelegate|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * FSharpExpr) option
    -
    -     		-

    Matches expressions which create an instance of a delegate type

    - - -

    CompiledName: |NewDelegate|_|

    -
    - - - ( |NewObject|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpType list * FSharpExpr list) option
    -
    -     		-

    Matches expressions which are calls to object constructors

    - - -

    CompiledName: |NewObject|_|

    -
    - - - ( |NewRecord|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * FSharpExpr list) option
    -
    -     		-

    Matches record expressions

    - - -

    CompiledName: |NewRecord|_|

    -
    - - - ( |NewTuple|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * FSharpExpr list) option
    -
    -     		-

    Matches tuple expressions

    - - -

    CompiledName: |NewTuple|_|

    -
    - - - ( |NewUnionCase|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * FSharpUnionCase * FSharpExpr list) option
    -
    -     		-

    Matches expressions which create an object corresponding to a union case

    - - -

    CompiledName: |NewUnionCase|_|

    -
    - - - ( |ObjectExpr|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * FSharpExpr * FSharpObjectExprOverride list * (FSharpType * FSharpObjectExprOverride list) list) option
    -
    -     		-

    Matches object expressions, returning the base type, the base call, the overrides and the interface implementations

    - - -

    CompiledName: |ObjectExpr|_|

    -
    - - - ( |Quote|_| ) arg1 - -
    - Signature: FSharpExpr -> FSharpExpr option
    -
    -     		-

    Matches expressions which are quotation literals

    - - -

    CompiledName: |Quote|_|

    -
    - - - ( |Sequential|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    -
    -     		-

    Matches sequential expressions

    - - -

    CompiledName: |Sequential|_|

    -
    - - - ( |ThisValue|_| ) arg1 - -
    - Signature: FSharpExpr -> FSharpType option
    -
    -     		-

    Matches expressions which are uses of the 'this' value

    - - -

    CompiledName: |ThisValue|_|

    -
    - - - ( |TraitCall|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType list * string * MemberFlags * FSharpType list * FSharpType list * FSharpExpr list) option
    -
    -     		-

    Matches expressions for an unresolved call to a trait

    - - -

    CompiledName: |TraitCall|_|

    -
    - - - ( |TryFinally|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    -
    -     		-

    Matches try/finally expressions

    - - -

    CompiledName: |TryFinally|_|

    -
    - - - ( |TryWith|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpMemberOrFunctionOrValue * FSharpExpr * FSharpMemberOrFunctionOrValue * FSharpExpr) option
    -
    -     		-

    Matches try/with expressions

    - - -

    CompiledName: |TryWith|_|

    -
    - - - ( |TupleGet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * int * FSharpExpr) option
    -
    -     		-

    Matches expressions which get a value from a tuple

    - - -

    CompiledName: |TupleGet|_|

    -
    - - - ( |TypeLambda|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpGenericParameter list * FSharpExpr) option
    -
    -     		-

    Matches expressions which are type abstractions

    - - -

    CompiledName: |TypeLambda|_|

    -
    - - - ( |TypeTest|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpType * FSharpExpr) option
    -
    -     		-

    Matches expressions which test the runtime type of a value

    - - -

    CompiledName: |TypeTest|_|

    -
    - - - ( |UnionCaseGet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase * FSharpField) option
    -
    -     		-

    Matches expressions which get a field from a union case

    - - -

    CompiledName: |UnionCaseGet|_|

    -
    - - - ( |UnionCaseSet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase * FSharpField * FSharpExpr) option
    -
    -     		-

    Matches expressions which set a field from a union case (only used in FSharp.Core itself)

    - - -

    CompiledName: |UnionCaseSet|_|

    -
    - - - ( |UnionCaseTag|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpType) option
    -
    -     		-

    Matches expressions which gets the tag for a union case

    - - -

    CompiledName: |UnionCaseTag|_|

    -
    - - - ( |UnionCaseTest|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase) option
    -
    -     		-

    Matches expressions which test if an expression corresponds to a particular union case

    - - -

    CompiledName: |UnionCaseTest|_|

    -
    - - - ( |Value|_| ) arg1 - -
    - Signature: FSharpExpr -> FSharpMemberOrFunctionOrValue option
    -
    -     		-

    Matches expressions which are uses of values

    - - -

    CompiledName: |Value|_|

    -
    - - - ( |ValueSet|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpExpr) option
    -
    -     		-

    Matches expressions which set the contents of a mutable variable

    - - -

    CompiledName: |ValueSet|_|

    -
    - - - ( |WhileLoop|_| ) arg1 - -
    - Signature: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    -
    -     		-

    Matches while loops

    - - -

    CompiledName: |WhileLoop|_|

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironment.html b/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironment.html deleted file mode 100644 index 8a1311854e..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironment.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - CompilerEnvironment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompilerEnvironment

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Information about the compilation environment

    - -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - BinFolderOfDefaultFSharpCompiler(...) - -
    - Signature: (probePoint:string option) -> string option
    -
    -     		-

    The default location of FSharp.Core.dll and fsc.exe based on the version of fsc.exe that is running

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html b/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html deleted file mode 100644 index 03b068251b..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - CompilerEnvironment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompilerEnvironment

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Information about the compilation environment

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - DefaultReferencesForOrphanSources (...) - -
    - Signature: assumeDotNetFramework:bool -> string list
    -
    -     		-

    These are the names of assemblies that should be referenced for .fs or .fsi files that -are not associated with a project.

    - - -
    - - - GetCompilationDefinesForEditing (...) - -
    - Signature: parsingOptions:FSharpParsingOptions -> string list
    -
    -     		-

    Return the compilation defines that should be used when editing the given file.

    - - -
    - - - IsCheckerSupportedSubcategory arg1 - -
    - Signature: string -> bool
    -
    -     		-

    Return true if this is a subcategory of error or warning message that the language service can emit

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-completioncontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-completioncontext.html deleted file mode 100644 index b637d6ad36..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-completioncontext.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - CompletionContext - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompletionContext

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AttributeApplication - -
    - Signature:
    -
    -     		- -
    - - - Inherit(...) - -
    - Signature: InheritanceContext * CompletionPath
    -
    -     		-

    completing something after the inherit keyword

    - - -
    - - - Invalid - -
    - Signature:
    -
    -     		-

    completion context cannot be determined due to errors

    - - -
    - - - OpenDeclaration - -
    - Signature:
    -
    -     		- -
    - - - ParameterList(pos,HashSet<string>) - -
    - Signature: pos * HashSet<string>
    -
    -     		-

    completing named parameters\setters in parameter list of constructor\method calls -end of name ast node * list of properties\parameters that were already set

    - - -
    - - - PatternType - -
    - Signature:
    -
    -     		-

    completing pattern type (e.g. foo (x: |))

    - - -
    - - - RangeOperator - -
    - Signature:
    -
    -     		- -
    - - - RecordField(RecordContext) - -
    - Signature: RecordContext
    -
    -     		-

    completing records field

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-completionitemkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-completionitemkind.html deleted file mode 100644 index 78b7ba7857..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-completionitemkind.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - CompletionItemKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompletionItemKind

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Argument - -
    - Signature:
    -
    -     		- -
    - - - CustomOperation - -
    - Signature:
    -
    -     		- -
    - - - Event - -
    - Signature:
    -
    -     		- -
    - - - Field - -
    - Signature:
    -
    -     		- -
    - - - Method(isExtension) - -
    - Signature: bool
    -
    -     		- -
    - - - Other - -
    - Signature:
    -
    -     		- -
    - - - Property - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-completionpath.html b/docs/reference/fsharp-compiler-sourcecodeservices-completionpath.html deleted file mode 100644 index 37824152bf..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-completionpath.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - CompletionPath - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompletionPath

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-debuggerenvironment.html b/docs/reference/fsharp-compiler-sourcecodeservices-debuggerenvironment.html deleted file mode 100644 index 1763d3b8f6..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-debuggerenvironment.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - DebuggerEnvironment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    DebuggerEnvironment

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Information about the debugging environment

    - -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - GetLanguageID () - -
    - Signature: unit -> Guid
    -
    -     		-

    Return the language ID, which is the expression evaluator id that the -debugger will use.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-entity.html b/docs/reference/fsharp-compiler-sourcecodeservices-entity.html deleted file mode 100644 index f9ab6baac1..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-entity.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - Entity - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Entity

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Helper data structure representing a symbol, sutable for implementing unresolved identifiers resolution code fixes.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - FullRelativeName - -
    - Signature: StringLongIdent
    -
    -     		-

    Full name, relative to the current scope.

    - - -
    - - - LastIdent - -
    - Signature: string
    -
    -     		-

    Last part of the entity's full name.

    - - -
    - - - Name - -
    - Signature: StringLongIdent
    -
    -     		-

    Full display name (i.e. last ident plus modules with RequireQualifiedAccess attribute prefixed).

    - - -
    - - - Namespace - -
    - Signature: StringLongIdent option
    -
    -     		-

    Namespace that is needed to open to make the entity resolvable in the current scope.

    - - -
    - - - Qualifier - -
    - Signature: StringLongIdent
    -
    -     		-

    Ident parts needed to append to the current ident to make it resolvable in current scope.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-entitycache.html b/docs/reference/fsharp-compiler-sourcecodeservices-entitycache.html deleted file mode 100644 index 59c89812a5..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-entitycache.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - EntityCache - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    EntityCache

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Thread safe wrapper over IAssemblyContentCache.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new() - -
    - Signature: unit -> EntityCache
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Clear() - -
    - Signature: unit -> unit
    -
    -     		-

    Clears the cache.

    - - -
    - - - Locking(arg1) - -
    - Signature: ((IAssemblyContentCache -> 'T)) -> 'T
    - Type parameters: 'T
    -     		-

    Performs an operation on the cache in thread safe manner.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-entitykind.html b/docs/reference/fsharp-compiler-sourcecodeservices-entitykind.html deleted file mode 100644 index ec206f6ff7..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-entitykind.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - EntityKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    EntityKind

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Attribute - -
    - Signature:
    -
    -     		- -
    - - - FunctionOrValue(isActivePattern) - -
    - Signature: bool
    -
    -     		- -
    - - - Module(ModuleKind) - -
    - Signature: ModuleKind
    -
    -     		- -
    - - - Type - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-extensions.html b/docs/reference/fsharp-compiler-sourcecodeservices-extensions.html deleted file mode 100644 index 8f71c97da6..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-extensions.html +++ /dev/null @@ -1,309 +0,0 @@ - - - - - Extensions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Extensions

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - -

    Type extensions

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Type extensionDescription
    - - - FullTypeSafe - -
    - Signature: FSharpType option
    -
    -     		-

    Safe version of FullType.

    - - -

    CompiledName: FSharpMemberOrFunctionOrValue.get_FullTypeSafe

    -
    - - - FullTypeSafe - -
    - Signature: FSharpType option
    -
    -     		-

    Safe version of FullType.

    - - -

    CompiledName: FSharpMemberOrFunctionOrValue.get_FullTypeSafe

    -
    - - - PublicNestedEntities - -
    - Signature: seq<FSharpEntity>
    -
    -     		-

    Public nested entities (methods, functions, values, nested modules).

    - - -

    CompiledName: FSharpEntity.get_PublicNestedEntities

    -
    - - - PublicNestedEntities - -
    - Signature: seq<FSharpEntity>
    -
    -     		-

    Public nested entities (methods, functions, values, nested modules).

    - - -

    CompiledName: FSharpEntity.get_PublicNestedEntities

    -
    - - - TryGetEntities() - -
    - Signature: unit -> seq<FSharpEntity>
    -
    -     		-

    Safe version of Entities.

    - - -

    CompiledName: FSharpAssemblySignature.TryGetEntities

    -
    - - - TryGetFullCompiledName() - -
    - Signature: unit -> string option
    -
    -     		-

    Safe version of CompiledName.

    - - -

    CompiledName: FSharpEntity.TryGetFullCompiledName

    -
    - - - TryGetFullCompiledOperatorNameIdents() - -
    - Signature: unit -> Idents option
    -
    -     		-

    Full operator compiled name.

    - - -

    CompiledName: FSharpMemberOrFunctionOrValue.TryGetFullCompiledOperatorNameIdents

    -
    - - - TryGetFullDisplayName() - -
    - Signature: unit -> string option
    -
    -     		-

    Safe version of DisplayName.

    - - -

    CompiledName: FSharpEntity.TryGetFullDisplayName

    -
    - - - TryGetFullDisplayName() - -
    - Signature: unit -> string option
    -
    -     		-

    Full name with last part replaced with display name.

    - - -

    CompiledName: FSharpMemberOrFunctionOrValue.TryGetFullDisplayName

    -
    - - - TryGetFullName() - -
    - Signature: unit -> string option
    -
    -     		-

    Safe version of FullName.

    - - -

    CompiledName: FSharpEntity.TryGetFullName

    -
    - - - TryGetMembersFunctionsAndValues - -
    - Signature: IList<FSharpMemberOrFunctionOrValue>
    -
    -     		-

    Safe version of GetMembersFunctionsAndValues.

    - - -

    CompiledName: FSharpEntity.get_TryGetMembersFunctionsAndValues

    -
    - - - TryGetMembersFunctionsAndValues - -
    - Signature: IList<FSharpMemberOrFunctionOrValue>
    -
    -     		-

    Safe version of GetMembersFunctionsAndValues.

    - - -

    CompiledName: FSharpEntity.get_TryGetMembersFunctionsAndValues

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-externalsymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-externalsymbol.html deleted file mode 100644 index 984abe1f31..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-externalsymbol.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - ExternalSymbol - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ExternalSymbol

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a symbol in an external (non F#) assembly

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Constructor(typeName,args) - -
    - Signature: string * ParamTypeSymbol list
    -
    -     		- -
    - - - Event(typeName,name) - -
    - Signature: string * string
    -
    -     		- -
    - - - Field(typeName,name) - -
    - Signature: string * string
    -
    -     		- -
    - - - Method(...) - -
    - Signature: string * string * ParamTypeSymbol list * int
    -
    -     		- -
    - - - Property(typeName,name) - -
    - Signature: string * string
    -
    -     		- -
    - - - Type(fullName) - -
    - Signature: string
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-externaltype.html b/docs/reference/fsharp-compiler-sourcecodeservices-externaltype.html deleted file mode 100644 index 35aa475c1a..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-externaltype.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - ExternalType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ExternalType

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a type in an external (non F#) assembly.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Array(inner) - -
    - Signature: ExternalType
    -
    -     		-

    Array of type that is defined in non-F# assembly.

    - - -
    - - - Pointer(inner) - -
    - Signature: ExternalType
    -
    -     		-

    Pointer defined in non-F# assembly.

    - - -
    - - - Type(fullName,genericArgs) - -
    - Signature: string * ExternalType list
    -
    -     		-

    Type defined in non-F# assembly.

    - - -
    - - - TypeVar(typeName) - -
    - Signature: string
    -
    -     		-

    Type variable defined in non-F# assembly.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-externaltypemodule.html b/docs/reference/fsharp-compiler-sourcecodeservices-externaltypemodule.html deleted file mode 100644 index b13a9e2a03..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-externaltypemodule.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ExternalType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ExternalType

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractparameter.html deleted file mode 100644 index 2e8fb87069..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractparameter.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - FSharpAbstractParameter - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpAbstractParameter

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a parameter in an abstract method of a class or interface

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Attributes - -
    - Signature: IList<FSharpAttribute>
    -
    -     		-

    The declared attributes of the parameter

    - - -

    CompiledName: get_Attributes

    -
    - - - IsInArg - -
    - Signature: bool
    -
    -     		-

    Indicate this is an in argument

    - - -

    CompiledName: get_IsInArg

    -
    - - - IsOptionalArg - -
    - Signature: bool
    -
    -     		-

    Indicate this is an optional argument

    - - -

    CompiledName: get_IsOptionalArg

    -
    - - - IsOutArg - -
    - Signature: bool
    -
    -     		-

    Indicate this is an out argument

    - - -

    CompiledName: get_IsOutArg

    -
    - - - Name - -
    - Signature: string option
    -
    -     		-

    The optional name of the parameter

    - - -

    CompiledName: get_Name

    -
    - - - Type - -
    - Signature: FSharpType
    -
    -     		-

    The declared or inferred type of the parameter

    - - -

    CompiledName: get_Type

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractsignature.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractsignature.html deleted file mode 100644 index 0e34712156..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractsignature.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - FSharpAbstractSignature - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpAbstractSignature

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the signature of an abstract slot of a class or interface

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AbstractArguments - -
    - Signature: IList<IList<FSharpAbstractParameter>>
    -
    -     		-

    Get the arguments of the abstract slot

    - - -

    CompiledName: get_AbstractArguments

    -
    - - - AbstractReturnType - -
    - Signature: FSharpType
    -
    -     		-

    Get the return type of the abstract slot

    - - -

    CompiledName: get_AbstractReturnType

    -
    - - - DeclaringType - -
    - Signature: FSharpType
    -
    -     		-

    Get the declaring type of the abstract slot

    - - -

    CompiledName: get_DeclaringType

    -
    - - - DeclaringTypeGenericParameters - -
    - Signature: IList<FSharpGenericParameter>
    -
    -     		-

    Get the generic arguments of the type defining the abstract slot

    - - -

    CompiledName: get_DeclaringTypeGenericParameters

    -
    - - - MethodGenericParameters - -
    - Signature: IList<FSharpGenericParameter>
    -
    -     		-

    Get the generic arguments of the abstract slot

    - - -

    CompiledName: get_MethodGenericParameters

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    Get the name of the abstract slot

    - - -

    CompiledName: get_Name

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibility.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibility.html deleted file mode 100644 index bf080ab8e0..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibility.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - FSharpAccessibility - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpAccessibility

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Indicates the accessibility of a symbol, as seen by the F# language

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - IsInternal - -
    - Signature: bool
    -
    -     		-

    Indicates the symbol has internal accessibility

    - - -

    CompiledName: get_IsInternal

    -
    - - - IsPrivate - -
    - Signature: bool
    -
    -     		-

    Indicates the symbol has private accessibility

    - - -

    CompiledName: get_IsPrivate

    -
    - - - IsPublic - -
    - Signature: bool
    -
    -     		-

    Indicates the symbol has public accessibility

    - - -

    CompiledName: get_IsPublic

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibilityrights.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibilityrights.html deleted file mode 100644 index 40872af3aa..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibilityrights.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - FSharpAccessibilityRights - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpAccessibilityRights

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the rights of a compilation to access symbols

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterncase.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterncase.html deleted file mode 100644 index 396090d6b8..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterncase.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - FSharpActivePatternCase - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpActivePatternCase

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A subtype of FSharpSymbol that represents a single case within an active pattern

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DeclarationLocation - -
    - Signature: range
    -
    -     		-

    The location of declaration of the active pattern case

    - - -

    CompiledName: get_DeclarationLocation

    -
    - - - Group - -
    - Signature: FSharpActivePatternGroup
    -
    -     		-

    The group of active pattern cases this belongs to

    - - -

    CompiledName: get_Group

    -
    - - - Index - -
    - Signature: int
    -
    -     		-

    Index of the case in the pattern group

    - - -

    CompiledName: get_Index

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    The name of the active pattern case

    - - -

    CompiledName: get_Name

    -
    - - - XmlDoc - -
    - Signature: IList<string>
    -
    -     		-

    Get the in-memory XML documentation for the active pattern case, used when code is checked in-memory

    - - -

    CompiledName: get_XmlDoc

    -
    - - - XmlDocSig - -
    - Signature: string
    -
    -     		-

    XML documentation signature for the active pattern case, used for .xml file lookup for compiled code

    - - -

    CompiledName: get_XmlDocSig

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterngroup.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterngroup.html deleted file mode 100644 index 19960e5e46..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterngroup.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - FSharpActivePatternGroup - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpActivePatternGroup

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents all cases within an active pattern

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DeclaringEntity - -
    - Signature: FSharpEntity option
    -
    -     		-

    Try to get the entity in which the active pattern is declared

    - - -

    CompiledName: get_DeclaringEntity

    -
    - - - IsTotal - -
    - Signature: bool
    -
    -     		-

    Indicate this is a total active pattern

    - - -

    CompiledName: get_IsTotal

    -
    - - - Name - -
    - Signature: string option
    -
    -     		-

    The whole group name

    - - -

    CompiledName: get_Name

    -
    - - - Names - -
    - Signature: IList<string>
    -
    -     		-

    The names of the active pattern cases

    - - -

    CompiledName: get_Names

    -
    - - - OverallType - -
    - Signature: FSharpType
    -
    -     		-

    Get the type indicating signature of the active pattern

    - - -

    CompiledName: get_OverallType

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpanonrecordtypedetails.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpanonrecordtypedetails.html deleted file mode 100644 index ef49f148d0..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpanonrecordtypedetails.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - FSharpAnonRecordTypeDetails - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpAnonRecordTypeDetails

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Assembly - -
    - Signature: FSharpAssembly
    -
    -     		-

    The assembly where the compiled form of the anonymous type is defined

    - - -

    CompiledName: get_Assembly

    -
    - - - CompiledName - -
    - Signature: string
    -
    -     		-

    The name of the compiled form of the anonymous type

    - - -

    CompiledName: get_CompiledName

    -
    - - - EnclosingCompiledTypeNames - -
    - Signature: string list
    -
    -     		-

    Names of any enclosing types of the compiled form of the anonymous type (if the anonymous type was defined as a nested type)

    - - -

    CompiledName: get_EnclosingCompiledTypeNames

    -
    - - - SortedFieldNames - -
    - Signature: string []
    -
    -     		-

    The sorted labels of the anonymous type

    - - -

    CompiledName: get_SortedFieldNames

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassembly.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassembly.html deleted file mode 100644 index 2c2165f083..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassembly.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - FSharpAssembly - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpAssembly

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents an assembly as seen by the F# language

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CodeLocation - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_CodeLocation

    -
    - - - Contents - -
    - Signature: FSharpAssemblySignature
    -
    -     		-

    The contents of the this assembly

    - - -

    CompiledName: get_Contents

    -
    - - - FileName - -
    - Signature: string option
    -
    -     		-

    The file name for the assembly, if any

    - - -

    CompiledName: get_FileName

    -
    - - - IsProviderGenerated - -
    - Signature: bool
    -
    -     		-

    Indicates if the assembly was generated by a type provider and is due for static linking

    - - -

    CompiledName: get_IsProviderGenerated

    -
    - - - QualifiedName - -
    - Signature: string
    -
    -     		-

    The qualified name of the assembly

    - - -

    CompiledName: get_QualifiedName

    -
    - - - SimpleName - -
    - Signature: string
    -
    -     		-

    The simple name for the assembly

    - - -

    CompiledName: get_SimpleName

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblycontents.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblycontents.html deleted file mode 100644 index d48ae9047f..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblycontents.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - FSharpAssemblyContents - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpAssemblyContents

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the definitional contents of an assembly, as seen by the F# language

    - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - ImplementationFiles - -
    - Signature: FSharpImplementationFileContents list
    -
    -     		-

    The contents of the implementation files in the assembly

    - - -

    CompiledName: get_ImplementationFiles

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblysignature.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblysignature.html deleted file mode 100644 index 464d297ae1..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblysignature.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - FSharpAssemblySignature - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpAssemblySignature

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents an inferred signature of part of an assembly as seen by the F# language

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Attributes - -
    - Signature: IList<FSharpAttribute>
    -
    -     		-

    Get the declared attributes for the assembly. -Only available when parsing an entire project.

    - - -

    CompiledName: get_Attributes

    -
    - - - Entities - -
    - Signature: IList<FSharpEntity>
    -
    -     		-

    The (non-nested) module and type definitions in this signature

    - - -

    CompiledName: get_Entities

    -
    - - - FindEntityByPath(arg1) - -
    - Signature: (string list) -> FSharpEntity option
    -
    -     		-

    Find entity using compiled names

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpattribute.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpattribute.html deleted file mode 100644 index bb3a07fb81..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpattribute.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - FSharpAttribute - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpAttribute

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a custom attribute attached to F# source code or a compiler .NET component

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AttributeType - -
    - Signature: FSharpEntity
    -
    -     		-

    The type of the attribute

    - - -

    CompiledName: get_AttributeType

    -
    - - - ConstructorArguments - -
    - Signature: IList<FSharpType * obj>
    -
    -     		-

    The arguments to the constructor for the attribute

    - - -

    CompiledName: get_ConstructorArguments

    -
    - - - Format(context) - -
    - Signature: context:FSharpDisplayContext -> string
    -
    -     		-

    Format the attribute using the rules of the given display context

    - - -
    - - - IsUnresolved - -
    - Signature: bool
    -
    -     		-

    Indicates if the attribute type is in an unresolved assembly

    - - -

    CompiledName: get_IsUnresolved

    -
    - - - NamedArguments - -
    - Signature: IList<FSharpType * string * bool * obj>
    -
    -     		-

    The named arguments for the attribute

    - - -

    CompiledName: get_NamedArguments

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpchecker.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpchecker.html deleted file mode 100644 index 8509827252..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpchecker.html +++ /dev/null @@ -1,899 +0,0 @@ - - - - - FSharpChecker - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpChecker

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Used to parse and check F# source code.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - BeforeBackgroundFileCheck - -
    - Signature: IEvent<string * obj option>
    -
    -     		-

    Notify the host that the logical type checking context for a file has now been updated internally -and that the file has become eligible to be re-typechecked for errors.

    -

    The event will be raised on a background thread.

    - - -

    CompiledName: get_BeforeBackgroundFileCheck

    -
    - - - CheckFileInProject(...) - -
    - Signature: (parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * textSnapshotInfo:obj option * userOpName:string option) -> Async<FSharpCheckFileAnswer>
    -
    -     		-

    Check a source code file, returning a handle to the results

    -

    Note: all files except the one being checked are read from the FileSystem API

    -

    Return FSharpCheckFileAnswer.Aborted if a parse tree was not available.

    - - -
    - - - CheckFileInProjectAllowingStaleCachedResults(...) - -
    - Signature: (parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * textSnapshotInfo:obj option * userOpName:string option) -> Async<FSharpCheckFileAnswer option>
    -
    -     		-

    Check a source code file, returning a handle to the results of the parse including -the reconstructed types in the file.All files except the one being checked are read from the FileSystem APINote: returns NoAntecedent if the background builder is not yet done preparing the type check context for the -file (e.g. loading references and parsing/checking files in the project that this file depends upon). -In this case, the caller can either retry, or wait for FileTypeCheckStateIsDirty to be raised for this file.

    - - -
    - - - CheckProjectInBackground(...) - -
    - Signature: (options:FSharpProjectOptions * userOpName:string option) -> unit
    -
    -     		-

    Set the project to be checked in the background. Overrides any previous call to CheckProjectInBackground

    - - -
    - - - ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients(...) - -
    - Signature: unit -> unit
    -
    -     		-

    Flush all caches and garbage collect

    - - -
    - - - Compile(...) - -
    - Signature: (ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * pdbFile:string option * executable:bool option * noframework:bool option * userOpName:string option) -> Async<FSharpErrorInfo [] * int>
    -
    -     		-

    TypeCheck and compile provided AST

    - - -
    - - - Compile(argv, userOpName) - -
    - Signature: (argv:string [] * userOpName:string option) -> Async<FSharpErrorInfo [] * int>
    -
    -     		-

    Compile using the given flags. Source files names are resolved via the FileSystem API. -The output file must be given by a -o flag. -The first argument is ignored and can just be "fsc.exe".

    - - -
    - - - CompileToDynamicAssembly(...) - -
    - Signature: (ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * debug:bool option * noframework:bool option * userOpName:string option) -> Async<FSharpErrorInfo [] * int * Assembly option>
    -
    -     		-

    TypeCheck and compile provided AST

    - - -
    - - - CompileToDynamicAssembly(...) - -
    - Signature: (otherFlags:string [] * execute:(TextWriter * TextWriter) option * userOpName:string option) -> Async<FSharpErrorInfo [] * int * Assembly option>
    -
    -     		-

    Compiles to a dynamic assembly using the given flags.

    -

    The first argument is ignored and can just be "fsc.exe".

    -

    Any source files names are resolved via the FileSystem API. An output file name must be given by a -o flag, but this will not -be written - instead a dynamic assembly will be created and loaded.

    -

    If the 'execute' parameter is given the entry points for the code are executed and -the given TextWriters are used for the stdout and stderr streams respectively. In this -case, a global setting is modified during the execution.

    - - -
    - - - CurrentQueueLength - -
    - Signature: int
    -
    -     		-

    Current queue length of the service, for debug purposes. -In addition, a single async operation or a step of a background build -may be in progress - such an operation is not counted in the queue length.

    - - -

    CompiledName: get_CurrentQueueLength

    -
    - - - FileChecked - -
    - Signature: IEvent<string * obj option>
    -
    -     		-

    Raised after a check of a file in the background analysis.

    -

    The event will be raised on a background thread.

    - - -

    CompiledName: get_FileChecked

    -
    - - - FileParsed - -
    - Signature: IEvent<string * obj option>
    -
    -     		-

    Raised after a parse of a file in the background analysis.

    -

    The event will be raised on a background thread.

    - - -

    CompiledName: get_FileParsed

    -
    - - - GetBackgroundCheckResultsForFileInProject(...) - -
    - Signature: (filename:string * options:FSharpProjectOptions * userOpName:string option) -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    -
    -     		-

    Like CheckFileInProject, but uses the existing results from the background builder.All files are read from the FileSystem API, including the file being checked.

    - - -
    - - - GetBackgroundParseResultsForFileInProject(...) - -
    - Signature: (filename:string * options:FSharpProjectOptions * userOpName:string option) -> Async<FSharpParseFileResults>
    -
    -     		-

    Like ParseFile, but uses results from the background builder.All files are read from the FileSystem API, including the file being checked.

    - - -
    - - - GetParsingOptionsFromCommandLineArgs(...) - -
    - Signature: (argv:string list * isInteractive:bool option) -> FSharpParsingOptions * FSharpErrorInfo list
    -
    -     		-

    Get the FSharpParsingOptions implied by a set of command line arguments.

    - - -
    - - - GetParsingOptionsFromCommandLineArgs(...) - -
    - Signature: (sourceFiles:string list * argv:string list * isInteractive:bool option) -> FSharpParsingOptions * FSharpErrorInfo list
    -
    -     		-

    Get the FSharpParsingOptions implied by a set of command line arguments and list of source files.

    - - -
    - - - GetParsingOptionsFromProjectOptions(...) - -
    - Signature: FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    -
    -     		-

    Get the FSharpParsingOptions implied by a FSharpProjectOptions.

    - - -
    - - - GetProjectOptionsFromCommandLineArgs(...) - -
    - Signature: (projectFileName:string * argv:string [] * loadedTimeStamp:DateTime option * extraProjectInfo:obj option) -> FSharpProjectOptions
    -
    -     		-

    Get the FSharpProjectOptions implied by a set of command line arguments.

    - - -
    - - - GetProjectOptionsFromScript(...) - -
    - Signature: (filename:string * source:string * loadedTimeStamp:DateTime option * otherFlags:string [] option * useFsiAuxLib:bool option * assumeDotNetFramework:bool option * extraProjectInfo:obj option * optionsStamp:int64 option * userOpName:string option) -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    -
    -     		-

    For a given script file, get the FSharpProjectOptions implied by the #load closure.All files are read from the FileSystem API, except the file being checked.

    - - -
    - - - ImplicitlyStartBackgroundWork() - -
    - Signature: unit -> bool
    -
    -     		-

    Get or set a flag which controls if background work is started implicitly.

    -

    If true, calls to CheckFileInProject implicitly start a background check of that project, replacing -any other background checks in progress. This is useful in IDE applications with spare CPU cycles as -it prepares the project analysis results for use. The default is 'true'.

    - - -

    CompiledName: set_ImplicitlyStartBackgroundWork

    -
    - - - ImplicitlyStartBackgroundWork() - -
    - Signature: unit -> unit
    -
    -     		-

    Get or set a flag which controls if background work is started implicitly.

    -

    If true, calls to CheckFileInProject implicitly start a background check of that project, replacing -any other background checks in progress. This is useful in IDE applications with spare CPU cycles as -it prepares the project analysis results for use. The default is 'true'.

    - - -

    CompiledName: get_ImplicitlyStartBackgroundWork

    -
    - - - InvalidateAll() - -
    - Signature: unit -> unit
    -
    -     		-

    This function is called when the entire environment is known to have changed for reasons not encoded in the ProjectOptions of any project/compilation.

    - - -
    - - - InvalidateConfiguration(...) - -
    - Signature: (options:FSharpProjectOptions * startBackgroundCompileIfAlreadySeen:bool option * userOpName:string option) -> unit
    -
    -     		-

    This function is called when the configuration is known to have changed for reasons not encoded in the ProjectOptions. -For example, dependent references may have been deleted or created. -Start a background compile of the project if a project with the same name has already been seen before. -An optional string used for tracing compiler operations associated with this request.

    - - -
    - - - KeepProjectAlive(options, userOpName) - -
    - Signature: (options:FSharpProjectOptions * userOpName:string option) -> Async<IDisposable>
    -
    -     		-

    Create resources for the project and keep the project alive until the returned object is disposed.

    - - -
    - - - MatchBraces(...) - -
    - Signature: (filename:string * source:string * options:FSharpProjectOptions * userOpName:string option) -> Async<(range * range) []>
    -
    -     		-

    Parse a source code file, returning information about brace matching in the file. -Return an enumeration of the matching parenthetical tokens in the file.

    - - -
    - - - MatchBraces(...) - -
    - Signature: (filename:string * source:string * options:FSharpParsingOptions * userOpName:string option) -> Async<(range * range) []>
    -
    -     		-

    Parse a source code file, returning information about brace matching in the file. -Return an enumeration of the matching parenthetical tokens in the file.

    - - -
    - - - MaxMemory() - -
    - Signature: unit -> int
    -
    -     		-

    A maximum number of megabytes of allocated memory. If the figure reported by System.GC.GetTotalMemory(false) goes over this limit, the FSharpChecker object will attempt to free memory and reduce cache sizes to a minimum.

    - - -

    CompiledName: set_MaxMemory

    -
    - - - MaxMemory() - -
    - Signature: unit -> unit
    -
    -     		-

    A maximum number of megabytes of allocated memory. If the figure reported by System.GC.GetTotalMemory(false) goes over this limit, the FSharpChecker object will attempt to free memory and reduce cache sizes to a minimum.

    - - -

    CompiledName: get_MaxMemory

    -
    - - - MaxMemoryReached - -
    - Signature: IEvent<unit>
    -
    -     		-

    Raised after the maxMB memory threshold limit is reached

    - - -

    CompiledName: get_MaxMemoryReached

    -
    - - - NotifyProjectCleaned(...) - -
    - Signature: (options:FSharpProjectOptions * userOpName:string option) -> Async<unit>
    -
    -     		-

    This function is called when a project has been cleaned/rebuilt, and thus any live type providers should be refreshed.

    - - -
    - - - ParseAndCheckFileInProject(...) - -
    - Signature: (filename:string * fileversion:int * source:string * options:FSharpProjectOptions * textSnapshotInfo:obj option * userOpName:string option) -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    -
    -     		-

    Parse and check a source code file, returning a handle to the results

    -

    Note: all files except the one being checked are read from the FileSystem API

    -

    Return FSharpCheckFileAnswer.Aborted if a parse tree was not available.

    - - -
    - - - ParseAndCheckProject(...) - -
    - Signature: (options:FSharpProjectOptions * userOpName:string option) -> Async<FSharpCheckProjectResults>
    -
    -     		-

    Parse and typecheck all files in a project.All files are read from the FileSystem API

    - - -
    - - - ParseFile(...) - -
    - Signature: (filename:string * source:string * options:FSharpParsingOptions * userOpName:string option) -> Async<FSharpParseFileResults>
    -
    -     		-

    Parse a source code file, returning a handle that can be used for obtaining navigation bar information -To get the full information, call 'CheckFileInProject' method on the result

    - - -
    - - - ParseFileInProject(...) - -
    - Signature: (filename:string * source:string * options:FSharpProjectOptions * userOpName:string option) -> Async<FSharpParseFileResults>
    -
    -     		-

    Parse a source code file, returning a handle that can be used for obtaining navigation bar information -To get the full information, call 'CheckFileInProject' method on the resultAll files except the one being checked are read from the FileSystem API

    - - -
    - - - PauseBeforeBackgroundWork() - -
    - Signature: unit -> int
    -
    -     		-

    Get or set the pause time in milliseconds before background work is started.

    - - -

    CompiledName: set_PauseBeforeBackgroundWork

    -
    - - - PauseBeforeBackgroundWork() - -
    - Signature: unit -> unit
    -
    -     		-

    Get or set the pause time in milliseconds before background work is started.

    - - -

    CompiledName: get_PauseBeforeBackgroundWork

    -
    - - - ProjectChecked - -
    - Signature: IEvent<string * obj option>
    -
    -     		-

    Notify the host that a project has been fully checked in the background (using file contents provided by the file system API)

    -

    The event may be raised on a background thread.

    - - -

    CompiledName: get_ProjectChecked

    -
    - - - StopBackgroundCompile() - -
    - Signature: unit -> unit
    -
    -     		-

    Stop the background compile.

    - - -
    - - - TokenizeFile(source) - -
    - Signature: source:string -> FSharpTokenInfo [] []
    -
    -     		-

    Tokenize an entire file, line by line

    - - -
    - - - TokenizeLine(line, state) - -
    - Signature: (line:string * state:FSharpTokenizerLexState) -> FSharpTokenInfo [] * FSharpTokenizerLexState
    -
    -     		-

    Tokenize a single line, returning token information and a tokenization state represented by an integer

    - - -
    - - - TryGetRecentCheckResultsForFile(...) - -
    - Signature: (filename:string * options:FSharpProjectOptions * source:string option * userOpName:string option) -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    -
    -     		-

    Try to get type check results for a file. This looks up the results of recent type checks of the -same file, regardless of contents. The version tag specified in the original check of the file is returned. -If the source of the file has changed the results returned by this function may be out of date, though may -still be usable for generating intellisense menus and information.

    - - -
    - - - WaitForBackgroundCompile() - -
    - Signature: unit -> unit
    -
    -     		-

    Block until the background compile finishes.

    - - -
    -

    Static members

    - - - - - - - - - - - - - - - - - - - - - - -
    Static memberDescription
    - - - Create(...) - -
    - Signature: (projectCacheSize:int option * keepAssemblyContents:bool option * keepAllBackgroundResolutions:bool option * legacyReferenceResolver:Resolver option * tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot option) -> FSharpChecker
    -
    -     		-

    Create an instance of an FSharpChecker.

    - - -
    - - - GlobalForegroundParseCountStatistic - -
    - Signature: int
    -
    -     		-

    Report a statistic for testability

    - - -

    CompiledName: get_GlobalForegroundParseCountStatistic

    -
    - - - GlobalForegroundTypeCheckCountStatistic - -
    - Signature: int
    -
    -     		-

    Report a statistic for testability

    - - -

    CompiledName: get_GlobalForegroundTypeCheckCountStatistic

    -
    - - - Instance - -
    - Signature: FSharpChecker
    -
    -     		- -

    CompiledName: get_Instance

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html deleted file mode 100644 index 8fa8438873..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - FSharpCheckFileAnswer - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpCheckFileAnswer

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    The result of calling TypeCheckResult including the possibility of abort and background compiler not caught up.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Aborted - -
    - Signature:
    -
    -     		- -
    - - - Succeeded(FSharpCheckFileResults) - -
    - Signature: FSharpCheckFileResults
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html deleted file mode 100644 index 929c6f112e..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html +++ /dev/null @@ -1,467 +0,0 @@ - - - - - FSharpCheckFileResults - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpCheckFileResults

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A handle to the results of CheckFileInProject.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DependencyFiles - -
    - Signature: string []
    -
    -     		-

    Indicates the set of files which must be watched to accurately track changes that affect these results, -Clients interested in reacting to updates to these files should watch these files and take actions as described -in the documentation for compiler service.

    - - -

    CompiledName: get_DependencyFiles

    -
    - - - Errors - -
    - Signature: FSharpErrorInfo []
    -
    -     		-

    The errors returned by parsing a source file.

    - - -

    CompiledName: get_Errors

    -
    - - - GetAllUsesOfAllSymbolsInFile() - -
    - Signature: unit -> Async<FSharpSymbolUse []>
    -
    -     		-

    Get all textual usages of all symbols throughout the file

    - - -
    - - - GetDeclarationListInfo(...) - -
    - Signature: (ParsedFileResultsOpt:FSharpParseFileResults option * line:int * lineText:string * partialName:PartialLongName * getAllEntities:(unit -> AssemblySymbol list) option * hasTextChangedSinceLastTypecheck:(obj * range -> bool) option * userOpName:string option) -> Async<FSharpDeclarationListInfo>
    -
    -     		-

    Get the items for a declaration list

    - - -
    - - - GetDeclarationListSymbols(...) - -
    - Signature: (ParsedFileResultsOpt:FSharpParseFileResults option * line:int * lineText:string * partialName:PartialLongName * getAllEntities:(unit -> AssemblySymbol list) option * hasTextChangedSinceLastTypecheck:(obj * range -> bool) option * userOpName:string option) -> Async<FSharpSymbolUse list list>
    -
    -     		-

    Get the items for a declaration list in FSharpSymbol format

    - - -
    - - - GetDeclarationLocation(...) - -
    - Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * preferFlag:bool option * userOpName:string option) -> Async<FSharpFindDeclResult>
    -
    -     		-

    Resolve the names at the given location to the declaration location of the corresponding construct.

    - - -
    - - - GetF1Keyword(...) - -
    - Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * userOpName:string option) -> Async<string option>
    -
    -     		-

    Compute the Visual Studio F1-help key identifier for the given location, based on name resolution results

    - - -
    - - - GetFormatSpecifierLocations() - -
    - Signature: unit -> range []
    -
    -     		-

    Get the locations of format specifiers

    - - -
    - - - GetFormatSpecifierLocationsAndArity() - -
    - Signature: unit -> (range * int) []
    -
    -     		-

    Get the locations of and number of arguments associated with format specifiers

    - - -
    - - - GetMethods(...) - -
    - Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list option * userOpName:string option) -> Async<FSharpMethodGroup>
    -
    -     		-

    Compute a set of method overloads to show in a dialog relevant to the given code location.

    - - -
    - - - GetMethodsAsSymbols(...) - -
    - Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * userOpName:string option) -> Async<FSharpSymbolUse list option>
    -
    -     		-

    Compute a set of method overloads to show in a dialog relevant to the given code location. The resulting method overloads are returned as symbols.

    - - -
    - - - GetSemanticClassification(arg1) - -
    - Signature: (range option) -> (range * SemanticClassificationType) []
    -
    -     		-

    Get any extra colorization info that is available after the typecheck

    - - -
    - - - GetStructuredToolTipText(...) - -
    - Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * userOpName:string option) -> Async<FSharpStructuredToolTipText>
    -
    -     		-

    Compute a formatted tooltip for the given location

    - - -
    - - - GetSymbolUseAtLocation(...) - -
    - Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * userOpName:string option) -> Async<FSharpSymbolUse option>
    -
    -     		-

    Resolve the names at the given location to a use of symbol.

    - - -
    - - - GetToolTipText(...) - -
    - Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * userOpName:string option) -> Async<FSharpToolTipText>
    -
    -     		-

    Compute a formatted tooltip for the given location

    - - -
    - - - GetUsesOfSymbolInFile(symbol) - -
    - Signature: symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    -
    -     		-

    Get the textual usages that resolved to the given symbol throughout the file

    - - -
    - - - HasFullTypeCheckInfo - -
    - Signature: bool
    -
    -     		-

    Indicates whether type checking successfully occurred with some results returned. If false, indicates that -an unrecoverable error in earlier checking/parsing/resolution steps.

    - - -

    CompiledName: get_HasFullTypeCheckInfo

    -
    - - - ImplementationFile - -
    - Signature: FSharpImplementationFileContents option
    -
    -     		-

    Represents complete typechecked implementation file, including its typechecked signatures if any.

    - - -

    CompiledName: get_ImplementationFile

    -
    - - - IsRelativeNameResolvableFromSymbol(...) - -
    - Signature: (cursorPos:pos * plid:string list * symbol:FSharpSymbol * userOpName:string option) -> Async<bool>
    -
    -     		-

    Determines if a long ident is resolvable at a specific point. -An optional string used for tracing compiler operations associated with this request.

    - - -
    - - - OpenDeclarations - -
    - Signature: FSharpOpenDeclaration []
    -
    -     		-

    Open declarations in the file, including auto open modules.

    - - -

    CompiledName: get_OpenDeclarations

    -
    - - - PartialAssemblySignature - -
    - Signature: FSharpAssemblySignature
    -
    -     		-

    Get a view of the contents of the assembly up to and including the file just checked

    - - -

    CompiledName: get_PartialAssemblySignature

    -
    - - - ProjectContext - -
    - Signature: FSharpProjectContext
    -
    -     		-

    Get the resolution of the ProjectOptions

    - - -

    CompiledName: get_ProjectContext

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html deleted file mode 100644 index feaf3ef7f6..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - FSharpCheckProjectResults - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpCheckProjectResults

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A handle to the results of CheckFileInProject.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AssemblyContents - -
    - Signature: FSharpAssemblyContents
    -
    -     		-

    Get a view of the overall contents of the assembly. Only valid to use if HasCriticalErrors is false.

    - - -

    CompiledName: get_AssemblyContents

    -
    - - - AssemblySignature - -
    - Signature: FSharpAssemblySignature
    -
    -     		-

    Get a view of the overall signature of the assembly. Only valid to use if HasCriticalErrors is false.

    - - -

    CompiledName: get_AssemblySignature

    -
    - - - DependencyFiles - -
    - Signature: string []
    -
    -     		-

    Indicates the set of files which must be watched to accurately track changes that affect these results, -Clients interested in reacting to updates to these files should watch these files and take actions as described -in the documentation for compiler service.

    - - -

    CompiledName: get_DependencyFiles

    -
    - - - Errors - -
    - Signature: FSharpErrorInfo []
    -
    -     		-

    The errors returned by processing the project

    - - -

    CompiledName: get_Errors

    -
    - - - GetAllUsesOfAllSymbols() - -
    - Signature: unit -> Async<FSharpSymbolUse []>
    -
    -     		-

    Get all textual usages of all symbols throughout the project

    - - -
    - - - GetOptimizedAssemblyContents() - -
    - Signature: unit -> FSharpAssemblyContents
    -
    -     		-

    Get an optimized view of the overall contents of the assembly. Only valid to use if HasCriticalErrors is false.

    - - -
    - - - GetUsesOfSymbol(symbol) - -
    - Signature: symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    -
    -     		-

    Get the textual usages that resolved to the given symbol throughout the project

    - - -
    - - - HasCriticalErrors - -
    - Signature: bool
    -
    -     		-

    Indicates if critical errors existed in the project options

    - - -

    CompiledName: get_HasCriticalErrors

    -
    - - - ProjectContext - -
    - Signature: FSharpProjectContext
    -
    -     		-

    Get the resolution of the ProjectOptions

    - - -

    CompiledName: get_ProjectContext

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistinfo.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistinfo.html deleted file mode 100644 index fbfb3b0161..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistinfo.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - FSharpDeclarationListInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpDeclarationListInfo

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a set of declarations in F# source code, with information attached ready for display by an editor. -Returned by GetDeclarations.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - IsError - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsError

    -
    - - - IsForType - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsForType

    -
    - - - Items - -
    - Signature: FSharpDeclarationListItem []
    -
    -     		- -

    CompiledName: get_Items

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: FSharpDeclarationListInfo
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistitem.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistitem.html deleted file mode 100644 index 85af448133..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistitem.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - FSharpDeclarationListItem - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpDeclarationListItem

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a declaration in F# source code, with information attached ready for display by an editor. -Returned by GetDeclarations.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Accessibility - -
    - Signature: FSharpAccessibility option
    -
    -     		- -

    CompiledName: get_Accessibility

    -
    - - - DescriptionText - -
    - Signature: FSharpToolTipText
    -
    -     		- -

    CompiledName: get_DescriptionText

    -
    - - - DescriptionTextAsync - -
    - Signature: Async<FSharpToolTipText>
    -
    -     		- -

    CompiledName: get_DescriptionTextAsync

    -
    - - - FullName - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_FullName

    -
    - - - Glyph - -
    - Signature: FSharpGlyph
    -
    -     		- -

    CompiledName: get_Glyph

    -
    - - - IsOwnMember - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsOwnMember

    -
    - - - IsResolved - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsResolved

    -
    - - - Kind - -
    - Signature: CompletionItemKind
    -
    -     		- -

    CompiledName: get_Kind

    -
    - - - MinorPriority - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_MinorPriority

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    Get the display name for the declaration.

    - - -

    CompiledName: get_Name

    -
    - - - NameInCode - -
    - Signature: string
    -
    -     		-

    Get the name for the declaration as it's presented in source code.

    - - -

    CompiledName: get_NameInCode

    -
    - - - NamespaceToOpen - -
    - Signature: string option
    -
    -     		- -

    CompiledName: get_NamespaceToOpen

    -
    - - - StructuredDescriptionText - -
    - Signature: FSharpStructuredToolTipText
    -
    -     		-

    Get the description text for the declaration. Computing this property may require using compiler -resources and may trigger execution of a type provider method to retrieve documentation.

    -

    May return "Loading..." if timeout occurs

    - - -

    CompiledName: get_StructuredDescriptionText

    -
    - - - StructuredDescriptionTextAsync - -
    - Signature: Async<FSharpStructuredToolTipText>
    -
    -     		-

    Get the description text, asynchronously. Never returns "Loading...".

    - - -

    CompiledName: get_StructuredDescriptionTextAsync

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdelegatesignature.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdelegatesignature.html deleted file mode 100644 index 99f96491d9..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdelegatesignature.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - FSharpDelegateSignature - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpDelegateSignature

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a delegate signature in an F# symbol

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DelegateArguments - -
    - Signature: IList<string option * FSharpType>
    -
    -     		-

    Get the argument types of the delegate signature

    - - -

    CompiledName: get_DelegateArguments

    -
    - - - DelegateReturnType - -
    - Signature: FSharpType
    -
    -     		-

    Get the return type of the delegate signature

    - - -

    CompiledName: get_DelegateReturnType

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdisplaycontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdisplaycontext.html deleted file mode 100644 index 085dea3565..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdisplaycontext.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - FSharpDisplayContext - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpDisplayContext

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the information needed to format types and other information in a style -suitable for use in F# source text at a particular source location.

    -

    Acquired via GetDisplayEnvAtLocationAlternate and similar methods. May be passed -to the Format method on FSharpType and other methods.

    - -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Empty - -
    - Signature: FSharpDisplayContext
    -
    -     		- -

    CompiledName: get_Empty

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpenclosingentitykind.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpenclosingentitykind.html deleted file mode 100644 index 441a5d2deb..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpenclosingentitykind.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - FSharpEnclosingEntityKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpEnclosingEntityKind

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Class - -
    - Signature:
    -
    -     		- -
    - - - DU - -
    - Signature:
    -
    -     		- -
    - - - Enum - -
    - Signature:
    -
    -     		- -
    - - - Exception - -
    - Signature:
    -
    -     		- -
    - - - Interface - -
    - Signature:
    -
    -     		- -
    - - - Module - -
    - Signature:
    -
    -     		- -
    - - - Namespace - -
    - Signature:
    -
    -     		- -
    - - - Record - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpentity.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpentity.html deleted file mode 100644 index a0f9fbb9f5..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpentity.html +++ /dev/null @@ -1,1057 +0,0 @@ - - - - - FSharpEntity - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpEntity

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A subtype of FSharpSymbol that represents a type definition or module as seen by the F# language

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AbbreviatedType - -
    - Signature: FSharpType
    -
    -     		-

    Get the type abbreviated by an F# type abbreviation

    - - -

    CompiledName: get_AbbreviatedType

    -
    - - - Accessibility - -
    - Signature: FSharpAccessibility
    -
    -     		-

    Get the declared accessibility of the type

    - - -

    CompiledName: get_Accessibility

    -
    - - - AccessPath - -
    - Signature: string
    -
    -     		-

    Get the path used to address the entity (e.g. "Namespace.Module1.NestedModule2"). Gives -"global" for items not in a namespace.

    - - -

    CompiledName: get_AccessPath

    -
    - - - ActivePatternCases - -
    - Signature: FSharpActivePatternCase list
    -
    -     		-

    Get all active pattern cases defined in all active patterns in the module.

    - - -

    CompiledName: get_ActivePatternCases

    -
    - - - AllCompilationPaths - -
    - Signature: string list
    -
    -     		-

    Get all compilation paths, taking Module suffixes into account.

    - - -

    CompiledName: get_AllCompilationPaths

    -
    - - - AllInterfaces - -
    - Signature: IList<FSharpType>
    -
    -     		-

    Get all the interface implementations, by walking the type hierarchy

    - - -

    CompiledName: get_AllInterfaces

    -
    - - - ArrayRank - -
    - Signature: int
    -
    -     		-

    Get the rank of an array type

    - - -

    CompiledName: get_ArrayRank

    -
    - - - Attributes - -
    - Signature: IList<FSharpAttribute>
    -
    -     		-

    Get the declared attributes for the type

    - - -

    CompiledName: get_Attributes

    -
    - - - BaseType - -
    - Signature: FSharpType option
    -
    -     		-

    Get the base type, if any

    - - -

    CompiledName: get_BaseType

    -
    - - - CompiledName - -
    - Signature: string
    -
    -     		-

    Get the compiled name of the type or module, possibly with `n mangling. This is identical to LogicalName -unless the CompiledName attribute is used.

    - - -

    CompiledName: get_CompiledName

    -
    - - - DeclarationLocation - -
    - Signature: range
    -
    -     		-

    Get the declaration location for the type constructor

    - - -

    CompiledName: get_DeclarationLocation

    -
    - - - DeclaredInterfaces - -
    - Signature: IList<FSharpType>
    -
    -     		-

    Get the declared interface implementations

    - - -

    CompiledName: get_DeclaredInterfaces

    -
    - - - DeclaringEntity - -
    - Signature: FSharpEntity option
    -
    -     		-

    Get the enclosing entity for the definition

    - - -

    CompiledName: get_DeclaringEntity

    -
    - - - DisplayName - -
    - Signature: string
    -
    -     		-

    Get the name of the type or module as displayed in F# code

    - - -

    CompiledName: get_DisplayName

    -
    - - - FSharpDelegateSignature - -
    - Signature: FSharpDelegateSignature
    -
    -     		-

    Indicates if the type is a delegate with the given Invoke signature

    - - -

    CompiledName: get_FSharpDelegateSignature

    -
    - - - FSharpFields - -
    - Signature: IList<FSharpField>
    -
    -     		-

    Get the fields of a record, class, struct or enum from the perspective of the F# language. -This includes static fields, the 'val' bindings in classes and structs, and the value definitions in enums. -For classes, the list may include compiler generated fields implied by the use of primary constructors.

    - - -

    CompiledName: get_FSharpFields

    -
    - - - FullName - -
    - Signature: string
    -
    -     		-

    Get the full name of the type or module

    - - -

    CompiledName: get_FullName

    -
    - - - GenericParameters - -
    - Signature: IList<FSharpGenericParameter>
    -
    -     		-

    Get the generic parameters, possibly including unit-of-measure parameters

    - - -

    CompiledName: get_GenericParameters

    -
    - - - HasAssemblyCodeRepresentation - -
    - Signature: bool
    -
    -     		-

    Indicates if the type is implemented through a mapping to IL assembly code. This is only -true for types in FSharp.Core.dll

    - - -

    CompiledName: get_HasAssemblyCodeRepresentation

    -
    - - - HasFSharpModuleSuffix - -
    - Signature: bool
    -
    -     		-

    Indicates that a module is compiled to a class with the given mangled name. The mangling is reversed during lookup

    - - -

    CompiledName: get_HasFSharpModuleSuffix

    -
    - - - IsArrayType - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is an array type

    - - -

    CompiledName: get_IsArrayType

    -
    - - - IsAttributeType - -
    - Signature: bool
    -
    -     		-

    Check if the entity inherits from System.Attribute in its type hierarchy

    - - -

    CompiledName: get_IsAttributeType

    -
    - - - IsByRef - -
    - Signature: bool
    -
    -     		-

    Indicates if is the 'byref<_>' type definition used for byref types in F#-compiled assemblies

    - - -

    CompiledName: get_IsByRef

    -
    - - - IsClass - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a class type definition

    - - -

    CompiledName: get_IsClass

    -
    - - - IsDelegate - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a delegate type definition

    - - -

    CompiledName: get_IsDelegate

    -
    - - - IsEnum - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is an enum type definition

    - - -

    CompiledName: get_IsEnum

    -
    - - - IsFSharp - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a reference to something in an F#-compiled assembly

    - - -

    CompiledName: get_IsFSharp

    -
    - - - IsFSharpAbbreviation - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a measure, type or exception abbreviation

    - - -

    CompiledName: get_IsFSharpAbbreviation

    -
    - - - IsFSharpExceptionDeclaration - -
    - Signature: bool
    -
    -     		-

    Indicates an F# exception declaration

    - - -

    CompiledName: get_IsFSharpExceptionDeclaration

    -
    - - - IsFSharpModule - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is an F# module definition

    - - -

    CompiledName: get_IsFSharpModule

    -
    - - - IsFSharpRecord - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is record type

    - - -

    CompiledName: get_IsFSharpRecord

    -
    - - - IsFSharpUnion - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is union type

    - - -

    CompiledName: get_IsFSharpUnion

    -
    - - - IsInterface - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is an interface type definition

    - - -

    CompiledName: get_IsInterface

    -
    - - - IsMeasure - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a measure definition

    - - -

    CompiledName: get_IsMeasure

    -
    - - - IsNamespace - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a part of a namespace path

    - - -

    CompiledName: get_IsNamespace

    -
    - - - IsOpaque - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a type definition for a reference type where the implementation details are hidden by a signature

    - - -

    CompiledName: get_IsOpaque

    -
    - - - IsProvided - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a provided type

    - - -

    CompiledName: get_IsProvided

    -
    - - - IsProvidedAndErased - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is an erased provided type

    - - -

    CompiledName: get_IsProvidedAndErased

    -
    - - - IsProvidedAndGenerated - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a generated provided type

    - - -

    CompiledName: get_IsProvidedAndGenerated

    -
    - - - IsStaticInstantiation - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a 'fake' symbol related to a static instantiation of a type provider

    - - -

    CompiledName: get_IsStaticInstantiation

    -
    - - - IsUnresolved - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is in an unresolved assembly

    - - -

    CompiledName: get_IsUnresolved

    -
    - - - IsValueType - -
    - Signature: bool
    -
    -     		-

    Indicates if the entity is a struct or enum

    - - -

    CompiledName: get_IsValueType

    -
    - - - LogicalName - -
    - Signature: string
    -
    -     		-

    Get the name of the type or module, possibly with `n mangling

    - - -

    CompiledName: get_LogicalName

    -
    - - - MembersFunctionsAndValues - -
    - Signature: IList<FSharpMemberOrFunctionOrValue>
    -
    -     		-

    Get the properties, events and methods of a type definitions, or the functions and values of a module

    - - -

    CompiledName: get_MembersFunctionsAndValues

    -
    - - - MembersOrValues - -
    - Signature: IList<FSharpMemberOrFunctionOrValue>
    -
    -     		- -

    CompiledName: get_MembersOrValues

    -
    - - - Namespace - -
    - Signature: string option
    -
    -     		-

    Get the namespace containing the type or module, if any. Use 'None' for item not in a namespace.

    - - -

    CompiledName: get_Namespace

    -
    - - - NestedEntities - -
    - Signature: IList<FSharpEntity>
    -
    -     		-

    Get the modules and types defined in a module, or the nested types of a type

    - - -

    CompiledName: get_NestedEntities

    -
    - - - QualifiedName - -
    - Signature: string
    -
    -     		-

    Get the fully qualified name of the type or module

    - - -

    CompiledName: get_QualifiedName

    -
    - - - RecordFields - -
    - Signature: IList<FSharpField>
    -
    -     		- -

    CompiledName: get_RecordFields

    -
    - - - RepresentationAccessibility - -
    - Signature: FSharpAccessibility
    -
    -     		-

    Get the declared accessibility of the representation, not taking signatures into account

    - - -

    CompiledName: get_RepresentationAccessibility

    -
    - - - StaticParameters - -
    - Signature: IList<FSharpStaticParameter>
    -
    -     		-

    Get the static parameters for a provided type

    - - -

    CompiledName: get_StaticParameters

    -
    - - - TryFullName - -
    - Signature: string option
    -
    -     		-

    Get the full name of the type or module if it is available

    - - -

    CompiledName: get_TryFullName

    -
    - - - UnionCases - -
    - Signature: IList<FSharpUnionCase>
    -
    -     		-

    Get the cases of a union type

    - - -

    CompiledName: get_UnionCases

    -
    - - - UsesPrefixDisplay - -
    - Signature: bool
    -
    -     		-

    Indicates if the type prefers the "tycon" syntax for display etc.

    - - -

    CompiledName: get_UsesPrefixDisplay

    -
    - - - XmlDoc - -
    - Signature: IList<string>
    -
    -     		-

    Get the in-memory XML documentation for the entity, used when code is checked in-memory

    - - -

    CompiledName: get_XmlDoc

    -
    - - - XmlDocSig - -
    - Signature: string
    -
    -     		-

    Get the XML documentation signature for the entity, used for .xml file lookup for compiled code

    - - -

    CompiledName: get_XmlDocSig

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorinfo.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorinfo.html deleted file mode 100644 index c41e9e6366..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorinfo.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - FSharpErrorInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpErrorInfo

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - EndColumn - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_EndColumn

    -
    - - - EndLineAlternate - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_EndLineAlternate

    -
    - - - ErrorNumber - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_ErrorNumber

    -
    - - - FileName - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_FileName

    -
    - - - Message - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Message

    -
    - - - Severity - -
    - Signature: FSharpErrorSeverity
    -
    -     		- -

    CompiledName: get_Severity

    -
    - - - StartColumn - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_StartColumn

    -
    - - - StartLineAlternate - -
    - Signature: int
    -
    -     		- -

    CompiledName: get_StartLineAlternate

    -
    - - - Subcategory - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Subcategory

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorseverity.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorseverity.html deleted file mode 100644 index 18c7bfb3be..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorseverity.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - FSharpErrorSeverity - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpErrorSeverity

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Error - -
    - Signature:
    -
    -     		- -
    - - - Warning - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpexpr.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpexpr.html deleted file mode 100644 index 0706f1ada1..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpexpr.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - FSharpExpr - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpExpr

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a checked and reduced expression, as seen by the F# language. The active patterns -in 'FSharp.Compiler.SourceCodeServices' can be used to analyze information about the expression.

    -

    Pattern matching is reduced to decision trees and conditional tests. Some other -constructs may be represented in reduced form.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - ImmediateSubExpressions - -
    - Signature: FSharpExpr list
    -
    -     		-

    The immediate sub-expressions of the expression.

    - - -

    CompiledName: get_ImmediateSubExpressions

    -
    - - - Range - -
    - Signature: range
    -
    -     		-

    The range of the expression

    - - -

    CompiledName: get_Range

    -
    - - - Type - -
    - Signature: FSharpType
    -
    -     		-

    The type of the expression

    - - -

    CompiledName: get_Type

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfield.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfield.html deleted file mode 100644 index f61e46a91a..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfield.html +++ /dev/null @@ -1,445 +0,0 @@ - - - - - FSharpField - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpField

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Accessibility - -
    - Signature: FSharpAccessibility
    -
    -     		-

    Indicates if the declared visibility of the field, not taking signatures into account

    - - -

    CompiledName: get_Accessibility

    -
    - - - AnonRecordFieldDetails - -
    - Signature: FSharpAnonRecordTypeDetails * FSharpType [] * int
    -
    -     		-

    If the field is from an anonymous record type then get the details of the field including the index in the sorted array of fields

    - - -

    CompiledName: get_AnonRecordFieldDetails

    -
    - - - DeclarationLocation - -
    - Signature: range
    -
    -     		-

    Get the declaration location of the field

    - - -

    CompiledName: get_DeclarationLocation

    -
    - - - DeclaringEntity - -
    - Signature: FSharpEntity option
    -
    -     		-

    Get the declaring entity of this field, if any. Fields from anonymous types do not have a declaring entity

    - - -

    CompiledName: get_DeclaringEntity

    -
    - - - FieldAttributes - -
    - Signature: IList<FSharpAttribute>
    -
    -     		-

    Get the attributes attached to generated field

    - - -

    CompiledName: get_FieldAttributes

    -
    - - - FieldType - -
    - Signature: FSharpType
    -
    -     		-

    Get the type of the field, w.r.t. the generic parameters of the enclosing type constructor

    - - -

    CompiledName: get_FieldType

    -
    - - - IsAnonRecordField - -
    - Signature: bool
    -
    -     		-

    Is this a field from an anonymous record type?

    - - -

    CompiledName: get_IsAnonRecordField

    -
    - - - IsCompilerGenerated - -
    - Signature: bool
    -
    -     		-

    Indicates a compiler generated field, not visible to Intellisense or name resolution

    - - -

    CompiledName: get_IsCompilerGenerated

    -
    - - - IsDefaultValue - -
    - Signature: bool
    -
    -     		-

    Indicates if the field declared is declared 'DefaultValue'

    - - -

    CompiledName: get_IsDefaultValue

    -
    - - - IsLiteral - -
    - Signature: bool
    -
    -     		-

    Indicates if the field has a literal value

    - - -

    CompiledName: get_IsLiteral

    -
    - - - IsMutable - -
    - Signature: bool
    -
    -     		-

    Indicates if the field is declared 'static'

    - - -

    CompiledName: get_IsMutable

    -
    - - - IsNameGenerated - -
    - Signature: bool
    -
    -     		-

    Indicates if the field name was generated by compiler (e.g. ItemN names in union cases and DataN in exceptions). -This API returns true for source defined symbols only.

    - - -

    CompiledName: get_IsNameGenerated

    -
    - - - IsStatic - -
    - Signature: bool
    -
    -     		-

    Indicates a static field

    - - -

    CompiledName: get_IsStatic

    -
    - - - IsUnresolved - -
    - Signature: bool
    -
    -     		-

    Indicates if the record field is for a type in an unresolved assembly

    - - -

    CompiledName: get_IsUnresolved

    -
    - - - IsVolatile - -
    - Signature: bool
    -
    -     		-

    Indicates if the field is declared volatile

    - - -

    CompiledName: get_IsVolatile

    -
    - - - LiteralValue - -
    - Signature: obj option
    -
    -     		-

    Get the default initialization info, for static literals

    - - -

    CompiledName: get_LiteralValue

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    Get the name of the field

    - - -

    CompiledName: get_Name

    -
    - - - PropertyAttributes - -
    - Signature: IList<FSharpAttribute>
    -
    -     		-

    Get the attributes attached to generated property

    - - -

    CompiledName: get_PropertyAttributes

    -
    - - - XmlDoc - -
    - Signature: IList<string>
    -
    -     		-

    Get the in-memory XML documentation for the field, used when code is checked in-memory

    - - -

    CompiledName: get_XmlDoc

    -
    - - - XmlDocSig - -
    - Signature: string
    -
    -     		-

    Get the XML documentation signature for .xml file lookup for the field, used for .xml file lookup for compiled code

    - - -

    CompiledName: get_XmlDocSig

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html deleted file mode 100644 index 8b04233790..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - FSharpFindDeclFailureReason - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpFindDeclFailureReason

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the reason why the GetDeclarationLocation operation failed.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - NoSourceCode - -
    - Signature:
    -
    -     		-

    Source code file is not available

    - - -
    - - - ProvidedMember(string) - -
    - Signature: string
    -
    -     		-

    Trying to find declaration of ProvidedMember without TypeProviderDefinitionLocationAttribute

    - - -
    - - - ProvidedType(string) - -
    - Signature: string
    -
    -     		-

    Trying to find declaration of ProvidedType without TypeProviderDefinitionLocationAttribute

    - - -
    - - - Unknown(message) - -
    - Signature: string
    -
    -     		-

    Generic reason: no particular information about error apart from a message

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html deleted file mode 100644 index e559dabd66..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - FSharpFindDeclResult - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpFindDeclResult

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the result of the GetDeclarationLocation operation.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - DeclFound(range) - -
    - Signature: range
    -
    -     		-

    Indicates a declaration location was found

    - - -
    - - - DeclNotFound(...) - -
    - Signature: FSharpFindDeclFailureReason
    -
    -     		-

    Indicates a declaration location was not found, with an additional reason

    - - -
    - - - ExternalDecl(assembly,externalSym) - -
    - Signature: string * ExternalSymbol
    -
    -     		-

    Indicates an external declaration was found

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameter.html deleted file mode 100644 index a635ce0d77..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameter.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - FSharpGenericParameter - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpGenericParameter

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A subtype of FSharpSymbol that represents a generic parameter for an FSharpSymbol

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Attributes - -
    - Signature: IList<FSharpAttribute>
    -
    -     		-

    Get the declared attributes of the type parameter.

    - - -

    CompiledName: get_Attributes

    -
    - - - Constraints - -
    - Signature: IList<FSharpGenericParameterConstraint>
    -
    -     		-

    Get the declared or inferred constraints for the type parameter

    - - -

    CompiledName: get_Constraints

    -
    - - - DeclarationLocation - -
    - Signature: range
    -
    -     		-

    Get the range of the generic parameter

    - - -

    CompiledName: get_DeclarationLocation

    -
    - - - IsCompilerGenerated - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a compiler generated type parameter

    - - -

    CompiledName: get_IsCompilerGenerated

    -
    - - - IsMeasure - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a measure variable

    - - -

    CompiledName: get_IsMeasure

    -
    - - - IsSolveAtCompileTime - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a statically resolved type variable

    - - -

    CompiledName: get_IsSolveAtCompileTime

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    Get the name of the generic parameter

    - - -

    CompiledName: get_Name

    -
    - - - XmlDoc - -
    - Signature: IList<string>
    -
    -     		-

    Get the in-memory XML documentation for the type parameter, used when code is checked in-memory

    - - -

    CompiledName: get_XmlDoc

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterconstraint.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterconstraint.html deleted file mode 100644 index 1d6eb50295..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterconstraint.html +++ /dev/null @@ -1,427 +0,0 @@ - - - - - FSharpGenericParameterConstraint - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpGenericParameterConstraint

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a constraint on a generic type parameter

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CoercesToTarget - -
    - Signature: FSharpType
    -
    -     		-

    Gets further information about a coerces-to constraint

    - - -

    CompiledName: get_CoercesToTarget

    -
    - - - DefaultsToConstraintData - -
    - Signature: FSharpGenericParameterDefaultsToConstraint
    -
    -     		-

    Gets further information about a defaults-to constraint

    - - -

    CompiledName: get_DefaultsToConstraintData

    -
    - - - DelegateConstraintData - -
    - Signature: FSharpGenericParameterDelegateConstraint
    -
    -     		-

    Gets further information about a delegate constraint

    - - -

    CompiledName: get_DelegateConstraintData

    -
    - - - EnumConstraintTarget - -
    - Signature: FSharpType
    -
    -     		-

    Gets further information about an enumeration constraint

    - - -

    CompiledName: get_EnumConstraintTarget

    -
    - - - IsCoercesToConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type is a subtype of the given type

    - - -

    CompiledName: get_IsCoercesToConstraint

    -
    - - - IsComparisonConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type supports F# generic comparison

    - - -

    CompiledName: get_IsComparisonConstraint

    -
    - - - IsDefaultsToConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a default value for an inference type variable should it be neither generalized nor solved

    - - -

    CompiledName: get_IsDefaultsToConstraint

    -
    - - - IsDelegateConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type is a delegate from the given tuple of args to the given return type

    - - -

    CompiledName: get_IsDelegateConstraint

    -
    - - - IsEnumConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type is an enum with the given underlying

    - - -

    CompiledName: get_IsEnumConstraint

    -
    - - - IsEqualityConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type supports F# generic equality

    - - -

    CompiledName: get_IsEqualityConstraint

    -
    - - - IsMemberConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type has a member with the given signature

    - - -

    CompiledName: get_IsMemberConstraint

    -
    - - - IsNonNullableValueTypeConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type is a non-Nullable value type

    - - -

    CompiledName: get_IsNonNullableValueTypeConstraint

    -
    - - - IsReferenceTypeConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type is a reference type

    - - -

    CompiledName: get_IsReferenceTypeConstraint

    -
    - - - IsRequiresDefaultConstructorConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type has a parameterless constructor

    - - -

    CompiledName: get_IsRequiresDefaultConstructorConstraint

    -
    - - - IsSimpleChoiceConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that is a type is a simple choice between one of the given ground types. Used by printf format strings.

    - - -

    CompiledName: get_IsSimpleChoiceConstraint

    -
    - - - IsSupportsNullConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type has a 'null' value

    - - -

    CompiledName: get_IsSupportsNullConstraint

    -
    - - - IsUnmanagedConstraint - -
    - Signature: bool
    -
    -     		-

    Indicates a constraint that a type is an unmanaged type

    - - -

    CompiledName: get_IsUnmanagedConstraint

    -
    - - - MemberConstraintData - -
    - Signature: FSharpGenericParameterMemberConstraint
    -
    -     		-

    Gets further information about a member constraint

    - - -

    CompiledName: get_MemberConstraintData

    -
    - - - SimpleChoices - -
    - Signature: IList<FSharpType>
    -
    -     		-

    Gets further information about a choice constraint

    - - -

    CompiledName: get_SimpleChoices

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdefaultstoconstraint.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdefaultstoconstraint.html deleted file mode 100644 index c9cfc038c2..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdefaultstoconstraint.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - FSharpGenericParameterDefaultsToConstraint - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpGenericParameterDefaultsToConstraint

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents further information about a 'defaults to' constraint on a generic type parameter

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DefaultsToPriority - -
    - Signature: int
    -
    -     		-

    Get the priority off the 'defaults to' constraint

    - - -

    CompiledName: get_DefaultsToPriority

    -
    - - - DefaultsToTarget - -
    - Signature: FSharpType
    -
    -     		-

    Get the default type associated with the 'defaults to' constraint

    - - -

    CompiledName: get_DefaultsToTarget

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdelegateconstraint.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdelegateconstraint.html deleted file mode 100644 index 7656ce1b7c..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdelegateconstraint.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - FSharpGenericParameterDelegateConstraint - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpGenericParameterDelegateConstraint

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents further information about a delegate constraint on a generic type parameter

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DelegateReturnType - -
    - Signature: FSharpType
    -
    -     		-

    Get the return type required by the constraint

    - - -

    CompiledName: get_DelegateReturnType

    -
    - - - DelegateTupledArgumentType - -
    - Signature: FSharpType
    -
    -     		-

    Get the tupled argument type required by the constraint

    - - -

    CompiledName: get_DelegateTupledArgumentType

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparametermemberconstraint.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparametermemberconstraint.html deleted file mode 100644 index 825c6ed56d..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparametermemberconstraint.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - FSharpGenericParameterMemberConstraint - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpGenericParameterMemberConstraint

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents further information about a member constraint on a generic type parameter

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - MemberArgumentTypes - -
    - Signature: IList<FSharpType>
    -
    -     		-

    Get the argument types of the method required by the constraint

    - - -

    CompiledName: get_MemberArgumentTypes

    -
    - - - MemberIsStatic - -
    - Signature: bool
    -
    -     		-

    Indicates if the the method required by the constraint must be static

    - - -

    CompiledName: get_MemberIsStatic

    -
    - - - MemberName - -
    - Signature: string
    -
    -     		-

    Get the name of the method required by the constraint

    - - -

    CompiledName: get_MemberName

    -
    - - - MemberReturnType - -
    - Signature: FSharpType
    -
    -     		-

    Get the return type of the method required by the constraint

    - - -

    CompiledName: get_MemberReturnType

    -
    - - - MemberSources - -
    - Signature: IList<FSharpType>
    -
    -     		-

    Get the types that may be used to satisfy the constraint

    - - -

    CompiledName: get_MemberSources

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpglyph.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpglyph.html deleted file mode 100644 index eb1151fa10..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpglyph.html +++ /dev/null @@ -1,396 +0,0 @@ - - - - - FSharpGlyph - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpGlyph

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Class - -
    - Signature:
    -
    -     		- -
    - - - Constant - -
    - Signature:
    -
    -     		- -
    - - - Delegate - -
    - Signature:
    -
    -     		- -
    - - - Enum - -
    - Signature:
    -
    -     		- -
    - - - EnumMember - -
    - Signature:
    -
    -     		- -
    - - - Error - -
    - Signature:
    -
    -     		- -
    - - - Event - -
    - Signature:
    -
    -     		- -
    - - - Exception - -
    - Signature:
    -
    -     		- -
    - - - ExtensionMethod - -
    - Signature:
    -
    -     		- -
    - - - Field - -
    - Signature:
    -
    -     		- -
    - - - Interface - -
    - Signature:
    -
    -     		- -
    - - - Method - -
    - Signature:
    -
    -     		- -
    - - - Module - -
    - Signature:
    -
    -     		- -
    - - - NameSpace - -
    - Signature:
    -
    -     		- -
    - - - OverridenMethod - -
    - Signature:
    -
    -     		- -
    - - - Property - -
    - Signature:
    -
    -     		- -
    - - - Struct - -
    - Signature:
    -
    -     		- -
    - - - Type - -
    - Signature:
    -
    -     		- -
    - - - Typedef - -
    - Signature:
    -
    -     		- -
    - - - Union - -
    - Signature:
    -
    -     		- -
    - - - Variable - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfilecontents.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfilecontents.html deleted file mode 100644 index 77b132cd01..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfilecontents.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - FSharpImplementationFileContents - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpImplementationFileContents

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the definitional contents of a single file or fragment in an assembly, as seen by the F# language

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Declarations - -
    - Signature: FSharpImplementationFileDeclaration list
    -
    -     		-

    Get the declarations that make up this implementation file

    - - -

    CompiledName: get_Declarations

    -
    - - - FileName - -
    - Signature: string
    -
    -     		-

    Get the system path of the implementation file

    - - -

    CompiledName: get_FileName

    -
    - - - HasExplicitEntryPoint - -
    - Signature: bool
    -
    -     		-

    Indicates if the implementation file has an explicit entry point

    - - -

    CompiledName: get_HasExplicitEntryPoint

    -
    - - - IsScript - -
    - Signature: bool
    -
    -     		-

    Indicates if the implementation file is a script

    - - -

    CompiledName: get_IsScript

    -
    - - - QualifiedName - -
    - Signature: string
    -
    -     		-

    The qualified name acts to fully-qualify module specifications and implementations

    - - -

    CompiledName: get_QualifiedName

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfiledeclaration.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfiledeclaration.html deleted file mode 100644 index 95185c6ff5..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfiledeclaration.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - FSharpImplementationFileDeclaration - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpImplementationFileDeclaration

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a declaration in an implementation file, as seen by the F# language

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Entity(...) - -
    - Signature: FSharpEntity * FSharpImplementationFileDeclaration list
    -
    -     		-

    Represents the declaration of a type

    - - -
    - - - InitAction(FSharpExpr) - -
    - Signature: FSharpExpr
    -
    -     		-

    Represents the declaration of a static initialization action

    - - -
    - - - MemberOrFunctionOrValue(...) - -
    - Signature: FSharpMemberOrFunctionOrValue * FSharpMemberOrFunctionOrValue list list * FSharpExpr
    -
    -     		-

    Represents the declaration of a member, function or value, including the parameters and body of the member

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpinlineannotation.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpinlineannotation.html deleted file mode 100644 index 96cc6e1ac6..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpinlineannotation.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - FSharpInlineAnnotation - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpInlineAnnotation

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - AggressiveInline - -
    - Signature:
    -
    -     		-

    Indicates the value is aggressively inlined by the .NET runtime

    - - -
    - - - AlwaysInline - -
    - Signature:
    -
    -     		-

    Indicates the value is inlined but compiled code for the function still exists, e.g. to satisfy interfaces on objects, but that it is also always inlined

    - - -
    - - - NeverInline - -
    - Signature:
    -
    -     		-

    Indicates the value is never inlined

    - - -
    - - - OptionalInline - -
    - Signature:
    -
    -     		-

    Indicates the value is optionally inlined

    - - -
    - - - PseudoValue - -
    - Signature:
    -
    -     		-

    Indicates the value is inlined and compiled code for the function does not exist

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharplinetokenizer.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharplinetokenizer.html deleted file mode 100644 index c9058f8657..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharplinetokenizer.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - FSharpLineTokenizer - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpLineTokenizer

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Object to tokenize a line of F# source code, starting with the given lexState. The lexState should be FSharpTokenizerLexState.Initial for -the first line of text. Returns an array of ranges of the text and two enumerations categorizing the -tokens and characters covered by that range, i.e. FSharpTokenColorKind and FSharpTokenCharKind. The enumerations -are somewhat adhoc but useful enough to give good colorization options to the user in an IDE.

    -

    A new lexState is also returned. An IDE-plugin should in general cache the lexState -values for each line of the edited code.

    - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - ScanToken(lexState) - -
    - Signature: lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
    -
    -     		-

    Scan one token from the line

    - - -
    -

    Static members

    - - - - - - - - - - - - - - -
    Static memberDescription
    - - - ColorStateOfLexState(arg1) - -
    - Signature: FSharpTokenizerLexState -> FSharpTokenizerColorState
    -
    -     		- -
    - - - LexStateOfColorState(arg1) - -
    - Signature: FSharpTokenizerColorState -> FSharpTokenizerLexState
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmemberorfunctionorvalue.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmemberorfunctionorvalue.html deleted file mode 100644 index 7dc27732f1..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmemberorfunctionorvalue.html +++ /dev/null @@ -1,1074 +0,0 @@ - - - - - FSharpMemberOrFunctionOrValue - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpMemberOrFunctionOrValue

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A subtype of F# symbol that represents an F# method, property, event, function or value, including extension members.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Accessibility - -
    - Signature: FSharpAccessibility
    -
    -     		-

    Get the accessibility information for the member, function or value

    - - -

    CompiledName: get_Accessibility

    -
    - - - ApparentEnclosingEntity - -
    - Signature: FSharpEntity
    -
    -     		-

    Get the logical enclosing entity, which for an extension member is type being extended

    - - -

    CompiledName: get_ApparentEnclosingEntity

    -
    - - - Attributes - -
    - Signature: IList<FSharpAttribute>
    -
    -     		-

    Custom attributes attached to the value. These contain references to other values (i.e. constructors in types). Mutable to fixup
    -these value references after copying a collection of values.

    - - -

    CompiledName: get_Attributes

    -
    - - - CompiledName - -
    - Signature: string
    -
    -     		-

    Get the member name in compiled code

    - - -

    CompiledName: get_CompiledName

    -
    - - - CurriedParameterGroups - -
    - Signature: IList<IList<FSharpParameter>>
    -
    -     		- -

    CompiledName: get_CurriedParameterGroups

    -
    - - - DeclarationLocation - -
    - Signature: range
    -
    -     		-

    Get the declaration location of the member, function or value

    - - -

    CompiledName: get_DeclarationLocation

    -
    - - - DeclaringEntity - -
    - Signature: FSharpEntity option
    -
    -     		-

    Get the enclosing entity for the definition

    - - -

    CompiledName: get_DeclaringEntity

    -
    - - - DisplayName - -
    - Signature: string
    -
    -     		-

    Get the name as presented in F# error messages and documentation

    - - -

    CompiledName: get_DisplayName

    -
    - - - EventAddMethod - -
    - Signature: FSharpMemberOrFunctionOrValue
    -
    -     		-

    Get an associated add method of an event

    - - -

    CompiledName: get_EventAddMethod

    -
    - - - EventDelegateType - -
    - Signature: FSharpType
    -
    -     		-

    Get an associated delegate type of an event

    - - -

    CompiledName: get_EventDelegateType

    -
    - - - EventForFSharpProperty - -
    - Signature: FSharpMemberOrFunctionOrValue option
    -
    -     		-

    Gets the event symbol implied by the use of a property, -for the case where the property is actually an F#-declared CLIEvent.

    -

    Uses of F#-declared events are considered to be properties as far as the language specification -and this API are concerned.

    - - -

    CompiledName: get_EventForFSharpProperty

    -
    - - - EventIsStandard - -
    - Signature: bool
    -
    -     		-

    Indicate if an event can be considered to be a property for the F# type system of type IEvent or IDelegateEvent. -In this case ReturnParameter will have a type corresponding to the property type. For -non-standard events, ReturnParameter will have a type corresponding to the delegate type.

    - - -

    CompiledName: get_EventIsStandard

    -
    - - - EventRemoveMethod - -
    - Signature: FSharpMemberOrFunctionOrValue
    -
    -     		-

    Get an associated remove method of an event

    - - -

    CompiledName: get_EventRemoveMethod

    -
    - - - FormatLayout(context) - -
    - Signature: context:FSharpDisplayContext -> Layout
    -
    -     		-

    Format the type using the rules of the given display context

    - - -
    - - - FullType - -
    - Signature: FSharpType
    -
    -     		-

    Get the full type of the member, function or value when used as a first class value

    - - -

    CompiledName: get_FullType

    -
    - - - GenericParameters - -
    - Signature: IList<FSharpGenericParameter>
    -
    -     		-

    Get the typars of the member, function or value

    - - -

    CompiledName: get_GenericParameters

    -
    - - - GetterMethod - -
    - Signature: FSharpMemberOrFunctionOrValue
    -
    -     		-

    Get an associated getter method of the property

    - - -

    CompiledName: get_GetterMethod

    -
    - - - HasGetterMethod - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a property and there exists an associated getter method

    - - -

    CompiledName: get_HasGetterMethod

    -
    - - - HasSetterMethod - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a property and there exists an associated setter method

    - - -

    CompiledName: get_HasSetterMethod

    -
    - - - ImplementedAbstractSignatures - -
    - Signature: IList<FSharpAbstractSignature>
    -
    -     		-

    Gets the list of the abstract slot signatures implemented by the member

    - - -

    CompiledName: get_ImplementedAbstractSignatures

    -
    - - - InlineAnnotation - -
    - Signature: FSharpInlineAnnotation
    -
    -     		-

    Get a result indicating if this is a must-inline value

    - - -

    CompiledName: get_InlineAnnotation

    -
    - - - IsActivePattern - -
    - Signature: bool
    -
    -     		-

    Indicates if this value or member is an F# active pattern

    - - -

    CompiledName: get_IsActivePattern

    -
    - - - IsBaseValue - -
    - Signature: bool
    -
    -     		-

    Indicates if this is "base" in "base.M(...)"

    - - -

    CompiledName: get_IsBaseValue

    -
    - - - IsCompilerGenerated - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a compiler generated value

    - - -

    CompiledName: get_IsCompilerGenerated

    -
    - - - IsConstructor - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a constructor.

    - - -

    CompiledName: get_IsConstructor

    -
    - - - IsConstructorThisValue - -
    - Signature: bool
    -
    -     		-

    Indicates if this is the "x" in "type C() as x = ..."

    - - -

    CompiledName: get_IsConstructorThisValue

    -
    - - - IsDispatchSlot - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an abstract member?

    - - -

    CompiledName: get_IsDispatchSlot

    -
    - - - IsEvent - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an event member

    - - -

    CompiledName: get_IsEvent

    -
    - - - IsEventAddMethod - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an add method for an event

    - - -

    CompiledName: get_IsEventAddMethod

    -
    - - - IsEventRemoveMethod - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a remove method for an event

    - - -

    CompiledName: get_IsEventRemoveMethod

    -
    - - - IsExplicitInterfaceImplementation - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an explicit implementation of an interface member

    - - -

    CompiledName: get_IsExplicitInterfaceImplementation

    -
    - - - IsExtensionMember - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an extension member?

    - - -

    CompiledName: get_IsExtensionMember

    -
    - - - IsGetterMethod - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a getter method for a property, or a use of a property in getter mode

    - - -

    CompiledName: get_IsGetterMethod

    -
    - - - IsImplicitConstructor - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an implicit constructor?

    - - -

    CompiledName: get_IsImplicitConstructor

    -
    - - - IsInstanceMember - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an instance member, when seen from F#?

    - - -

    CompiledName: get_IsInstanceMember

    -
    - - - IsInstanceMemberInCompiledCode - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an instance member in compiled code.

    -

    Explanatory note: some members such as IsNone and IsSome on types with UseNullAsTrueValue appear -as instance members in F# code but are compiled as static members.

    - - -

    CompiledName: get_IsInstanceMemberInCompiledCode

    -
    - - - IsMember - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a member, including extension members?

    - - -

    CompiledName: get_IsMember

    -
    - - - IsMemberThisValue - -
    - Signature: bool
    -
    -     		-

    Indicates if this is the "x" in "member x.M = ..."

    - - -

    CompiledName: get_IsMemberThisValue

    -
    - - - IsModuleValueOrMember - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a module or member value

    - - -

    CompiledName: get_IsModuleValueOrMember

    -
    - - - IsMutable - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a mutable value

    - - -

    CompiledName: get_IsMutable

    -
    - - - IsOverrideOrExplicitInterfaceImplementation(...) - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an 'override', 'default' or an explicit implementation of an interface member

    - - -

    CompiledName: get_IsOverrideOrExplicitInterfaceImplementation

    -
    - - - IsOverrideOrExplicitMember - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsOverrideOrExplicitMember

    -
    - - - IsProperty - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a property member

    - - -

    CompiledName: get_IsProperty

    -
    - - - IsPropertyGetterMethod - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a getter method for a property, or a use of a property in getter mode

    - - -

    CompiledName: get_IsPropertyGetterMethod

    -
    - - - IsPropertySetterMethod - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a setter method for a property, or a use of a property in setter mode

    - - -

    CompiledName: get_IsPropertySetterMethod

    -
    - - - IsSetterMethod - -
    - Signature: bool
    -
    -     		-

    Indicates if this is a setter method for a property, or a use of a property in setter mode

    - - -

    CompiledName: get_IsSetterMethod

    -
    - - - IsTypeFunction - -
    - Signature: bool
    -
    -     		-

    Indicates if this is an F# type function

    - - -

    CompiledName: get_IsTypeFunction

    -
    - - - IsUnresolved - -
    - Signature: bool
    -
    -     		-

    Indicates if the member, function or value is in an unresolved assembly

    - - -

    CompiledName: get_IsUnresolved

    -
    - - - IsValCompiledAsMethod - -
    - Signature: bool
    -
    -     		-

    Indicated if this is a value compiled to a method

    - - -

    CompiledName: get_IsValCompiledAsMethod

    -
    - - - IsValue - -
    - Signature: bool
    -
    -     		-

    Indicated if this is a value

    - - -

    CompiledName: get_IsValue

    -
    - - - LiteralValue - -
    - Signature: obj option
    -
    -     		-

    Indicates if this is a [] value, and if so what value? (may be null)

    - - -

    CompiledName: get_LiteralValue

    -
    - - - LogicalName - -
    - Signature: string
    -
    -     		-

    Get the logical name of the member

    - - -

    CompiledName: get_LogicalName

    -
    - - - Overloads(arg1) - -
    - Signature: bool -> IList<FSharpMemberOrFunctionOrValue> option
    -
    -     		-

    Gets the overloads for the current method -matchParameterNumber indicates whether to filter the overloads to match the number of parameters in the current symbol

    - - -
    - - - ReturnParameter - -
    - Signature: FSharpParameter
    -
    -     		- -

    CompiledName: get_ReturnParameter

    -
    - - - SetterMethod - -
    - Signature: FSharpMemberOrFunctionOrValue
    -
    -     		-

    Get an associated setter method of the property

    - - -

    CompiledName: get_SetterMethod

    -
    - - - XmlDoc - -
    - Signature: IList<string>
    -
    -     		-

    Get the in-memory XML documentation for the value, used when code is checked in-memory

    - - -

    CompiledName: get_XmlDoc

    -
    - - - XmlDocSig - -
    - Signature: string
    -
    -     		-

    XML documentation signature for the value, used for .xml file lookup for compiled code

    - - -

    CompiledName: get_XmlDocSig

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroup.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroup.html deleted file mode 100644 index e48be2ab10..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroup.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - FSharpMethodGroup - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpMethodGroup

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a group of methods (or other items) returned by GetMethods.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - MethodName - -
    - Signature: string
    -
    -     		-

    The shared name of the methods (or other items) in the group

    - - -

    CompiledName: get_MethodName

    -
    - - - Methods - -
    - Signature: FSharpMethodGroupItem []
    -
    -     		-

    The methods (or other items) in the group

    - - -

    CompiledName: get_Methods

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitem.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitem.html deleted file mode 100644 index 1a9033ed82..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitem.html +++ /dev/null @@ -1,258 +0,0 @@ - - - - - FSharpMethodGroupItem - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpMethodGroupItem

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents one method (or other item) in a method group. The item may represent either a method or -a single, non-overloaded item such as union case or a named function value.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Description - -
    - Signature: FSharpToolTipText
    -
    -     		-

    The formatted description text for the method (or other item)

    - - -

    CompiledName: get_Description

    -
    - - - HasParamArrayArg - -
    - Signature: bool
    -
    -     		-

    Does the method support a params list arg?

    - - -

    CompiledName: get_HasParamArrayArg

    -
    - - - HasParameters - -
    - Signature: bool
    -
    -     		-

    Does the method support an arguments list? This is always true except for static type instantiations like TP<42,"foo">.

    - - -

    CompiledName: get_HasParameters

    -
    - - - Parameters - -
    - Signature: FSharpMethodGroupItemParameter []
    -
    -     		-

    The parameters of the method in the overload set

    - - -

    CompiledName: get_Parameters

    -
    - - - ReturnTypeText - -
    - Signature: string
    -
    -     		-

    The formatted type text for the method (or other item)

    - - -

    CompiledName: get_ReturnTypeText

    -
    - - - StaticParameters - -
    - Signature: FSharpMethodGroupItemParameter []
    -
    -     		-

    Does the type name or method support a static arguments list, like TP<42,"foo"> or conn.CreateCommand<42, "foo">(arg1, arg2)?

    - - -

    CompiledName: get_StaticParameters

    -
    - - - StructuredDescription - -
    - Signature: FSharpStructuredToolTipText
    -
    -     		-

    The structured description representation for the method (or other item)

    - - -

    CompiledName: get_StructuredDescription

    -
    - - - StructuredReturnTypeText - -
    - Signature: Layout
    -
    -     		-

    The The structured description representation for the method (or other item)

    - - -

    CompiledName: get_StructuredReturnTypeText

    -
    - - - XmlDoc - -
    - Signature: FSharpXmlDoc
    -
    -     		-

    The documentation for the item

    - - -

    CompiledName: get_XmlDoc

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitemparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitemparameter.html deleted file mode 100644 index cd33a5f9ba..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitemparameter.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - FSharpMethodGroupItemParameter - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpMethodGroupItemParameter

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents one parameter for one method (or other item) in a group.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CanonicalTypeTextForSorting - -
    - Signature: string
    -
    -     		-

    A key that can be used for sorting the parameters, used to help sort overloads.

    - - -

    CompiledName: get_CanonicalTypeTextForSorting

    -
    - - - Display - -
    - Signature: string
    -
    -     		-

    The text to display for the parameter including its name, its type and visual indicators of other -information such as whether it is optional.

    - - -

    CompiledName: get_Display

    -
    - - - IsOptional - -
    - Signature: bool
    -
    -     		-

    Is the parameter optional

    - - -

    CompiledName: get_IsOptional

    -
    - - - ParameterName - -
    - Signature: string
    -
    -     		-

    The name of the parameter.

    - - -

    CompiledName: get_ParameterName

    -
    - - - StructuredDisplay - -
    - Signature: Layout
    -
    -     		-

    The structured representation for the parameter including its name, its type and visual indicators of other -information such as whether it is optional.

    - - -

    CompiledName: get_StructuredDisplay

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitem.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitem.html deleted file mode 100644 index fccced5783..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitem.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - FSharpNavigationDeclarationItem - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpNavigationDeclarationItem

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents an item to be displayed in the navigation bar

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Access - -
    - Signature: SynAccess option
    -
    -     		- -

    CompiledName: get_Access

    -
    - - - BodyRange - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_BodyRange

    -
    - - - EnclosingEntityKind - -
    - Signature: FSharpEnclosingEntityKind
    -
    -     		- -

    CompiledName: get_EnclosingEntityKind

    -
    - - - Glyph - -
    - Signature: FSharpGlyph
    -
    -     		- -

    CompiledName: get_Glyph

    -
    - - - IsAbstract - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsAbstract

    -
    - - - IsSingleTopLevel - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsSingleTopLevel

    -
    - - - Kind - -
    - Signature: FSharpNavigationDeclarationItemKind
    -
    -     		- -

    CompiledName: get_Kind

    -
    - - - Name - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_Name

    -
    - - - Range - -
    - Signature: range
    -
    -     		- -

    CompiledName: get_Range

    -
    - - - UniqueName - -
    - Signature: string
    -
    -     		- -

    CompiledName: get_UniqueName

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitemkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitemkind.html deleted file mode 100644 index 8ea5fd83ff..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitemkind.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - FSharpNavigationDeclarationItemKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpNavigationDeclarationItemKind

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Indicates a kind of item to show in an F# navigation bar

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ExnDecl - -
    - Signature:
    -
    -     		- -
    - - - FieldDecl - -
    - Signature:
    -
    -     		- -
    - - - MethodDecl - -
    - Signature:
    -
    -     		- -
    - - - ModuleDecl - -
    - Signature:
    -
    -     		- -
    - - - ModuleFileDecl - -
    - Signature:
    -
    -     		- -
    - - - NamespaceDecl - -
    - Signature:
    -
    -     		- -
    - - - OtherDecl - -
    - Signature:
    -
    -     		- -
    - - - PropertyDecl - -
    - Signature:
    -
    -     		- -
    - - - TypeDecl - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationitems.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationitems.html deleted file mode 100644 index aaa9ee3624..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationitems.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - FSharpNavigationItems - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpNavigationItems

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents result of 'GetNavigationItems' operation - this contains -all the members and currently selected indices. First level correspond to -types & modules and second level are methods etc.

    - -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Declarations - -
    - Signature: FSharpNavigationTopLevelDeclaration []
    -
    -     		- -

    CompiledName: get_Declarations

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationtopleveldeclaration.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationtopleveldeclaration.html deleted file mode 100644 index d68a264d49..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationtopleveldeclaration.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - FSharpNavigationTopLevelDeclaration - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpNavigationTopLevelDeclaration

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents top-level declarations (that should be in the type drop-down) -with nested declarations (that can be shown in the member drop-down)

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Declaration - -
    - Signature: FSharpNavigationDeclarationItem
    -
    -     		- -
    - - - Nested - -
    - Signature: FSharpNavigationDeclarationItem []
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnoteworthyparaminfolocations.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnoteworthyparaminfolocations.html deleted file mode 100644 index 9ac8689370..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnoteworthyparaminfolocations.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - FSharpNoteworthyParamInfoLocations - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpNoteworthyParamInfoLocations

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the locations relevant to activating parameter info in an IDE

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - IsThereACloseParen - -
    - Signature: bool
    -
    -     		-

    Is false if either this is a call without parens "f x" or the parser recovered as in "f(x,y"

    - - -

    CompiledName: get_IsThereACloseParen

    -
    - - - LongId - -
    - Signature: string list
    -
    -     		-

    The text of the long identifier prior to the open-parentheses

    - - -

    CompiledName: get_LongId

    -
    - - - LongIdEndLocation - -
    - Signature: pos
    -
    -     		-

    The end location of long identifier prior to the open-parentheses

    - - -

    CompiledName: get_LongIdEndLocation

    -
    - - - LongIdStartLocation - -
    - Signature: pos
    -
    -     		-

    The start location of long identifier prior to the open-parentheses

    - - -

    CompiledName: get_LongIdStartLocation

    -
    - - - NamedParamNames - -
    - Signature: string option []
    -
    -     		-

    Either empty or a name if an actual named parameter; f(0,a=4,?b=None) would be [|None; Some "a"; Some "b"|]

    - - -

    CompiledName: get_NamedParamNames

    -
    - - - OpenParenLocation - -
    - Signature: pos
    -
    -     		-

    The location of the open-parentheses

    - - -

    CompiledName: get_OpenParenLocation

    -
    - - - TupleEndLocations - -
    - Signature: pos []
    -
    -     		-

    The locations of commas and close parenthesis (or, last char of last arg, if no final close parenthesis)

    - - -

    CompiledName: get_TupleEndLocations

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Find(arg1, arg2) - -
    - Signature: (pos * ParsedInput) -> FSharpNoteworthyParamInfoLocations option
    -
    -     		-

    Find the information about parameter info locations at a particular source location

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpobjectexproverride.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpobjectexproverride.html deleted file mode 100644 index edf111c24f..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpobjectexproverride.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - FSharpObjectExprOverride - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpObjectExprOverride

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a checked method in an object expression, as seen by the F# language.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Body - -
    - Signature: FSharpExpr
    -
    -     		-

    The expression that forms the body of the method

    - - -

    CompiledName: get_Body

    -
    - - - CurriedParameterGroups - -
    - Signature: FSharpMemberOrFunctionOrValue list list
    -
    -     		-

    The parameters of the method

    - - -

    CompiledName: get_CurriedParameterGroups

    -
    - - - GenericParameters - -
    - Signature: FSharpGenericParameter list
    -
    -     		-

    The generic parameters of the method

    - - -

    CompiledName: get_GenericParameters

    -
    - - - Signature - -
    - Signature: FSharpAbstractSignature
    -
    -     		-

    The signature of the implemented abstract slot

    - - -

    CompiledName: get_Signature

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpopendeclaration.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpopendeclaration.html deleted file mode 100644 index f7113f12ea..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpopendeclaration.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - FSharpOpenDeclaration - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpOpenDeclaration

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents open declaration in F# code.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AppliedScope - -
    - Signature: range
    -
    -     		-

    Scope in which open declaration is visible.

    - - -

    CompiledName: get_AppliedScope

    -
    - - - IsOwnNamespace - -
    - Signature: bool
    -
    -     		-

    If it's namespace Xxx.Yyy declaration.

    - - -

    CompiledName: get_IsOwnNamespace

    -
    - - - LongId - -
    - Signature: Ident list
    -
    -     		-

    Idents.

    - - -

    CompiledName: get_LongId

    -
    - - - Modules - -
    - Signature: FSharpEntity list
    -
    -     		-

    Modules or namespaces which is opened with this declaration.

    - - -

    CompiledName: get_Modules

    -
    - - - Range - -
    - Signature: range option
    -
    -     		-

    Range of the open declaration.

    - - -

    CompiledName: get_Range

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparameter.html deleted file mode 100644 index 2693d566a8..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparameter.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - FSharpParameter - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpParameter

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A subtype of FSharpSymbol that represents a parameter

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Attributes - -
    - Signature: IList<FSharpAttribute>
    -
    -     		-

    The declared attributes of the parameter

    - - -

    CompiledName: get_Attributes

    -
    - - - DeclarationLocation - -
    - Signature: range
    -
    -     		-

    The declaration location of the parameter

    - - -

    CompiledName: get_DeclarationLocation

    -
    - - - IsInArg - -
    - Signature: bool
    -
    -     		-

    Indicate this is an in argument

    - - -

    CompiledName: get_IsInArg

    -
    - - - IsOptionalArg - -
    - Signature: bool
    -
    -     		-

    Indicate this is an optional argument

    - - -

    CompiledName: get_IsOptionalArg

    -
    - - - IsOutArg - -
    - Signature: bool
    -
    -     		-

    Indicate this is an out argument

    - - -

    CompiledName: get_IsOutArg

    -
    - - - IsParamArrayArg - -
    - Signature: bool
    -
    -     		-

    Indicate this is a param array argument

    - - -

    CompiledName: get_IsParamArrayArg

    -
    - - - Name - -
    - Signature: string option
    -
    -     		-

    The optional name of the parameter

    - - -

    CompiledName: get_Name

    -
    - - - Type - -
    - Signature: FSharpType
    -
    -     		-

    The declared or inferred type of the parameter

    - - -

    CompiledName: get_Type

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsefileresults.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsefileresults.html deleted file mode 100644 index 2438a5a798..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsefileresults.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - FSharpParseFileResults - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpParseFileResults

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the results of parsing an F# file

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DependencyFiles - -
    - Signature: string []
    -
    -     		-

    When these files change then the build is invalid

    - - -

    CompiledName: get_DependencyFiles

    -
    - - - Errors - -
    - Signature: FSharpErrorInfo []
    -
    -     		-

    Get the errors and warnings for the parse

    - - -

    CompiledName: get_Errors

    -
    - - - FileName - -
    - Signature: string
    -
    -     		-

    Name of the file for which this information were created

    - - -

    CompiledName: get_FileName

    -
    - - - FindNoteworthyParamInfoLocations(pos) - -
    - Signature: pos:pos -> FSharpNoteworthyParamInfoLocations option
    -
    -     		-

    Notable parse info for ParameterInfo at a given location

    - - -
    - - - GetNavigationItems() - -
    - Signature: unit -> FSharpNavigationItems
    -
    -     		-

    Get declared items and the selected item at the specified location

    - - -
    - - - ParseHadErrors - -
    - Signature: bool
    -
    -     		-

    Indicates if any errors occurred during the parse

    - - -

    CompiledName: get_ParseHadErrors

    -
    - - - ParseTree - -
    - Signature: ParsedInput option
    -
    -     		-

    The syntax tree resulting from the parse

    - - -

    CompiledName: get_ParseTree

    -
    - - - ValidateBreakpointLocation(pos) - -
    - Signature: pos:pos -> range option
    -
    -     		-

    Return the inner-most range associated with a possible breakpoint location

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html deleted file mode 100644 index e796e8ba13..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - FSharpParsingOptions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpParsingOptions

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Options used to determine active --define conditionals and other options relevant to parsing files in a project

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - CompilingFsLib - -
    - Signature: bool
    -
    -     		- -
    - - - ConditionalCompilationDefines - -
    - Signature: string list
    -
    -     		- -
    - - - ErrorSeverityOptions - -
    - Signature: FSharpErrorSeverityOptions
    -
    -     		- -
    - - - IsExe - -
    - Signature: bool
    -
    -     		- -
    - - - IsInteractive - -
    - Signature: bool
    -
    -     		- -
    - - - LightSyntax - -
    - Signature: bool option
    -
    -     		- -
    - - - SourceFiles - -
    - Signature: string []
    -
    -     		- -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Default - -
    - Signature: FSharpParsingOptions
    -
    -     		- -

    CompiledName: get_Default

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html deleted file mode 100644 index c0981c3058..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - FSharpProjectContext - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpProjectContext

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the checking context implied by the ProjectOptions

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AccessibilityRights - -
    - Signature: FSharpAccessibilityRights
    -
    -     		-

    Get the accessibility rights for this project context w.r.t. InternalsVisibleTo attributes granting access to other assemblies

    - - -

    CompiledName: get_AccessibilityRights

    -
    - - - GetReferencedAssemblies() - -
    - Signature: unit -> FSharpAssembly list
    -
    -     		-

    Get the resolution and full contents of the assemblies referenced by the project options

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html deleted file mode 100644 index 1ae2e4ef8b..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html +++ /dev/null @@ -1,301 +0,0 @@ - - - - - FSharpProjectOptions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpProjectOptions

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A set of information describing a project or script build configuration.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - ExtraProjectInfo - -
    - Signature: obj option
    -
    -     		-

    Extra information passed back on event trigger

    - - -
    - - - IsIncompleteTypeCheckEnvironment - -
    - Signature: bool
    -
    -     		-

    When true, the typechecking environment is known a priori to be incomplete, for -example when a .fs file is opened outside of a project. In this case, the number of error -messages reported is reduced.

    - - -
    - - - LoadTime - -
    - Signature: DateTime
    -
    -     		-

    Timestamp of project/script load, used to differentiate between different instances of a project load. -This ensures that a complete reload of the project or script type checking -context occurs on project or script unload/reload.

    - - -
    - - - OriginalLoadReferences - -
    - Signature: (range * string) list
    -
    -     		-

    Unused in this API and should be '[]' when used as user-specified input

    - - -
    - - - OtherOptions - -
    - Signature: string []
    -
    -     		-

    Additional command line argument options for the project. These can include additional files and references.

    - - -
    - - - ProjectFileName - -
    - Signature: string
    -
    -     		- -
    - - - ProjectId - -
    - Signature: string option
    -
    -     		-

    This is the unique identifier for the project, it is case sensitive. If it's None, will key off of ProjectFileName in our caching.

    - - -
    - - - ReferencedProjects - -
    - Signature: (string * FSharpProjectOptions) []
    -
    -     		-

    The command line arguments for the other projects referenced by this project, indexed by the -exact text used in the "-r:" reference in FSharpProjectOptions.

    - - -
    - - - SourceFiles - -
    - Signature: string []
    -
    -     		-

    The files in the project

    - - -
    - - - Stamp - -
    - Signature: int64 option
    -
    -     		-

    An optional stamp to uniquely identify this set of options -If two sets of options both have stamps, then they are considered equal -if and only if the stamps are equal

    - - -
    - - - UnresolvedReferences - -
    - Signature: UnresolvedReferencesSet option
    -
    -     		-

    Unused in this API and should be 'None' when used as user-specified input

    - - -
    - - - UseScriptResolutionRules - -
    - Signature: bool
    -
    -     		-

    When true, use the reference resolution rules for scripts rather than the rules for compiler.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsourcetokenizer.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsourcetokenizer.html deleted file mode 100644 index 6211ab54b4..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsourcetokenizer.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - FSharpSourceTokenizer - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpSourceTokenizer

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Tokenizer for a source file. Holds some expensive-to-compute resources at the scope of the file.

    - -
    -

    Constructors

    - - - - - - - - - - -
    ConstructorDescription
    - - - new(conditionalDefines, fileName) - -
    - Signature: (conditionalDefines:string list * fileName:string option) -> FSharpSourceTokenizer
    -
    -     		- -

    CompiledName: .ctor

    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - CreateBufferTokenizer(bufferFiller) - -
    - Signature: (bufferFiller:(char [] * int * int -> int)) -> FSharpLineTokenizer
    -
    -     		- -
    - - - CreateLineTokenizer(lineText) - -
    - Signature: lineText:string -> FSharpLineTokenizer
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstaticparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstaticparameter.html deleted file mode 100644 index dba0b9ca3c..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstaticparameter.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - FSharpStaticParameter - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpStaticParameter

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A subtype of FSharpSymbol that represents a static parameter to an F# type provider

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DeclarationLocation - -
    - Signature: range
    -
    -     		-

    Get the declaration location of the static parameter

    - - -

    CompiledName: get_DeclarationLocation

    -
    - - - DefaultValue - -
    - Signature: obj
    -
    -     		-

    Get the default value for the static parameter

    - - -

    CompiledName: get_DefaultValue

    -
    - - - HasDefaultValue - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_HasDefaultValue

    -
    - - - IsOptional - -
    - Signature: bool
    -
    -     		-

    Indicates if the static parameter is optional

    - - -

    CompiledName: get_IsOptional

    -
    - - - Kind - -
    - Signature: FSharpType
    -
    -     		-

    Get the kind of the static parameter

    - - -

    CompiledName: get_Kind

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    Get the name of the static parameter

    - - -

    CompiledName: get_Name

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltipelement.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltipelement.html deleted file mode 100644 index 9679477453..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltipelement.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - FSharpStructuredToolTipElement - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpStructuredToolTipElement

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A single data tip display element with where text is expressed as

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltiptext.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltiptext.html deleted file mode 100644 index f3c4822d1d..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltiptext.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpStructuredToolTipText - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpStructuredToolTipText

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymbol.html deleted file mode 100644 index e267ea927b..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymbol.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - FSharpSymbol - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpSymbol

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents a symbol in checked F# source code or a compiled .NET component.

    -

    The subtype of the symbol may reveal further information and can be one of FSharpEntity, FSharpUnionCase -FSharpField, FSharpGenericParameter, FSharpStaticParameter, FSharpMemberOrFunctionOrValue, FSharpParameter, -or FSharpActivePatternCase.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Assembly - -
    - Signature: FSharpAssembly
    -
    -     		-

    Get the assembly declaring this symbol

    - - -

    CompiledName: get_Assembly

    -
    - - - DeclarationLocation - -
    - Signature: range option
    -
    -     		-

    Get the declaration location for the symbol

    - - -

    CompiledName: get_DeclarationLocation

    -
    - - - DisplayName - -
    - Signature: string
    -
    -     		-

    Gets the short display name for the symbol

    - - -

    CompiledName: get_DisplayName

    -
    - - - FullName - -
    - Signature: string
    -
    -     		-

    Get a textual representation of the full name of the symbol. The text returned for some symbols -may not be a valid identifier path in F# code, but rather a human-readable representation of the symbol.

    - - -

    CompiledName: get_FullName

    -
    - - - GetEffectivelySameAsHash() - -
    - Signature: unit -> int
    -
    -     		-

    A hash compatible with the IsEffectivelySameAs relation

    - - -
    - - - ImplementationLocation - -
    - Signature: range option
    -
    -     		-

    Get the implementation location for the symbol if it was declared in a signature that has an implementation

    - - -

    CompiledName: get_ImplementationLocation

    -
    - - - IsAccessible(arg1) - -
    - Signature: FSharpAccessibilityRights -> bool
    -
    -     		-

    Computes if the symbol is accessible for the given accessibility rights

    - - -
    - - - IsEffectivelySameAs(other) - -
    - Signature: other:FSharpSymbol -> bool
    -
    -     		-

    Return true if two symbols are effectively the same when referred to in F# source code text.
    -This sees through signatures (a symbol in a signature will be considered effectively the same as -the matching symbol in an implementation). In addition, other equivalances are applied -when the same F# source text implies the same declaration name - for example, constructors -are considered to be effectively the same symbol as the corresponding type definition.

    -

    This is the relation used by GetUsesOfSymbol and GetUsesOfSymbolInFile.

    - - -
    - - - IsExplicitlySuppressed - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsExplicitlySuppressed

    -
    - - - SignatureLocation - -
    - Signature: range option
    -
    -     		-

    Get the signature location for the symbol if it was declared in an implementation

    - - -

    CompiledName: get_SignatureLocation

    -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - GetAccessibility(arg1) - -
    - Signature: FSharpSymbol -> FSharpAccessibility option
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymboluse.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymboluse.html deleted file mode 100644 index 521b370fbc..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymboluse.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - FSharpSymbolUse - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpSymbolUse

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the use of an F# symbol from F# source code

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - DisplayContext - -
    - Signature: FSharpDisplayContext
    -
    -     		-

    The display context active at the point where the symbol is used. Can be passed to FSharpType.Format -and other methods to format items in a way that is suitable for a specific source code location.

    - - -

    CompiledName: get_DisplayContext

    -
    - - - FileName - -
    - Signature: string
    -
    -     		-

    The file name the reference occurs in

    - - -

    CompiledName: get_FileName

    -
    - - - IsFromAttribute - -
    - Signature: bool
    -
    -     		-

    Indicates if the reference is in an attribute

    - - -

    CompiledName: get_IsFromAttribute

    -
    - - - IsFromComputationExpression - -
    - Signature: bool
    -
    -     		-

    Indicates if the reference is either a builder or a custom operation in a computation expression

    - - -

    CompiledName: get_IsFromComputationExpression

    -
    - - - IsFromDefinition - -
    - Signature: bool
    -
    -     		-

    Indicates if the reference is a definition for the symbol, either in a signature or implementation

    - - -

    CompiledName: get_IsFromDefinition

    -
    - - - IsFromDispatchSlotImplementation - -
    - Signature: bool
    -
    -     		-

    Indicates if the reference is via the member being implemented in a class or object expression

    - - -

    CompiledName: get_IsFromDispatchSlotImplementation

    -
    - - - IsFromOpenStatement - -
    - Signature: bool
    -
    -     		-

    Indicates if the reference is in open statement

    - - -

    CompiledName: get_IsFromOpenStatement

    -
    - - - IsFromPattern - -
    - Signature: bool
    -
    -     		-

    Indicates if the reference is in a pattern

    - - -

    CompiledName: get_IsFromPattern

    -
    - - - IsFromType - -
    - Signature: bool
    -
    -     		-

    Indicates if the reference is in a syntactic type

    - - -

    CompiledName: get_IsFromType

    -
    - - - RangeAlternate - -
    - Signature: range
    -
    -     		-

    The range of text representing the reference to the symbol

    - - -

    CompiledName: get_RangeAlternate

    -
    - - - Symbol - -
    - Signature: FSharpSymbol
    -
    -     		-

    The symbol referenced

    - - -

    CompiledName: get_Symbol

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencharkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencharkind.html deleted file mode 100644 index b99534ce9d..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencharkind.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - FSharpTokenCharKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpTokenCharKind

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Gives an indication of the class to assign to the characters of the token an IDE

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Comment - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - Default - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - Delimiter - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - Identifier - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - Keyword - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - LineComment - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - Literal - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - Operator - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - String - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - Text - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - - - WhiteSpace - -
    - Signature: FSharpTokenCharKind
    - Modifiers: static
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencolorkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencolorkind.html deleted file mode 100644 index 84bfe87503..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencolorkind.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - FSharpTokenColorKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpTokenColorKind

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Gives an indicattion of the color class to assign to the token an IDE

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Comment - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - Default - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - Identifier - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - InactiveCode - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - Keyword - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - Number - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - Operator - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - PreprocessorKeyword - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - Punctuation - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - String - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - Text - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - - - UpperIdentifier - -
    - Signature: FSharpTokenColorKind
    - Modifiers: static
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokeninfo.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokeninfo.html deleted file mode 100644 index 0b5144cf43..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokeninfo.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - FSharpTokenInfo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpTokenInfo

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Information about a particular token from the tokenizer

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - CharClass - -
    - Signature: FSharpTokenCharKind
    -
    -     		-

    Gives an indication of the class to assign to the token an IDE

    - - -
    - - - ColorClass - -
    - Signature: FSharpTokenColorKind
    -
    -     		- -
    - - - FSharpTokenTriggerClass - -
    - Signature: FSharpTokenTriggerClass
    -
    -     		-

    Actions taken when the token is typed

    - - -
    - - - FullMatchedLength - -
    - Signature: int
    -
    -     		-

    The full length consumed by this match, including delayed tokens (which can be ignored in naive lexers)

    - - -
    - - - LeftColumn - -
    - Signature: int
    -
    -     		-

    Left column of the token.

    - - -
    - - - RightColumn - -
    - Signature: int
    -
    -     		-

    Right column of the token.

    - - -
    - - - Tag - -
    - Signature: int
    -
    -     		-

    The tag is an integer identifier for the token

    - - -
    - - - TokenName - -
    - Signature: string
    -
    -     		-

    Provides additional information about the token

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizercolorstate.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizercolorstate.html deleted file mode 100644 index e45b57fc72..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizercolorstate.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - FSharpTokenizerColorState - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpTokenizerColorState

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents stable information for the state of the laxing engine at the end of a line

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - CamlOnly - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - Comment - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - EndLineThenSkip - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - EndLineThenToken - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - IfDefSkip - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - InitialState - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - SingleLineComment - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - String - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - StringInComment - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - Token - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - TripleQuoteString - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - TripleQuoteStringInComment - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - VerbatimString - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - - - VerbatimStringInComment - -
    - Signature: FSharpTokenizerColorState
    - Modifiers: static
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizerlexstate.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizerlexstate.html deleted file mode 100644 index bb94c3a8ff..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizerlexstate.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - FSharpTokenizerLexState - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpTokenizerLexState

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents encoded information for the end-of-line continuation of lexing

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - OtherBits - -
    - Signature: int64
    -
    -     		- -
    - - - PosBits - -
    - Signature: int64
    -
    -     		- -
    -

    Instance members

    - - - - - - - - - - -
    Instance memberDescription
    - - - Equals(arg1) - -
    - Signature: FSharpTokenizerLexState -> bool
    -
    -     		- -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Initial - -
    - Signature: FSharpTokenizerLexState
    -
    -     		- -

    CompiledName: get_Initial

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentag.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentag.html deleted file mode 100644 index 5c0e725ff3..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentag.html +++ /dev/null @@ -1,1051 +0,0 @@ - - - - - FSharpTokenTag - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpTokenTag

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Some of the values in the field FSharpTokenInfo.Tag

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - AMP_AMP - -
    - Signature: int
    -
    -     		-

    Indicates the token is a @@

    - - -
    - - - BAR - -
    - Signature: int
    -
    -     		-

    Indicates the token is a _

    - - -
    - - - BAR_BAR - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ||

    - - -
    - - - BAR_RBRACK - -
    - Signature: int
    -
    -     		-

    Indicates the token is a |]

    - - -
    - - - BEGIN - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword begin

    - - -
    - - - CLASS - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword class

    - - -
    - - - COLON - -
    - Signature: int
    -
    -     		-

    Indicates the token is a :

    - - -
    - - - COLON_COLON - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ::

    - - -
    - - - COLON_EQUALS - -
    - Signature: int
    -
    -     		-

    Indicates the token is a :=

    - - -
    - - - COLON_GREATER - -
    - Signature: int
    -
    -     		-

    Indicates the token is a :>

    - - -
    - - - COLON_QMARK - -
    - Signature: int
    -
    -     		-

    Indicates the token is a :?

    - - -
    - - - COLON_QMARK_GREATER - -
    - Signature: int
    -
    -     		-

    Indicates the token is a :?>

    - - -
    - - - COMMA - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ,

    - - -
    - - - COMMENT - -
    - Signature: int
    -
    -     		-

    Indicates the token is a comment

    - - -
    - - - DO - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword do

    - - -
    - - - DOT - -
    - Signature: int
    -
    -     		-

    Indicates the token is a .

    - - -
    - - - DOT_DOT - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ..

    - - -
    - - - ELSE - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword else

    - - -
    - - - EQUALS - -
    - Signature: int
    -
    -     		-

    Indicates the token is a =

    - - -
    - - - FUNCTION - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword function

    - - -
    - - - GREATER - -
    - Signature: int
    -
    -     		-

    Indicates the token is a >

    - - -
    - - - GREATER_RBRACK - -
    - Signature: int
    -
    -     		-

    Indicates the token is a >]

    - - -
    - - - IDENT - -
    - Signature: int
    -
    -     		-

    Indicates the token is an identifier (synonym for FSharpTokenTag.Identifier)

    - - -
    - - - Identifier - -
    - Signature: int
    -
    -     		-

    Indicates the token is an identifier

    - - -
    - - - INFIX_AT_HAT_OP - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ^

    - - -
    - - - INFIX_BAR_OP - -
    - Signature: int
    -
    -     		-

    Indicates the token is a |

    - - -
    - - - INFIX_COMPARE_OP - -
    - Signature: int
    -
    -     		-

    Indicates the token is a |

    - - -
    - - - INFIX_STAR_DIV_MOD_OP - -
    - Signature: int
    -
    -     		-

    Indicates the token is a %

    - - -
    - - - INT32_DOT_DOT - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ..

    - - -
    - - - LARROW - -
    - Signature: int
    -
    -     		-

    Indicates the token is a <-

    - - -
    - - - LBRACE - -
    - Signature: int
    -
    -     		-

    Indicates the token is a {

    - - -
    - - - LBRACK - -
    - Signature: int
    -
    -     		-

    Indicates the token is a [

    - - -
    - - - LBRACK_BAR - -
    - Signature: int
    -
    -     		-

    Indicates the token is a [|

    - - -
    - - - LBRACK_LESS - -
    - Signature: int
    -
    -     		-

    Indicates the token is a [<

    - - -
    - - - LESS - -
    - Signature: int
    -
    -     		-

    Indicates the token is a <

    - - -
    - - - LINE_COMMENT - -
    - Signature: int
    -
    -     		-

    Indicates the token is a line comment

    - - -
    - - - LPAREN - -
    - Signature: int
    -
    -     		-

    Indicates the token is a (

    - - -
    - - - MINUS - -
    - Signature: int
    -
    -     		-

    Indicates the token is a -

    - - -
    - - - NEW - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword new

    - - -
    - - - OWITH - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword with in #light

    - - -
    - - - PERCENT_OP - -
    - Signature: int
    -
    -     		-

    Indicates the token is a %

    - - -
    - - - PLUS_MINUS_OP - -
    - Signature: int
    -
    -     		-

    Indicates the token is a + or -

    - - -
    - - - PREFIX_OP - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ~

    - - -
    - - - QMARK - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ?

    - - -
    - - - QUOTE - -
    - Signature: int
    -
    -     		-

    Indicates the token is a "

    - - -
    - - - RARROW - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ->

    - - -
    - - - RBRACE - -
    - Signature: int
    -
    -     		-

    Indicates the token is a }

    - - -
    - - - RBRACK - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ]

    - - -
    - - - RPAREN - -
    - Signature: int
    -
    -     		-

    Indicates the token is a )

    - - -
    - - - SEMICOLON - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ;

    - - -
    - - - STAR - -
    - Signature: int
    -
    -     		-

    Indicates the token is a *

    - - -
    - - - String - -
    - Signature: int
    -
    -     		-

    Indicates the token is a string

    - - -
    - - - STRING - -
    - Signature: int
    -
    -     		-

    Indicates the token is an string (synonym for FSharpTokenTag.String)

    - - -
    - - - STRUCT - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword struct

    - - -
    - - - THEN - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword then

    - - -
    - - - TRY - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword try

    - - -
    - - - UNDERSCORE - -
    - Signature: int
    -
    -     		-

    Indicates the token is a ..

    - - -
    - - - WHITESPACE - -
    - Signature: int
    -
    -     		-

    Indicates the token is a whitespace

    - - -
    - - - WITH - -
    - Signature: int
    -
    -     		-

    Indicates the token is keyword with

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentriggerclass.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentriggerclass.html deleted file mode 100644 index c0060dd843..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentriggerclass.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - FSharpTokenTriggerClass - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpTokenTriggerClass

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Gives an indication of what should happen when the token is typed in an IDE

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - ChoiceSelect - -
    - Signature: FSharpTokenTriggerClass
    - Modifiers: static
    -
    -     		- -
    - - - MatchBraces - -
    - Signature: FSharpTokenTriggerClass
    - Modifiers: static
    -
    -     		- -
    - - - MemberSelect - -
    - Signature: FSharpTokenTriggerClass
    - Modifiers: static
    -
    -     		- -
    - - - MethodTip - -
    - Signature: FSharpTokenTriggerClass
    - Modifiers: static
    -
    -     		- -
    - - - None - -
    - Signature: FSharpTokenTriggerClass
    - Modifiers: static
    -
    -     		- -
    - - - ParamEnd - -
    - Signature: FSharpTokenTriggerClass
    - Modifiers: static
    -
    -     		- -
    - - - ParamNext - -
    - Signature: FSharpTokenTriggerClass
    - Modifiers: static
    -
    -     		- -
    - - - ParamStart - -
    - Signature: FSharpTokenTriggerClass
    - Modifiers: static
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement-1.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement-1.html deleted file mode 100644 index fbef06edc1..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement-1.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - FSharpToolTipElement<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpToolTipElement<'T>

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A single tool tip display element

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - CompositionError(string) - -
    - Signature: string
    -
    -     		-

    An error occurred formatting this element

    - - -
    - - - Group(FSharpToolTipElementData<'T> list) - -
    - Signature: FSharpToolTipElementData<'T> list
    -
    -     		-

    A single type, method, etc with comment. May represent a method overload group.

    - - -
    - - - None - -
    - Signature:
    -
    -     		- -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Single(...) - -
    - Signature: ('T * FSharpXmlDoc * typeMapping:'T list option * paramName:string option * remarks:'T option) -> FSharpToolTipElement<'T>
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement.html deleted file mode 100644 index b326757d2b..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - FSharpToolTipElement - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpToolTipElement

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A single data tip display element with where text is expressed as string

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelementdata-1.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelementdata-1.html deleted file mode 100644 index bd809373ba..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelementdata-1.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - FSharpToolTipElementData<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpToolTipElementData<'T>

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A single data tip display element

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - MainDescription - -
    - Signature: 'T
    -
    -     		- -
    - - - ParamName - -
    - Signature: string option
    -
    -     		-

    Parameter name

    - - -
    - - - Remarks - -
    - Signature: 'T option
    -
    -     		-

    Extra text, goes at the end

    - - -
    - - - TypeMapping - -
    - Signature: 'T list
    -
    -     		-

    typar insantiation text, to go after xml

    - - -
    - - - XmlDoc - -
    - Signature: FSharpXmlDoc
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext-1.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext-1.html deleted file mode 100644 index 6a8a614e66..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext-1.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - FSharpToolTipText<'T> - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpToolTipText<'T>

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Information for building a tool tip box.

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - FSharpToolTipText(...) - -
    - Signature: FSharpToolTipElement<'T> list
    -
    -     		-

    A list of data tip elements to display.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext.html deleted file mode 100644 index 136740cfdc..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpToolTipText - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpToolTipText

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptype.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptype.html deleted file mode 100644 index 375eddee47..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptype.html +++ /dev/null @@ -1,547 +0,0 @@ - - - - - FSharpType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpType

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - AbbreviatedType - -
    - Signature: FSharpType
    -
    -     		-

    Get the type for which this is an abbreviation

    - - -

    CompiledName: get_AbbreviatedType

    -
    - - - AllInterfaces - -
    - Signature: IList<FSharpType>
    -
    -     		-

    Get all the interface implementations, by walking the type hierarchy, taking into account the instantiation of this type -if it is an instantiation of a generic type.

    - - -

    CompiledName: get_AllInterfaces

    -
    - - - AnonRecordTypeDetails - -
    - Signature: FSharpAnonRecordTypeDetails
    -
    -     		-

    Get the details of the anonymous record type.

    - - -

    CompiledName: get_AnonRecordTypeDetails

    -
    - - - BaseType - -
    - Signature: FSharpType option
    -
    -     		-

    Get the base type, if any, taking into account the instantiation of this type -if it is an instantiation of a generic type.

    - - -

    CompiledName: get_BaseType

    -
    - - - Format(context) - -
    - Signature: context:FSharpDisplayContext -> string
    -
    -     		-

    Format the type using the rules of the given display context

    - - -
    - - - FormatLayout(context) - -
    - Signature: context:FSharpDisplayContext -> Layout
    -
    -     		-

    Format the type using the rules of the given display context

    - - -
    - - - GenericArguments - -
    - Signature: IList<FSharpType>
    -
    -     		-

    Get the generic arguments for a tuple type, a function type or a type constructed using a named entity

    - - -

    CompiledName: get_GenericArguments

    -
    - - - GenericParameter - -
    - Signature: FSharpGenericParameter
    -
    -     		-

    Get the generic parameter data for a generic parameter type

    - - -

    CompiledName: get_GenericParameter

    -
    - - - HasTypeDefinition - -
    - Signature: bool
    -
    -     		-

    Indicates if the type is constructed using a named entity, including array and byref types

    - - -

    CompiledName: get_HasTypeDefinition

    -
    - - - Instantiate(arg1) - -
    - Signature: ((FSharpGenericParameter * FSharpType) list) -> FSharpType
    -
    -     		-

    Instantiate generic type parameters in a type

    - - -
    - - - IsAbbreviation - -
    - Signature: bool
    -
    -     		-

    Indicates this is an abbreviation for another type

    - - -

    CompiledName: get_IsAbbreviation

    -
    - - - IsAnonRecordType - -
    - Signature: bool
    -
    -     		-

    Indicates if the type is an anonymous record type. The GenericArguments property returns the type instantiation of the anonymous record type

    - - -

    CompiledName: get_IsAnonRecordType

    -
    - - - IsFunctionType - -
    - Signature: bool
    -
    -     		-

    Indicates if the type is a function type. The GenericArguments property returns the domain and range of the function type.

    - - -

    CompiledName: get_IsFunctionType

    -
    - - - IsGenericParameter - -
    - Signature: bool
    -
    -     		-

    Indicates if the type is a variable type, whether declared, generalized or an inference type parameter

    - - -

    CompiledName: get_IsGenericParameter

    -
    - - - IsNamedType - -
    - Signature: bool
    -
    -     		- -

    CompiledName: get_IsNamedType

    -
    - - - IsStructTupleType - -
    - Signature: bool
    -
    -     		-

    Indicates if the type is a struct tuple type. The GenericArguments property returns the elements of the tuple type.

    - - -

    CompiledName: get_IsStructTupleType

    -
    - - - IsTupleType - -
    - Signature: bool
    -
    -     		-

    Indicates if the type is a tuple type (reference or struct). The GenericArguments property returns the elements of the tuple type.

    - - -

    CompiledName: get_IsTupleType

    -
    - - - IsUnresolved - -
    - Signature: bool
    -
    -     		-

    Indicates this is a named type in an unresolved assembly

    - - -

    CompiledName: get_IsUnresolved

    -
    - - - NamedEntity - -
    - Signature: FSharpEntity
    -
    -     		- -

    CompiledName: get_NamedEntity

    -
    - - - TypeDefinition - -
    - Signature: FSharpEntity
    -
    -     		-

    Get the type definition for a type

    - - -

    CompiledName: get_TypeDefinition

    -
    -

    Static members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Static memberDescription
    - - - Prettify(parameters, returnParameter) - -
    - Signature: (parameters:IList<IList<FSharpParameter>> * returnParameter:FSharpParameter) -> IList<IList<FSharpParameter>> * FSharpParameter
    -
    -     		-

    Adjust the types in a group of curried parameters and return type by removing any occurrences of type inference variables, replacing them -systematically with lower-case type inference variables such as 'a.

    - - -
    - - - Prettify(parameters) - -
    - Signature: parameters:IList<IList<FSharpParameter>> -> IList<IList<FSharpParameter>>
    -
    -     		-

    Adjust the types in a group of curried parameters by removing any occurrences of type inference variables, replacing them -systematically with lower-case type inference variables such as 'a.

    - - -
    - - - Prettify(parameters) - -
    - Signature: parameters:IList<FSharpParameter> -> IList<FSharpParameter>
    -
    -     		-

    Adjust the types in a group of parameters by removing any occurrences of type inference variables, replacing them -systematically with lower-case type inference variables such as 'a.

    - - -
    - - - Prettify(parameter) - -
    - Signature: parameter:FSharpParameter -> FSharpParameter
    -
    -     		-

    Adjust the type in a single parameter by removing any occurrences of type inference variables, replacing them -systematically with lower-case type inference variables such as 'a.

    - - -
    - - - Prettify(types) - -
    - Signature: types:IList<FSharpType> -> IList<FSharpType>
    -
    -     		-

    Adjust a group of types by removing any occurrences of type inference variables, replacing them -systematically with lower-case type inference variables such as 'a.

    - - -
    - - - Prettify(ty) - -
    - Signature: ty:FSharpType -> FSharpType
    -
    -     		-

    Adjust the type by removing any occurrences of type inference variables, replacing them -systematically with lower-case type inference variables such as 'a.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpunioncase.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpunioncase.html deleted file mode 100644 index 1f7c5d69fb..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpunioncase.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - FSharpUnionCase - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpUnionCase

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A subtype of FSharpSymbol that represents a union case as seen by the F# language

    - -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Accessibility - -
    - Signature: FSharpAccessibility
    -
    -     		-

    Indicates if the declared visibility of the union constructor, not taking signatures into account

    - - -

    CompiledName: get_Accessibility

    -
    - - - Attributes - -
    - Signature: IList<FSharpAttribute>
    -
    -     		-

    Get the attributes for the case, attached to the generated static method to make instances of the case

    - - -

    CompiledName: get_Attributes

    -
    - - - CompiledName - -
    - Signature: string
    -
    -     		-

    Get the name of the case in generated IL code

    - - -

    CompiledName: get_CompiledName

    -
    - - - DeclarationLocation - -
    - Signature: range
    -
    -     		-

    Get the range of the name of the case

    - - -

    CompiledName: get_DeclarationLocation

    -
    - - - IsUnresolved - -
    - Signature: bool
    -
    -     		-

    Indicates if the union case is for a type in an unresolved assembly

    - - -

    CompiledName: get_IsUnresolved

    -
    - - - Name - -
    - Signature: string
    -
    -     		-

    Get the name of the union case

    - - -

    CompiledName: get_Name

    -
    - - - ReturnType - -
    - Signature: FSharpType
    -
    -     		-

    Get the type constructed by the case. Normally exactly the type of the enclosing type, sometimes an abbreviation of it

    - - -

    CompiledName: get_ReturnType

    -
    - - - UnionCaseFields - -
    - Signature: IList<FSharpField>
    -
    -     		-

    Get the data carried by the case.

    - - -

    CompiledName: get_UnionCaseFields

    -
    - - - XmlDoc - -
    - Signature: IList<string>
    -
    -     		-

    Get the in-memory XML documentation for the union case, used when code is checked in-memory

    - - -

    CompiledName: get_XmlDoc

    -
    - - - XmlDocSig - -
    - Signature: string
    -
    -     		-

    Get the XML documentation signature for .xml file lookup for the union case, used for .xml file lookup for compiled code

    - - -

    CompiledName: get_XmlDocSig

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpxmldoc.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpxmldoc.html deleted file mode 100644 index 68a34cdcca..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpxmldoc.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - FSharpXmlDoc - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpXmlDoc

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Describe a comment as either a block of text or a file+signature reference into an intellidoc file.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - None - -
    - Signature:
    -
    -     		-

    No documentation is available

    - - -
    - - - Text(string) - -
    - Signature: string
    -
    -     		-

    The text for documentation

    - - -
    - - - XmlDocFileSignature(string,string) - -
    - Signature: string * string
    -
    -     		-

    Indicates that the text for the documentation can be found in a .xml documentation file, using the given signature key

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-iassemblycontentcache.html b/docs/reference/fsharp-compiler-sourcecodeservices-iassemblycontentcache.html deleted file mode 100644 index ef458f3102..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-iassemblycontentcache.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - IAssemblyContentCache - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    IAssemblyContentCache

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Assembly content cache.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Set(arg1 arg2) - -
    - Signature: AssemblyPath -> AssemblyContentCacheEntry -> unit
    - Modifiers: abstract
    -
    -     		-

    Store an assembly content.

    - - -
    - - - TryGet(arg1) - -
    - Signature: AssemblyPath -> AssemblyContentCacheEntry option
    - Modifiers: abstract
    -
    -     		-

    Try get an assembly cached content.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-idents.html b/docs/reference/fsharp-compiler-sourcecodeservices-idents.html deleted file mode 100644 index a76a1a2065..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-idents.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - Idents - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Idents

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    An array of ShortIdent.

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-inheritancecontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-inheritancecontext.html deleted file mode 100644 index 6e0aeaa18c..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-inheritancecontext.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - InheritanceContext - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    InheritanceContext

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Class - -
    - Signature:
    -
    -     		- -
    - - - Interface - -
    - Signature:
    -
    -     		- -
    - - - Unknown - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-insertcontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-insertcontext.html deleted file mode 100644 index 1e3ae9e4d6..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-insertcontext.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - InsertContext - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    InsertContext

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Insert open namespace context.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Pos - -
    - Signature: pos
    -
    -     		-

    Current position (F# compiler line number).

    - - -
    - - - ScopeKind - -
    - Signature: ScopeKind
    -
    -     		-

    Current scope kind.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-keywords.html b/docs/reference/fsharp-compiler-sourcecodeservices-keywords.html deleted file mode 100644 index 57ac2e2883..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-keywords.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Keywords - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Keywords

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - KeywordsWithDescription - -
    - Signature: (string * string) list
    -
    -     		-

    Keywords paired with their descriptions. Used in completion and quick info.

    - - -
    - - - NormalizeIdentifierBackticks arg1 - -
    - Signature: string -> string
    -
    -     		-

    Remove backticks if present.

    - - -
    - - - QuoteIdentifierIfNeeded arg1 - -
    - Signature: string -> string
    -
    -     		-

    Add backticks if the identifier is a keyword.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-layout.html b/docs/reference/fsharp-compiler-sourcecodeservices-layout.html deleted file mode 100644 index fce087f232..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-layout.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - Layout - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Layout

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-lookuptype.html b/docs/reference/fsharp-compiler-sourcecodeservices-lookuptype.html deleted file mode 100644 index dc0a6ab9a6..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-lookuptype.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - LookupType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LookupType

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Entity lookup type.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Fuzzy - -
    - Signature:
    -
    -     		- -
    - - - Precise - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedident.html b/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedident.html deleted file mode 100644 index af8bf84b6b..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedident.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - MaybeUnresolvedIdent - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MaybeUnresolvedIdent

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    ShortIdent with a flag indicating if it's resolved in some scope.

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Ident - -
    - Signature: ShortIdent
    -
    -     		- -
    - - - Resolved - -
    - Signature: bool
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedidents.html b/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedidents.html deleted file mode 100644 index 2672b5b738..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedidents.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - MaybeUnresolvedIdents - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    MaybeUnresolvedIdents

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Array of MaybeUnresolvedIdent.

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-modulekind.html b/docs/reference/fsharp-compiler-sourcecodeservices-modulekind.html deleted file mode 100644 index da8a51e44f..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-modulekind.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - ModuleKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ModuleKind

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - HasModuleSuffix - -
    - Signature: bool
    -
    -     		- -
    - - - IsAutoOpen - -
    - Signature: bool
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-container.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-container.html deleted file mode 100644 index d2835e40e9..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-container.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - Container - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Container

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: NavigateTo -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Name - -
    - Signature: string
    -
    -     		- -
    - - - Type - -
    - Signature: ContainerType
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-containertype.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-containertype.html deleted file mode 100644 index a2283cc230..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-containertype.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - ContainerType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ContainerType

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: NavigateTo -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Exception - -
    - Signature:
    -
    -     		- -
    - - - File - -
    - Signature:
    -
    -     		- -
    - - - Module - -
    - Signature:
    -
    -     		- -
    - - - Namespace - -
    - Signature:
    -
    -     		- -
    - - - Type - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitem.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitem.html deleted file mode 100644 index 92f88a0304..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitem.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - NavigableItem - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NavigableItem

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: NavigateTo -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Container - -
    - Signature: Container
    -
    -     		- -
    - - - IsSignature - -
    - Signature: bool
    -
    -     		- -
    - - - Kind - -
    - Signature: NavigableItemKind
    -
    -     		- -
    - - - Name - -
    - Signature: string
    -
    -     		- -
    - - - Range - -
    - Signature: range
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitemkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitemkind.html deleted file mode 100644 index 17deaf2f33..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitemkind.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - NavigableItemKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NavigableItemKind

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: NavigateTo -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Constructor - -
    - Signature:
    -
    -     		- -
    - - - EnumCase - -
    - Signature:
    -
    -     		- -
    - - - Exception - -
    - Signature:
    -
    -     		- -
    - - - Field - -
    - Signature:
    -
    -     		- -
    - - - Member - -
    - Signature:
    -
    -     		- -
    - - - Module - -
    - Signature:
    -
    -     		- -
    - - - ModuleAbbreviation - -
    - Signature:
    -
    -     		- -
    - - - ModuleValue - -
    - Signature:
    -
    -     		- -
    - - - Property - -
    - Signature:
    -
    -     		- -
    - - - Type - -
    - Signature:
    -
    -     		- -
    - - - UnionCase - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto.html deleted file mode 100644 index 55943c6401..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - NavigateTo - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    NavigateTo

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - Container -
    - ContainerType -
    - NavigableItem -
    - NavigableItemKind -
    - -
    - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - getNavigableItems arg1 - -
    - Signature: ParsedInput -> NavigableItem []
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-openstatementinsertionpoint.html b/docs/reference/fsharp-compiler-sourcecodeservices-openstatementinsertionpoint.html deleted file mode 100644 index 07a186bc61..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-openstatementinsertionpoint.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - OpenStatementInsertionPoint - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    OpenStatementInsertionPoint

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Where open statements should be added.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Nearest - -
    - Signature:
    -
    -     		- -
    - - - TopLevel - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbol.html deleted file mode 100644 index 8862405437..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbol.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - ParamTypeSymbol - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParamTypeSymbol

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represents the type of a single method parameter

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Byref(ExternalType) - -
    - Signature: ExternalType
    -
    -     		- -
    - - - Param(ExternalType) - -
    - Signature: ExternalType
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbolmodule.html b/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbolmodule.html deleted file mode 100644 index de3598ed7c..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbolmodule.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ParamTypeSymbol - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParamTypeSymbol

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-parsedinput.html b/docs/reference/fsharp-compiler-sourcecodeservices-parsedinput.html deleted file mode 100644 index 93567d29be..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-parsedinput.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - ParsedInput - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ParsedInput

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Parse AST helpers.

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - adjustInsertionPoint getLineStr ctx - -
    - Signature: getLineStr:(int -> string) -> ctx:InsertContext -> pos
    -
    -     		-

    Corrects insertion line number based on kind of scope and text surrounding the insertion point.

    - - -
    - - - findNearestPointToInsertOpenDeclaration (...) - -
    - Signature: currentLine:int -> ast:ParsedInput -> entity:Idents -> insertionPoint:OpenStatementInsertionPoint -> InsertContext
    -
    -     		-

    Returns InsertContext based on current position and symbol idents.

    - - -
    - - - getLongIdentAt ast pos - -
    - Signature: ast:ParsedInput -> pos:pos -> LongIdent option
    -
    -     		-

    Returns lond identifier at position.

    - - -
    - - - tryFindInsertionContext (...) - -
    - Signature: currentLine:int -> ast:ParsedInput -> MaybeUnresolvedIdents -> insertionPoint:OpenStatementInsertionPoint -> Idents option * Idents option * Idents option * Idents -> (Entity * InsertContext) []
    -
    -     		-

    Returns InsertContext based on current position and symbol idents.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-position.html b/docs/reference/fsharp-compiler-sourcecodeservices-position.html deleted file mode 100644 index 78ec93d317..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-position.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - Position - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Position

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-prettynaming.html b/docs/reference/fsharp-compiler-sourcecodeservices-prettynaming.html deleted file mode 100644 index f19d7e790e..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-prettynaming.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - PrettyNaming - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PrettyNaming

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    A set of helpers related to naming of identifiers

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - FormatAndOtherOverloadsString arg1 - -
    - Signature: int -> string
    -
    -     		- -
    - - - GetLongNameFromString arg1 - -
    - Signature: string -> string list
    -
    -     		- -
    - - - IsIdentifierPartCharacter arg1 - -
    - Signature: char -> bool
    -
    -     		- -
    - - - IsLongIdentifierPartCharacter arg1 - -
    - Signature: char -> bool
    -
    -     		- -
    - - - IsOperatorName arg1 - -
    - Signature: string -> bool
    -
    -     		- -
    - - - KeywordNames - -
    - Signature: string list
    -
    -     		-

    All the keywords in the F# language

    - - -
    - - - QuoteIdentifierIfNeeded arg1 - -
    - Signature: string -> string
    -
    -     		-

    A utility to help determine if an identifier needs to be quoted

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-range.html b/docs/reference/fsharp-compiler-sourcecodeservices-range.html deleted file mode 100644 index f64ae2f8b3..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-range.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - Range - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Range

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-recordcontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-recordcontext.html deleted file mode 100644 index 18c29aa79e..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-recordcontext.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - RecordContext - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    RecordContext

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Constructor(string) - -
    - Signature: string
    -
    -     		- -
    - - - CopyOnUpdate(range,CompletionPath) - -
    - Signature: range * CompletionPath
    -
    -     		- -
    - - - New(CompletionPath) - -
    - Signature: CompletionPath
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-scopekind.html b/docs/reference/fsharp-compiler-sourcecodeservices-scopekind.html deleted file mode 100644 index 65404c6899..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-scopekind.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - ScopeKind - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ScopeKind

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Kind of lexical scope.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - HashDirective - -
    - Signature:
    -
    -     		- -
    - - - Namespace - -
    - Signature:
    -
    -     		- -
    - - - NestedModule - -
    - Signature:
    -
    -     		- -
    - - - OpenDeclaration - -
    - Signature:
    -
    -     		- -
    - - - TopModule - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-semanticclassificationtype.html b/docs/reference/fsharp-compiler-sourcecodeservices-semanticclassificationtype.html deleted file mode 100644 index 71d3df3fde..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-semanticclassificationtype.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - SemanticClassificationType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SemanticClassificationType

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ComputationExpression - -
    - Signature:
    -
    -     		- -
    - - - Disposable - -
    - Signature:
    -
    -     		- -
    - - - Enumeration - -
    - Signature:
    -
    -     		- -
    - - - Function - -
    - Signature:
    -
    -     		- -
    - - - Interface - -
    - Signature:
    -
    -     		- -
    - - - IntrinsicFunction - -
    - Signature:
    -
    -     		- -
    - - - Module - -
    - Signature:
    -
    -     		- -
    - - - MutableVar - -
    - Signature:
    -
    -     		- -
    - - - Operator - -
    - Signature:
    -
    -     		- -
    - - - Printf - -
    - Signature:
    -
    -     		- -
    - - - Property - -
    - Signature:
    -
    -     		- -
    - - - ReferenceType - -
    - Signature:
    -
    -     		- -
    - - - TypeArgument - -
    - Signature:
    -
    -     		- -
    - - - UnionCase - -
    - Signature:
    -
    -     		- -
    - - - ValueType - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-shortident.html b/docs/reference/fsharp-compiler-sourcecodeservices-shortident.html deleted file mode 100644 index e9cfbbbbba..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-shortident.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - ShortIdent - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ShortIdent

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Short identifier, i.e. an identifier that contains no dots.

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Chars(arg1) - -
    - Signature: int -> char
    -
    -     		- -
    - - - Length - -
    - Signature: int
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-sourcefile.html b/docs/reference/fsharp-compiler-sourcecodeservices-sourcefile.html deleted file mode 100644 index a2f0136dae..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-sourcefile.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - SourceFile - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SourceFile

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Information about F# source file names

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - IsCompilable arg1 - -
    - Signature: string -> bool
    -
    -     		-

    Whether or not this file is compilable

    - - -
    - - - MustBeSingleFileProject arg1 - -
    - Signature: string -> bool
    -
    -     		-

    Whether or not this file should be a single-file project

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-stringlongident.html b/docs/reference/fsharp-compiler-sourcecodeservices-stringlongident.html deleted file mode 100644 index 2b69107778..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-stringlongident.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - StringLongIdent - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    StringLongIdent

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Lond identifier (i.e. it may contain dots).

    - -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Chars(arg1) - -
    - Signature: int -> char
    -
    -     		- -
    - - - Length - -
    - Signature: int
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-structure-collapse.html b/docs/reference/fsharp-compiler-sourcecodeservices-structure-collapse.html deleted file mode 100644 index 8cc455856e..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-structure-collapse.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - Collapse - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Collapse

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: Structure -

    -
    -

    Collapse indicates the way a range/snapshot should be collapsed. Same is for a scope inside -some kind of scope delimiter, e.g. [| ... |], [ ... ], { ... }, etc. Below is for expressions -following a binding or the right hand side of a pattern, e.g. let x = ...

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Below - -
    - Signature:
    -
    -     		- -
    - - - Same - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-structure-scope.html b/docs/reference/fsharp-compiler-sourcecodeservices-structure-scope.html deleted file mode 100644 index 1d75713ef1..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-structure-scope.html +++ /dev/null @@ -1,763 +0,0 @@ - - - - - Scope - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Scope

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: Structure -

    -
    -

    Tag to identify the constuct that can be stored alongside its associated ranges

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ArrayOrList - -
    - Signature:
    -
    -     		- -
    - - - Attribute - -
    - Signature:
    -
    -     		- -
    - - - Comment - -
    - Signature:
    -
    -     		- -
    - - - CompExpr - -
    - Signature:
    -
    -     		- -
    - - - CompExprInternal - -
    - Signature:
    -
    -     		- -
    - - - Do - -
    - Signature:
    -
    -     		- -
    - - - ElseInIfThenElse - -
    - Signature:
    -
    -     		- -
    - - - EnumCase - -
    - Signature:
    -
    -     		- -
    - - - FinallyInTryFinally - -
    - Signature:
    -
    -     		- -
    - - - For - -
    - Signature:
    -
    -     		- -
    - - - HashDirective - -
    - Signature:
    -
    -     		- -
    - - - IfThenElse - -
    - Signature:
    -
    -     		- -
    - - - Interface - -
    - Signature:
    -
    -     		- -
    - - - Lambda - -
    - Signature:
    -
    -     		- -
    - - - LetOrUse - -
    - Signature:
    -
    -     		- -
    - - - LetOrUseBang - -
    - Signature:
    -
    -     		- -
    - - - Match - -
    - Signature:
    -
    -     		- -
    - - - MatchBang - -
    - Signature:
    -
    -     		- -
    - - - MatchClause - -
    - Signature:
    -
    -     		- -
    - - - MatchLambda - -
    - Signature:
    -
    -     		- -
    - - - Member - -
    - Signature:
    -
    -     		- -
    - - - Module - -
    - Signature:
    -
    -     		- -
    - - - Namespace - -
    - Signature:
    -
    -     		- -
    - - - New - -
    - Signature:
    -
    -     		- -
    - - - ObjExpr - -
    - Signature:
    -
    -     		- -
    - - - Open - -
    - Signature:
    -
    -     		- -
    - - - Quote - -
    - Signature:
    -
    -     		- -
    - - - Record - -
    - Signature:
    -
    -     		- -
    - - - RecordDefn - -
    - Signature:
    -
    -     		- -
    - - - RecordField - -
    - Signature:
    -
    -     		- -
    - - - SpecialFunc - -
    - Signature:
    -
    -     		- -
    - - - ThenInIfThenElse - -
    - Signature:
    -
    -     		- -
    - - - TryFinally - -
    - Signature:
    -
    -     		- -
    - - - TryInTryFinally - -
    - Signature:
    -
    -     		- -
    - - - TryInTryWith - -
    - Signature:
    -
    -     		- -
    - - - TryWith - -
    - Signature:
    -
    -     		- -
    - - - Tuple - -
    - Signature:
    -
    -     		- -
    - - - Type - -
    - Signature:
    -
    -     		- -
    - - - TypeExtension - -
    - Signature:
    -
    -     		- -
    - - - UnionCase - -
    - Signature:
    -
    -     		- -
    - - - UnionDefn - -
    - Signature:
    -
    -     		- -
    - - - Val - -
    - Signature:
    -
    -     		- -
    - - - While - -
    - Signature:
    -
    -     		- -
    - - - WithInTryWith - -
    - Signature:
    -
    -     		- -
    - - - XmlDocComment - -
    - Signature:
    -
    -     		- -
    - - - YieldOrReturn - -
    - Signature:
    -
    -     		- -
    - - - YieldOrReturnBang - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-structure-scoperange.html b/docs/reference/fsharp-compiler-sourcecodeservices-structure-scoperange.html deleted file mode 100644 index ac0bac082f..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-structure-scoperange.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - ScopeRange - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    ScopeRange

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    - Parent Module: Structure -

    -
    -

    Stores the range for a construct, the sub-range that should be collapsed for outlinging, -a tag for the construct type, and a tag for the collapse style

    - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - Collapse - -
    - Signature: Collapse
    -
    -     		- -
    - - - CollapseRange - -
    - Signature: range
    -
    -     		-

    TextSpan in BlockSpan

    - - -
    - - - Range - -
    - Signature: range
    -
    -     		-

    HintSpan in BlockSpan

    - - -
    - - - Scope - -
    - Signature: Scope
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-structure.html b/docs/reference/fsharp-compiler-sourcecodeservices-structure.html deleted file mode 100644 index 1e08bf5329..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-structure.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - Structure - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Structure

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - Collapse -

    Collapse indicates the way a range/snapshot should be collapsed. Same is for a scope inside -some kind of scope delimiter, e.g. [| ... |], [ ... ], { ... }, etc. Below is for expressions -following a binding or the right hand side of a pattern, e.g. let x = ...

    - -
    - Scope -

    Tag to identify the constuct that can be stored alongside its associated ranges

    - -
    - ScopeRange -

    Stores the range for a construct, the sub-range that should be collapsed for outlinging, -a tag for the construct type, and a tag for the collapse style

    - -
    - -
    - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - getOutliningRanges (...) - -
    - Signature: sourceLines:string [] -> parsedInput:ParsedInput -> seq<ScopeRange>
    -
    -     		-

    Returns outlining ranges for given parsed input.

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-symbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-symbol.html deleted file mode 100644 index bffec694e3..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-symbol.html +++ /dev/null @@ -1,752 +0,0 @@ - - - - - Symbol - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Symbol

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Patterns over FSharpSymbol and derivatives.

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - getAbbreviatedType(arg1) - -
    - Signature: FSharpType -> FSharpType
    -
    -     		- -
    - - - getEntityAbbreviatedType(arg1) - -
    - Signature: FSharpEntity -> FSharpEntity * FSharpType option
    -
    -     		- -
    - - - hasAttribute(arg1) - -
    - Signature: seq<FSharpAttribute> -> bool
    - Type parameters: 'T
    -     		- -
    - - - hasModuleSuffixAttribute(arg1) - -
    - Signature: FSharpEntity -> bool
    -
    -     		- -
    - - - isAttribute(arg1) - -
    - Signature: FSharpAttribute -> bool
    - Type parameters: 'T
    -     		- -
    - - - isOperator(name) - -
    - Signature: name:string -> bool
    -
    -     		- -
    - - - isUnnamedUnionCaseField(arg1) - -
    - Signature: FSharpField -> bool
    -
    -     		- -
    - - - tryGetAttribute(arg1) - -
    - Signature: seq<FSharpAttribute> -> FSharpAttribute option
    - Type parameters: 'T
    -     		- -
    -

    Active patterns

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Active patternDescription
    - - - ( |AbbreviatedType|_| )(arg1) - -
    - Signature: FSharpEntity -> FSharpType option
    -
    -     		- -

    CompiledName: |AbbreviatedType|_|

    -
    - - - ( |AbstractClass|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |AbstractClass|_|

    -
    - - - ( |ActivePatternCase|_| )(arg1) - -
    - Signature: FSharpSymbol -> FSharpActivePatternCase option
    -
    -     		- -

    CompiledName: |ActivePatternCase|_|

    -
    - - - ( |Array|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |Array|_|

    -
    - - - ( |Attribute|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |Attribute|_|

    -
    - - - ( |ByRef|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |ByRef|_|

    -
    - - - ( |Class|_| )(...) - -
    - Signature: (original:FSharpEntity * abbreviated:FSharpEntity * 'a) -> unit option
    - Type parameters: 'a
    -     		- -

    CompiledName: |Class|_|

    -
    - - - ( |Constructor|_| )(arg1) - -
    - Signature: FSharpMemberOrFunctionOrValue -> FSharpEntity option
    -
    -     		- -

    CompiledName: |Constructor|_|

    -
    - - - ( |Delegate|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |Delegate|_|

    -
    - - - ( |Enum|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |Enum|_|

    -
    - - - ( |Event|_| )(arg1) - -
    - Signature: FSharpMemberOrFunctionOrValue -> unit option
    -
    -     		- -

    CompiledName: |Event|_|

    -
    - - - ( |ExtensionMember|_| )(arg1) - -
    - Signature: FSharpMemberOrFunctionOrValue -> unit option
    -
    -     		- -

    CompiledName: |ExtensionMember|_|

    -
    - - - ( |Field|_| )(arg1) - -
    - Signature: FSharpSymbol -> (FSharpField * FSharpType) option
    -
    -     		- -

    CompiledName: |Field|_|

    -
    - - - ( |FSharpEntity|_| )(arg1) - -
    - Signature: FSharpSymbol -> (FSharpEntity * FSharpEntity * FSharpType option) option
    -
    -     		- -

    CompiledName: |FSharpEntity|_|

    -
    - - - ( |FSharpException|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |FSharpException|_|

    -
    - - - ( |FSharpModule|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |FSharpModule|_|

    -
    - - - ( |FSharpType|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |FSharpType|_|

    -
    - - - ( |Function|_| )(excluded arg2) - -
    - Signature: excluded:bool -> FSharpMemberOrFunctionOrValue -> unit option
    -
    -     		- -

    CompiledName: |Function|_|

    -
    - - - ( |FunctionType|_| )(arg1) - -
    - Signature: FSharpType -> unit option
    -
    -     		- -

    CompiledName: |FunctionType|_|

    -
    - - - ( |Interface|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |Interface|_|

    -
    - - - ( |MemberFunctionOrValue|_| )(arg1) - -
    - Signature: FSharpSymbol -> FSharpMemberOrFunctionOrValue option
    -
    -     		- -

    CompiledName: |MemberFunctionOrValue|_|

    -
    - - - ( |MutableVar|_| )(arg1) - -
    - Signature: FSharpSymbol -> unit option
    -
    -     		- -

    CompiledName: |MutableVar|_|

    -
    - - - ( |Namespace|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |Namespace|_|

    -
    - - - ( |Parameter|_| )(arg1) - -
    - Signature: FSharpSymbol -> unit option
    -
    -     		- -

    CompiledName: |Parameter|_|

    -
    - - - ( |Pattern|_| )(arg1) - -
    - Signature: FSharpSymbol -> unit option
    -
    -     		- -

    CompiledName: |Pattern|_|

    -
    - - - ( |ProvidedAndErasedType|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |ProvidedAndErasedType|_|

    -
    - - - ( |ProvidedType|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |ProvidedType|_|

    -
    - - - ( |Record|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |Record|_|

    -
    - - - ( |RecordField|_| )(arg1) - -
    - Signature: FSharpSymbol -> FSharpField option
    -
    -     		- -

    CompiledName: |RecordField|_|

    -
    - - - ( |RefCell|_| )(arg1) - -
    - Signature: FSharpType -> unit option
    -
    -     		- -

    CompiledName: |RefCell|_|

    -
    - - - ( |Tuple|_| )(arg1) - -
    - Signature: FSharpType option -> unit option
    -
    -     		- -

    CompiledName: |Tuple|_|

    -
    - - - ( |TypeWithDefinition|_| )(arg1) - -
    - Signature: FSharpType -> FSharpEntity option
    -
    -     		- -

    CompiledName: |TypeWithDefinition|_|

    -
    - - - ( |UnionCase|_| )(arg1) - -
    - Signature: FSharpSymbol -> FSharpUnionCase option
    -
    -     		- -

    CompiledName: |UnionCase|_|

    -
    - - - ( |UnionType|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |UnionType|_|

    -
    - - - ( |ValueType|_| )(arg1) - -
    - Signature: FSharpEntity -> unit option
    -
    -     		- -

    CompiledName: |ValueType|_|

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-tooltips.html b/docs/reference/fsharp-compiler-sourcecodeservices-tooltips.html deleted file mode 100644 index 9e78d981ab..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-tooltips.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - Tooltips - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Tooltips

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - Map f a - -
    - Signature: f:('T1 -> 'T2) -> a:Async<'T1> -> Async<'T2>
    - Type parameters: 'T1, 'T2
    -     		- -
    - - - ToFSharpToolTipElement arg1 - -
    - Signature: FSharpStructuredToolTipElement -> FSharpToolTipElement
    -
    -     		- -
    - - - ToFSharpToolTipText arg1 - -
    - Signature: FSharpStructuredToolTipText -> FSharpToolTipText
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html b/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html deleted file mode 100644 index 6d93d2662e..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - UnresolvedReferencesSet - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UnresolvedReferencesSet

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Unused in this API

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedsymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedsymbol.html deleted file mode 100644 index 6921f28402..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedsymbol.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - UnresolvedSymbol - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UnresolvedSymbol

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - DisplayName - -
    - Signature: string
    -
    -     		- -
    - - - FullName - -
    - Signature: string
    -
    -     		- -
    - - - Namespace - -
    - Signature: string []
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-untypedparseimpl.html b/docs/reference/fsharp-compiler-sourcecodeservices-untypedparseimpl.html deleted file mode 100644 index 965f076438..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-untypedparseimpl.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - UntypedParseImpl - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UntypedParseImpl

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - GetEntityKind (arg1, arg2) - -
    - Signature: (pos * ParsedInput) -> EntityKind option
    -
    -     		- -
    - - - GetFullNameOfSmallestModuleOrNamespaceAtPoint (...) - -
    - Signature: (ParsedInput * pos) -> string []
    -
    -     		- -
    - - - GetRangeOfExprLeftOfDot (arg1, arg2) - -
    - Signature: (pos * ParsedInput option) -> range option
    -
    -     		- -
    - - - TryFindExpressionASTLeftOfDotLeftOfCursor (...) - -
    - Signature: (pos * ParsedInput option) -> (pos * bool) option
    -
    -     		- -
    - - - TryFindExpressionIslandInPosition (...) - -
    - Signature: (pos * ParsedInput option) -> string option
    -
    -     		- -
    - - - TryGetCompletionContext (...) - -
    - Signature: (pos * ParsedInput * lineStr:string) -> CompletionContext option
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-unusedopens.html b/docs/reference/fsharp-compiler-sourcecodeservices-unusedopens.html deleted file mode 100644 index bd68836764..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-unusedopens.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - UnusedOpens - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UnusedOpens

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - getUnusedOpens (...) - -
    - Signature: (checkFileResults:FSharpCheckFileResults * getSourceLineStr:(int -> string)) -> Async<range list>
    -
    -     		-

    Get all unused open declarations in a file

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-xmldocable.html b/docs/reference/fsharp-compiler-sourcecodeservices-xmldocable.html deleted file mode 100644 index b503e79dfe..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-xmldocable.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - XmlDocable - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    XmlDocable

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -

    Represent an Xml documentation block in source code

    - -
    -

    Union Cases

    - - - - - - - - - - -
    Union CaseDescription
    - - - XmlDocable(line,indent,paramNames) - -
    - Signature: int * int * string list
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-xmldoccomment.html b/docs/reference/fsharp-compiler-sourcecodeservices-xmldoccomment.html deleted file mode 100644 index 3c91c087b2..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-xmldoccomment.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - XmlDocComment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    XmlDocComment

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - isBlank arg1 - -
    - Signature: string -> int option
    -
    -     		-

    if it's a blank XML comment with trailing "<", returns Some (index of the "<"), otherwise returns None

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-xmldocparser.html b/docs/reference/fsharp-compiler-sourcecodeservices-xmldocparser.html deleted file mode 100644 index 3cd25f73dc..0000000000 --- a/docs/reference/fsharp-compiler-sourcecodeservices-xmldocparser.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - XmlDocParser - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    XmlDocParser

    -

    - Namespace: FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - -
    Function or valueDescription
    - - - getXmlDocables (...) - -
    - Signature: (sourceCodeOfTheFile:string * input:ParsedInput option) -> XmlDocable list
    -
    -     		-

    Get the list of Xml documentation from current source code

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/index.html b/docs/reference/index.html deleted file mode 100644 index 7bc8e89cd9..0000000000 --- a/docs/reference/index.html +++ /dev/null @@ -1,1534 +0,0 @@ - - - - - Namespaces - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - -

    F# Compiler Services

    - - -

    FSharp.Compiler Namespace

    -
    - - - - - - - - - - - - - - -
    TypeDescription
    - LogCompilerFunctionId -
    - PartialLongName -

    Qualified long name.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ModuleDescription
    - Ast -
    - ErrorLogger -
    - Layout -
    - PrettyNaming -

    Anything to do with special names of identifiers and other lexical rules

    - -
    - QuickParse -

    Methods for cheaply and innacurately parsing F#.

    -

    These methods are very old and are mostly to do with extracting "long identifier islands" -A.B.C -from F# source code, an approach taken from pre-F# VS samples for implementing intelliense.

    -

    This code should really no longer be needed since the language service has access to -parsed F# source code ASTs. However, the long identifiers are still passed back to GetDeclarations and friends in the -F# Compiler Service and it's annoyingly hard to remove their use completely.

    -

    In general it is unlikely much progress will be made by fixing this code - it will be better to -extract more information from the F# ASTs.

    -

    It's also surprising how hard even the job of getting long identifier islands can be. For example the code -below is inaccurate for long identifier chains involving ... identifiers. And there are special cases -for active pattern names and so on.

    - -
    - Range -
    - ReferenceResolver -
    - -
    -

    FSharp.Compiler.AbstractIL Namespace

    -
    - - - - - - - - - - - - - - -
    ModuleDescription
    - IL -

    The "unlinked" view of .NET metadata and code. Central to the Abstract IL library

    - -
    - ILBinaryReader -

    Binary reader. Read a .NET binary and concert it to Abstract IL data -structures.

    -

    NOTE: -- The metadata in the loaded modules will be relative to -those modules, e.g. ILScopeRef.Local will mean "local to -that module". You must use [rescopeILType] etc. if you want to include -(i.e. copy) the metadata into your own module.

    -
      -
    • -

      PDB (debug info) reading/folding: -The PDB reader is invoked if you give a PDB path -This indicates if you want to search for PDB files and have the -reader fold them in. You cannot currently name the pdb file -directly - you can only name the path. Giving "None" says -"do not read the PDB file even if one exists".

      -

      The debug info appears primarily as I_seqpoint annotations in -the instruction streams. Unfortunately the PDB information does -not, for example, tell you how to map back from a class definition -to a source code line number - you will need to explicitly search -for a sequence point in the code for one of the methods of the -class. That is not particularly satisfactory, and it may be -a good idea to build a small library which extracts the information -you need.

      -
      • -
    - -
    - -
    -

    FSharp.Compiler.AbstractIL.Internal Namespace

    -
    - - - - - - - - - - -
    ModuleDescription
    - Library -
    - -
    -

    FSharp.Compiler.Interactive Namespace

    -
    - - - - - - - - - - -
    ModuleDescription
    - Shell -
    - -
    -

    FSharp.Compiler.SourceCodeServices Namespace

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - AssemblyContentType -

    Assembly content type.

    - -
    - AssemblyPath -

    Assembly path.

    - -
    - AssemblySymbol -

    Represents type, module, member, function or value in a compiled assembly.

    - -
    - CompilerEnvironment -

    Information about the compilation environment

    - -
    - CompletionContext -
    - CompletionItemKind -
    - CompletionPath -
    - Entity -

    Helper data structure representing a symbol, sutable for implementing unresolved identifiers resolution code fixes.

    - -
    - EntityCache -

    Thread safe wrapper over IAssemblyContentCache.

    - -
    - EntityKind -
    - ExternalSymbol -

    Represents a symbol in an external (non F#) assembly

    - -
    - ExternalType -

    Represents a type in an external (non F#) assembly.

    - -
    - FSharpAbstractParameter -

    Represents a parameter in an abstract method of a class or interface

    - -
    - FSharpAbstractSignature -

    Represents the signature of an abstract slot of a class or interface

    - -
    - FSharpAccessibility -

    Indicates the accessibility of a symbol, as seen by the F# language

    - -
    - FSharpAccessibilityRights -

    Represents the rights of a compilation to access symbols

    - -
    - FSharpActivePatternCase -

    A subtype of FSharpSymbol that represents a single case within an active pattern

    - -
    - FSharpActivePatternGroup -

    Represents all cases within an active pattern

    - -
    - FSharpAnonRecordTypeDetails -

    A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language

    - -
    - FSharpAssembly -

    Represents an assembly as seen by the F# language

    - -
    - FSharpAssemblyContents -

    Represents the definitional contents of an assembly, as seen by the F# language

    - -
    - FSharpAssemblySignature -

    Represents an inferred signature of part of an assembly as seen by the F# language

    - -
    - FSharpAttribute -

    Represents a custom attribute attached to F# source code or a compiler .NET component

    - -
    - FSharpCheckFileAnswer -

    The result of calling TypeCheckResult including the possibility of abort and background compiler not caught up.

    - -
    - FSharpCheckFileResults -

    A handle to the results of CheckFileInProject.

    - -
    - FSharpCheckProjectResults -

    A handle to the results of CheckFileInProject.

    - -
    - FSharpChecker -

    Used to parse and check F# source code.

    - -
    - FSharpDeclarationListInfo -

    Represents a set of declarations in F# source code, with information attached ready for display by an editor. -Returned by GetDeclarations.

    - -
    - FSharpDeclarationListItem -

    Represents a declaration in F# source code, with information attached ready for display by an editor. -Returned by GetDeclarations.

    - -
    - FSharpDelegateSignature -

    Represents a delegate signature in an F# symbol

    - -
    - FSharpDisplayContext -

    Represents the information needed to format types and other information in a style -suitable for use in F# source text at a particular source location.

    -

    Acquired via GetDisplayEnvAtLocationAlternate and similar methods. May be passed -to the Format method on FSharpType and other methods.

    - -
    - FSharpEnclosingEntityKind -
    - FSharpEntity -

    A subtype of FSharpSymbol that represents a type definition or module as seen by the F# language

    - -
    - FSharpErrorInfo -
    - FSharpErrorSeverity -
    - FSharpExpr -

    Represents a checked and reduced expression, as seen by the F# language. The active patterns -in 'FSharp.Compiler.SourceCodeServices' can be used to analyze information about the expression.

    -

    Pattern matching is reduced to decision trees and conditional tests. Some other -constructs may be represented in reduced form.

    - -
    - FSharpField -

    A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language

    - -
    - FSharpFindDeclFailureReason -

    Represents the reason why the GetDeclarationLocation operation failed.

    - -
    - FSharpFindDeclResult -

    Represents the result of the GetDeclarationLocation operation.

    - -
    - FSharpGenericParameter -

    A subtype of FSharpSymbol that represents a generic parameter for an FSharpSymbol

    - -
    - FSharpGenericParameterConstraint -

    Represents a constraint on a generic type parameter

    - -
    - FSharpGenericParameterDefaultsToConstraint -

    Represents further information about a 'defaults to' constraint on a generic type parameter

    - -
    - FSharpGenericParameterDelegateConstraint -

    Represents further information about a delegate constraint on a generic type parameter

    - -
    - FSharpGenericParameterMemberConstraint -

    Represents further information about a member constraint on a generic type parameter

    - -
    - FSharpGlyph -
    - FSharpImplementationFileContents -

    Represents the definitional contents of a single file or fragment in an assembly, as seen by the F# language

    - -
    - FSharpImplementationFileDeclaration -

    Represents a declaration in an implementation file, as seen by the F# language

    - -
    - FSharpInlineAnnotation -
    - FSharpLineTokenizer -

    Object to tokenize a line of F# source code, starting with the given lexState. The lexState should be FSharpTokenizerLexState.Initial for -the first line of text. Returns an array of ranges of the text and two enumerations categorizing the -tokens and characters covered by that range, i.e. FSharpTokenColorKind and FSharpTokenCharKind. The enumerations -are somewhat adhoc but useful enough to give good colorization options to the user in an IDE.

    -

    A new lexState is also returned. An IDE-plugin should in general cache the lexState -values for each line of the edited code.

    - -
    - FSharpMemberOrFunctionOrValue -

    A subtype of F# symbol that represents an F# method, property, event, function or value, including extension members.

    - -
    - FSharpMethodGroup -

    Represents a group of methods (or other items) returned by GetMethods.

    - -
    - FSharpMethodGroupItem -

    Represents one method (or other item) in a method group. The item may represent either a method or -a single, non-overloaded item such as union case or a named function value.

    - -
    - FSharpMethodGroupItemParameter -

    Represents one parameter for one method (or other item) in a group.

    - -
    - FSharpNavigationDeclarationItem -

    Represents an item to be displayed in the navigation bar

    - -
    - FSharpNavigationDeclarationItemKind -

    Indicates a kind of item to show in an F# navigation bar

    - -
    - FSharpNavigationItems -

    Represents result of 'GetNavigationItems' operation - this contains -all the members and currently selected indices. First level correspond to -types & modules and second level are methods etc.

    - -
    - FSharpNavigationTopLevelDeclaration -

    Represents top-level declarations (that should be in the type drop-down) -with nested declarations (that can be shown in the member drop-down)

    - -
    - FSharpNoteworthyParamInfoLocations -

    Represents the locations relevant to activating parameter info in an IDE

    - -
    - FSharpObjectExprOverride -

    Represents a checked method in an object expression, as seen by the F# language.

    - -
    - FSharpOpenDeclaration -

    Represents open declaration in F# code.

    - -
    - FSharpParameter -

    A subtype of FSharpSymbol that represents a parameter

    - -
    - FSharpParseFileResults -

    Represents the results of parsing an F# file

    - -
    - FSharpParsingOptions -

    Options used to determine active --define conditionals and other options relevant to parsing files in a project

    - -
    - FSharpProjectContext -

    Represents the checking context implied by the ProjectOptions

    - -
    - FSharpProjectOptions -

    A set of information describing a project or script build configuration.

    - -
    - FSharpSourceTokenizer -

    Tokenizer for a source file. Holds some expensive-to-compute resources at the scope of the file.

    - -
    - FSharpStaticParameter -

    A subtype of FSharpSymbol that represents a static parameter to an F# type provider

    - -
    - FSharpStructuredToolTipElement -

    A single data tip display element with where text is expressed as

    - -
    - FSharpStructuredToolTipText -
    - FSharpSymbol -

    Represents a symbol in checked F# source code or a compiled .NET component.

    -

    The subtype of the symbol may reveal further information and can be one of FSharpEntity, FSharpUnionCase -FSharpField, FSharpGenericParameter, FSharpStaticParameter, FSharpMemberOrFunctionOrValue, FSharpParameter, -or FSharpActivePatternCase.

    - -
    - FSharpSymbolUse -

    Represents the use of an F# symbol from F# source code

    - -
    - FSharpTokenCharKind -

    Gives an indication of the class to assign to the characters of the token an IDE

    - -
    - FSharpTokenColorKind -

    Gives an indicattion of the color class to assign to the token an IDE

    - -
    - FSharpTokenInfo -

    Information about a particular token from the tokenizer

    - -
    - FSharpTokenTriggerClass -

    Gives an indication of what should happen when the token is typed in an IDE

    - -
    - FSharpTokenizerColorState -

    Represents stable information for the state of the laxing engine at the end of a line

    - -
    - FSharpTokenizerLexState -

    Represents encoded information for the end-of-line continuation of lexing

    - -
    - FSharpToolTipElement<'T> -

    A single tool tip display element

    - -
    - FSharpToolTipElement -

    A single data tip display element with where text is expressed as string

    - -
    - FSharpToolTipElementData<'T> -

    A single data tip display element

    - -
    - FSharpToolTipText<'T> -

    Information for building a tool tip box.

    - -
    - FSharpToolTipText -
    - FSharpType -
    - FSharpUnionCase -

    A subtype of FSharpSymbol that represents a union case as seen by the F# language

    - -
    - FSharpXmlDoc -

    Describe a comment as either a block of text or a file+signature reference into an intellidoc file.

    - -
    - IAssemblyContentCache -

    Assembly content cache.

    - -
    - Idents -

    An array of ShortIdent.

    - -
    - InheritanceContext -
    - InsertContext -

    Insert open namespace context.

    - -
    - Layout -
    - LookupType -

    Entity lookup type.

    - -
    - MaybeUnresolvedIdent -

    ShortIdent with a flag indicating if it's resolved in some scope.

    - -
    - MaybeUnresolvedIdents -

    Array of MaybeUnresolvedIdent.

    - -
    - ModuleKind -
    - OpenStatementInsertionPoint -

    Where open statements should be added.

    - -
    - ParamTypeSymbol -

    Represents the type of a single method parameter

    - -
    - Position -
    - Range -
    - RecordContext -
    - ScopeKind -

    Kind of lexical scope.

    - -
    - SemanticClassificationType -
    - ShortIdent -

    Short identifier, i.e. an identifier that contains no dots.

    - -
    - StringLongIdent -

    Lond identifier (i.e. it may contain dots).

    - -
    - UnresolvedReferencesSet -

    Unused in this API

    - -
    - UnresolvedSymbol -
    - XmlDocable -

    Represent an Xml documentation block in source code

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ModuleDescription
    - AssemblyContentProvider -

    Provides assembly content.

    - -
    - AstTraversal -

    A range of utility functions to assist with traversing an AST

    - -
    - BasicPatterns -

    A collection of active patterns to analyze expressions

    - -
    - CompilerEnvironment -

    Information about the compilation environment

    - -
    - DebuggerEnvironment -

    Information about the debugging environment

    - -
    - Extensions -
    - ExternalType -
    - FSharpTokenTag -

    Some of the values in the field FSharpTokenInfo.Tag

    - -
    - Keywords -
    - NavigateTo -
    - ParamTypeSymbol -
    - ParsedInput -

    Parse AST helpers.

    - -
    - PrettyNaming -

    A set of helpers related to naming of identifiers

    - -
    - SourceFile -

    Information about F# source file names

    - -
    - Structure -
    - Symbol -

    Patterns over FSharpSymbol and derivatives.

    - -
    - Tooltips -
    - UntypedParseImpl -
    - UnusedOpens -
    - XmlDocComment -
    - XmlDocParser -
    - -
    -

    Internal.Utilities.StructuredFormat Namespace

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - FormatOptions -

    A record of options to control structural formatting. -For F# Interactive properties matching those of this value can be accessed via the 'fsi' -value.

    -

    Floating Point format given in the same format accepted by System.Double.ToString, -e.g. f6 or g15.

    -

    If ShowProperties is set the printing process will evaluate properties of the values being -displayed. This may cause additional computation.

    -

    The ShowIEnumerable is set the printing process will force the evaluation of IEnumerable objects -to a small, finite depth, as determined by the printing parameters. -This may lead to additional computation being performed during printing.

    - -From F# Interactive the default settings can be adjusted using, for example, -
    -  open FSharp.Compiler.Interactive.Settings;;
-  setPrintWidth 120;;
-
    -     - -
    - IEnvironment -
    - Joint -

    Data representing joints in structured layouts of terms. The representation -of this data type is only for the consumption of formatting engines.

    - -
    - Layout -

    Data representing structured layouts of terms. The representation -of this data type is only for the consumption of formatting engines.

    - -
    - LayoutTag -
    - TaggedText -
    - TaggedTextWriter -
    - - - - - - - - - - - - - - - - - - -
    ModuleDescription
    - Display -
    - LayoutOps -

    A layout is a sequence of strings which have been joined together. -The strings are classified as words, separators and left and right parenthesis. -This classification determines where spaces are inserted. -A joint is either unbreakable, breakable or broken. -If a joint is broken the RHS layout occurs on the next line with optional indentation. -A layout can be squashed to for given width which forces breaks as required.

    - -
    - TaggedTextOps -
    - -
    -

    Microsoft.FSharp.Compiler.Interactive.Shell Namespace

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - CompilerInputStream -

    Defines a read-only input stream used to feed content to the hosted F# Interactive dynamic compiler.

    - -
    - CompilerOutputStream -
    - EvaluationEventArgs -
    - FsiEvaluationSession -
    - FsiEvaluationSessionHostConfig -
    - FsiValue -
    - - - - - - - - - - -
    ModuleDescription
    - Settings -
    - -
    -

    Microsoft.FSharp.Compiler.SourceCodeServices Namespace

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeDescription
    - CompilerEnvironment -
    - FSharpCheckFileAnswer -
    - FSharpCheckFileResults -
    - FSharpCheckProjectResults -
    - FSharpChecker -
    - FSharpFindDeclFailureReason -
    - FSharpFindDeclResult -
    - FSharpParsingOptions -
    - FSharpProjectContext -
    - FSharpProjectOptions -
    - SemanticClassificationType -
    - UnresolvedReferencesSet -
    - - - - - - - - - - - - - - - - - - -
    ModuleDescription
    - CompilerEnvironment -
    - DebuggerEnvironment -
    - PrettyNaming -
    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-display.html b/docs/reference/internal-utilities-structuredformat-display.html deleted file mode 100644 index e6457a76d2..0000000000 --- a/docs/reference/internal-utilities-structuredformat-display.html +++ /dev/null @@ -1,265 +0,0 @@ - - - - - Display - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Display

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - any_to_layout options (value, arg3) - -
    - Signature: options:FormatOptions -> (value:'T * Type) -> Layout
    - Type parameters: 'T
    -     		- -
    - - - any_to_string (value, arg2) - -
    - Signature: (value:'T * Type) -> string
    - Type parameters: 'T
    -     		-

    Convert any value to a string using a standard formatter -Data is typically formatted in a structured format, e.g. -lists are formatted using the "[1;2]" notation. -The details of the format are not specified and may change -from version to version and according to the flags given -to the F# compiler. The format is intended to be human-readable, -not machine readable. If alternative generic formats are required -you should develop your own formatter, using the code in the -implementation of this file as a starting point.

    -

    Data from other .NET languages is formatted using a virtual -call to Object.ToString() on the boxed version of the input.

    - - -
    - - - asTaggedTextWriter writer - -
    - Signature: writer:TextWriter -> TaggedTextWriter
    -
    -     		- -
    - - - fsi_any_to_layout options (value, arg3) - -
    - Signature: options:FormatOptions -> (value:'T * Type) -> Layout
    - Type parameters: 'T
    -     		- -
    - - - layout_as_string options (value, arg3) - -
    - Signature: options:FormatOptions -> (value:'T * Type) -> string
    - Type parameters: 'T
    -     		- -
    - - - layout_to_string options layout - -
    - Signature: options:FormatOptions -> layout:Layout -> string
    -
    -     		-

    Convert any value to a layout using the given formatting options. The -layout can then be processed using formatting display engines such as -those in the LayoutOps module. anytostring and outputany are -built using anyto_layout with default format options.

    - - -
    - - - output_any writer (value, arg3) - -
    - Signature: writer:TextWriter -> (value:'T * Type) -> unit
    - Type parameters: 'T
    -     		-

    Output any value to a channel using the same set of formatting rules -as anytostring

    - - -
    - - - output_layout options writer layout - -
    - Signature: options:FormatOptions -> writer:TextWriter -> layout:Layout -> unit
    -
    -     		- -
    - - - output_layout_tagged (...) - -
    - Signature: options:FormatOptions -> writer:TaggedTextWriter -> layout:Layout -> unit
    -
    -     		- -
    - - - squash_layout options layout - -
    - Signature: options:FormatOptions -> layout:Layout -> Layout
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-formatoptions.html b/docs/reference/internal-utilities-structuredformat-formatoptions.html deleted file mode 100644 index d4897797ad..0000000000 --- a/docs/reference/internal-utilities-structuredformat-formatoptions.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - FormatOptions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FormatOptions

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -

    A record of options to control structural formatting. -For F# Interactive properties matching those of this value can be accessed via the 'fsi' -value.

    -

    Floating Point format given in the same format accepted by System.Double.ToString, -e.g. f6 or g15.

    -

    If ShowProperties is set the printing process will evaluate properties of the values being -displayed. This may cause additional computation.

    -

    The ShowIEnumerable is set the printing process will force the evaluation of IEnumerable objects -to a small, finite depth, as determined by the printing parameters. -This may lead to additional computation being performed during printing.

    - -From F# Interactive the default settings can be adjusted using, for example, -
    -  open FSharp.Compiler.Interactive.Settings;;
-  setPrintWidth 120;;
-
    -     - -
    -

    Record Fields

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Record FieldDescription
    - - - AttributeProcessor - -
    - Signature: string -> (string * string) list -> bool -> unit
    -
    -     		- -
    - - - BindingFlags - -
    - Signature: BindingFlags
    -
    -     		- -
    - - - FloatingPointFormat - -
    - Signature: string
    -
    -     		- -
    - - - FormatProvider - -
    - Signature: IFormatProvider
    -
    -     		- -
    - - - PrintDepth - -
    - Signature: int
    -
    -     		- -
    - - - PrintIntercepts - -
    - Signature: (IEnvironment -> obj -> Layout option) list
    -
    -     		- -
    - - - PrintLength - -
    - Signature: int
    -
    -     		- -
    - - - PrintSize - -
    - Signature: int
    -
    -     		- -
    - - - PrintWidth - -
    - Signature: int
    -
    -     		- -
    - - - ShowIEnumerable - -
    - Signature: bool
    -
    -     		- -
    - - - ShowProperties - -
    - Signature: bool
    -
    -     		- -
    - - - StringLimit - -
    - Signature: int
    -
    -     		- -
    -

    Static members

    - - - - - - - - - - -
    Static memberDescription
    - - - Default - -
    - Signature: FormatOptions
    -
    -     		- -

    CompiledName: get_Default

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-ienvironment.html b/docs/reference/internal-utilities-structuredformat-ienvironment.html deleted file mode 100644 index afbbda7d9b..0000000000 --- a/docs/reference/internal-utilities-structuredformat-ienvironment.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - IEnvironment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    IEnvironment

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - GetLayout(arg1) - -
    - Signature: obj -> Layout
    - Modifiers: abstract
    -
    -     		-

    Return to the layout-generation -environment to layout any otherwise uninterpreted object

    - - -
    - - - MaxColumns - -
    - Signature: int
    - Modifiers: abstract
    -
    -     		-

    The maximum number of elements for which to generate layout for -list-like structures, or columns in table-like -structures. -1 if no maximum.

    - - -

    CompiledName: get_MaxColumns

    -
    - - - MaxRows - -
    - Signature: int
    - Modifiers: abstract
    -
    -     		-

    The maximum number of rows for which to generate layout for table-like -structures. -1 if no maximum.

    - - -

    CompiledName: get_MaxRows

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-joint.html b/docs/reference/internal-utilities-structuredformat-joint.html deleted file mode 100644 index bf505eaec8..0000000000 --- a/docs/reference/internal-utilities-structuredformat-joint.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - Joint - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Joint

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -

    Data representing joints in structured layouts of terms. The representation -of this data type is only for the consumption of formatting engines.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Breakable(int) - -
    - Signature: int
    -
    -     		- -
    - - - Broken(int) - -
    - Signature: int
    -
    -     		- -
    - - - Unbreakable - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-layout.html b/docs/reference/internal-utilities-structuredformat-layout.html deleted file mode 100644 index 39e7bd959d..0000000000 --- a/docs/reference/internal-utilities-structuredformat-layout.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - Layout - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Layout

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -

    Data representing structured layouts of terms. The representation -of this data type is only for the consumption of formatting engines.

    - -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - Attr(...) - -
    - Signature: string * (string * string) list * Layout
    -
    -     		- -
    - - - Leaf(bool,TaggedText,bool) - -
    - Signature: bool * TaggedText * bool
    -
    -     		- -
    - - - Node(bool,Layout,bool,Layout,bool,Joint) - -
    - Signature: bool * Layout * bool * Layout * bool * Joint
    -
    -     		- -
    - - - ObjLeaf(bool,obj,bool) - -
    - Signature: bool * obj * bool
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-layoutops.html b/docs/reference/internal-utilities-structuredformat-layoutops.html deleted file mode 100644 index 3a26ee63cb..0000000000 --- a/docs/reference/internal-utilities-structuredformat-layoutops.html +++ /dev/null @@ -1,571 +0,0 @@ - - - - - LayoutOps - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LayoutOps

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -

    A layout is a sequence of strings which have been joined together. -The strings are classified as words, separators and left and right parenthesis. -This classification determines where spaces are inserted. -A joint is either unbreakable, breakable or broken. -If a joint is broken the RHS layout occurs on the next line with optional indentation. -A layout can be squashed to for given width which forces breaks as required.

    - -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - ( -- ) layout1 layout2 - -
    - Signature: layout1:Layout -> layout2:Layout -> Layout
    -
    -     		-

    Join, possible break with indent=1

    - - -

    CompiledName: op_MinusMinus

    -
    - - - ( --- ) layout1 layout2 - -
    - Signature: layout1:Layout -> layout2:Layout -> Layout
    -
    -     		-

    Join, possible break with indent=2

    - - -

    CompiledName: op_MinusMinusMinus

    -
    - - - ( @@ ) layout1 layout2 - -
    - Signature: layout1:Layout -> layout2:Layout -> Layout
    -
    -     		-

    Join broken with ident=0

    - - -

    CompiledName: op_AtAt

    -
    - - - ( @@- ) layout1 layout2 - -
    - Signature: layout1:Layout -> layout2:Layout -> Layout
    -
    -     		-

    Join broken with ident=1

    - - -

    CompiledName: op_AtAtMinus

    -
    - - - ( @@-- ) layout1 layout2 - -
    - Signature: layout1:Layout -> layout2:Layout -> Layout
    -
    -     		-

    Join broken with ident=2

    - - -

    CompiledName: op_AtAtMinusMinus

    -
    - - - ( ^^ ) layout1 layout2 - -
    - Signature: layout1:Layout -> layout2:Layout -> Layout
    -
    -     		-

    Join, unbreakable.

    - - -

    CompiledName: op_HatHat

    -
    - - - ( ++ ) layout1 layout2 - -
    - Signature: layout1:Layout -> layout2:Layout -> Layout
    -
    -     		-

    Join, possible break with indent=0

    - - -

    CompiledName: op_PlusPlus

    -
    - - - aboveL layout1 layout2 - -
    - Signature: layout1:Layout -> layout2:Layout -> Layout
    -
    -     		-

    Layout two vertically.

    - - -
    - - - aboveListL layouts - -
    - Signature: layouts:Layout list -> Layout
    -
    -     		-

    Layout list vertically.

    - - -
    - - - braceL layout - -
    - Signature: layout:Layout -> Layout
    -
    -     		-

    Wrap braces around layout.

    - - -
    - - - bracketL layout - -
    - Signature: layout:Layout -> Layout
    -
    -     		-

    Wrap round brackets around Layout.

    - - -
    - - - commaListL layouts - -
    - Signature: layouts:Layout list -> Layout
    -
    -     		-

    Join layouts into a comma separated list.

    - - -
    - - - emptyL - -
    - Signature: Layout
    -
    -     		-

    The empty layout

    - - -
    - - - isEmptyL layout - -
    - Signature: layout:Layout -> bool
    -
    -     		-

    Is it the empty layout?

    - - -
    - - - leftL text - -
    - Signature: text:TaggedText -> Layout
    -
    -     		-

    An string which is left parenthesis (no space on the right).

    - - -
    - - - listL selector value - -
    - Signature: selector:('T -> Layout) -> value:'T list -> Layout
    - Type parameters: 'T
    -     		-

    Layout like an F# list.

    - - -
    - - - objL value - -
    - Signature: value:obj -> Layout
    -
    -     		-

    An uninterpreted leaf, to be interpreted into a string -by the layout engine. This allows leaf layouts for numbers, strings and -other atoms to be customized according to culture.

    - - -
    - - - optionL selector value - -
    - Signature: selector:('T -> Layout) -> value:'T option -> Layout
    - Type parameters: 'T
    -     		-

    Layout like an F# option.

    - - -
    - - - rightL text - -
    - Signature: text:TaggedText -> Layout
    -
    -     		-

    An string which is right parenthesis (no space on the left).

    - - -
    - - - semiListL layouts - -
    - Signature: layouts:Layout list -> Layout
    -
    -     		-

    Join layouts into a semi-colon separated list.

    - - -
    - - - sepL text - -
    - Signature: text:TaggedText -> Layout
    -
    -     		-

    An string which requires no spaces either side.

    - - -
    - - - sepListL layout1 layouts - -
    - Signature: layout1:Layout -> layouts:Layout list -> Layout
    -
    -     		-

    Join layouts into a list separated using the given Layout.

    - - -
    - - - spaceListL layouts - -
    - Signature: layouts:Layout list -> Layout
    -
    -     		-

    Join layouts into a space separated list.

    - - -
    - - - squareBracketL layout - -
    - Signature: layout:Layout -> Layout
    -
    -     		-

    Wrap square brackets around layout.

    - - -
    - - - tagAttrL text maps layout - -
    - Signature: text:string -> maps:(string * string) list -> layout:Layout -> Layout
    -
    -     		-

    See tagL

    - - -
    - - - tupleL layouts - -
    - Signature: layouts:Layout list -> Layout
    -
    -     		-

    Form tuple of layouts.

    - - -
    - - - unfoldL selector folder state count - -
    - Signature: selector:('T -> Layout) -> folder:('State -> ('T * 'State) option) -> state:'State -> count:int -> Layout list
    - Type parameters: 'T, 'State
    -     		-

    For limiting layout of list-like sequences (lists,arrays,etc). -unfold a list of items using (project and z) making layout list via itemL. -If reach maxLength (before exhausting) then truncate.

    - - -
    - - - wordL text - -
    - Signature: text:TaggedText -> Layout
    -
    -     		-

    An string leaf

    - - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-layouttag.html b/docs/reference/internal-utilities-structuredformat-layouttag.html deleted file mode 100644 index 5aec4320b5..0000000000 --- a/docs/reference/internal-utilities-structuredformat-layouttag.html +++ /dev/null @@ -1,564 +0,0 @@ - - - - - LayoutTag - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    LayoutTag

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -
    -

    Union Cases

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Union CaseDescription
    - - - ActivePatternCase - -
    - Signature:
    -
    -     		- -
    - - - ActivePatternResult - -
    - Signature:
    -
    -     		- -
    - - - Alias - -
    - Signature:
    -
    -     		- -
    - - - Class - -
    - Signature:
    -
    -     		- -
    - - - Delegate - -
    - Signature:
    -
    -     		- -
    - - - Enum - -
    - Signature:
    -
    -     		- -
    - - - Event - -
    - Signature:
    -
    -     		- -
    - - - Field - -
    - Signature:
    -
    -     		- -
    - - - Interface - -
    - Signature:
    -
    -     		- -
    - - - Keyword - -
    - Signature:
    -
    -     		- -
    - - - LineBreak - -
    - Signature:
    -
    -     		- -
    - - - Local - -
    - Signature:
    -
    -     		- -
    - - - Member - -
    - Signature:
    -
    -     		- -
    - - - Method - -
    - Signature:
    -
    -     		- -
    - - - Module - -
    - Signature:
    -
    -     		- -
    - - - ModuleBinding - -
    - Signature:
    -
    -     		- -
    - - - Namespace - -
    - Signature:
    -
    -     		- -
    - - - NumericLiteral - -
    - Signature:
    -
    -     		- -
    - - - Operator - -
    - Signature:
    -
    -     		- -
    - - - Parameter - -
    - Signature:
    -
    -     		- -
    - - - Property - -
    - Signature:
    -
    -     		- -
    - - - Punctuation - -
    - Signature:
    -
    -     		- -
    - - - Record - -
    - Signature:
    -
    -     		- -
    - - - RecordField - -
    - Signature:
    -
    -     		- -
    - - - Space - -
    - Signature:
    -
    -     		- -
    - - - StringLiteral - -
    - Signature:
    -
    -     		- -
    - - - Struct - -
    - Signature:
    -
    -     		- -
    - - - Text - -
    - Signature:
    -
    -     		- -
    - - - TypeParameter - -
    - Signature:
    -
    -     		- -
    - - - Union - -
    - Signature:
    -
    -     		- -
    - - - UnionCase - -
    - Signature:
    -
    -     		- -
    - - - UnknownEntity - -
    - Signature:
    -
    -     		- -
    - - - UnknownType - -
    - Signature:
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-taggedtext.html b/docs/reference/internal-utilities-structuredformat-taggedtext.html deleted file mode 100644 index a4cc0ea09b..0000000000 --- a/docs/reference/internal-utilities-structuredformat-taggedtext.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - TaggedText - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    TaggedText

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Tag - -
    - Signature: LayoutTag
    - Modifiers: abstract
    -
    -     		- -

    CompiledName: get_Tag

    -
    - - - Text - -
    - Signature: string
    - Modifiers: abstract
    -
    -     		- -

    CompiledName: get_Text

    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-taggedtextops-literals.html b/docs/reference/internal-utilities-structuredformat-taggedtextops-literals.html deleted file mode 100644 index 826cf0bd6e..0000000000 --- a/docs/reference/internal-utilities-structuredformat-taggedtextops-literals.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - Literals - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Literals

    -

    - Namespace: Internal.Utilities.StructuredFormat
    - Parent Module: TaggedTextOps -

    -
    -
    - - - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - arrow - -
    - Signature: TaggedText
    -
    -     		- -
    - - - comma - -
    - Signature: TaggedText
    -
    -     		- -
    - - - equals - -
    - Signature: TaggedText
    -
    -     		- -
    - - - leftBrace - -
    - Signature: TaggedText
    -
    -     		- -
    - - - leftBraceBar - -
    - Signature: TaggedText
    -
    -     		- -
    - - - leftBracket - -
    - Signature: TaggedText
    -
    -     		- -
    - - - leftParen - -
    - Signature: TaggedText
    -
    -     		- -
    - - - lineBreak - -
    - Signature: TaggedText
    -
    -     		- -
    - - - questionMark - -
    - Signature: TaggedText
    -
    -     		- -
    - - - rightBrace - -
    - Signature: TaggedText
    -
    -     		- -
    - - - rightBraceBar - -
    - Signature: TaggedText
    -
    -     		- -
    - - - rightBracket - -
    - Signature: TaggedText
    -
    -     		- -
    - - - rightParen - -
    - Signature: TaggedText
    -
    -     		- -
    - - - semicolon - -
    - Signature: TaggedText
    -
    -     		- -
    - - - space - -
    - Signature: TaggedText
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-taggedtextops.html b/docs/reference/internal-utilities-structuredformat-taggedtextops.html deleted file mode 100644 index 9de7748129..0000000000 --- a/docs/reference/internal-utilities-structuredformat-taggedtextops.html +++ /dev/null @@ -1,528 +0,0 @@ - - - - - TaggedTextOps - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    TaggedTextOps

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -
    - - -

    Nested types and modules

    -
    - - - - - - - - - - -
    ModuleDescription
    - Literals -
    - -
    - -

    Functions and values

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Function or valueDescription
    - - - keywordFunctions - -
    - Signature: Set<string>
    -
    -     		- -
    - - - tag arg1 arg2 - -
    - Signature: LayoutTag -> string -> TaggedText
    -
    -     		- -
    - - - tagAlias arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagClass arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagDelegate arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagEnum arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagEvent arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagField arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagInterface arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagKeyword arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagLineBreak arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagLocal arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagMethod arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagModule arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagModuleBinding arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagNamespace arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagNumericLiteral arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagOperator arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagParameter arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagProperty arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagPunctuation arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagRecord arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagRecordField arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagSpace arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagStringLiteral arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagStruct arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagText arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagTypeParameter arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - - - tagUnionCase arg1 - -
    - Signature: string -> TaggedText
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/internal-utilities-structuredformat-taggedtextwriter.html b/docs/reference/internal-utilities-structuredformat-taggedtextwriter.html deleted file mode 100644 index 35f4e7af29..0000000000 --- a/docs/reference/internal-utilities-structuredformat-taggedtextwriter.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - TaggedTextWriter - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    TaggedTextWriter

    -

    - Namespace: Internal.Utilities.StructuredFormat
    -

    -
    -
    -

    Instance members

    - - - - - - - - - - - - - - -
    Instance memberDescription
    - - - Write(t) - -
    - Signature: t:TaggedText -> unit
    - Modifiers: abstract
    -
    -     		- -
    - - - WriteLine() - -
    - Signature: unit -> unit
    - Modifiers: abstract
    -
    -     		- -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-interactive-shell-compilerinputstream.html b/docs/reference/microsoft-fsharp-compiler-interactive-shell-compilerinputstream.html deleted file mode 100644 index 21f36c8129..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-interactive-shell-compilerinputstream.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - CompilerInputStream - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompilerInputStream

    -

    - Namespace: Microsoft.FSharp.Compiler.Interactive.Shell
    -

    -
    -

    Defines a read-only input stream used to feed content to the hosted F# Interactive dynamic compiler.

    - -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-interactive-shell-compileroutputstream.html b/docs/reference/microsoft-fsharp-compiler-interactive-shell-compileroutputstream.html deleted file mode 100644 index f29b8aaf4a..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-interactive-shell-compileroutputstream.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - CompilerOutputStream - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompilerOutputStream

    -

    - Namespace: Microsoft.FSharp.Compiler.Interactive.Shell
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-interactive-shell-evaluationeventargs.html b/docs/reference/microsoft-fsharp-compiler-interactive-shell-evaluationeventargs.html deleted file mode 100644 index dc8bca668b..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-interactive-shell-evaluationeventargs.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - EvaluationEventArgs - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    EvaluationEventArgs

    -

    - Namespace: Microsoft.FSharp.Compiler.Interactive.Shell
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-interactive-shell-fsievaluationsession.html b/docs/reference/microsoft-fsharp-compiler-interactive-shell-fsievaluationsession.html deleted file mode 100644 index 09db42da93..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-interactive-shell-fsievaluationsession.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FsiEvaluationSession - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FsiEvaluationSession

    -

    - Namespace: Microsoft.FSharp.Compiler.Interactive.Shell
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html b/docs/reference/microsoft-fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html deleted file mode 100644 index 5310ca295b..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FsiEvaluationSessionHostConfig - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FsiEvaluationSessionHostConfig

    -

    - Namespace: Microsoft.FSharp.Compiler.Interactive.Shell
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-interactive-shell-fsivalue.html b/docs/reference/microsoft-fsharp-compiler-interactive-shell-fsivalue.html deleted file mode 100644 index d94713ef2d..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-interactive-shell-fsivalue.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FsiValue - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FsiValue

    -

    - Namespace: Microsoft.FSharp.Compiler.Interactive.Shell
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-interactive-shell-settings.html b/docs/reference/microsoft-fsharp-compiler-interactive-shell-settings.html deleted file mode 100644 index 97d2a9d90b..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-interactive-shell-settings.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Settings - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    Settings

    -

    - Namespace: Microsoft.FSharp.Compiler.Interactive.Shell
    -

    -
    -
    - - - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-compilerenvironment.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-compilerenvironment.html deleted file mode 100644 index 772faf4a97..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-compilerenvironment.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - CompilerEnvironment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompilerEnvironment

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html deleted file mode 100644 index 8d9f8c7a49..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - CompilerEnvironment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    CompilerEnvironment

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-debuggerenvironment.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-debuggerenvironment.html deleted file mode 100644 index cfc027ac5d..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-debuggerenvironment.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - DebuggerEnvironment - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    DebuggerEnvironment

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpchecker.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpchecker.html deleted file mode 100644 index 59241335cb..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpchecker.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpChecker - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpChecker

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html deleted file mode 100644 index 90d273eb4c..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpCheckFileAnswer - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpCheckFileAnswer

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html deleted file mode 100644 index f4f31e485e..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpCheckFileResults - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpCheckFileResults

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html deleted file mode 100644 index de197f8d93..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpCheckProjectResults - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpCheckProjectResults

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html deleted file mode 100644 index 8d038d5308..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpFindDeclFailureReason - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpFindDeclFailureReason

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html deleted file mode 100644 index 6e9c40002a..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpFindDeclResult - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpFindDeclResult

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html deleted file mode 100644 index 7520810607..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpParsingOptions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpParsingOptions

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html deleted file mode 100644 index 2e2f4851d1..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpProjectContext - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpProjectContext

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html deleted file mode 100644 index e4bf56dcb7..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - FSharpProjectOptions - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    FSharpProjectOptions

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-prettynaming.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-prettynaming.html deleted file mode 100644 index eb9115a766..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-prettynaming.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - PrettyNaming - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    PrettyNaming

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - - - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-semanticclassificationtype.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-semanticclassificationtype.html deleted file mode 100644 index 3113d7a3c3..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-semanticclassificationtype.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - SemanticClassificationType - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    SemanticClassificationType

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html b/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html deleted file mode 100644 index e984794e07..0000000000 --- a/docs/reference/microsoft-fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - UnresolvedReferencesSet - F# Compiler Services - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - - - - -

    UnresolvedReferencesSet

    -

    - Namespace: Microsoft.FSharp.Compiler.SourceCodeServices
    -

    -
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/symbols.html b/docs/symbols.html index 0c491a3005..ad34717e39 100644 --- a/docs/symbols.html +++ b/docs/symbols.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Compiler Services: Working with symbols

    +

    Compiler Services: Working with symbols

    This tutorial demonstrates how to work with symbols provided by the F# compiler. See also project wide analysis for information on symbol references.

    @@ -42,25 +41,27 @@ 

    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
+
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
 
    		
 
    // Reference F# compiler API
-#r "FSharp.Compiler.Service.dll"
+#r "FSharp.Compiler.Service.dll"
 
-open System
-open System.IO
-open FSharp.Compiler.SourceCodeServices
+open System
+open System.IO
+open FSharp.Compiler.SourceCodeServices
+open FSharp.Compiler.Text
 
 // Create an interactive checker instance 
-let checker = FSharpChecker.Create()
+let checker = FSharpChecker.Create()
 
    		
 
    
 
    
@@ -82,22 +83,22 @@ 
    15: 
 16:
    -
    let parseAndTypeCheckSingleFile (file, input) = 
+
    let parseAndTypeCheckSingleFile (file, input) = 
     // Get context representing a stand-alone (script) file
-    let projOptions, errors = 
-        checker.GetProjectOptionsFromScript(file, input)
-        |> Async.RunSynchronously
+    let projOptions, errors = 
+        checker.GetProjectOptionsFromScript(file, input)
+        |> Async.RunSynchronously
 
-    let parseFileResults, checkFileResults = 
-        checker.ParseAndCheckFileInProject(file, 0, input, projOptions) 
-        |> Async.RunSynchronously
+    let parseFileResults, checkFileResults = 
+        checker.ParseAndCheckFileInProject(file, 0, input, projOptions) 
+        |> Async.RunSynchronously
 
     // Wait until type checking succeeds (or 100 attempts)
-    match checkFileResults with
-    | FSharpCheckFileAnswer.Succeeded(res) -> parseFileResults, res
-    | res -> failwithf "Parsing did not finish... (%A)" res
+    match checkFileResults with
+    | FSharpCheckFileAnswer.Succeeded(res) -> parseFileResults, res
+    | res -> failwithf "Parsing did not finish... (%A)" res
 
-let file = "/home/user/Test.fsx"
+let file = "/home/user/Test.fsx"
 
    
 
 
@@ -122,7 +123,7 @@ 
    13: 
 14:
    -
    let input2 = 
+
    let input2 = 
       """
 [<System.CLSCompliant(true)>]
 let foo(x, y) = 
@@ -134,8 +135,8 @@ 
    type C() = 
     member x.P = 1
       """
-let parseFileResults, checkFileResults = 
-    parseAndTypeCheckSingleFile(file, input2)
+let parseFileResults, checkFileResults = 
+    parseAndTypeCheckSingleFile(file, SourceText.ofString input2)
 
    
 
 
@@ -145,9 +146,9 @@ 
    3: 
 4:
    -
    let partialAssemblySignature = checkFileResults.PartialAssemblySignature
+
    let partialAssemblySignature = checkFileResults.PartialAssemblySignature
     
-partialAssemblySignature.Entities.Count = 1  // one entity
+partialAssemblySignature.Entities.Count = 1  // one entity
     
 
    
 
@@ -157,27 +158,27 @@ 
    2: 
 3:
    -
    let moduleEntity = partialAssemblySignature.Entities.[0]
+
    let moduleEntity = partialAssemblySignature.Entities.[0]
 
-moduleEntity.DisplayName = "Test"
+moduleEntity.DisplayName = "Test"
 
    
 
 
 
    Now get the entity that corresponds to the type definition in the code:
    
 
-
    1: 
 
    let classEntity = moduleEntity.NestedEntities.[0]
+
    let classEntity = moduleEntity.NestedEntities.[0]
 
    		
 
    
 
    
 
    Now get the value that corresponds to the function defined in the code:
    
 
-
    1: 
 
    let fnVal = moduleEntity.MembersFunctionsAndValues.[0]
+
    let fnVal = moduleEntity.MembersFunctionsAndValues.[0]
 
    		
 
    
 
    
-
    Now look around at the properties describing the function value. All fo the following evaluate to true:
    
+
    Now look around at the properties describing the function value. All of the following evaluate to true:
    
 
-
     1: 
  2: 
  3: 
@@ -202,29 +203,29 @@ 
    22: 
 23: 
 
    fnVal.Attributes.Count = 1
-fnVal.CurriedParameterGroups.Count // 1
-fnVal.CurriedParameterGroups.[0].Count // 2
-fnVal.CurriedParameterGroups.[0].[0].Name // "x"
-fnVal.CurriedParameterGroups.[0].[1].Name // "y"
-fnVal.DeclarationLocation.StartLine // 3
-fnVal.DisplayName // "foo"
-fnVal.DeclaringEntity.Value.DisplayName // "Test"
-fnVal.DeclaringEntity.Value.DeclarationLocation.StartLine // 1
-fnVal.GenericParameters.Count // 0
-fnVal.InlineAnnotation // FSharpInlineAnnotation.OptionalInline
-fnVal.IsActivePattern // false
-fnVal.IsCompilerGenerated // false
-fnVal.IsDispatchSlot // false
-fnVal.IsExtensionMember // false
-fnVal.IsPropertyGetterMethod // false
-fnVal.IsImplicitConstructor // false
-fnVal.IsInstanceMember // false
-fnVal.IsMember // false
-fnVal.IsModuleValueOrMember // true
-fnVal.IsMutable // false
-fnVal.IsPropertySetterMethod // false
-fnVal.IsTypeFunction // false
+
    fnVal.Attributes.Count = 1
+fnVal.CurriedParameterGroups.Count // 1
+fnVal.CurriedParameterGroups.[0].Count // 2
+fnVal.CurriedParameterGroups.[0].[0].Name // "x"
+fnVal.CurriedParameterGroups.[0].[1].Name // "y"
+fnVal.DeclarationLocation.StartLine // 3
+fnVal.DisplayName // "foo"
+fnVal.DeclaringEntity.Value.DisplayName // "Test"
+fnVal.DeclaringEntity.Value.DeclarationLocation.StartLine // 1
+fnVal.GenericParameters.Count // 0
+fnVal.InlineAnnotation // FSharpInlineAnnotation.OptionalInline
+fnVal.IsActivePattern // false
+fnVal.IsCompilerGenerated // false
+fnVal.IsDispatchSlot // false
+fnVal.IsExtensionMember // false
+fnVal.IsPropertyGetterMethod // false
+fnVal.IsImplicitConstructor // false
+fnVal.IsInstanceMember // false
+fnVal.IsMember // false
+fnVal.IsModuleValueOrMember // true
+fnVal.IsMutable // false
+fnVal.IsPropertySetterMethod // false
+fnVal.IsTypeFunction // false
 
    		
 
    
 
    
@@ -238,13 +239,13 @@ 
    6: 
 7:
    -
    fnVal.FullType // int * int -> unit
-fnVal.FullType.IsFunctionType // int * int -> unit
-fnVal.FullType.GenericArguments.[0] // int * int 
-fnVal.FullType.GenericArguments.[0].IsTupleType // int * int 
-let argTy1 = fnVal.FullType.GenericArguments.[0].GenericArguments.[0]
+
    fnVal.FullType // int * int -> unit
+fnVal.FullType.IsFunctionType // int * int -> unit
+fnVal.FullType.GenericArguments.[0] // int * int 
+fnVal.FullType.GenericArguments.[0].IsTupleType // int * int 
+let argTy1 = fnVal.FullType.GenericArguments.[0].GenericArguments.[0]
 
-argTy1.TypeDefinition.DisplayName // int
+argTy1.TypeDefinition.DisplayName // int
 
    
 
 
@@ -253,8 +254,8 @@ 
    1: 
 2: 
 
    
-
    argTy1.HasTypeDefinition
-argTy1.TypeDefinition.IsFSharpAbbreviation // "int"
+
    argTy1.HasTypeDefinition
+argTy1.TypeDefinition.IsFSharpAbbreviation // "int"
 
    
 
 
@@ -263,9 +264,9 @@ 
    2: 
 3: 
 
    
-
    let argTy1b = argTy1.TypeDefinition.AbbreviatedType
-argTy1b.TypeDefinition.Namespace // Some "Microsoft.FSharp.Core" 
-argTy1b.TypeDefinition.CompiledName // "int32" 
+
    let argTy1b = argTy1.TypeDefinition.AbbreviatedType
+argTy1b.TypeDefinition.Namespace // Some "Microsoft.FSharp.Core" 
+argTy1b.TypeDefinition.CompiledName // "int32" 
 
    
 
 
@@ -275,9 +276,9 @@ 
    2: 
 3: 
 
    
-
    let argTy1c = argTy1b.TypeDefinition.AbbreviatedType
-argTy1c.TypeDefinition.Namespace // Some "SystemCore" 
-argTy1c.TypeDefinition.CompiledName // "Int32" 
+
    let argTy1c = argTy1b.TypeDefinition.AbbreviatedType
+argTy1c.TypeDefinition.Namespace // Some "SystemCore" 
+argTy1c.TypeDefinition.CompiledName // "Int32" 
 
    
 
 
@@ -291,22 +292,22 @@ 
    6: 
 7: 
 
    
-
    let projectContext = checkFileResults.ProjectContext
+
    let projectContext = checkFileResults.ProjectContext
     
-for assembly in projectContext.GetReferencedAssemblies() do
-    match assembly.FileName with 
-    | None -> printfn "compilation referenced an assembly without a file" 
-    | Some s -> printfn "compilation references assembly '%s'" s
+for assembly in projectContext.GetReferencedAssemblies() do
+    match assembly.FileName with 
+    | None -> printfn "compilation referenced an assembly without a file" 
+    | Some s -> printfn "compilation references assembly '%s'" s
     
 
    
 
 
 
    Notes:
    
 
      
-
    • If incomplete code is present, some or all of the attirbutes may not be quite as expected.
      • 
+
    • If incomplete code is present, some or all of the attributes may not be quite as expected.
      • 
 
    • 
 If some assembly references are missing (which is actually very, very common), then 'IsUnresolved'  may
-be true on values, members and/or entites related to external assemblies.  You should be sure to make your
+be true on values, members and/or entities related to external assemblies.  You should be sure to make your
 code robust against IsUnresolved exceptions.
 
      • 
 
    
@@ -321,12 +322,12 @@ 
    5: 
 6: 
 
    
-
    let parseAndCheckScript (file, input) = 
-    let projOptions, errors = 
-        checker.GetProjectOptionsFromScript(file, input)
-        |> Async.RunSynchronously
+
    let parseAndCheckScript (file, input) = 
+    let projOptions, errors = 
+        checker.GetProjectOptionsFromScript(file, input)
+        |> Async.RunSynchronously
 
-    checker.ParseAndCheckProject(projOptions) |> Async.RunSynchronously
+    checker.ParseAndCheckProject(projOptions) |> Async.RunSynchronously
 
    
 
 
@@ -336,10 +337,10 @@ 
    3: 
 4: 
 
    
-
    let tmpFile = Path.ChangeExtension(System.IO.Path.GetTempFileName() , "fs")
-File.WriteAllText(tmpFile, input2)
+
    let tmpFile = Path.ChangeExtension(System.IO.Path.GetTempFileName() , "fs")
+File.WriteAllText(tmpFile, input2)
 
-let projectResults = parseAndCheckScript(tmpFile, input2)
+let projectResults = parseAndCheckScript(tmpFile, SourceText.ofString input2)
 
    
 
 
@@ -353,13 +354,13 @@ 
    7: 
 8: 
 
    
-
    let assemblySig = projectResults.AssemblySignature
+
    let assemblySig = projectResults.AssemblySignature
     
-assemblySig.Entities.Count = 1  // one entity
-assemblySig.Entities.[0].Namespace  // one entity
-assemblySig.Entities.[0].DisplayName // "Tmp28D0"
-assemblySig.Entities.[0].MembersFunctionsAndValues.Count // 1 
-assemblySig.Entities.[0].MembersFunctionsAndValues.[0].DisplayName // "foo" 
+assemblySig.Entities.Count = 1  // one entity
+assemblySig.Entities.[0].Namespace  // one entity
+assemblySig.Entities.[0].DisplayName // "Tmp28D0"
+assemblySig.Entities.[0].MembersFunctionsAndValues.Count // 1 
+assemblySig.Entities.[0].MembersFunctionsAndValues.[0].DisplayName // "foo" 
     
 
    
 
@@ -370,90 +371,96 @@ 
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    namespace FSharp.Compiler
    namespace FSharp.Compiler.SourceCodeServices
    -
    val checker : FSharpChecker

    Full name: Symbols.checker
    -
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    -
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    -
    val parseAndTypeCheckSingleFile : file:string * input:string -> 'a * FSharpCheckFileResults

    Full name: Symbols.parseAndTypeCheckSingleFile
    -
    val file : string
    -
    val input : string
    -
    val projOptions : FSharpProjectOptions
    -
    val errors : obj
    -
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    val parseFileResults : 'a
    -
    val checkFileResults : FSharpCheckFileAnswer
    -
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    -
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults

    Full name: FSharp.Compiler.SourceCodeServices.FSharpCheckFileAnswer
    -
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    -
    val res : FSharpCheckFileResults
    -
    val res : FSharpCheckFileAnswer
    -
    val failwithf : format:Printf.StringFormat<'T,'Result> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.failwithf
    -
    val file : string

    Full name: Symbols.file
    -
    val input2 : string

    Full name: Symbols.input2
    -
    val parseFileResults : obj

    Full name: Symbols.parseFileResults
    -
    val checkFileResults : FSharpCheckFileResults

    Full name: Symbols.checkFileResults
    -
    val partialAssemblySignature : FSharpAssemblySignature

    Full name: Symbols.partialAssemblySignature
    -
    property FSharpCheckFileResults.PartialAssemblySignature: FSharpAssemblySignature
    -
    property FSharpAssemblySignature.Entities: Collections.Generic.IList<FSharpEntity>
    -
    property Collections.Generic.ICollection.Count: int
    -
    val moduleEntity : FSharpEntity

    Full name: Symbols.moduleEntity
    -
    property FSharpEntity.DisplayName: string
    -
    val classEntity : FSharpEntity

    Full name: Symbols.classEntity
    -
    property FSharpEntity.NestedEntities: Collections.Generic.IList<FSharpEntity>
    -
    val fnVal : FSharpMemberOrFunctionOrValue

    Full name: Symbols.fnVal
    -
    property FSharpEntity.MembersFunctionsAndValues: Collections.Generic.IList<FSharpMemberOrFunctionOrValue>
    -
    property FSharpMemberOrFunctionOrValue.Attributes: Collections.Generic.IList<FSharpAttribute>
    -
    property FSharpMemberOrFunctionOrValue.CurriedParameterGroups: Collections.Generic.IList<Collections.Generic.IList<FSharpParameter>>
    -
    property FSharpMemberOrFunctionOrValue.DeclarationLocation: FSharp.Compiler.Range.range
    -
    property FSharp.Compiler.Range.range.StartLine: int
    -
    property FSharpMemberOrFunctionOrValue.DisplayName: string
    -
    property FSharpMemberOrFunctionOrValue.DeclaringEntity: FSharpEntity option
    -
    property Option.Value: FSharpEntity
    -
    property FSharpEntity.DeclarationLocation: FSharp.Compiler.Range.range
    -
    property FSharpMemberOrFunctionOrValue.GenericParameters: Collections.Generic.IList<FSharpGenericParameter>
    -
    property FSharpMemberOrFunctionOrValue.InlineAnnotation: FSharpInlineAnnotation
    -
    property FSharpMemberOrFunctionOrValue.IsActivePattern: bool
    -
    property FSharpMemberOrFunctionOrValue.IsCompilerGenerated: bool
    -
    property FSharpMemberOrFunctionOrValue.IsDispatchSlot: bool
    -
    property FSharpMemberOrFunctionOrValue.IsExtensionMember: bool
    -
    property FSharpMemberOrFunctionOrValue.IsPropertyGetterMethod: bool
    -
    property FSharpMemberOrFunctionOrValue.IsImplicitConstructor: bool
    -
    property FSharpMemberOrFunctionOrValue.IsInstanceMember: bool
    -
    property FSharpMemberOrFunctionOrValue.IsMember: bool
    -
    property FSharpMemberOrFunctionOrValue.IsModuleValueOrMember: bool
    -
    property FSharpMemberOrFunctionOrValue.IsMutable: bool
    -
    property FSharpMemberOrFunctionOrValue.IsPropertySetterMethod: bool
    -
    property FSharpMemberOrFunctionOrValue.IsTypeFunction: bool
    -
    property FSharpMemberOrFunctionOrValue.FullType: FSharpType
    -
    property FSharpType.IsFunctionType: bool
    -
    property FSharpType.GenericArguments: Collections.Generic.IList<FSharpType>
    -
    val argTy1 : FSharpType

    Full name: Symbols.argTy1
    -
    property FSharpType.TypeDefinition: FSharpEntity
    -
    property FSharpType.HasTypeDefinition: bool
    -
    property FSharpEntity.IsFSharpAbbreviation: bool
    -
    val argTy1b : FSharpType

    Full name: Symbols.argTy1b
    -
    property FSharpEntity.AbbreviatedType: FSharpType
    -
    property FSharpEntity.Namespace: string option
    -
    property FSharpEntity.CompiledName: string
    -
    val argTy1c : FSharpType

    Full name: Symbols.argTy1c
    -
    val projectContext : FSharpProjectContext

    Full name: Symbols.projectContext
    -
    property FSharpCheckFileResults.ProjectContext: FSharpProjectContext
    -
    member FSharpProjectContext.GetReferencedAssemblies : unit -> FSharpAssembly list
    -
    union case Option.None: Option<'T>
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    union case Option.Some: Value: 'T -> Option<'T>
    -
    val parseAndCheckScript : file:string * input:string -> 'a

    Full name: Symbols.parseAndCheckScript
    -
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    -
    val tmpFile : string

    Full name: Symbols.tmpFile
    -
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val InvalidPathChars : char[]
      static val PathSeparator : char
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string
      static member GetExtension : path:string -> string
      static member GetFileName : path:string -> string
      ...

    Full name: System.IO.Path
    -
    Path.ChangeExtension(path: string, extension: string) : string
    -
    Path.GetTempFileName() : string
    -
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 3 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      static member Encrypt : path:string -> unit
      static member Exists : path:string -> bool
      ...

    Full name: System.IO.File
    -
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    -
    val projectResults : obj

    Full name: Symbols.projectResults
    -
    val assemblySig : obj

    Full name: Symbols.assemblySig
    -
    union case ScopeKind.Namespace: ScopeKind
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>
    +
    namespace FSharp.Compiler.Text
    +
    val checker : FSharpChecker
    +
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    +
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    +
    val parseAndTypeCheckSingleFile : file:string * input:ISourceText -> FSharpParseFileResults * FSharpCheckFileResults
    +
    val file : string
    +
    val input : ISourceText
    +
    val projOptions : FSharpProjectOptions
    +
    val errors : FSharpErrorInfo list
    +
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * sourceText:ISourceText * ?previewEnabled:bool * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?useSdkRefs:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    val parseFileResults : FSharpParseFileResults
    +
    val checkFileResults : FSharpCheckFileAnswer
    +
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    +
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults
    +
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    +
    val res : FSharpCheckFileResults
    +
    val res : FSharpCheckFileAnswer
    +
    val failwithf : format:Printf.StringFormat<'T,'Result> -> 'T
    +
    val input2 : string
    +
    val checkFileResults : FSharpCheckFileResults
    +
    module SourceText

    from FSharp.Compiler.Text
    +
    val ofString : string -> ISourceText
    +
    val partialAssemblySignature : FSharpAssemblySignature
    +
    property FSharpCheckFileResults.PartialAssemblySignature: FSharpAssemblySignature with get
    +
    property FSharpAssemblySignature.Entities: Collections.Generic.IList<FSharpEntity> with get
    +
    property Collections.Generic.ICollection.Count: int with get
    +
    val moduleEntity : FSharpEntity
    +
    property FSharpEntity.DisplayName: string with get
    +
    val classEntity : FSharpEntity
    +
    property FSharpEntity.NestedEntities: Collections.Generic.IList<FSharpEntity> with get
    +
    val fnVal : FSharpMemberOrFunctionOrValue
    +
    property FSharpEntity.MembersFunctionsAndValues: Collections.Generic.IList<FSharpMemberOrFunctionOrValue> with get
    +
    property FSharpMemberOrFunctionOrValue.Attributes: Collections.Generic.IList<FSharpAttribute> with get
    +
    property FSharpMemberOrFunctionOrValue.CurriedParameterGroups: Collections.Generic.IList<Collections.Generic.IList<FSharpParameter>> with get
    +
    property FSharpMemberOrFunctionOrValue.DeclarationLocation: FSharp.Compiler.Range.range with get
    +
    property FSharp.Compiler.Range.range.StartLine: int with get
    +
    property FSharpMemberOrFunctionOrValue.DisplayName: string with get
    +
    property FSharpMemberOrFunctionOrValue.DeclaringEntity: FSharpEntity option with get
    +
    property Option.Value: FSharpEntity with get
    +
    property FSharpEntity.DeclarationLocation: FSharp.Compiler.Range.range with get
    +
    property FSharpMemberOrFunctionOrValue.GenericParameters: Collections.Generic.IList<FSharpGenericParameter> with get
    +
    property FSharpMemberOrFunctionOrValue.InlineAnnotation: FSharpInlineAnnotation with get
    +
    property FSharpMemberOrFunctionOrValue.IsActivePattern: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsCompilerGenerated: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsDispatchSlot: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsExtensionMember: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsPropertyGetterMethod: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsImplicitConstructor: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsInstanceMember: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsMember: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsModuleValueOrMember: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsMutable: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsPropertySetterMethod: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsTypeFunction: bool with get
    +
    property FSharpMemberOrFunctionOrValue.FullType: FSharpType with get
    +
    property FSharpType.IsFunctionType: bool with get
    +
    property FSharpType.GenericArguments: Collections.Generic.IList<FSharpType> with get
    +
    val argTy1 : FSharpType
    +
    property FSharpType.TypeDefinition: FSharpEntity with get
    +
    property FSharpType.HasTypeDefinition: bool with get
    +
    property FSharpEntity.IsFSharpAbbreviation: bool with get
    +
    val argTy1b : FSharpType
    +
    property FSharpEntity.AbbreviatedType: FSharpType with get
    +
    property FSharpEntity.Namespace: string option with get
    +
    property FSharpEntity.CompiledName: string with get
    +
    val argTy1c : FSharpType
    +
    val projectContext : FSharpProjectContext
    +
    property FSharpCheckFileResults.ProjectContext: FSharpProjectContext with get
    +
    val assembly : FSharpAssembly
    +
    member FSharpProjectContext.GetReferencedAssemblies : unit -> FSharpAssembly list
    +
    property FSharpAssembly.FileName: string option with get
    +
    union case Option.None: Option<'T>
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    union case Option.Some: Value: 'T -> Option<'T>
    +
    val s : string
    +
    val parseAndCheckScript : file:string * input:ISourceText -> FSharpCheckProjectResults
    +
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    +
    val tmpFile : string
    +
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val PathSeparator : char
      static val InvalidPathChars : char[]
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string + 1 overload
      static member GetExtension : path:string -> string + 1 overload
      static member GetFileName : path:string -> string + 1 overload
      ...
    +
    Path.ChangeExtension(path: string, extension: string) : string
    +
    Path.GetTempFileName() : string
    +
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllLinesAsync : path:string * contents:IEnumerable<string> * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendAllTextAsync : path:string * contents:string * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 2 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      ...
    +
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    +
    val projectResults : FSharpCheckProjectResults
    +
    val assemblySig : FSharpAssemblySignature
    +
    property FSharpCheckProjectResults.AssemblySignature: FSharpAssemblySignature with get
    +
    union case ScopeKind.Namespace: ScopeKind
    @@ -469,10 +476,10 @@

    Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -501,6 +508,6 @@

    - Fork me on GitHub + Fork me on GitHub diff --git a/docs/tokenizer.html b/docs/tokenizer.html index 0dc3cf64c5..0b28a8c47a 100644 --- a/docs/tokenizer.html +++ b/docs/tokenizer.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Compiler Services: Using the F# tokenizer

    +

    Compiler Services: Using the F# tokenizer

    This tutorial demonstrates how to call the F# language tokenizer. Given F# source code, the tokenizer generates a list of source code lines that contain information about tokens on each line. For each token, you can get the type @@ -49,8 +48,8 @@ 

    1: 
 2:
    -
    #r "FSharp.Compiler.Service.dll"
-open FSharp.Compiler.SourceCodeServices
+
    #r "FSharp.Compiler.Service.dll"
+open FSharp.Compiler.SourceCodeServices
 
    
 
 
@@ -61,7 +60,7 @@ 
    1: 
 
    
-
    let sourceTok = FSharpSourceTokenizer([], Some "C:\\test.fsx")
+
    let sourceTok = FSharpSourceTokenizer([], Some "C:\\test.fsx")
 
    
 
 
@@ -77,12 +76,12 @@ 
    1: 
 
    
-
    let tokenizer = sourceTok.CreateLineTokenizer("let answer=42")
+
    let tokenizer = sourceTok.CreateLineTokenizer("let answer=42")
 
    
 
 
 
    Now, we can write a simple recursive function that calls ScanToken on the tokenizer
-until it returns None (indicating the end of line). When the function suceeds, it
+until it returns None (indicating the end of line). When the function succeeds, it
 returns FSharpTokenInfo object with all the interesting details:
    
 
    1: 
 2: 
@@ -95,14 +94,14 @@ 
    9: 
 
    		
 
    /// Tokenize a single line of F# code
-let rec tokenizeLine (tokenizer:FSharpLineTokenizer) state =
-  match tokenizer.ScanToken(state) with
-  | Some tok, state ->
+let rec tokenizeLine (tokenizer:FSharpLineTokenizer) state =
+  match tokenizer.ScanToken(state) with
+  | Some tok, state ->
       // Print token name
-      printf "%s " tok.TokenName
+      printf "%s " tok.TokenName
       // Tokenize the rest, in the new state
-      tokenizeLine tokenizer state
-  | None, state -> state
+      tokenizeLine tokenizer state
+  | None, state -> state
 
    		
 
    
 
    
@@ -110,7 +109,7 @@ 
    1: 
 
    
-
    tokenizeLine tokenizer FSharpTokenizerLexState.Initial
+
    tokenizeLine tokenizer FSharpTokenizerLexState.Initial
 
    
 
 
@@ -134,10 +133,10 @@ 
    3: 
 4: 
 
    
-
    let lines = """
+
    let lines = """
   // Hello world
   let hello() =
-     printfn "Hello world!" """.Split('\r','\n')
+     printfn "Hello world!" """.Split('\r','\n')
 
    
 
 
@@ -158,16 +157,16 @@ 
    11: 
 
    
 
    /// Print token names for multiple lines of code
-let rec tokenizeLines state count lines = 
-  match lines with
-  | line::lines ->
+let rec tokenizeLines state count lines = 
+  match lines with
+  | line::lines ->
       // Create tokenizer & tokenize single line
-      printfn "\nLine %d" count
-      let tokenizer = sourceTok.CreateLineTokenizer(line)
-      let state = tokenizeLine tokenizer state
+      printfn "\nLine %d" count
+      let tokenizer = sourceTok.CreateLineTokenizer(line)
+      let state = tokenizeLine tokenizer state
       // Tokenize the rest using new state
-      tokenizeLines state (count+1) lines
-  | [] -> ()
+      tokenizeLines state (count+1) lines
+  | [] -> ()
 
    
 
 
@@ -178,9 +177,9 @@ 
    2: 
 3: 
 
    
-
    lines
-|> List.ofSeq
-|> tokenizeLines FSharpTokenizerLexState.Initial 1
+
    lines
+|> List.ofSeq
+|> tokenizeLines FSharpTokenizerLexState.Initial 1
 
    
 
 
@@ -208,29 +207,29 @@ 
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    namespace FSharp.Compiler
    namespace FSharp.Compiler.SourceCodeServices
    -
    val sourceTok : FSharpSourceTokenizer

    Full name: Tokenizer.sourceTok
    -
    Multiple items
    type FSharpSourceTokenizer =
      new : conditionalDefines:string list * fileName:string option -> FSharpSourceTokenizer
      member CreateBufferTokenizer : bufferFiller:(char [] * int * int -> int) -> FSharpLineTokenizer
      member CreateLineTokenizer : lineText:string -> FSharpLineTokenizer

    Full name: FSharp.Compiler.SourceCodeServices.FSharpSourceTokenizer

    --------------------
    new : conditionalDefines:string list * fileName:string option -> FSharpSourceTokenizer
    +
    val sourceTok : FSharpSourceTokenizer
    +
    Multiple items
    type FSharpSourceTokenizer =
      new : conditionalDefines:string list * fileName:string option -> FSharpSourceTokenizer
      member CreateBufferTokenizer : bufferFiller:(char [] * int * int -> int) -> FSharpLineTokenizer
      member CreateLineTokenizer : lineText:string -> FSharpLineTokenizer

    --------------------
    new : conditionalDefines:string list * fileName:string option -> FSharpSourceTokenizer
    union case Option.Some: Value: 'T -> Option<'T>
    -
    val tokenizer : FSharpLineTokenizer

    Full name: Tokenizer.tokenizer
    +
    val tokenizer : FSharpLineTokenizer
    member FSharpSourceTokenizer.CreateLineTokenizer : lineText:string -> FSharpLineTokenizer
    -
    val tokenizeLine : tokenizer:FSharpLineTokenizer -> state:FSharpTokenizerLexState -> FSharpTokenizerLexState

    Full name: Tokenizer.tokenizeLine


     Tokenize a single line of F# code
    -
    val tokenizer : FSharpLineTokenizer
    -
    type FSharpLineTokenizer
    member ScanToken : lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
    static member ColorStateOfLexState : FSharpTokenizerLexState -> FSharpTokenizerColorState
    static member LexStateOfColorState : FSharpTokenizerColorState -> FSharpTokenizerLexState

    Full name: FSharp.Compiler.SourceCodeServices.FSharpLineTokenizer
    -
    val state : FSharpTokenizerLexState
    -
    member FSharpLineTokenizer.ScanToken : lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
    -
    val tok : FSharpTokenInfo
    -
    val printf : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printf
    +
    val tokenizeLine : tokenizer:FSharpLineTokenizer -> state:FSharpTokenizerLexState -> FSharpTokenizerLexState


     Tokenize a single line of F# code
    +
    type FSharpLineTokenizer =
      member ScanToken : lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
      static member ColorStateOfLexState : FSharpTokenizerLexState -> FSharpTokenizerColorState
      static member LexStateOfColorState : FSharpTokenizerColorState -> FSharpTokenizerLexState
    +
    [<Struct>]
    val state : FSharpTokenizerLexState
    +
    member FSharpLineTokenizer.ScanToken : lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
    +
    val tok : FSharpTokenInfo
    +
    val printf : format:Printf.TextWriterFormat<'T> -> 'T
    +
    FSharpTokenInfo.TokenName: string
    union case Option.None: Option<'T>
    -
    type FSharpTokenizerLexState =
      {PosBits: int64;
       OtherBits: int64;}
      member Equals : FSharpTokenizerLexState -> bool
      static member Initial : FSharpTokenizerLexState

    Full name: FSharp.Compiler.SourceCodeServices.FSharpTokenizerLexState
    -
    property FSharpTokenizerLexState.Initial: FSharpTokenizerLexState
    -
    val lines : string []

    Full name: Tokenizer.lines
    -
    val tokenizeLines : state:FSharpTokenizerLexState -> count:int -> lines:string list -> unit

    Full name: Tokenizer.tokenizeLines


     Print token names for multiple lines of code
    +
    [<Struct>]
    type FSharpTokenizerLexState =
      { PosBits: int64
        OtherBits: int64 }
        member Equals : FSharpTokenizerLexState -> bool
        static member Initial : FSharpTokenizerLexState
    +
    property FSharpTokenizerLexState.Initial: FSharpTokenizerLexState with get
    +
    val lines : string []
    +
    val tokenizeLines : state:FSharpTokenizerLexState -> count:int -> lines:string list -> unit


     Print token names for multiple lines of code
    val count : int
    val lines : string list
    val line : string
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    Multiple items
    module List

    from Microsoft.FSharp.Collections

    --------------------
    -
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    Multiple items
    module List

    from Microsoft.FSharp.Collections

    --------------------
    type List<'T> =
      | ( [] )
      | ( :: ) of Head: 'T * Tail: 'T list
        interface IReadOnlyList<'T>
        interface IReadOnlyCollection<'T>
        interface IEnumerable
        interface IEnumerable<'T>
        member GetSlice : startIndex:int option * endIndex:int option -> 'T list
        member Head : 'T
        member IsEmpty : bool
        member Item : index:int -> 'T with get
        member Length : int
        member Tail : 'T list
        ...
    +
    val ofSeq : source:seq<'T> -> 'T list
    @@ -246,10 +245,10 @@

    Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -278,6 +277,6 @@

    Fork me on GitHub + Fork me on GitHub diff --git a/docs/typedtree.html b/docs/typedtree.html index 80fbda9481..4d51087acb 100644 --- a/docs/typedtree.html +++ b/docs/typedtree.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Compiler Services: Processing typed expression tree

    +

    Compiler Services: Processing typed expression tree

    This tutorial demonstrates how to get the checked, typed expressions tree (TAST) for F# code and how to walk over the tree.

    This can be used for creating tools such as source code analyzers and refactoring tools. @@ -51,11 +50,13 @@

    2: 3: 4: +5: -
    #r "FSharp.Compiler.Service.dll"
-open System
-open System.IO
-open FSharp.Compiler.SourceCodeServices
+
    #r "FSharp.Compiler.Service.dll"
+open System
+open System.IO
+open FSharp.Compiler.SourceCodeServices
+open FSharp.Compiler.Text
 
    
 
 
@@ -79,20 +80,20 @@ 
    Checking code15: 
 
    // Create an interactive checker instance 
-let checker = FSharpChecker.Create(keepAssemblyContents=true)
+let checker = FSharpChecker.Create(keepAssemblyContents=true)
 
-let parseAndCheckSingleFile (input) = 
-    let file = Path.ChangeExtension(System.IO.Path.GetTempFileName(), "fsx")  
-    File.WriteAllText(file, input)
+let parseAndCheckSingleFile (input) = 
+    let file = Path.ChangeExtension(System.IO.Path.GetTempFileName(), "fsx")  
+    File.WriteAllText(file, input)
     // Get context representing a stand-alone (script) file
-    let projOptions, _errors = 
-        checker.GetProjectOptionsFromScript(file, input)
-        |> Async.RunSynchronously
+    let projOptions, _errors = 
+        checker.GetProjectOptionsFromScript(file, SourceText.ofString input)
+        |> Async.RunSynchronously
 
-    let fprojOptions, _ = projOptions
+    let fprojOptions = projOptions
 
-    checker.ParseAndCheckProject (fprojOptions)
-    |> Async.RunSynchronously
+    checker.ParseAndCheckProject (fprojOptions)
+    |> Async.RunSynchronously
    @@ -119,7 +120,7 @@

    19: 20: -
    let input2 = 
+
    let input2 = 
       """
 module MyLibrary 
 
@@ -135,10 +136,10 @@ 
    type MyClass() = 
     member x.MyMethod() = 1
       """
-let checkProjectResults = 
-    parseAndCheckSingleFile(input2)
+let checkProjectResults = 
+    parseAndCheckSingleFile(input2)
 
-checkProjectResults.Errors // should be empty
+checkProjectResults.Errors // should be empty
 
    
 
 
@@ -147,7 +148,7 @@ 
    1: 
 
    
-
    let checkedFile = checkProjectResults.AssemblyContents.ImplementationFiles.[0]
+
    let checkedFile = checkProjectResults.AssemblyContents.ImplementationFiles.[0]
 
    
 
 
@@ -175,20 +176,20 @@ 
    19: 
 20: 
 
    
-
    let rec printDecl prefix d = 
-    match d with 
-    | FSharpImplementationFileDeclaration.Entity (e, subDecls) -> 
-        printfn "%sEntity %s was declared and contains %d sub-declarations" prefix e.CompiledName subDecls.Length
-        for subDecl in subDecls do 
-            printDecl (prefix+"    ") subDecl
-    | FSharpImplementationFileDeclaration.MemberOrFunctionOrValue(v, vs, e) -> 
-        printfn "%sMember or value %s was declared" prefix  v.CompiledName
-    | FSharpImplementationFileDeclaration.InitAction(e) -> 
-        printfn "%sA top-level expression was declared" prefix 
+
    let rec printDecl prefix d = 
+    match d with 
+    | FSharpImplementationFileDeclaration.Entity (e, subDecls) -> 
+        printfn "%sEntity %s was declared and contains %d sub-declarations" prefix e.CompiledName subDecls.Length
+        for subDecl in subDecls do 
+            printDecl (prefix+"    ") subDecl
+    | FSharpImplementationFileDeclaration.MemberOrFunctionOrValue(v, vs, e) -> 
+        printfn "%sMember or value %s was declared" prefix  v.CompiledName
+    | FSharpImplementationFileDeclaration.InitAction(e) -> 
+        printfn "%sA top-level expression was declared" prefix 
 
 
-for d in checkedFile.Declarations do 
-   printDecl "" d
+for d in checkedFile.Declarations do 
+   printDecl "" d
 
 // Entity MyLibrary was declared and contains 4 sub-declarations
 //     Member or value foo was declared
@@ -209,10 +210,10 @@ 
    3: 
 4: 
 
    
-
    let myLibraryEntity, myLibraryDecls =    
-   match checkedFile.Declarations.[0] with 
-   | FSharpImplementationFileDeclaration.Entity (e, subDecls) -> (e, subDecls)
-   | _ -> failwith "unexpected"
+
    let myLibraryEntity, myLibraryDecls =    
+   match checkedFile.Declarations.[0] with 
+   | FSharpImplementationFileDeclaration.Entity (e, subDecls) -> (e, subDecls)
+   | _ -> failwith "unexpected"
 
    
 
 
@@ -222,10 +223,10 @@ 
    3: 
 4: 
 
    
-
    let (fooSymbol, fooArgs, fooExpression) = 
-    match myLibraryDecls.[0] with 
-    | FSharpImplementationFileDeclaration.MemberOrFunctionOrValue(v, vs, e) -> (v, vs, e)
-    | _ -> failwith "unexpected"
+
    let (fooSymbol, fooArgs, fooExpression) = 
+    match myLibraryDecls.[0] with 
+    | FSharpImplementationFileDeclaration.MemberOrFunctionOrValue(v, vs, e) -> (v, vs, e)
+    | _ -> failwith "unexpected"
 
    
 
 
@@ -237,8 +238,8 @@ 
    1: 
 2: 
 
    
-
    fooExpression.Type  // shows that the return type of the body expression is 'int'
-fooExpression.Range  // shows the declaration range of the expression implementing 'foo'
+
    fooExpression.Type  // shows that the return type of the body expression is 'int'
+fooExpression.Range  // shows the declaration range of the expression implementing 'foo'
 
    
 
 
@@ -346,106 +347,106 @@ 
     99: 
 100: 
 
    
-
    let rec visitExpr f (e:FSharpExpr) = 
-    f e
-    match e with 
-    | BasicPatterns.AddressOf(lvalueExpr) -> 
-        visitExpr f lvalueExpr
-    | BasicPatterns.AddressSet(lvalueExpr, rvalueExpr) -> 
-        visitExpr f lvalueExpr; visitExpr f rvalueExpr
-    | BasicPatterns.Application(funcExpr, typeArgs, argExprs) -> 
-        visitExpr f funcExpr; visitExprs f argExprs
-    | BasicPatterns.Call(objExprOpt, memberOrFunc, typeArgs1, typeArgs2, argExprs) -> 
-        visitObjArg f objExprOpt; visitExprs f argExprs
-    | BasicPatterns.Coerce(targetType, inpExpr) -> 
-        visitExpr f inpExpr
-    | BasicPatterns.FastIntegerForLoop(startExpr, limitExpr, consumeExpr, isUp) -> 
-        visitExpr f startExpr; visitExpr f limitExpr; visitExpr f consumeExpr
-    | BasicPatterns.ILAsm(asmCode, typeArgs, argExprs) -> 
-        visitExprs f argExprs
-    | BasicPatterns.ILFieldGet (objExprOpt, fieldType, fieldName) -> 
-        visitObjArg f objExprOpt
-    | BasicPatterns.ILFieldSet (objExprOpt, fieldType, fieldName, valueExpr) -> 
-        visitObjArg f objExprOpt
-    | BasicPatterns.IfThenElse (guardExpr, thenExpr, elseExpr) -> 
-        visitExpr f guardExpr; visitExpr f thenExpr; visitExpr f elseExpr
-    | BasicPatterns.Lambda(lambdaVar, bodyExpr) -> 
-        visitExpr f bodyExpr
-    | BasicPatterns.Let((bindingVar, bindingExpr), bodyExpr) -> 
-        visitExpr f bindingExpr; visitExpr f bodyExpr
-    | BasicPatterns.LetRec(recursiveBindings, bodyExpr) -> 
-        List.iter (snd >> visitExpr f) recursiveBindings; visitExpr f bodyExpr
-    | BasicPatterns.NewArray(arrayType, argExprs) -> 
-        visitExprs f argExprs
-    | BasicPatterns.NewDelegate(delegateType, delegateBodyExpr) -> 
-        visitExpr f delegateBodyExpr
-    | BasicPatterns.NewObject(objType, typeArgs, argExprs) -> 
-        visitExprs f argExprs
-    | BasicPatterns.NewRecord(recordType, argExprs) ->  
-        visitExprs f argExprs
-    | BasicPatterns.NewAnonRecord(recordType, argExprs) ->  
-        visitExprs f argExprs
-    | BasicPatterns.NewTuple(tupleType, argExprs) -> 
-        visitExprs f argExprs
-    | BasicPatterns.NewUnionCase(unionType, unionCase, argExprs) -> 
-        visitExprs f argExprs
-    | BasicPatterns.Quote(quotedExpr) -> 
-        visitExpr f quotedExpr
-    | BasicPatterns.FSharpFieldGet(objExprOpt, recordOrClassType, fieldInfo) -> 
-        visitObjArg f objExprOpt
-    | BasicPatterns.AnonRecordGet(objExpr, recordOrClassType, fieldInfo) -> 
-        visitExpr f objExpr
-    | BasicPatterns.FSharpFieldSet(objExprOpt, recordOrClassType, fieldInfo, argExpr) -> 
-        visitObjArg f objExprOpt; visitExpr f argExpr
-    | BasicPatterns.Sequential(firstExpr, secondExpr) -> 
-        visitExpr f firstExpr; visitExpr f secondExpr
-    | BasicPatterns.TryFinally(bodyExpr, finalizeExpr) -> 
-        visitExpr f bodyExpr; visitExpr f finalizeExpr
-    | BasicPatterns.TryWith(bodyExpr, _, _, catchVar, catchExpr) -> 
-        visitExpr f bodyExpr; visitExpr f catchExpr
-    | BasicPatterns.TupleGet(tupleType, tupleElemIndex, tupleExpr) -> 
-        visitExpr f tupleExpr
-    | BasicPatterns.DecisionTree(decisionExpr, decisionTargets) -> 
-        visitExpr f decisionExpr; List.iter (snd >> visitExpr f) decisionTargets
-    | BasicPatterns.DecisionTreeSuccess (decisionTargetIdx, decisionTargetExprs) -> 
-        visitExprs f decisionTargetExprs
-    | BasicPatterns.TypeLambda(genericParam, bodyExpr) -> 
-        visitExpr f bodyExpr
-    | BasicPatterns.TypeTest(ty, inpExpr) -> 
-        visitExpr f inpExpr
-    | BasicPatterns.UnionCaseSet(unionExpr, unionType, unionCase, unionCaseField, valueExpr) -> 
-        visitExpr f unionExpr; visitExpr f valueExpr
-    | BasicPatterns.UnionCaseGet(unionExpr, unionType, unionCase, unionCaseField) -> 
-        visitExpr f unionExpr
-    | BasicPatterns.UnionCaseTest(unionExpr, unionType, unionCase) -> 
-        visitExpr f unionExpr
-    | BasicPatterns.UnionCaseTag(unionExpr, unionType) -> 
-        visitExpr f unionExpr
-    | BasicPatterns.ObjectExpr(objType, baseCallExpr, overrides, interfaceImplementations) -> 
-        visitExpr f baseCallExpr
-        List.iter (visitObjMember f) overrides
-        List.iter (snd >> List.iter (visitObjMember f)) interfaceImplementations
-    | BasicPatterns.TraitCall(sourceTypes, traitName, typeArgs, typeInstantiation, argTypes, argExprs) -> 
-        visitExprs f argExprs
-    | BasicPatterns.ValueSet(valToSet, valueExpr) -> 
-        visitExpr f valueExpr
-    | BasicPatterns.WhileLoop(guardExpr, bodyExpr) -> 
-        visitExpr f guardExpr; visitExpr f bodyExpr
-    | BasicPatterns.BaseValue baseType -> ()
-    | BasicPatterns.DefaultValue defaultType -> ()
-    | BasicPatterns.ThisValue thisType -> ()
-    | BasicPatterns.Const(constValueObj, constType) -> ()
-    | BasicPatterns.Value(valueToGet) -> ()
-    | _ -> failwith (sprintf "unrecognized %+A" e)
+
    let rec visitExpr f (e:FSharpExpr) = 
+    f e
+    match e with 
+    | BasicPatterns.AddressOf(lvalueExpr) -> 
+        visitExpr f lvalueExpr
+    | BasicPatterns.AddressSet(lvalueExpr, rvalueExpr) -> 
+        visitExpr f lvalueExpr; visitExpr f rvalueExpr
+    | BasicPatterns.Application(funcExpr, typeArgs, argExprs) -> 
+        visitExpr f funcExpr; visitExprs f argExprs
+    | BasicPatterns.Call(objExprOpt, memberOrFunc, typeArgs1, typeArgs2, argExprs) -> 
+        visitObjArg f objExprOpt; visitExprs f argExprs
+    | BasicPatterns.Coerce(targetType, inpExpr) -> 
+        visitExpr f inpExpr
+    | BasicPatterns.FastIntegerForLoop(startExpr, limitExpr, consumeExpr, isUp) -> 
+        visitExpr f startExpr; visitExpr f limitExpr; visitExpr f consumeExpr
+    | BasicPatterns.ILAsm(asmCode, typeArgs, argExprs) -> 
+        visitExprs f argExprs
+    | BasicPatterns.ILFieldGet (objExprOpt, fieldType, fieldName) -> 
+        visitObjArg f objExprOpt
+    | BasicPatterns.ILFieldSet (objExprOpt, fieldType, fieldName, valueExpr) -> 
+        visitObjArg f objExprOpt
+    | BasicPatterns.IfThenElse (guardExpr, thenExpr, elseExpr) -> 
+        visitExpr f guardExpr; visitExpr f thenExpr; visitExpr f elseExpr
+    | BasicPatterns.Lambda(lambdaVar, bodyExpr) -> 
+        visitExpr f bodyExpr
+    | BasicPatterns.Let((bindingVar, bindingExpr), bodyExpr) -> 
+        visitExpr f bindingExpr; visitExpr f bodyExpr
+    | BasicPatterns.LetRec(recursiveBindings, bodyExpr) -> 
+        List.iter (snd >> visitExpr f) recursiveBindings; visitExpr f bodyExpr
+    | BasicPatterns.NewArray(arrayType, argExprs) -> 
+        visitExprs f argExprs
+    | BasicPatterns.NewDelegate(delegateType, delegateBodyExpr) -> 
+        visitExpr f delegateBodyExpr
+    | BasicPatterns.NewObject(objType, typeArgs, argExprs) -> 
+        visitExprs f argExprs
+    | BasicPatterns.NewRecord(recordType, argExprs) ->  
+        visitExprs f argExprs
+    | BasicPatterns.NewAnonRecord(recordType, argExprs) ->  
+        visitExprs f argExprs
+    | BasicPatterns.NewTuple(tupleType, argExprs) -> 
+        visitExprs f argExprs
+    | BasicPatterns.NewUnionCase(unionType, unionCase, argExprs) -> 
+        visitExprs f argExprs
+    | BasicPatterns.Quote(quotedExpr) -> 
+        visitExpr f quotedExpr
+    | BasicPatterns.FSharpFieldGet(objExprOpt, recordOrClassType, fieldInfo) -> 
+        visitObjArg f objExprOpt
+    | BasicPatterns.AnonRecordGet(objExpr, recordOrClassType, fieldInfo) -> 
+        visitExpr f objExpr
+    | BasicPatterns.FSharpFieldSet(objExprOpt, recordOrClassType, fieldInfo, argExpr) -> 
+        visitObjArg f objExprOpt; visitExpr f argExpr
+    | BasicPatterns.Sequential(firstExpr, secondExpr) -> 
+        visitExpr f firstExpr; visitExpr f secondExpr
+    | BasicPatterns.TryFinally(bodyExpr, finalizeExpr) -> 
+        visitExpr f bodyExpr; visitExpr f finalizeExpr
+    | BasicPatterns.TryWith(bodyExpr, _, _, catchVar, catchExpr) -> 
+        visitExpr f bodyExpr; visitExpr f catchExpr
+    | BasicPatterns.TupleGet(tupleType, tupleElemIndex, tupleExpr) -> 
+        visitExpr f tupleExpr
+    | BasicPatterns.DecisionTree(decisionExpr, decisionTargets) -> 
+        visitExpr f decisionExpr; List.iter (snd >> visitExpr f) decisionTargets
+    | BasicPatterns.DecisionTreeSuccess (decisionTargetIdx, decisionTargetExprs) -> 
+        visitExprs f decisionTargetExprs
+    | BasicPatterns.TypeLambda(genericParam, bodyExpr) -> 
+        visitExpr f bodyExpr
+    | BasicPatterns.TypeTest(ty, inpExpr) -> 
+        visitExpr f inpExpr
+    | BasicPatterns.UnionCaseSet(unionExpr, unionType, unionCase, unionCaseField, valueExpr) -> 
+        visitExpr f unionExpr; visitExpr f valueExpr
+    | BasicPatterns.UnionCaseGet(unionExpr, unionType, unionCase, unionCaseField) -> 
+        visitExpr f unionExpr
+    | BasicPatterns.UnionCaseTest(unionExpr, unionType, unionCase) -> 
+        visitExpr f unionExpr
+    | BasicPatterns.UnionCaseTag(unionExpr, unionType) -> 
+        visitExpr f unionExpr
+    | BasicPatterns.ObjectExpr(objType, baseCallExpr, overrides, interfaceImplementations) -> 
+        visitExpr f baseCallExpr
+        List.iter (visitObjMember f) overrides
+        List.iter (snd >> List.iter (visitObjMember f)) interfaceImplementations
+    | BasicPatterns.TraitCall(sourceTypes, traitName, typeArgs, typeInstantiation, argTypes, argExprs) -> 
+        visitExprs f argExprs
+    | BasicPatterns.ValueSet(valToSet, valueExpr) -> 
+        visitExpr f valueExpr
+    | BasicPatterns.WhileLoop(guardExpr, bodyExpr) -> 
+        visitExpr f guardExpr; visitExpr f bodyExpr
+    | BasicPatterns.BaseValue baseType -> ()
+    | BasicPatterns.DefaultValue defaultType -> ()
+    | BasicPatterns.ThisValue thisType -> ()
+    | BasicPatterns.Const(constValueObj, constType) -> ()
+    | BasicPatterns.Value(valueToGet) -> ()
+    | _ -> failwith (sprintf "unrecognized %+A" e)
 
-and visitExprs f exprs = 
-    List.iter (visitExpr f) exprs
+and visitExprs f exprs = 
+    List.iter (visitExpr f) exprs
 
-and visitObjArg f objOpt = 
-    Option.iter (visitExpr f) objOpt
+and visitObjArg f objOpt = 
+    Option.iter (visitExpr f) objOpt
 
-and visitObjMember f memb = 
-    visitExpr f memb.Body
+and visitObjMember f memb = 
+    visitExpr f memb.Body
 
    
 
 
@@ -467,7 +468,7 @@ 
    15: 
 16: 
 
    
-
    fooExpression |> visitExpr (fun e -> printfn "Visiting %A" e)
+
    fooExpression |> visitExpr (fun e -> printfn "Visiting %A" e)
 
 // Prints:
 //
@@ -502,181 +503,194 @@ 
    Summary
    
 
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    
 
    namespace FSharp.Compiler
    
 
    namespace FSharp.Compiler.SourceCodeServices
    
-
    val checker : FSharpChecker

    Full name: Typedtree.checker
    
-
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    
-
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    
-
    val parseAndCheckSingleFile : input:string -> 'a

    Full name: Typedtree.parseAndCheckSingleFile
    
-
    val input : string
    
-
    val file : string
    
-
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val InvalidPathChars : char[]
      static val PathSeparator : char
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string
      static member GetExtension : path:string -> string
      static member GetFileName : path:string -> string
      ...

    Full name: System.IO.Path
    
-
    Path.ChangeExtension(path: string, extension: string) : string
    
-
    Path.GetTempFileName() : string
    
-
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 3 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      static member Encrypt : path:string -> unit
      static member Exists : path:string -> bool
      ...

    Full name: System.IO.File
    
-
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    
-
    val projOptions : FSharpProjectOptions * obj
    
-
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    
-
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    
-
    
-
    val fprojOptions : FSharpProjectOptions
    
-
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    
-
    val input2 : string

    Full name: Typedtree.input2
    
-
    val checkProjectResults : obj

    Full name: Typedtree.checkProjectResults
    
-
    val checkedFile : obj

    Full name: Typedtree.checkedFile
    
-
    val printDecl : prefix:string -> d:FSharpImplementationFileDeclaration -> unit

    Full name: Typedtree.printDecl
    
-
    val prefix : string
    
-
    val d : FSharpImplementationFileDeclaration
    
-
    type FSharpImplementationFileDeclaration =
      | Entity of FSharpEntity * FSharpImplementationFileDeclaration list
      | MemberOrFunctionOrValue of FSharpMemberOrFunctionOrValue * FSharpMemberOrFunctionOrValue list list * FSharpExpr
      | InitAction of FSharpExpr

    Full name: FSharp.Compiler.SourceCodeServices.FSharpImplementationFileDeclaration
    
-
    union case FSharpImplementationFileDeclaration.Entity: FSharpEntity * FSharpImplementationFileDeclaration list -> FSharpImplementationFileDeclaration
    
-
    val e : FSharpEntity
    
-
    val subDecls : FSharpImplementationFileDeclaration list
    
-
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    
-
    property FSharpEntity.CompiledName: string
    
-
    union case FSharpImplementationFileDeclaration.MemberOrFunctionOrValue: FSharpMemberOrFunctionOrValue * FSharpMemberOrFunctionOrValue list list * FSharpExpr -> FSharpImplementationFileDeclaration
    
-
    val v : FSharpMemberOrFunctionOrValue
    
-
    val vs : FSharpMemberOrFunctionOrValue list list
    
-
    val e : FSharpExpr
    
-
    property FSharpMemberOrFunctionOrValue.CompiledName: string
    
-
    union case FSharpImplementationFileDeclaration.InitAction: FSharpExpr -> FSharpImplementationFileDeclaration
    
-
    val myLibraryEntity : FSharpEntity

    Full name: Typedtree.myLibraryEntity
    
-
    val myLibraryDecls : FSharpImplementationFileDeclaration list

    Full name: Typedtree.myLibraryDecls
    
-
    val failwith : message:string -> 'T

    Full name: Microsoft.FSharp.Core.Operators.failwith
    
-
    val fooSymbol : FSharpMemberOrFunctionOrValue

    Full name: Typedtree.fooSymbol
    
-
    val fooArgs : FSharpMemberOrFunctionOrValue list list

    Full name: Typedtree.fooArgs
    
-
    val fooExpression : FSharpExpr

    Full name: Typedtree.fooExpression
    
-
    property FSharpExpr.Type: FSharpType
    
-
    property FSharpExpr.Range: FSharp.Compiler.Range.range
    
-
    val visitExpr : f:(FSharpExpr -> unit) -> e:FSharpExpr -> unit

    Full name: Typedtree.visitExpr
    
-
    val f : (FSharpExpr -> unit)
    
-
    type FSharpExpr
    member ImmediateSubExpressions : FSharpExpr list
    member Range : range
    member Type : FSharpType

    Full name: FSharp.Compiler.SourceCodeServices.FSharpExpr
    
-
    module BasicPatterns

    from FSharp.Compiler.SourceCodeServices
    
-
    active recognizer AddressOf: FSharpExpr -> FSharpExpr option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |AddressOf|_| )
    
-
    val lvalueExpr : FSharpExpr
    
-
    active recognizer AddressSet: FSharpExpr -> (FSharpExpr * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |AddressSet|_| )
    
-
    val rvalueExpr : FSharpExpr
    
-
    active recognizer Application: FSharpExpr -> (FSharpExpr * FSharpType list * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |Application|_| )
    
-
    val funcExpr : FSharpExpr
    
-
    val typeArgs : FSharpType list
    
-
    val argExprs : FSharpExpr list
    
-
    val visitExprs : f:(FSharpExpr -> unit) -> exprs:FSharpExpr list -> unit

    Full name: Typedtree.visitExprs
    
-
    active recognizer Call: FSharpExpr -> (FSharpExpr option * FSharpMemberOrFunctionOrValue * FSharpType list * FSharpType list * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |Call|_| )
    
-
    val objExprOpt : FSharpExpr option
    
-
    val memberOrFunc : FSharpMemberOrFunctionOrValue
    
-
    val typeArgs1 : FSharpType list
    
-
    val typeArgs2 : FSharpType list
    
-
    val visitObjArg : f:(FSharpExpr -> unit) -> objOpt:FSharpExpr option -> unit

    Full name: Typedtree.visitObjArg
    
-
    active recognizer Coerce: FSharpExpr -> (FSharpType * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |Coerce|_| )
    
-
    val targetType : FSharpType
    
-
    val inpExpr : FSharpExpr
    
-
    active recognizer FastIntegerForLoop: FSharpExpr -> (FSharpExpr * FSharpExpr * FSharpExpr * bool) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |FastIntegerForLoop|_| )
    
-
    val startExpr : FSharpExpr
    
-
    val limitExpr : FSharpExpr
    
-
    val consumeExpr : FSharpExpr
    
-
    val isUp : bool
    
-
    active recognizer ILAsm: FSharpExpr -> (string * FSharpType list * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |ILAsm|_| )
    
-
    val asmCode : string
    
-
    active recognizer ILFieldGet: FSharpExpr -> (FSharpExpr option * FSharpType * string) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |ILFieldGet|_| )
    
-
    val fieldType : FSharpType
    
-
    val fieldName : string
    
-
    active recognizer ILFieldSet: FSharpExpr -> (FSharpExpr option * FSharpType * string * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |ILFieldSet|_| )
    
-
    val valueExpr : FSharpExpr
    
-
    active recognizer IfThenElse: FSharpExpr -> (FSharpExpr * FSharpExpr * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |IfThenElse|_| )
    
-
    val guardExpr : FSharpExpr
    
-
    val thenExpr : FSharpExpr
    
-
    val elseExpr : FSharpExpr
    
-
    active recognizer Lambda: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |Lambda|_| )
    
-
    val lambdaVar : FSharpMemberOrFunctionOrValue
    
-
    val bodyExpr : FSharpExpr
    
-
    active recognizer Let: FSharpExpr -> ((FSharpMemberOrFunctionOrValue * FSharpExpr) * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |Let|_| )
    
-
    val bindingVar : FSharpMemberOrFunctionOrValue
    
-
    val bindingExpr : FSharpExpr
    
-
    active recognizer LetRec: FSharpExpr -> ((FSharpMemberOrFunctionOrValue * FSharpExpr) list * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |LetRec|_| )
    
-
    val recursiveBindings : (FSharpMemberOrFunctionOrValue * FSharpExpr) list
    
-
    Multiple items
    module List

    from Microsoft.FSharp.Collections

    --------------------
    
-
    val snd : tuple:('T1 * 'T2) -> 'T2

    Full name: Microsoft.FSharp.Core.Operators.snd
    
-
    active recognizer NewArray: FSharpExpr -> (FSharpType * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |NewArray|_| )
    
-
    val arrayType : FSharpType
    
-
    active recognizer NewDelegate: FSharpExpr -> (FSharpType * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |NewDelegate|_| )
    
-
    val delegateType : FSharpType
    
-
    val delegateBodyExpr : FSharpExpr
    
-
    active recognizer NewObject: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpType list * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |NewObject|_| )
    
-
    val objType : FSharpMemberOrFunctionOrValue
    
-
    active recognizer NewRecord: FSharpExpr -> (FSharpType * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |NewRecord|_| )
    
-
    val recordType : FSharpType
    
-
    active recognizer NewAnonRecord: FSharpExpr -> (FSharpType * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |NewAnonRecord|_| )
    
-
    active recognizer NewTuple: FSharpExpr -> (FSharpType * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |NewTuple|_| )
    
-
    val tupleType : FSharpType
    
-
    active recognizer NewUnionCase: FSharpExpr -> (FSharpType * FSharpUnionCase * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |NewUnionCase|_| )
    
-
    val unionType : FSharpType
    
-
    val unionCase : FSharpUnionCase
    
-
    active recognizer Quote: FSharpExpr -> FSharpExpr option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |Quote|_| )
    
-
    val quotedExpr : FSharpExpr
    
-
    active recognizer FSharpFieldGet: FSharpExpr -> (FSharpExpr option * FSharpType * FSharpField) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |FSharpFieldGet|_| )
    
-
    val recordOrClassType : FSharpType
    
-
    val fieldInfo : FSharpField
    
-
    active recognizer AnonRecordGet: FSharpExpr -> (FSharpExpr * FSharpType * int) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |AnonRecordGet|_| )
    
-
    val objExpr : FSharpExpr
    
-
    val fieldInfo : int
    
-
    active recognizer FSharpFieldSet: FSharpExpr -> (FSharpExpr option * FSharpType * FSharpField * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |FSharpFieldSet|_| )
    
-
    val argExpr : FSharpExpr
    
-
    active recognizer Sequential: FSharpExpr -> (FSharpExpr * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |Sequential|_| )
    
-
    val firstExpr : FSharpExpr
    
-
    val secondExpr : FSharpExpr
    
-
    active recognizer TryFinally: FSharpExpr -> (FSharpExpr * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |TryFinally|_| )
    
-
    val finalizeExpr : FSharpExpr
    
-
    active recognizer TryWith: FSharpExpr -> (FSharpExpr * FSharpMemberOrFunctionOrValue * FSharpExpr * FSharpMemberOrFunctionOrValue * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |TryWith|_| )
    
-
    val catchVar : FSharpMemberOrFunctionOrValue
    
-
    val catchExpr : FSharpExpr
    
-
    active recognizer TupleGet: FSharpExpr -> (FSharpType * int * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |TupleGet|_| )
    
-
    val tupleElemIndex : int
    
-
    val tupleExpr : FSharpExpr
    
-
    active recognizer DecisionTree: FSharpExpr -> (FSharpExpr * (FSharpMemberOrFunctionOrValue list * FSharpExpr) list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |DecisionTree|_| )
    
-
    val decisionExpr : FSharpExpr
    
-
    val decisionTargets : (FSharpMemberOrFunctionOrValue list * FSharpExpr) list
    
-
    active recognizer DecisionTreeSuccess: FSharpExpr -> (int * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |DecisionTreeSuccess|_| )
    
-
    val decisionTargetIdx : int
    
-
    val decisionTargetExprs : FSharpExpr list
    
-
    active recognizer TypeLambda: FSharpExpr -> (FSharpGenericParameter list * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |TypeLambda|_| )
    
-
    val genericParam : FSharpGenericParameter list
    
-
    active recognizer TypeTest: FSharpExpr -> (FSharpType * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |TypeTest|_| )
    
-
    val ty : FSharpType
    
-
    active recognizer UnionCaseSet: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase * FSharpField * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |UnionCaseSet|_| )
    
-
    val unionExpr : FSharpExpr
    
-
    val unionCaseField : FSharpField
    
-
    active recognizer UnionCaseGet: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase * FSharpField) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |UnionCaseGet|_| )
    
-
    active recognizer UnionCaseTest: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |UnionCaseTest|_| )
    
-
    active recognizer UnionCaseTag: FSharpExpr -> (FSharpExpr * FSharpType) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |UnionCaseTag|_| )
    
-
    active recognizer ObjectExpr: FSharpExpr -> (FSharpType * FSharpExpr * FSharpObjectExprOverride list * (FSharpType * FSharpObjectExprOverride list) list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |ObjectExpr|_| )
    
-
    val objType : FSharpType
    
-
    val baseCallExpr : FSharpExpr
    
-
    val overrides : FSharpObjectExprOverride list
    
-
    val interfaceImplementations : (FSharpType * FSharpObjectExprOverride list) list
    
-
    val visitObjMember : f:(FSharpExpr -> unit) -> memb:'a -> unit

    Full name: Typedtree.visitObjMember
    
-
    active recognizer TraitCall: FSharpExpr -> (FSharpType list * string * FSharp.Compiler.Ast.MemberFlags * FSharpType list * FSharpType list * FSharpExpr list) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |TraitCall|_| )
    
-
    val sourceTypes : FSharpType list
    
-
    val traitName : string
    
-
    val typeArgs : FSharp.Compiler.Ast.MemberFlags
    
-
    val typeInstantiation : FSharpType list
    
-
    val argTypes : FSharpType list
    
-
    active recognizer ValueSet: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |ValueSet|_| )
    
-
    val valToSet : FSharpMemberOrFunctionOrValue
    
-
    active recognizer WhileLoop: FSharpExpr -> (FSharpExpr * FSharpExpr) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |WhileLoop|_| )
    
-
    active recognizer BaseValue: FSharpExpr -> FSharpType option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |BaseValue|_| )
    
-
    val baseType : FSharpType
    
-
    active recognizer DefaultValue: FSharpExpr -> FSharpType option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |DefaultValue|_| )
    
-
    val defaultType : FSharpType
    
-
    active recognizer ThisValue: FSharpExpr -> FSharpType option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |ThisValue|_| )
    
-
    val thisType : FSharpType
    
-
    active recognizer Const: FSharpExpr -> (obj * FSharpType) option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |Const|_| )
    
-
    val constValueObj : obj
    
-
    val constType : FSharpType
    
-
    active recognizer Value: FSharpExpr -> FSharpMemberOrFunctionOrValue option

    Full name: FSharp.Compiler.SourceCodeServices.BasicPatterns.( |Value|_| )
    
-
    val valueToGet : FSharpMemberOrFunctionOrValue
    
-
    val sprintf : format:Printf.StringFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.sprintf
    
-
    val exprs : FSharpExpr list
    
-
    val objOpt : FSharpExpr option
    
-
    module Option

    from Microsoft.FSharp.Core
    
-
    val iter : action:('T -> unit) -> option:'T option -> unit

    Full name: Microsoft.FSharp.Core.Option.iter
    
-
    val memb : 'a
    
+
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>
    
+
    namespace FSharp.Compiler.Text
    
+
    val checker : FSharpChecker
    
+
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    
+
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    
+
    val parseAndCheckSingleFile : input:string -> FSharpCheckProjectResults
    
+
    val input : string
    
+
    val file : string
    
+
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val PathSeparator : char
      static val InvalidPathChars : char[]
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string + 1 overload
      static member GetExtension : path:string -> string + 1 overload
      static member GetFileName : path:string -> string + 1 overload
      ...
    
+
    Path.ChangeExtension(path: string, extension: string) : string
    
+
    Path.GetTempFileName() : string
    
+
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllLinesAsync : path:string * contents:IEnumerable<string> * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendAllTextAsync : path:string * contents:string * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 2 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      ...
    
+
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    
+
    val projOptions : FSharpProjectOptions
    
+
    val _errors : FSharpErrorInfo list
    
+
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * sourceText:ISourceText * ?previewEnabled:bool * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?useSdkRefs:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    
+
    module SourceText

    from FSharp.Compiler.Text
    
+
    val ofString : string -> ISourceText
    
+
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    
+
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    
+
    val fprojOptions : FSharpProjectOptions
    
+
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    
+
    val input2 : string
    
+
    val checkProjectResults : FSharpCheckProjectResults
    
+
    property FSharpCheckProjectResults.Errors: FSharpErrorInfo [] with get
    
+
    val checkedFile : FSharpImplementationFileContents
    
+
    property FSharpCheckProjectResults.AssemblyContents: FSharpAssemblyContents with get
    
+
    property FSharpAssemblyContents.ImplementationFiles: FSharpImplementationFileContents list with get
    
+
    val printDecl : prefix:string -> d:FSharpImplementationFileDeclaration -> unit
    
+
    val prefix : string
    
+
    val d : FSharpImplementationFileDeclaration
    
+
    type FSharpImplementationFileDeclaration =
      | Entity of FSharpEntity * FSharpImplementationFileDeclaration list
      | MemberOrFunctionOrValue of FSharpMemberOrFunctionOrValue * FSharpMemberOrFunctionOrValue list list * FSharpExpr
      | InitAction of FSharpExpr
    
+
    union case FSharpImplementationFileDeclaration.Entity: FSharpEntity * FSharpImplementationFileDeclaration list -> FSharpImplementationFileDeclaration
    
+
    val e : FSharpEntity
    
+
    val subDecls : FSharpImplementationFileDeclaration list
    
+
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    
+
    property FSharpEntity.CompiledName: string with get
    
+
    property List.Length: int with get
    
+
    val subDecl : FSharpImplementationFileDeclaration
    
+
    union case FSharpImplementationFileDeclaration.MemberOrFunctionOrValue: FSharpMemberOrFunctionOrValue * FSharpMemberOrFunctionOrValue list list * FSharpExpr -> FSharpImplementationFileDeclaration
    
+
    val v : FSharpMemberOrFunctionOrValue
    
+
    val vs : FSharpMemberOrFunctionOrValue list list
    
+
    val e : FSharpExpr
    
+
    property FSharpMemberOrFunctionOrValue.CompiledName: string with get
    
+
    union case FSharpImplementationFileDeclaration.InitAction: FSharpExpr -> FSharpImplementationFileDeclaration
    
+
    property FSharpImplementationFileContents.Declarations: FSharpImplementationFileDeclaration list with get
    
+
    val myLibraryEntity : FSharpEntity
    
+
    val myLibraryDecls : FSharpImplementationFileDeclaration list
    
+
    val failwith : message:string -> 'T
    
+
    val fooSymbol : FSharpMemberOrFunctionOrValue
    
+
    val fooArgs : FSharpMemberOrFunctionOrValue list list
    
+
    val fooExpression : FSharpExpr
    
+
    property FSharpExpr.Type: FSharpType with get
    
+
    property FSharpExpr.Range: FSharp.Compiler.Range.range with get
    
+
    val visitExpr : f:(FSharpExpr -> unit) -> e:FSharpExpr -> unit
    
+
    val f : (FSharpExpr -> unit)
    
+
    type FSharpExpr =
      member ImmediateSubExpressions : FSharpExpr list
      member Range : range
      member Type : FSharpType
    
+
    module BasicPatterns

    from FSharp.Compiler.SourceCodeServices
    
+
    active recognizer AddressOf: FSharpExpr -> FSharpExpr option
    
+
    val lvalueExpr : FSharpExpr
    
+
    active recognizer AddressSet: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    
+
    val rvalueExpr : FSharpExpr
    
+
    active recognizer Application: FSharpExpr -> (FSharpExpr * FSharpType list * FSharpExpr list) option
    
+
    val funcExpr : FSharpExpr
    
+
    val typeArgs : FSharpType list
    
+
    val argExprs : FSharpExpr list
    
+
    val visitExprs : f:(FSharpExpr -> unit) -> exprs:FSharpExpr list -> unit
    
+
    active recognizer Call: FSharpExpr -> (FSharpExpr option * FSharpMemberOrFunctionOrValue * FSharpType list * FSharpType list * FSharpExpr list) option
    
+
    val objExprOpt : FSharpExpr option
    
+
    val memberOrFunc : FSharpMemberOrFunctionOrValue
    
+
    val typeArgs1 : FSharpType list
    
+
    val typeArgs2 : FSharpType list
    
+
    val visitObjArg : f:(FSharpExpr -> unit) -> objOpt:FSharpExpr option -> unit
    
+
    active recognizer Coerce: FSharpExpr -> (FSharpType * FSharpExpr) option
    
+
    val targetType : FSharpType
    
+
    val inpExpr : FSharpExpr
    
+
    active recognizer FastIntegerForLoop: FSharpExpr -> (FSharpExpr * FSharpExpr * FSharpExpr * bool) option
    
+
    val startExpr : FSharpExpr
    
+
    val limitExpr : FSharpExpr
    
+
    val consumeExpr : FSharpExpr
    
+
    val isUp : bool
    
+
    active recognizer ILAsm: FSharpExpr -> (string * FSharpType list * FSharpExpr list) option
    
+
    val asmCode : string
    
+
    active recognizer ILFieldGet: FSharpExpr -> (FSharpExpr option * FSharpType * string) option
    
+
    val fieldType : FSharpType
    
+
    val fieldName : string
    
+
    active recognizer ILFieldSet: FSharpExpr -> (FSharpExpr option * FSharpType * string * FSharpExpr) option
    
+
    val valueExpr : FSharpExpr
    
+
    active recognizer IfThenElse: FSharpExpr -> (FSharpExpr * FSharpExpr * FSharpExpr) option
    
+
    val guardExpr : FSharpExpr
    
+
    val thenExpr : FSharpExpr
    
+
    val elseExpr : FSharpExpr
    
+
    active recognizer Lambda: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpExpr) option
    
+
    val lambdaVar : FSharpMemberOrFunctionOrValue
    
+
    val bodyExpr : FSharpExpr
    
+
    active recognizer Let: FSharpExpr -> ((FSharpMemberOrFunctionOrValue * FSharpExpr) * FSharpExpr) option
    
+
    val bindingVar : FSharpMemberOrFunctionOrValue
    
+
    val bindingExpr : FSharpExpr
    
+
    active recognizer LetRec: FSharpExpr -> ((FSharpMemberOrFunctionOrValue * FSharpExpr) list * FSharpExpr) option
    
+
    val recursiveBindings : (FSharpMemberOrFunctionOrValue * FSharpExpr) list
    
+
    Multiple items
    module List

    from Microsoft.FSharp.Collections

    --------------------
    type List<'T> =
      | ( [] )
      | ( :: ) of Head: 'T * Tail: 'T list
        interface IReadOnlyList<'T>
        interface IReadOnlyCollection<'T>
        interface IEnumerable
        interface IEnumerable<'T>
        member GetSlice : startIndex:int option * endIndex:int option -> 'T list
        member Head : 'T
        member IsEmpty : bool
        member Item : index:int -> 'T with get
        member Length : int
        member Tail : 'T list
        ...
    
+
    val iter : action:('T -> unit) -> list:'T list -> unit
    
+
    val snd : tuple:('T1 * 'T2) -> 'T2
    
+
    active recognizer NewArray: FSharpExpr -> (FSharpType * FSharpExpr list) option
    
+
    val arrayType : FSharpType
    
+
    active recognizer NewDelegate: FSharpExpr -> (FSharpType * FSharpExpr) option
    
+
    val delegateType : FSharpType
    
+
    val delegateBodyExpr : FSharpExpr
    
+
    active recognizer NewObject: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpType list * FSharpExpr list) option
    
+
    val objType : FSharpMemberOrFunctionOrValue
    
+
    active recognizer NewRecord: FSharpExpr -> (FSharpType * FSharpExpr list) option
    
+
    val recordType : FSharpType
    
+
    active recognizer NewAnonRecord: FSharpExpr -> (FSharpType * FSharpExpr list) option
    
+
    active recognizer NewTuple: FSharpExpr -> (FSharpType * FSharpExpr list) option
    
+
    val tupleType : FSharpType
    
+
    active recognizer NewUnionCase: FSharpExpr -> (FSharpType * FSharpUnionCase * FSharpExpr list) option
    
+
    val unionType : FSharpType
    
+
    val unionCase : FSharpUnionCase
    
+
    active recognizer Quote: FSharpExpr -> FSharpExpr option
    
+
    val quotedExpr : FSharpExpr
    
+
    active recognizer FSharpFieldGet: FSharpExpr -> (FSharpExpr option * FSharpType * FSharpField) option
    
+
    val recordOrClassType : FSharpType
    
+
    val fieldInfo : FSharpField
    
+
    active recognizer AnonRecordGet: FSharpExpr -> (FSharpExpr * FSharpType * int) option
    
+
    val objExpr : FSharpExpr
    
+
    val fieldInfo : int
    
+
    active recognizer FSharpFieldSet: FSharpExpr -> (FSharpExpr option * FSharpType * FSharpField * FSharpExpr) option
    
+
    val argExpr : FSharpExpr
    
+
    active recognizer Sequential: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    
+
    val firstExpr : FSharpExpr
    
+
    val secondExpr : FSharpExpr
    
+
    active recognizer TryFinally: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    
+
    val finalizeExpr : FSharpExpr
    
+
    active recognizer TryWith: FSharpExpr -> (FSharpExpr * FSharpMemberOrFunctionOrValue * FSharpExpr * FSharpMemberOrFunctionOrValue * FSharpExpr) option
    
+
    val catchVar : FSharpMemberOrFunctionOrValue
    
+
    val catchExpr : FSharpExpr
    
+
    active recognizer TupleGet: FSharpExpr -> (FSharpType * int * FSharpExpr) option
    
+
    val tupleElemIndex : int
    
+
    val tupleExpr : FSharpExpr
    
+
    active recognizer DecisionTree: FSharpExpr -> (FSharpExpr * (FSharpMemberOrFunctionOrValue list * FSharpExpr) list) option
    
+
    val decisionExpr : FSharpExpr
    
+
    val decisionTargets : (FSharpMemberOrFunctionOrValue list * FSharpExpr) list
    
+
    active recognizer DecisionTreeSuccess: FSharpExpr -> (int * FSharpExpr list) option
    
+
    val decisionTargetIdx : int
    
+
    val decisionTargetExprs : FSharpExpr list
    
+
    active recognizer TypeLambda: FSharpExpr -> (FSharpGenericParameter list * FSharpExpr) option
    
+
    val genericParam : FSharpGenericParameter list
    
+
    active recognizer TypeTest: FSharpExpr -> (FSharpType * FSharpExpr) option
    
+
    val ty : FSharpType
    
+
    active recognizer UnionCaseSet: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase * FSharpField * FSharpExpr) option
    
+
    val unionExpr : FSharpExpr
    
+
    val unionCaseField : FSharpField
    
+
    active recognizer UnionCaseGet: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase * FSharpField) option
    
+
    active recognizer UnionCaseTest: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase) option
    
+
    active recognizer UnionCaseTag: FSharpExpr -> (FSharpExpr * FSharpType) option
    
+
    active recognizer ObjectExpr: FSharpExpr -> (FSharpType * FSharpExpr * FSharpObjectExprOverride list * (FSharpType * FSharpObjectExprOverride list) list) option
    
+
    val objType : FSharpType
    
+
    val baseCallExpr : FSharpExpr
    
+
    val overrides : FSharpObjectExprOverride list
    
+
    val interfaceImplementations : (FSharpType * FSharpObjectExprOverride list) list
    
+
    val visitObjMember : f:(FSharpExpr -> unit) -> memb:FSharpObjectExprOverride -> unit
    
+
    active recognizer TraitCall: FSharpExpr -> (FSharpType list * string * FSharp.Compiler.Ast.MemberFlags * FSharpType list * FSharpType list * FSharpExpr list) option
    
+
    val sourceTypes : FSharpType list
    
+
    val traitName : string
    
+
    val typeArgs : FSharp.Compiler.Ast.MemberFlags
    
+
    val typeInstantiation : FSharpType list
    
+
    val argTypes : FSharpType list
    
+
    active recognizer ValueSet: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpExpr) option
    
+
    val valToSet : FSharpMemberOrFunctionOrValue
    
+
    active recognizer WhileLoop: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    
+
    active recognizer BaseValue: FSharpExpr -> FSharpType option
    
+
    val baseType : FSharpType
    
+
    active recognizer DefaultValue: FSharpExpr -> FSharpType option
    
+
    val defaultType : FSharpType
    
+
    active recognizer ThisValue: FSharpExpr -> FSharpType option
    
+
    val thisType : FSharpType
    
+
    active recognizer Const: FSharpExpr -> (obj * FSharpType) option
    
+
    val constValueObj : obj
    
+
    val constType : FSharpType
    
+
    active recognizer Value: FSharpExpr -> FSharpMemberOrFunctionOrValue option
    
+
    val valueToGet : FSharpMemberOrFunctionOrValue
    
+
    val sprintf : format:Printf.StringFormat<'T> -> 'T
    
+
    val exprs : FSharpExpr list
    
+
    val objOpt : FSharpExpr option
    
+
    module Option

    from Microsoft.FSharp.Core
    
+
    val iter : action:('T -> unit) -> option:'T option -> unit
    
+
    val memb : FSharpObjectExprOverride
    
+
    property FSharpObjectExprOverride.Body: FSharpExpr with get

    @@ -692,10 +706,10 @@

    Summary

  • Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -724,6 +738,6 @@

    Summary

    - Fork me on GitHub + Fork me on GitHub diff --git a/docs/untypedtree.html b/docs/untypedtree.html index 78392b4e0e..f9e0631b45 100644 --- a/docs/untypedtree.html +++ b/docs/untypedtree.html @@ -25,16 +25,15 @@

    F# Compiler Services

    - -

    Compiler Services: Processing untyped syntax tree

    +

    Compiler Services: Processing untyped syntax tree

    This tutorial demonstrates how to get the untyped abstract syntax tree (AST) for F# code and how to walk over the tree. This can be used for creating tools such as code formatter, basic refactoring or code navigation tools. The untyped @@ -57,10 +56,12 @@ 

    1: 
 2: 
 3: 
+4:
    -
    #r "FSharp.Compiler.Service.dll"
-open System
-open FSharp.Compiler.SourceCodeServices
+
    #r "FSharp.Compiler.Service.dll"
+open System
+open FSharp.Compiler.SourceCodeServices
+open FSharp.Compiler.Text
 
    
 
 
@@ -73,7 +74,7 @@ 
    2: 
 
    // Create an interactive checker instance 
-let checker = FSharpChecker.Create()
+let checker = FSharpChecker.Create()
    @@ -102,22 +103,22 @@

    17: 
    /// Get untyped tree for a specified input
-let getUntypedTree (file, input) = 
+let getUntypedTree (file, input) = 
   // Get compiler options for the 'project' implied by a single script file
-  let projOptions, errors = 
-      checker.GetProjectOptionsFromScript(file, input)
-      |> Async.RunSynchronously
+  let projOptions, errors = 
+      checker.GetProjectOptionsFromScript(file, input)
+      |> Async.RunSynchronously
 
-  let parsingOptions, _errors = checker.GetParsingOptionsFromProjectOptions(projOptions)
+  let parsingOptions, _errors = checker.GetParsingOptionsFromProjectOptions(projOptions)
 
   // Run the first phase (untyped parsing) of the compiler
-  let parseFileResults = 
-      checker.ParseFile(file, input, parsingOptions) 
-      |> Async.RunSynchronously
+  let parseFileResults = 
+      checker.ParseFile(file, input, parsingOptions) 
+      |> Async.RunSynchronously
 
-  match parseFileResults.ParseTree with
-  | Some tree -> tree
-  | None -> failwith "Something went wrong during parsing!"
+  match parseFileResults.ParseTree with
+  | Some tree -> tree
+  | None -> failwith "Something went wrong during parsing!"
    @@ -129,7 +130,7 @@

    W

    The relevant parts are in the following namespace:

    -
    1: 
 
    open FSharp.Compiler.Ast
+
    open FSharp.Compiler.Ast
    @@ -160,16 +161,16 @@ 

    /// Walk over a pattern - this is for example used in 
 /// let <pat> = <expr> or in the 'match' expression
-let rec visitPattern = function
-  | SynPat.Wild(_) -> 
-      printfn "  .. underscore pattern"
-  | SynPat.Named(pat, name, _, _, _) ->
-      visitPattern pat
-      printfn "  .. named as '%s'" name.idText
-  | SynPat.LongIdent(LongIdentWithDots(ident, _), _, _, _, _, _) ->
-      let names = String.concat "." [ for i in ident -> i.idText ]
-      printfn "  .. identifier: %s" names
-  | pat -> printfn "  .. other pattern: %A" pat
+let rec visitPattern = function
+  | SynPat.Wild(_) -> 
+      printfn "  .. underscore pattern"
+  | SynPat.Named(pat, name, _, _, _) ->
+      visitPattern pat
+      printfn "  .. named as '%s'" name.idText
+  | SynPat.LongIdent(LongIdentWithDots(ident, _), _, _, _, _, _) ->
+      let names = String.concat "." [ for i in ident -> i.idText ]
+      printfn "  .. identifier: %s" names
+  | pat -> printfn "  .. other pattern: %A" pat
    @@ -207,27 +208,27 @@ 

    /// Walk over an expression - if expression contains two or three 
 /// sub-expressions (two if the 'else' branch is missing), let expression
 /// contains pattern and two sub-expressions
-let rec visitExpression = function
-  | SynExpr.IfThenElse(cond, trueBranch, falseBranchOpt, _, _, _, _) ->
+let rec visitExpression = function
+  | SynExpr.IfThenElse(cond, trueBranch, falseBranchOpt, _, _, _, _) ->
       // Visit all sub-expressions
-      printfn "Conditional:"
-      visitExpression cond
-      visitExpression trueBranch
-      falseBranchOpt |> Option.iter visitExpression 
+      printfn "Conditional:"
+      visitExpression cond
+      visitExpression trueBranch
+      falseBranchOpt |> Option.iter visitExpression 
 
-  | SynExpr.LetOrUse(_, _, bindings, body, _) ->
+  | SynExpr.LetOrUse(_, _, bindings, body, _) ->
       // Visit bindings (there may be multiple 
       // for 'let .. = .. and .. = .. in ...'
-      printfn "LetOrUse with the following bindings:"
-      for binding in bindings do
-        let (Binding(access, kind, inlin, mutabl, attrs, xmlDoc, 
-                     data, pat, retInfo, init, m, sp)) = binding
-        visitPattern pat 
-        visitExpression init
+      printfn "LetOrUse with the following bindings:"
+      for binding in bindings do
+        let (Binding(access, kind, inlin, mutabl, attrs, xmlDoc, 
+                     data, pat, retInfo, init, m, sp)) = binding
+        visitPattern pat 
+        visitExpression init
       // Visit the body expression
-      printfn "And the following body:"
-      visitExpression body
-  | expr -> printfn " - not supported expression: %A" expr
+      printfn "And the following body:"
+      visitExpression body
+  | expr -> printfn " - not supported expression: %A" expr
    @@ -236,7 +237,7 @@

    Walking over declarations

    As mentioned earlier, the AST of a file contains a number of module or namespace declarations -(top-level node) that contain declarations inside a module (let bindings or types) or inisde +(top-level node) that contain declarations inside a module (let bindings or types) or inside a namespace (just types). The following functions walks over declarations - we ignore types, nested modules and all other elements and look only at top-level let bindings (values and functions):

    @@ -259,18 +260,18 @@ 

    /// Walk over a list of declarations in a module. This is anything
 /// that you can write as a top-level inside module (let bindings,
 /// nested modules, type declarations etc.)
-let visitDeclarations decls = 
-  for declaration in decls do
-    match declaration with
-    | SynModuleDecl.Let(isRec, bindings, range) ->
+let visitDeclarations decls = 
+  for declaration in decls do
+    match declaration with
+    | SynModuleDecl.Let(isRec, bindings, range) ->
         // Let binding as a declaration is similar to let binding
         // as an expression (in visitExpression), but has no body
-        for binding in bindings do
-          let (Binding(access, kind, inlin, mutabl, attrs, xmlDoc, 
-                       data, pat, retInfo, body, m, sp)) = binding
-          visitPattern pat 
-          visitExpression body         
-    | _ -> printfn " - not supported declaration: %A" declaration
+        for binding in bindings do
+          let (Binding(access, kind, inlin, mutabl, attrs, xmlDoc, 
+                       data, pat, retInfo, body, m, sp)) = binding
+          visitPattern pat 
+          visitExpression body         
+    | _ -> printfn " - not supported declaration: %A" declaration
    @@ -291,11 +292,11 @@

    /// (basically 'module Foo =' or 'namespace Foo.Bar') /// Note that there is one implicitly, even if the file /// does not explicitly define it.. -let visitModulesAndNamespaces modulesOrNss = - for moduleOrNs in modulesOrNss do - let (SynModuleOrNamespace(lid, isRec, isMod, decls, xml, attrs, _, m)) = moduleOrNs - printfn "Namespace or module: %A" lid - visitDeclarations decls +let visitModulesAndNamespaces modulesOrNss = + for moduleOrNs in modulesOrNss do + let (SynModuleOrNamespace(lid, isRec, isMod, decls, xml, attrs, _, m)) = moduleOrNs + printfn "Namespace or module: %A" lid + visitDeclarations decls @@ -317,18 +318,24 @@

    9: 10: 11: +12: +13: +14: 
    // Sample input for the compiler service
-let input = """
+let input =
+  """
   let foo() = 
     let msg = "Hello world"
     if true then 
-      printfn "%s" msg """
+      printfn "%s" msg
+  """
+
 // File name in Unix format
-let file = "/home/user/Test.fsx"
+let file = "/home/user/Test.fsx"
 
 // Get the AST of sample F# code
-let tree = getUntypedTree(file, input) 
+let tree = getUntypedTree(file, SourceText.ofString input)
    @@ -349,12 +356,12 @@

    7: 
    // Extract implementation file details
-match tree with
-| ParsedInput.ImplFile(implFile) ->
+match tree with
+| ParsedInput.ImplFile(implFile) ->
     // Extract declarations and walk over them
-    let (ParsedImplFileInput(fn, script, name, _, _, modules, _)) = implFile
-    visitModulesAndNamespaces modules
-| _ -> failwith "F# Interface file (*.fsi) not supported."
+    let (ParsedImplFileInput(fn, script, name, _, _, modules, _)) = implFile
+    visitModulesAndNamespaces modules
+| _ -> failwith "F# Interface file (*.fsi) not supported."
    @@ -370,82 +377,98 @@

    Summary

    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    namespace FSharp.Compiler
    namespace FSharp.Compiler.SourceCodeServices
    -
    val checker : FSharpChecker

    Full name: Untypedtree.checker
    -
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    -
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    -
    val getUntypedTree : file:string * input:string -> 'a

    Full name: Untypedtree.getUntypedTree


     Get untyped tree for a specified input
    -
    val file : string
    -
    val input : string
    -
    val projOptions : FSharpProjectOptions
    -
    val errors : obj
    -
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    val parsingOptions : FSharpParsingOptions
    -
    member FSharpChecker.GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    -
    val parseFileResults : obj
    -
    member FSharpChecker.ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    -
    union case Option.Some: Value: 'T -> Option<'T>
    -
    val tree : 'a
    -
    union case Option.None: Option<'T>
    -
    val failwith : message:string -> 'T

    Full name: Microsoft.FSharp.Core.Operators.failwith
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>

    Full name: FSharp.Compiler.SourceCodeServices.FSharpAttribute
    -
    module Ast

    from FSharp.Compiler
    -
    val visitPattern : _arg1:SynPat -> unit

    Full name: Untypedtree.visitPattern


     Walk over a pattern - this is for example used in
     let <pat> = <expr> or in the 'match' expression
    -
    type SynPat =
      | Const of SynConst * range: range
      | Wild of range: range
      | Named of SynPat * Ident * isSelfIdentifier: bool * accessibility: SynAccess option * range: range
      | Typed of SynPat * SynType * range: range
      | Attrib of SynPat * SynAttributes * range: range
      | Or of SynPat * SynPat * range: range
      | Ands of SynPat list * range: range
      | LongIdent of longDotId: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * accessibility: SynAccess option * range: range
      | Tuple of isStruct: bool * SynPat list * range: range
      | Paren of SynPat * range: range
      ...
      member Range : range

    Full name: FSharp.Compiler.Ast.SynPat
    -
    union case SynPat.Wild: range: FSharp.Compiler.Range.range -> SynPat
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    union case SynPat.Named: SynPat * Ident * isSelfIdentifier: bool * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynPat
    -
    val pat : SynPat
    -
    val name : Ident
    -
    property Ident.idText: string
    -
    union case SynPat.LongIdent: longDotId: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynPat
    -
    Multiple items
    union case LongIdentWithDots.LongIdentWithDots: id: LongIdent * dotms: FSharp.Compiler.Range.range list -> LongIdentWithDots

    --------------------
    type LongIdentWithDots =
      | LongIdentWithDots of id: LongIdent * dotms: range list
      member Lid : LongIdent
      member Range : range
      member RangeSansAnyExtraDot : range
      member ThereIsAnExtraDotAtTheEnd : bool

    Full name: FSharp.Compiler.Ast.LongIdentWithDots
    -
    val ident : LongIdent
    -
    val names : string
    -
    Multiple items
    type String =
      new : value:char -> string + 7 overloads
      member Chars : int -> char
      member Clone : unit -> obj
      member CompareTo : value:obj -> int + 1 overload
      member Contains : value:string -> bool
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EndsWith : value:string -> bool + 2 overloads
      member Equals : obj:obj -> bool + 2 overloads
      member GetEnumerator : unit -> CharEnumerator
      member GetHashCode : unit -> int
      ...

    Full name: System.String

    --------------------
    String(value: nativeptr<char>) : unit
    String(value: nativeptr<sbyte>) : unit
    String(value: char []) : unit
    String(c: char, count: int) : unit
    String(value: nativeptr<char>, startIndex: int, length: int) : unit
    String(value: nativeptr<sbyte>, startIndex: int, length: int) : unit
    String(value: char [], startIndex: int, length: int) : unit
    String(value: nativeptr<sbyte>, startIndex: int, length: int, enc: Text.Encoding) : unit
    -
    val concat : sep:string -> strings:seq<string> -> string

    Full name: Microsoft.FSharp.Core.String.concat
    -
    val visitExpression : _arg1:SynExpr -> unit

    Full name: Untypedtree.visitExpression


     Walk over an expression - if expression contains two or three
     sub-expressions (two if the 'else' branch is missing), let expression
     contains pattern and two sub-expressions
    -
    type SynExpr =
      | Paren of expr: SynExpr * leftParenRange: range * rightParenRange: range option * range: range
      | Quote of operator: SynExpr * isRaw: bool * quotedSynExpr: SynExpr * isFromQueryExpression: bool * range: range
      | Const of constant: SynConst * range: range
      | Typed of expr: SynExpr * typeName: SynType * range: range
      | Tuple of isStruct: bool * exprs: SynExpr list * commaRanges: range list * range: range
      | AnonRecd of isStruct: bool * copyInfo: (SynExpr * BlockSeparator) option * recordFields: (Ident * SynExpr) list * range: range
      | ArrayOrList of isList: bool * exprs: SynExpr list * range: range
      | Record of baseInfo: (SynType * SynExpr * range * BlockSeparator option * range) option * copyInfo: (SynExpr * BlockSeparator) option * recordFields: (RecordFieldName * SynExpr option * BlockSeparator option) list * range: range
      | New of isProtected: bool * typeName: SynType * expr: SynExpr * range: range
      | ObjExpr of objType: SynType * argOptions: (SynExpr * Ident option) option * bindings: SynBinding list * extraImpls: SynInterfaceImpl list * newExprRange: range * range: range
      ...
      member IsArbExprAndThusAlreadyReportedError : bool
      member Range : range
      member RangeOfFirstPortion : range
      member RangeSansAnyExtraDot : range

    Full name: FSharp.Compiler.Ast.SynExpr
    -
    union case SynExpr.IfThenElse: ifExpr: SynExpr * thenExpr: SynExpr * elseExpr: SynExpr option * spIfToThen: SequencePointInfoForBinding * isFromErrorRecovery: bool * ifToThenRange: FSharp.Compiler.Range.range * range: FSharp.Compiler.Range.range -> SynExpr
    -
    val cond : SynExpr
    -
    val trueBranch : SynExpr
    -
    val falseBranchOpt : SynExpr option
    -
    module Option

    from Microsoft.FSharp.Core
    -
    val iter : action:('T -> unit) -> option:'T option -> unit

    Full name: Microsoft.FSharp.Core.Option.iter
    -
    union case SynExpr.LetOrUse: isRecursive: bool * isUse: bool * bindings: SynBinding list * body: SynExpr * range: FSharp.Compiler.Range.range -> SynExpr
    -
    val bindings : SynBinding list
    -
    val body : SynExpr
    -
    union case SynBinding.Binding: accessibility: SynAccess option * kind: SynBindingKind * mustInline: bool * isMutable: bool * attrs: SynAttributes * xmlDoc: PreXmlDoc * valData: SynValData * headPat: SynPat * returnInfo: SynBindingReturnInfo option * expr: SynExpr * range: FSharp.Compiler.Range.range * seqPoint: SequencePointInfoForBinding -> SynBinding
    -
    val expr : SynExpr
    -
    val visitDeclarations : decls:seq<SynModuleDecl> -> unit

    Full name: Untypedtree.visitDeclarations


     Walk over a list of declarations in a module. This is anything
     that you can write as a top-level inside module (let bindings,
     nested modules, type declarations etc.)
    -
    val decls : seq<SynModuleDecl>
    -
    val declaration : SynModuleDecl
    -
    type SynModuleDecl =
      | ModuleAbbrev of ident: Ident * longId: LongIdent * range: range
      | NestedModule of SynComponentInfo * isRecursive: bool * SynModuleDecls * bool * range: range
      | Let of isRecursive: bool * SynBinding list * range: range
      | DoExpr of SequencePointInfoForBinding * SynExpr * range: range
      | Types of SynTypeDefn list * range: range
      | Exception of SynExceptionDefn * range: range
      | Open of longDotId: LongIdentWithDots * range: range
      | Attributes of SynAttributes * range: range
      | HashDirective of ParsedHashDirective * range: range
      | NamespaceFragment of SynModuleOrNamespace
      member Range : range

    Full name: FSharp.Compiler.Ast.SynModuleDecl
    -
    union case SynModuleDecl.Let: isRecursive: bool * SynBinding list * range: FSharp.Compiler.Range.range -> SynModuleDecl
    -
    val isRec : bool
    -
    val range : FSharp.Compiler.Range.range
    -
    val visitModulesAndNamespaces : modulesOrNss:seq<SynModuleOrNamespace> -> unit

    Full name: Untypedtree.visitModulesAndNamespaces


     Walk over all module or namespace declarations
     (basically 'module Foo =' or 'namespace Foo.Bar')
     Note that there is one implicitly, even if the file
     does not explicitly define it..
    -
    val modulesOrNss : seq<SynModuleOrNamespace>
    -
    val moduleOrNs : SynModuleOrNamespace
    -
    Multiple items
    union case SynModuleOrNamespace.SynModuleOrNamespace: longId: LongIdent * isRecursive: bool * kind: SynModuleOrNamespaceKind * decls: SynModuleDecls * xmlDoc: PreXmlDoc * attribs: SynAttributes * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynModuleOrNamespace

    --------------------
    type SynModuleOrNamespace =
      | SynModuleOrNamespace of longId: LongIdent * isRecursive: bool * kind: SynModuleOrNamespaceKind * decls: SynModuleDecls * xmlDoc: PreXmlDoc * attribs: SynAttributes * accessibility: SynAccess option * range: range
      member Range : range

    Full name: FSharp.Compiler.Ast.SynModuleOrNamespace
    -
    val lid : LongIdent
    -
    val isMod : SynModuleOrNamespaceKind
    -
    val decls : SynModuleDecls
    -
    val xml : PreXmlDoc
    -
    val attrs : SynAttributes
    -
    val m : FSharp.Compiler.Range.range
    -
    val input : string

    Full name: Untypedtree.input
    -
    val file : string

    Full name: Untypedtree.file
    -
    val tree : ParsedInput

    Full name: Untypedtree.tree
    -
    Multiple items
    module ParsedInput

    from FSharp.Compiler.SourceCodeServices

    --------------------
    type ParsedInput =
      | ImplFile of ParsedImplFileInput
      | SigFile of ParsedSigFileInput
      member Range : range

    Full name: FSharp.Compiler.Ast.ParsedInput
    -
    union case ParsedInput.ImplFile: ParsedImplFileInput -> ParsedInput
    -
    val implFile : ParsedImplFileInput
    -
    Multiple items
    union case ParsedImplFileInput.ParsedImplFileInput: fileName: string * isScript: bool * qualifiedNameOfFile: QualifiedNameOfFile * scopedPragmas: ScopedPragma list * hashDirectives: ParsedHashDirective list * modules: SynModuleOrNamespace list * isLastCompiland: bool * bool -> ParsedImplFileInput

    --------------------
    type ParsedImplFileInput = | ParsedImplFileInput of fileName: string * isScript: bool * qualifiedNameOfFile: QualifiedNameOfFile * scopedPragmas: ScopedPragma list * hashDirectives: ParsedHashDirective list * modules: SynModuleOrNamespace list * isLastCompiland: bool * bool

    Full name: FSharp.Compiler.Ast.ParsedImplFileInput
    -
    val fn : string
    -
    val script : bool
    -
    val name : QualifiedNameOfFile
    -
    val modules : SynModuleOrNamespace list
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>
    +
    namespace FSharp.Compiler.Text
    +
    val checker : FSharpChecker
    +
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    +
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    +
    val getUntypedTree : file:string * input:ISourceText -> FSharp.Compiler.Ast.ParsedInput


     Get untyped tree for a specified input
    +
    val file : string
    +
    val input : ISourceText
    +
    val projOptions : FSharpProjectOptions
    +
    val errors : FSharpErrorInfo list
    +
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * sourceText:ISourceText * ?previewEnabled:bool * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?useSdkRefs:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    val parsingOptions : FSharpParsingOptions
    +
    val _errors : FSharpErrorInfo list
    +
    member FSharpChecker.GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    +
    val parseFileResults : FSharpParseFileResults
    +
    member FSharpChecker.ParseFile : filename:string * sourceText:ISourceText * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    +
    property FSharpParseFileResults.ParseTree: FSharp.Compiler.Ast.ParsedInput option with get
    +
    union case Option.Some: Value: 'T -> Option<'T>
    +
    val tree : FSharp.Compiler.Ast.ParsedInput
    +
    union case Option.None: Option<'T>
    +
    val failwith : message:string -> 'T
    +
    module Ast

    from FSharp.Compiler
    +
    val visitPattern : _arg1:SynPat -> unit


     Walk over a pattern - this is for example used in
     let <pat> = <expr> or in the 'match' expression
    +
    type SynPat =
      | Const of SynConst * range: range
      | Wild of range: range
      | Named of SynPat * Ident * isSelfIdentifier: bool * accessibility: SynAccess option * range: range
      | Typed of SynPat * SynType * range: range
      | Attrib of SynPat * SynAttributes * range: range
      | Or of SynPat * SynPat * range: range
      | Ands of SynPat list * range: range
      | LongIdent of longDotId: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * accessibility: SynAccess option * range: range
      | Tuple of isStruct: bool * SynPat list * range: range
      | Paren of SynPat * range: range
      ...
        member Range : range
    +
    union case SynPat.Wild: range: FSharp.Compiler.Range.range -> SynPat
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    union case SynPat.Named: SynPat * Ident * isSelfIdentifier: bool * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynPat
    +
    val pat : SynPat
    +
    val name : Ident
    +
    property Ident.idText: string with get
    +
    union case SynPat.LongIdent: longDotId: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynPat
    +
    Multiple items
    union case LongIdentWithDots.LongIdentWithDots: id: LongIdent * dotms: FSharp.Compiler.Range.range list -> LongIdentWithDots

    --------------------
    type LongIdentWithDots =
      | LongIdentWithDots of id: LongIdent * dotms: range list
        member Lid : LongIdent
        member Range : range
        member RangeSansAnyExtraDot : range
        member ThereIsAnExtraDotAtTheEnd : bool
    +
    val ident : LongIdent
    +
    val names : string
    +
    Multiple items
    type String =
      new : value:char[] -> string + 8 overloads
      member Chars : int -> char
      member Clone : unit -> obj
      member CompareTo : value:obj -> int + 1 overload
      member Contains : value:string -> bool + 3 overloads
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EndsWith : value:string -> bool + 3 overloads
      member Equals : obj:obj -> bool + 2 overloads
      member GetEnumerator : unit -> CharEnumerator
      member GetHashCode : unit -> int + 1 overload
      ...

    --------------------
    String(value: char []) : String
    String(value: nativeptr<char>) : String
    String(value: nativeptr<sbyte>) : String
    String(value: ReadOnlySpan<char>) : String
    String(c: char, count: int) : String
    String(value: char [], startIndex: int, length: int) : String
    String(value: nativeptr<char>, startIndex: int, length: int) : String
    String(value: nativeptr<sbyte>, startIndex: int, length: int) : String
    String(value: nativeptr<sbyte>, startIndex: int, length: int, enc: Text.Encoding) : String
    +
    val concat : sep:string -> strings:seq<string> -> string
    +
    val i : Ident
    +
    val visitExpression : _arg1:SynExpr -> unit


     Walk over an expression - if expression contains two or three
     sub-expressions (two if the 'else' branch is missing), let expression
     contains pattern and two sub-expressions
    +
    type SynExpr =
      | Paren of expr: SynExpr * leftParenRange: range * rightParenRange: range option * range: range
      | Quote of operator: SynExpr * isRaw: bool * quotedSynExpr: SynExpr * isFromQueryExpression: bool * range: range
      | Const of constant: SynConst * range: range
      | Typed of expr: SynExpr * typeName: SynType * range: range
      | Tuple of isStruct: bool * exprs: SynExpr list * commaRanges: range list * range: range
      | AnonRecd of isStruct: bool * copyInfo: (SynExpr * BlockSeparator) option * recordFields: (Ident * SynExpr) list * range: range
      | ArrayOrList of isList: bool * exprs: SynExpr list * range: range
      | Record of baseInfo: (SynType * SynExpr * range * BlockSeparator option * range) option * copyInfo: (SynExpr * BlockSeparator) option * recordFields: (RecordFieldName * SynExpr option * BlockSeparator option) list * range: range
      | New of isProtected: bool * typeName: SynType * expr: SynExpr * range: range
      | ObjExpr of objType: SynType * argOptions: (SynExpr * Ident option) option * bindings: SynBinding list * extraImpls: SynInterfaceImpl list * newExprRange: range * range: range
      ...
        member IsArbExprAndThusAlreadyReportedError : bool
        member Range : range
        member RangeOfFirstPortion : range
        member RangeSansAnyExtraDot : range
    +
    union case SynExpr.IfThenElse: ifExpr: SynExpr * thenExpr: SynExpr * elseExpr: SynExpr option * spIfToThen: SequencePointInfoForBinding * isFromErrorRecovery: bool * ifToThenRange: FSharp.Compiler.Range.range * range: FSharp.Compiler.Range.range -> SynExpr
    +
    val cond : SynExpr
    +
    val trueBranch : SynExpr
    +
    val falseBranchOpt : SynExpr option
    +
    module Option

    from Microsoft.FSharp.Core
    +
    val iter : action:('T -> unit) -> option:'T option -> unit
    +
    union case SynExpr.LetOrUse: isRecursive: bool * isUse: bool * bindings: SynBinding list * body: SynExpr * range: FSharp.Compiler.Range.range -> SynExpr
    +
    val bindings : SynBinding list
    +
    val body : SynExpr
    +
    val binding : SynBinding
    +
    union case SynBinding.Binding: accessibility: SynAccess option * kind: SynBindingKind * mustInline: bool * isMutable: bool * attrs: SynAttributes * xmlDoc: PreXmlDoc * valData: SynValData * headPat: SynPat * returnInfo: SynBindingReturnInfo option * expr: SynExpr * range: FSharp.Compiler.Range.range * seqPoint: SequencePointInfoForBinding -> SynBinding
    +
    val access : SynAccess option
    +
    val kind : SynBindingKind
    +
    val inlin : bool
    +
    val mutabl : bool
    +
    val attrs : SynAttributes
    +
    val xmlDoc : PreXmlDoc
    +
    val data : SynValData
    +
    val retInfo : SynBindingReturnInfo option
    +
    val init : SynExpr
    +
    val m : FSharp.Compiler.Range.range
    +
    val sp : SequencePointInfoForBinding
    +
    val expr : SynExpr
    +
    val visitDeclarations : decls:seq<SynModuleDecl> -> unit


     Walk over a list of declarations in a module. This is anything
     that you can write as a top-level inside module (let bindings,
     nested modules, type declarations etc.)
    +
    val decls : seq<SynModuleDecl>
    +
    val declaration : SynModuleDecl
    +
    type SynModuleDecl =
      | ModuleAbbrev of ident: Ident * longId: LongIdent * range: range
      | NestedModule of SynComponentInfo * isRecursive: bool * SynModuleDecls * bool * range: range
      | Let of isRecursive: bool * SynBinding list * range: range
      | DoExpr of SequencePointInfoForBinding * SynExpr * range: range
      | Types of SynTypeDefn list * range: range
      | Exception of SynExceptionDefn * range: range
      | Open of longDotId: LongIdentWithDots * range: range
      | Attributes of SynAttributes * range: range
      | HashDirective of ParsedHashDirective * range: range
      | NamespaceFragment of SynModuleOrNamespace
        member Range : range
    +
    union case SynModuleDecl.Let: isRecursive: bool * SynBinding list * range: FSharp.Compiler.Range.range -> SynModuleDecl
    +
    val isRec : bool
    +
    val range : FSharp.Compiler.Range.range
    +
    val visitModulesAndNamespaces : modulesOrNss:seq<SynModuleOrNamespace> -> unit


     Walk over all module or namespace declarations
     (basically 'module Foo =' or 'namespace Foo.Bar')
     Note that there is one implicitly, even if the file
     does not explicitly define it..
    +
    val modulesOrNss : seq<SynModuleOrNamespace>
    +
    val moduleOrNs : SynModuleOrNamespace
    +
    Multiple items
    union case SynModuleOrNamespace.SynModuleOrNamespace: longId: LongIdent * isRecursive: bool * kind: SynModuleOrNamespaceKind * decls: SynModuleDecls * xmlDoc: PreXmlDoc * attribs: SynAttributes * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynModuleOrNamespace

    --------------------
    type SynModuleOrNamespace =
      | SynModuleOrNamespace of longId: LongIdent * isRecursive: bool * kind: SynModuleOrNamespaceKind * decls: SynModuleDecls * xmlDoc: PreXmlDoc * attribs: SynAttributes * accessibility: SynAccess option * range: range
        member Range : range
    +
    val lid : LongIdent
    +
    [<Struct>]
    val isMod : SynModuleOrNamespaceKind
    +
    val decls : SynModuleDecls
    +
    val xml : PreXmlDoc
    +
    val input : string
    +
    val tree : ParsedInput
    +
    val getUntypedTree : file:string * input:ISourceText -> ParsedInput


     Get untyped tree for a specified input
    +
    module SourceText

    from FSharp.Compiler.Text
    +
    val ofString : string -> ISourceText
    +
    Multiple items
    module ParsedInput

    from FSharp.Compiler.SourceCodeServices

    --------------------
    type ParsedInput =
      | ImplFile of ParsedImplFileInput
      | SigFile of ParsedSigFileInput
        member Range : range
    +
    union case ParsedInput.ImplFile: ParsedImplFileInput -> ParsedInput
    +
    val implFile : ParsedImplFileInput
    +
    Multiple items
    union case ParsedImplFileInput.ParsedImplFileInput: fileName: string * isScript: bool * qualifiedNameOfFile: QualifiedNameOfFile * scopedPragmas: ScopedPragma list * hashDirectives: ParsedHashDirective list * modules: SynModuleOrNamespace list * isLastCompiland: bool * bool -> ParsedImplFileInput

    --------------------
    type ParsedImplFileInput = | ParsedImplFileInput of fileName: string * isScript: bool * qualifiedNameOfFile: QualifiedNameOfFile * scopedPragmas: ScopedPragma list * hashDirectives: ParsedHashDirective list * modules: SynModuleOrNamespace list * isLastCompiland: bool * bool
    +
    val fn : string
    +
    val script : bool
    +
    val name : QualifiedNameOfFile
    +
    val modules : SynModuleOrNamespace list

    @@ -461,10 +484,10 @@

    Summary

  • Home page
  • Get Library via NuGet
    • -
  • Source Code on GitHub
    • -
  • License
    • -
  • Release Notes
    • - +
  • Source Code on GitHub
    • +
  • License
    • +
  • Release Notes
    • +
  • Getting started
  • Home page
  • Developer notes
    • @@ -493,6 +516,6 @@

    Summary

    - Fork me on GitHub + Fork me on GitHub diff --git a/fcs/docsrc/tools/generate.fsx b/fcs/docsrc/tools/generate.fsx index 241133bff5..785ab9028e 100644 --- a/fcs/docsrc/tools/generate.fsx +++ b/fcs/docsrc/tools/generate.fsx @@ -57,9 +57,9 @@ let copyFiles () = Shell.copyRecursive (formatting @@ "styles") (output @@ "content") true |> Trace.tracefn "Copying styles and scripts: %A" -let clr = System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory() +let clr = Path.GetDirectoryName(typeof.Assembly.Location) //System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory() printfn "CLR: %s" clr -let fsfmt = @"C:\Users\nojaf\.nuget\packages\fsharp.formatting\4.0.0-alpha02\lib\netstandard2.0" // __SOURCE_DIRECTORY__ @@ ".." @@ ".." @@ @"packages" @@ "FSharp.Formatting" @@ "lib" @@ "net40" +let fsfmt = @"C:\Users\nojaf\.nuget\packages\fsharp.formatting\4.0.0-alpha03\lib\netstandard2.0" // __SOURCE_DIRECTORY__ @@ ".." @@ ".." @@ @"packages" @@ "FSharp.Formatting" @@ "lib" @@ "net40" // Build API reference from XML comments let buildReference () = @@ -76,7 +76,7 @@ let buildReference () = clr @@ "System.Core.dll" clr @@ "Microsoft.CSharp.dll" clr @@ "System.Linq.dll" - clr @@ "System.dll" + // clr @@ "System.dll" clr @@ "System.Reflection.Metadata.dll" clr @@ "System.Numerics.dll" clr @@ "System.Collections.Immutable.dll" @@ -84,8 +84,30 @@ let buildReference () = clr @@ "mscorlib.dll" fsfmt @@ "FSharp.MetadataFormat.dll" fsfmt @@ "RazorEngine.NetCore.dll" - bin @@ "FSharp.Core.dll" + @"C:\Users\nojaf\.nuget\packages\fsharp.core\4.7.0\lib\netstandard2.0\FSharp.Core.dll" + // bin @@ "FSharp.Core.dll" bin @@ "FSharp.Compiler.Service.dll" +// clr @@ "System.Collections.dll" +// clr @@ "System.Core.dll" +// clr @@ "System.Data.dll" +// clr @@ "System.dll" +// clr @@ "System.Drawing.dll" +// clr @@ "System.IO.dll" +// clr @@ "System.Linq.dll" +// clr @@ "System.Linq.Expressions.dll" +// clr @@ "System.Net.Requests.dll" +// clr @@ "System.Numerics.dll" +// clr @@ "System.Reflection.dll" +// clr @@ "System.Runtime.dll" +// clr @@ "System.Runtime.Numerics.dll" +// clr @@ "System.Threading.dll" +// clr @@ "System.Threading.Tasks.dll" +// clr @@ "System.Web.dll" +// clr @@ "System.Xml.dll" + @"C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App\2.1.13\Microsoft.AspNetCore.dll" + @"C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App\2.1.13\Microsoft.AspNetCore.Razor.dll" + @"C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App\2.1.13\Microsoft.AspNetCore.Razor.Language.dll" + @"C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App\2.1.13\Microsoft.AspNetCore.Razor.Runtime.dll" ] ) // Build documentation from `fsx` and `md` files in `docsrc/content` diff --git a/fcs/paket.dependencies b/fcs/paket.dependencies index c3f2d642fb..42e0952617 100644 --- a/fcs/paket.dependencies +++ b/fcs/paket.dependencies @@ -18,7 +18,6 @@ nuget Fake.DotNet.Paket group generate source https://api.nuget.org/v3/index.json -source C:\Users\nojaf\Projects\FSharp.Formatting\artifacts storage: none framework: netstandard2.0 From 0142acd4f50e3b398d7924f78cc78ad98d660c46 Mon Sep 17 00:00:00 2001 From: nojaf Date: Sun, 9 Feb 2020 15:43:06 +0100 Subject: [PATCH 4/7] Update documentation for FCS 34. --- docs/fsharp-readme.html | 309 -- docs/ja/compiler.html | 228 - docs/ja/corelib.html | 176 - docs/ja/devnotes.html | 143 - docs/ja/editor.html | 430 -- docs/ja/filesystem.html | 427 -- docs/ja/fsharp-readme.html | 344 -- docs/ja/index.html | 159 - docs/ja/interactive.html | 550 --- docs/ja/project.html | 549 --- docs/ja/symbols.html | 516 --- docs/ja/tokenizer.html | 291 -- docs/ja/untypedtree.html | 527 --- ...rp-compiler-abstractil-il-ilalignment.html | 154 + ...ompiler-abstractil-il-ilargconvention.html | 187 + ...p-compiler-abstractil-il-ilarraybound.html | 172 + ...-compiler-abstractil-il-ilarraybounds.html | 130 + ...p-compiler-abstractil-il-ilarrayshape.html | 174 + ...ler-abstractil-il-ilassemblylongevity.html | 172 + ...iler-abstractil-il-ilassemblymanifest.html | 352 ++ ...-compiler-abstractil-il-ilassemblyref.html | 256 ++ ...p-compiler-abstractil-il-ilattribelem.html | 331 ++ ...rp-compiler-abstractil-il-ilattribute.html | 188 + ...ler-abstractil-il-ilattributenamedarg.html | 156 + ...p-compiler-abstractil-il-ilattributes.html | 137 + ...iler-abstractil-il-ilattributesstored.html | 102 + ...rp-compiler-abstractil-il-ilbasictype.html | 290 ++ ...sharp-compiler-abstractil-il-ilboxity.html | 128 + ...-compiler-abstractil-il-ilcallingconv.html | 235 + ...iler-abstractil-il-ilcallingsignature.html | 147 + .../fsharp-compiler-abstractil-il-ilcode.html | 161 + ...rp-compiler-abstractil-il-ilcodelabel.html | 96 + ...piler-abstractil-il-ilcomparisoninstr.html | 264 ++ ...fsharp-compiler-abstractil-il-ilconst.html | 161 + ...bstractil-il-ildefaultpinvokeencoding.html | 148 + ...arp-compiler-abstractil-il-ilenuminfo.html | 130 + ...arp-compiler-abstractil-il-ileventdef.html | 305 ++ ...rp-compiler-abstractil-il-ileventdefs.html | 138 + ...arp-compiler-abstractil-il-ileventref.html | 158 + ...piler-abstractil-il-ilexceptionclause.html | 159 + ...ompiler-abstractil-il-ilexceptionspec.html | 135 + ...stractil-il-ilexportedtypeorforwarder.html | 240 + ...actil-il-ilexportedtypesandforwarders.html | 136 + ...arp-compiler-abstractil-il-ilfielddef.html | 454 ++ ...rp-compiler-abstractil-il-ilfielddefs.html | 139 + ...rp-compiler-abstractil-il-ilfieldinit.html | 293 ++ ...arp-compiler-abstractil-il-ilfieldref.html | 149 + ...rp-compiler-abstractil-il-ilfieldspec.html | 200 + ...-compiler-abstractil-il-ilgenericargs.html | 196 + ...piler-abstractil-il-ilgenericargslist.html | 194 + ...r-abstractil-il-ilgenericparameterdef.html | 244 + ...-abstractil-il-ilgenericparameterdefs.html | 194 + ...piler-abstractil-il-ilgenericvariance.html | 141 + ...harp-compiler-abstractil-il-ilglobals.html | 443 ++ .../fsharp-compiler-abstractil-il-ilguid.html | 96 + ...fsharp-compiler-abstractil-il-ilinstr.html | 1358 ++++++ ...mpiler-abstractil-il-illazymethodbody.html | 123 + ...fsharp-compiler-abstractil-il-illocal.html | 150 + ...mpiler-abstractil-il-illocaldebuginfo.html | 135 + ...ler-abstractil-il-illocaldebugmapping.html | 139 + ...sharp-compiler-abstractil-il-illocals.html | 194 + ...piler-abstractil-il-illocalsallocator.html | 152 + ...compiler-abstractil-il-ilmemberaccess.html | 200 + ...p-compiler-abstractil-il-ilmethodbody.html | 202 + ...rp-compiler-abstractil-il-ilmethoddef.html | 953 ++++ ...p-compiler-abstractil-il-ilmethoddefs.html | 154 + ...ompiler-abstractil-il-ilmethodimpldef.html | 130 + ...mpiler-abstractil-il-ilmethodimpldefs.html | 123 + ...rp-compiler-abstractil-il-ilmethodref.html | 244 + ...p-compiler-abstractil-il-ilmethodspec.html | 244 + ...ler-abstractil-il-ilmethodvirtualinfo.html | 154 + ...rp-compiler-abstractil-il-ilmoduledef.html | 432 ++ ...rp-compiler-abstractil-il-ilmoduleref.html | 170 + ...mpiler-abstractil-il-ilnativeresource.html | 137 + ...p-compiler-abstractil-il-ilnativetype.html | 608 +++ ...ompiler-abstractil-il-ilnativevariant.html | 681 +++ ...er-abstractil-il-ilnestedexportedtype.html | 191 + ...r-abstractil-il-ilnestedexportedtypes.html | 123 + ...ompiler-abstractil-il-iloverridesspec.html | 152 + ...rp-compiler-abstractil-il-ilparameter.html | 252 ++ ...p-compiler-abstractil-il-ilparameters.html | 194 + ...arp-compiler-abstractil-il-ilplatform.html | 147 + ...p-compiler-abstractil-il-ilpretypedef.html | 159 + ...mpiler-abstractil-il-ilpretypedefimpl.html | 101 + ...-compiler-abstractil-il-ilpropertydef.html | 319 ++ ...compiler-abstractil-il-ilpropertydefs.html | 138 + ...-compiler-abstractil-il-ilpropertyref.html | 158 + ...arp-compiler-abstractil-il-ilreadonly.html | 128 + ...p-compiler-abstractil-il-ilreferences.html | 128 + ...arp-compiler-abstractil-il-ilresource.html | 194 + ...mpiler-abstractil-il-ilresourceaccess.html | 133 + ...iler-abstractil-il-ilresourcelocation.html | 99 + ...rp-compiler-abstractil-il-ilresources.html | 125 + ...sharp-compiler-abstractil-il-ilreturn.html | 198 + ...arp-compiler-abstractil-il-ilscoperef.html | 205 + ...mpiler-abstractil-il-ilsecurityaction.html | 341 ++ ...compiler-abstractil-il-ilsecuritydecl.html | 115 + ...ompiler-abstractil-il-ilsecuritydecls.html | 126 + ...r-abstractil-il-ilsecuritydeclsstored.html | 102 + ...mpiler-abstractil-il-ilsourcedocument.html | 187 + ...compiler-abstractil-il-ilsourcemarker.html | 198 + ...arp-compiler-abstractil-il-iltailcall.html | 128 + ...mpiler-abstractil-il-ilthisconvention.html | 154 + ...fsharp-compiler-abstractil-il-iltoken.html | 148 + .../fsharp-compiler-abstractil-il-iltype.html | 366 ++ ...harp-compiler-abstractil-il-iltypedef.html | 718 +++ ...ompiler-abstractil-il-iltypedefaccess.html | 148 + ...-compiler-abstractil-il-iltypedefkind.html | 174 + ...ompiler-abstractil-il-iltypedeflayout.html | 148 + ...ler-abstractil-il-iltypedeflayoutinfo.html | 128 + ...arp-compiler-abstractil-il-iltypedefs.html | 173 + ...ompiler-abstractil-il-iltypedefstored.html | 99 + ...arp-compiler-abstractil-il-iltypeinit.html | 135 + ...harp-compiler-abstractil-il-iltyperef.html | 226 + ...fsharp-compiler-abstractil-il-iltypes.html | 194 + ...arp-compiler-abstractil-il-iltypespec.html | 228 + ...harp-compiler-abstractil-il-ilvarargs.html | 170 + ...-compiler-abstractil-il-ilversioninfo.html | 181 + ...p-compiler-abstractil-il-ilvolatility.html | 128 + ...arp-compiler-abstractil-il-methodbody.html | 172 + ...compiler-abstractil-il-methodcodekind.html | 146 + ...arp-compiler-abstractil-il-methodkind.html | 172 + ...bstractil-il-pinvokecallingconvention.html | 187 + ...iler-abstractil-il-pinvokecharbestfit.html | 146 + ...ler-abstractil-il-pinvokecharencoding.html | 159 + ...-compiler-abstractil-il-pinvokemethod.html | 213 + ...actil-il-pinvokethrowonunmappablechar.html | 146 + ...ompiler-abstractil-il-primaryassembly.html | 168 + ...harp-compiler-abstractil-il-publickey.html | 219 + .../fsharp-compiler-abstractil-il.html | 3918 +++++++++++++++++ ...tractil-ilbinaryreader-ilmodulereader.html | 135 + ...binaryreader-ilreadermetadatasnapshot.html | 143 + ...ractil-ilbinaryreader-ilreaderoptions.html | 163 + ...reader-ilreadertrygetmetadatasnapshot.html | 94 + ...actil-ilbinaryreader-metadataonlyflag.html | 133 + ...actil-ilbinaryreader-reducememoryflag.html | 133 + ...naryreader-shim-defaultassemblyreader.html | 99 + ...l-ilbinaryreader-shim-iassemblyreader.html | 116 + ...mpiler-abstractil-ilbinaryreader-shim.html | 149 + ...-abstractil-ilbinaryreader-statistics.html | 172 + ...rp-compiler-abstractil-ilbinaryreader.html | 229 + ...internal-library-anycallerthreadtoken.html | 118 + ...ler-abstractil-internal-library-array.html | 306 ++ ...ractil-internal-library-cancellable-1.html | 119 + ...l-internal-library-cancellablebuilder.html | 241 + ...il-internal-library-cancellablemodule.html | 290 ++ ...ternal-library-compilationthreadtoken.html | 123 + ...bstractil-internal-library-dictionary.html | 117 + ...internal-library-dictionaryextensions.html | 163 + ...tractil-internal-library-eventually-1.html | 145 + ...il-internal-library-eventuallybuilder.html | 228 + ...til-internal-library-eventuallymodule.html | 272 ++ ...actil-internal-library-executiontoken.html | 96 + ...il-internal-library-inlinedelayinit-1.html | 181 + ...al-library-ipartialequalitycomparer-1.html | 120 + ...rnal-library-ipartialequalitycomparer.html | 130 + ...tractil-internal-library-layeredmap-2.html | 144 + ...il-internal-library-layeredmultimap-2.html | 246 ++ ...iler-abstractil-internal-library-lazy.html | 117 + ...il-internal-library-lazywithcontext-2.html | 256 ++ ...ternal-library-lazywithcontextfailure.html | 160 + ...il-internal-library-list-frontandback.html | 118 + ...iler-abstractil-internal-library-list.html | 604 +++ ...er-abstractil-internal-library-lock-1.html | 139 + ...abstractil-internal-library-locktoken.html | 97 + ...piler-abstractil-internal-library-map.html | 117 + ...l-internal-library-memoizationtable-2.html | 139 + ...bstractil-internal-library-multimap-2.html | 144 + ...actil-internal-library-multimapmodule.html | 187 + ...abstractil-internal-library-namemap-1.html | 144 + ...ractil-internal-library-namemapmodule.html | 479 ++ ...actil-internal-library-namemultimap-1.html | 144 + ...l-internal-library-namemultimapmodule.html | 239 + ...er-abstractil-internal-library-option.html | 130 + ...ler-abstractil-internal-library-order.html | 143 + ...stractil-internal-library-resizearray.html | 138 + ...-internal-library-resultorexception-1.html | 128 + ...ernal-library-resultorexceptionmodule.html | 175 + ...ternal-library-shim-defaultfilesystem.html | 116 + ...til-internal-library-shim-ifilesystem.html | 328 ++ ...iler-abstractil-internal-library-shim.html | 185 + ...er-abstractil-internal-library-string.html | 379 ++ ...er-abstractil-internal-library-tables.html | 119 + ...l-internal-library-undefinedexception.html | 94 + ...ternal-library-uniquestampgenerator-1.html | 153 + ...-internal-library-valueoptioninternal.html | 133 + ...l-internal-library-valueorcancelled-1.html | 133 + ...-compiler-abstractil-internal-library.html | 934 ++++ ...rp-compiler-abstractil-internal-utils.html | 116 + .../fsharp-compiler-ast-blockseparator.html | 130 + .../fsharp-compiler-ast-customoperations.html | 126 + .../fsharp-compiler-ast-expratomicflag.html | 134 + .../fsharp-compiler-ast-fsharplib.html | 161 + docs/reference/fsharp-compiler-ast-ident.html | 160 + ...p-compiler-ast-lexbuflocalxmldocstore.html | 99 + .../fsharp-compiler-ast-lexcont.html | 116 + ...compiler-ast-lexerendlinecontinuation.html | 154 + ...arp-compiler-ast-lexerifdefexpression.html | 154 + .../fsharp-compiler-ast-lexerifdefstack.html | 194 + ...p-compiler-ast-lexerifdefstackentries.html | 194 + ...arp-compiler-ast-lexerifdefstackentry.html | 128 + ...piler-ast-lexerwhitespacecontinuation.html | 292 ++ .../fsharp-compiler-ast-longident.html | 194 + ...fsharp-compiler-ast-longidentwithdots.html | 186 + .../fsharp-compiler-ast-memberflags.html | 172 + .../fsharp-compiler-ast-memberkind.html | 191 + ...arp-compiler-ast-parsedfsiinteraction.html | 134 + ...harp-compiler-ast-parsedhashdirective.html | 121 + .../fsharp-compiler-ast-parsedimplfile.html | 121 + ...p-compiler-ast-parsedimplfilefragment.html | 148 + ...harp-compiler-ast-parsedimplfileinput.html | 121 + .../fsharp-compiler-ast-parsedinput.html | 157 + .../fsharp-compiler-ast-parsedsigfile.html | 121 + ...rp-compiler-ast-parsedsigfilefragment.html | 148 + ...sharp-compiler-ast-parsedsigfileinput.html | 121 + .../fsharp-compiler-ast-parserdetail.html | 128 + .../fsharp-compiler-ast-prexmldoc.html | 210 + ...harp-compiler-ast-qualifiednameoffile.html | 177 + .../fsharp-compiler-ast-recordfieldname.html | 130 + .../fsharp-compiler-ast-scopedpragma.html | 120 + .../fsharp-compiler-ast-seqexpronly.html | 119 + ...piler-ast-sequencepointinfoforbinding.html | 188 + ...piler-ast-sequencepointinfoforfinally.html | 128 + ...piler-ast-sequencepointinfoforforloop.html | 128 + ...-compiler-ast-sequencepointinfoforseq.html | 141 + ...mpiler-ast-sequencepointinfofortarget.html | 128 + ...-compiler-ast-sequencepointinfofortry.html | 141 + ...ler-ast-sequencepointinfoforwhileloop.html | 128 + ...compiler-ast-sequencepointinfoforwith.html | 128 + .../fsharp-compiler-ast-synaccess.html | 146 + .../fsharp-compiler-ast-synarginfo.html | 123 + ...harp-compiler-ast-synargnamegenerator.html | 150 + .../fsharp-compiler-ast-synattribute.html | 178 + .../fsharp-compiler-ast-synattributelist.html | 130 + .../fsharp-compiler-ast-synattributes.html | 194 + .../fsharp-compiler-ast-synbinding.html | 171 + .../fsharp-compiler-ast-synbindingkind.html | 149 + ...arp-compiler-ast-synbindingreturninfo.html | 121 + .../fsharp-compiler-ast-syncomponentinfo.html | 149 + .../fsharp-compiler-ast-synconst.html | 451 ++ ...sharp-compiler-ast-synconstructorargs.html | 128 + .../fsharp-compiler-ast-synenumcase.html | 145 + .../fsharp-compiler-ast-synenumcases.html | 194 + .../fsharp-compiler-ast-synexceptiondefn.html | 145 + ...arp-compiler-ast-synexceptiondefnrepr.html | 145 + .../fsharp-compiler-ast-synexceptionsig.html | 121 + .../fsharp-compiler-ast-synexpr.html | 1154 +++++ .../fsharp-compiler-ast-synfield.html | 123 + .../fsharp-compiler-ast-synfields.html | 194 + .../fsharp-compiler-ast-synindexerarg.html | 171 + .../fsharp-compiler-ast-syninfo.html | 458 ++ .../fsharp-compiler-ast-syninterfaceimpl.html | 121 + .../fsharp-compiler-ast-synmatchclause.html | 157 + .../fsharp-compiler-ast-synmeasure.html | 216 + .../fsharp-compiler-ast-synmemberdefn.html | 286 ++ .../fsharp-compiler-ast-synmemberdefns.html | 194 + .../fsharp-compiler-ast-synmembersig.html | 177 + .../fsharp-compiler-ast-synmembersigs.html | 194 + .../fsharp-compiler-ast-synmoduledecl.html | 261 ++ .../fsharp-compiler-ast-synmoduledecls.html | 194 + ...arp-compiler-ast-synmoduleornamespace.html | 143 + ...compiler-ast-synmoduleornamespacekind.html | 181 + ...-compiler-ast-synmoduleornamespacesig.html | 121 + .../fsharp-compiler-ast-synmodulesigdecl.html | 235 + ...fsharp-compiler-ast-synmodulesigdecls.html | 194 + .../reference/fsharp-compiler-ast-synpat.html | 392 ++ .../fsharp-compiler-ast-synrationalconst.html | 150 + .../fsharp-compiler-ast-synreturninfo.html | 120 + .../fsharp-compiler-ast-synsimplepat.html | 159 + ...ler-ast-synsimplepatalternativeidinfo.html | 132 + .../fsharp-compiler-ast-synsimplepats.html | 140 + ...r-ast-synstaticoptimizationconstraint.html | 134 + .../fsharp-compiler-ast-syntaxerror.html | 139 + .../fsharp-compiler-ast-syntypar.html | 143 + .../fsharp-compiler-ast-syntypardecl.html | 123 + .../fsharp-compiler-ast-syntype.html | 383 ++ ...fsharp-compiler-ast-syntypeconstraint.html | 275 ++ .../fsharp-compiler-ast-syntypedefn.html | 143 + .../fsharp-compiler-ast-syntypedefnkind.html | 251 ++ .../fsharp-compiler-ast-syntypedefnrepr.html | 170 + .../fsharp-compiler-ast-syntypedefnsig.html | 125 + ...sharp-compiler-ast-syntypedefnsigrepr.html | 178 + ...rp-compiler-ast-syntypedefnsimplerepr.html | 256 ++ .../fsharp-compiler-ast-synunioncase.html | 145 + .../fsharp-compiler-ast-synunioncases.html | 194 + .../fsharp-compiler-ast-synunioncasetype.html | 141 + .../fsharp-compiler-ast-synvaldata.html | 121 + .../fsharp-compiler-ast-synvalinfo.html | 147 + .../fsharp-compiler-ast-synvalsig.html | 171 + .../fsharp-compiler-ast-synvaltypardecls.html | 123 + .../fsharp-compiler-ast-typarstaticreq.html | 128 + .../reference/fsharp-compiler-ast-xmldoc.html | 188 + .../fsharp-compiler-ast-xmldoccollector.html | 165 + .../fsharp-compiler-ast-xmldocstatics.html | 138 + docs/reference/fsharp-compiler-ast.html | 2136 +++++++++ ...sharp-compiler-errorlogger-buildphase.html | 252 ++ ...ler-errorlogger-buildphasesubcategory.html | 310 ++ ...iler-errorlogger-capturingerrorlogger.html | 151 + ...sharp-compiler-errorlogger-deprecated.html | 128 + .../fsharp-compiler-errorlogger-error.html | 128 + ...harp-compiler-errorlogger-errorlogger.html | 172 + ...ler-errorlogger-errorloggerextensions.html | 258 ++ ...sharp-compiler-errorlogger-errorstyle.html | 174 + ...iler-errorlogger-errorwithsuggestions.html | 154 + .../fsharp-compiler-errorlogger-exiter.html | 116 + ...arp-compiler-errorlogger-experimental.html | 128 + ...rrorlogger-fsharperrorseverityoptions.html | 202 + ...errorlogger-imperativeoperationresult.html | 94 + ...rp-compiler-errorlogger-internalerror.html | 128 + ...p-compiler-errorlogger-libraryuseonly.html | 115 + ...rp-compiler-errorlogger-numberederror.html | 128 + ...ompiler-errorlogger-operationresult-1.html | 134 + ...-compiler-errorlogger-operationresult.html | 122 + ...compiler-errorlogger-phaseddiagnostic.html | 229 + ...-errorlogger-possibleunverifiablecode.html | 115 + ...rp-compiler-errorlogger-reportederror.html | 122 + ...ompiler-errorlogger-stopprocessingexn.html | 117 + ...harp-compiler-errorlogger-suggestions.html | 94 + ...mpiler-errorlogger-trackerrorsbuilder.html | 241 + ...r-errorlogger-unresolvedpathreference.html | 141 + ...logger-unresolvedpathreferencenorange.html | 128 + ...-errorlogger-unresolvedreferenceerror.html | 128 + ...rrorlogger-unresolvedreferencenorange.html | 115 + ...piler-errorlogger-usercompilermessage.html | 141 + ...arp-compiler-errorlogger-wrappederror.html | 130 + .../fsharp-compiler-errorlogger.html | 1144 +++++ ...interactive-shell-compilerinputstream.html | 146 + ...nteractive-shell-compileroutputstream.html | 144 + ...interactive-shell-evaluationeventargs.html | 187 + ...ractive-shell-fsicompilationexception.html | 145 + ...nteractive-shell-fsievaluationsession.html | 702 +++ ...-shell-fsievaluationsessionhostconfig.html | 440 ++ ...p-compiler-interactive-shell-fsivalue.html | 141 + ...interactive-shell-settings-ieventloop.html | 153 + ...ve-shell-settings-interactivesettings.html | 499 +++ ...p-compiler-interactive-shell-settings.html | 156 + .../fsharp-compiler-interactive-shell.html | 189 + .../fsharp-compiler-layout-layout.html | 94 + ...harp-compiler-layout-layoutrenderer-2.html | 174 + .../fsharp-compiler-layout-layouttag.html | 94 + .../fsharp-compiler-layout-leftl.html | 195 + ...p-compiler-layout-navigabletaggedtext.html | 138 + .../fsharp-compiler-layout-noresult.html | 115 + .../fsharp-compiler-layout-nostate.html | 115 + .../fsharp-compiler-layout-rightl.html | 195 + .../fsharp-compiler-layout-sepl.html | 247 ++ .../fsharp-compiler-layout-taggedtext.html | 132 + ...ompiler-layout-taggedtextops-literals.html | 390 ++ .../fsharp-compiler-layout-taggedtextops.html | 552 +++ .../fsharp-compiler-layout-wordl.html | 468 ++ docs/reference/fsharp-compiler-layout.html | 687 +++ ...fsharp-compiler-logcompilerfunctionid.html | 171 + .../fsharp-compiler-nicenamegenerator.html | 156 + .../fsharp-compiler-partiallongname.html | 186 + ...mpiler-prettynaming-activepatterninfo.html | 179 + ...-prettynaming-invalidmangledstaticarg.html | 115 + ...p-compiler-prettynaming-namearitypair.html | 115 + .../fsharp-compiler-prettynaming.html | 835 ++++ .../reference/fsharp-compiler-quickparse.html | 223 + .../fsharp-compiler-range-fileindex.html | 96 + .../reference/fsharp-compiler-range-line.html | 134 + .../fsharp-compiler-range-line0.html | 96 + .../fsharp-compiler-range-pos-0.html | 134 + docs/reference/fsharp-compiler-range-pos.html | 198 + .../fsharp-compiler-range-pos01.html | 130 + .../fsharp-compiler-range-range-0.html | 134 + .../fsharp-compiler-range-range.html | 343 ++ .../fsharp-compiler-range-range01.html | 130 + docs/reference/fsharp-compiler-range.html | 632 +++ ...ferenceresolver-resolutionenvironment.html | 137 + ...mpiler-referenceresolver-resolvedfile.html | 147 + ...p-compiler-referenceresolver-resolver.html | 162 + .../fsharp-compiler-referenceresolver.html | 130 + ...ecodeservices-assemblycontentprovider.html | 135 + ...ourcecodeservices-assemblycontenttype.html | 133 + ...piler-sourcecodeservices-assemblypath.html | 129 + ...ler-sourcecodeservices-assemblysymbol.html | 244 + ...ervices-asttraversal-astvisitorbase-1.html | 390 ++ ...odeservices-asttraversal-traversepath.html | 194 + ...odeservices-asttraversal-traversestep.html | 200 + ...piler-sourcecodeservices-asttraversal.html | 222 + ...iler-sourcecodeservices-basicpatterns.html | 829 ++++ ...ourcecodeservices-compilerenvironment.html | 123 + ...odeservices-compilerenvironmentmodule.html | 156 + ...-sourcecodeservices-completioncontext.html | 221 + ...sourcecodeservices-completionitemkind.html | 197 + ...ler-sourcecodeservices-completionpath.html | 127 + ...ourcecodeservices-debuggerenvironment.html | 121 + ...rp-compiler-sourcecodeservices-entity.html | 178 + ...mpiler-sourcecodeservices-entitycache.html | 155 + ...ompiler-sourcecodeservices-entitykind.html | 158 + ...ompiler-sourcecodeservices-extensions.html | 300 ++ ...ler-sourcecodeservices-externalsymbol.html | 186 + ...piler-sourcecodeservices-externaltype.html | 168 + ...sourcecodeservices-externaltypemodule.html | 95 + ...ecodeservices-fsharpabstractparameter.html | 204 + ...ecodeservices-fsharpabstractsignature.html | 204 + ...ourcecodeservices-fsharpaccessibility.html | 167 + ...odeservices-fsharpaccessibilityrights.html | 100 + ...ecodeservices-fsharpactivepatterncase.html | 204 + ...codeservices-fsharpactivepatterngroup.html | 188 + ...eservices-fsharpanonrecordtypedetails.html | 172 + ...ler-sourcecodeservices-fsharpassembly.html | 210 + ...cecodeservices-fsharpassemblycontents.html | 119 + ...ecodeservices-fsharpassemblysignature.html | 156 + ...er-sourcecodeservices-fsharpattribute.html | 187 + ...iler-sourcecodeservices-fsharpchecker.html | 888 ++++ ...rcecodeservices-fsharpcheckfileanswer.html | 138 + ...cecodeservices-fsharpcheckfileresults.html | 472 ++ ...odeservices-fsharpcheckprojectresults.html | 251 ++ ...odeservices-fsharpdeclarationlistinfo.html | 173 + ...odeservices-fsharpdeclarationlistitem.html | 315 ++ ...ecodeservices-fsharpdelegatesignature.html | 140 + ...urcecodeservices-fsharpdisplaycontext.html | 146 + ...odeservices-fsharpenclosingentitykind.html | 210 + ...piler-sourcecodeservices-fsharpentity.html | 1021 +++++ ...er-sourcecodeservices-fsharperrorinfo.html | 232 + ...ourcecodeservices-fsharperrorseverity.html | 132 + ...ompiler-sourcecodeservices-fsharpexpr.html | 159 + ...mpiler-sourcecodeservices-fsharpfield.html | 429 ++ ...ourcecodeservices-fsharpfileutilities.html | 118 + ...eservices-fsharpfinddeclfailurereason.html | 168 + ...urcecodeservices-fsharpfinddeclresult.html | 153 + ...cecodeservices-fsharpgenericparameter.html | 236 + ...ices-fsharpgenericparameterconstraint.html | 414 ++ ...pgenericparameterdefaultstoconstraint.html | 142 + ...arpgenericparameterdelegateconstraint.html | 142 + ...sharpgenericparametermemberconstraint.html | 190 + ...mpiler-sourcecodeservices-fsharpglyph.html | 379 ++ ...ices-fsharpimplementationfilecontents.html | 188 + ...s-fsharpimplementationfiledeclaration.html | 148 + ...cecodeservices-fsharpinlineannotation.html | 181 + ...ourcecodeservices-fsharplinetokenizer.html | 162 + ...ervices-fsharpmemberorfunctionorvalue.html | 1045 +++++ ...-sourcecodeservices-fsharpmethodgroup.html | 140 + ...rcecodeservices-fsharpmethodgroupitem.html | 253 ++ ...rvices-fsharpmethodgroupitemparameter.html | 190 + ...r-sourcecodeservices-fsharpnavigation.html | 116 + ...vices-fsharpnavigationdeclarationitem.html | 248 ++ ...s-fsharpnavigationdeclarationitemkind.html | 220 + ...rcecodeservices-fsharpnavigationitems.html | 124 + ...s-fsharpnavigationtopleveldeclaration.html | 136 + ...es-fsharpnoteworthyparaminfolocations.html | 243 + ...codeservices-fsharpobjectexproverride.html | 172 + ...rcecodeservices-fsharpopendeclaration.html | 188 + ...er-sourcecodeservices-fsharpparameter.html | 236 + ...cecodeservices-fsharpparsefileresults.html | 233 + ...urcecodeservices-fsharpparsingoptions.html | 216 + ...urcecodeservices-fsharpprojectcontext.html | 139 + ...urcecodeservices-fsharpprojectoptions.html | 288 ++ ...rcecodeservices-fsharpsourcetokenizer.html | 156 + ...rcecodeservices-fsharpstaticparameter.html | 210 + ...rvices-fsharpstructuredtooltipelement.html | 95 + ...eservices-fsharpstructuredtooltiptext.html | 93 + ...piler-sourcecodeservices-fsharpsymbol.html | 293 ++ ...er-sourcecodeservices-fsharpsymboluse.html | 301 ++ ...ourcecodeservices-fsharptokencharkind.html | 257 ++ ...urcecodeservices-fsharptokencolorkind.html | 271 ++ ...er-sourcecodeservices-fsharptokeninfo.html | 221 + ...odeservices-fsharptokenizercolorstate.html | 299 ++ ...ecodeservices-fsharptokenizerlexstate.html | 179 + ...ler-sourcecodeservices-fsharptokentag.html | 1005 +++++ ...ecodeservices-fsharptokentriggerclass.html | 215 + ...cecodeservices-fsharptooltipelement-1.html | 172 + ...urcecodeservices-fsharptooltipelement.html | 95 + ...deservices-fsharptooltipelementdata-1.html | 179 + ...ourcecodeservices-fsharptooltiptext-1.html | 118 + ...-sourcecodeservices-fsharptooltiptext.html | 93 + ...ompiler-sourcecodeservices-fsharptype.html | 541 +++ ...er-sourcecodeservices-fsharpunioncase.html | 284 ++ ...piler-sourcecodeservices-fsharpxmldoc.html | 153 + ...rcecodeservices-iassemblycontentcache.html | 141 + ...rp-compiler-sourcecodeservices-idents.html | 95 + ...sourcecodeservices-inheritancecontext.html | 145 + ...iler-sourcecodeservices-insertcontext.html | 133 + ...iler-sourcecodeservices-interfacedata.html | 172 + ...cecodeservices-interfacestubgenerator.html | 208 + ...-compiler-sourcecodeservices-keywords.html | 163 + ...rp-compiler-sourcecodeservices-layout.html | 93 + ...ompiler-sourcecodeservices-lookuptype.html | 134 + ...urcecodeservices-maybeunresolvedident.html | 129 + ...rcecodeservices-maybeunresolvedidents.html | 95 + ...ompiler-sourcecodeservices-modulekind.html | 127 + ...urcecodeservices-navigateto-container.html | 128 + ...codeservices-navigateto-containertype.html | 172 + ...codeservices-navigateto-navigableitem.html | 167 + ...services-navigateto-navigableitemkind.html | 250 ++ ...ompiler-sourcecodeservices-navigateto.html | 159 + ...eservices-openstatementinsertionpoint.html | 129 + ...er-sourcecodeservices-paramtypesymbol.html | 134 + ...rcecodeservices-paramtypesymbolmodule.html | 95 + ...mpiler-sourcecodeservices-parsedinput.html | 165 + ...-compiler-sourcecodeservices-position.html | 127 + ...piler-sourcecodeservices-prettynaming.html | 200 + ...arp-compiler-sourcecodeservices-range.html | 127 + ...iler-sourcecodeservices-recordcontext.html | 145 + ...compiler-sourcecodeservices-scopekind.html | 168 + ...deservices-semanticclassificationtype.html | 301 ++ ...ompiler-sourcecodeservices-shortident.html | 129 + ...vices-simplifynames-simplifiablerange.html | 134 + ...iler-sourcecodeservices-simplifynames.html | 139 + ...ompiler-sourcecodeservices-sourcefile.html | 135 + ...er-sourcecodeservices-stringlongident.html | 129 + ...sourcecodeservices-structure-collapse.html | 137 + ...er-sourcecodeservices-structure-scope.html | 720 +++ ...urcecodeservices-structure-scoperange.html | 166 + ...compiler-sourcecodeservices-structure.html | 162 + ...rp-compiler-sourcecodeservices-symbol.html | 712 +++ ...-compiler-sourcecodeservices-tooltips.html | 142 + ...ecodeservices-unresolvedreferencesset.html | 95 + ...r-sourcecodeservices-unresolvedsymbol.html | 140 + ...r-sourcecodeservices-untypedparseimpl.html | 181 + ...sourcecodeservices-unuseddeclarations.html | 118 + ...mpiler-sourcecodeservices-unusedopens.html | 118 + ...ompiler-sourcecodeservices-xmldocable.html | 116 + ...iler-sourcecodeservices-xmldoccomment.html | 118 + ...piler-sourcecodeservices-xmldocparser.html | 118 + ...harp-compiler-stablenicenamegenerator.html | 155 + .../fsharp-compiler-text-isourcetext.html | 229 + .../fsharp-compiler-text-sourcetext.html | 116 + docs/reference/index.html | 1804 ++++++++ .../reference/internal-utilities-pathmap.html | 93 + ...al-utilities-structuredformat-display.html | 253 ++ ...lities-structuredformat-formatoptions.html | 303 ++ ...ilities-structuredformat-ienvironment.html | 155 + ...rnal-utilities-structuredformat-joint.html | 149 + ...nal-utilities-structuredformat-layout.html | 162 + ...-utilities-structuredformat-layoutops.html | 541 +++ ...-utilities-structuredformat-layouttag.html | 536 +++ ...utilities-structuredformat-taggedtext.html | 131 + ...ructuredformat-taggedtextops-literals.html | 299 ++ ...lities-structuredformat-taggedtextops.html | 499 +++ ...ies-structuredformat-taggedtextwriter.html | 129 + .../.idea.FSharp.Compiler.Service/.idea/.name | 1 + fcs/docsrc/tools/generate.fsx | 57 +- fcs/paket.dependencies | 5 +- fcs/paket.lock | 42 +- 537 files changed, 113894 insertions(+), 4722 deletions(-) delete mode 100644 docs/fsharp-readme.html delete mode 100644 docs/ja/compiler.html delete mode 100644 docs/ja/corelib.html delete mode 100644 docs/ja/devnotes.html delete mode 100644 docs/ja/editor.html delete mode 100644 docs/ja/filesystem.html delete mode 100644 docs/ja/fsharp-readme.html delete mode 100644 docs/ja/index.html delete mode 100644 docs/ja/interactive.html delete mode 100644 docs/ja/project.html delete mode 100644 docs/ja/symbols.html delete mode 100644 docs/ja/tokenizer.html delete mode 100644 docs/ja/untypedtree.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilalignment.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilargconvention.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilarraybound.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilarraybounds.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilarrayshape.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilassemblylongevity.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilassemblymanifest.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilassemblyref.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattribelem.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattribute.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattributenamedarg.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattributes.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilattributesstored.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilbasictype.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilboxity.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcallingconv.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcallingsignature.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcode.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcodelabel.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilcomparisoninstr.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilconst.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ildefaultpinvokeencoding.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilenuminfo.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ileventdef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ileventdefs.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ileventref.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilexceptionclause.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilexceptionspec.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilexportedtypeorforwarder.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilexportedtypesandforwarders.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfielddef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfielddefs.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfieldinit.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfieldref.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilfieldspec.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericargs.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericargslist.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdefs.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilgenericvariance.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilglobals.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilguid.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilinstr.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-illazymethodbody.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocal.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocaldebuginfo.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocaldebugmapping.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocals.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-illocalsallocator.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmemberaccess.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodbody.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethoddef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethoddefs.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldefs.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodref.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodspec.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmethodvirtualinfo.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmoduledef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilmoduleref.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnativeresource.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnativetype.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnativevariant.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtype.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtypes.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iloverridesspec.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilparameter.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilparameters.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilplatform.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilpretypedef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilpretypedefimpl.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilpropertydef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilpropertydefs.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilpropertyref.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilreadonly.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilreferences.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilresource.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilresourceaccess.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilresourcelocation.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilresources.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilreturn.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilscoperef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsecurityaction.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecl.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecls.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsecuritydeclsstored.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsourcedocument.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilsourcemarker.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltailcall.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilthisconvention.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltoken.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltype.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedefaccess.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedefkind.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedeflayout.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedeflayoutinfo.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedefs.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypedefstored.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypeinit.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltyperef.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypes.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-iltypespec.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilvarargs.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilversioninfo.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-ilvolatility.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-methodbody.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-methodcodekind.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-methodkind.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokecallingconvention.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokecharbestfit.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokecharencoding.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokemethod.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-pinvokethrowonunmappablechar.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-primaryassembly.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il-publickey.html create mode 100644 docs/reference/fsharp-compiler-abstractil-il.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilmodulereader.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadermetadatasnapshot.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreaderoptions.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadertrygetmetadatasnapshot.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-metadataonlyflag.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-reducememoryflag.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-defaultassemblyreader.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-iassemblyreader.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader-statistics.html create mode 100644 docs/reference/fsharp-compiler-abstractil-ilbinaryreader.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-anycallerthreadtoken.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-array.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-cancellable-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-cancellablebuilder.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-cancellablemodule.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-compilationthreadtoken.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-dictionary.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-dictionaryextensions.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-eventually-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-eventuallybuilder.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-eventuallymodule.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-executiontoken.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-inlinedelayinit-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-layeredmap-2.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-layeredmultimap-2.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-lazy.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontext-2.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontextfailure.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-list-frontandback.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-list.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-lock-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-locktoken.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-map.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-memoizationtable-2.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-multimap-2.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-multimapmodule.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-namemap-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-namemapmodule.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-namemultimap-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-namemultimapmodule.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-option.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-order.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-resizearray.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-resultorexception-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-resultorexceptionmodule.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-shim-defaultfilesystem.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-shim-ifilesystem.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-shim.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-string.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-tables.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-undefinedexception.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-uniquestampgenerator-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-valueoptioninternal.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library-valueorcancelled-1.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-library.html create mode 100644 docs/reference/fsharp-compiler-abstractil-internal-utils.html create mode 100644 docs/reference/fsharp-compiler-ast-blockseparator.html create mode 100644 docs/reference/fsharp-compiler-ast-customoperations.html create mode 100644 docs/reference/fsharp-compiler-ast-expratomicflag.html create mode 100644 docs/reference/fsharp-compiler-ast-fsharplib.html create mode 100644 docs/reference/fsharp-compiler-ast-ident.html create mode 100644 docs/reference/fsharp-compiler-ast-lexbuflocalxmldocstore.html create mode 100644 docs/reference/fsharp-compiler-ast-lexcont.html create mode 100644 docs/reference/fsharp-compiler-ast-lexerendlinecontinuation.html create mode 100644 docs/reference/fsharp-compiler-ast-lexerifdefexpression.html create mode 100644 docs/reference/fsharp-compiler-ast-lexerifdefstack.html create mode 100644 docs/reference/fsharp-compiler-ast-lexerifdefstackentries.html create mode 100644 docs/reference/fsharp-compiler-ast-lexerifdefstackentry.html create mode 100644 docs/reference/fsharp-compiler-ast-lexerwhitespacecontinuation.html create mode 100644 docs/reference/fsharp-compiler-ast-longident.html create mode 100644 docs/reference/fsharp-compiler-ast-longidentwithdots.html create mode 100644 docs/reference/fsharp-compiler-ast-memberflags.html create mode 100644 docs/reference/fsharp-compiler-ast-memberkind.html create mode 100644 docs/reference/fsharp-compiler-ast-parsedfsiinteraction.html create mode 100644 docs/reference/fsharp-compiler-ast-parsedhashdirective.html create mode 100644 docs/reference/fsharp-compiler-ast-parsedimplfile.html create mode 100644 docs/reference/fsharp-compiler-ast-parsedimplfilefragment.html create mode 100644 docs/reference/fsharp-compiler-ast-parsedimplfileinput.html create mode 100644 docs/reference/fsharp-compiler-ast-parsedinput.html create mode 100644 docs/reference/fsharp-compiler-ast-parsedsigfile.html create mode 100644 docs/reference/fsharp-compiler-ast-parsedsigfilefragment.html create mode 100644 docs/reference/fsharp-compiler-ast-parsedsigfileinput.html create mode 100644 docs/reference/fsharp-compiler-ast-parserdetail.html create mode 100644 docs/reference/fsharp-compiler-ast-prexmldoc.html create mode 100644 docs/reference/fsharp-compiler-ast-qualifiednameoffile.html create mode 100644 docs/reference/fsharp-compiler-ast-recordfieldname.html create mode 100644 docs/reference/fsharp-compiler-ast-scopedpragma.html create mode 100644 docs/reference/fsharp-compiler-ast-seqexpronly.html create mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforbinding.html create mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforfinally.html create mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforforloop.html create mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforseq.html create mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfofortarget.html create mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfofortry.html create mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforwhileloop.html create mode 100644 docs/reference/fsharp-compiler-ast-sequencepointinfoforwith.html create mode 100644 docs/reference/fsharp-compiler-ast-synaccess.html create mode 100644 docs/reference/fsharp-compiler-ast-synarginfo.html create mode 100644 docs/reference/fsharp-compiler-ast-synargnamegenerator.html create mode 100644 docs/reference/fsharp-compiler-ast-synattribute.html create mode 100644 docs/reference/fsharp-compiler-ast-synattributelist.html create mode 100644 docs/reference/fsharp-compiler-ast-synattributes.html create mode 100644 docs/reference/fsharp-compiler-ast-synbinding.html create mode 100644 docs/reference/fsharp-compiler-ast-synbindingkind.html create mode 100644 docs/reference/fsharp-compiler-ast-synbindingreturninfo.html create mode 100644 docs/reference/fsharp-compiler-ast-syncomponentinfo.html create mode 100644 docs/reference/fsharp-compiler-ast-synconst.html create mode 100644 docs/reference/fsharp-compiler-ast-synconstructorargs.html create mode 100644 docs/reference/fsharp-compiler-ast-synenumcase.html create mode 100644 docs/reference/fsharp-compiler-ast-synenumcases.html create mode 100644 docs/reference/fsharp-compiler-ast-synexceptiondefn.html create mode 100644 docs/reference/fsharp-compiler-ast-synexceptiondefnrepr.html create mode 100644 docs/reference/fsharp-compiler-ast-synexceptionsig.html create mode 100644 docs/reference/fsharp-compiler-ast-synexpr.html create mode 100644 docs/reference/fsharp-compiler-ast-synfield.html create mode 100644 docs/reference/fsharp-compiler-ast-synfields.html create mode 100644 docs/reference/fsharp-compiler-ast-synindexerarg.html create mode 100644 docs/reference/fsharp-compiler-ast-syninfo.html create mode 100644 docs/reference/fsharp-compiler-ast-syninterfaceimpl.html create mode 100644 docs/reference/fsharp-compiler-ast-synmatchclause.html create mode 100644 docs/reference/fsharp-compiler-ast-synmeasure.html create mode 100644 docs/reference/fsharp-compiler-ast-synmemberdefn.html create mode 100644 docs/reference/fsharp-compiler-ast-synmemberdefns.html create mode 100644 docs/reference/fsharp-compiler-ast-synmembersig.html create mode 100644 docs/reference/fsharp-compiler-ast-synmembersigs.html create mode 100644 docs/reference/fsharp-compiler-ast-synmoduledecl.html create mode 100644 docs/reference/fsharp-compiler-ast-synmoduledecls.html create mode 100644 docs/reference/fsharp-compiler-ast-synmoduleornamespace.html create mode 100644 docs/reference/fsharp-compiler-ast-synmoduleornamespacekind.html create mode 100644 docs/reference/fsharp-compiler-ast-synmoduleornamespacesig.html create mode 100644 docs/reference/fsharp-compiler-ast-synmodulesigdecl.html create mode 100644 docs/reference/fsharp-compiler-ast-synmodulesigdecls.html create mode 100644 docs/reference/fsharp-compiler-ast-synpat.html create mode 100644 docs/reference/fsharp-compiler-ast-synrationalconst.html create mode 100644 docs/reference/fsharp-compiler-ast-synreturninfo.html create mode 100644 docs/reference/fsharp-compiler-ast-synsimplepat.html create mode 100644 docs/reference/fsharp-compiler-ast-synsimplepatalternativeidinfo.html create mode 100644 docs/reference/fsharp-compiler-ast-synsimplepats.html create mode 100644 docs/reference/fsharp-compiler-ast-synstaticoptimizationconstraint.html create mode 100644 docs/reference/fsharp-compiler-ast-syntaxerror.html create mode 100644 docs/reference/fsharp-compiler-ast-syntypar.html create mode 100644 docs/reference/fsharp-compiler-ast-syntypardecl.html create mode 100644 docs/reference/fsharp-compiler-ast-syntype.html create mode 100644 docs/reference/fsharp-compiler-ast-syntypeconstraint.html create mode 100644 docs/reference/fsharp-compiler-ast-syntypedefn.html create mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnkind.html create mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnrepr.html create mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnsig.html create mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnsigrepr.html create mode 100644 docs/reference/fsharp-compiler-ast-syntypedefnsimplerepr.html create mode 100644 docs/reference/fsharp-compiler-ast-synunioncase.html create mode 100644 docs/reference/fsharp-compiler-ast-synunioncases.html create mode 100644 docs/reference/fsharp-compiler-ast-synunioncasetype.html create mode 100644 docs/reference/fsharp-compiler-ast-synvaldata.html create mode 100644 docs/reference/fsharp-compiler-ast-synvalinfo.html create mode 100644 docs/reference/fsharp-compiler-ast-synvalsig.html create mode 100644 docs/reference/fsharp-compiler-ast-synvaltypardecls.html create mode 100644 docs/reference/fsharp-compiler-ast-typarstaticreq.html create mode 100644 docs/reference/fsharp-compiler-ast-xmldoc.html create mode 100644 docs/reference/fsharp-compiler-ast-xmldoccollector.html create mode 100644 docs/reference/fsharp-compiler-ast-xmldocstatics.html create mode 100644 docs/reference/fsharp-compiler-ast.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-buildphase.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-buildphasesubcategory.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-capturingerrorlogger.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-deprecated.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-error.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-errorlogger.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-errorloggerextensions.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-errorstyle.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-errorwithsuggestions.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-exiter.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-experimental.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-fsharperrorseverityoptions.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-imperativeoperationresult.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-internalerror.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-libraryuseonly.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-numberederror.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-operationresult-1.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-operationresult.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-phaseddiagnostic.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-possibleunverifiablecode.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-reportederror.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-stopprocessingexn.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-suggestions.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-trackerrorsbuilder.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-unresolvedpathreference.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-unresolvedpathreferencenorange.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-unresolvedreferenceerror.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-unresolvedreferencenorange.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-usercompilermessage.html create mode 100644 docs/reference/fsharp-compiler-errorlogger-wrappederror.html create mode 100644 docs/reference/fsharp-compiler-errorlogger.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-compilerinputstream.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-compileroutputstream.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-evaluationeventargs.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-fsicompilationexception.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-fsievaluationsession.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-fsivalue.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-settings-ieventloop.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-settings-interactivesettings.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell-settings.html create mode 100644 docs/reference/fsharp-compiler-interactive-shell.html create mode 100644 docs/reference/fsharp-compiler-layout-layout.html create mode 100644 docs/reference/fsharp-compiler-layout-layoutrenderer-2.html create mode 100644 docs/reference/fsharp-compiler-layout-layouttag.html create mode 100644 docs/reference/fsharp-compiler-layout-leftl.html create mode 100644 docs/reference/fsharp-compiler-layout-navigabletaggedtext.html create mode 100644 docs/reference/fsharp-compiler-layout-noresult.html create mode 100644 docs/reference/fsharp-compiler-layout-nostate.html create mode 100644 docs/reference/fsharp-compiler-layout-rightl.html create mode 100644 docs/reference/fsharp-compiler-layout-sepl.html create mode 100644 docs/reference/fsharp-compiler-layout-taggedtext.html create mode 100644 docs/reference/fsharp-compiler-layout-taggedtextops-literals.html create mode 100644 docs/reference/fsharp-compiler-layout-taggedtextops.html create mode 100644 docs/reference/fsharp-compiler-layout-wordl.html create mode 100644 docs/reference/fsharp-compiler-layout.html create mode 100644 docs/reference/fsharp-compiler-logcompilerfunctionid.html create mode 100644 docs/reference/fsharp-compiler-nicenamegenerator.html create mode 100644 docs/reference/fsharp-compiler-partiallongname.html create mode 100644 docs/reference/fsharp-compiler-prettynaming-activepatterninfo.html create mode 100644 docs/reference/fsharp-compiler-prettynaming-invalidmangledstaticarg.html create mode 100644 docs/reference/fsharp-compiler-prettynaming-namearitypair.html create mode 100644 docs/reference/fsharp-compiler-prettynaming.html create mode 100644 docs/reference/fsharp-compiler-quickparse.html create mode 100644 docs/reference/fsharp-compiler-range-fileindex.html create mode 100644 docs/reference/fsharp-compiler-range-line.html create mode 100644 docs/reference/fsharp-compiler-range-line0.html create mode 100644 docs/reference/fsharp-compiler-range-pos-0.html create mode 100644 docs/reference/fsharp-compiler-range-pos.html create mode 100644 docs/reference/fsharp-compiler-range-pos01.html create mode 100644 docs/reference/fsharp-compiler-range-range-0.html create mode 100644 docs/reference/fsharp-compiler-range-range.html create mode 100644 docs/reference/fsharp-compiler-range-range01.html create mode 100644 docs/reference/fsharp-compiler-range.html create mode 100644 docs/reference/fsharp-compiler-referenceresolver-resolutionenvironment.html create mode 100644 docs/reference/fsharp-compiler-referenceresolver-resolvedfile.html create mode 100644 docs/reference/fsharp-compiler-referenceresolver-resolver.html create mode 100644 docs/reference/fsharp-compiler-referenceresolver.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-assemblycontentprovider.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-assemblycontenttype.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-assemblypath.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-assemblysymbol.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-astvisitorbase-1.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversepath.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversestep.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-asttraversal.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-basicpatterns.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironment.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-completioncontext.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-completionitemkind.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-completionpath.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-debuggerenvironment.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-entity.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-entitycache.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-entitykind.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-extensions.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-externalsymbol.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-externaltype.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-externaltypemodule.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractparameter.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractsignature.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibility.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibilityrights.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterncase.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterngroup.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpanonrecordtypedetails.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpassembly.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblycontents.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblysignature.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpattribute.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpchecker.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistinfo.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistitem.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpdelegatesignature.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpdisplaycontext.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpenclosingentitykind.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpentity.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorinfo.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorseverity.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpexpr.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpfield.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpfileutilities.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameter.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterconstraint.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdefaultstoconstraint.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdelegateconstraint.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparametermemberconstraint.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpglyph.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfilecontents.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfiledeclaration.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpinlineannotation.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharplinetokenizer.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpmemberorfunctionorvalue.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroup.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitem.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitemparameter.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigation.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitem.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitemkind.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationitems.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationtopleveldeclaration.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpnoteworthyparaminfolocations.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpobjectexproverride.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpopendeclaration.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpparameter.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsefileresults.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpsourcetokenizer.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpstaticparameter.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltipelement.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltiptext.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymbol.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymboluse.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencharkind.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencolorkind.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokeninfo.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizercolorstate.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizerlexstate.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentag.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentriggerclass.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement-1.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelementdata-1.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext-1.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharptype.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpunioncase.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-fsharpxmldoc.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-iassemblycontentcache.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-idents.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-inheritancecontext.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-insertcontext.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-interfacedata.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-interfacestubgenerator.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-keywords.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-layout.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-lookuptype.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedident.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedidents.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-modulekind.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto-container.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto-containertype.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitem.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitemkind.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-navigateto.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-openstatementinsertionpoint.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbol.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbolmodule.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-parsedinput.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-position.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-prettynaming.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-range.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-recordcontext.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-scopekind.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-semanticclassificationtype.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-shortident.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-simplifynames-simplifiablerange.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-simplifynames.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-sourcefile.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-stringlongident.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-structure-collapse.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-structure-scope.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-structure-scoperange.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-structure.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-symbol.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-tooltips.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-unresolvedsymbol.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-untypedparseimpl.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-unuseddeclarations.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-unusedopens.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-xmldocable.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-xmldoccomment.html create mode 100644 docs/reference/fsharp-compiler-sourcecodeservices-xmldocparser.html create mode 100644 docs/reference/fsharp-compiler-stablenicenamegenerator.html create mode 100644 docs/reference/fsharp-compiler-text-isourcetext.html create mode 100644 docs/reference/fsharp-compiler-text-sourcetext.html create mode 100644 docs/reference/index.html create mode 100644 docs/reference/internal-utilities-pathmap.html create mode 100644 docs/reference/internal-utilities-structuredformat-display.html create mode 100644 docs/reference/internal-utilities-structuredformat-formatoptions.html create mode 100644 docs/reference/internal-utilities-structuredformat-ienvironment.html create mode 100644 docs/reference/internal-utilities-structuredformat-joint.html create mode 100644 docs/reference/internal-utilities-structuredformat-layout.html create mode 100644 docs/reference/internal-utilities-structuredformat-layoutops.html create mode 100644 docs/reference/internal-utilities-structuredformat-layouttag.html create mode 100644 docs/reference/internal-utilities-structuredformat-taggedtext.html create mode 100644 docs/reference/internal-utilities-structuredformat-taggedtextops-literals.html create mode 100644 docs/reference/internal-utilities-structuredformat-taggedtextops.html create mode 100644 docs/reference/internal-utilities-structuredformat-taggedtextwriter.html create mode 100644 fcs/.idea/.idea.FSharp.Compiler.Service/.idea/.name diff --git a/docs/fsharp-readme.html b/docs/fsharp-readme.html deleted file mode 100644 index 0e3a74fa2e..0000000000 --- a/docs/fsharp-readme.html +++ /dev/null @@ -1,309 +0,0 @@ - - - - - F# Compiler README - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    F# Compiler README

    -
    -

    NOTE: This readme file is the original README.md document from the F# compiler -source code (github.com/fsharp/fsharp). This project is a fork of the F# compiler -source, with several minor changes that expose certain services. The readme is included -here for reference.

    -
    -

    This is the F# compiler, core library and core tools (open source edition). -The master branch is for the latest version of F# (currently F# 3.0). -To bootstrap the compiler, binaries built from an earlier version of this project are used.

    -

    Requirements

    -

    Requires mono 2.9 or higher. Prefer Mono 3.0.

    -

    On OSX, requires automake 2.69. To install from homebrew:

    - -
    1: 
-
    brew install automake
-
    -

    Building

    -

    On Linux and other Unix systems:

    -

    The usual:

    - -
    1: 
-2: 
-3: 
-
    ./autogen.sh
-make
-sudo make install
-
    -

    By default that makes optimized binaries. To make debug, use make CONFIG=debug

    -

    On MacOS (OSX)

    -

    Use a prefix to your version of Mono:

    - -
    1: 
-2: 
-3: 
-
    ./autogen.sh --prefix=/Library/Frameworks/Mono.framework/Versions/Current/
-make
-sudo make install
-
    -

    By default that makes optimized binaries. To make debug, use make CONFIG=debug

    -

    On Windows, using msbuild (e.g.. if .NET is installed)

    -

    If you have only VS2012 installed, and not VS2010, you'll need to install the F# 2.0 Runtime (http://www.microsoft.com/en-us/download/details.aspx?id=13450)

    - -
    1: 
-2: 
-3: 
-4: 
-5: 
-
    cd src
-msbuild fsharp-proto-build.proj
-ngen install ..\lib\proto\4.0\fsc-proto.exe (optional)
-msbuild fsharp-library-build.proj /p:Configuration=Release
-msbuild fsharp-compiler-build.proj /p:Configuration=Release
-
    -

    You can also build the FSharp.Core for .NET 2.0, Mono 2.1, MonoTouch, Silverlight 5.0, Windows Phone 7.1, Portable Profile47 (net45+sl5+win8), Portable Profile88 (net4+sl4+wp71+win8) and XNA 4.0 for Xbox 360 profiles:

    - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-
    msbuild fsharp-library-build.proj /p:TargetFramework=net20 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=mono21 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=monotouch /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=portable-net45+sl5+win8 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=portable-net4+sl4+wp71+win8 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=sl5 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=wp7 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=net40-xna40-xbox360 /p:Configuration=Release
-
    -

    You can also build the FSharp.Core and FSharp.Compiler.Silverlight.dll for Silverlight 5.0:

    - -
    1: 
-2: 
-
    msbuild fsharp-library-build.proj /p:TargetFramework=sl5-compiler  /p:Configuration=Release
-msbuild fsharp-compiler-build.proj /p:TargetFramework=sl5-compiler /p:Configuration=Release
-
    -

    Change to /p:Configuration=Debug for debug binaries.

    -

    On Windows, using xbuild (e.g. if no .NET is installed and only Mono 3.0 is installed):

    - -
    1: 
-2: 
-3: 
-4: 
-
    cd src
-xbuild fsharp-proto-build.proj
-xbuild fsharp-library-build.proj
-xbuild fsharp-compiler-build.proj
-
    -

    Building using xbuild does not yet lay down a Mono-ready distribution (see src/fsharp/targets.make), so should only -be used for private development rather than preparing distributions.

    -

    Strong Names

    -

    The FSharp.Core.dll produced is only delay-signed (Mono does not require strong names). -If a strong-name signed FSharp.Core.dll is needed then use the one in

    - -
    1: 
-
    lib\bootstrap\signed\3.0\v4.0\FSharp.Core.dll
-
    -

    What you get

    -

    Once built the main compiler binaries go in

    - -
    1: 
-
    lib/release/4.0
-
    -

    There are versions of FSharp.Core for .NET 2.0, MonoAndroid, MonoTouch (Mono profile 2.1) in

    - -
    1: 
-2: 
-3: 
-
    lib/release/2.0
-lib/release/2.1
-lib/release/2.1monotouch
-
    -

    On make install the binaries etc. go in the prefix, e.g.

    - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-
    /Library/Frameworks/Mono.framework/Versions/Current/lib/mono/2.0/FSharp.Core.dll
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/2.1/FSharp.Core.dll
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.0/fsc.exe
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.0/FSharp.Compiler.dll
-...
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.5/fsc.exe
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.5/FSharp.Compiler.dll
-...
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/gac/.../FSharp.Compiler.dll
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/gac/.../FSharp.Compiler.dll
-...
-
    -

    plus some files for xbuild support

    - -
    1: 
-2: 
-
    /Library/Frameworks/Mono.framework/Versions/Current/lib/mono/Microsoft\ F#/v4.0/*
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/Microsoft\ SDKs/F#/3.0/Framework/*
-
    -

    (these names are the canonical names for Microsoft.FSharp.Targets used by project files coming from Visual Studio)

    -

    plus scripts

    -

    /usr/bin/fsharpc (F# compiler) -/usr/bin/fsharpi (F# Interactive)

    -

    Development notes

    -

    Continuous Integration Build

    -

    We have a CI build set up with the JetBrains/Teamcity server as part of the F# community projects there:

    -

    http://teamcity.codebetter.com/project.html?projectId=project61&tab=projectOverview

    -

    @forki controls access. Right now this builds both a Mono 'make' install and a Windows 'cd src; msbuild fsharp-build.proj' build. No binaries are saved from the build, it is just for sanity checking.

    -

    Editing the Compiler with Visual Studio or MonoDevelop

    -

    Open all-vs2012.sln, and edit in modes Debug or Release. The compiler takes a good while to compile and that -can be a bit invasive to the work flow, so it's normally better to do the actual compilation from -the command line, see above.

    -

    The F# support in MonoDevelop uses an in-process background compiler. On the Mac this causes pausing garbage -collections to kick in which makes editing the compiler in MonoDevelop awkward.

    -

    Building F# Core Unit Tests for .NET 4.x (optional)

    -

    This uses the proto compiler to build the unit tests that check some parts of FSharp.Core.dll and FSharp.Compiler.dll. There is also another set of tests under tests\fsharp.

    - -
    1: 
-
    msbuild fsharp-library-unittests-build.proj /p:TargetFramework=net40
-
    -

    Note: You must have NUnit installed to build the unit tests.

    -

    Validation and Use

    -

    Here are some simple tests to validate what you have built by checking fsi.exe (F# Interactive) starts up:

    - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-
    lib\debug\4.0\fsi.exe
-1 + 1;;
-\#q;;
-lib\debug\4.0\fsi.exe /help
-lib\debug\4.0\fsc.exe /help
-echo printfn "hello world" > hello.fs
-lib\debug\4.0\fsc.exe hello.fs
-hello.exe
-
    -

    Running Compiler tests (on Windows)

    -

    There are language tests under tests\fsharp\core. The test apparatus is primitive and unfortunately uses batch files. You can run these on Windows using:

    - -
    1: 
-2: 
-
    cd ..\tests\fsharp\core
-..\..\build-and-run-all-installed-ilx-configs.bat results.log
-
    -

    The results file will contain one entry for each test directory, plus any reported errors.

    - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
    tests\fsharp\core
-tests\fsharp\core\queriesCustomQueryOps
-tests\fsharp\core\queriesLeafExpressionConvert
-tests\fsharp\core\queriesNullableOperators
-tests\fsharp\core\queriesOverIEnumerable
-...
-
    -

    Some tests for LINQ queries require SQL Server be installed. A failing test will look like this:

    - -
    1: 
-
    ERRORLEVEL=1: in tests\fsharp\core\csfromfs\build.bat
-
    -

    You can then go to the relevant directory and run build.bat and run.bat.

    -

    History

    -

    F# compiler sources dropped by Microsoft are available from fsharppowerpack.codeplex.com.

    -

    Uses bootstrapping libraries, tools and F# compiler. The lib/bootstrap/X.0 directories contain mono-built libraries, compiler and tools that can be used to bootstrap a build. You can also supply your own via the --with-bootstrap option.

    - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/compiler.html b/docs/ja/compiler.html deleted file mode 100644 index af3783a84f..0000000000 --- a/docs/ja/compiler.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - コンパイラの組み込み - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    コンパイラの組み込み

    -

    このチュートリアルではF#コンパイラをホストする方法を紹介します。

    -
    -

    注意: 以下で使用しているAPIは実験的なもので、 -新しいnugetパッケージの公開に伴って変更される可能性があります。 -注意: F#コンパイラをホストする方法はいくつかあります。 -一番簡単な方法は fsc.exe のプロセスを使って引数を渡す方法です。

    -
    -
    -

    まず、F# Interactiveサービスを含むライブラリへの参照を追加します:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-
    #r "FSharp.Compiler.Service.dll"
-open FSharp.Compiler.SourceCodeServices
-open System.IO
-
-let scs = FSharpChecker.Create()
-
    -

    次に、一時ファイルへコンテンツを書き込みます:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-
    let fn = Path.GetTempFileName()
-let fn2 = Path.ChangeExtension(fn, ".fs")
-let fn3 = Path.ChangeExtension(fn, ".dll")
-
-File.WriteAllText(fn2, """
-module M
-
-type C() = 
-   member x.P = 1
-
-let x = 3 + 4
-""")
-
    -

    そしてコンパイラを呼び出します:

    - - - -
    1: 
-
    let errors1, exitCode1 = scs.Compile([| "fsc.exe"; "-o"; fn3; "-a"; fn2 |]) |> Async.RunSynchronously
-
    -

    エラーが発生した場合は「終了コード」とエラーの配列から原因を特定できます:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-
    File.WriteAllText(fn2, """
-module M
-
-let x = 1.0 + "" // a type error
-""")
-
-let errors1b, exitCode1b = scs.Compile([| "fsc.exe"; "-o"; fn3; "-a"; fn2 |]) |> Async.RunSynchronously
-
-if exitCode1b <> 0 then
-    errors1b
-    |> Array.iter (printfn "%A")
-
    -

    動的アセンブリへのコンパイル

    -

    コードを動的アセンブリとしてコンパイルすることもできます。 -動的アセンブリはF# Interactiveコードジェネレータでも使用されています。

    -

    この機能はたとえばファイルシステムが必ずしも利用できないような状況で役に立ちます。

    -

    出力ファイルの名前を指定する "-o" オプションを指定することは可能ですが、 -実際には出力ファイルがディスク上に書き込まれることはありません。

    -

    'execute' 引数に 'None' を指定するとアセンブリ用の初期化コードが実行されません。

    - - - -
    1: 
-2: 
-
    let errors2, exitCode2, dynAssembly2 = 
-    scs.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], execute=None) |> Async.RunSynchronously
-
    -

    'Some' を指定するとアセンブリ用の初期化コードが実行されます。

    - - - -
    1: 
-2: 
-
    let errors3, exitCode3, dynAssembly3 = 
-    scs.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], Some(stdout,stderr)) |> Async.RunSynchronously
-
    - -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    -
    namespace FSharp.Compiler
    -
    namespace FSharp.Compiler.SourceCodeServices
    -
    namespace System
    -
    namespace System.IO
    -
    val scs : FSharpChecker

    Full name: Compiler.scs
    -
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    -
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    -
    val fn : string

    Full name: Compiler.fn
    -
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val InvalidPathChars : char[]
      static val PathSeparator : char
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string
      static member GetExtension : path:string -> string
      static member GetFileName : path:string -> string
      ...

    Full name: System.IO.Path
    -
    Path.GetTempFileName() : string
    -
    val fn2 : string

    Full name: Compiler.fn2
    -
    Path.ChangeExtension(path: string, extension: string) : string
    -
    val fn3 : string

    Full name: Compiler.fn3
    -
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 3 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      static member Encrypt : path:string -> unit
      static member Exists : path:string -> bool
      ...

    Full name: System.IO.File
    -
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: System.Text.Encoding) : unit
    -
    val errors1 : obj

    Full name: Compiler.errors1
    -
    val exitCode1 : obj

    Full name: Compiler.exitCode1
    -
    member FSharpChecker.Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member FSharpChecker.Compile : ast:FSharp.Compiler.Ast.ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    val errors1b : obj []

    Full name: Compiler.errors1b
    -
    val exitCode1b : int

    Full name: Compiler.exitCode1b
    -
    module Array

    from Microsoft.FSharp.Collections
    -
    val iter : action:('T -> unit) -> array:'T [] -> unit

    Full name: Microsoft.FSharp.Collections.Array.iter
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    val errors2 : obj

    Full name: Compiler.errors2
    -
    val exitCode2 : obj

    Full name: Compiler.exitCode2
    -
    val dynAssembly2 : obj

    Full name: Compiler.dynAssembly2
    -
    member FSharpChecker.CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * System.Reflection.Assembly option>
    member FSharpChecker.CompileToDynamicAssembly : ast:FSharp.Compiler.Ast.ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * System.Reflection.Assembly option>
    -
    union case Option.None: Option<'T>
    -
    val errors3 : obj

    Full name: Compiler.errors3
    -
    val exitCode3 : obj

    Full name: Compiler.exitCode3
    -
    val dynAssembly3 : obj

    Full name: Compiler.dynAssembly3
    -
    union case Option.Some: Value: 'T -> Option<'T>
    -
    val stdout<'T> : TextWriter

    Full name: Microsoft.FSharp.Core.Operators.stdout
    -
    val stderr<'T> : TextWriter

    Full name: Microsoft.FSharp.Core.Operators.stderr
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/corelib.html b/docs/ja/corelib.html deleted file mode 100644 index 24534af079..0000000000 --- a/docs/ja/corelib.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - コンパイラサービス: FSharp.Core.dll についてのメモ - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    コンパイラサービス: FSharp.Core.dll についてのメモ

    -

    あなたのアプリケーションとともに FSharp.Core を配布する

    -

    FSharp.Compiler.Service.dll を利用するアプリケーションまたはプラグイン・コンポーネントをビルドする際、普通はアプリの一部として FSharp.Core.dll のコピーも含めることになるでしょう。

    -

    例えば、 HostedCompiler.exe をビルドする場合、普通はあなたの HostedCompiler.exe と同じフォルダに FSharp.Core.dll (例えば 4.3.1.0)を配置します。

    -

    動的コンパイルや動的実行を行う場合、FSharp.Core.optdata と FSharp.Core.sigdata も含める必要があるかもしれませんが、これらについては下記の指針をご覧ください。

    -

    あなたのアプリケーションにリダイレクトをバインドする

    -

    FSharp.Compiler.Service.dll コンポーネントは FSharp.Core 4.3.0.0 に依存しています。通例、あなたのアプリケーションはこれより後のバージョンの FSharp.Core をターゲットにしており、FSharp.Core 4.3.0.0 をあなたのアプリケーションで用いる FSharp.Core.dll の最終バージョンにちゃんと転送させるようにバインド リダイレクトが必要になるでしょう。バインド リダイレクト ファイルは通常ビルドツールによって自動的に生成されます。そうでない場合、下記のようなファイル(あなたのツールが HostedCompiler.exe という名前で、バインド リダイレクト ファイルが HostedCompiler.exe.config という名前の場合)を使うことが出来ます。

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-
    <?xml version="1.0" encoding="utf-8" ?>
-<configuration>
-    <runtime>
-      <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
-        <dependentAssembly>
-          <assemblyIdentity name="FSharp.Core" publicKeyToken="b03f5f7f11d50a3a" culture="neutral"/>
-          <bindingRedirect oldVersion="2.0.0.0-4.3.0.0" newVersion="4.3.1.0"/>
-        </dependentAssembly>
-        <dependentAssembly>
-          <assemblyIdentity name="System.Collections.Immutable" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
-          <bindingRedirect oldVersion="1.0.0.0-1.2.0.0" newVersion="1.2.1.0" />
-        </dependentAssembly>
-      </assemblyBinding>
-    </runtime>	
-</configuration>
-
    -

    どの FSharp.Core と .NET フレームワークがコンパイル時に参照される？

    -

    FSharp.Combiler.Service コンポーネントは多かれ少なかれ、F#コードを コンパイルするために使われるに過ぎません。特に、コマンドライン引数(あなたのツールを実行するために使われる FSharp.Core や .NET フレームワークとは違います)に明示的に FSharp.Core および/またはフレームワークのアセンブリを参照することが出来ます。

    -

    特定の FSharp.Core および .NET フレームワーク アセンブリ、またはそのいずれかをターゲットにする場合、 --noframework 引数と適切なコマンドライン引数を使います:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-
    [<Literal>]
-let fsharpCorePath = 
-    @"C:\Program Files (x86)\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.1.0\FSharp.Core.dll"
-let errors2, exitCode2 = 
-  scs.Compile(
-    [| "fsc.exe"; "--noframework"; 
-       "-r"; fsharpCorePath; 
-       "-r"; @"C:\Windows\Microsoft.NET\Framework\v4.0.30319\mscorlib.dll"; 
-       "-o"; fn3; 
-       "-a"; fn2 |])
-
    -

    これらのアセンブリが配置されている場所を指定する必要があります。クロスプラットフォームに対応した方法でDLL を配置して、それらをコマンドライン引数に変換する最も簡単な方法は、F# プロジェクトファイルをクラックすることです。 -自分で SDK のパスを処理する代わりに、FSharp.Compiler.Service.dll 用のテストで使用しているようなヘルパー関数も用意されています。

    -

    スクリプトを処理しているか GetCheckOptionsFromScriptRoot を使っている場合

    -

    もし SDK 配置先にある FSharp.Core.dll を明示的に参照 していない 場合、または FsiEvaluationSession や GetCheckOptionsFromScriptRoot を使用してスクリプトを処理している場合、以下のいずれかの方法により、暗黙的にFSharp.Core が参照されます:

    -
      -

    1. System.Reflection.Assembly.GetEntryAssembly() によって返されるホストアセンブリから静的に参照されたFSharp.Core.dll のバージョン

      2. -
    2. -

      ホストアセンブリに FSharp.Core への静的な参照がない場合、

      -
        -
      • FSharp.Compiler.Service 0.x シリーズでは、FSharp.Core バージョン 4.3.0.0 への参照が付与されます
        • -
      • FSharp.Compiler.Service 1.3.1.x (F# 3.1 シリーズ)では、FSharp.Core バージョン 4.3.1.0 への参照が付与されます
        • -
      • FSharp.Compiler.Service 1.4.0.x (F# 4.0 シリーズ)では、FSharp.Core バージョン 4.4.0.0 への参照が付与されます
        • -
      -
      3. -
    -

    FSharp.Core.optdata と FSharp.Core.sigdata を含める必要はありますか？

    -

    もしあなたのコンパイル引数が SDK 配置先にある FSharp.Core.dll を明示的に参照している場合、FSharp.Core.sigdata と FSharp.Core.optdata はその DLL と同じフォルダになければいけません(これらのファイルがインストールされていない場合、F# SDKの インストールに問題があります)。もしコンパイル引数で常に明示的に参照していたなら、FSharp.Core.optdata と FSharp.Core.sigdata はあなたのアプリケーションの一部として含める必要は ありません 。

    -

    もしあなたが暗黙的な参照(例えば、上記のスクリプト処理など)に頼っているのなら、これはあなたのツールがアプリケーションの一部として FSharp.Core.dll を参照しているかもしれない、ということです。この場合、FSharp.Core.optdata および FSharp.Core.sigdata が FSharp.Core.dll と同じフォルダに見つからないというエラーが発生するかもしれません。 もしあなたがアプリケーションに含めている FSharp.Core.dll を暗黙的に参照したいのであれば、FSharp.Core.sigdata と FSharp.Core.optdata もアプリケーションに追加する2つのファイルとして追加しましょう。 CombileToDynamicAssembly を使用する場合、この問題によってアセンブリ解決中のスタックオーバーフローも引き起こされるでしょう。

    -

    動的コンパイルと動的コード実行を行うツール(例: HostedExecution.exe)はしばしば FSharp.Core.dll を暗黙的に参照するようになっています。 -これはつまり通常 FSharp.Core.optdata と FSharp.Core.sigdata を含んでいるということです。

    -

    要約

    -

    このデザインノートでは3つのポイントを検討しました:

    -
      -
    • どの FSharp.Core.dll があなたのコンパイルツールを実行するのに使われるか
      • -
    • あなたのコンパイルツールを実行するのに使われる FSharp.Core.dll へのバインド リダイレクトを設定する方法
      • -
    • あなたのツールによって実行されるチェック時およびコンパイル時にどの FSharp.Core.dll および/またはフレームワークのアセンブリが参照されるか
      • -
    - -
    Multiple items
    type LiteralAttribute =
      inherit Attribute
      new : unit -> LiteralAttribute

    Full name: Microsoft.FSharp.Core.LiteralAttribute

    --------------------
    new : unit -> LiteralAttribute
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/devnotes.html b/docs/ja/devnotes.html deleted file mode 100644 index b60eec4483..0000000000 --- a/docs/ja/devnotes.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - 開発者用メモ - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    開発者用メモ

    -

    F#コンパイラの修正版クローンではクライアントの編集機能やF#コンパイラの埋め込み、 -F# Interactiveをサービスとして動作させるための機能が追加されています。

    -

    コンポーネント

    -

    まず FSharp.Compiler.Service.dll というコンポーネントがあります。 -このコンポーネントにはリファクタリングやその他の編集ツールが完全なF# ASTやパーサ機能を利用できるように -可視性を変更するというマイナーな変更だけが加えられています。 -主な狙いとしては、メインコンパイラの安定版かつドキュメントが備えられたフォークを用意することにより、 -このコンポーネントにある共通コードを様々なツールで共有できるようにすることです。

    -

    2つ目のコンポーネントはF# Interactiveをサービスとして組み込めるようにするためのもので、 -fsi.exe のソースコードに多数の変更が加えられており、 -EvalExpression や EvalInteraction といった関数が追加されています。

    -

    このレポジトリは以下の点を除けば 'fsharp' と 同一 です:

    -
      -
    • -

      FSharp.Compiler.Service.dll のビルド、特に以下の点に関する変更:

      -
        -
      • アセンブリ名の変更
        • -

      • FSharp.Compiler.Service.dll のみビルドされる

        • -
      • -

        ブートストラッパーやプロトコンパイラを使用しない。 -F#コンパイラがインストール済みであることを想定。

        -
        • -
      -
      • -
    • -

      FAKEを使用するビルドスクリプト。 -すべてのコードのビルドとNuGetパッケージ、ドキュメントの生成、 -NuGetパッケージの配布に必要なファイルの生成などがFAKEによって行われる。 -(F# プロジェクト スキャフォールド に準拠)

      -
      • -
    • -

      新機能追加のためにコンパイラのソースコードを変更。 -また、評価用関数を実装するためにF# Interactiveサービスに対する変更を追加。

      -
      • -
    • F#編集用クライアントで使用されるAPIを改善するためにコンパイラのソースコードを変更。
      • -
    • コンパイラサービスAPIに新機能を追加するためにコンパイラのソースコードを変更。
      • -
    -

    fsharp/fsharp のレポジトリに言語あるいはコンパイラが追加コミットされた場合、 -それらはこのレポジトリにもマージされるべきで、同時に新しいNuGetパッケージもリリースする必要があります。

    -

    ビルドとNuGet

    -

    ビルドの手順は F# プロジェクト スキャフォールド -で推奨されているものに準じます。 -プロジェクトを独自にビルドする場合、以下の手順に従ってください:

    - -
    1: 
-2: 
-
    git clone https://github.com/fsharp/FSharp.Compiler.Service
-cd FSharp.Compiler.Service
-
    -

    次に、(Windowsであれば) build.cmd または(LinuxやMac OSであれば) build.sh を実行してすべてをビルドします。 -ファイルは bin ディレクトリ内に出力されます。 -ドキュメントやNuGetパッケージもビルドしたい場合には build Release を実行します -(このコマンドはGitHub上のドキュメントを更新しようとしますが、GitHubのレポジトリに適切な権限を持っている場合にのみ有効です)。

    -

    クライアント

    -

    このコンポーネントは以下のようなツールで使用されています:

    - - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/editor.html b/docs/ja/editor.html deleted file mode 100644 index 5895a9ca48..0000000000 --- a/docs/ja/editor.html +++ /dev/null @@ -1,430 +0,0 @@ - - - - - コンパイラサービス: エディタサービス - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    コンパイラサービス: エディタサービス

    -

    このチュートリアルはF#コンパイラによって公開されるエディタサービスの -使用方法についてのデモです。 -このAPIにより、Visual StudioやXamarin Studio、EmacsなどのF#エディタ内において、 -自動補完機能やツールチップ表示、引数情報のヘルプ表示、括弧の補完などの機能を -実装することができます -(詳細については fsharpbindings のプロジェクトを参照してください)。 -型無しASTを使用するチュートリアル と同じく、 -今回も FSharpChecker オブジェクトを作成するところから始めます。

    -
    -

    注意: 以下で使用しているAPIは試験的なもので、最新バージョンのnugetパッケージの -公開に伴って変更されることがあります。

    -
    -

    サンプルソースコードの型チェック

    -

    前回の(型無しASTを使った)チュートリアル と同じく、 -FSharp.Compiler.Service.dll への参照を追加した後に特定の名前空間をオープンし、 -FSharpChecker のインスタンスを作成します:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-
    // F#コンパイラAPIを参照
-#r "FSharp.Compiler.Service.dll"
-
-open System
-open FSharp.Compiler.SourceCodeServices
-
-// インタラクティブチェッカーのインスタンスを作成
-let checker = FSharpChecker.Create()
-
    -

    前回 同様、 -コンパイラに渡されるファイルとしては特定の入力値だけであるという -コンテキストを想定するため、 GetCheckOptionsFromScriptRoot を使います -(この入力値はコンパイラによってスクリプトファイル、 -あるいはスタンドアロンのF#ソースコードとみなされます)。

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-
    // サンプルの入力となる複数行文字列
-let input = 
-    """
-open System
-
-let foo() = 
-let msg = String.Concat("Hello"," ","world")
-if true then 
-printfn "%s" msg.
-"""
-// 入力値の分割とファイル名の定義
-let inputLines = input.Split('\n')
-let file = "/home/user/Test.fsx"
-
-let projOptions, _errors1 = checker.GetProjectOptionsFromScript(file, input) |> Async.RunSynchronously
-
-let parsingOptions, _errors2 = checker.GetParsingOptionsFromProjectOptions(projOptions)
-
    -

    型チェックを実行するには、まず ParseFile を使って -入力値をパースする必要があります。 -このメソッドを使うと 型無しAST にアクセスできるようになります。 -しかし今回は完全な型チェックを実行するため、続けて CheckFileInProject -を呼び出す必要があります。 -このメソッドは ParseFile の結果も必要とするため、 -たいていの場合にはこれら2つのメソッドをセットで呼び出すことになります。

    - - - -
    1: 
-2: 
-3: 
-4: 
-
    // パースを実行
-let parseFileResults =
-    checker.ParseFile(file, input, parsingOptions)
-    |> Async.RunSynchronously
-
    -

    TypeCheckResults に備えられた興味深い機能の紹介に入る前に、 -サンプル入力に対して型チェッカーを実行する必要があります。 -F#コードにエラーがあった場合も何らかの型チェックの結果が返されます -(ただし間違って「推測された」結果が含まれることがあります)。

    - - - -
    1: 
-2: 
-3: 
-4: 
-
    // 型チェックを実行
-let checkFileAnswer = 
-    checker.CheckFileInProject(parseFileResults, file, 0, input, projOptions) 
-    |> Async.RunSynchronously
-
    -

    あるいは ParseAndCheckFileInProject を使用すれば1つの操作で両方のチェックを行うことができます：

    - - - -
    1: 
-2: 
-3: 
-
    let parseResults2, checkFileAnswer2 =
-    checker.ParseAndCheckFileInProject(file, 0, input, projOptions)
-    |> Async.RunSynchronously
-
    -

    この返り値は CheckFileAnswer 型で、この型に機能的に興味深いものが揃えられています...

    - - - -
    1: 
-2: 
-3: 
-4: 
-
    let checkFileResults = 
-    match checkFileAnswer with
-    | FSharpCheckFileAnswer.Succeeded(res) -> res
-    | res -> failwithf "パースが完了していません... (%A)" res
-
    -

    今回は単に(状況に応じて)「Hello world」と表示するだけの -単純な関数の型をチェックしています。 -最終行では値 msg に対する補完リストを表示することができるように、 -msg. というようにドットを追加している点に注意してください -(今回の場合は文字列型に対する様々なメソッドが期待されます)。

    -

    型チェックの結果を使用する

    -

    では TypeCheckResults 型で公開されているAPIをいくつか見ていきましょう。 -一般的に、F#ソースコードエディタサービスの実装に必要な機能は -ほとんどこの型に備えられています。

    -

    ツールチップの取得

    -

    ツールチップを取得するには GetToolTipTextAlternate メソッドを使用します。 -このメソッドには行数と文字オフセットを指定します。 -いずれも0から始まる数値です。 -サンプルコードでは3行目(0行目は空白行)、インデックス7にある文字 f から始まる関数 -foo のツールチップを取得しています -(ツールチップは識別子の中であれば任意の位置で機能します)。

    -

    またこのメソッドにはトークンタグを指定する必要もあります。 -トークンタグは一般的には IDENT を指定して、識別子に対する -ツールチップが取得できるようにします -(あるいは #r "..." を使用している場合にはアセンブリの完全パスを表示させるように -することもできるでしょう)。

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
    // 最後の引数に指定する、IDENTトークンのタグを取得
-open FSharp.Compiler
-
-// 特定の位置におけるツールチップを取得
-let tip = checkFileResults.GetToolTipText(4, 7, inputLines.[1], ["foo"], FSharpTokenTag.Identifier)
-printfn "%A" tip
-
    -
    -

    注意： GetToolTipTextAlternate は古い関数 GetToolTipText に代わるものです。 -GetToolTipText は0から始まる行番号を受け取るようになっていたため、非推奨になりました。

    -
    -

    この関数には位置とトークンの種類の他にも、 -(ソースコードの変更時に役立つように)特定行の現在の内容と、 -現時点における完全修飾された 名前 を表す文字列のリストを指定する必要があります。 -たとえば完全修飾名 System.Random という名前を持った識別子 Random に対する -ツールチップを取得する場合、 Random という文字列が現れる場所の他に、 -["System"; "Random"] という値を指定する必要があります。

    -

    返り値の型は ToolTipText で、この型には ToolTipElement という -判別共用体が含まれます。 -この共用体は、コンパイラによって返されたツールチップの種類に応じて異なります。

    -

    自動補完リストの取得

    -

    次に紹介する TypeCheckResults のメソッドを使用すると、 -特定の位置における自動補完機能を実装できます。 -この機能は任意の識別子上、 -あるいは(特定のスコープ内で利用可能な名前の一覧を取得する場合には)任意のスコープ、 -あるいは特定のオブジェクトにおけるメンバーリストを取得する場合には -. の直後で呼び出すことができます。 -今回は文字列の値 msg に対するメンバーリストを取得することにします。

    -

    そのためには最終行( printfn "%s" msg. で終わっている行)にある -シンボル . の位置を指定して GetDeclarationListInfo を呼び出します。 -オフセットは1から始まるため、位置は 7, 23 になります。 -また、テキストが変更されていないことを表す関数と、 -現時点において補完する必要がある識別子を指定する必要もあります。

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
    // 特定の位置における宣言(自動補完)を取得する
-let decls = 
-    checkFileResults.GetDeclarationListInfo
-      (Some parseFileResults, 7, inputLines.[6], PartialLongName.Empty 23, (fun _ -> []), fun _ -> false)
-      |> Async.RunSynchronously
-
-// 利用可能な項目を表示
-for item in decls.Items do
-    printfn " - %s" item.Name
-
    -
    -

    注意： GetDeclarationListInfo は古い関数 GetDeclarations に代わるものです。 -GetDeclarations は0から始まる行番号を受け取るようになっていたため、非推奨になりました。 -また、将来的には現在の GetDeclarations が削除され、 GetDeclarationListInfo が -GetDeclarations になる予定です。

    -
    -

    コードを実行してみると、 Substring や ToUpper 、 ToLower といった -文字列に対するいつものメソッドのリストが取得できていることでしょう。 -GetDeclarations の5,6番目の引数( [] および "msg" )には -自動補完用のコンテキストを指定します。 -今回の場合は完全名 msg に対する補完を行いましたが、 -たとえば ["System"; "Collections"] と "Generic" というように -完全修飾された名前空間を指定して補完リストを取得することもできます。

    -

    引数の情報を取得する

    -

    次に一般的なエディタの機能としては、メソッドのオーバーロードに -関する情報を提供するというものでしょう。 -サンプルコード中では多数のオーバーロードを持った String.Concat を使っています。 -このオーバーロード一覧は GetMethods で取得できます。 -先ほどと同じく、このメソッドには対象とする項目の位置を0基準のオフセットで指定し -(今回は String.Concat 識別子の右側の終端)、 -識別子もやはり指定します -(これにより、コンパイラはソースコードが変更された場合でも最新の情報に追従できます):

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
    //String.Concatメソッドのオーバーロードを取得する
-let methods = 
-    checkFileResults.GetMethods(5, 27, inputLines.[4], Some ["String"; "Concat"]) |> Async.RunSynchronously
-
-// 連結された引数リストを表示
-for mi in methods.Methods do
-    [ for p in mi.Parameters -> p.Display ]
-    |> String.concat ", " 
-    |> printfn "%s(%s)" methods.MethodName
-
    -

    ここでは Display プロパティを使用することで各引数に対する -アノテーションを取得しています。 -このプロパティは arg0: obj あるいは params args: obj[] 、 -str0: string, str1: string といった情報を返します。 -これらの引数を連結した後、メソッド名とメソッドの型情報とともに表示させています。

    -

    非同期操作と即時操作

    -

    CheckFileInProject が非同期操作であることを気にされる人もいるかもしれません。 -これはつまり、F#コードの型チェックにはある程度時間がかかることを示唆しています。 -F#コンパイラは型チェックを(自動的に)バックグラウンドで処理を進めているため、 -CheckFileInProject メソッドを呼び出すと非同期操作が返されることになります。

    -

    また、 CheckFileInProjectIfReady というメソッドもあります。 -このメソッドは、型チェックの操作が即座に開始できない場合、 -つまりプロジェクト内の他のファイルがまだ型チェックされていない場合には -処理が即座に返されます。 -この場合、バックグラウンドワーカーは一定期間他の作業を進めるか、 -FileTypeCheckStateIsDirty イベントが発生するまでは -ファイルに対する型チェックを諦めるか、どちらか選択することになります。

    -
    -

    fsharpbinding プロジェクトには -1つのF#エージェント経由ですべてのリクエストをバックグラウンドワークとして -処理するような、より複雑な具体例も含まれています。 -エディタの機能を実装する方法としてはこちらのほうが適切です。

    -
    -

    まとめ

    -

    CheckFileAnswer にはチュートリアルで紹介していないような便利なメソッドが -多数揃えられています。 -これらを使用すれば特定の識別子に対する宣言の位置を取得したり、 -付加的な色情報を取得したりすることができます -(F# 3.1では式ビルダーの識別子やクエリ演算子も着色表示されます)。

    -

    最後に、直接.NET APIを呼び出すことができないようなエディタに対するサポート機能を -実装する場合、ここで紹介した様々な機能を -FSharp.AutoComplete -プロジェクトのコマンドラインインターフェイス経由で呼び出すこともできます。

    - -
    namespace System
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    -
    namespace FSharp.Compiler
    -
    namespace FSharp.Compiler.SourceCodeServices
    -
    val checker : FSharpChecker

    Full name: Editor.checker
    -
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    -
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    -
    val input : string

    Full name: Editor.input
    -
    val inputLines : string []

    Full name: Editor.inputLines
    -
    String.Split([<ParamArray>] separator: char []) : string []
    String.Split(separator: string [], options: StringSplitOptions) : string []
    String.Split(separator: char [], options: StringSplitOptions) : string []
    String.Split(separator: char [], count: int) : string []
    String.Split(separator: string [], count: int, options: StringSplitOptions) : string []
    String.Split(separator: char [], count: int, options: StringSplitOptions) : string []
    -
    val file : string

    Full name: Editor.file
    -
    val projOptions : FSharpProjectOptions

    Full name: Editor.projOptions
    -
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    val parsingOptions : FSharpParsingOptions

    Full name: Editor.parsingOptions
    -
    member FSharpChecker.GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    -
    val parseFileResults : FSharpParseFileResults

    Full name: Editor.parseFileResults
    -
    member FSharpChecker.ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    -
    val checkFileAnswer : FSharpCheckFileAnswer

    Full name: Editor.checkFileAnswer
    -
    member FSharpChecker.CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    -
    val parseResults2 : obj

    Full name: Editor.parseResults2
    -
    val checkFileAnswer2 : obj

    Full name: Editor.checkFileAnswer2
    -
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    -
    val checkFileResults : FSharpCheckFileResults

    Full name: Editor.checkFileResults
    -
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults

    Full name: FSharp.Compiler.SourceCodeServices.FSharpCheckFileAnswer
    -
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    -
    val res : FSharpCheckFileResults
    -
    val res : FSharpCheckFileAnswer
    -
    val failwithf : format:Printf.StringFormat<'T,'Result> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.failwithf
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>

    Full name: FSharp.Compiler.SourceCodeServices.FSharpAttribute
    -
    val tip : Async<FSharpToolTipText>

    Full name: Editor.tip
    -
    member FSharpCheckFileResults.GetToolTipText : line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * ?userOpName:string -> Async<FSharpToolTipText>
    -
    module FSharpTokenTag

    from FSharp.Compiler.SourceCodeServices
    -
    val Identifier : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpTokenTag.Identifier
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    val decls : obj

    Full name: Editor.decls
    -
    member FSharpCheckFileResults.GetDeclarationListInfo : ParsedFileResultsOpt:FSharpParseFileResults option * line:int * lineText:string * partialName:PartialLongName * ?getAllEntities:(unit -> AssemblySymbol list) * ?hasTextChangedSinceLastTypecheck:(obj * Range.range -> bool) * ?userOpName:string -> Async<FSharpDeclarationListInfo>
    -
    union case Option.Some: Value: 'T -> Option<'T>
    -
    type PartialLongName =
      {QualifyingIdents: string list;
       PartialIdent: string;
       EndColumn: int;
       LastDotPos: int option;}
      static member Empty : endColumn:int -> PartialLongName

    Full name: FSharp.Compiler.PartialLongName
    -
    static member PartialLongName.Empty : endColumn:int -> PartialLongName
    -
    val item : Entity
    -
    Entity.Name: StringLongIdent
    -
    val methods : obj

    Full name: Editor.methods
    -
    member FSharpCheckFileResults.GetMethods : line:int * colAtEndOfNames:int * lineText:string * names:string list option * ?userOpName:string -> Async<FSharpMethodGroup>
    -
    val mi : obj
    -
    val p : obj
    -
    Multiple items
    type String =
      new : value:char -> string + 7 overloads
      member Chars : int -> char
      member Clone : unit -> obj
      member CompareTo : value:obj -> int + 1 overload
      member Contains : value:string -> bool
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EndsWith : value:string -> bool + 2 overloads
      member Equals : obj:obj -> bool + 2 overloads
      member GetEnumerator : unit -> CharEnumerator
      member GetHashCode : unit -> int
      ...

    Full name: System.String

    --------------------
    String(value: nativeptr<char>) : unit
    String(value: nativeptr<sbyte>) : unit
    String(value: char []) : unit
    String(c: char, count: int) : unit
    String(value: nativeptr<char>, startIndex: int, length: int) : unit
    String(value: nativeptr<sbyte>, startIndex: int, length: int) : unit
    String(value: char [], startIndex: int, length: int) : unit
    String(value: nativeptr<sbyte>, startIndex: int, length: int, enc: Text.Encoding) : unit
    -
    val concat : sep:string -> strings:seq<string> -> string

    Full name: Microsoft.FSharp.Core.String.concat
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/filesystem.html b/docs/ja/filesystem.html deleted file mode 100644 index 00892b7dc6..0000000000 --- a/docs/ja/filesystem.html +++ /dev/null @@ -1,427 +0,0 @@ - - - - - コンパイラサービス: ファイルシステム仮想化 - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    コンパイラサービス: ファイルシステム仮想化

    -

    FSharp.Compiler.Service にはファイルシステムを表すグローバル変数があります。 -この変数を設定するこにより、ファイルシステムが利用できない状況でも -コンパイラをホストすることができるようになります。

    -
    -

    注意: 以下で使用しているAPIは実験的なもので、 -新しいnugetパッケージの公開に伴って変更される可能性があります。

    -
    -

    FileSystemの設定

    -

    以下の例ではディスクからの読み取りを行うような実装をファイルシステムに設定しています:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-33: 
-34: 
-35: 
-36: 
-37: 
-38: 
-39: 
-40: 
-41: 
-42: 
-43: 
-44: 
-45: 
-46: 
-47: 
-48: 
-49: 
-50: 
-51: 
-52: 
-53: 
-54: 
-55: 
-56: 
-57: 
-58: 
-59: 
-60: 
-61: 
-62: 
-63: 
-64: 
-65: 
-66: 
-67: 
-68: 
-69: 
-70: 
-71: 
-72: 
-73: 
-74: 
-75: 
-76: 
-
    #r "FSharp.Compiler.Service.dll"
-open System
-open System.IO
-open System.Collections.Generic
-open System.Text
-open FSharp.Compiler.AbstractIL.Internal.Library
-
-let defaultFileSystem = Shim.FileSystem
-
-let fileName1 = @"c:\mycode\test1.fs" // 注意: 実際には存在しないファイルのパス
-let fileName2 = @"c:\mycode\test2.fs" // 注意: 実際には存在しないファイルのパス
-
-type MyFileSystem() = 
-    let file1 = """
-module File1
-
-let A = 1"""
-    let file2 = """
-module File2
-let B = File1.A + File1.A"""
-    let files = dict [(fileName1, file1); (fileName2, file2)]
-
-    interface IFileSystem with
-        // 読み取りおよび書き込み用にファイルをオープンする機能を実装
-        member __.FileStreamReadShim(fileName) = 
-            match files.TryGetValue(fileName) with
-            | true, text -> new MemoryStream(Encoding.UTF8.GetBytes(text)) :> Stream
-            | _ -> defaultFileSystem.FileStreamReadShim(fileName)
-
-        member __.FileStreamCreateShim(fileName) = 
-            defaultFileSystem.FileStreamCreateShim(fileName)
-
-        member __.IsStableFileHeuristic(fileName) = 
-            defaultFileSystem.IsStableFileHeuristic(fileName)
-
-        member __.FileStreamWriteExistingShim(fileName) = 
-            defaultFileSystem.FileStreamWriteExistingShim(fileName)
-
-        member __.ReadAllBytesShim(fileName) = 
-            match files.TryGetValue(fileName) with
-            | true, text -> Encoding.UTF8.GetBytes(text)
-            | _ -> defaultFileSystem.ReadAllBytesShim(fileName)
-
-        // 一時パスおよびファイルのタイムスタンプに関連する機能を実装
-        member __.GetTempPathShim() = 
-            defaultFileSystem.GetTempPathShim()
-
-        member __.GetLastWriteTimeShim(fileName) = 
-            defaultFileSystem.GetLastWriteTimeShim(fileName)
-
-        member __.GetFullPathShim(fileName) = 
-            defaultFileSystem.GetFullPathShim(fileName)
-
-        member __.IsInvalidPathShim(fileName) = 
-            defaultFileSystem.IsInvalidPathShim(fileName)
-
-        member __.IsPathRootedShim(fileName) = 
-            defaultFileSystem.IsPathRootedShim(fileName)
-
-        // ファイルの存在確認および削除に関連する機能を実装
-        member __.SafeExists(fileName) = 
-            files.ContainsKey(fileName) || defaultFileSystem.SafeExists(fileName)
-
-        member __.FileDelete(fileName) = 
-            defaultFileSystem.FileDelete(fileName)
-
-        // アセンブリのロードに関連する機能を実装。
-        // 型プロバイダやF# Interactiveで使用される。
-        member __.AssemblyLoadFrom(fileName) = 
-            defaultFileSystem.AssemblyLoadFrom fileName
-
-        member __.AssemblyLoad(assemblyName) = 
-            defaultFileSystem.AssemblyLoad assemblyName 
-
-let myFileSystem = MyFileSystem()
-Shim.FileSystem <- MyFileSystem() 
-
    -

    FileSystemによるコンパイルの実行

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-33: 
-34: 
-35: 
-36: 
-37: 
-38: 
-39: 
-40: 
-41: 
-42: 
-
    open FSharp.Compiler.SourceCodeServices
-
-let checker = FSharpChecker.Create()
-let projectOptions = 
-    let allFlags = 
-        [| yield "--simpleresolution"; 
-           yield "--noframework"; 
-           yield "--debug:full"; 
-           yield "--define:DEBUG"; 
-           yield "--optimize-"; 
-           yield "--doc:test.xml"; 
-           yield "--warn:3"; 
-           yield "--fullpaths"; 
-           yield "--flaterrors"; 
-           yield "--target:library"; 
-           let references =
-             [ @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\mscorlib.dll"; 
-               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.dll"; 
-               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.Core.dll"; 
-               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.0.0\FSharp.Core.dll"]
-           for r in references do 
-                 yield "-r:" + r |]
- 
-    { ProjectFileName = @"c:\mycode\compilation.fsproj" // 現在のディレクトリで一意な名前を指定
-      ProjectId = None
-      SourceFiles = [| fileName1; fileName2 |]
-      OriginalLoadReferences = []
-      ExtraProjectInfo=None
-      Stamp = None
-      OtherOptions = allFlags 
-      ReferencedProjects=[| |]
-      IsIncompleteTypeCheckEnvironment = false
-      UseScriptResolutionRules = true 
-      LoadTime = System.DateTime.Now // 'Now' を指定して強制的に再読込させている点に注意
-      UnresolvedReferences = None }
-
-let results = checker.ParseAndCheckProject(projectOptions) |> Async.RunSynchronously
-
-results.Errors
-results.AssemblySignature.Entities.Count //2
-results.AssemblySignature.Entities.[0].MembersFunctionsAndValues.Count //1
-results.AssemblySignature.Entities.[0].MembersFunctionsAndValues.[0].DisplayName // "B"
-
    -

    まとめ

    -

    このチュートリアルでは FSharp.Compiler.Service コンポーネントで使用される -ファイルシステムに注目して、グローバルな設定を変更する方法について紹介しました。

    -

    このチュートリアルの執筆時点では、以下に列挙したSystem.IOの操作に対しては -仮想化されたファイルシステムAPIが用意されない予定になっています。 -将来のバージョンのコンパイラサービスではこれらのAPIが追加されるかもしれません。

    -
      -
    • Path.Combine
      • -
    • Path.DirectorySeparatorChar
      • -
    • Path.GetDirectoryName
      • -
    • Path.GetFileName
      • -
    • Path.GetFileNameWithoutExtension
      • -
    • Path.HasExtension
      • -
    • Path.GetRandomFileName (アセンブリ内にコンパイル済みwin32リソースを生成する場合にのみ使用される)
      • -
    -

    注意: SourceCodeServices API内の一部の操作では、 -引数にファイルの内容だけでなくファイル名を指定する必要があります。 -これらのAPIにおいて、ファイル名はエラーの報告のためだけに使用されます。

    -

    注意: 型プロバイダーコンポーネントは仮想化されたファイルシステムを使用しません。

    -

    注意: コンパイラサービスは --simpleresolution が指定されていない場合、 -MSBuildを使ってアセンブリの解決を試みることがあります。 -FileSystem APIを使用する場合、通常はコンパイラへのフラグとして ---simpleresolution を指定することになります。 -それと同時に --noframework を指定します。 -.NETアセンブリに対するすべての参照を明示的に指定する必要があるでしょう。

    - -
    namespace System
    -
    namespace System.IO
    -
    namespace System.Collections
    -
    namespace System.Collections.Generic
    -
    namespace System.Text
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    -
    namespace FSharp.Compiler
    -
    namespace FSharp.Compiler.AbstractIL
    -
    namespace FSharp.Compiler.AbstractIL.Internal
    -
    module Library

    from FSharp.Compiler.AbstractIL.Internal
    -
    val defaultFileSystem : obj

    Full name: Filesystem.defaultFileSystem
    -
    val fileName1 : string

    Full name: Filesystem.fileName1
    -
    val fileName2 : string

    Full name: Filesystem.fileName2
    -
    Multiple items
    type MyFileSystem =
      interface obj
      new : unit -> MyFileSystem
      override AssemblyLoad : assemblyName:'a -> 'b
      override AssemblyLoadFrom : fileName:'c -> 'd
      override FileDelete : fileName:'e -> 'f
      override FileStreamCreateShim : fileName:'a1 -> 'a2
      override FileStreamReadShim : fileName:obj -> Stream
      override FileStreamWriteExistingShim : fileName:'q -> 'r
      override GetFullPathShim : fileName:'k -> 'l
      override GetLastWriteTimeShim : fileName:'m -> 'n
      ...

    Full name: Filesystem.MyFileSystem

    --------------------
    new : unit -> MyFileSystem
    -
    val file1 : string
    -
    val file2 : string
    -
    val files : IDictionary<obj,obj>
    -
    val dict : keyValuePairs:seq<'Key * 'Value> -> IDictionary<'Key,'Value> (requires equality)

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.dict
    -
    override MyFileSystem.FileStreamReadShim : fileName:obj -> Stream

    Full name: Filesystem.MyFileSystem.FileStreamReadShim
    -
    val fileName : obj
    -
    IDictionary.TryGetValue(key: obj, value: byref<obj>) : bool
    -
    val text : obj
    -
    Multiple items
    type MemoryStream =
      inherit Stream
      new : unit -> MemoryStream + 6 overloads
      member CanRead : bool
      member CanSeek : bool
      member CanWrite : bool
      member Capacity : int with get, set
      member Flush : unit -> unit
      member GetBuffer : unit -> byte[]
      member Length : int64
      member Position : int64 with get, set
      member Read : buffer:byte[] * offset:int * count:int -> int
      ...

    Full name: System.IO.MemoryStream

    --------------------
    MemoryStream() : unit
    MemoryStream(capacity: int) : unit
    MemoryStream(buffer: byte []) : unit
    MemoryStream(buffer: byte [], writable: bool) : unit
    MemoryStream(buffer: byte [], index: int, count: int) : unit
    MemoryStream(buffer: byte [], index: int, count: int, writable: bool) : unit
    MemoryStream(buffer: byte [], index: int, count: int, writable: bool, publiclyVisible: bool) : unit
    -
    type Encoding =
      member BodyName : string
      member Clone : unit -> obj
      member CodePage : int
      member DecoderFallback : DecoderFallback with get, set
      member EncoderFallback : EncoderFallback with get, set
      member EncodingName : string
      member Equals : value:obj -> bool
      member GetByteCount : chars:char[] -> int + 3 overloads
      member GetBytes : chars:char[] -> byte[] + 5 overloads
      member GetCharCount : bytes:byte[] -> int + 2 overloads
      ...

    Full name: System.Text.Encoding
    -
    property Encoding.UTF8: Encoding
    -
    Encoding.GetBytes(s: string) : byte []
    Encoding.GetBytes(chars: char []) : byte []
    Encoding.GetBytes(chars: char [], index: int, count: int) : byte []
    Encoding.GetBytes(chars: nativeptr<char>, charCount: int, bytes: nativeptr<byte>, byteCount: int) : int
    Encoding.GetBytes(s: string, charIndex: int, charCount: int, bytes: byte [], byteIndex: int) : int
    Encoding.GetBytes(chars: char [], charIndex: int, charCount: int, bytes: byte [], byteIndex: int) : int
    -
    type Stream =
      inherit MarshalByRefObject
      member BeginRead : buffer:byte[] * offset:int * count:int * callback:AsyncCallback * state:obj -> IAsyncResult
      member BeginWrite : buffer:byte[] * offset:int * count:int * callback:AsyncCallback * state:obj -> IAsyncResult
      member CanRead : bool
      member CanSeek : bool
      member CanTimeout : bool
      member CanWrite : bool
      member Close : unit -> unit
      member CopyTo : destination:Stream -> unit + 1 overload
      member Dispose : unit -> unit
      member EndRead : asyncResult:IAsyncResult -> int
      ...

    Full name: System.IO.Stream
    -
    val __ : MyFileSystem
    -
    override MyFileSystem.FileStreamCreateShim : fileName:'a1 -> 'a2

    Full name: Filesystem.MyFileSystem.FileStreamCreateShim
    -
    val fileName : 'a1
    -
    override MyFileSystem.IsStableFileHeuristic : fileName:'s -> 't

    Full name: Filesystem.MyFileSystem.IsStableFileHeuristic
    -
    val fileName : 's
    -
    override MyFileSystem.FileStreamWriteExistingShim : fileName:'q -> 'r

    Full name: Filesystem.MyFileSystem.FileStreamWriteExistingShim
    -
    val fileName : 'q
    -
    override MyFileSystem.ReadAllBytesShim : fileName:obj -> 'p

    Full name: Filesystem.MyFileSystem.ReadAllBytesShim
    -
    override MyFileSystem.GetTempPathShim : unit -> 'o

    Full name: Filesystem.MyFileSystem.GetTempPathShim
    -
    override MyFileSystem.GetLastWriteTimeShim : fileName:'m -> 'n

    Full name: Filesystem.MyFileSystem.GetLastWriteTimeShim
    -
    val fileName : 'm
    -
    override MyFileSystem.GetFullPathShim : fileName:'k -> 'l

    Full name: Filesystem.MyFileSystem.GetFullPathShim
    -
    val fileName : 'k
    -
    override MyFileSystem.IsInvalidPathShim : fileName:'i -> 'j

    Full name: Filesystem.MyFileSystem.IsInvalidPathShim
    -
    val fileName : 'i
    -
    override MyFileSystem.IsPathRootedShim : fileName:'g -> 'h

    Full name: Filesystem.MyFileSystem.IsPathRootedShim
    -
    val fileName : 'g
    -
    override MyFileSystem.SafeExists : fileName:obj -> bool

    Full name: Filesystem.MyFileSystem.SafeExists
    -
    IDictionary.ContainsKey(key: obj) : bool
    -
    override MyFileSystem.FileDelete : fileName:'e -> 'f

    Full name: Filesystem.MyFileSystem.FileDelete
    -
    val fileName : 'e
    -
    override MyFileSystem.AssemblyLoadFrom : fileName:'c -> 'd

    Full name: Filesystem.MyFileSystem.AssemblyLoadFrom
    -
    val fileName : 'c
    -
    override MyFileSystem.AssemblyLoad : assemblyName:'a -> 'b

    Full name: Filesystem.MyFileSystem.AssemblyLoad
    -
    val assemblyName : 'a
    -
    val myFileSystem : MyFileSystem

    Full name: Filesystem.myFileSystem
    -
    namespace FSharp.Compiler.SourceCodeServices
    -
    val checker : FSharpChecker

    Full name: Filesystem.checker
    -
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    -
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    -
    val projectOptions : FSharpProjectOptions

    Full name: Filesystem.projectOptions
    -
    val allFlags : string []
    -
    val references : string list
    -
    union case Option.None: Option<'T>
    -
    Multiple items
    type DateTime =
      struct
        new : ticks:int64 -> DateTime + 10 overloads
        member Add : value:TimeSpan -> DateTime
        member AddDays : value:float -> DateTime
        member AddHours : value:float -> DateTime
        member AddMilliseconds : value:float -> DateTime
        member AddMinutes : value:float -> DateTime
        member AddMonths : months:int -> DateTime
        member AddSeconds : value:float -> DateTime
        member AddTicks : value:int64 -> DateTime
        member AddYears : value:int -> DateTime
        ...
      end

    Full name: System.DateTime

    --------------------
    DateTime()
       (+0 other overloads)
    DateTime(ticks: int64) : unit
       (+0 other overloads)
    DateTime(ticks: int64, kind: DateTimeKind) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) : unit
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) : unit
       (+0 other overloads)
    -
    property DateTime.Now: DateTime
    -
    val results : obj

    Full name: Filesystem.results
    -
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/fsharp-readme.html b/docs/ja/fsharp-readme.html deleted file mode 100644 index 39ade0ac38..0000000000 --- a/docs/ja/fsharp-readme.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - F# コンパイラのREADME - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    F# コンパイラのREADME

    -
    -

    注意: このreadmeファイルはF# コンパイラソースコード -(github.com/fsharp/fsharp) -に付属していたオリジナルのファイルのコピーです。 -F# Compiler Servicesプロジェクトは元々F# Compilerプロジェクトから派生したもので、 -いくつかのサービスを公開するために若干の変更が加えられています。 -ここに含まれるreadmeファイルは参考程度にとどめてください。

    -
    -

    このプロジェクトには(オープンソース版の)F# コンパイラ、コアライブラリ、コアツールが含まれます。 -いずれもMITライセンスが適用されます。 -master ブランチは最新バージョンのF#(現時点ではF# 3.0)に対応します。 -なおコンパイラをブートストラップするために、 -このプロジェクトの以前のバージョンでビルドされたバイナリが使用されます。

    -

    必須要件

    -

    Mono 2.9以上のバージョンが必要です。Mono 3.0が推奨されます。

    -

    OS Xの場合、automake 2.69が必要です。 -homebrew 経由でインストールする場合は -以下のようにします:

    - -
    1: 
-
    brew install automake
-
    -

    ビルド

    -

    Linuxおよびその他のUnixシステムの場合

    -

    通常の手順は以下の通りです:

    - -
    1: 
-2: 
-3: 
-
    ./autogen.sh
-make
-sudo make install
-
    -

    デフォルトでは最適化されたバイナリが生成されます。 -デバッグ版をビルドする場合は make CONFIG=debug とします。

    -

    MacOS (OSX)の場合

    -

    Monoのバージョンを指定するprefixを設定します:

    - -
    1: 
-2: 
-3: 
-
    ./autogen.sh --prefix=/Library/Frameworks/Mono.framework/Versions/Current/
-make
-sudo make install
-
    -

    デフォルトでは最適化されたバイナリが生成されます。 -デバッグ版をビルドする場合は make CONFIG=debug とします。

    -

    Windows上でmsbuildを使用する(つまり.NETがインストールされている)場合

    -

    VS2010がインストールされておらず、VS2012しかインストールされていない場合には -F# 2.0 ランタイム -のインストールが必要です:

    - -
    1: 
-2: 
-3: 
-4: 
-5: 
-
    cd src
-msbuild fsharp-proto-build.proj
-ngen install ..\lib\proto\4.0\fsc-proto.exe (optional)
-msbuild fsharp-library-build.proj /p:Configuration=Release
-msbuild fsharp-compiler-build.proj /p:Configuration=Release
-
    -

    また、.NET 2.0やMono 2.1、MonoTouch、Silverlight 5.0、 -Windows Phone 7.1、ポータブルプロファイル47(.NET4.5+Silverlight5+Windows8)、 -ポータブルプロファイル88(.NET4+Silverlight4+WindowsPhone7.1+Windows8)、 -Xbox 360用XNA 4.0のプロファイルに対応するFSharp.Coreをビルドすることもできます:

    - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-
    msbuild fsharp-library-build.proj /p:TargetFramework=net20 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=mono21 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=monotouch /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=portable-net45+sl5+win8 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=portable-net4+sl4+wp71+win8 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=sl5 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=wp7 /p:Configuration=Release
-msbuild fsharp-library-build.proj /p:TargetFramework=net40-xna40-xbox360 /p:Configuration=Release
-
    -

    Silverlight 5.0用にFSharp.CoreとFSharp.Compiler.Silverlight.dll -をビルドすることもできます:

    - -
    1: 
-2: 
-
    msbuild fsharp-library-build.proj /p:TargetFramework=sl5-compiler  /p:Configuration=Release
-msbuild fsharp-compiler-build.proj /p:TargetFramework=sl5-compiler /p:Configuration=Release
-
    -

    デバッグ版バイナリを出力する場合は /p:Configuration=Debug に変更します。

    -

    Windows上でxbuildを使用する(つまり.NETがインストールされておらず、Mono 3.0だけがインストールされている)場合

    - -
    1: 
-2: 
-3: 
-4: 
-
    cd src
-xbuild fsharp-proto-build.proj
-xbuild fsharp-library-build.proj
-xbuild fsharp-compiler-build.proj
-
    -

    xbuildを使用したビルドはMono準拠の公開用バイナリ生成にはまだ対応していないため -(src/fsharp/targets.make を参照)、個人的な使用にとどめ、 -公開用のビルドには使用してはいけません。

    -

    厳密名

    -

    生成されたFSharp.Core.dllには遅延署名だけが行われます -(Monoでは厳密名が必須ではありません)。 -厳密名で署名されたFSharp.Core.dllが必要であれば以下を使用してください:

    - -
    1: 
-
    lib\bootstrap\signed\3.0\v4.0\FSharp.Core.dll
-
    -

    生成されるファイル

    -

    ビルドが完了すると、メインのコンパイラバイナリは以下の場所に生成されます:

    - -
    1: 
-
    lib/release/4.0
-
    -

    .NET 2.0やMonoAndroid、MonoTouch(Monoプロファイル2.1)は以下の場所に生成されます:

    - -
    1: 
-2: 
-3: 
-
    lib/release/2.0
-lib/release/2.1
-lib/release/2.1monotouch
-
    -

    make install　を実行した場合のプレフィックスは以下のようになります:

    - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-
    /Library/Frameworks/Mono.framework/Versions/Current/lib/mono/2.0/FSharp.Core.dll
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/2.1/FSharp.Core.dll
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.0/fsc.exe
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.0/FSharp.Compiler.dll
-...
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.5/fsc.exe
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.5/FSharp.Compiler.dll
-...
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/gac/.../FSharp.Compiler.dll
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/gac/.../FSharp.Compiler.dll
-...
-
    -

    またxbuildをサポートする場合は以下のプレフィックスになります:

    - -
    1: 
-2: 
-
    /Library/Frameworks/Mono.framework/Versions/Current/lib/mono/Microsoft\ F#/v4.0/*
-/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/Microsoft\ SDKs/F#/3.0/Framework/*
-
    -

    (これらの名前はVisual Studio由来のプロジェクトファイルで使用されている -Microsoft.FSharp.Targetsファイル内における正式名です)

    -

    また、以下のスクリプトが配置されます:

    - -
    1: 
-2: 
-
    /usr/bin/fsharpc   (F# コンパイラ)
-/usr/bin/fsharpi   (F# Interactive)
-
    -

    開発者用メモ

    -

    継続的インテグレーションビルド

    -

    このプロジェクトはJetBrains/Teamcityサーバー上において、 -F#コミュニティプロジェクトの一部として継続的インテグレーション -(CI:continuous integration)ビルドが行われています:

    -

    http://teamcity.codebetter.com/project.html?projectId=project61&tab=projectOverview

    -

    主な管理者は @forki です。 -今のところMono用に'make' installと、 -Windows用に 'cd src; msbuild fsharp-build.proj' のビルドが行われています。 -ビルドされたバイナリは保存されておらず、 -単にサニティチェックだけが対象になっています。

    -

    Visual StudioまたはMonoDevelop上でコンパイラを編集する

    -

    all-vs2012.sln を開いてモードをDebugまたはReleaseに設定します。 -コンパイラはコンパイル中でも気を利かせてワークフローに若干介入することがあるため、 -実際にコンパイルを実行するには上記にあるようなコマンドライン経由で -コンパイルするとよいでしょう。

    -

    MonoDevelopでサポートされているF#ではプロセス内バックグラウンドコンパイラが -使用されます。 -Mac上ではこれが原因でガベージコレクションを止めることがあり、 -MonoDevelop上でのコンパイラの編集がしづらくなる場合があります。

    -

    .NET 4.x用にF# Coreの単体テストをビルドする(省略可)

    -

    このプロジェクトでは、 FSharp.Core.dll や FSharp.Compiler.dll の一部を -チェックする単体テストをビルドするためにprotoコンパイラを使用しています。 -また、 tests\fsharp 以下にもいくつかのテストがあります。

    - -
    1: 
-
    msbuild fsharp-library-unittests-build.proj /p:TargetFramework=net40
-
    -

    注意: 単体テストをビルドする場合、NUnitをインストールしておく必要があります。

    -

    検証および使用方法

    -

    ビルドされたバイナリを簡単に検証するには、以下のようにして fsi.exe -(F# Interactive) を起動してみるとよいでしょう:

    - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-
    lib\debug\4.0\fsi.exe
-1 + 1;;
-\#q;;
-lib\debug\4.0\fsi.exe /help
-lib\debug\4.0\fsc.exe /help
-echo printfn "hello world" > hello.fs
-lib\debug\4.0\fsc.exe hello.fs
-hello.exe
-
    -

    (Windows上で)コンパイラのテストを実行する

    -

    tests\fsharp\core 以下には言語機能のテストがあります。 -テスト機構は素朴なもので、残念なことにバッチファイルを使用しています。 -これらのテストをWindows上で実行するには以下のようにします:

    - -
    1: 
-2: 
-
    cd ..\tests\fsharp\core
-..\..\build-and-run-all-installed-ilx-configs.bat results.log
-
    -

    それぞれのテストディレクトリには1つのテスト結果ファイルが生成され、 -発生したエラーも記録されます。

    - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
    tests\fsharp\core
-tests\fsharp\core\queriesCustomQueryOps
-tests\fsharp\core\queriesLeafExpressionConvert
-tests\fsharp\core\queriesNullableOperators
-tests\fsharp\core\queriesOverIEnumerable
-...
-
    -

    LINQクエリに対するいくつかのテストではSQL Serverのインストールが必要です。 -テストが失敗すると、たとえば以下のように出力されます:

    - -
    1: 
-
    ERRORLEVEL=1: in tests\fsharp\core\csfromfs\build.bat
-
    -

    この場合、関連するディレクトリに移動した後、 -build.bat および run.bat を実行します。

    -

    歴史

    -

    Microsoftから公開されたF#コンパイラのソースは -fsharppowerpack.codeplex.com にあります。

    -

    ブートストラップ用ライブラリ、ツール、F#コンパイラが利用できます。 -lib/bootstrap/X.0 ディレクトリにはMonoビルド用ライブラリやコンパイラ、 -ビルドをブートストラップするために使用するツールなどが含まれています。 -ブートストラップを独自に指定する場合は --with-bootstrap オプションを使用します。

    - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/index.html b/docs/ja/index.html deleted file mode 100644 index c90e26b5ad..0000000000 --- a/docs/ja/index.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - F# コンパイラサービス - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    F# コンパイラサービス

    -

    F# コンパイラサービスパッケージはF# コンパイラのソースコードから派生したコンポーネントです。 -このソースコードにはF# 言語バインディングを実装するための機能や、 -コンパイラやリファクタリングツールを元にしたツールを作成するための機能が追加されています。 -また、パッケージには自身のアプリケーションにF# スクリプトを埋め込む際に利用できるような -F# インタラクティブサービスも含まれています。

    -
    -
    -
    -
    - F# コンパイラサービスパッケージは NuGet経由でインストールできます: - 
    PM> Install-Package FSharp.Compiler.Service
    -
    -
    -
    -
    -

    利用可能なサービス

    -

    プロジェクトには現在以下のサービスがあり、いずれもテストされ、 -このページから参照可能なドキュメントがあります。 -ライブラリには他にも使用可能な公開APIがありますが、 -ここではドキュメント化されていません。

    -
      -
    • -

      F# 言語トークナイザ - F#ソースコードをトークンのストリームへと変換します。 -この機能はソースコードを色つき表示したり、基本的なツールを作成するような場合に有効です。 -ネストされたコメントや文字列なども適切に処理できます。

      -
      • -
    • -

      型無しASTの処理 - この機能を使うことで型無し抽象構文木(AST: abstract syntax tree)にアクセスできます。 -型無しASTとは型情報を含まない解析済みのF#の文法を表すもので、 -コードフォーマットやその他様々な単純処理に利用できます。

      -
      • -
    • -

      エディタ (IDE) サービスの使用 - 自動補完やツールチップ、 -引数の情報などを表示するための機能があります。 -この機能を使うと、F#サポート機能をエディタに追加したり、F#コードから -何らかの型情報を取得したりすることができるようになります。

      -
      • -
    • -

      シグネチャや型、解決済みのシンボルの処理 - -解決済みのシンボルや推測された型の表現、アセンブリ全体のシグネチャなどを -型のチェック時に返すような多数のサービスがあります。

      -
      • -
    • -

      複数プロジェクトやプロジェクト全体の処理 - -すべてのプロジェクトに対するチェックを実行することにより、 -プロジェクト全体の解析結果を使って[すべての参照の検索] のような -機能を実現できます。

      -
      • -
    • -

      F# Interactive のホスティング - 自身の.NETコードから -F# Interactiveを.NETライブラリとして呼び出すことができるようになります。 -このAPIを使用すると、自身のプロジェクト内でF#をスクリプト言語として -埋め込むことができるようになります。

      -
      • -
    • -

      F#コンパイラのホスティング - F# コンパイラを -呼び出すコードを組み込むことができます。

      -
      • -
    • -

      ファイルシステムAPI - FSharp.Compiler.Service コンポーネントには -ファイルシステムを表すグローバル変数が定義されています。 -この変数を設定することによって、ファイルシステムが使用できない状況であっても -コンパイラをホストすることができるようになります。

      -
      • -
    -
    -

    注釈: FSharp.Compiler.Service.dll には既存のものと重複する機能が多数あるため、 -将来的にはもっときちんとした形に変更されます。 -そのため、これらのサービスを使用するAPIには破壊的変更が加えられる可能性があります。

    -
    -

    貢献および著作権について

    -

    このプロジェクトは fsharp/fsharp からフォークしたもので、 -そこへさらにエディタやF#用ツール、F# Interactiveの組み込みに必要となる機能を -追加したものです。

    -

    F# ソースコードの著作権はMicrosoft Corporationおよび貢献者に、 -拡張機能の著作権は Dave Thomas, Anh-Dung Phan, Tomas Petricek および -その他の貢献者にあります。 -ソースコードは MIT ライセンス の元に公開されています。

    - - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/interactive.html b/docs/ja/interactive.html deleted file mode 100644 index ac574f2bd0..0000000000 --- a/docs/ja/interactive.html +++ /dev/null @@ -1,550 +0,0 @@ - - - - - インタラクティブサービス: F# Interactiveの組み込み - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    インタラクティブサービス: F# Interactiveの組み込み

    -

    このチュートリアルでは、独自のアプリケーションに -F# Interactiveを組み込む方法について紹介します。 -F# Interactiveは対話式のスクリプティング環境で、 -F#コードを高度に最適化されたILコードへとコンパイルしつつ、 -それを即座に実行することができます。 -F# Interactiveサービスを使用すると、独自のアプリケーションに -F#の評価機能を追加できます。

    -
    -

    注意: F# Interactiveは様々な方法で組み込むことができます。 -最も簡単な方法は fsi.exe プロセスとの間で標準入出力経由でやりとりする方法です。 -このチュートリアルではF# Interactiveの機能を.NET APIで -直接呼び出す方法について紹介します。 -ただし入力用のコントロールを備えていない場合、別プロセスでF# Interactiveを -起動するのはよい方法だといえます。 -理由の1つとしては StackOverflowException を処理する方法がないため、 -出来の悪いスクリプトによってはホストプロセスが停止させられてしまう -場合があるからです。 -.NET APIを通じてF# Interactiveを呼び出すとしても、 --shadowcopyreferences -オプションは無視されることを覚えておきましょう。 -詳細な議論については、このスレッド -に目を通してみてください。 -注意: もしFSharp.Core.dll が見つからないというエラーが出て FsiEvaluationSession.Create -に失敗した場合、 FSharp.Core.sigdata と FSharp.Core.optdata というファイルを追加してください。 -詳しい内容はこちら -にあります。

    -
    -

    しかしそれでもF# InteractiveサービスにはF# Interactiveを実行ファイルに埋め込んで -実行出来る(そしてアプリケーションの各機能とやりとり出来る)、あるいは -機能限定されたF#コード(たとえば独自のDSLによって生成されたコード)だけを -実行させることが出来るという便利さがあります。

    -

    F# Interactiveの開始

    -

    まずF# Interactiveサービスを含むライブラリへの参照を追加します:

    - - - -
    1: 
-2: 
-3: 
-
    #r "FSharp.Compiler.Service.dll"
-open FSharp.Compiler.SourceCodeServices
-open FSharp.Compiler.Interactive.Shell
-
    -

    F# Interactiveとやりとりするには、入出力を表すストリームを作成する必要があります。 -これらのストリームを使用することで、 -いくつかのF#コードに対する評価結果を後から出力することができます:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-
    open System
-open System.IO
-open System.Text
-
-// 入出力のストリームを初期化
-let sbOut = new StringBuilder()
-let sbErr = new StringBuilder()
-let inStream = new StringReader("")
-let outStream = new StringWriter(sbOut)
-let errStream = new StringWriter(sbErr)
-
-// コマンドライン引数を組み立てて、FSIセッションを開始する
-let argv = [| "C:\\fsi.exe" |]
-let allArgs = Array.append argv [|"--noninteractive"|]
-
-let fsiConfig = FsiEvaluationSession.GetDefaultConfiguration()
-let fsiSession = FsiEvaluationSession.Create(fsiConfig, allArgs, inStream, outStream, errStream)  
-
    -

    コードの評価および実行

    -

    F# Interactiveサービスにはコードを評価するためのメソッドがいくつか用意されています。 -最初の1つは EvalExpression で、式を評価してその結果を返します。 -結果には戻り値が( obj として)含まれる他、値に対して静的に推論された型も含まれます:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-
    /// 式を評価して結果を返す
-let evalExpression text =
-  match fsiSession.EvalExpression(text) with
-  | Some value -> printfn "%A" value.ReflectionValue
-  | None -> printfn "結果が得られませんでした！"
-
    -

    これは引数に文字列を取り、それをF#コードとして評価(つまり実行)します。

    - - - -
    1: 
-
    evalExpression "42+1" // '43' を表示する
-
    -

    これは以下のように強く型付けされた方法で使うことができます:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
    /// 式を評価して、強く型付けされた結果を返す
-let evalExpressionTyped<'T> (text) =
-    match fsiSession.EvalExpression(text) with
-    | Some value -> value.ReflectionValue |> unbox<'T>
-    | None -> failwith "結果が得られませんでした！"
-
-evalExpressionTyped<int> "42+1"  // '43' になる
-
    -

    EvalInteraction メソッドは画面出力機能や宣言、 -F#の式としては不正なものの、F# Interactiveコンソールには入力できるようなものなど、 -副作用を伴う命令を評価する場合に使用できます。 -たとえば #time "on" (あるいはその他のディレクティブ)や open System 、 -その他の宣言やトップレベルステートメントなどが該当します。 -指定するコードの終端に ;; を入力する必要はありません。 -実行したいコードだけを入力します:

    - - - -
    1: 
-
    fsiSession.EvalInteraction "printfn \"bye\""
-
    -

    EvalScript メソッドを使用すると、完全な .fsx スクリプトを評価することができます。

    - - - -
    1: 
-2: 
-
    File.WriteAllText("sample.fsx", "let twenty = 10 + 10")
-fsiSession.EvalScript "sample.fsx"
-
    -

    例外処理

    -

    コードに型チェックの警告やエラーがあった場合、または評価して例外で失敗した場合、 -EvalExpression 、 EvalInteraction そして EvalScript ではあまりうまく処理されません。 -これらのケースでは、 EvalExpressionNonThrowing 、 EvalInteractionNonThrowing -そして EvalScriptNonThrowing を使うことが出来ます。 -これらは結果と FSharpErrorInfo 値の配列の組を返します。 -これらはエラーと警告を表します。結果の部分は実際の結果と例外のいずれかを表す -Choice<_,_> です。

    -

    EvalExpression および EvalExpressionNonThrowing の結果部分は -オプションの FSharpValue 値です。 -その値が存在しない場合、式が .NET オブジェクトとして表現できる具体的な結果を -持っていなかったということを指し示しています。 -この状況は実際には入力されたどんな通常の式に対しても発生すべきではなく、 -ライブラリ内で使われるプリミティブ値に対してのみ発生すべきです。

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
    File.WriteAllText("sample.fsx", "let twenty = 'a' + 10.0")
-let result, warnings = fsiSession.EvalScriptNonThrowing "sample.fsx"
-
-// 結果を表示する
-match result with 
-| Choice1Of2 () -> printfn "チェックと実行はOKでした"
-| Choice2Of2 exn -> printfn "実行例外: %s" exn.Message
-
    -

    は次のようになります:

    - - - -
    1: 
-
    実行例外: Operation could not be completed due to earlier error
-
    - - - -
    1: 
-2: 
-3: 
-
    // エラーと警告を表示する
-for w in warnings do 
-   printfn "警告 %s 場所 %d,%d" w.Message w.StartLineAlternate w.StartColumn
-
    -

    は次のようになります:

    - - - -
    1: 
-2: 
-
    警告 The type 'float' does not match the type 'char' 場所 1,19
-警告 The type 'float' does not match the type 'char' 場所 1,17
-
    -

    式に対しては:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-
    let evalExpressionTyped2<'T> text =
-   let res, warnings = fsiSession.EvalExpressionNonThrowing(text)
-   for w in warnings do 
-       printfn "警告 %s 場所 %d,%d" w.Message w.StartLineAlternate w.StartColumn 
-   match res with 
-   | Choice1Of2 (Some value) -> value.ReflectionValue |> unbox<'T>
-   | Choice1Of2 None -> failwith "null または結果がありません"
-   | Choice2Of2 (exn:exn) -> failwith (sprintf "例外 %s" exn.Message)
-
-evalExpressionTyped2<int> "42+1"  // '43' になる
-
    -

    並列実行

    -

    デフォルトでは EvalExpression に渡したコードは即時実行されます。 -並列に実行するために、タスクを開始する計算を投入します:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-
    open System.Threading.Tasks
-
-let sampleLongRunningExpr = 
-    """
-async { 
-    // 実行したいコード
-    do System.Threading.Thread.Sleep 5000
-    return 10 
-}
-  |> Async.StartAsTask"""
-
-let task1 = evalExpressionTyped<Task<int>>(sampleLongRunningExpr)  
-let task2 = evalExpressionTyped<Task<int>>(sampleLongRunningExpr)
-
    -

    両方の計算がいま開始しました。結果を取得することが出来ます:

    - - - -
    1: 
-2: 
-
    task1.Result // 完了後に結果が出てくる (最大5秒)
-task2.Result // 完了後に結果が出てくる (最大5秒)
-
    -

    評価コンテキスト内での型チェック

    -

    F# Interactiveの一連のスクリプティングセッション中で -コードの型チェックを実行したいような状況を考えてみましょう。 -たとえばまず宣言を評価します:

    - - - -
    1: 
-
    fsiSession.EvalInteraction "let xxx = 1 + 1"
-
    -

    次に部分的に完全な xxx + xx というコードの型チェックを実行したいとします:

    - - - -
    1: 
-2: 
-
    let parseResults, checkResults, checkProjectResults = 
-    fsiSession.ParseAndCheckInteraction("xxx + xx") |> Async.RunSynchronously
-
    -

    parseResults と checkResults はそれぞれ エディタ -のページで説明している ParseFileResults と CheckFileResults 型です。 -たとえば以下のようなコードでエラーを確認出来ます:

    - - - -
    1: 
-
    checkResults.Errors.Length // 1
-
    -

    コードはF# Interactiveセッション内において、その時点までに実行された -有効な宣言からなる論理的な型コンテキストと結びつく形でチェックされます。

    -

    また、宣言リスト情報やツールチップテキスト、シンボルの解決といった処理を -要求することもできます:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
    open FSharp.Compiler
-
-// ツールチップを取得する
-checkResults.GetToolTipText(1, 2, "xxx + xx", ["xxx"], FSharpTokenTag.IDENT) 
-
-checkResults.GetSymbolUseAtLocation(1, 2, "xxx + xx", ["xxx"]) // シンボル xxx
-  
-
    -

    'fsi'オブジェクト

    -

    スクリプトのコードが'fsi'オブジェクトにアクセスできるようにしたい場合、 -このオブジェクトの実装を明示的に渡さなければなりません。 -通常、FSharp.Compiler.Interactive.Settings.dll由来の1つが使われます。

    - - - -
    1: 
-
    let fsiConfig2 = FsiEvaluationSession.GetDefaultConfiguration(fsi)
-
    -

    収集可能なコード生成

    -

    FsiEvaluationSessionを使用してコードを評価すると、 -.NET の動的アセンブリを生成し、他のリソースを使用します。 -collectible=true を渡すことで、生成されたコードを収集可能に出来ます。 -しかしながら、例えば EvalExpression から返される FsiValue のような型を必要とする未解放のオブジェクト参照が無く、 -かつ FsiEvaluationSession を破棄したに違いない場合に限ってコードが収集されます。 -収集可能なアセンブリに対する制限 -も参照してください。

    -

    以下の例は200個の評価セッションを生成しています。 collectible=true と use session = ... -の両方を使っていることに気をつけてください。

    -

    収集可能なコードが正しく動いた場合、全体としてのリソース使用量は -評価が進んでも線形には増加しないでしょう。

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-
    let collectionTest() = 
-
-    for i in 1 .. 200 do
-        let defaultArgs = [|"fsi.exe";"--noninteractive";"--nologo";"--gui-"|]
-        use inStream = new StringReader("")
-        use outStream = new StringWriter()
-        use errStream = new StringWriter()
-
-        let fsiConfig = FsiEvaluationSession.GetDefaultConfiguration()
-        use session = FsiEvaluationSession.Create(fsiConfig, defaultArgs, inStream, outStream, errStream, collectible=true)
-        
-        session.EvalInteraction (sprintf "type D = { v : int }")
-        let v = session.EvalExpression (sprintf "{ v = 42 * %d }" i)
-        printfn "その %d, 結果 = %A" i v.Value.ReflectionValue
-
-// collectionTest()  <-- このようにテストを実行する
-
    - -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    -
    namespace FSharp.Compiler
    -
    namespace FSharp.Compiler.SourceCodeServices
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>

    Full name: FSharp.Compiler.SourceCodeServices.FSharpAttribute
    -
    namespace FSharp.Compiler.Interactive
    -
    module Shell

    from FSharp.Compiler.Interactive
    -
    namespace System
    -
    namespace System.IO
    -
    namespace System.Text
    -
    val sbOut : StringBuilder

    Full name: Interactive.sbOut
    -
    Multiple items
    type StringBuilder =
      new : unit -> StringBuilder + 5 overloads
      member Append : value:string -> StringBuilder + 18 overloads
      member AppendFormat : format:string * arg0:obj -> StringBuilder + 4 overloads
      member AppendLine : unit -> StringBuilder + 1 overload
      member Capacity : int with get, set
      member Chars : int -> char with get, set
      member Clear : unit -> StringBuilder
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EnsureCapacity : capacity:int -> int
      member Equals : sb:StringBuilder -> bool
      ...

    Full name: System.Text.StringBuilder

    --------------------
    StringBuilder() : unit
    StringBuilder(capacity: int) : unit
    StringBuilder(value: string) : unit
    StringBuilder(value: string, capacity: int) : unit
    StringBuilder(capacity: int, maxCapacity: int) : unit
    StringBuilder(value: string, startIndex: int, length: int, capacity: int) : unit
    -
    val sbErr : StringBuilder

    Full name: Interactive.sbErr
    -
    val inStream : StringReader

    Full name: Interactive.inStream
    -
    Multiple items
    type StringReader =
      inherit TextReader
      new : s:string -> StringReader
      member Close : unit -> unit
      member Peek : unit -> int
      member Read : unit -> int + 1 overload
      member ReadLine : unit -> string
      member ReadToEnd : unit -> string

    Full name: System.IO.StringReader

    --------------------
    StringReader(s: string) : unit
    -
    val outStream : StringWriter

    Full name: Interactive.outStream
    -
    Multiple items
    type StringWriter =
      inherit TextWriter
      new : unit -> StringWriter + 3 overloads
      member Close : unit -> unit
      member Encoding : Encoding
      member GetStringBuilder : unit -> StringBuilder
      member ToString : unit -> string
      member Write : value:char -> unit + 2 overloads

    Full name: System.IO.StringWriter

    --------------------
    StringWriter() : unit
    StringWriter(formatProvider: IFormatProvider) : unit
    StringWriter(sb: StringBuilder) : unit
    StringWriter(sb: StringBuilder, formatProvider: IFormatProvider) : unit
    -
    val errStream : StringWriter

    Full name: Interactive.errStream
    -
    val argv : string []

    Full name: Interactive.argv
    -
    val allArgs : string []

    Full name: Interactive.allArgs
    -
    type Array =
      member Clone : unit -> obj
      member CopyTo : array:Array * index:int -> unit + 1 overload
      member GetEnumerator : unit -> IEnumerator
      member GetLength : dimension:int -> int
      member GetLongLength : dimension:int -> int64
      member GetLowerBound : dimension:int -> int
      member GetUpperBound : dimension:int -> int
      member GetValue : [<ParamArray>] indices:int[] -> obj + 7 overloads
      member Initialize : unit -> unit
      member IsFixedSize : bool
      ...

    Full name: System.Array
    -
    val append : array1:'T [] -> array2:'T [] -> 'T []

    Full name: Microsoft.FSharp.Collections.Array.append
    -
    val fsiConfig : FsiEvaluationSessionHostConfig

    Full name: Interactive.fsiConfig
    -
    type FsiEvaluationSession =
      interface IDisposable
      member EvalExpression : code:string -> FsiValue option
      member EvalExpressionNonThrowing : code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
      member EvalInteraction : code:string -> unit
      member EvalInteractionNonThrowing : code:string -> Choice<unit,exn> * FSharpErrorInfo []
      member EvalScript : filePath:string -> unit
      member EvalScriptNonThrowing : filePath:string -> Choice<unit,exn> * FSharpErrorInfo []
      member FormatValue : reflectionValue:obj * reflectionType:Type -> string
      member GetCompletions : longIdent:string -> seq<string>
      member Interrupt : unit -> unit
      ...

    Full name: FSharp.Compiler.Interactive.Shell.FsiEvaluationSession
    -
    static member FsiEvaluationSession.GetDefaultConfiguration : unit -> FsiEvaluationSessionHostConfig
    static member FsiEvaluationSession.GetDefaultConfiguration : fsiObj:obj -> FsiEvaluationSessionHostConfig
    static member FsiEvaluationSession.GetDefaultConfiguration : fsiObj:obj * useFsiAuxLib:bool -> FsiEvaluationSessionHostConfig
    -
    val fsiSession : FsiEvaluationSession

    Full name: Interactive.fsiSession
    -
    static member FsiEvaluationSession.Create : fsiConfig:FsiEvaluationSessionHostConfig * argv:string [] * inReader:TextReader * outWriter:TextWriter * errorWriter:TextWriter * ?collectible:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver -> FsiEvaluationSession
    -
    val evalExpression : text:string -> unit

    Full name: Interactive.evalExpression


     式を評価して結果を返す
    -
    val text : string
    -
    member FsiEvaluationSession.EvalExpression : code:string -> FsiValue option
    -
    union case Option.Some: Value: 'T -> Option<'T>
    -
    val value : FsiValue
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    property FsiValue.ReflectionValue: obj
    -
    union case Option.None: Option<'T>
    -
    val evalExpressionTyped : text:string -> 'T

    Full name: Interactive.evalExpressionTyped


     式を評価して、強く型付けされた結果を返す
    -
    val unbox : value:obj -> 'T

    Full name: Microsoft.FSharp.Core.Operators.unbox
    -
    val failwith : message:string -> 'T

    Full name: Microsoft.FSharp.Core.Operators.failwith
    -
    Multiple items
    val int : value:'T -> int (requires member op_Explicit)

    Full name: Microsoft.FSharp.Core.Operators.int

    --------------------
    type int = int32

    Full name: Microsoft.FSharp.Core.int

    --------------------
    type int<'Measure> = int

    Full name: Microsoft.FSharp.Core.int<_>
    -
    member FsiEvaluationSession.EvalInteraction : code:string -> unit
    -
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 3 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      static member Encrypt : path:string -> unit
      static member Exists : path:string -> bool
      ...

    Full name: System.IO.File
    -
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Encoding) : unit
    -
    member FsiEvaluationSession.EvalScript : filePath:string -> unit
    -
    val result : Choice<unit,exn>

    Full name: Interactive.result
    -
    val warnings : FSharpErrorInfo []

    Full name: Interactive.warnings
    -
    member FsiEvaluationSession.EvalScriptNonThrowing : filePath:string -> Choice<unit,exn> * FSharpErrorInfo []
    -
    union case Choice.Choice1Of2: 'T1 -> Choice<'T1,'T2>
    -
    union case Choice.Choice2Of2: 'T2 -> Choice<'T1,'T2>
    -
    Multiple items
    val exn : exn

    --------------------
    type exn = Exception

    Full name: Microsoft.FSharp.Core.exn
    -
    property Exception.Message: string
    -
    val not : value:bool -> bool

    Full name: Microsoft.FSharp.Core.Operators.not
    -
    val w : FSharpErrorInfo
    -
    property FSharpErrorInfo.Message: string
    -
    property FSharpErrorInfo.StartLineAlternate: int
    -
    property FSharpErrorInfo.StartColumn: int
    -
    val evalExpressionTyped2 : text:string -> 'T

    Full name: Interactive.evalExpressionTyped2
    -
    val res : Choice<FsiValue option,exn>
    -
    val warnings : FSharpErrorInfo []
    -
    member FsiEvaluationSession.EvalExpressionNonThrowing : code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
    -
    val sprintf : format:Printf.StringFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.sprintf
    -
    namespace System.Threading
    -
    namespace System.Threading.Tasks
    -
    val sampleLongRunningExpr : string

    Full name: Interactive.sampleLongRunningExpr
    -
    val task1 : Task<int>

    Full name: Interactive.task1
    -
    Multiple items
    type Task =
      new : action:Action -> Task + 7 overloads
      member AsyncState : obj
      member ContinueWith : continuationAction:Action<Task> -> Task + 9 overloads
      member CreationOptions : TaskCreationOptions
      member Dispose : unit -> unit
      member Exception : AggregateException
      member Id : int
      member IsCanceled : bool
      member IsCompleted : bool
      member IsFaulted : bool
      ...

    Full name: System.Threading.Tasks.Task

    --------------------
    type Task<'TResult> =
      inherit Task
      new : function:Func<'TResult> -> Task<'TResult> + 7 overloads
      member ContinueWith : continuationAction:Action<Task<'TResult>> -> Task + 9 overloads
      member Result : 'TResult with get, set
      static member Factory : TaskFactory<'TResult>

    Full name: System.Threading.Tasks.Task<_>

    --------------------
    Task(action: Action) : unit
    Task(action: Action, cancellationToken: Threading.CancellationToken) : unit
    Task(action: Action, creationOptions: TaskCreationOptions) : unit
    Task(action: Action<obj>, state: obj) : unit
    Task(action: Action, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : unit
    Task(action: Action<obj>, state: obj, cancellationToken: Threading.CancellationToken) : unit
    Task(action: Action<obj>, state: obj, creationOptions: TaskCreationOptions) : unit
    Task(action: Action<obj>, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : unit

    --------------------
    Task(function: Func<'TResult>) : unit
    Task(function: Func<'TResult>, cancellationToken: Threading.CancellationToken) : unit
    Task(function: Func<'TResult>, creationOptions: TaskCreationOptions) : unit
    Task(function: Func<obj,'TResult>, state: obj) : unit
    Task(function: Func<'TResult>, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : unit
    Task(function: Func<obj,'TResult>, state: obj, cancellationToken: Threading.CancellationToken) : unit
    Task(function: Func<obj,'TResult>, state: obj, creationOptions: TaskCreationOptions) : unit
    Task(function: Func<obj,'TResult>, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : unit
    -
    val task2 : Task<int>

    Full name: Interactive.task2
    -
    property Task.Result: int
    -
    val parseResults : obj

    Full name: Interactive.parseResults
    -
    val checkResults : obj

    Full name: Interactive.checkResults
    -
    val checkProjectResults : obj

    Full name: Interactive.checkProjectResults
    -
    member FsiEvaluationSession.ParseAndCheckInteraction : code:string -> Async<FSharpParseFileResults * FSharpCheckFileResults * FSharpCheckProjectResults>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    module FSharpTokenTag

    from FSharp.Compiler.SourceCodeServices
    -
    val IDENT : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpTokenTag.IDENT
    -
    val fsiConfig2 : FsiEvaluationSessionHostConfig

    Full name: Interactive.fsiConfig2
    -
    val fsi : Compiler.Interactive.InteractiveSession

    Full name: Microsoft.FSharp.Compiler.Interactive.Settings.fsi
    -
    val collectionTest : unit -> unit

    Full name: Interactive.collectionTest
    -
    val i : int32
    -
    val defaultArgs : string []
    -
    val inStream : StringReader
    -
    val outStream : StringWriter
    -
    val errStream : StringWriter
    -
    val fsiConfig : FsiEvaluationSessionHostConfig
    -
    val session : FsiEvaluationSession
    -
    static member FsiEvaluationSession.Create : fsiConfig:FsiEvaluationSessionHostConfig * argv:string [] * inReader:TextReader * outWriter:TextWriter * errorWriter:TextWriter * ?collectible:bool * ?legacyReferenceResolver:ReferenceResolver.Resolver -> FsiEvaluationSession
    -
    val v : FsiValue option
    -
    property Option.Value: FsiValue
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/project.html b/docs/ja/project.html deleted file mode 100644 index 420b2b0066..0000000000 --- a/docs/ja/project.html +++ /dev/null @@ -1,549 +0,0 @@ - - - - - コンパイラサービス: プロジェクトの分析 - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    コンパイラサービス: プロジェクトの分析

    -

    このチュートリアルではF#コンパイラによって提供されるサービスを使用して -プロジェクト全体を分析する方法について紹介します。

    -
    -

    注意: 以下で使用しているAPIは試験的なもので、 -最新のnugetパッケージの公開に伴って変更されることがあります。

    -
    -

    プロジェクト全体の結果を取得する

    -

    以前の(型無しASTを使った)チュートリアル と同じく、 -まずは FSharp.Compiler.Service.dll への参照追加と、適切な名前空間のオープン、 -FSharpChecker インスタンスの作成を行います:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
    // F#コンパイラAPIへの参照
-#r "FSharp.Compiler.Service.dll"
-
-open System
-open System.Collections.Generic
-open FSharp.Compiler.SourceCodeServices
-
-// インタラクティブチェッカーのインスタンスを作成
-let checker = FSharpChecker.Create()
-
    -

    今回のサンプル入力は以下の通りです:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-33: 
-34: 
-35: 
-
    module Inputs = 
-    open System.IO
-
-    let base1 = Path.GetTempFileName()
-    let fileName1 = Path.ChangeExtension(base1, ".fs")
-    let base2 = Path.GetTempFileName()
-    let fileName2 = Path.ChangeExtension(base2, ".fs")
-    let dllName = Path.ChangeExtension(base2, ".dll")
-    let projFileName = Path.ChangeExtension(base2, ".fsproj")
-    let fileSource1 = """
-module M
-
-type C() = 
-    member x.P = 1
-
-let xxx = 3 + 4
-let fff () = xxx + xxx
-    """
-    File.WriteAllText(fileName1, fileSource1)
-
-    let fileSource2 = """
-module N
-
-open M
-
-type D1() = 
-    member x.SomeProperty = M.xxx
-
-type D2() = 
-    member x.SomeProperty = M.fff()
-
-// 警告を発生させる
-let y2 = match 1 with 1 -> M.xxx
-    """
-    File.WriteAllText(fileName2, fileSource2)
-
    -

    GetProjectOptionsFromCommandLineArgs を使用して、 -2つのファイルを1つのプロジェクトとして扱えるようにします:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-
    let projectOptions = 
-    checker.GetProjectOptionsFromCommandLineArgs
-       (Inputs.projFileName,
-        [| yield "--simpleresolution" 
-           yield "--noframework" 
-           yield "--debug:full" 
-           yield "--define:DEBUG" 
-           yield "--optimize-" 
-           yield "--out:" + Inputs.dllName
-           yield "--doc:test.xml" 
-           yield "--warn:3" 
-           yield "--fullpaths" 
-           yield "--flaterrors" 
-           yield "--target:library" 
-           yield Inputs.fileName1
-           yield Inputs.fileName2
-           let references = 
-             [ @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\mscorlib.dll" 
-               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.dll" 
-               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.Core.dll" 
-               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.0.0\FSharp.Core.dll"]  
-           for r in references do
-                 yield "-r:" + r |])
-
    -

    そして(ディスク上に保存されたファイルを使用して) -プロジェクト全体をチェックします:

    - - - -
    1: 
-
    let wholeProjectResults = checker.ParseAndCheckProject(projectOptions) |> Async.RunSynchronously
-
    -

    発生したエラーと警告は以下のようにしてチェックできます:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
    wholeProjectResults.Errors.Length // 1
-wholeProjectResults.Errors.[0].Message.Contains("Incomplete pattern matches on this expression") // true
-
-wholeProjectResults.Errors.[0].StartLineAlternate // 13
-wholeProjectResults.Errors.[0].EndLineAlternate // 13
-wholeProjectResults.Errors.[0].StartColumn // 15
-wholeProjectResults.Errors.[0].EndColumn // 16
-
    -

    推測されたプロジェクトのシグネチャをチェックします:

    - - - -
    1: 
-2: 
-3: 
-4: 
-
    [ for x in wholeProjectResults.AssemblySignature.Entities -> x.DisplayName ] // ["N"; "M"]
-[ for x in wholeProjectResults.AssemblySignature.Entities.[0].NestedEntities -> x.DisplayName ] // ["D1"; "D2"]
-[ for x in wholeProjectResults.AssemblySignature.Entities.[1].NestedEntities -> x.DisplayName ] // ["C"]
-[ for x in wholeProjectResults.AssemblySignature.Entities.[0].MembersFunctionsAndValues -> x.DisplayName ] // ["y2"]
-
    -

    プロジェクト内の全シンボルを取得することもできます:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-
    let rec allSymbolsInEntities (entities: IList<FSharpEntity>) = 
-    [ for e in entities do 
-          yield (e :> FSharpSymbol) 
-          for x in e.MembersFunctionsAndValues do
-             yield (x :> FSharpSymbol)
-          for x in e.UnionCases do
-             yield (x :> FSharpSymbol)
-          for x in e.FSharpFields do
-             yield (x :> FSharpSymbol)
-          yield! allSymbolsInEntities e.NestedEntities ]
-
-let allSymbols = allSymbolsInEntities wholeProjectResults.AssemblySignature.Entities
-
    -

    プロジェクト全体のチェックが完了した後は、 -プロジェクト内の各ファイルに対する個別の結果を取得することもできます。 -この処理は即座に完了し、改めてチェックが実行されることもありません。

    - - - -
    1: 
-2: 
-3: 
-
    let backgroundParseResults1, backgroundTypedParse1 = 
-    checker.GetBackgroundCheckResultsForFileInProject(Inputs.fileName1, projectOptions) 
-    |> Async.RunSynchronously
-
    -

    そしてそれぞれのファイル内にあるシンボルを解決できます:

    - - - -
    1: 
-2: 
-3: 
-
    let xSymbol = 
-    backgroundTypedParse1.GetSymbolUseAtLocation(9,9,"",["xxx"])
-    |> Async.RunSynchronously
-
    -

    それぞれのシンボルに対して、シンボルへの参照を検索することもできます:

    - - - -
    1: 
-
    let usesOfXSymbol = wholeProjectResults.GetUsesOfSymbol(xSymbol.Value.Symbol)
-
    -

    推測されたシグネチャ内にあるすべての定義済みシンボルに対して、 -それらがどこで使用されているのかを探し出すこともできます:

    - - - -
    1: 
-2: 
-3: 
-
    let allUsesOfAllSignatureSymbols = 
-    [ for s in allSymbols do 
-         yield s.ToString(), wholeProjectResults.GetUsesOfSymbol(s) ]
-
    -

    (ローカルスコープで使用されているものも含めて) -プロジェクト全体で使用されているすべてのシンボルを確認することもできます：

    - - - -
    1: 
-
    let allUsesOfAllSymbols = wholeProjectResults.GetAllUsesOfAllSymbols()
-
    -

    また、プロジェクト内のファイルに対して、更新後のバージョンに対して -チェックを実行するようにリクエストすることもできます -(なお FileSystem API を使用していない場合には、 -プロジェクト内のその他のファイルがまだディスクから -読み取り中であることに注意してください):

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-
    let parseResults1, checkAnswer1 = 
-    checker.ParseAndCheckFileInProject(Inputs.fileName1, 0, Inputs.fileSource1, projectOptions) 
-    |> Async.RunSynchronously
-
-let checkResults1 = 
-    match checkAnswer1 with 
-    | FSharpCheckFileAnswer.Succeeded x ->  x 
-    | _ -> failwith "想定外の終了状態です"
-
-let parseResults2, checkAnswer2 = 
-    checker.ParseAndCheckFileInProject(Inputs.fileName2, 0, Inputs.fileSource2, projectOptions)
-    |> Async.RunSynchronously
-
-let checkResults2 = 
-    match checkAnswer2 with 
-    | FSharpCheckFileAnswer.Succeeded x ->  x 
-    | _ -> failwith "想定外の終了状態です"
-
    -

    そして再びシンボルを解決したり、参照を検索したりすることができます:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-
    let xSymbol2 = 
-    checkResults1.GetSymbolUseAtLocation(9,9,"",["xxx"]) 
-    |> Async.RunSynchronously
-
-let usesOfXSymbol2 = wholeProjectResults.GetUsesOfSymbol(xSymbol2.Value.Symbol)
-
    -

    あるいは(ローカルスコープで使用されているシンボルも含めて) -ファイル中で使用されているすべてのシンボルを検索することもできます：

    - - - -
    1: 
-
    let allUsesOfAllSymbolsInFile1 = checkResults1.GetAllUsesOfAllSymbolsInFile()
-
    -

    あるいは特定のファイル中で使用されているシンボルを検索することもできます：

    - - - -
    1: 
-2: 
-3: 
-
    let allUsesOfXSymbolInFile1 = checkResults1.GetUsesOfSymbolInFile(xSymbol2.Value.Symbol)
-
-let allUsesOfXSymbolInFile2 = checkResults2.GetUsesOfSymbolInFile(xSymbol2.Value.Symbol)
-
    -

    複数プロジェクトの分析

    -

    複数のプロジェクトにまたがった参照があるような、 -複数のF# プロジェクトを分析したい場合、 -それらのプロジェクトを一旦ビルドして、 -ProjectOptionsで -r:プロジェクト-出力-までの-パス.dll 引数を指定して -プロジェクトの相互参照を設定すると一番簡単です。 -しかしこの場合、それぞれのプロジェクトが正しくビルド出来、 -DLLファイルが参照可能なディスク上に生成されなければいけません。

    -

    たとえばIDEを操作している場合など、状況によっては -DLLのコンパイルが通るようになる前に -プロジェクトを参照したいことがあるでしょう。 -この場合はProjectOptionsのReferencedProjectsを設定します。 -この値には依存するプロジェクトのオプションを再帰的に指定します。 -それぞれのプロジェクト参照にはやはり、 -ReferencedProjectsのエントリそれぞれに対応する --r:プロジェクト-出力-までの-パス.dll というコマンドライン引数を -ProjectOptionsに設定する必要があります。

    -

    プロジェクト参照が設定されると、ソースファイルからのF#プロジェクト分析処理が -インクリメンタル分析の結果を使用して行われるようになります。 -その際にはソースファイルファイルをDLLへとコンパイルする必要はありません。

    -

    相互参照を含むようなF#プロジェクトを効率よく分析するには、 -ReferencedProjectsを正しく設定した後、 -それぞれのプロジェクトを順番通りに分析していくとよいでしょう。

    -
    -

    注意： プロジェクトの参照機能は試作段階です。 -プロジェクトの参照を使用すると、依存先のプロジェクトがまだ分析中で、 -要求したサービスがまだ利用できないことがあるため、 -コンパイラサービスの性能が低下することがあります。 -注意： アセンブリが型プロバイダーのコンポーネントを含む場合、 -プロジェクト参照機能は利用できません。 -プロジェクトの分析処理を強制しない限りはプロジェクト参照を設定しても -効果がありません。 -また、分析を強制する場合にはディスク上にDLLが存在しなければいけません。

    -
    -

    まとめ

    -

    これまで説明してきた通り、 ParseAndCheckProject を使用すると -シンボルの参照などのようなプロジェクト全体の解析結果にアクセスできるようになります。 -シンボルに対する処理の詳細については シンボル のページを参照してください。

    - -
    namespace System
    -
    namespace System.Collections
    -
    namespace System.Collections.Generic
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    -
    namespace FSharp.Compiler
    -
    namespace FSharp.Compiler.SourceCodeServices
    -
    val checker : FSharpChecker

    Full name: Project.checker
    -
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    -
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    -
    namespace System.IO
    -
    val base1 : string

    Full name: Project.Inputs.base1
    -
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val InvalidPathChars : char[]
      static val PathSeparator : char
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string
      static member GetExtension : path:string -> string
      static member GetFileName : path:string -> string
      ...

    Full name: System.IO.Path
    -
    Path.GetTempFileName() : string
    -
    val fileName1 : string

    Full name: Project.Inputs.fileName1
    -
    Path.ChangeExtension(path: string, extension: string) : string
    -
    val base2 : string

    Full name: Project.Inputs.base2
    -
    val fileName2 : string

    Full name: Project.Inputs.fileName2
    -
    val dllName : string

    Full name: Project.Inputs.dllName
    -
    val projFileName : string

    Full name: Project.Inputs.projFileName
    -
    val fileSource1 : string

    Full name: Project.Inputs.fileSource1
    -
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 3 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      static member Encrypt : path:string -> unit
      static member Exists : path:string -> bool
      ...

    Full name: System.IO.File
    -
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    -
    val fileSource2 : string

    Full name: Project.Inputs.fileSource2
    -
    val projectOptions : FSharpProjectOptions

    Full name: Project.projectOptions
    -
    member FSharpChecker.GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    -
    module Inputs

    from Project
    -
    val references : string list
    -
    val wholeProjectResults : obj

    Full name: Project.wholeProjectResults
    -
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    val x : UnresolvedSymbol
    -
    UnresolvedSymbol.DisplayName: string
    -
    val allSymbolsInEntities : entities:IList<FSharpEntity> -> FSharpSymbol list

    Full name: Project.allSymbolsInEntities
    -
    val entities : IList<FSharpEntity>
    -
    type IList<'T> =
      member IndexOf : item:'T -> int
      member Insert : index:int * item:'T -> unit
      member Item : int -> 'T with get, set
      member RemoveAt : index:int -> unit

    Full name: System.Collections.Generic.IList<_>
    -
    type FSharpEntity =
      inherit FSharpSymbol
      private new : SymbolEnv * EntityRef -> FSharpEntity
      member AbbreviatedType : FSharpType
      member AccessPath : string
      member Accessibility : FSharpAccessibility
      member ActivePatternCases : FSharpActivePatternCase list
      member AllCompilationPaths : string list
      member AllInterfaces : IList<FSharpType>
      member ArrayRank : int
      member Attributes : IList<FSharpAttribute>
      ...

    Full name: FSharp.Compiler.SourceCodeServices.FSharpEntity
    -
    val e : FSharpEntity
    -
    type FSharpSymbol =
      member GetEffectivelySameAsHash : unit -> int
      member IsAccessible : FSharpAccessibilityRights -> bool
      member IsEffectivelySameAs : other:FSharpSymbol -> bool
      member Assembly : FSharpAssembly
      member DeclarationLocation : range option
      member DisplayName : string
      member FullName : string
      member ImplementationLocation : range option
      member IsExplicitlySuppressed : bool
      member private Item : Item
      ...

    Full name: FSharp.Compiler.SourceCodeServices.FSharpSymbol
    -
    val x : FSharpMemberOrFunctionOrValue
    -
    property FSharpEntity.MembersFunctionsAndValues: IList<FSharpMemberOrFunctionOrValue>
    -
    val x : FSharpUnionCase
    -
    property FSharpEntity.UnionCases: IList<FSharpUnionCase>
    -
    val x : FSharpField
    -
    property FSharpEntity.FSharpFields: IList<FSharpField>
    -
    property FSharpEntity.NestedEntities: IList<FSharpEntity>
    -
    val allSymbols : FSharpSymbol list

    Full name: Project.allSymbols
    -
    val backgroundParseResults1 : obj

    Full name: Project.backgroundParseResults1
    -
    val backgroundTypedParse1 : obj

    Full name: Project.backgroundTypedParse1
    -
    member FSharpChecker.GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    -
    val xSymbol : obj

    Full name: Project.xSymbol
    -
    val usesOfXSymbol : obj

    Full name: Project.usesOfXSymbol
    -
    module Symbol

    from FSharp.Compiler.SourceCodeServices
    -
    val allUsesOfAllSignatureSymbols : obj list

    Full name: Project.allUsesOfAllSignatureSymbols
    -
    val allUsesOfAllSymbols : obj

    Full name: Project.allUsesOfAllSymbols
    -
    val parseResults1 : obj

    Full name: Project.parseResults1
    -
    val checkAnswer1 : FSharpCheckFileAnswer

    Full name: Project.checkAnswer1
    -
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    -
    val checkResults1 : FSharpCheckFileResults

    Full name: Project.checkResults1
    -
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults

    Full name: FSharp.Compiler.SourceCodeServices.FSharpCheckFileAnswer
    -
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    -
    val x : FSharpCheckFileResults
    -
    val failwith : message:string -> 'T

    Full name: Microsoft.FSharp.Core.Operators.failwith
    -
    val parseResults2 : obj

    Full name: Project.parseResults2
    -
    val checkAnswer2 : FSharpCheckFileAnswer

    Full name: Project.checkAnswer2
    -
    val checkResults2 : FSharpCheckFileResults

    Full name: Project.checkResults2
    -
    val xSymbol2 : obj

    Full name: Project.xSymbol2
    -
    member FSharpCheckFileResults.GetSymbolUseAtLocation : line:int * colAtEndOfNames:int * lineText:string * names:string list * ?userOpName:string -> Async<FSharpSymbolUse option>
    -
    val usesOfXSymbol2 : obj

    Full name: Project.usesOfXSymbol2
    -
    val allUsesOfAllSymbolsInFile1 : Async<FSharpSymbolUse []>

    Full name: Project.allUsesOfAllSymbolsInFile1
    -
    member FSharpCheckFileResults.GetAllUsesOfAllSymbolsInFile : unit -> Async<FSharpSymbolUse []>
    -
    val allUsesOfXSymbolInFile1 : Async<FSharpSymbolUse []>

    Full name: Project.allUsesOfXSymbolInFile1
    -
    member FSharpCheckFileResults.GetUsesOfSymbolInFile : symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    -
    val allUsesOfXSymbolInFile2 : Async<FSharpSymbolUse []>

    Full name: Project.allUsesOfXSymbolInFile2
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/symbols.html b/docs/ja/symbols.html deleted file mode 100644 index 12aa3e2f54..0000000000 --- a/docs/ja/symbols.html +++ /dev/null @@ -1,516 +0,0 @@ - - - - - コンパイラサービス: シンボルの処理 - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    コンパイラサービス: シンボルの処理

    -

    このチュートリアルでは、F#コンパイラによって提供される -シンボルの扱い方についてのデモを紹介します。 -シンボルの参照に関する情報については プロジェクト全体の分析 -も参考にしてください。

    -
    -

    注意: 以下で使用しているAPIは試験的なもので、 -最新のnugetパッケージの公開に伴って変更されることがあります。

    -
    -

    これまでと同じく、 FSharp.Compiler.Service.dll への参照を追加した後、 -適切な名前空間をオープンし、 FSharpChecker のインスタンスを作成します:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
    // F#コンパイラAPIへの参照
-#r "FSharp.Compiler.Service.dll"
-
-open System
-open System.IO
-open FSharp.Compiler.SourceCodeServices
-
-// インタラクティブチェッカーのインスタンスを作成
-let checker = FSharpChecker.Create()
-
    -

    そして特定の入力値に対して型チェックを行います:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-
    let parseAndTypeCheckSingleFile (file, input) = 
-    // スタンドアロンの(スクリプト)ファイルを表すコンテキストを取得
-    let projOptions, _errors = 
-        checker.GetProjectOptionsFromScript(file, input)
-        |> Async.RunSynchronously
-
-    let parseFileResults, checkFileResults = 
-        checker.ParseAndCheckFileInProject(file, 0, input, projOptions) 
-        |> Async.RunSynchronously
-
-    // 型チェックが成功(あるいは100%に到達)するまで待機
-    match checkFileResults with
-    | FSharpCheckFileAnswer.Succeeded(res) -> parseFileResults, res
-    | res -> failwithf "Parsing did not finish... (%A)" res
-
-let file = "/home/user/Test.fsx"
-
    -

    ファイルに対する解決済みのシグネチャ情報を取得する

    -

    ファイルに対する型チェックが完了すると、 -TypeCheckResults の PartialAssemblySignature プロパティを参照することにより、 -チェック中の特定のファイルを含む、推論されたプロジェクトのシグネチャに -アクセスすることができます。

    -

    モジュールや型、属性、メンバ、値、関数、共用体、レコード型、測定単位、 -およびその他のF#言語要素に対する完全なシグネチャ情報が参照できます。

    -

    ただし型付き式ツリーに対する情報は(今のところ)この方法では利用できません。

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-
    let input2 = 
-      """
-[<System.CLSCompliant(true)>]
-let foo(x, y) = 
-    let msg = String.Concat("Hello"," ","world")
-    if true then 
-        printfn "x = %d, y = %d" x y 
-        printfn "%s" msg
-
-type C() = 
-    member x.P = 1
-      """
-let parseFileResults, checkFileResults = 
-    parseAndTypeCheckSingleFile(file, input2)
-
    -

    これでコードに対する部分的なアセンブリのシグネチャが取得できるようになります:

    - - - -
    1: 
-2: 
-3: 
-
    let partialAssemblySignature = checkFileResults.PartialAssemblySignature
-
-partialAssemblySignature.Entities.Count = 1  // エンティティは1つ
-
    -

    そしてコードを含むモジュールに関連したエンティティを取得します:

    - - - -
    1: 
-2: 
-3: 
-
    let moduleEntity = partialAssemblySignature.Entities.[0]
-
-moduleEntity.DisplayName = "Test"
-
    -

    そしてコード内の型定義に関連したエンティティを取得します:

    - - - -
    1: 
-
    let classEntity = moduleEntity.NestedEntities.[0]
-
    -

    そしてコード内で定義された関数に関連した値を取得します:

    - - - -
    1: 
-
    let fnVal = moduleEntity.MembersFunctionsAndValues.[0]
-
    -

    関数値に関するプロパティの値を確認してみましょう。

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-
    fnVal.Attributes.Count // 1
-fnVal.CurriedParameterGroups.Count // 1
-fnVal.CurriedParameterGroups.[0].Count // 2
-fnVal.CurriedParameterGroups.[0].[0].Name // "x"
-fnVal.CurriedParameterGroups.[0].[1].Name // "y"
-fnVal.DeclarationLocation.StartLine // 3
-fnVal.DisplayName // "foo"
-fnVal.DeclaringEntity.Value.DisplayName // "Test"
-fnVal.DeclaringEntity.Value.DeclarationLocation.StartLine // 1
-fnVal.GenericParameters.Count // 0
-fnVal.InlineAnnotation // FSharpInlineAnnotation.OptionalInline
-fnVal.IsActivePattern // false
-fnVal.IsCompilerGenerated // false
-fnVal.IsDispatchSlot // false
-fnVal.IsExtensionMember // false
-fnVal.IsPropertyGetterMethod // false
-fnVal.IsImplicitConstructor // false
-fnVal.IsInstanceMember // false
-fnVal.IsMember // false
-fnVal.IsModuleValueOrMember // true
-fnVal.IsMutable // false
-fnVal.IsPropertySetterMethod // false
-fnVal.IsTypeFunction // false
-
    -

    次に、この関数の型がファーストクラスの値として使用されているかどうかチェックします。 -(ちなみに CurriedParameterGroups プロパティには引数の名前など、 -より多くの情報も含まれています)

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
    fnVal.FullType // int * int -> unit
-fnVal.FullType.IsFunctionType // true
-fnVal.FullType.GenericArguments.[0] // int * int 
-fnVal.FullType.GenericArguments.[0].IsTupleType // true
-let argTy1 = fnVal.FullType.GenericArguments.[0].GenericArguments.[0]
-
-argTy1.TypeDefinition.DisplayName // int
-
    -

    というわけで int * int -> unit という型を表現するオブジェクトが取得できて、 -その1つめの 'int' を確認できたわけです。 -また、以下のようにすると 'int' 型についてのより詳細な情報が取得でき、 -それが名前付きの型であり、F#の型省略形 type int = int32 であることがわかります:

    - - - -
    1: 
-2: 
-
    argTy1.HasTypeDefinition // true
-argTy1.TypeDefinition.IsFSharpAbbreviation // true
-
    -

    型省略形の右辺、つまり int32 についてもチェックしてみましょう:

    - - - -
    1: 
-2: 
-3: 
-
    let argTy1b = argTy1.TypeDefinition.AbbreviatedType
-argTy1b.TypeDefinition.Namespace // Some "Microsoft.FSharp.Core" 
-argTy1b.TypeDefinition.CompiledName // "int32" 
-
    -

    そして再び型省略形 type int32 = System.Int32 から型に関する完全な情報が取得できます:

    - - - -
    1: 
-2: 
-3: 
-
    let argTy1c = argTy1b.TypeDefinition.AbbreviatedType
-argTy1c.TypeDefinition.Namespace // Some "System" 
-argTy1c.TypeDefinition.CompiledName // "Int32" 
-
    -

    ファイルに対する型チェックの結果には、 -コンパイル時に使用されたプロジェクト(あるいはスクリプト)のオプションに関する -ProjectContext と呼ばれる情報も含まれています:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
    let projectContext = checkFileResults.ProjectContext
-
-for assembly in projectContext.GetReferencedAssemblies() do
-    match assembly.FileName with 
-    | None -> printfn "コンパイル時にファイルの存在しないアセンブリを参照しました"
-    | Some s -> printfn "コンパイル時にアセンブリ '%s' を参照しました" s
-
    -

    注意:

    -
      -
    • -不完全なコードが存在する場合、一部あるいはすべての属性が意図したとおりには -並ばないことがあります。 -
      • -
    • -(実際には非常によくあることですが)一部のアセンブリが見つからない場合、 -外部アセンブリに関連する値やメンバ、エンティティにおける 'IsUnresolved' が -trueになることがあります。 -IsUnresolvedによる例外に対処できるよう、堅牢なコードにしておくべきです。 -
      • -
    -

    プロジェクト全体に対するシンボル情報を取得する

    -

    プロジェクト全体をチェックする場合、チェッカーを作成した後に parseAndCheckScript -を呼び出します。 -今回の場合は単に1つのスクリプトだけが含まれたプロジェクトをチェックします。 -異なる "projOptions" を指定すると、巨大なプロジェクトに対する設定を -構成することもできます。

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-
    let parseAndCheckScript (file, input) = 
-    let projOptions, errors = 
-        checker.GetProjectOptionsFromScript(file, input)
-        |> Async.RunSynchronously
-
-    let projResults = 
-        checker.ParseAndCheckProject(projOptions) 
-        |> Async.RunSynchronously
-
-    projResults
-
    -

    そして特定の入力に対してこの関数を呼び出します:

    - - - -
    1: 
-2: 
-3: 
-4: 
-
    let tmpFile = Path.ChangeExtension(System.IO.Path.GetTempFileName() , "fs")
-File.WriteAllText(tmpFile, input2)
-
-let projectResults = parseAndCheckScript(tmpFile, input2)
-
    -

    結果は以下の通りです:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
    let assemblySig = projectResults.AssemblySignature
-
-assemblySig.Entities.Count = 1  // エンティティは1つ
-assemblySig.Entities.[0].Namespace  // null
-assemblySig.Entities.[0].DisplayName // "Tmp28D0"
-assemblySig.Entities.[0].MembersFunctionsAndValues.Count // 1 
-assemblySig.Entities.[0].MembersFunctionsAndValues.[0].DisplayName // "foo" 
-
    - -
    namespace System
    -
    namespace System.IO
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    -
    namespace FSharp.Compiler
    -
    namespace FSharp.Compiler.SourceCodeServices
    -
    val checker : FSharpChecker

    Full name: Symbols.checker
    -
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    -
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    -
    val parseAndTypeCheckSingleFile : file:string * input:string -> 'a * FSharpCheckFileResults

    Full name: Symbols.parseAndTypeCheckSingleFile
    -
    val file : string
    -
    val input : string
    -
    val projOptions : FSharpProjectOptions
    -
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    val parseFileResults : 'a
    -
    val checkFileResults : FSharpCheckFileAnswer
    -
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    -
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults

    Full name: FSharp.Compiler.SourceCodeServices.FSharpCheckFileAnswer
    -
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    -
    val res : FSharpCheckFileResults
    -
    val res : FSharpCheckFileAnswer
    -
    val failwithf : format:Printf.StringFormat<'T,'Result> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.failwithf
    -
    val file : string

    Full name: Symbols.file
    -
    val input2 : string

    Full name: Symbols.input2
    -
    val parseFileResults : obj

    Full name: Symbols.parseFileResults
    -
    val checkFileResults : FSharpCheckFileResults

    Full name: Symbols.checkFileResults
    -
    val partialAssemblySignature : FSharpAssemblySignature

    Full name: Symbols.partialAssemblySignature
    -
    property FSharpCheckFileResults.PartialAssemblySignature: FSharpAssemblySignature
    -
    property FSharpAssemblySignature.Entities: Collections.Generic.IList<FSharpEntity>
    -
    property Collections.Generic.ICollection.Count: int
    -
    val moduleEntity : FSharpEntity

    Full name: Symbols.moduleEntity
    -
    property FSharpEntity.DisplayName: string
    -
    val classEntity : FSharpEntity

    Full name: Symbols.classEntity
    -
    property FSharpEntity.NestedEntities: Collections.Generic.IList<FSharpEntity>
    -
    val fnVal : FSharpMemberOrFunctionOrValue

    Full name: Symbols.fnVal
    -
    property FSharpEntity.MembersFunctionsAndValues: Collections.Generic.IList<FSharpMemberOrFunctionOrValue>
    -
    property FSharpMemberOrFunctionOrValue.Attributes: Collections.Generic.IList<FSharpAttribute>
    -
    property FSharpMemberOrFunctionOrValue.CurriedParameterGroups: Collections.Generic.IList<Collections.Generic.IList<FSharpParameter>>
    -
    property FSharpMemberOrFunctionOrValue.DeclarationLocation: FSharp.Compiler.Range.range
    -
    property FSharp.Compiler.Range.range.StartLine: int
    -
    property FSharpMemberOrFunctionOrValue.DisplayName: string
    -
    property FSharpMemberOrFunctionOrValue.DeclaringEntity: FSharpEntity option
    -
    property Option.Value: FSharpEntity
    -
    property FSharpEntity.DeclarationLocation: FSharp.Compiler.Range.range
    -
    property FSharpMemberOrFunctionOrValue.GenericParameters: Collections.Generic.IList<FSharpGenericParameter>
    -
    property FSharpMemberOrFunctionOrValue.InlineAnnotation: FSharpInlineAnnotation
    -
    property FSharpMemberOrFunctionOrValue.IsActivePattern: bool
    -
    property FSharpMemberOrFunctionOrValue.IsCompilerGenerated: bool
    -
    property FSharpMemberOrFunctionOrValue.IsDispatchSlot: bool
    -
    property FSharpMemberOrFunctionOrValue.IsExtensionMember: bool
    -
    property FSharpMemberOrFunctionOrValue.IsPropertyGetterMethod: bool
    -
    property FSharpMemberOrFunctionOrValue.IsImplicitConstructor: bool
    -
    property FSharpMemberOrFunctionOrValue.IsInstanceMember: bool
    -
    property FSharpMemberOrFunctionOrValue.IsMember: bool
    -
    property FSharpMemberOrFunctionOrValue.IsModuleValueOrMember: bool
    -
    property FSharpMemberOrFunctionOrValue.IsMutable: bool
    -
    property FSharpMemberOrFunctionOrValue.IsPropertySetterMethod: bool
    -
    property FSharpMemberOrFunctionOrValue.IsTypeFunction: bool
    -
    property FSharpMemberOrFunctionOrValue.FullType: FSharpType
    -
    property FSharpType.IsFunctionType: bool
    -
    property FSharpType.GenericArguments: Collections.Generic.IList<FSharpType>
    -
    val argTy1 : FSharpType

    Full name: Symbols.argTy1
    -
    property FSharpType.TypeDefinition: FSharpEntity
    -
    property FSharpType.HasTypeDefinition: bool
    -
    property FSharpEntity.IsFSharpAbbreviation: bool
    -
    val argTy1b : FSharpType

    Full name: Symbols.argTy1b
    -
    property FSharpEntity.AbbreviatedType: FSharpType
    -
    property FSharpEntity.Namespace: string option
    -
    property FSharpEntity.CompiledName: string
    -
    val argTy1c : FSharpType

    Full name: Symbols.argTy1c
    -
    val projectContext : FSharpProjectContext

    Full name: Symbols.projectContext
    -
    property FSharpCheckFileResults.ProjectContext: FSharpProjectContext
    -
    member FSharpProjectContext.GetReferencedAssemblies : unit -> FSharpAssembly list
    -
    union case Option.None: Option<'T>
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    union case Option.Some: Value: 'T -> Option<'T>
    -
    val parseAndCheckScript : file:string * input:string -> 'a

    Full name: Symbols.parseAndCheckScript
    -
    val errors : obj
    -
    val projResults : 'a
    -
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    -
    val tmpFile : string

    Full name: Symbols.tmpFile
    -
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val InvalidPathChars : char[]
      static val PathSeparator : char
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string
      static member GetExtension : path:string -> string
      static member GetFileName : path:string -> string
      ...

    Full name: System.IO.Path
    -
    Path.ChangeExtension(path: string, extension: string) : string
    -
    Path.GetTempFileName() : string
    -
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 3 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      static member Encrypt : path:string -> unit
      static member Exists : path:string -> bool
      ...

    Full name: System.IO.File
    -
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    -
    val projectResults : obj

    Full name: Symbols.projectResults
    -
    val assemblySig : obj

    Full name: Symbols.assemblySig
    -
    union case ScopeKind.Namespace: ScopeKind
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/tokenizer.html b/docs/ja/tokenizer.html deleted file mode 100644 index 9175abca48..0000000000 --- a/docs/ja/tokenizer.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - コンパイラサービス：F#トークナイザを使用する - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    コンパイラサービス：F#トークナイザを使用する

    -

    このチュートリアルではF#言語トークナイザの呼び出し方を紹介します。 -F#のソースコードに対して、トークナイザは -コードの各行にあるトークンに関する情報を含んだソースコード行のリストを生成します。 -各トークンに対してはトークンの種類や位置を取得したり、 -トークンの種類(キーワード、識別子、数値、演算子など)に応じた -色を取得したりすることができます。

    -
    -

    注意: 以下で使用しているAPIは実験的なもので、 -新しいnugetパッケージの公開に伴って変更される可能性があります。

    -
    -

    トークナイザの作成

    -

    トークナイザを使用するには、 FSharp.Compiler.Service.dll への参照を追加した後に -SourceCodeServices 名前空間をオープンします：

    - - - -
    1: 
-2: 
-
    #r "FSharp.Compiler.Service.dll"
-open FSharp.Compiler.SourceCodeServices
-
    -

    すると FSharpSourceTokenizer のインスタンスを作成できるようになります。 -このクラスには2つの引数を指定します。 -最初の引数には定義済みのシンボルのリスト、 -2番目の引数にはソースコードのファイル名を指定します。 -定義済みのシンボルのリストを指定するのは、 -トークナイザが #if ディレクティブを処理する必要があるからです。 -ファイル名はソースコードの位置を特定する場合にのみ指定する必要があります -(存在しないファイル名でも指定できます):

    - - - -
    1: 
-
    let sourceTok = FSharpSourceTokenizer([], "C:\\test.fsx")
-
    -

    sourceTok オブジェクトを使用することでF#ソースコードの各行を -(繰り返し)トークン化することができます。

    -

    F#コードのトークン化

    -

    トークナイザはソースファイル全体ではなく、行単位で処理を行います。 -トークンを取得した後、トークナイザは新しいステートを( int64 値として)返します。 -この値を使うとF#コードをより効率的にトークン化できます。 -つまり、ソースコードが変更された場合もファイル全体を -再度トークン化する必要はありません。 -変更された部分だけをトークン化すればよいのです。

    -

    1行をトークン化する

    -

    1行をトークン化するには、先ほど作成した FSharpSourceTokenizer オブジェクトに対して -CreateLineTokenizer を呼び、 FSharpLineTokenizer を作成します:

    - - - -
    1: 
-
    let tokenizer = sourceTok.CreateLineTokenizer("let answer=42")
-
    -

    そして tokenizer の ScanToken を繰り返し None を返すまで -(つまり最終行に到達するまで)繰り返し呼び出すような単純な再帰関数を用意します。 -この関数が成功すると、必要な詳細情報をすべて含んだ FSharpTokenInfo オブジェクトが -返されます:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
    /// F#コード1行をトークン化します
-let rec tokenizeLine (tokenizer:FSharpLineTokenizer) state =
-  match tokenizer.ScanToken(state) with
-  | Some tok, state ->
-      // トークン名を表示
-      printf "%s " tok.TokenName
-      // 新しい状態で残りをトークン化
-      tokenizeLine tokenizer state
-  | None, state -> state
-
    -

    この関数は、複数行コードや複数行コメント内の前方の行をトークン化する場合に -必要となるような新しい状態を返します。 -初期値としては 0L を指定します:

    - - - -
    1: 
-
    tokenizeLine tokenizer FSharpTokenizerLexState.Initial
-
    -

    この結果は LET WHITESPACE IDENT EQUALS INT32 という -トークン名のシーケンスになります。 -FSharpTokenInfo にはたとえば以下のような興味深いプロパティが多数あります:

    -
      -
    • -CharClass および ColorClass はF#コードを色づけする場合に使用できるような、 -トークンのカテゴリに関する情報を返します。 -
      • -
    • LeftColumn および RightColumn は行内におけるトークンの位置を返します。
      • -
    • TokenName は(F# レキサ内で定義された)トークンの名前を返します。
      • -
    -

    なおトークナイザはステートフルであることに注意してください。 -つまり、1行を複数回トークン化したい場合にはその都度 CreateLineTokenizer を -呼び出す必要があります。

    -

    サンプルコードのトークン化

    -

    トークナイザをもっと長いサンプルコードやファイル全体に対して実行する場合、 -サンプル入力を string のコレクションとして読み取る必要があります:

    - - - -
    1: 
-2: 
-3: 
-4: 
-
    let lines = """
-  // Hello world
-  let hello() =
-     printfn "Hello world!" """.Split('\r','\n')
-
    -

    複数行の入力値をトークン化する場合も、現在の状態を保持するような -再帰関数が必要になります。 -以下の関数はソースコード行を文字列のリストとして受け取ります -(また、行番号および現在の状態も受け取ります)。 -各行に対して新しいトークナイザを作成して、 -直前の行における 最後 の状態を使って tokenizeLine を呼び出します:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-
    /// 複数行のコードに対してトークンの名前を表示します
-let rec tokenizeLines state count lines = 
-  match lines with
-  | line::lines ->
-      // トークナイザを作成して1行をトークン化
-      printfn "\nLine %d" count
-      let tokenizer = sourceTok.CreateLineTokenizer(line)
-      let state = tokenizeLine tokenizer state
-      // 新しい状態を使って残りをトークン化
-      tokenizeLines state (count+1) lines
-  | [] -> ()
-
    -

    ここでは単に(先ほど定義した) tokenizeLine を呼び出して、 -各行にあるすべてのトークンの名前を表示しています。 -この関数は先と同じく、初期状態の値 0L と、1行目を表す 1 を -指定して呼び出すことができます:

    - - - -
    1: 
-2: 
-3: 
-
    lines
-|> List.ofSeq
-|> tokenizeLines FSharpTokenizerLexState.Initial 1
-
    -

    重要ではない部分(各行の先頭にある空白文字や、1行目のように空白文字しかない行) -を除けば、このコードを実行すると以下のような出力になります:

    - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
    Line 1
-  LINE_COMMENT LINE_COMMENT (...) LINE_COMMENT 
-Line 2
-  LET WHITESPACE IDENT LPAREN RPAREN WHITESPACE EQUALS 
-Line 3
-  IDENT WHITESPACE STRING_TEXT (...) STRING_TEXT STRING 
-
    -

    注目すべきは、単一行コメントや文字列に対して、 -トークナイザが複数回(大まかにいって単語単位で) LINE_COMMENT や -STRING_TEXT を返しているところです。 -したがって、コメントや文字列全体をテキストとして取得したい場合には -それぞれのトークンを連結する必要があります。

    - -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    -
    namespace FSharp.Compiler
    -
    namespace FSharp.Compiler.SourceCodeServices
    -
    val sourceTok : FSharpSourceTokenizer

    Full name: Tokenizer.sourceTok
    -
    Multiple items
    type FSharpSourceTokenizer =
      new : conditionalDefines:string list * fileName:string option -> FSharpSourceTokenizer
      member CreateBufferTokenizer : bufferFiller:(char [] * int * int -> int) -> FSharpLineTokenizer
      member CreateLineTokenizer : lineText:string -> FSharpLineTokenizer

    Full name: FSharp.Compiler.SourceCodeServices.FSharpSourceTokenizer

    --------------------
    new : conditionalDefines:string list * fileName:string option -> FSharpSourceTokenizer
    -
    val tokenizer : FSharpLineTokenizer

    Full name: Tokenizer.tokenizer
    -
    member FSharpSourceTokenizer.CreateLineTokenizer : lineText:string -> FSharpLineTokenizer
    -
    val tokenizeLine : tokenizer:FSharpLineTokenizer -> state:FSharpTokenizerLexState -> FSharpTokenizerLexState

    Full name: Tokenizer.tokenizeLine


     F#コード1行をトークン化します
    -
    val tokenizer : FSharpLineTokenizer
    -
    type FSharpLineTokenizer
    member ScanToken : lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
    static member ColorStateOfLexState : FSharpTokenizerLexState -> FSharpTokenizerColorState
    static member LexStateOfColorState : FSharpTokenizerColorState -> FSharpTokenizerLexState

    Full name: FSharp.Compiler.SourceCodeServices.FSharpLineTokenizer
    -
    val state : FSharpTokenizerLexState
    -
    member FSharpLineTokenizer.ScanToken : lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
    -
    union case Option.Some: Value: 'T -> Option<'T>
    -
    val tok : FSharpTokenInfo
    -
    val printf : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printf
    -
    union case Option.None: Option<'T>
    -
    type FSharpTokenizerLexState =
      {PosBits: int64;
       OtherBits: int64;}
      member Equals : FSharpTokenizerLexState -> bool
      static member Initial : FSharpTokenizerLexState

    Full name: FSharp.Compiler.SourceCodeServices.FSharpTokenizerLexState
    -
    property FSharpTokenizerLexState.Initial: FSharpTokenizerLexState
    -
    val lines : string []

    Full name: Tokenizer.lines
    -
    val tokenizeLines : state:FSharpTokenizerLexState -> count:int -> lines:string list -> unit

    Full name: Tokenizer.tokenizeLines


     複数行のコードに対してトークンの名前を表示します
    -
    val count : int
    -
    val lines : string list
    -
    val line : string
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    Multiple items
    module List

    from Microsoft.FSharp.Collections

    --------------------
    -
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/ja/untypedtree.html b/docs/ja/untypedtree.html deleted file mode 100644 index 79f2871a21..0000000000 --- a/docs/ja/untypedtree.html +++ /dev/null @@ -1,527 +0,0 @@ - - - - - コンパイラサービス：型無し構文木の処理 - - - - - - - - - - - - - - - - - -
    -
    - -

    F# Compiler Services

    -
    -
    -
    -
    - -

    コンパイラサービス：型無し構文木の処理

    -

    このチュートリアルではF#コードに対する型無し抽象構文木 -(untyped abstract syntax tree: untyped AST) -を取得する方法、および木全体を走査する方法を紹介します。 -この処理を行うことによって、コードフォーマットツールや -基本的なリファクタリングツール、コードナビゲーションツールなどを作成できます。 -型無し構文木にはコードの構造に関する情報が含まれていますが、 -型情報が含まれていないだけでなく、後で型チェッカーを通すまでは -解決されないような曖昧さも残されています。 -また、 エディタサービス として提供されているAPIと -型無しASTの情報を組み合わせることもできます。

    -
    -

    注釈: 以下で使用しているAPIは試験的なもので、将来的に変更される場合があります。 -つまりFSharp.Compiler.Service.dll には既存のものと重複する機能が多数あるため、 -将来的にはもっときちんとした形に変更されます。 -そのため、これらのサービスを使用するAPIには破壊的変更が加えられる可能性があります。

    -
    -

    型無しASTの取得

    -

    型無しASTにアクセスするには、 FSharpChecker のインスタンスを作成します。 -これは型チェックおよびパース用のコンテキストを表す型で、、 -スタンドアロンのF#スクリプトファイル(たとえばVisual Studioで開いたファイル)、 -あるいは複数ファイルで構成されたロード済みのプロジェクトファイルの -いずれかと結びつきます。 -このインスタンスを作成すると、型チェックの最初のステップである -「型無しパース」を実行できます。 -次のフェーズは「型有りパース」で、これは エディタサービス で -使用されるものです。

    -

    インタラクティブチェッカーを使用するには、 -FSharp.Compiler.Service.dll への参照を追加した後、 -SourceCodeServices 名前空間をオープンします：

    - - - -
    1: 
-2: 
-3: 
-
    #r "FSharp.Compiler.Service.dll"
-open System
-open FSharp.Compiler.SourceCodeServices
-
    -

    型無しパースの実行

    -

    型無しパース処理は(それなりの時間がかかる型チェック処理と比較すると) -かなり高速なため、同期的に実行できます。 -まず FSharpChecker を作成します。

    - - - -
    1: 
-2: 
-
    // インタラクティブチェッカーのインスタンスを作成
-let checker = FSharpChecker.Create()
-
    -

    ASTを取得するために、ファイル名とソースコードを受け取る関数を用意します -(ファイル名は位置情報のためだけに使用されるもので、存在しなくても構いません)。 -まず、コンテキストを表す「インタラクティブチェッカーオプション」を -用意する必要があります。 -単純な処理に対しては、 GetCheckOptionsFromScriptRoot を使えば -スクリプトファイルのコンテキストを推測させることができます。 -そして UntypedParse メソッドを呼び出した後、 -ParseTree プロパティの値を返します:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-
    /// 特定の入力に対する型無し構文木を取得する
-let getUntypedTree (file, input) = 
-  // 1つのスクリプトファイルから推測される「プロジェクト」用の
-  // コンパイラオプションを取得する
-  let projOptions, errors =
-      checker.GetProjectOptionsFromScript(file, input) 
-      |> Async.RunSynchronously
-
-  let parsingOptions, _errors = checker.GetParsingOptionsFromProjectOptions(projectOptions)
-
-  // コンパイラの第1フェーズを実行する
-  let untypedRes = 
-      checker.ParseFile(file, input, parsingOptions) 
-      |> Async.RunSynchronously
-
-  match untypedRes.ParseTree with
-  | Some tree -> tree
-  | None -> failwith "パース中に何らかの問題が発生しました!"
-
    -

    FSharpChecker の詳細については - APIドキュメント -の他に、F# ソースコードのインラインコメントも参考になるでしょう -( service.fsi のソースコードを参照 )。

    -

    ASTの走査

    -

    抽象構文木は(式やパターン、宣言など)それぞれ異なる文法的要素を表現する、 -多数の判別共用体として定義されています。 -ASTを理解するには -ast.fs内にあるソースコード -の定義を確認する方法が一番よいでしょう。

    -

    ASTに関連する要素は以下の名前空間に含まれています:

    - - - -
    1: 
-
    open FSharp.Compiler.Ast
-
    -

    ASTを処理する場合、異なる文法的要素に対するパターンマッチを行うような -相互再帰関数を多数用意することになります。 -サポートすべき要素は非常に多種多様です。 -たとえばトップレベル要素としてはモジュールや名前空間の宣言、 -モジュール内における(letバインディングや型などの)宣言などがあります。 -モジュール内のlet宣言には式が含まれ、さらにこの式に -パターンが含まれていることもあります。

    -

    パターンと式を走査する

    -

    まずは式とパターンを走査する関数から始めます。 -この関数は要素を走査しつつ、要素に関する情報を画面に表示します。 -パターンの場合、入力は SynPat 型であり、この型には Wild ( _ パターンを表す)や -Named ( <pat> という名前 のパターン)、 -LongIdent ( Foo.Bar 形式の名前)など、多数のケースがあります。 -なお、基本的にパース後のパターンは元のソースコードの見た目よりも複雑になります -(具体的には Named がかなり多数現れます):

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-
    /// パターンの走査
-/// これは let <pat> = <expr> あるいは 'match' 式に対する例です
-let rec visitPattern = function
-  | SynPat.Wild(_) -> 
-      printfn "  .. アンダースコアパターン"
-  | SynPat.Named(pat, name, _, _, _) ->
-      visitPattern pat
-      printfn "  .. 名前 '%s' のパターン" name.idText
-  | SynPat.LongIdent(LongIdentWithDots(ident, _), _, _, _, _, _) ->
-      let names = String.concat "." [ for i in ident -> i.idText ]
-      printfn "  .. 識別子: %s" names
-  | pat -> printfn "  .. その他のパターン: %A" pat
-
    -

    この関数は (bar という名前の (foo, _) のような、 -ネストされたパターンに対応するために) 再帰関数になっていますが、 -以降で定義するいずれの関数も呼び出しません -(パターンはその他の文法的な要素を含むことができないからです)。

    -

    次の関数は式全体を走査するものです。 -これは処理の大部分が行われる関数で、 -20以上のケースをカバーすることになるでしょう -( SynExpr と入力するとその他のオプションが確認できます)。 -以下のコードでは if .. then .. と let .. = ... という式を -処理する方法だけを紹介しています:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-
    /// 式を走査する。
-/// 式に2つあるいは3つの部分式が含まれていた場合('else'の分岐がない場合は2つ)、
-/// let式にはパターンおよび2つの部分式が含まれる
-let rec visitExpression = function
-  | SynExpr.IfThenElse(cond, trueBranch, falseBranchOpt, _, _, _, _) ->
-      // すべての部分式を走査
-      printfn "条件部:"
-      visitExpression cond
-      visitExpression trueBranch
-      falseBranchOpt |> Option.iter visitExpression 
-
-  | SynExpr.LetOrUse(_, _, bindings, body, _) ->
-      // バインディングを走査
-      // ('let .. = .. and .. = .. in ...' に対しては複数回走査されることがある)
-      printfn "以下のバインディングを含むLetOrUse:"
-      for binding in bindings do
-        let (Binding(access, kind, inlin, mutabl, attrs, xmlDoc, 
-                     data, pat, retInfo, init, m, sp)) = binding
-        visitPattern pat 
-        visitExpression init
-      // 本体の式を走査
-      printfn "本体は以下:"
-      visitExpression body
-  | expr -> printfn " - サポート対象外の式: %A" expr
-
    -

    visitExpression 関数はモジュール内のすべてのトップレベル宣言を走査するような -関数から呼ばれることになります。 -今回のチュートリアルでは型やメンバーを無視していますが、 -これらを走査する場合も visitExpression を呼び出すことになるでしょう。

    -

    宣言を走査する

    -

    既に説明したように、1つのファイルに対するASTには多数のモジュールや -名前空間の宣言が(トップレベルノードとして)含まれ、 -モジュール内にも(letバインディングや型の)宣言が、 -名前空間にも(こちらは単に型だけの)宣言が含まれます。 -以下の関数はそれぞれの宣言を走査します。 -ただし今回は型やネストされたモジュール、その他の要素については無視して、 -トップレベルの(値および関数に対する) let バインディングだけを対象にしています:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-
    /// モジュール内の宣言リストを走査する。
-/// モジュール内のトップレベルに記述できるすべての要素
-/// (letバインディングやネストされたモジュール、型の宣言など)が対象になる。
-let visitDeclarations decls = 
-  for declaration in decls do
-    match declaration with
-    | SynModuleDecl.Let(isRec, bindings, range) ->
-        // 宣言としてのletバインディングは
-        // (visitExpressionで処理したような)式としてのletバインディングと
-        // 似ているが、本体を持たない
-        for binding in bindings do
-          let (Binding(access, kind, inlin, mutabl, attrs, xmlDoc, 
-                       data, pat, retInfo, body, m, sp)) = binding
-          visitPattern pat 
-          visitExpression body         
-    | _ -> printfn " - サポート対象外の宣言: %A" declaration
-
    -

    visitDeclarations 関数はモジュールや名前空間の宣言のシーケンスを走査する -関数から呼ばれることになります。 -このシーケンスはたとえば複数の namespace Foo 宣言を含むようなファイルに対応します:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
    /// すべてのモジュールや名前空間の宣言を走査する
-/// (基本的には 'module Foo =' または 'namespace Foo.Bar' というコード)
-/// なおファイル中で明示的に定義されていない場合であっても
-/// 暗黙的にモジュールまたは名前空間の宣言が存在することに注意。
-let visitModulesAndNamespaces modulesOrNss =
-  for moduleOrNs in modulesOrNss do
-    let (SynModuleOrNamespace(lid, isRec, isMod, decls, xml, attrs, _, m)) = moduleOrNs
-    printfn "名前空間またはモジュール: %A" lid
-    visitDeclarations decls
-
    -

    以上でASTの要素を(宣言から始まって式やパターンに至るまで)走査するための -関数がそろったので、サンプル入力からASTを取得した後、 -上記の関数を実行することができるようになりました。

    -

    すべてを組み合わせる

    -

    既に説明したように、 getUntypedTree 関数では FSharpChecker を使って -ASTに対する第1フェーズ(パース)を行ってツリーを返しています。 -この関数にはF#のソースコードとともに、ファイルのパスを指定する必要があります。 -(単に位置情報として利用されるだけなので) -指定先のパスにファイルが存在している必要はなく、 -UnixとWindowsどちらの形式でも指定できます:

    - - - -
     1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-
    // コンパイラサービスへのサンプル入力
-let input = """
-  let foo() = 
-    let msg = "Hello world"
-    if true then 
-      printfn "%s" msg """
-// Unix形式のファイル名
-let file = "/home/user/Test.fsx"
-
-// サンプルF#コードに対するASTを取得
-let tree = getUntypedTree(file, input) 
-
    -

    このコードをF# Interactiveで実行した場合、コンソールに tree;; と入力すると、 -データ構造に対する文字列表現が表示されることが確認できます。 -ツリーには大量の情報が含まれているため、あまり読みやすいものではありませんが、 -木が動作する様子を想像することはできるでしょう。

    -

    tree の返値はやはり判別共用体で、2つのケースに分かれます。 -1つはF#のシグネチャファイル( *.fsi )を表す ParsedInput.SigFile で、 -もう1つは通常のソースコード( *.fsx または *.fs )を表す -ParsedInput.ImplFile です。 -上記の手順で作成した関数に渡すことができるモジュールや名前空間のシーケンスは -実装ファイルに含まれています:

    - - - -
    1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
    // 実装ファイルの詳細をチェックする
-match tree with
-| ParsedInput.ImplFile(implFile) ->
-    // 宣言を展開してそれぞれを走査する
-    let (ParsedImplFileInput(fn, script, name, _, _, modules, _)) = implFile
-    visitModulesAndNamespaces modules
-| _ -> failwith "F# インターフェイスファイル (*.fsi) は未サポートです。"
-
    -

    まとめ

    -

    このチュートリアルでは型無し抽象構文木に対する基本的な走査方法を紹介しました。 -このトピックは包括的なものであるため、1つの記事ですべてを説明することは不可能です。 -さらに深く理解するためには、型無しASTを活用するツールのよい例として -Fantomas project を参考にするとよいでしょう。 -実際には今回参照したような情報と、次のチュートリアルで説明する -エディタサービス から得られる情報とを -組み合わせて利用することになるでしょう。

    - -
    namespace System
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    -
    namespace FSharp.Compiler
    -
    namespace FSharp.Compiler.SourceCodeServices
    -
    val checker : FSharpChecker

    Full name: Untypedtree.checker
    -
    type FSharpChecker
    member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
    member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
    member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
    member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromCommandLineArgs : sourceFiles:string list * argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
    member GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    member GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    member GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    member InvalidateAll : unit -> unit
    member InvalidateConfiguration : options:FSharpProjectOptions * ?startBackgroundCompileIfAlreadySeen:bool * ?userOpName:string -> unit
    member KeepProjectAlive : options:FSharpProjectOptions * ?userOpName:string -> Async<IDisposable>
    member MatchBraces : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<(range * range) []>
    member NotifyProjectCleaned : options:FSharpProjectOptions * ?userOpName:string -> Async<unit>
    member ParseAndCheckFileInProject : filename:string * fileversion:int * source:string * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    member ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    member ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    member StopBackgroundCompile : unit -> unit
    member TokenizeFile : source:string -> FSharpTokenInfo [] []
    member TokenizeLine : line:string * state:FSharpTokenizerLexState -> FSharpTokenInfo [] * FSharpTokenizerLexState
    member TryGetRecentCheckResultsForFile : filename:string * options:FSharpProjectOptions * ?source:string * ?userOpName:string -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    member WaitForBackgroundCompile : unit -> unit
    member BeforeBackgroundFileCheck : IEvent<string * obj option>
    member CurrentQueueLength : int
    member FileChecked : IEvent<string * obj option>
    member FileParsed : IEvent<string * obj option>
    member private FrameworkImportsCache : FrameworkImportsCache
    member ImplicitlyStartBackgroundWork : bool
    member MaxMemory : int
    member MaxMemoryReached : IEvent<unit>
    member PauseBeforeBackgroundWork : int
    member ProjectChecked : IEvent<string * obj option>
    member private ReactorOps : IReactorOperations
    member private ReferenceResolver : Resolver
    member ImplicitlyStartBackgroundWork : bool with set
    member MaxMemory : int with set
    member PauseBeforeBackgroundWork : int with set
    static member Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:Resolver * ?tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot -> FSharpChecker
    static member GlobalForegroundParseCountStatistic : int
    static member GlobalForegroundTypeCheckCountStatistic : int

    Full name: FSharp.Compiler.SourceCodeServices.FSharpChecker
    -
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot -> FSharpChecker
    -
    val getUntypedTree : file:string * input:string -> 'a

    Full name: Untypedtree.getUntypedTree


     特定の入力に対する型無し構文木を取得する
    -
    val file : string
    -
    val input : string
    -
    val projOptions : obj
    -
    val errors : obj
    -
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * source:string * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    -
    Multiple items

    --------------------
    type Async<'T>

    Full name: Microsoft.FSharp.Control.Async<_>
    -
    -
    val parsingOptions : FSharpParsingOptions
    -
    member FSharpChecker.GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    -
    val untypedRes : obj
    -
    member FSharpChecker.ParseFile : filename:string * source:string * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    -
    union case Option.Some: Value: 'T -> Option<'T>
    -
    val tree : 'a
    -
    union case Option.None: Option<'T>
    -
    val failwith : message:string -> 'T

    Full name: Microsoft.FSharp.Core.Operators.failwith
    -
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>

    Full name: FSharp.Compiler.SourceCodeServices.FSharpAttribute
    -
    module Ast

    from FSharp.Compiler
    -
    val visitPattern : _arg1:SynPat -> unit

    Full name: Untypedtree.visitPattern


     パターンの走査
     これは let <pat> = <expr> あるいは 'match' 式に対する例です
    -
    type SynPat =
      | Const of SynConst * range: range
      | Wild of range: range
      | Named of SynPat * Ident * isSelfIdentifier: bool * accessibility: SynAccess option * range: range
      | Typed of SynPat * SynType * range: range
      | Attrib of SynPat * SynAttributes * range: range
      | Or of SynPat * SynPat * range: range
      | Ands of SynPat list * range: range
      | LongIdent of longDotId: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * accessibility: SynAccess option * range: range
      | Tuple of isStruct: bool * SynPat list * range: range
      | Paren of SynPat * range: range
      ...
      member Range : range

    Full name: FSharp.Compiler.Ast.SynPat
    -
    union case SynPat.Wild: range: FSharp.Compiler.Range.range -> SynPat
    -
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T

    Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
    -
    union case SynPat.Named: SynPat * Ident * isSelfIdentifier: bool * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynPat
    -
    val pat : SynPat
    -
    val name : Ident
    -
    property Ident.idText: string
    -
    union case SynPat.LongIdent: longDotId: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynPat
    -
    Multiple items
    union case LongIdentWithDots.LongIdentWithDots: id: LongIdent * dotms: FSharp.Compiler.Range.range list -> LongIdentWithDots

    --------------------
    type LongIdentWithDots =
      | LongIdentWithDots of id: LongIdent * dotms: range list
      member Lid : LongIdent
      member Range : range
      member RangeSansAnyExtraDot : range
      member ThereIsAnExtraDotAtTheEnd : bool

    Full name: FSharp.Compiler.Ast.LongIdentWithDots
    -
    val ident : LongIdent
    -
    val names : string
    -
    Multiple items
    type String =
      new : value:char -> string + 7 overloads
      member Chars : int -> char
      member Clone : unit -> obj
      member CompareTo : value:obj -> int + 1 overload
      member Contains : value:string -> bool
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EndsWith : value:string -> bool + 2 overloads
      member Equals : obj:obj -> bool + 2 overloads
      member GetEnumerator : unit -> CharEnumerator
      member GetHashCode : unit -> int
      ...

    Full name: System.String

    --------------------
    String(value: nativeptr<char>) : unit
    String(value: nativeptr<sbyte>) : unit
    String(value: char []) : unit
    String(c: char, count: int) : unit
    String(value: nativeptr<char>, startIndex: int, length: int) : unit
    String(value: nativeptr<sbyte>, startIndex: int, length: int) : unit
    String(value: char [], startIndex: int, length: int) : unit
    String(value: nativeptr<sbyte>, startIndex: int, length: int, enc: Text.Encoding) : unit
    -
    val concat : sep:string -> strings:seq<string> -> string

    Full name: Microsoft.FSharp.Core.String.concat
    -
    val visitExpression : _arg1:SynExpr -> unit

    Full name: Untypedtree.visitExpression


     式を走査する。
     式に2つあるいは3つの部分式が含まれていた場合('else'の分岐がない場合は2つ)、
     let式にはパターンおよび2つの部分式が含まれる
    -
    type SynExpr =
      | Paren of expr: SynExpr * leftParenRange: range * rightParenRange: range option * range: range
      | Quote of operator: SynExpr * isRaw: bool * quotedSynExpr: SynExpr * isFromQueryExpression: bool * range: range
      | Const of constant: SynConst * range: range
      | Typed of expr: SynExpr * typeName: SynType * range: range
      | Tuple of isStruct: bool * exprs: SynExpr list * commaRanges: range list * range: range
      | AnonRecd of isStruct: bool * copyInfo: (SynExpr * BlockSeparator) option * recordFields: (Ident * SynExpr) list * range: range
      | ArrayOrList of isList: bool * exprs: SynExpr list * range: range
      | Record of baseInfo: (SynType * SynExpr * range * BlockSeparator option * range) option * copyInfo: (SynExpr * BlockSeparator) option * recordFields: (RecordFieldName * SynExpr option * BlockSeparator option) list * range: range
      | New of isProtected: bool * typeName: SynType * expr: SynExpr * range: range
      | ObjExpr of objType: SynType * argOptions: (SynExpr * Ident option) option * bindings: SynBinding list * extraImpls: SynInterfaceImpl list * newExprRange: range * range: range
      ...
      member IsArbExprAndThusAlreadyReportedError : bool
      member Range : range
      member RangeOfFirstPortion : range
      member RangeSansAnyExtraDot : range

    Full name: FSharp.Compiler.Ast.SynExpr
    -
    union case SynExpr.IfThenElse: ifExpr: SynExpr * thenExpr: SynExpr * elseExpr: SynExpr option * spIfToThen: SequencePointInfoForBinding * isFromErrorRecovery: bool * ifToThenRange: FSharp.Compiler.Range.range * range: FSharp.Compiler.Range.range -> SynExpr
    -
    val cond : SynExpr
    -
    val trueBranch : SynExpr
    -
    val falseBranchOpt : SynExpr option
    -
    module Option

    from Microsoft.FSharp.Core
    -
    val iter : action:('T -> unit) -> option:'T option -> unit

    Full name: Microsoft.FSharp.Core.Option.iter
    -
    union case SynExpr.LetOrUse: isRecursive: bool * isUse: bool * bindings: SynBinding list * body: SynExpr * range: FSharp.Compiler.Range.range -> SynExpr
    -
    val bindings : SynBinding list
    -
    val body : SynExpr
    -
    union case SynBinding.Binding: accessibility: SynAccess option * kind: SynBindingKind * mustInline: bool * isMutable: bool * attrs: SynAttributes * xmlDoc: PreXmlDoc * valData: SynValData * headPat: SynPat * returnInfo: SynBindingReturnInfo option * expr: SynExpr * range: FSharp.Compiler.Range.range * seqPoint: SequencePointInfoForBinding -> SynBinding
    -
    val expr : SynExpr
    -
    val visitDeclarations : decls:seq<SynModuleDecl> -> unit

    Full name: Untypedtree.visitDeclarations


     モジュール内の宣言リストを走査する。
     モジュール内のトップレベルに記述できるすべての要素
     (letバインディングやネストされたモジュール、型の宣言など)が対象になる。
    -
    val decls : seq<SynModuleDecl>
    -
    val declaration : SynModuleDecl
    -
    type SynModuleDecl =
      | ModuleAbbrev of ident: Ident * longId: LongIdent * range: range
      | NestedModule of SynComponentInfo * isRecursive: bool * SynModuleDecls * bool * range: range
      | Let of isRecursive: bool * SynBinding list * range: range
      | DoExpr of SequencePointInfoForBinding * SynExpr * range: range
      | Types of SynTypeDefn list * range: range
      | Exception of SynExceptionDefn * range: range
      | Open of longDotId: LongIdentWithDots * range: range
      | Attributes of SynAttributes * range: range
      | HashDirective of ParsedHashDirective * range: range
      | NamespaceFragment of SynModuleOrNamespace
      member Range : range

    Full name: FSharp.Compiler.Ast.SynModuleDecl
    -
    union case SynModuleDecl.Let: isRecursive: bool * SynBinding list * range: FSharp.Compiler.Range.range -> SynModuleDecl
    -
    val isRec : bool
    -
    val range : FSharp.Compiler.Range.range
    -
    val visitModulesAndNamespaces : modulesOrNss:seq<SynModuleOrNamespace> -> unit

    Full name: Untypedtree.visitModulesAndNamespaces


     すべてのモジュールや名前空間の宣言を走査する
     (基本的には 'module Foo =' または 'namespace Foo.Bar' というコード)
     なおファイル中で明示的に定義されていない場合であっても
     暗黙的にモジュールまたは名前空間の宣言が存在することに注意。
    -
    val modulesOrNss : seq<SynModuleOrNamespace>
    -
    val moduleOrNs : SynModuleOrNamespace
    -
    Multiple items
    union case SynModuleOrNamespace.SynModuleOrNamespace: longId: LongIdent * isRecursive: bool * kind: SynModuleOrNamespaceKind * decls: SynModuleDecls * xmlDoc: PreXmlDoc * attribs: SynAttributes * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynModuleOrNamespace

    --------------------
    type SynModuleOrNamespace =
      | SynModuleOrNamespace of longId: LongIdent * isRecursive: bool * kind: SynModuleOrNamespaceKind * decls: SynModuleDecls * xmlDoc: PreXmlDoc * attribs: SynAttributes * accessibility: SynAccess option * range: range
      member Range : range

    Full name: FSharp.Compiler.Ast.SynModuleOrNamespace
    -
    val lid : LongIdent
    -
    val isMod : SynModuleOrNamespaceKind
    -
    val decls : SynModuleDecls
    -
    val xml : PreXmlDoc
    -
    val attrs : SynAttributes
    -
    val m : FSharp.Compiler.Range.range
    -
    val input : string

    Full name: Untypedtree.input
    -
    val file : string

    Full name: Untypedtree.file
    -
    val tree : ParsedInput

    Full name: Untypedtree.tree
    -
    Multiple items
    module ParsedInput

    from FSharp.Compiler.SourceCodeServices

    --------------------
    type ParsedInput =
      | ImplFile of ParsedImplFileInput
      | SigFile of ParsedSigFileInput
      member Range : range

    Full name: FSharp.Compiler.Ast.ParsedInput
    -
    union case ParsedInput.ImplFile: ParsedImplFileInput -> ParsedInput
    -
    val implFile : ParsedImplFileInput
    -
    Multiple items
    union case ParsedImplFileInput.ParsedImplFileInput: fileName: string * isScript: bool * qualifiedNameOfFile: QualifiedNameOfFile * scopedPragmas: ScopedPragma list * hashDirectives: ParsedHashDirective list * modules: SynModuleOrNamespace list * isLastCompiland: bool * bool -> ParsedImplFileInput

    --------------------
    type ParsedImplFileInput = | ParsedImplFileInput of fileName: string * isScript: bool * qualifiedNameOfFile: QualifiedNameOfFile * scopedPragmas: ScopedPragma list * hashDirectives: ParsedHashDirective list * modules: SynModuleOrNamespace list * isLastCompiland: bool * bool

    Full name: FSharp.Compiler.Ast.ParsedImplFileInput
    -
    val fn : string
    -
    val script : bool
    -
    val name : QualifiedNameOfFile
    -
    val modules : SynModuleOrNamespace list
    - -
    -
    - - - - -
    -
    -
    - Fork me on GitHub - - diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilalignment.html b/docs/reference/fsharp-compiler-abstractil-il-ilalignment.html new file mode 100644 index 0000000000..3a5919c000 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilalignment.html @@ -0,0 +1,154 @@ + + + + + ILAlignment - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILAlignment

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Aligned + +
    + Signature:
    +
    +     		+ +
    + + Unaligned1 + +
    + Signature:
    +
    +     		+ +
    + + Unaligned2 + +
    + Signature:
    +
    +     		+ +
    + + Unaligned4 + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilargconvention.html b/docs/reference/fsharp-compiler-abstractil-il-ilargconvention.html new file mode 100644 index 0000000000..6bf74557bc --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilargconvention.html @@ -0,0 +1,187 @@ + + + + + ILArgConvention - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILArgConvention

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + CDecl + +
    + Signature:
    +
    +     		+ +
    + + Default + +
    + Signature:
    +
    +     		+ +
    + + FastCall + +
    + Signature:
    +
    +     		+ +
    + + StdCall + +
    + Signature:
    +
    +     		+ +
    + + ThisCall + +
    + Signature:
    +
    +     		+ +
    + + VarArg + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilarraybound.html b/docs/reference/fsharp-compiler-abstractil-il-ilarraybound.html new file mode 100644 index 0000000000..7cc35c6207 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilarraybound.html @@ -0,0 +1,172 @@ + + + + + ILArrayBound - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILArrayBound

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Array shapes. For most purposes the rank is the only thing that matters.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.IsNone + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsNone

    +
    + + x.IsSome + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSome

    +
    + + x.Value + +
    + Signature: int32
    + + Attributes:
    +[<CompilationRepresentation(2)>]
    +     +
    +     		+ +

    CompiledName: get_Value

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + Option.None + +
    + Signature: int32 option
    +
    +     		+ +

    CompiledName: get_None

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilarraybounds.html b/docs/reference/fsharp-compiler-abstractil-il-ilarraybounds.html new file mode 100644 index 0000000000..5ddd04cd4c --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilarraybounds.html @@ -0,0 +1,130 @@ + + + + + ILArrayBounds - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILArrayBounds

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Lower-bound/size pairs

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: ILArrayBound
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: ILArrayBound
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilarrayshape.html b/docs/reference/fsharp-compiler-abstractil-il-ilarrayshape.html new file mode 100644 index 0000000000..f73fdba595 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilarrayshape.html @@ -0,0 +1,174 @@ + + + + + ILArrayShape - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILArrayShape

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + ILArrayShape(ILArrayBounds list) + +
    + Signature: ILArrayBounds list
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Rank + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Rank

    +
    +

    Static members

    + + + + + + + + + + + + + + +
    Static memberDescription
    + + ILArrayShape.FromRank(arg1) + +
    + Signature: int -> ILArrayShape
    +
    +     		+ +
    + + ILArrayShape.SingleDimensional + +
    + Signature: ILArrayShape
    +
    +     		+

    Bounds for a single dimensional, zero based array

    + + +

    CompiledName: get_SingleDimensional

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilassemblylongevity.html b/docs/reference/fsharp-compiler-abstractil-il-ilassemblylongevity.html new file mode 100644 index 0000000000..1cae1ffa92 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilassemblylongevity.html @@ -0,0 +1,172 @@ + + + + + ILAssemblyLongevity - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILAssemblyLongevity

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Library + +
    + Signature:
    +
    +     		+ +
    + + PlatformAppDomain + +
    + Signature:
    +
    +     		+ +
    + + PlatformProcess + +
    + Signature:
    +
    +     		+ +
    + + PlatformSystem + +
    + Signature:
    +
    +     		+ +
    + + Unspecified + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilassemblymanifest.html b/docs/reference/fsharp-compiler-abstractil-il-ilassemblymanifest.html new file mode 100644 index 0000000000..f890466b70 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilassemblymanifest.html @@ -0,0 +1,352 @@ + + + + + ILAssemblyManifest - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILAssemblyManifest

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    The main module of an assembly is a module plus some manifest information.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + AssemblyLongevity + +
    + Signature: ILAssemblyLongevity
    +
    +     		+ +
    + + AuxModuleHashAlgorithm + +
    + Signature: int32
    +
    +     		+

    This is the ID of the algorithm used for the hashes of auxiliary +files in the assembly. These hashes are stored in the +ILModuleRef.Hash fields of this assembly. These are not +cryptographic hashes: they are simple file hashes. The algorithm +is normally 0x00008004 indicating the SHA1 hash algorithm.

    + + +
    + + CustomAttrsStored + +
    + Signature: ILAttributesStored
    +
    +     		+ +
    + + DisableJitOptimizations + +
    + Signature: bool
    +
    +     		+ +
    + + EntrypointElsewhere + +
    + Signature: ILModuleRef option
    +
    +     		+

    Records whether the entrypoint resides in another module.

    + + +
    + + ExportedTypes + +
    + Signature: ILExportedTypesAndForwarders
    +
    +     		+

    Records the types implemented by this assembly in auxiliary +modules.

    + + +
    + + IgnoreSymbolStoreSequencePoints + +
    + Signature: bool
    +
    +     		+ +
    + + JitTracking + +
    + Signature: bool
    +
    +     		+ +
    + + Locale + +
    + Signature: string option
    +
    +     		+ +
    + + MetadataIndex + +
    + Signature: int32
    +
    +     		+ +
    + + Name + +
    + Signature: string
    +
    +     		+ +
    + + PublicKey + +
    + Signature: byte [] option
    +
    +     		+

    This is the public key used to sign this +assembly (the signature itself is stored elsewhere: see the +binary format, and may not have been written if delay signing +is used). (member Name, member PublicKey) forms the full +public name of the assembly.

    + + +
    + + Retargetable + +
    + Signature: bool
    +
    +     		+ +
    + + SecurityDeclsStored + +
    + Signature: ILSecurityDeclsStored
    +
    +     		+ +
    + + Version + +
    + Signature: ILVersionInfo option
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + + x.SecurityDecls + +
    + Signature: ILSecurityDecls
    +
    +     		+ +

    CompiledName: get_SecurityDecls

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilassemblyref.html b/docs/reference/fsharp-compiler-abstractil-il-ilassemblyref.html new file mode 100644 index 0000000000..ffe65802d0 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilassemblyref.html @@ -0,0 +1,256 @@ + + + + + ILAssemblyRef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILAssemblyRef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.EqualsIgnoringVersion(arg1) + +
    + Signature: ILAssemblyRef -> bool
    +
    +     		+ +
    + + x.Hash + +
    + Signature: byte [] option
    +
    +     		+ +

    CompiledName: get_Hash

    +
    + + x.Locale + +
    + Signature: string option
    +
    +     		+ +

    CompiledName: get_Locale

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + + x.PublicKey + +
    + Signature: PublicKey option
    +
    +     		+ +

    CompiledName: get_PublicKey

    +
    + + x.QualifiedName + +
    + Signature: string
    +
    +     		+

    The fully qualified name of the assembly reference, e.g. mscorlib, Version=1.0.3705 etc.

    + + +

    CompiledName: get_QualifiedName

    +
    + + x.Retargetable + +
    + Signature: bool
    +
    +     		+

    CLI says this indicates if the assembly can be retargeted (at runtime) to be from a different publisher.

    + + +

    CompiledName: get_Retargetable

    +
    + + x.Version + +
    + Signature: ILVersionInfo option
    +
    +     		+ +

    CompiledName: get_Version

    +
    +

    Static members

    + + + + + + + + + + + + + + +
    Static memberDescription
    + + ILAssemblyRef.Create(...) + +
    + Signature: (name:string * hash:byte [] option * publicKey:PublicKey option * retargetable:bool * version:ILVersionInfo option * locale:string option) -> ILAssemblyRef
    +
    +     		+ +
    + + ILAssemblyRef.FromAssemblyName(arg1) + +
    + Signature: AssemblyName -> ILAssemblyRef
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattribelem.html b/docs/reference/fsharp-compiler-abstractil-il-ilattribelem.html new file mode 100644 index 0000000000..6044b2c5f7 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilattribelem.html @@ -0,0 +1,331 @@ + + + + + ILAttribElem - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILAttribElem

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Array(ILType,ILAttribElem list) + +
    + Signature: ILType * ILAttribElem list
    +
    +     		+ +
    + + Bool(bool) + +
    + Signature: bool
    +
    +     		+ +
    + + Byte(byte) + +
    + Signature: byte
    +
    +     		+ +
    + + Char(char) + +
    + Signature: char
    +
    +     		+ +
    + + Double(double) + +
    + Signature: double
    +
    +     		+ +
    + + Int16(int16) + +
    + Signature: int16
    +
    +     		+ +
    + + Int32(int32) + +
    + Signature: int32
    +
    +     		+ +
    + + Int64(int64) + +
    + Signature: int64
    +
    +     		+ +
    + + Null + +
    + Signature:
    +
    +     		+ +
    + + SByte(sbyte) + +
    + Signature: sbyte
    +
    +     		+ +
    + + Single(single) + +
    + Signature: single
    +
    +     		+ +
    + + String(string option) + +
    + Signature: string option
    +
    +     		+

    Represents a custom attribute parameter of type 'string'. These may be null, in which case they are encoded in a special +way as indicated by Ecma-335 Partition II.

    + + +
    + + Type(ILType option) + +
    + Signature: ILType option
    +
    +     		+ +
    + + TypeRef(ILTypeRef option) + +
    + Signature: ILTypeRef option
    +
    +     		+ +
    + + UInt16(uint16) + +
    + Signature: uint16
    +
    +     		+ +
    + + UInt32(uint32) + +
    + Signature: uint32
    +
    +     		+ +
    + + UInt64(uint64) + +
    + Signature: uint64
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattribute.html b/docs/reference/fsharp-compiler-abstractil-il-ilattribute.html new file mode 100644 index 0000000000..215e44549c --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilattribute.html @@ -0,0 +1,188 @@ + + + + + ILAttribute - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILAttribute

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Custom attribute.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Decoded(method,fixedArgs,namedArgs) + +
    + Signature: ILMethodSpec * ILAttribElem list * ILAttributeNamedArg list
    +
    +     		+

    Attribute with args in decoded form.

    + + +
    + + Encoded(method,data,elements) + +
    + Signature: ILMethodSpec * byte [] * ILAttribElem list
    +
    +     		+

    Attribute with args encoded to a binary blob according to ECMA-335 II.21 and II.23.3. +'decodeILAttribData' is used to parse the byte[] blob to ILAttribElem's as best as possible.

    + + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Elements + +
    + Signature: ILAttribElem list
    +
    +     		+

    Decoded arguments. May be empty in encoded attribute form.

    + + +

    CompiledName: get_Elements

    +
    + + x.Method + +
    + Signature: ILMethodSpec
    +
    +     		+

    Attribute instance constructor.

    + + +

    CompiledName: get_Method

    +
    + + x.WithMethod(method) + +
    + Signature: method:ILMethodSpec -> ILAttribute
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattributenamedarg.html b/docs/reference/fsharp-compiler-abstractil-il-ilattributenamedarg.html new file mode 100644 index 0000000000..8cf39c1628 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilattributenamedarg.html @@ -0,0 +1,156 @@ + + + + + ILAttributeNamedArg - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILAttributeNamedArg

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Named args: values and flags indicating if they are fields or properties.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: string
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: ILType
    +
    +     		+ +
    + + x.Item3 + +
    + Signature: bool
    +
    +     		+ +
    + + x.Item4 + +
    + Signature: ILAttribElem
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattributes.html b/docs/reference/fsharp-compiler-abstractil-il-ilattributes.html new file mode 100644 index 0000000000..182f114d2f --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilattributes.html @@ -0,0 +1,137 @@ + + + + + ILAttributes - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILAttributes

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Struct>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AsArray + +
    + Signature: ILAttribute []
    +
    +     		+ +

    CompiledName: get_AsArray

    +
    + + x.AsList + +
    + Signature: ILAttribute list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilattributesstored.html b/docs/reference/fsharp-compiler-abstractil-il-ilattributesstored.html new file mode 100644 index 0000000000..f4f98f008b --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilattributesstored.html @@ -0,0 +1,102 @@ + + + + + ILAttributesStored - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILAttributesStored

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents the efficiency-oriented storage of ILAttributes in another item.

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilbasictype.html b/docs/reference/fsharp-compiler-abstractil-il-ilbasictype.html new file mode 100644 index 0000000000..2ceeee0033 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilbasictype.html @@ -0,0 +1,290 @@ + + + + + ILBasicType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILBasicType

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + DT_I + +
    + Signature:
    +
    +     		+ +
    + + DT_I1 + +
    + Signature:
    +
    +     		+ +
    + + DT_I2 + +
    + Signature:
    +
    +     		+ +
    + + DT_I4 + +
    + Signature:
    +
    +     		+ +
    + + DT_I8 + +
    + Signature:
    +
    +     		+ +
    + + DT_R + +
    + Signature:
    +
    +     		+ +
    + + DT_R4 + +
    + Signature:
    +
    +     		+ +
    + + DT_R8 + +
    + Signature:
    +
    +     		+ +
    + + DT_REF + +
    + Signature:
    +
    +     		+ +
    + + DT_U + +
    + Signature:
    +
    +     		+ +
    + + DT_U1 + +
    + Signature:
    +
    +     		+ +
    + + DT_U2 + +
    + Signature:
    +
    +     		+ +
    + + DT_U4 + +
    + Signature:
    +
    +     		+ +
    + + DT_U8 + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilboxity.html b/docs/reference/fsharp-compiler-abstractil-il-ilboxity.html new file mode 100644 index 0000000000..e2f1e52243 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilboxity.html @@ -0,0 +1,128 @@ + + + + + ILBoxity - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILBoxity

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AsObject + +
    + Signature:
    +
    +     		+ +
    + + AsValue + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcallingconv.html b/docs/reference/fsharp-compiler-abstractil-il-ilcallingconv.html new file mode 100644 index 0000000000..0231242463 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilcallingconv.html @@ -0,0 +1,235 @@ + + + + + ILCallingConv - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILCallingConv

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + Callconv(...) + +
    + Signature: ILThisConvention * ILArgConvention
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.BasicConv + +
    + Signature: ILArgConvention
    +
    +     		+ +

    CompiledName: get_BasicConv

    +
    + + x.IsInstance + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsInstance

    +
    + + x.IsInstanceExplicit + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsInstanceExplicit

    +
    + + x.IsStatic + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsStatic

    +
    + + x.ThisConv + +
    + Signature: ILThisConvention
    +
    +     		+ +

    CompiledName: get_ThisConv

    +
    +

    Static members

    + + + + + + + + + + + + + + +
    Static memberDescription
    + + ILCallingConv.Instance + +
    + Signature: ILCallingConv
    +
    +     		+ +

    CompiledName: get_Instance

    +
    + + ILCallingConv.Static + +
    + Signature: ILCallingConv
    +
    +     		+ +

    CompiledName: get_Static

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcallingsignature.html b/docs/reference/fsharp-compiler-abstractil-il-ilcallingsignature.html new file mode 100644 index 0000000000..d0606ab11b --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilcallingsignature.html @@ -0,0 +1,147 @@ + + + + + ILCallingSignature - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILCallingSignature

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + ArgTypes + +
    + Signature: ILTypes
    +
    +     		+ +
    + + CallingConv + +
    + Signature: ILCallingConv
    +
    +     		+ +
    + + ReturnType + +
    + Signature: ILType
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcode.html b/docs/reference/fsharp-compiler-abstractil-il-ilcode.html new file mode 100644 index 0000000000..799ab30e19 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilcode.html @@ -0,0 +1,161 @@ + + + + + ILCode - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILCode

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Exceptions + +
    + Signature: ILExceptionSpec list
    +
    +     		+ +
    + + Instrs + +
    + Signature: ILInstr []
    +
    +     		+ +
    + + Labels + +
    + Signature: Dictionary<ILCodeLabel,int>
    +
    +     		+ +
    + + Locals + +
    + Signature: ILLocalDebugInfo list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcodelabel.html b/docs/reference/fsharp-compiler-abstractil-il-ilcodelabel.html new file mode 100644 index 0000000000..bff5fba8cc --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilcodelabel.html @@ -0,0 +1,96 @@ + + + + + ILCodeLabel - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILCodeLabel

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    ILCode labels. In structured code each code label refers to a basic block somewhere in the code of the method.

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilcomparisoninstr.html b/docs/reference/fsharp-compiler-abstractil-il-ilcomparisoninstr.html new file mode 100644 index 0000000000..23bef4f6e0 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilcomparisoninstr.html @@ -0,0 +1,264 @@ + + + + + ILComparisonInstr - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILComparisonInstr

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + BI_beq + +
    + Signature:
    +
    +     		+ +
    + + BI_bge + +
    + Signature:
    +
    +     		+ +
    + + BI_bge_un + +
    + Signature:
    +
    +     		+ +
    + + BI_bgt + +
    + Signature:
    +
    +     		+ +
    + + BI_bgt_un + +
    + Signature:
    +
    +     		+ +
    + + BI_ble + +
    + Signature:
    +
    +     		+ +
    + + BI_ble_un + +
    + Signature:
    +
    +     		+ +
    + + BI_blt + +
    + Signature:
    +
    +     		+ +
    + + BI_blt_un + +
    + Signature:
    +
    +     		+ +
    + + BI_bne_un + +
    + Signature:
    +
    +     		+ +
    + + BI_brfalse + +
    + Signature:
    +
    +     		+ +
    + + BI_brtrue + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilconst.html b/docs/reference/fsharp-compiler-abstractil-il-ilconst.html new file mode 100644 index 0000000000..ae1f0b2862 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilconst.html @@ -0,0 +1,161 @@ + + + + + ILConst - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILConst

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + I4(int32) + +
    + Signature: int32
    +
    +     		+ +
    + + I8(int64) + +
    + Signature: int64
    +
    +     		+ +
    + + R4(single) + +
    + Signature: single
    +
    +     		+ +
    + + R8(double) + +
    + Signature: double
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ildefaultpinvokeencoding.html b/docs/reference/fsharp-compiler-abstractil-il-ildefaultpinvokeencoding.html new file mode 100644 index 0000000000..f6fec7099c --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ildefaultpinvokeencoding.html @@ -0,0 +1,148 @@ + + + + + ILDefaultPInvokeEncoding - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILDefaultPInvokeEncoding

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Default Unicode encoding for P/Invoke within a type.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Ansi + +
    + Signature:
    +
    +     		+ +
    + + Auto + +
    + Signature:
    +
    +     		+ +
    + + Unicode + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilenuminfo.html b/docs/reference/fsharp-compiler-abstractil-il-ilenuminfo.html new file mode 100644 index 0000000000..f17e7ca65c --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilenuminfo.html @@ -0,0 +1,130 @@ + + + + + ILEnumInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILEnumInfo

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Decompose a type definition according to its kind.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + enumType + +
    + Signature: ILType
    +
    +     		+ +
    + + enumValues + +
    + Signature: (string * ILFieldInit) list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ileventdef.html b/docs/reference/fsharp-compiler-abstractil-il-ileventdef.html new file mode 100644 index 0000000000..127a2213df --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ileventdef.html @@ -0,0 +1,305 @@ + + + + + ILEventDef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILEventDef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    Event definitions.

    + +
    +

    Constructors

    + + + + + + + + + + + + + + +
    ConstructorDescription
    + + new(...) + +
    + Signature: (eventType:ILType option * name:string * attributes:EventAttributes * addMethod:ILMethodRef * removeMethod:ILMethodRef * fireMethod:ILMethodRef option * otherMethods:ILMethodRef list * customAttrs:ILAttributes) -> ILEventDef
    +
    +     		+

    Functional creation of a value, immediate

    + + +

    CompiledName: .ctor

    +
    + + new(...) + +
    + Signature: (eventType:ILType option * name:string * attributes:EventAttributes * addMethod:ILMethodRef * removeMethod:ILMethodRef * fireMethod:ILMethodRef option * otherMethods:ILMethodRef list * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILEventDef
    +
    +     		+

    Functional creation of a value, using delayed reading via a metadata index, for ilread.fs

    + + +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AddMethod + +
    + Signature: ILMethodRef
    +
    +     		+ +

    CompiledName: get_AddMethod

    +
    + + x.Attributes + +
    + Signature: EventAttributes
    +
    +     		+ +

    CompiledName: get_Attributes

    +
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + + x.EventType + +
    + Signature: ILType option
    +
    +     		+ +

    CompiledName: get_EventType

    +
    + + x.FireMethod + +
    + Signature: ILMethodRef option
    +
    +     		+ +

    CompiledName: get_FireMethod

    +
    + + x.IsRTSpecialName + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsRTSpecialName

    +
    + + x.IsSpecialName + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSpecialName

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + + x.OtherMethods + +
    + Signature: ILMethodRef list
    +
    +     		+ +

    CompiledName: get_OtherMethods

    +
    + + x.RemoveMethod + +
    + Signature: ILMethodRef
    +
    +     		+ +

    CompiledName: get_RemoveMethod

    +
    + + x.With(...) + +
    + Signature: (eventType:ILType option option * name:string option * attributes:EventAttributes option * addMethod:ILMethodRef option * removeMethod:ILMethodRef option * fireMethod:ILMethodRef option option * otherMethods:ILMethodRef list option * customAttrs:ILAttributes option) -> ILEventDef
    +
    +     		+

    Functional update of the value

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ileventdefs.html b/docs/reference/fsharp-compiler-abstractil-il-ileventdefs.html new file mode 100644 index 0000000000..fcedf88bcf --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ileventdefs.html @@ -0,0 +1,138 @@ + + + + + ILEventDefs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILEventDefs

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +

    Table of those events in a type definition.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AsList + +
    + Signature: ILEventDef list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + + x.LookupByName(arg1) + +
    + Signature: string -> ILEventDef list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ileventref.html b/docs/reference/fsharp-compiler-abstractil-il-ileventref.html new file mode 100644 index 0000000000..eef218b657 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ileventref.html @@ -0,0 +1,158 @@ + + + + + ILEventRef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILEventRef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    A utility type provided for completeness

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DeclaringTypeRef + +
    + Signature: ILTypeRef
    +
    +     		+ +

    CompiledName: get_DeclaringTypeRef

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + ILEventRef.Create(arg1, arg2) + +
    + Signature: (ILTypeRef * string) -> ILEventRef
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilexceptionclause.html b/docs/reference/fsharp-compiler-abstractil-il-ilexceptionclause.html new file mode 100644 index 0000000000..e7c87a65e3 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilexceptionclause.html @@ -0,0 +1,159 @@ + + + + + ILExceptionClause - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILExceptionClause

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Fault(ILCodeLabel * ILCodeLabel) + +
    + Signature: ILCodeLabel * ILCodeLabel
    +
    +     		+ +
    + + FilterCatch(...) + +
    + Signature: ILCodeLabel * ILCodeLabel * ILCodeLabel * ILCodeLabel
    +
    +     		+ +
    + + Finally(ILCodeLabel * ILCodeLabel) + +
    + Signature: ILCodeLabel * ILCodeLabel
    +
    +     		+ +
    + + TypeCatch(...) + +
    + Signature: ILType * ILCodeLabel * ILCodeLabel
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilexceptionspec.html b/docs/reference/fsharp-compiler-abstractil-il-ilexceptionspec.html new file mode 100644 index 0000000000..01f47f97a2 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilexceptionspec.html @@ -0,0 +1,135 @@ + + + + + ILExceptionSpec - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILExceptionSpec

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Clause + +
    + Signature: ILExceptionClause
    +
    +     		+ +
    + + Range + +
    + Signature: ILCodeLabel * ILCodeLabel
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypeorforwarder.html b/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypeorforwarder.html new file mode 100644 index 0000000000..c7053e55b7 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypeorforwarder.html @@ -0,0 +1,240 @@ + + + + + ILExportedTypeOrForwarder - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILExportedTypeOrForwarder

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    these are only found in the ILExportedTypesAndForwarders table in the manifest

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Attributes + +
    + Signature: TypeAttributes
    +
    +     		+ +
    + + CustomAttrsStored + +
    + Signature: ILAttributesStored
    +
    +     		+ +
    + + MetadataIndex + +
    + Signature: int32
    +
    +     		+ +
    + + Name + +
    + Signature: string
    +
    +     		+

    [Namespace.]Name

    + + +
    + + Nested + +
    + Signature: ILNestedExportedTypes
    +
    +     		+ +
    + + ScopeRef + +
    + Signature: ILScopeRef
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Access + +
    + Signature: ILTypeDefAccess
    +
    +     		+ +

    CompiledName: get_Access

    +
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + + x.IsForwarder + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsForwarder

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypesandforwarders.html b/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypesandforwarders.html new file mode 100644 index 0000000000..841960028d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilexportedtypesandforwarders.html @@ -0,0 +1,136 @@ + + + + + ILExportedTypesAndForwarders - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILExportedTypesAndForwarders

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AsList + +
    + Signature: ILExportedTypeOrForwarder list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + + x.TryFindByName(arg1) + +
    + Signature: string -> ILExportedTypeOrForwarder option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfielddef.html b/docs/reference/fsharp-compiler-abstractil-il-ilfielddef.html new file mode 100644 index 0000000000..c26a3e1143 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilfielddef.html @@ -0,0 +1,454 @@ + + + + + ILFieldDef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILFieldDef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    Field definitions.

    + +
    +

    Constructors

    + + + + + + + + + + + + + + +
    ConstructorDescription
    + + new(...) + +
    + Signature: (name:string * fieldType:ILType * attributes:FieldAttributes * data:byte [] option * literalValue:ILFieldInit option * offset:int32 option * marshal:ILNativeType option * customAttrs:ILAttributes) -> ILFieldDef
    +
    +     		+

    Functional creation of a value, immediate

    + + +

    CompiledName: .ctor

    +
    + + new(...) + +
    + Signature: (name:string * fieldType:ILType * attributes:FieldAttributes * data:byte [] option * literalValue:ILFieldInit option * offset:int32 option * marshal:ILNativeType option * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILFieldDef
    +
    +     		+

    Functional creation of a value using delayed reading via a metadata index

    + + +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Access + +
    + Signature: ILMemberAccess
    +
    +     		+ +

    CompiledName: get_Access

    +
    + + x.Attributes + +
    + Signature: FieldAttributes
    +
    +     		+ +

    CompiledName: get_Attributes

    +
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + + x.Data + +
    + Signature: byte [] option
    +
    +     		+ +

    CompiledName: get_Data

    +
    + + x.FieldType + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_FieldType

    +
    + + x.IsInitOnly + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsInitOnly

    +
    + + x.IsLiteral + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsLiteral

    +
    + + x.IsSpecialName + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSpecialName

    +
    + + x.IsStatic + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsStatic

    +
    + + x.LiteralValue + +
    + Signature: ILFieldInit option
    +
    +     		+ +

    CompiledName: get_LiteralValue

    +
    + + x.Marshal + +
    + Signature: ILNativeType option
    +
    +     		+ +

    CompiledName: get_Marshal

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + + x.NotSerialized + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_NotSerialized

    +
    + + x.Offset + +
    + Signature: int32 option
    +
    +     		+

    The explicit offset in bytes when explicit layout is used.

    + + +

    CompiledName: get_Offset

    +
    + + x.With(...) + +
    + Signature: (name:string option * fieldType:ILType option * attributes:FieldAttributes option * data:byte [] option option * literalValue:ILFieldInit option option * offset:int32 option option * marshal:ILNativeType option option * customAttrs:ILAttributes option) -> ILFieldDef
    +
    +     		+

    Functional update of the value

    + + +
    + + x.WithAccess(arg1) + +
    + Signature: ILMemberAccess -> ILFieldDef
    +
    +     		+ +
    + + x.WithFieldMarshal(arg1) + +
    + Signature: (ILNativeType option) -> ILFieldDef
    +
    +     		+ +
    + + x.WithInitOnly(arg1) + +
    + Signature: bool -> ILFieldDef
    +
    +     		+ +
    + + x.WithLiteralDefaultValue(arg1) + +
    + Signature: (ILFieldInit option) -> ILFieldDef
    +
    +     		+ +
    + + x.WithNotSerialized(arg1) + +
    + Signature: bool -> ILFieldDef
    +
    +     		+ +
    + + x.WithSpecialName(arg1) + +
    + Signature: bool -> ILFieldDef
    +
    +     		+ +
    + + x.WithStatic(arg1) + +
    + Signature: bool -> ILFieldDef
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfielddefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilfielddefs.html new file mode 100644 index 0000000000..18f2ae02f6 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilfielddefs.html @@ -0,0 +1,139 @@ + + + + + ILFieldDefs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILFieldDefs

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +

    Tables of fields. Logically equivalent to a list of fields but the table is kept in +a form to allow efficient looking up fields by name.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AsList + +
    + Signature: ILFieldDef list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + + x.LookupByName(arg1) + +
    + Signature: string -> ILFieldDef list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfieldinit.html b/docs/reference/fsharp-compiler-abstractil-il-ilfieldinit.html new file mode 100644 index 0000000000..c887a60ad0 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilfieldinit.html @@ -0,0 +1,293 @@ + + + + + ILFieldInit - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILFieldInit

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +

    Field Init

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Bool(bool) + +
    + Signature: bool
    +
    +     		+ +
    + + Char(uint16) + +
    + Signature: uint16
    +
    +     		+ +
    + + Double(double) + +
    + Signature: double
    +
    +     		+ +
    + + Int16(int16) + +
    + Signature: int16
    +
    +     		+ +
    + + Int32(int32) + +
    + Signature: int32
    +
    +     		+ +
    + + Int64(int64) + +
    + Signature: int64
    +
    +     		+ +
    + + Int8(sbyte) + +
    + Signature: sbyte
    +
    +     		+ +
    + + Null + +
    + Signature:
    +
    +     		+ +
    + + Single(single) + +
    + Signature: single
    +
    +     		+ +
    + + String(string) + +
    + Signature: string
    +
    +     		+ +
    + + UInt16(uint16) + +
    + Signature: uint16
    +
    +     		+ +
    + + UInt32(uint32) + +
    + Signature: uint32
    +
    +     		+ +
    + + UInt64(uint64) + +
    + Signature: uint64
    +
    +     		+ +
    + + UInt8(byte) + +
    + Signature: byte
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfieldref.html b/docs/reference/fsharp-compiler-abstractil-il-ilfieldref.html new file mode 100644 index 0000000000..af6fc7eb8c --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilfieldref.html @@ -0,0 +1,149 @@ + + + + + ILFieldRef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILFieldRef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +

    Formal identities of fields.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + DeclaringTypeRef + +
    + Signature: ILTypeRef
    +
    +     		+ +
    + + Name + +
    + Signature: string
    +
    +     		+ +
    + + Type + +
    + Signature: ILType
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilfieldspec.html b/docs/reference/fsharp-compiler-abstractil-il-ilfieldspec.html new file mode 100644 index 0000000000..9df0ab3de6 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilfieldspec.html @@ -0,0 +1,200 @@ + + + + + ILFieldSpec - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILFieldSpec

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +

    Field specs. The data given for a ldfld, stfld etc. instruction.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + DeclaringType + +
    + Signature: ILType
    +
    +     		+ +
    + + FieldRef + +
    + Signature: ILFieldRef
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.ActualType + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_ActualType

    +
    + + x.DeclaringTypeRef + +
    + Signature: ILTypeRef
    +
    +     		+ +

    CompiledName: get_DeclaringTypeRef

    +
    + + x.FormalType + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_FormalType

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericargs.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericargs.html new file mode 100644 index 0000000000..20a9926ffd --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilgenericargs.html @@ -0,0 +1,196 @@ + + + + + ILGenericArgs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILGenericArgs

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Actual generic parameters are always types.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> ILType
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: ILType list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: ILType list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericargslist.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericargslist.html new file mode 100644 index 0000000000..7a92f6d60b --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilgenericargslist.html @@ -0,0 +1,194 @@ + + + + + ILGenericArgsList - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILGenericArgsList

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> ILType
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: ILType list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: ILType list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdef.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdef.html new file mode 100644 index 0000000000..3a3ae1f85a --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdef.html @@ -0,0 +1,244 @@ + + + + + ILGenericParameterDef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILGenericParameterDef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Generic parameters. Formal generic parameter declarations may include the bounds, if any, on the generic parameter.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Constraints + +
    + Signature: ILTypes
    +
    +     		+

    At most one is the parent type, the others are interface types.

    + + +
    + + CustomAttrsStored + +
    + Signature: ILAttributesStored
    +
    +     		+

    Do not use this

    + + +
    + + HasDefaultConstructorConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates the type argument must have a public nullary constructor.

    + + +
    + + HasNotNullableValueTypeConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates the type argument must be a value type, but not Nullable.

    + + +
    + + HasReferenceTypeConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates the type argument must be a reference type.

    + + +
    + + MetadataIndex + +
    + Signature: int32
    +
    +     		+

    Do not use this

    + + +
    + + Name + +
    + Signature: string
    +
    +     		+ +
    + + Variance + +
    + Signature: ILGenericVariance
    +
    +     		+

    Variance of type parameters, only applicable to generic parameters for generic interfaces and delegates.

    + + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdefs.html new file mode 100644 index 0000000000..418a024831 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilgenericparameterdefs.html @@ -0,0 +1,194 @@ + + + + + ILGenericParameterDefs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILGenericParameterDefs

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: ILGenericParameterDef
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> ILGenericParameterDef
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: ILGenericParameterDef list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: ILGenericParameterDef list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilgenericvariance.html b/docs/reference/fsharp-compiler-abstractil-il-ilgenericvariance.html new file mode 100644 index 0000000000..131eabb6a5 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilgenericvariance.html @@ -0,0 +1,141 @@ + + + + + ILGenericVariance - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILGenericVariance

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ContraVariant + +
    + Signature:
    +
    +     		+ +
    + + CoVariant + +
    + Signature:
    +
    +     		+ +
    + + NonVariant + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilglobals.html b/docs/reference/fsharp-compiler-abstractil-il-ilglobals.html new file mode 100644 index 0000000000..8a14cfdcb1 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilglobals.html @@ -0,0 +1,443 @@ + + + + + ILGlobals - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILGlobals

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Class>]
    + +     +

    +
    +

    A table of common references to items in primary assembly (System.Runtime or mscorlib). +If a particular version of System.Runtime.dll has been loaded then you should +reference items from it via an ILGlobals for that specific version built using mkILGlobals.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.IsPossiblePrimaryAssemblyRef(arg1) + +
    + Signature: ILAssemblyRef -> bool
    +
    +     		+

    Is the given assembly possibly a primary assembly? +In practice, a primary assembly is an assembly that contains the System.Object type definition +and has no referenced assemblies. +However, we must consider assemblies that forward the System.Object type definition +to be possible primary assemblies. +Therefore, this will return true if the given assembly is the real primary assembly or an assembly that forwards +the System.Object type definition. +Assembly equivalency ignores the version here.

    + + +
    + + x.primaryAssemblyName + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_primaryAssemblyName

    +
    + + x.primaryAssemblyRef + +
    + Signature: ILAssemblyRef
    +
    +     		+ +

    CompiledName: get_primaryAssemblyRef

    +
    + + x.primaryAssemblyScopeRef + +
    + Signature: ILScopeRef
    +
    +     		+ +

    CompiledName: get_primaryAssemblyScopeRef

    +
    + + x.typ_Array + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Array

    +
    + + x.typ_Bool + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Bool

    +
    + + x.typ_Byte + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Byte

    +
    + + x.typ_Char + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Char

    +
    + + x.typ_Double + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Double

    +
    + + x.typ_Int16 + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Int16

    +
    + + x.typ_Int32 + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Int32

    +
    + + x.typ_Int64 + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Int64

    +
    + + x.typ_IntPtr + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_IntPtr

    +
    + + x.typ_Object + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Object

    +
    + + x.typ_SByte + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_SByte

    +
    + + x.typ_Single + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Single

    +
    + + x.typ_String + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_String

    +
    + + x.typ_Type + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_Type

    +
    + + x.typ_TypedReference + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_TypedReference

    +
    + + x.typ_UInt16 + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_UInt16

    +
    + + x.typ_UInt32 + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_UInt32

    +
    + + x.typ_UInt64 + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_UInt64

    +
    + + x.typ_UIntPtr + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_typ_UIntPtr

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilguid.html b/docs/reference/fsharp-compiler-abstractil-il-ilguid.html new file mode 100644 index 0000000000..46080b7934 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilguid.html @@ -0,0 +1,96 @@ + + + + + ILGuid - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILGuid

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Represents guids

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilinstr.html b/docs/reference/fsharp-compiler-abstractil-il-ilinstr.html new file mode 100644 index 0000000000..927cf1295d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilinstr.html @@ -0,0 +1,1358 @@ + + + + + ILInstr - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILInstr

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The instruction set.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AI_add + +
    + Signature:
    +
    +     		+ +
    + + AI_add_ovf + +
    + Signature:
    +
    +     		+ +
    + + AI_add_ovf_un + +
    + Signature:
    +
    +     		+ +
    + + AI_and + +
    + Signature:
    +
    +     		+ +
    + + AI_ceq + +
    + Signature:
    +
    +     		+ +
    + + AI_cgt + +
    + Signature:
    +
    +     		+ +
    + + AI_cgt_un + +
    + Signature:
    +
    +     		+ +
    + + AI_ckfinite + +
    + Signature:
    +
    +     		+ +
    + + AI_clt + +
    + Signature:
    +
    +     		+ +
    + + AI_clt_un + +
    + Signature:
    +
    +     		+ +
    + + AI_conv(ILBasicType) + +
    + Signature: ILBasicType
    +
    +     		+ +
    + + AI_conv_ovf(ILBasicType) + +
    + Signature: ILBasicType
    +
    +     		+ +
    + + AI_conv_ovf_un(ILBasicType) + +
    + Signature: ILBasicType
    +
    +     		+ +
    + + AI_div + +
    + Signature:
    +
    +     		+ +
    + + AI_div_un + +
    + Signature:
    +
    +     		+ +
    + + AI_dup + +
    + Signature:
    +
    +     		+ +
    + + AI_ldc(ILBasicType,ILConst) + +
    + Signature: ILBasicType * ILConst
    +
    +     		+ +
    + + AI_ldnull + +
    + Signature:
    +
    +     		+ +
    + + AI_mul + +
    + Signature:
    +
    +     		+ +
    + + AI_mul_ovf + +
    + Signature:
    +
    +     		+ +
    + + AI_mul_ovf_un + +
    + Signature:
    +
    +     		+ +
    + + AI_neg + +
    + Signature:
    +
    +     		+ +
    + + AI_nop + +
    + Signature:
    +
    +     		+ +
    + + AI_not + +
    + Signature:
    +
    +     		+ +
    + + AI_or + +
    + Signature:
    +
    +     		+ +
    + + AI_pop + +
    + Signature:
    +
    +     		+ +
    + + AI_rem + +
    + Signature:
    +
    +     		+ +
    + + AI_rem_un + +
    + Signature:
    +
    +     		+ +
    + + AI_shl + +
    + Signature:
    +
    +     		+ +
    + + AI_shr + +
    + Signature:
    +
    +     		+ +
    + + AI_shr_un + +
    + Signature:
    +
    +     		+ +
    + + AI_sub + +
    + Signature:
    +
    +     		+ +
    + + AI_sub_ovf + +
    + Signature:
    +
    +     		+ +
    + + AI_sub_ovf_un + +
    + Signature:
    +
    +     		+ +
    + + AI_xor + +
    + Signature:
    +
    +     		+ +
    + + EI_ilzero(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + EI_ldlen_multi(int32,int32) + +
    + Signature: int32 * int32
    +
    +     		+ +
    + + I_arglist + +
    + Signature:
    +
    +     		+ +
    + + I_box(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + I_br(ILCodeLabel) + +
    + Signature: ILCodeLabel
    +
    +     		+ +
    + + I_brcmp(ILComparisonInstr,ILCodeLabel) + +
    + Signature: ILComparisonInstr * ILCodeLabel
    +
    +     		+ +
    + + I_break + +
    + Signature:
    +
    +     		+ +
    + + I_call(...) + +
    + Signature: ILTailcall * ILMethodSpec * ILVarArgs
    +
    +     		+ +
    + + I_callconstraint(...) + +
    + Signature: ILTailcall * ILType * ILMethodSpec * ILVarArgs
    +
    +     		+ +
    + + I_calli(...) + +
    + Signature: ILTailcall * ILCallingSignature * ILVarArgs
    +
    +     		+ +
    + + I_callvirt(...) + +
    + Signature: ILTailcall * ILMethodSpec * ILVarArgs
    +
    +     		+ +
    + + I_castclass(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + I_cpblk(ILAlignment,ILVolatility) + +
    + Signature: ILAlignment * ILVolatility
    +
    +     		+ +
    + + I_cpobj(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + I_endfilter + +
    + Signature:
    +
    +     		+ +
    + + I_endfinally + +
    + Signature:
    +
    +     		+ +
    + + I_initblk(ILAlignment,ILVolatility) + +
    + Signature: ILAlignment * ILVolatility
    +
    +     		+ +
    + + I_initobj(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + I_isinst(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + I_jmp(ILMethodSpec) + +
    + Signature: ILMethodSpec
    +
    +     		+ +
    + + I_ldarg(uint16) + +
    + Signature: uint16
    +
    +     		+ +
    + + I_ldarga(uint16) + +
    + Signature: uint16
    +
    +     		+ +
    + + I_ldelem(ILBasicType) + +
    + Signature: ILBasicType
    +
    +     		+ +
    + + I_ldelem_any(ILArrayShape,ILType) + +
    + Signature: ILArrayShape * ILType
    +
    +     		+ +
    + + I_ldelema(...) + +
    + Signature: ILReadonly * bool * ILArrayShape * ILType
    +
    +     		+ +
    + + I_ldfld(...) + +
    + Signature: ILAlignment * ILVolatility * ILFieldSpec
    +
    +     		+ +
    + + I_ldflda(ILFieldSpec) + +
    + Signature: ILFieldSpec
    +
    +     		+ +
    + + I_ldftn(ILMethodSpec) + +
    + Signature: ILMethodSpec
    +
    +     		+ +
    + + I_ldind(...) + +
    + Signature: ILAlignment * ILVolatility * ILBasicType
    +
    +     		+ +
    + + I_ldlen + +
    + Signature:
    +
    +     		+ +
    + + I_ldloc(uint16) + +
    + Signature: uint16
    +
    +     		+ +
    + + I_ldloca(uint16) + +
    + Signature: uint16
    +
    +     		+ +
    + + I_ldobj(ILAlignment,ILVolatility,ILType) + +
    + Signature: ILAlignment * ILVolatility * ILType
    +
    +     		+ +
    + + I_ldsfld(ILVolatility,ILFieldSpec) + +
    + Signature: ILVolatility * ILFieldSpec
    +
    +     		+ +
    + + I_ldsflda(ILFieldSpec) + +
    + Signature: ILFieldSpec
    +
    +     		+ +
    + + I_ldstr(string) + +
    + Signature: string
    +
    +     		+ +
    + + I_ldtoken(ILToken) + +
    + Signature: ILToken
    +
    +     		+ +
    + + I_ldvirtftn(ILMethodSpec) + +
    + Signature: ILMethodSpec
    +
    +     		+ +
    + + I_leave(ILCodeLabel) + +
    + Signature: ILCodeLabel
    +
    +     		+ +
    + + I_localloc + +
    + Signature:
    +
    +     		+ +
    + + I_mkrefany(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + I_newarr(ILArrayShape,ILType) + +
    + Signature: ILArrayShape * ILType
    +
    +     		+ +
    + + I_newobj(ILMethodSpec,ILVarArgs) + +
    + Signature: ILMethodSpec * ILVarArgs
    +
    +     		+ +
    + + I_refanytype + +
    + Signature:
    +
    +     		+ +
    + + I_refanyval(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + I_ret + +
    + Signature:
    +
    +     		+ +
    + + I_rethrow + +
    + Signature:
    +
    +     		+ +
    + + I_seqpoint(ILSourceMarker) + +
    + Signature: ILSourceMarker
    +
    +     		+ +
    + + I_sizeof(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + I_starg(uint16) + +
    + Signature: uint16
    +
    +     		+ +
    + + I_stelem(ILBasicType) + +
    + Signature: ILBasicType
    +
    +     		+ +
    + + I_stelem_any(ILArrayShape,ILType) + +
    + Signature: ILArrayShape * ILType
    +
    +     		+ +
    + + I_stfld(...) + +
    + Signature: ILAlignment * ILVolatility * ILFieldSpec
    +
    +     		+ +
    + + I_stind(...) + +
    + Signature: ILAlignment * ILVolatility * ILBasicType
    +
    +     		+ +
    + + I_stloc(uint16) + +
    + Signature: uint16
    +
    +     		+ +
    + + I_stobj(ILAlignment,ILVolatility,ILType) + +
    + Signature: ILAlignment * ILVolatility * ILType
    +
    +     		+ +
    + + I_stsfld(ILVolatility,ILFieldSpec) + +
    + Signature: ILVolatility * ILFieldSpec
    +
    +     		+ +
    + + I_switch(ILCodeLabel list) + +
    + Signature: ILCodeLabel list
    +
    +     		+ +
    + + I_throw + +
    + Signature:
    +
    +     		+ +
    + + I_unbox(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + + I_unbox_any(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-illazymethodbody.html b/docs/reference/fsharp-compiler-abstractil-il-illazymethodbody.html new file mode 100644 index 0000000000..2cfcf69384 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-illazymethodbody.html @@ -0,0 +1,123 @@ + + + + + ILLazyMethodBody - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILLazyMethodBody

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    +[<Sealed>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Contents + +
    + Signature: MethodBody
    +
    +     		+ +

    CompiledName: get_Contents

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocal.html b/docs/reference/fsharp-compiler-abstractil-il-illocal.html new file mode 100644 index 0000000000..3d25603e7d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-illocal.html @@ -0,0 +1,150 @@ + + + + + ILLocal - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILLocal

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    Local variables

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + DebugInfo + +
    + Signature: (string * int * int) option
    +
    +     		+ +
    + + IsPinned + +
    + Signature: bool
    +
    +     		+ +
    + + Type + +
    + Signature: ILType
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocaldebuginfo.html b/docs/reference/fsharp-compiler-abstractil-il-illocaldebuginfo.html new file mode 100644 index 0000000000..d1150acfd4 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-illocaldebuginfo.html @@ -0,0 +1,135 @@ + + + + + ILLocalDebugInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILLocalDebugInfo

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + DebugMappings + +
    + Signature: ILLocalDebugMapping list
    +
    +     		+ +
    + + Range + +
    + Signature: ILCodeLabel * ILCodeLabel
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocaldebugmapping.html b/docs/reference/fsharp-compiler-abstractil-il-illocaldebugmapping.html new file mode 100644 index 0000000000..97cb0eeb14 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-illocaldebugmapping.html @@ -0,0 +1,139 @@ + + + + + ILLocalDebugMapping - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILLocalDebugMapping

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Indicates that a particular local variable has a particular source +language name within a given set of ranges. This does not effect local +variable numbering, which is global over the whole method.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + LocalIndex + +
    + Signature: int
    +
    +     		+ +
    + + LocalName + +
    + Signature: string
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocals.html b/docs/reference/fsharp-compiler-abstractil-il-illocals.html new file mode 100644 index 0000000000..1806d1d5b2 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-illocals.html @@ -0,0 +1,194 @@ + + + + + ILLocals - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILLocals

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: ILLocal
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> ILLocal
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: ILLocal list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: ILLocal list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-illocalsallocator.html b/docs/reference/fsharp-compiler-abstractil-il-illocalsallocator.html new file mode 100644 index 0000000000..99e0f44f31 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-illocalsallocator.html @@ -0,0 +1,152 @@ + + + + + ILLocalsAllocator - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILLocalsAllocator

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Helpers for codegen: scopes for allocating new temporary variables.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(preAlloc) + +
    + Signature: preAlloc:int -> ILLocalsAllocator
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AllocLocal(arg1) + +
    + Signature: ILLocal -> uint16
    +
    +     		+ +
    + + x.Close() + +
    + Signature: unit -> ILLocal list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmemberaccess.html b/docs/reference/fsharp-compiler-abstractil-il-ilmemberaccess.html new file mode 100644 index 0000000000..747f80b225 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmemberaccess.html @@ -0,0 +1,200 @@ + + + + + ILMemberAccess - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILMemberAccess

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Member Access

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Assembly + +
    + Signature:
    +
    +     		+ +
    + + CompilerControlled + +
    + Signature:
    +
    +     		+ +
    + + Family + +
    + Signature:
    +
    +     		+ +
    + + FamilyAndAssembly + +
    + Signature:
    +
    +     		+ +
    + + FamilyOrAssembly + +
    + Signature:
    +
    +     		+ +
    + + Private + +
    + Signature:
    +
    +     		+ +
    + + Public + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodbody.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodbody.html new file mode 100644 index 0000000000..3564f1da57 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmethodbody.html @@ -0,0 +1,202 @@ + + + + + ILMethodBody - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILMethodBody

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    IL method bodies

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + AggressiveInlining + +
    + Signature: bool
    +
    +     		+ +
    + + Code + +
    + Signature: ILCode
    +
    +     		+ +
    + + IsZeroInit + +
    + Signature: bool
    +
    +     		+ +
    + + Locals + +
    + Signature: ILLocals
    +
    +     		+ +
    + + MaxStack + +
    + Signature: int32
    +
    +     		+ +
    + + NoInlining + +
    + Signature: bool
    +
    +     		+ +
    + + SourceMarker + +
    + Signature: ILSourceMarker option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethoddef.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethoddef.html new file mode 100644 index 0000000000..58f8a603e4 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmethoddef.html @@ -0,0 +1,953 @@ + + + + + ILMethodDef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILMethodDef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    IL Method definitions.

    + +
    +

    Constructors

    + + + + + + + + + + + + + + +
    ConstructorDescription
    + + new(...) + +
    + Signature: (name:string * attributes:MethodAttributes * implAttributes:MethodImplAttributes * callingConv:ILCallingConv * parameters:ILParameters * ret:ILReturn * body:ILLazyMethodBody * isEntryPoint:bool * genericParams:ILGenericParameterDefs * securityDecls:ILSecurityDecls * customAttrs:ILAttributes) -> ILMethodDef
    +
    +     		+

    Functional creation of a value, immediate

    + + +

    CompiledName: .ctor

    +
    + + new(...) + +
    + Signature: (name:string * attributes:MethodAttributes * implAttributes:MethodImplAttributes * callingConv:ILCallingConv * parameters:ILParameters * ret:ILReturn * body:ILLazyMethodBody * isEntryPoint:bool * genericParams:ILGenericParameterDefs * securityDeclsStored:ILSecurityDeclsStored * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILMethodDef
    +
    +     		+

    Functional creation of a value, with delayed reading of some elements via a metadata index

    + + +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Access + +
    + Signature: ILMemberAccess
    +
    +     		+ +

    CompiledName: get_Access

    +
    + + x.Attributes + +
    + Signature: MethodAttributes
    +
    +     		+ +

    CompiledName: get_Attributes

    +
    + + x.Body + +
    + Signature: ILLazyMethodBody
    +
    +     		+ +

    CompiledName: get_Body

    +
    + + x.CallingConv + +
    + Signature: ILCallingConv
    +
    +     		+ +

    CompiledName: get_CallingConv

    +
    + + x.CallingSignature + +
    + Signature: ILCallingSignature
    +
    +     		+ +

    CompiledName: get_CallingSignature

    +
    + + x.Code + +
    + Signature: ILCode option
    +
    +     		+ +

    CompiledName: get_Code

    +
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + + x.GenericParams + +
    + Signature: ILGenericParameterDefs
    +
    +     		+ +

    CompiledName: get_GenericParams

    +
    + + x.HasSecurity + +
    + Signature: bool
    +
    +     		+

    Some methods are marked "HasSecurity" even if there are no permissions attached, e.g. if they use SuppressUnmanagedCodeSecurityAttribute

    + + +

    CompiledName: get_HasSecurity

    +
    + + x.ImplAttributes + +
    + Signature: MethodImplAttributes
    +
    +     		+ +

    CompiledName: get_ImplAttributes

    +
    + + x.IsAbstract + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsAbstract

    +
    + + x.IsAggressiveInline + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsAggressiveInline

    +
    + + x.IsCheckAccessOnOverride + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsCheckAccessOnOverride

    +
    + + x.IsClassInitializer + +
    + Signature: bool
    +
    +     		+

    Indicates a .cctor method.

    + + +

    CompiledName: get_IsClassInitializer

    +
    + + x.IsConstructor + +
    + Signature: bool
    +
    +     		+

    Indicates a .ctor method.

    + + +

    CompiledName: get_IsConstructor

    +
    + + x.IsEntryPoint + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEntryPoint

    +
    + + x.IsFinal + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsFinal

    +
    + + x.IsForwardRef + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsForwardRef

    +
    + + x.IsHideBySig + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsHideBySig

    +
    + + x.IsIL + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsIL

    +
    + + x.IsInternalCall + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsInternalCall

    +
    + + x.IsManaged + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsManaged

    +
    + + x.IsMustRun + +
    + Signature: bool
    +
    +     		+

    SafeHandle finalizer must be run.

    + + +

    CompiledName: get_IsMustRun

    +
    + + x.IsNewSlot + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsNewSlot

    +
    + + x.IsNoInline + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsNoInline

    +
    + + x.IsNonVirtualInstance + +
    + Signature: bool
    +
    +     		+

    Indicates this is an instance methods that is not virtual.

    + + +

    CompiledName: get_IsNonVirtualInstance

    +
    + + x.IsPreserveSig + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsPreserveSig

    +
    + + x.IsReqSecObj + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsReqSecObj

    +
    + + x.IsSpecialName + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSpecialName

    +
    + + x.IsStatic + +
    + Signature: bool
    +
    +     		+

    Indicates a static method.

    + + +

    CompiledName: get_IsStatic

    +
    + + x.IsSynchronized + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSynchronized

    +
    + + x.IsUnmanagedExport + +
    + Signature: bool
    +
    +     		+

    The method is exported to unmanaged code using COM interop.

    + + +

    CompiledName: get_IsUnmanagedExport

    +
    + + x.IsVirtual + +
    + Signature: bool
    +
    +     		+

    Indicates an instance methods that is virtual or abstract or implements an interface slot.

    + + +

    CompiledName: get_IsVirtual

    +
    + + x.IsZeroInit + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsZeroInit

    +
    + + x.Locals + +
    + Signature: ILLocals
    +
    +     		+ +

    CompiledName: get_Locals

    +
    + + x.MaxStack + +
    + Signature: int32
    +
    +     		+ +

    CompiledName: get_MaxStack

    +
    + + x.MethodBody + +
    + Signature: ILMethodBody
    +
    +     		+ +

    CompiledName: get_MethodBody

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + + x.Parameters + +
    + Signature: ILParameters
    +
    +     		+ +

    CompiledName: get_Parameters

    +
    + + x.ParameterTypes + +
    + Signature: ILTypes
    +
    +     		+ +

    CompiledName: get_ParameterTypes

    +
    + + x.Return + +
    + Signature: ILReturn
    +
    +     		+ +

    CompiledName: get_Return

    +
    + + x.SecurityDecls + +
    + Signature: ILSecurityDecls
    +
    +     		+ +

    CompiledName: get_SecurityDecls

    +
    + + x.With(...) + +
    + Signature: (name:string option * attributes:MethodAttributes option * implAttributes:MethodImplAttributes option * callingConv:ILCallingConv option * parameters:ILParameters option * ret:ILReturn option * body:ILLazyMethodBody option * securityDecls:ILSecurityDecls option * isEntryPoint:bool option * genericParams:ILGenericParameterDefs option * customAttrs:ILAttributes option) -> ILMethodDef
    +
    +     		+

    Functional update of the value

    + + +
    + + x.WithAbstract(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + + x.WithAccess(arg1) + +
    + Signature: ILMemberAccess -> ILMethodDef
    +
    +     		+ +
    + + x.WithAggressiveInlining(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + + x.WithFinal(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + + x.WithHideBySig(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + + x.WithHideBySig() + +
    + Signature: unit -> ILMethodDef
    +
    +     		+ +
    + + x.WithNewSlot + +
    + Signature: ILMethodDef
    +
    +     		+ +

    CompiledName: get_WithNewSlot

    +
    + + x.WithNoInlining(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + + x.WithPInvoke(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + + x.WithPreserveSig(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + + x.WithRuntime(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + + x.WithSecurity(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + + x.WithSpecialName + +
    + Signature: ILMethodDef
    +
    +     		+ +

    CompiledName: get_WithSpecialName

    +
    + + x.WithSynchronized(arg1) + +
    + Signature: bool -> ILMethodDef
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethoddefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethoddefs.html new file mode 100644 index 0000000000..4da8ba6cd0 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmethoddefs.html @@ -0,0 +1,154 @@ + + + + + ILMethodDefs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILMethodDefs

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +

    Tables of methods. Logically equivalent to a list of methods but +the table is kept in a form optimized for looking up methods by +name and arity.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AsArray + +
    + Signature: ILMethodDef []
    +
    +     		+ +

    CompiledName: get_AsArray

    +
    + + x.AsList + +
    + Signature: ILMethodDef list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + + x.FindByName(arg1) + +
    + Signature: string -> ILMethodDef list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldef.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldef.html new file mode 100644 index 0000000000..e9e14a6d8b --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldef.html @@ -0,0 +1,130 @@ + + + + + ILMethodImplDef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILMethodImplDef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    Method Impls

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + OverrideBy + +
    + Signature: ILMethodSpec
    +
    +     		+ +
    + + Overrides + +
    + Signature: ILOverridesSpec
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldefs.html new file mode 100644 index 0000000000..5f312a8805 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmethodimpldefs.html @@ -0,0 +1,123 @@ + + + + + ILMethodImplDefs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILMethodImplDefs

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.AsList + +
    + Signature: ILMethodImplDef list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodref.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodref.html new file mode 100644 index 0000000000..23675ca8ec --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmethodref.html @@ -0,0 +1,244 @@ + + + + + ILMethodRef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILMethodRef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Formal identities of methods.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.ArgCount + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_ArgCount

    +
    + + x.ArgTypes + +
    + Signature: ILTypes
    +
    +     		+ +

    CompiledName: get_ArgTypes

    +
    + + x.CallingConv + +
    + Signature: ILCallingConv
    +
    +     		+ +

    CompiledName: get_CallingConv

    +
    + + x.CallingSignature + +
    + Signature: ILCallingSignature
    +
    +     		+ +

    CompiledName: get_CallingSignature

    +
    + + x.DeclaringTypeRef + +
    + Signature: ILTypeRef
    +
    +     		+ +

    CompiledName: get_DeclaringTypeRef

    +
    + + x.GenericArity + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_GenericArity

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + + x.ReturnType + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_ReturnType

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + ILMethodRef.Create(...) + +
    + Signature: (enclosingTypeRef:ILTypeRef * callingConv:ILCallingConv * name:string * genericArity:int * argTypes:ILTypes * returnType:ILType) -> ILMethodRef
    +
    +     		+

    Functional creation

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodspec.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodspec.html new file mode 100644 index 0000000000..5992c41f22 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmethodspec.html @@ -0,0 +1,244 @@ + + + + + ILMethodSpec - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILMethodSpec

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    The information at the callsite of a method

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.CallingConv + +
    + Signature: ILCallingConv
    +
    +     		+ +

    CompiledName: get_CallingConv

    +
    + + x.DeclaringType + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_DeclaringType

    +
    + + x.FormalArgTypes + +
    + Signature: ILTypes
    +
    +     		+ +

    CompiledName: get_FormalArgTypes

    +
    + + x.FormalReturnType + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_FormalReturnType

    +
    + + x.GenericArgs + +
    + Signature: ILGenericArgs
    +
    +     		+ +

    CompiledName: get_GenericArgs

    +
    + + x.GenericArity + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_GenericArity

    +
    + + x.MethodRef + +
    + Signature: ILMethodRef
    +
    +     		+ +

    CompiledName: get_MethodRef

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + ILMethodSpec.Create(arg1, arg2, arg3) + +
    + Signature: (ILType * ILMethodRef * ILGenericArgs) -> ILMethodSpec
    +
    +     		+

    Functional creation

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmethodvirtualinfo.html b/docs/reference/fsharp-compiler-abstractil-il-ilmethodvirtualinfo.html new file mode 100644 index 0000000000..5f42577662 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmethodvirtualinfo.html @@ -0,0 +1,154 @@ + + + + + ILMethodVirtualInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILMethodVirtualInfo

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + IsAbstract + +
    + Signature: bool
    +
    +     		+ +
    + + IsCheckAccessOnOverride + +
    + Signature: bool
    +
    +     		+ +
    + + IsFinal + +
    + Signature: bool
    +
    +     		+ +
    + + IsNewSlot + +
    + Signature: bool
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmoduledef.html b/docs/reference/fsharp-compiler-abstractil-il-ilmoduledef.html new file mode 100644 index 0000000000..81886cff2d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmoduledef.html @@ -0,0 +1,432 @@ + + + + + ILModuleDef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILModuleDef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    One module in the "current" assembly, either a main-module or +an auxiliary module. The main module will have a manifest.

    +

    An assembly is built by joining together a "main" module plus +several auxiliary modules.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + CustomAttrsStored + +
    + Signature: ILAttributesStored
    +
    +     		+ +
    + + ImageBase + +
    + Signature: int32
    +
    +     		+ +
    + + Is32Bit + +
    + Signature: bool
    +
    +     		+ +
    + + Is32BitPreferred + +
    + Signature: bool
    +
    +     		+ +
    + + Is64Bit + +
    + Signature: bool
    +
    +     		+ +
    + + IsDLL + +
    + Signature: bool
    +
    +     		+ +
    + + IsILOnly + +
    + Signature: bool
    +
    +     		+ +
    + + Manifest + +
    + Signature: ILAssemblyManifest option
    +
    +     		+ +
    + + MetadataIndex + +
    + Signature: int32
    +
    +     		+ +
    + + MetadataVersion + +
    + Signature: string
    +
    +     		+ +
    + + Name + +
    + Signature: string
    +
    +     		+ +
    + + NativeResources + +
    + Signature: ILNativeResource list
    +
    +     		+

    e.g. win86 resources, as the exact contents of a .res or .obj file. Must be unlinked manually.

    + + +
    + + PhysicalAlignment + +
    + Signature: int32
    +
    +     		+ +
    + + Platform + +
    + Signature: ILPlatform option
    +
    +     		+ +
    + + Resources + +
    + Signature: ILResources
    +
    +     		+ +
    + + StackReserveSize + +
    + Signature: int32 option
    +
    +     		+ +
    + + SubSystemFlags + +
    + Signature: int32
    +
    +     		+ +
    + + SubsystemVersion + +
    + Signature: int * int
    +
    +     		+ +
    + + TypeDefs + +
    + Signature: ILTypeDefs
    +
    +     		+ +
    + + UseHighEntropyVA + +
    + Signature: bool
    +
    +     		+ +
    + + VirtualAlignment + +
    + Signature: int32
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + + x.HasManifest + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_HasManifest

    +
    + + x.ManifestOfAssembly + +
    + Signature: ILAssemblyManifest
    +
    +     		+ +

    CompiledName: get_ManifestOfAssembly

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilmoduleref.html b/docs/reference/fsharp-compiler-abstractil-il-ilmoduleref.html new file mode 100644 index 0000000000..7d6722455f --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilmoduleref.html @@ -0,0 +1,170 @@ + + + + + ILModuleRef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILModuleRef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Hash + +
    + Signature: byte [] option
    +
    +     		+ +

    CompiledName: get_Hash

    +
    + + x.HasMetadata + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_HasMetadata

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + ILModuleRef.Create(...) + +
    + Signature: (name:string * hasMetadata:bool * hash:byte [] option) -> ILModuleRef
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnativeresource.html b/docs/reference/fsharp-compiler-abstractil-il-ilnativeresource.html new file mode 100644 index 0000000000..80085f3504 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilnativeresource.html @@ -0,0 +1,137 @@ + + + + + ILNativeResource - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILNativeResource

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + In(...) + +
    + Signature: string * int * int * int
    +
    +     		+

    Represents a native resource to be read from the PE file

    + + +
    + + Out(unlinkedResource) + +
    + Signature: byte []
    +
    +     		+

    Represents a native resource to be written in an output file

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnativetype.html b/docs/reference/fsharp-compiler-abstractil-il-ilnativetype.html new file mode 100644 index 0000000000..0e1406595d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilnativetype.html @@ -0,0 +1,608 @@ + + + + + ILNativeType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILNativeType

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +

    Native Types, for marshalling to the native C interface. +These are taken directly from the ILASM syntax, see ECMA Spec (Partition II, 7.4).

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ANSIBSTR + +
    + Signature:
    +
    +     		+ +
    + + Array(...) + +
    + Signature: ILNativeType option * (int32 * int32 option) option
    +
    +     		+

    optional idx of parameter giving size plus optional additive i.e. num elems

    + + +
    + + AsAny + +
    + Signature:
    +
    +     		+ +
    + + Bool + +
    + Signature:
    +
    +     		+ +
    + + BSTR + +
    + Signature:
    +
    +     		+ +
    + + Byte + +
    + Signature:
    +
    +     		+ +
    + + ByValStr + +
    + Signature:
    +
    +     		+ +
    + + Currency + +
    + Signature:
    +
    +     		+ +
    + + Custom(ILGuid,string,string,byte []) + +
    + Signature: ILGuid * string * string * byte []
    +
    +     		+ +
    + + Double + +
    + Signature:
    +
    +     		+ +
    + + Empty + +
    + Signature:
    +
    +     		+ +
    + + Error + +
    + Signature:
    +
    +     		+ +
    + + FixedArray(int32) + +
    + Signature: int32
    +
    +     		+ +
    + + FixedSysString(int32) + +
    + Signature: int32
    +
    +     		+ +
    + + IDispatch + +
    + Signature:
    +
    +     		+ +
    + + Int + +
    + Signature:
    +
    +     		+ +
    + + Int16 + +
    + Signature:
    +
    +     		+ +
    + + Int32 + +
    + Signature:
    +
    +     		+ +
    + + Int64 + +
    + Signature:
    +
    +     		+ +
    + + Int8 + +
    + Signature:
    +
    +     		+ +
    + + Interface + +
    + Signature:
    +
    +     		+ +
    + + IUnknown + +
    + Signature:
    +
    +     		+ +
    + + LPSTR + +
    + Signature:
    +
    +     		+ +
    + + LPSTRUCT + +
    + Signature:
    +
    +     		+ +
    + + LPTSTR + +
    + Signature:
    +
    +     		+ +
    + + LPUTF8STR + +
    + Signature:
    +
    +     		+ +
    + + LPWSTR + +
    + Signature:
    +
    +     		+ +
    + + Method + +
    + Signature:
    +
    +     		+ +
    + + SafeArray(ILNativeVariant,string option) + +
    + Signature: ILNativeVariant * string option
    +
    +     		+ +
    + + Single + +
    + Signature:
    +
    +     		+ +
    + + Struct + +
    + Signature:
    +
    +     		+ +
    + + TBSTR + +
    + Signature:
    +
    +     		+ +
    + + UInt + +
    + Signature:
    +
    +     		+ +
    + + UInt16 + +
    + Signature:
    +
    +     		+ +
    + + UInt32 + +
    + Signature:
    +
    +     		+ +
    + + UInt64 + +
    + Signature:
    +
    +     		+ +
    + + VariantBool + +
    + Signature:
    +
    +     		+ +
    + + Void + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnativevariant.html b/docs/reference/fsharp-compiler-abstractil-il-ilnativevariant.html new file mode 100644 index 0000000000..d4c6b0742d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilnativevariant.html @@ -0,0 +1,681 @@ + + + + + ILNativeVariant - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILNativeVariant

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Array(ILNativeVariant) + +
    + Signature: ILNativeVariant
    +
    +     		+ +
    + + Blob + +
    + Signature:
    +
    +     		+ +
    + + BlobObject + +
    + Signature:
    +
    +     		+ +
    + + Bool + +
    + Signature:
    +
    +     		+ +
    + + BSTR + +
    + Signature:
    +
    +     		+ +
    + + Byref(ILNativeVariant) + +
    + Signature: ILNativeVariant
    +
    +     		+ +
    + + CArray + +
    + Signature:
    +
    +     		+ +
    + + CF + +
    + Signature:
    +
    +     		+ +
    + + CLSID + +
    + Signature:
    +
    +     		+ +
    + + Currency + +
    + Signature:
    +
    +     		+ +
    + + Date + +
    + Signature:
    +
    +     		+ +
    + + Decimal + +
    + Signature:
    +
    +     		+ +
    + + Double + +
    + Signature:
    +
    +     		+ +
    + + Empty + +
    + Signature:
    +
    +     		+ +
    + + Error + +
    + Signature:
    +
    +     		+ +
    + + FileTime + +
    + Signature:
    +
    +     		+ +
    + + HRESULT + +
    + Signature:
    +
    +     		+ +
    + + IDispatch + +
    + Signature:
    +
    +     		+ +
    + + Int + +
    + Signature:
    +
    +     		+ +
    + + Int16 + +
    + Signature:
    +
    +     		+ +
    + + Int32 + +
    + Signature:
    +
    +     		+ +
    + + Int64 + +
    + Signature:
    +
    +     		+ +
    + + Int8 + +
    + Signature:
    +
    +     		+ +
    + + IUnknown + +
    + Signature:
    +
    +     		+ +
    + + LPSTR + +
    + Signature:
    +
    +     		+ +
    + + LPWSTR + +
    + Signature:
    +
    +     		+ +
    + + Null + +
    + Signature:
    +
    +     		+ +
    + + PTR + +
    + Signature:
    +
    +     		+ +
    + + Record + +
    + Signature:
    +
    +     		+ +
    + + SafeArray + +
    + Signature:
    +
    +     		+ +
    + + Single + +
    + Signature:
    +
    +     		+ +
    + + Storage + +
    + Signature:
    +
    +     		+ +
    + + StoredObject + +
    + Signature:
    +
    +     		+ +
    + + Stream + +
    + Signature:
    +
    +     		+ +
    + + StreamedObject + +
    + Signature:
    +
    +     		+ +
    + + UInt + +
    + Signature:
    +
    +     		+ +
    + + UInt16 + +
    + Signature:
    +
    +     		+ +
    + + UInt32 + +
    + Signature:
    +
    +     		+ +
    + + UInt64 + +
    + Signature:
    +
    +     		+ +
    + + UInt8 + +
    + Signature:
    +
    +     		+ +
    + + UserDefined + +
    + Signature:
    +
    +     		+ +
    + + Variant + +
    + Signature:
    +
    +     		+ +
    + + Vector(ILNativeVariant) + +
    + Signature: ILNativeVariant
    +
    +     		+ +
    + + Void + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtype.html b/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtype.html new file mode 100644 index 0000000000..4f7e75fcc8 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtype.html @@ -0,0 +1,191 @@ + + + + + ILNestedExportedType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILNestedExportedType

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    these are only found in the "Nested" field of ILExportedTypeOrForwarder objects

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Access + +
    + Signature: ILMemberAccess
    +
    +     		+ +
    + + CustomAttrsStored + +
    + Signature: ILAttributesStored
    +
    +     		+ +
    + + MetadataIndex + +
    + Signature: int32
    +
    +     		+ +
    + + Name + +
    + Signature: string
    +
    +     		+ +
    + + Nested + +
    + Signature: ILNestedExportedTypes
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtypes.html b/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtypes.html new file mode 100644 index 0000000000..a20d8c7b3a --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilnestedexportedtypes.html @@ -0,0 +1,123 @@ + + + + + ILNestedExportedTypes - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILNestedExportedTypes

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.AsList + +
    + Signature: ILNestedExportedType list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iloverridesspec.html b/docs/reference/fsharp-compiler-abstractil-il-iloverridesspec.html new file mode 100644 index 0000000000..bd499961cd --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iloverridesspec.html @@ -0,0 +1,152 @@ + + + + + ILOverridesSpec - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILOverridesSpec

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + OverridesSpec(ILMethodRef,ILType) + +
    + Signature: ILMethodRef * ILType
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DeclaringType + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_DeclaringType

    +
    + + x.MethodRef + +
    + Signature: ILMethodRef
    +
    +     		+ +

    CompiledName: get_MethodRef

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilparameter.html b/docs/reference/fsharp-compiler-abstractil-il-ilparameter.html new file mode 100644 index 0000000000..ed9bd8bb8d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilparameter.html @@ -0,0 +1,252 @@ + + + + + ILParameter - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILParameter

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Method parameters and return values.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + CustomAttrsStored + +
    + Signature: ILAttributesStored
    +
    +     		+ +
    + + Default + +
    + Signature: ILFieldInit option
    +
    +     		+ +
    + + IsIn + +
    + Signature: bool
    +
    +     		+ +
    + + IsOptional + +
    + Signature: bool
    +
    +     		+ +
    + + IsOut + +
    + Signature: bool
    +
    +     		+ +
    + + Marshal + +
    + Signature: ILNativeType option
    +
    +     		+

    Marshalling map for parameters. COM Interop only.

    + + +
    + + MetadataIndex + +
    + Signature: int32
    +
    +     		+ +
    + + Name + +
    + Signature: string option
    +
    +     		+ +
    + + Type + +
    + Signature: ILType
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilparameters.html b/docs/reference/fsharp-compiler-abstractil-il-ilparameters.html new file mode 100644 index 0000000000..b20384d967 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilparameters.html @@ -0,0 +1,194 @@ + + + + + ILParameters - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILParameters

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: ILParameter
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> ILParameter
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: ILParameter list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: ILParameter list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilplatform.html b/docs/reference/fsharp-compiler-abstractil-il-ilplatform.html new file mode 100644 index 0000000000..4be6aa7ad0 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilplatform.html @@ -0,0 +1,147 @@ + + + + + ILPlatform - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILPlatform

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AMD64 + +
    + Signature:
    +
    +     		+ +
    + + IA64 + +
    + Signature:
    +
    +     		+ +
    + + X86 + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilpretypedef.html b/docs/reference/fsharp-compiler-abstractil-il-ilpretypedef.html new file mode 100644 index 0000000000..4ac4a11381 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilpretypedef.html @@ -0,0 +1,159 @@ + + + + + ILPreTypeDef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILPreTypeDef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents a prefix of information for ILTypeDef.

    +

    The information is enough to perform name resolution for the F# compiler, probe attributes +for ExtensionAttribute etc. This is key to the on-demand exploration of .NET metadata. +This information has to be "Goldilocks" - not too much, not too little, just right.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.GetTypeDef() + +
    + Signature: unit -> ILTypeDef
    + Modifiers: abstract
    +
    +     		+

    Realise the actual full typedef

    + + +
    + + x.Name + +
    + Signature: string
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_Name

    +
    + + x.Namespace + +
    + Signature: string list
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_Namespace

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilpretypedefimpl.html b/docs/reference/fsharp-compiler-abstractil-il-ilpretypedefimpl.html new file mode 100644 index 0000000000..50facb752a --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilpretypedefimpl.html @@ -0,0 +1,101 @@ + + + + + ILPreTypeDefImpl - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILPreTypeDefImpl

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilpropertydef.html b/docs/reference/fsharp-compiler-abstractil-il-ilpropertydef.html new file mode 100644 index 0000000000..b884c2712d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilpropertydef.html @@ -0,0 +1,319 @@ + + + + + ILPropertyDef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILPropertyDef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    Property definitions

    + +
    +

    Constructors

    + + + + + + + + + + + + + + +
    ConstructorDescription
    + + new(...) + +
    + Signature: (name:string * attributes:PropertyAttributes * setMethod:ILMethodRef option * getMethod:ILMethodRef option * callingConv:ILThisConvention * propertyType:ILType * init:ILFieldInit option * args:ILTypes * customAttrs:ILAttributes) -> ILPropertyDef
    +
    +     		+

    Functional creation of a value, immediate

    + + +

    CompiledName: .ctor

    +
    + + new(...) + +
    + Signature: (name:string * attributes:PropertyAttributes * setMethod:ILMethodRef option * getMethod:ILMethodRef option * callingConv:ILThisConvention * propertyType:ILType * init:ILFieldInit option * args:ILTypes * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILPropertyDef
    +
    +     		+

    Functional creation of a value, using delayed reading via a metadata index, for ilread.fs

    + + +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Args + +
    + Signature: ILTypes
    +
    +     		+ +

    CompiledName: get_Args

    +
    + + x.Attributes + +
    + Signature: PropertyAttributes
    +
    +     		+ +

    CompiledName: get_Attributes

    +
    + + x.CallingConv + +
    + Signature: ILThisConvention
    +
    +     		+ +

    CompiledName: get_CallingConv

    +
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + + x.GetMethod + +
    + Signature: ILMethodRef option
    +
    +     		+ +

    CompiledName: get_GetMethod

    +
    + + x.Init + +
    + Signature: ILFieldInit option
    +
    +     		+ +

    CompiledName: get_Init

    +
    + + x.IsRTSpecialName + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsRTSpecialName

    +
    + + x.IsSpecialName + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSpecialName

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + + x.PropertyType + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_PropertyType

    +
    + + x.SetMethod + +
    + Signature: ILMethodRef option
    +
    +     		+ +

    CompiledName: get_SetMethod

    +
    + + x.With(...) + +
    + Signature: (name:string option * attributes:PropertyAttributes option * setMethod:ILMethodRef option option * getMethod:ILMethodRef option option * callingConv:ILThisConvention option * propertyType:ILType option * init:ILFieldInit option option * args:ILTypes option * customAttrs:ILAttributes option) -> ILPropertyDef
    +
    +     		+

    Functional update of the value

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilpropertydefs.html b/docs/reference/fsharp-compiler-abstractil-il-ilpropertydefs.html new file mode 100644 index 0000000000..13159b1fd2 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilpropertydefs.html @@ -0,0 +1,138 @@ + + + + + ILPropertyDefs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILPropertyDefs

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +

    Table of properties in an IL type definition.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AsList + +
    + Signature: ILPropertyDef list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + + x.LookupByName(arg1) + +
    + Signature: string -> ILPropertyDef list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilpropertyref.html b/docs/reference/fsharp-compiler-abstractil-il-ilpropertyref.html new file mode 100644 index 0000000000..be380ab7fd --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilpropertyref.html @@ -0,0 +1,158 @@ + + + + + ILPropertyRef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILPropertyRef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    A utility type provided for completeness

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DeclaringTypeRef + +
    + Signature: ILTypeRef
    +
    +     		+ +

    CompiledName: get_DeclaringTypeRef

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + ILPropertyRef.Create(arg1, arg2) + +
    + Signature: (ILTypeRef * string) -> ILPropertyRef
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilreadonly.html b/docs/reference/fsharp-compiler-abstractil-il-ilreadonly.html new file mode 100644 index 0000000000..62cc03eb70 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilreadonly.html @@ -0,0 +1,128 @@ + + + + + ILReadonly - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILReadonly

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + NormalAddress + +
    + Signature:
    +
    +     		+ +
    + + ReadonlyAddress + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilreferences.html b/docs/reference/fsharp-compiler-abstractil-il-ilreferences.html new file mode 100644 index 0000000000..52dc5bedaf --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilreferences.html @@ -0,0 +1,128 @@ + + + + + ILReferences - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILReferences

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + AssemblyReferences + +
    + Signature: ILAssemblyRef list
    +
    +     		+ +
    + + ModuleReferences + +
    + Signature: ILModuleRef list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilresource.html b/docs/reference/fsharp-compiler-abstractil-il-ilresource.html new file mode 100644 index 0000000000..f32bf890aa --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilresource.html @@ -0,0 +1,194 @@ + + + + + ILResource - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILResource

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +

    "Manifest ILResources" are chunks of resource data, being one of: +- the data section of the current module (byte[] of resource given directly). +- in an external file in this assembly (offset given in the ILResourceLocation field). +- as a resources in another assembly of the same name.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Access + +
    + Signature: ILResourceAccess
    +
    +     		+ +
    + + CustomAttrsStored + +
    + Signature: ILAttributesStored
    +
    +     		+ +
    + + Location + +
    + Signature: ILResourceLocation
    +
    +     		+ +
    + + MetadataIndex + +
    + Signature: int32
    +
    +     		+ +
    + + Name + +
    + Signature: string
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilresourceaccess.html b/docs/reference/fsharp-compiler-abstractil-il-ilresourceaccess.html new file mode 100644 index 0000000000..32cacfd9ed --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilresourceaccess.html @@ -0,0 +1,133 @@ + + + + + ILResourceAccess - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILResourceAccess

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Private + +
    + Signature:
    +
    +     		+ +
    + + Public + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilresourcelocation.html b/docs/reference/fsharp-compiler-abstractil-il-ilresourcelocation.html new file mode 100644 index 0000000000..f1c7a799fb --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilresourcelocation.html @@ -0,0 +1,99 @@ + + + + + ILResourceLocation - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILResourceLocation

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilresources.html b/docs/reference/fsharp-compiler-abstractil-il-ilresources.html new file mode 100644 index 0000000000..7bb0a18bef --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilresources.html @@ -0,0 +1,125 @@ + + + + + ILResources - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILResources

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +

    Table of resources in a module.

    + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.AsList + +
    + Signature: ILResource list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilreturn.html b/docs/reference/fsharp-compiler-abstractil-il-ilreturn.html new file mode 100644 index 0000000000..9b547ba1f6 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilreturn.html @@ -0,0 +1,198 @@ + + + + + ILReturn - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILReturn

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Method return values.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + CustomAttrsStored + +
    + Signature: ILAttributesStored
    +
    +     		+ +
    + + Marshal + +
    + Signature: ILNativeType option
    +
    +     		+ +
    + + MetadataIndex + +
    + Signature: int32
    +
    +     		+ +
    + + Type + +
    + Signature: ILType
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + + x.WithCustomAttrs(customAttrs) + +
    + Signature: customAttrs:ILAttributes -> ILReturn
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilscoperef.html b/docs/reference/fsharp-compiler-abstractil-il-ilscoperef.html new file mode 100644 index 0000000000..dec6674ce1 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilscoperef.html @@ -0,0 +1,205 @@ + + + + + ILScopeRef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILScopeRef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Assembly(ILAssemblyRef) + +
    + Signature: ILAssemblyRef
    +
    +     		+

    A reference to a type in another assembly

    + + +
    + + Local + +
    + Signature:
    +
    +     		+

    A reference to the type in the current module

    + + +
    + + Module(ILModuleRef) + +
    + Signature: ILModuleRef
    +
    +     		+

    A reference to a type in a module in the same assembly

    + + +
    + + PrimaryAssembly + +
    + Signature:
    +
    +     		+

    A reference to a type in the primary assembly

    + + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.IsLocalRef + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsLocalRef

    +
    + + x.QualifiedName + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_QualifiedName

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsecurityaction.html b/docs/reference/fsharp-compiler-abstractil-il-ilsecurityaction.html new file mode 100644 index 0000000000..b54f504820 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilsecurityaction.html @@ -0,0 +1,341 @@ + + + + + ILSecurityAction - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILSecurityAction

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Assert + +
    + Signature:
    +
    +     		+ +
    + + Demand + +
    + Signature:
    +
    +     		+ +
    + + DemandChoice + +
    + Signature:
    +
    +     		+ +
    + + Deny + +
    + Signature:
    +
    +     		+ +
    + + InheritanceDemandChoice + +
    + Signature:
    +
    +     		+ +
    + + InheritCheck + +
    + Signature:
    +
    +     		+ +
    + + LinkCheck + +
    + Signature:
    +
    +     		+ +
    + + LinkDemandChoice + +
    + Signature:
    +
    +     		+ +
    + + NonCasDemand + +
    + Signature:
    +
    +     		+ +
    + + NonCasInheritance + +
    + Signature:
    +
    +     		+ +
    + + NonCasLinkDemand + +
    + Signature:
    +
    +     		+ +
    + + PermitOnly + +
    + Signature:
    +
    +     		+ +
    + + PreJitDeny + +
    + Signature:
    +
    +     		+ +
    + + PreJitGrant + +
    + Signature:
    +
    +     		+ +
    + + ReqMin + +
    + Signature:
    +
    +     		+ +
    + + ReqOpt + +
    + Signature:
    +
    +     		+ +
    + + ReqRefuse + +
    + Signature:
    +
    +     		+ +
    + + Request + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecl.html b/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecl.html new file mode 100644 index 0000000000..4c6c9393fd --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecl.html @@ -0,0 +1,115 @@ + + + + + ILSecurityDecl - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILSecurityDecl

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + ILSecurityDecl(ILSecurityAction,byte []) + +
    + Signature: ILSecurityAction * byte []
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecls.html b/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecls.html new file mode 100644 index 0000000000..8f914f427a --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydecls.html @@ -0,0 +1,126 @@ + + + + + ILSecurityDecls - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILSecurityDecls

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    +[<Struct>]
    + +     +

    +
    +

    Abstract type equivalent to ILSecurityDecl list - use helpers +below to construct/destruct these.

    + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.AsList + +
    + Signature: ILSecurityDecl list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydeclsstored.html b/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydeclsstored.html new file mode 100644 index 0000000000..2717538411 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilsecuritydeclsstored.html @@ -0,0 +1,102 @@ + + + + + ILSecurityDeclsStored - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILSecurityDeclsStored

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents the efficiency-oriented storage of ILSecurityDecls in another item.

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsourcedocument.html b/docs/reference/fsharp-compiler-abstractil-il-ilsourcedocument.html new file mode 100644 index 0000000000..1614a99eb0 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilsourcedocument.html @@ -0,0 +1,187 @@ + + + + + ILSourceDocument - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILSourceDocument

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Debug info. Values of type "source" can be attached at sequence +points and some other locations.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DocumentType + +
    + Signature: ILGuid option
    +
    +     		+ +

    CompiledName: get_DocumentType

    +
    + + x.File + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_File

    +
    + + x.Language + +
    + Signature: ILGuid option
    +
    +     		+ +

    CompiledName: get_Language

    +
    + + x.Vendor + +
    + Signature: ILGuid option
    +
    +     		+ +

    CompiledName: get_Vendor

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + ILSourceDocument.Create(...) + +
    + Signature: (language:ILGuid option * vendor:ILGuid option * documentType:ILGuid option * file:string) -> ILSourceDocument
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilsourcemarker.html b/docs/reference/fsharp-compiler-abstractil-il-ilsourcemarker.html new file mode 100644 index 0000000000..a7e15bcd7d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilsourcemarker.html @@ -0,0 +1,198 @@ + + + + + ILSourceMarker - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILSourceMarker

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Column + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Column

    +
    + + x.Document + +
    + Signature: ILSourceDocument
    +
    +     		+ +

    CompiledName: get_Document

    +
    + + x.EndColumn + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_EndColumn

    +
    + + x.EndLine + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_EndLine

    +
    + + x.Line + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Line

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + ILSourceMarker.Create(...) + +
    + Signature: (document:ILSourceDocument * line:int * column:int * endLine:int * endColumn:int) -> ILSourceMarker
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltailcall.html b/docs/reference/fsharp-compiler-abstractil-il-iltailcall.html new file mode 100644 index 0000000000..cd2b558f2b --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltailcall.html @@ -0,0 +1,128 @@ + + + + + ILTailcall - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTailcall

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Normalcall + +
    + Signature:
    +
    +     		+ +
    + + Tailcall + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilthisconvention.html b/docs/reference/fsharp-compiler-abstractil-il-ilthisconvention.html new file mode 100644 index 0000000000..b72d3b97e2 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilthisconvention.html @@ -0,0 +1,154 @@ + + + + + ILThisConvention - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILThisConvention

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Instance + +
    + Signature:
    +
    +     		+

    accepts an implicit 'this' pointer

    + + +
    + + InstanceExplicit + +
    + Signature:
    +
    +     		+

    accepts an explicit 'this' pointer

    + + +
    + + Static + +
    + Signature:
    +
    +     		+

    no 'this' pointer is passed

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltoken.html b/docs/reference/fsharp-compiler-abstractil-il-iltoken.html new file mode 100644 index 0000000000..601e971567 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltoken.html @@ -0,0 +1,148 @@ + + + + + ILToken - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILToken

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ILField(ILFieldSpec) + +
    + Signature: ILFieldSpec
    +
    +     		+ +
    + + ILMethod(ILMethodSpec) + +
    + Signature: ILMethodSpec
    +
    +     		+ +
    + + ILType(ILType) + +
    + Signature: ILType
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltype.html b/docs/reference/fsharp-compiler-abstractil-il-iltype.html new file mode 100644 index 0000000000..38d98d0d67 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltype.html @@ -0,0 +1,366 @@ + + + + + ILType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILType

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Array(ILArrayShape,ILType) + +
    + Signature: ILArrayShape * ILType
    +
    +     		+

    Array types

    + + +
    + + Boxed(ILTypeSpec) + +
    + Signature: ILTypeSpec
    +
    +     		+

    Reference types. Also may be used for parents of members even if for members in value types.

    + + +
    + + Byref(ILType) + +
    + Signature: ILType
    +
    +     		+

    Managed pointers.

    + + +
    + + FunctionPointer(ILCallingSignature) + +
    + Signature: ILCallingSignature
    +
    +     		+

    ILCode pointers.

    + + +
    + + Modified(bool,ILTypeRef,ILType) + +
    + Signature: bool * ILTypeRef * ILType
    +
    +     		+

    Custom modifiers.

    + + +
    + + Ptr(ILType) + +
    + Signature: ILType
    +
    +     		+

    Unmanaged pointers. Nb. the type is used by tools and for binding only, not by the verifier.

    + + +
    + + TypeVar(uint16) + +
    + Signature: uint16
    +
    +     		+

    Reference a generic arg.

    + + +
    + + Value(ILTypeSpec) + +
    + Signature: ILTypeSpec
    +
    +     		+

    Unboxed types, including builtin types.

    + + +
    + + Void + +
    + Signature:
    +
    +     		+

    Used only in return and pointer types.

    + + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.BasicQualifiedName + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_BasicQualifiedName

    +
    + + x.Boxity + +
    + Signature: ILBoxity
    +
    +     		+ +

    CompiledName: get_Boxity

    +
    + + x.GenericArgs + +
    + Signature: ILGenericArgs
    +
    +     		+ +

    CompiledName: get_GenericArgs

    +
    + + x.IsNominal + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsNominal

    +
    + + x.IsTyvar + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsTyvar

    +
    + + x.QualifiedName + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_QualifiedName

    +
    + + x.TypeRef + +
    + Signature: ILTypeRef
    +
    +     		+ +

    CompiledName: get_TypeRef

    +
    + + x.TypeSpec + +
    + Signature: ILTypeSpec
    +
    +     		+

    The type being modified.

    + + +

    CompiledName: get_TypeSpec

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedef.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedef.html new file mode 100644 index 0000000000..10113caf34 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypedef.html @@ -0,0 +1,718 @@ + + + + + ILTypeDef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeDef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    Represents IL Type Definitions.

    + +
    +

    Constructors

    + + + + + + + + + + + + + + +
    ConstructorDescription
    + + new(...) + +
    + Signature: (name:string * attributes:TypeAttributes * layout:ILTypeDefLayout * implements:ILTypes * genericParams:ILGenericParameterDefs * extends:ILType option * methods:ILMethodDefs * nestedTypes:ILTypeDefs * fields:ILFieldDefs * methodImpls:ILMethodImplDefs * events:ILEventDefs * properties:ILPropertyDefs * securityDecls:ILSecurityDecls * customAttrs:ILAttributes) -> ILTypeDef
    +
    +     		+

    Functional creation of a value, immediate

    + + +

    CompiledName: .ctor

    +
    + + new(...) + +
    + Signature: (name:string * attributes:TypeAttributes * layout:ILTypeDefLayout * implements:ILTypes * genericParams:ILGenericParameterDefs * extends:ILType option * methods:ILMethodDefs * nestedTypes:ILTypeDefs * fields:ILFieldDefs * methodImpls:ILMethodImplDefs * events:ILEventDefs * properties:ILPropertyDefs * securityDeclsStored:ILSecurityDeclsStored * customAttrsStored:ILAttributesStored * metadataIndex:int32) -> ILTypeDef
    +
    +     		+

    Functional creation of a value, using delayed reading via a metadata index, for ilread.fs

    + + +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Access + +
    + Signature: ILTypeDefAccess
    +
    +     		+ +

    CompiledName: get_Access

    +
    + + x.Attributes + +
    + Signature: TypeAttributes
    +
    +     		+ +

    CompiledName: get_Attributes

    +
    + + x.CustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +

    CompiledName: get_CustomAttrs

    +
    + + x.Encoding + +
    + Signature: ILDefaultPInvokeEncoding
    +
    +     		+ +

    CompiledName: get_Encoding

    +
    + + x.Events + +
    + Signature: ILEventDefs
    +
    +     		+ +

    CompiledName: get_Events

    +
    + + x.Extends + +
    + Signature: ILType option
    +
    +     		+ +

    CompiledName: get_Extends

    +
    + + x.Fields + +
    + Signature: ILFieldDefs
    +
    +     		+ +

    CompiledName: get_Fields

    +
    + + x.GenericParams + +
    + Signature: ILGenericParameterDefs
    +
    +     		+ +

    CompiledName: get_GenericParams

    +
    + + x.HasSecurity + +
    + Signature: bool
    +
    +     		+

    Some classes are marked "HasSecurity" even if there are no permissions attached, +e.g. if they use SuppressUnmanagedCodeSecurityAttribute

    + + +

    CompiledName: get_HasSecurity

    +
    + + x.Implements + +
    + Signature: ILTypes
    +
    +     		+ +

    CompiledName: get_Implements

    +
    + + x.IsAbstract + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsAbstract

    +
    + + x.IsClass + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsClass

    +
    + + x.IsComInterop + +
    + Signature: bool
    +
    +     		+

    Class or interface generated for COM interop.

    + + +

    CompiledName: get_IsComInterop

    +
    + + x.IsDelegate + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsDelegate

    +
    + + x.IsEnum + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEnum

    +
    + + x.IsInterface + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsInterface

    +
    + + x.IsSealed + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSealed

    +
    + + x.IsSerializable + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSerializable

    +
    + + x.IsSpecialName + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSpecialName

    +
    + + x.IsStruct + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsStruct

    +
    + + x.IsStructOrEnum + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsStructOrEnum

    +
    + + x.Layout + +
    + Signature: ILTypeDefLayout
    +
    +     		+ +

    CompiledName: get_Layout

    +
    + + x.MethodImpls + +
    + Signature: ILMethodImplDefs
    +
    +     		+ +

    CompiledName: get_MethodImpls

    +
    + + x.Methods + +
    + Signature: ILMethodDefs
    +
    +     		+ +

    CompiledName: get_Methods

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + + x.NestedTypes + +
    + Signature: ILTypeDefs
    +
    +     		+ +

    CompiledName: get_NestedTypes

    +
    + + x.Properties + +
    + Signature: ILPropertyDefs
    +
    +     		+ +

    CompiledName: get_Properties

    +
    + + x.SecurityDecls + +
    + Signature: ILSecurityDecls
    +
    +     		+ +

    CompiledName: get_SecurityDecls

    +
    + + x.With(...) + +
    + Signature: (name:string option * attributes:TypeAttributes option * layout:ILTypeDefLayout option * implements:ILTypes option * genericParams:ILGenericParameterDefs option * extends:ILType option option * methods:ILMethodDefs option * nestedTypes:ILTypeDefs option * fields:ILFieldDefs option * methodImpls:ILMethodImplDefs option * events:ILEventDefs option * properties:ILPropertyDefs option * customAttrs:ILAttributes option * securityDecls:ILSecurityDecls option) -> ILTypeDef
    +
    +     		+

    Functional update

    + + +
    + + x.WithAbstract(arg1) + +
    + Signature: bool -> ILTypeDef
    +
    +     		+ +
    + + x.WithAccess(arg1) + +
    + Signature: ILTypeDefAccess -> ILTypeDef
    +
    +     		+ +
    + + x.WithEncoding(arg1) + +
    + Signature: ILDefaultPInvokeEncoding -> ILTypeDef
    +
    +     		+ +
    + + x.WithHasSecurity(arg1) + +
    + Signature: bool -> ILTypeDef
    +
    +     		+ +
    + + x.WithImport(arg1) + +
    + Signature: bool -> ILTypeDef
    +
    +     		+ +
    + + x.WithInitSemantics(arg1) + +
    + Signature: ILTypeInit -> ILTypeDef
    +
    +     		+ +
    + + x.WithKind(arg1) + +
    + Signature: ILTypeDefKind -> ILTypeDef
    +
    +     		+ +
    + + x.WithLayout(arg1) + +
    + Signature: ILTypeDefLayout -> ILTypeDef
    +
    +     		+ +
    + + x.WithNestedAccess(arg1) + +
    + Signature: ILMemberAccess -> ILTypeDef
    +
    +     		+ +
    + + x.WithSealed(arg1) + +
    + Signature: bool -> ILTypeDef
    +
    +     		+ +
    + + x.WithSerializable(arg1) + +
    + Signature: bool -> ILTypeDef
    +
    +     		+ +
    + + x.WithSpecialName(arg1) + +
    + Signature: bool -> ILTypeDef
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedefaccess.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedefaccess.html new file mode 100644 index 0000000000..c214c5512c --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypedefaccess.html @@ -0,0 +1,148 @@ + + + + + ILTypeDefAccess - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeDefAccess

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Type Access.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Nested(ILMemberAccess) + +
    + Signature: ILMemberAccess
    +
    +     		+ +
    + + Private + +
    + Signature:
    +
    +     		+ +
    + + Public + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedefkind.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedefkind.html new file mode 100644 index 0000000000..08427b23e7 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypedefkind.html @@ -0,0 +1,174 @@ + + + + + ILTypeDefKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeDefKind

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    A categorization of type definitions into "kinds"

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Class + +
    + Signature:
    +
    +     		+ +
    + + Delegate + +
    + Signature:
    +
    +     		+ +
    + + Enum + +
    + Signature:
    +
    +     		+ +
    + + Interface + +
    + Signature:
    +
    +     		+ +
    + + ValueType + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayout.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayout.html new file mode 100644 index 0000000000..5117e074c7 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayout.html @@ -0,0 +1,148 @@ + + + + + ILTypeDefLayout - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeDefLayout

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Type Layout information.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Auto + +
    + Signature:
    +
    +     		+ +
    + + Explicit(ILTypeDefLayoutInfo) + +
    + Signature: ILTypeDefLayoutInfo
    +
    +     		+ +
    + + Sequential(ILTypeDefLayoutInfo) + +
    + Signature: ILTypeDefLayoutInfo
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayoutinfo.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayoutinfo.html new file mode 100644 index 0000000000..d552051162 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypedeflayoutinfo.html @@ -0,0 +1,128 @@ + + + + + ILTypeDefLayoutInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeDefLayoutInfo

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Pack + +
    + Signature: uint16 option
    +
    +     		+ +
    + + Size + +
    + Signature: int32 option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedefs.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedefs.html new file mode 100644 index 0000000000..1b7dcde2e3 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypedefs.html @@ -0,0 +1,173 @@ + + + + + ILTypeDefs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeDefs

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<Sealed>]
    + +     +

    +
    +

    Tables of named type definitions.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AsArray + +
    + Signature: ILTypeDef []
    +
    +     		+ +

    CompiledName: get_AsArray

    +
    + + x.AsArrayOfPreTypeDefs + +
    + Signature: ILPreTypeDef []
    +
    +     		+

    Get some information about the type defs, but do not force the read of the type defs themselves.

    + + +

    CompiledName: get_AsArrayOfPreTypeDefs

    +
    + + x.AsList + +
    + Signature: ILTypeDef list
    +
    +     		+ +

    CompiledName: get_AsList

    +
    + + x.FindByName(arg1) + +
    + Signature: string -> ILTypeDef
    +
    +     		+

    Calls to FindByName will result in any laziness in the overall +set of ILTypeDefs being read in in addition +to the details for the type found, but the remaining individual +type definitions will not be read.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypedefstored.html b/docs/reference/fsharp-compiler-abstractil-il-iltypedefstored.html new file mode 100644 index 0000000000..cc1f3c888f --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypedefstored.html @@ -0,0 +1,99 @@ + + + + + ILTypeDefStored - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeDefStored

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypeinit.html b/docs/reference/fsharp-compiler-abstractil-il-iltypeinit.html new file mode 100644 index 0000000000..d580fa4bf7 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypeinit.html @@ -0,0 +1,135 @@ + + + + + ILTypeInit - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeInit

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Indicate the initialization semantics of a type.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + BeforeField + +
    + Signature:
    +
    +     		+ +
    + + OnAny + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltyperef.html b/docs/reference/fsharp-compiler-abstractil-il-iltyperef.html new file mode 100644 index 0000000000..16efa27240 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltyperef.html @@ -0,0 +1,226 @@ + + + + + ILTypeRef - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeRef

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Type refs, i.e. references to types in some .NET assembly

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.BasicQualifiedName + +
    + Signature: string
    +
    +     		+

    The name of the type in the assembly using the '+' notation for nested types.

    + + +

    CompiledName: get_BasicQualifiedName

    +
    + + x.Enclosing + +
    + Signature: string list
    +
    +     		+

    The list of enclosing type names for a nested type. If non-nil then the first of these also contains the namespace.

    + + +

    CompiledName: get_Enclosing

    +
    + + x.FullName + +
    + Signature: string
    +
    +     		+

    The name of the type in the assembly using the '.' notation for nested types.

    + + +

    CompiledName: get_FullName

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    The name of the type. This also contains the namespace if Enclosing is empty.

    + + +

    CompiledName: get_Name

    +
    + + x.QualifiedName + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_QualifiedName

    +
    + + x.Scope + +
    + Signature: ILScopeRef
    +
    +     		+

    Where is the type, i.e. is it in this module, in another module in this assembly or in another assembly?

    + + +

    CompiledName: get_Scope

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + ILTypeRef.Create(scope, enclosing, name) + +
    + Signature: (scope:ILScopeRef * enclosing:string list * name:string) -> ILTypeRef
    +
    +     		+

    Create a ILTypeRef.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypes.html b/docs/reference/fsharp-compiler-abstractil-il-iltypes.html new file mode 100644 index 0000000000..f40afbf80d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypes.html @@ -0,0 +1,194 @@ + + + + + ILTypes - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypes

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: ILType
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> ILType
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: ILType list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: ILType list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-iltypespec.html b/docs/reference/fsharp-compiler-abstractil-il-iltypespec.html new file mode 100644 index 0000000000..1fda6232b1 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-iltypespec.html @@ -0,0 +1,228 @@ + + + + + ILTypeSpec - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILTypeSpec

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Type specs and types.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Enclosing + +
    + Signature: string list
    +
    +     		+

    The list of enclosing type names for a nested type. If non-nil then the first of these also contains the namespace.

    + + +

    CompiledName: get_Enclosing

    +
    + + x.FullName + +
    + Signature: string
    +
    +     		+

    The name of the type in the assembly using the '.' notation for nested types.

    + + +

    CompiledName: get_FullName

    +
    + + x.GenericArgs + +
    + Signature: ILGenericArgs
    +
    +     		+

    The type instantiation if the type is generic, otherwise empty

    + + +

    CompiledName: get_GenericArgs

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    The name of the type. This also contains the namespace if Enclosing is empty.

    + + +

    CompiledName: get_Name

    +
    + + x.Scope + +
    + Signature: ILScopeRef
    +
    +     		+

    Where is the type, i.e. is it in this module, in another module in this assembly or in another assembly?

    + + +

    CompiledName: get_Scope

    +
    + + x.TypeRef + +
    + Signature: ILTypeRef
    +
    +     		+

    Which type is being referred to?

    + + +

    CompiledName: get_TypeRef

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + ILTypeSpec.Create(...) + +
    + Signature: (typeRef:ILTypeRef * instantiation:ILGenericArgs) -> ILTypeSpec
    +
    +     		+

    Create an ILTypeSpec.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilvarargs.html b/docs/reference/fsharp-compiler-abstractil-il-ilvarargs.html new file mode 100644 index 0000000000..bacf654f55 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilvarargs.html @@ -0,0 +1,170 @@ + + + + + ILVarArgs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILVarArgs

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.IsNone + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsNone

    +
    + + x.IsSome + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSome

    +
    + + x.Value + +
    + Signature: ILTypes
    + + Attributes:
    +[<CompilationRepresentation(2)>]
    +     +
    +     		+ +

    CompiledName: get_Value

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + Option.None + +
    + Signature: ILTypes option
    +
    +     		+ +

    CompiledName: get_None

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilversioninfo.html b/docs/reference/fsharp-compiler-abstractil-il-ilversioninfo.html new file mode 100644 index 0000000000..c28bf2eb24 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilversioninfo.html @@ -0,0 +1,181 @@ + + + + + ILVersionInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILVersionInfo

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<Struct>]
    + +     +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Build + +
    + Signature: uint16
    +
    +     		+ +
    + + Major + +
    + Signature: uint16
    +
    +     		+ +
    + + Minor + +
    + Signature: uint16
    +
    +     		+ +
    + + Revision + +
    + Signature: uint16
    +
    +     		+ +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(major, minor, build, revision) + +
    + Signature: (major:uint16 * minor:uint16 * build:uint16 * revision:uint16) -> ILVersionInfo
    +
    +     		+ +

    CompiledName: .ctor

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-ilvolatility.html b/docs/reference/fsharp-compiler-abstractil-il-ilvolatility.html new file mode 100644 index 0000000000..04a30b388a --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-ilvolatility.html @@ -0,0 +1,128 @@ + + + + + ILVolatility - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILVolatility

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Nonvolatile + +
    + Signature:
    +
    +     		+ +
    + + Volatile + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-methodbody.html b/docs/reference/fsharp-compiler-abstractil-il-methodbody.html new file mode 100644 index 0000000000..28f3f97629 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-methodbody.html @@ -0,0 +1,172 @@ + + + + + MethodBody - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MethodBody

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Abstract + +
    + Signature:
    +
    +     		+ +
    + + IL(ILMethodBody) + +
    + Signature: ILMethodBody
    +
    +     		+ +
    + + Native + +
    + Signature:
    +
    +     		+ +
    + + NotAvailable + +
    + Signature:
    +
    +     		+ +
    + + PInvoke(PInvokeMethod) + +
    + Signature: PInvokeMethod
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-methodcodekind.html b/docs/reference/fsharp-compiler-abstractil-il-methodcodekind.html new file mode 100644 index 0000000000..ff60e445c5 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-methodcodekind.html @@ -0,0 +1,146 @@ + + + + + MethodCodeKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MethodCodeKind

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + IL + +
    + Signature:
    +
    +     		+ +
    + + Native + +
    + Signature:
    +
    +     		+ +
    + + Runtime + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-methodkind.html b/docs/reference/fsharp-compiler-abstractil-il-methodkind.html new file mode 100644 index 0000000000..ef838ba7e8 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-methodkind.html @@ -0,0 +1,172 @@ + + + + + MethodKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MethodKind

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Cctor + +
    + Signature:
    +
    +     		+ +
    + + Ctor + +
    + Signature:
    +
    +     		+ +
    + + NonVirtual + +
    + Signature:
    +
    +     		+ +
    + + Static + +
    + Signature:
    +
    +     		+ +
    + + Virtual(ILMethodVirtualInfo) + +
    + Signature: ILMethodVirtualInfo
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokecallingconvention.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokecallingconvention.html new file mode 100644 index 0000000000..98aea862d3 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-pinvokecallingconvention.html @@ -0,0 +1,187 @@ + + + + + PInvokeCallingConvention - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PInvokeCallingConvention

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    PInvoke attributes.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Cdecl + +
    + Signature:
    +
    +     		+ +
    + + Fastcall + +
    + Signature:
    +
    +     		+ +
    + + None + +
    + Signature:
    +
    +     		+ +
    + + Stdcall + +
    + Signature:
    +
    +     		+ +
    + + Thiscall + +
    + Signature:
    +
    +     		+ +
    + + WinApi + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokecharbestfit.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokecharbestfit.html new file mode 100644 index 0000000000..d23d5d836f --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-pinvokecharbestfit.html @@ -0,0 +1,146 @@ + + + + + PInvokeCharBestFit - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PInvokeCharBestFit

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Disabled + +
    + Signature:
    +
    +     		+ +
    + + Enabled + +
    + Signature:
    +
    +     		+ +
    + + UseAssembly + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokecharencoding.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokecharencoding.html new file mode 100644 index 0000000000..6e7deaa0c6 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-pinvokecharencoding.html @@ -0,0 +1,159 @@ + + + + + PInvokeCharEncoding - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PInvokeCharEncoding

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Ansi + +
    + Signature:
    +
    +     		+ +
    + + Auto + +
    + Signature:
    +
    +     		+ +
    + + None + +
    + Signature:
    +
    +     		+ +
    + + Unicode + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokemethod.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokemethod.html new file mode 100644 index 0000000000..8066e5a8a6 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-pinvokemethod.html @@ -0,0 +1,213 @@ + + + + + PInvokeMethod - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PInvokeMethod

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + CallingConv + +
    + Signature: PInvokeCallingConvention
    +
    +     		+ +
    + + CharBestFit + +
    + Signature: PInvokeCharBestFit
    +
    +     		+ +
    + + CharEncoding + +
    + Signature: PInvokeCharEncoding
    +
    +     		+ +
    + + LastError + +
    + Signature: bool
    +
    +     		+ +
    + + Name + +
    + Signature: string
    +
    +     		+ +
    + + NoMangle + +
    + Signature: bool
    +
    +     		+ +
    + + ThrowOnUnmappableChar + +
    + Signature: PInvokeThrowOnUnmappableChar
    +
    +     		+ +
    + + Where + +
    + Signature: ILModuleRef
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-pinvokethrowonunmappablechar.html b/docs/reference/fsharp-compiler-abstractil-il-pinvokethrowonunmappablechar.html new file mode 100644 index 0000000000..b7e9d4b2ae --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-pinvokethrowonunmappablechar.html @@ -0,0 +1,146 @@ + + + + + PInvokeThrowOnUnmappableChar - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PInvokeThrowOnUnmappableChar

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Disabled + +
    + Signature:
    +
    +     		+ +
    + + Enabled + +
    + Signature:
    +
    +     		+ +
    + + UseAssembly + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-primaryassembly.html b/docs/reference/fsharp-compiler-abstractil-il-primaryassembly.html new file mode 100644 index 0000000000..946c0750b5 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-primaryassembly.html @@ -0,0 +1,168 @@ + + + + + PrimaryAssembly - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PrimaryAssembly

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Mscorlib + +
    + Signature:
    +
    +     		+ +
    + + NetStandard + +
    + Signature:
    +
    +     		+ +
    + + System_Runtime + +
    + Signature:
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il-publickey.html b/docs/reference/fsharp-compiler-abstractil-il-publickey.html new file mode 100644 index 0000000000..714f9ee80f --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il-publickey.html @@ -0,0 +1,219 @@ + + + + + PublicKey - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PublicKey

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: IL
    + + Attributes:
    +[<StructuralEquality>]
    +[<StructuralComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + PublicKey(byte []) + +
    + Signature: byte []
    +
    +     		+ +
    + + PublicKeyToken(byte []) + +
    + Signature: byte []
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.IsKey + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsKey

    +
    + + x.IsKeyToken + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsKeyToken

    +
    + + x.Key + +
    + Signature: byte []
    +
    +     		+ +

    CompiledName: get_Key

    +
    + + x.KeyToken + +
    + Signature: byte []
    +
    +     		+ +

    CompiledName: get_KeyToken

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + PublicKey.KeyAsToken(arg1) + +
    + Signature: (byte []) -> PublicKey
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-il.html b/docs/reference/fsharp-compiler-abstractil-il.html new file mode 100644 index 0000000000..52bfed8eee --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-il.html @@ -0,0 +1,3918 @@ + + + + + IL - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    IL

    +

    + Namespace: FSharp.Compiler.AbstractIL
    +

    +
    +

    The "unlinked" view of .NET metadata and code. Central to the Abstract IL library

    + +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + ILAlignment + + +
    + ILArgConvention + + +
    + ILArrayBound + +

    Array shapes. For most purposes the rank is the only thing that matters.

    + + +
    + ILArrayBounds + +

    Lower-bound/size pairs

    + + +
    + ILArrayShape + + +
    + ILAssemblyLongevity + + +
    + ILAssemblyManifest + +

    The main module of an assembly is a module plus some manifest information.

    + + +
    + ILAssemblyRef + + +
    + ILAttribElem + + +
    + ILAttribute + +

    Custom attribute.

    + + +
    + ILAttributeNamedArg + +

    Named args: values and flags indicating if they are fields or properties.

    + + +
    + ILAttributes + + +
    + ILAttributesStored + +

    Represents the efficiency-oriented storage of ILAttributes in another item.

    + + +
    + ILBasicType + + +
    + ILBoxity + + +
    + ILCallingConv + + +
    + ILCallingSignature + + +
    + ILCode + + +
    + ILCodeLabel + +

    ILCode labels. In structured code each code label refers to a basic block somewhere in the code of the method.

    + + +
    + ILComparisonInstr + + +
    + ILConst + + +
    + ILDefaultPInvokeEncoding + +

    Default Unicode encoding for P/Invoke within a type.

    + + +
    + ILEnumInfo + +

    Decompose a type definition according to its kind.

    + + +
    + ILEventDef + +

    Event definitions.

    + + +
    + ILEventDefs + +

    Table of those events in a type definition.

    + + +
    + ILEventRef + +

    A utility type provided for completeness

    + + +
    + ILExceptionClause + + +
    + ILExceptionSpec + + +
    + ILExportedTypeOrForwarder + +

    these are only found in the ILExportedTypesAndForwarders table in the manifest

    + + +
    + ILExportedTypesAndForwarders + + +
    + ILFieldDef + +

    Field definitions.

    + + +
    + ILFieldDefs + +

    Tables of fields. Logically equivalent to a list of fields but the table is kept in +a form to allow efficient looking up fields by name.

    + + +
    + ILFieldInit + +

    Field Init

    + + +
    + ILFieldRef + +

    Formal identities of fields.

    + + +
    + ILFieldSpec + +

    Field specs. The data given for a ldfld, stfld etc. instruction.

    + + +
    + ILGenericArgs + +

    Actual generic parameters are always types.

    + + +
    + ILGenericArgsList + + +
    + ILGenericParameterDef + +

    Generic parameters. Formal generic parameter declarations may include the bounds, if any, on the generic parameter.

    + + +
    + ILGenericParameterDefs + + +
    + ILGenericVariance + + +
    + ILGlobals + +

    A table of common references to items in primary assembly (System.Runtime or mscorlib). +If a particular version of System.Runtime.dll has been loaded then you should +reference items from it via an ILGlobals for that specific version built using mkILGlobals.

    + + +
    + ILGuid + +

    Represents guids

    + + +
    + ILInstr + +

    The instruction set.

    + + +
    + ILLazyMethodBody + + +
    + ILLocal + +

    Local variables

    + + +
    + ILLocalDebugInfo + + +
    + ILLocalDebugMapping + +

    Indicates that a particular local variable has a particular source +language name within a given set of ranges. This does not effect local +variable numbering, which is global over the whole method.

    + + +
    + ILLocals + + +
    + ILLocalsAllocator + +

    Helpers for codegen: scopes for allocating new temporary variables.

    + + +
    + ILMemberAccess + +

    Member Access

    + + +
    + ILMethodBody + +

    IL method bodies

    + + +
    + ILMethodDef + +

    IL Method definitions.

    + + +
    + ILMethodDefs + +

    Tables of methods. Logically equivalent to a list of methods but +the table is kept in a form optimized for looking up methods by +name and arity.

    + + +
    + ILMethodImplDef + +

    Method Impls

    + + +
    + ILMethodImplDefs + + +
    + ILMethodRef + +

    Formal identities of methods.

    + + +
    + ILMethodSpec + +

    The information at the callsite of a method

    + + +
    + ILMethodVirtualInfo + + +
    + ILModuleDef + +

    One module in the "current" assembly, either a main-module or +an auxiliary module. The main module will have a manifest.

    +

    An assembly is built by joining together a "main" module plus +several auxiliary modules.

    + + +
    + ILModuleRef + + +
    + ILNativeResource + + +
    + ILNativeType + +

    Native Types, for marshalling to the native C interface. +These are taken directly from the ILASM syntax, see ECMA Spec (Partition II, 7.4).

    + + +
    + ILNativeVariant + + +
    + ILNestedExportedType + +

    these are only found in the "Nested" field of ILExportedTypeOrForwarder objects

    + + +
    + ILNestedExportedTypes + + +
    + ILOverridesSpec + + + +
    + ILParameter + +

    Method parameters and return values.

    + + +
    + ILParameters + + +
    + ILPlatform + + +
    + ILPreTypeDef + +

    Represents a prefix of information for ILTypeDef.

    +

    The information is enough to perform name resolution for the F# compiler, probe attributes +for ExtensionAttribute etc. This is key to the on-demand exploration of .NET metadata. +This information has to be "Goldilocks" - not too much, not too little, just right.

    + + +
    + ILPreTypeDefImpl + + +
    + ILPropertyDef + +

    Property definitions

    + + +
    + ILPropertyDefs + +

    Table of properties in an IL type definition.

    + + +
    + ILPropertyRef + +

    A utility type provided for completeness

    + + +
    + ILReadonly + + +
    + ILReferences + + +
    + ILResource + +

    "Manifest ILResources" are chunks of resource data, being one of: +- the data section of the current module (byte[] of resource given directly). +- in an external file in this assembly (offset given in the ILResourceLocation field). +- as a resources in another assembly of the same name.

    + + +
    + ILResourceAccess + + +
    + ILResourceLocation + + +
    + ILResources + +

    Table of resources in a module.

    + + +
    + ILReturn + +

    Method return values.

    + + +
    + ILScopeRef + + +
    + ILSecurityAction + + +
    + ILSecurityDecl + + +
    + ILSecurityDecls + +

    Abstract type equivalent to ILSecurityDecl list - use helpers +below to construct/destruct these.

    + + +
    + ILSecurityDeclsStored + +

    Represents the efficiency-oriented storage of ILSecurityDecls in another item.

    + + +
    + ILSourceDocument + +

    Debug info. Values of type "source" can be attached at sequence +points and some other locations.

    + + +
    + ILSourceMarker + + +
    + ILTailcall + + +
    + ILThisConvention + + +
    + ILToken + + +
    + ILType + + +
    + ILTypeDef + +

    Represents IL Type Definitions.

    + + +
    + ILTypeDefAccess + +

    Type Access.

    + + +
    + ILTypeDefKind + +

    A categorization of type definitions into "kinds"

    + + +
    + ILTypeDefLayout + +

    Type Layout information.

    + + +
    + ILTypeDefLayoutInfo + + +
    + ILTypeDefStored + + +
    + ILTypeDefs + +

    Tables of named type definitions.

    + + +
    + ILTypeInit + +

    Indicate the initialization semantics of a type.

    + + +
    + ILTypeRef + +

    Type refs, i.e. references to types in some .NET assembly

    + + +
    + ILTypeSpec + +

    Type specs and types.

    + + +
    + ILTypes + + +
    + ILVarArgs + + +
    + ILVersionInfo + + +
    + ILVolatility + + +
    + MethodBody + + +
    + MethodCodeKind + + +
    + MethodKind + + +
    + PInvokeCallingConvention + +

    PInvoke attributes.

    + + +
    + PInvokeCharBestFit + + +
    + PInvokeCharEncoding + + +
    + PInvokeMethod + + +
    + PInvokeThrowOnUnmappableChar + + +
    + PrimaryAssembly + + +
    + PublicKey + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + addILTypeDef arg1 arg2 + +
    + Signature: ILTypeDef -> ILTypeDefs -> ILTypeDefs
    +
    +     		+ +
    + + andTailness arg1 arg2 + +
    + Signature: ILTailcall -> bool -> ILTailcall
    +
    +     		+ +
    + + buildILCode arg1 lab2pc instrs arg4 arg5 + +
    + Signature: string -> lab2pc:Dictionary<ILCodeLabel,int> -> instrs:ILInstr [] -> ILExceptionSpec list -> ILLocalDebugInfo list -> ILCode
    +
    +     		+ +
    + + compareILVersions arg1 arg2 + +
    + Signature: ILVersionInfo -> ILVersionInfo -> int
    +
    +     		+ +
    + + computeILEnumInfo(arg1, arg2) + +
    + Signature: (string * ILFieldDefs) -> ILEnumInfo
    +
    +     		+ +
    + + computeILRefs arg1 arg2 + +
    + Signature: ILGlobals -> ILModuleDef -> ILReferences
    +
    +     		+

    Find the full set of assemblies referenced by a module.

    + + +
    + + decodeILAttribData arg1 arg2 + +
    + Signature: ILGlobals -> ILAttribute -> ILAttribElem list * ILAttributeNamedArg list
    +
    +     		+

    Not all custom attribute data can be decoded without binding types. In particular +enums must be bound in order to discover the size of the underlying integer. +The following assumes enums have size int32.

    + + +
    + + destILArrTy(arg1) + +
    + Signature: ILType -> ILArrayShape * ILType
    +
    +     		+ +
    + + destTypeDefsWithGlobalFunctionsFirst(...) + +
    + Signature: ILGlobals -> ILTypeDefs -> ILTypeDef list
    +
    +     		+

    When writing a binary the fake "toplevel" type definition (called ) +must come first. This function puts it first, and creates it in the returned +list as an empty typedef if it doesn't already exist.

    + + +
    + + EcmaMscorlibILGlobals + +
    + Signature: ILGlobals
    +
    +     		+ +
    + + ecmaPublicKey + +
    + Signature: PublicKey
    +
    +     		+

    This is a 'vendor neutral' way of referencing mscorlib.

    + + +
    + + emptyILCustomAttrs + +
    + Signature: ILAttributes
    +
    +     		+ +
    + + emptyILEvents + +
    + Signature: ILEventDefs
    +
    +     		+ +
    + + emptyILFields + +
    + Signature: ILFieldDefs
    +
    +     		+ +
    + + emptyILMethodImpls + +
    + Signature: ILMethodImplDefs
    +
    +     		+ +
    + + emptyILMethods + +
    + Signature: ILMethodDefs
    +
    +     		+ +
    + + emptyILProperties + +
    + Signature: ILPropertyDefs
    +
    +     		+ +
    + + emptyILRefs + +
    + Signature: ILReferences
    +
    +     		+ +
    + + emptyILSecurityDecls + +
    + Signature: ILSecurityDecls
    +
    +     		+ +
    + + emptyILTypeDefs + +
    + Signature: ILTypeDefs
    +
    +     		+ +
    + + formatCodeLabel(arg1) + +
    + Signature: ILCodeLabel -> string
    +
    +     		+ +
    + + formatILVersion(arg1) + +
    + Signature: ILVersionInfo -> string
    +
    +     		+ +
    + + generateCodeLabel() + +
    + Signature: unit -> ILCodeLabel
    +
    +     		+

    Making code.

    + + +
    + + getCustomAttrData arg1 arg2 + +
    + Signature: ILGlobals -> ILAttribute -> byte []
    +
    +     		+ +
    + + getTyOfILEnumInfo(arg1) + +
    + Signature: ILEnumInfo -> ILType
    +
    +     		+ +
    + + instILType arg1 arg2 + +
    + Signature: ILGenericArgs -> ILType -> ILType
    +
    +     		+

    Instantiate type variables that occur within types and other items.

    + + +
    + + instILTypeAux arg1 arg2 arg3 + +
    + Signature: int -> ILGenericArgs -> ILType -> ILType
    +
    +     		+

    Instantiate type variables that occur within types and other items.

    + + +
    + + isILArrTy(arg1) + +
    + Signature: ILType -> bool
    +
    +     		+ +
    + + isILBoolTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILByteTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILCharTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILDoubleTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILInt16Ty arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILInt32Ty arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILInt64Ty arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILIntPtrTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILObjectTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+

    Discriminating different important built-in types.

    + + +
    + + isILSByteTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILSingleTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILStringTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILTypedReferenceTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILUInt16Ty arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILUInt32Ty arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILUInt64Ty arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isILUIntPtrTy arg1 arg2 + +
    + Signature: ILGlobals -> ILType -> bool
    +
    +     		+ +
    + + isTypeNameForGlobalFunctions(arg1) + +
    + Signature: string -> bool
    +
    +     		+ +
    + + methBodyAbstract + +
    + Signature: ILLazyMethodBody
    +
    +     		+ +
    + + methBodyNative + +
    + Signature: ILLazyMethodBody
    +
    +     		+ +
    + + methBodyNotAvailable + +
    + Signature: ILLazyMethodBody
    +
    +     		+ +
    + + mkCallBaseConstructor(arg1, arg2) + +
    + Signature: (ILType * ILType list) -> ILInstr list
    +
    +     		+ +
    + + mkCtorMethSpecForDelegate(...) + +
    + Signature: ILGlobals -> (ILType * bool) -> ILMethodSpec
    +
    +     		+

    Given a delegate type definition which lies in a particular scope, +make a reference to its constructor.

    + + +
    + + mkILArr1DTy(arg1) + +
    + Signature: ILType -> ILType
    +
    +     		+ +
    + + mkILArrTy(arg1, arg2) + +
    + Signature: (ILType * ILArrayShape) -> ILType
    +
    +     		+ +
    + + mkILBoxedTy arg1 arg2 + +
    + Signature: ILTypeRef -> ILGenericArgsList -> ILType
    +
    +     		+ +
    + + mkILBoxedType(arg1) + +
    + Signature: ILTypeSpec -> ILType
    +
    +     		+ +
    + + mkILCallSig(arg1, arg2, arg3) + +
    + Signature: (ILCallingConv * ILType list * ILType) -> ILCallingSignature
    +
    +     		+ +
    + + mkILClassCtor(arg1) + +
    + Signature: MethodBody -> ILMethodDef
    +
    +     		+ +
    + + mkILCtor(arg1, arg2, arg3) + +
    + Signature: (ILMemberAccess * ILParameter list * MethodBody) -> ILMethodDef
    +
    +     		+ +
    + + mkILCtorMethSpecForTy(arg1, arg2) + +
    + Signature: (ILType * ILType list) -> ILMethodSpec
    +
    +     		+

    Construct references to constructors.

    + + +
    + + mkILCustomAttribMethRef(...) + +
    + Signature: ILGlobals -> (ILMethodSpec * ILAttribElem list * ILAttributeNamedArg list) -> ILAttribute
    +
    +     		+

    Make custom attributes.

    + + +
    + + mkILCustomAttribute(...) + +
    + Signature: ILGlobals -> (ILTypeRef * ILType list * ILAttribElem list * ILAttributeNamedArg list) -> ILAttribute
    +
    +     		+ +
    + + mkILCustomAttrs(arg1) + +
    + Signature: ILAttribute list -> ILAttributes
    +
    +     		+

    Making tables of custom attributes, etc.

    + + +
    + + mkILCustomAttrsFromArray(arg1) + +
    + Signature: ILAttribute [] -> ILAttributes
    +
    +     		+ +
    + + mkILCustomAttrsReader(arg1) + +
    + Signature: (int32 -> ILAttribute []) -> ILAttributesStored
    +
    +     		+ +
    + + mkILDelegateMethods(...) + +
    + Signature: ILMemberAccess -> ILGlobals -> (ILType * ILType) -> (ILParameter list * ILReturn) -> ILMethodDef list
    +
    +     		+ +
    + + mkILEmptyGenericParams + +
    + Signature: ILGenericParameterDefs
    +
    +     		+

    Make a formal generic parameters.

    + + +
    + + mkILEvents(arg1) + +
    + Signature: ILEventDef list -> ILEventDefs
    +
    +     		+ +
    + + mkILEventsLazy(arg1) + +
    + Signature: Lazy<ILEventDef list> -> ILEventDefs
    +
    +     		+ +
    + + mkILExportedTypes(arg1) + +
    + Signature: ILExportedTypeOrForwarder list -> ILExportedTypesAndForwarders
    +
    +     		+ +
    + + mkILExportedTypesLazy(arg1) + +
    + Signature: Lazy<ILExportedTypeOrForwarder list> -> ILExportedTypesAndForwarders
    +
    +     		+ +
    + + mkILFieldRef(arg1, arg2, arg3) + +
    + Signature: (ILTypeRef * string * ILType) -> ILFieldRef
    +
    +     		+

    Construct references to fields.

    + + +
    + + mkILFields(arg1) + +
    + Signature: ILFieldDef list -> ILFieldDefs
    +
    +     		+ +
    + + mkILFieldsLazy(arg1) + +
    + Signature: Lazy<ILFieldDef list> -> ILFieldDefs
    +
    +     		+ +
    + + mkILFieldSpec(arg1, arg2) + +
    + Signature: (ILFieldRef * ILType) -> ILFieldSpec
    +
    +     		+ +
    + + mkILFieldSpecInTy(arg1, arg2, arg3) + +
    + Signature: (ILType * string * ILType) -> ILFieldSpec
    +
    +     		+ +
    + + mkILFormalBoxedTy arg1 arg2 + +
    + Signature: ILTypeRef -> ILGenericParameterDef list -> ILType
    +
    +     		+

    Make generalized versions of possibly-generic types, e.g. Given the ILTypeDef for List, return the type "List".

    + + +
    + + mkILFormalGenericArgs arg1 arg2 + +
    + Signature: int -> ILGenericParameterDefs -> ILGenericArgsList
    +
    +     		+ +
    + + mkILFormalNamedTy arg1 arg2 arg3 + +
    + Signature: ILBoxity -> ILTypeRef -> ILGenericParameterDef list -> ILType
    +
    +     		+ +
    + + mkILFormalTypars(arg1) + +
    + Signature: ILType list -> ILGenericParameterDefs
    +
    +     		+ +
    + + mkILGenericClass(...) + +
    + Signature: (string * ILTypeDefAccess * ILGenericParameterDefs * ILType * ILType list * ILMethodDefs * ILFieldDefs * ILTypeDefs * ILPropertyDefs * ILEventDefs * ILAttributes * ILTypeInit) -> ILTypeDef
    +
    +     		+

    Make a type definition.

    + + +
    + + mkILGenericNonVirtualMethod(...) + +
    + Signature: (string * ILMemberAccess * ILGenericParameterDefs * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    +
    +     		+ +
    + + mkILGenericVirtualMethod(...) + +
    + Signature: (string * ILMemberAccess * ILGenericParameterDefs * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    +
    +     		+ +
    + + mkILGlobals(...) + +
    + Signature: (primaryScopeRef:ILScopeRef * assembliesThatForwardToPrimaryAssembly:ILAssemblyRef list) -> ILGlobals
    +
    +     		+

    Build the table of commonly used references given functions to find types in system assemblies

    + + +
    + + mkILInstanceField(...) + +
    + Signature: (string * ILType * ILFieldInit option * ILMemberAccess) -> ILFieldDef
    +
    +     		+

    Make field definitions.

    + + +
    + + mkILInstanceMethSpecInTy(...) + +
    + Signature: (ILType * string * ILType list * ILType * ILGenericArgsList) -> ILMethodSpec
    +
    +     		+

    Construct references to instance methods.

    + + +
    + + mkILLiteralField(...) + +
    + Signature: (string * ILType * ILFieldInit * byte [] option * ILMemberAccess) -> ILFieldDef
    +
    +     		+ +
    + + mkILLocal arg1 arg2 + +
    + Signature: ILType -> (string * int * int) option -> ILLocal
    +
    +     		+ +
    + + mkILMethodBody(...) + +
    + Signature: (initlocals:bool * ILLocals * int * ILCode * ILSourceMarker option) -> ILMethodBody
    +
    +     		+

    Make method definitions.

    + + +
    + + mkILMethodImpls(arg1) + +
    + Signature: ILMethodImplDef list -> ILMethodImplDefs
    +
    +     		+ +
    + + mkILMethodImplsLazy(arg1) + +
    + Signature: Lazy<ILMethodImplDef list> -> ILMethodImplDefs
    +
    +     		+ +
    + + mkILMethods(arg1) + +
    + Signature: ILMethodDef list -> ILMethodDefs
    +
    +     		+ +
    + + mkILMethodsComputed(arg1) + +
    + Signature: (unit -> ILMethodDef []) -> ILMethodDefs
    +
    +     		+ +
    + + mkILMethodsFromArray(arg1) + +
    + Signature: ILMethodDef [] -> ILMethodDefs
    +
    +     		+ +
    + + mkILMethRef(...) + +
    + Signature: (ILTypeRef * ILCallingConv * string * int * ILType list * ILType) -> ILMethodRef
    +
    +     		+

    Make method references and specs.

    + + +
    + + mkILMethSpec(arg1, arg2, arg3, arg4) + +
    + Signature: (ILMethodRef * ILBoxity * ILGenericArgsList * ILGenericArgsList) -> ILMethodSpec
    +
    +     		+ +
    + + mkILMethSpecForMethRefInTy(...) + +
    + Signature: (ILMethodRef * ILType * ILGenericArgsList) -> ILMethodSpec
    +
    +     		+ +
    + + mkILMethSpecInTy(...) + +
    + Signature: (ILType * ILCallingConv * string * ILType list * ILType * ILGenericArgsList) -> ILMethodSpec
    +
    +     		+ +
    + + mkILNamedTy arg1 arg2 arg3 + +
    + Signature: ILBoxity -> ILTypeRef -> ILGenericArgsList -> ILType
    +
    +     		+ +
    + + mkILNestedExportedTypes(arg1) + +
    + Signature: ILNestedExportedType list -> ILNestedExportedTypes
    +
    +     		+ +
    + + mkILNestedExportedTypesLazy(arg1) + +
    + Signature: Lazy<ILNestedExportedType list> -> ILNestedExportedTypes
    +
    +     		+ +
    + + mkILNestedTyRef(arg1, arg2, arg3) + +
    + Signature: (ILScopeRef * string list * string) -> ILTypeRef
    +
    +     		+

    Make type refs.

    + + +
    + + mkILNonGenericBoxedTy(arg1) + +
    + Signature: ILTypeRef -> ILType
    +
    +     		+ +
    + + mkILNonGenericEmptyCtor arg1 arg2 + +
    + Signature: ILSourceMarker option -> ILType -> ILMethodDef
    +
    +     		+ +
    + + mkILNonGenericInstanceMethod(...) + +
    + Signature: (string * ILMemberAccess * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    +
    +     		+ +
    + + mkILNonGenericInstanceMethSpecInTy(...) + +
    + Signature: (ILType * string * ILType list * ILType) -> ILMethodSpec
    +
    +     		+

    Construct references to instance methods.

    + + +
    + + mkILNonGenericMethSpecInTy(...) + +
    + Signature: (ILType * ILCallingConv * string * ILType list * ILType) -> ILMethodSpec
    +
    +     		+

    Construct references to methods on a given type .

    + + +
    + + mkILNonGenericStaticMethod(...) + +
    + Signature: (string * ILMemberAccess * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    +
    +     		+ +
    + + mkILNonGenericStaticMethSpecInTy(...) + +
    + Signature: (ILType * string * ILType list * ILType) -> ILMethodSpec
    +
    +     		+

    Construct references to static, non-generic methods.

    + + +
    + + mkILNonGenericTySpec(arg1) + +
    + Signature: ILTypeRef -> ILTypeSpec
    +
    +     		+

    Make type specs.

    + + +
    + + mkILNonGenericValueTy(arg1) + +
    + Signature: ILTypeRef -> ILType
    +
    +     		+ +
    + + mkILNonGenericVirtualMethod(...) + +
    + Signature: (string * ILMemberAccess * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    +
    +     		+ +
    + + mkILParam(arg1, arg2) + +
    + Signature: (string option * ILType) -> ILParameter
    +
    +     		+

    Derived functions for making return, parameter and local variable +objects for use in method definitions.

    + + +
    + + mkILParamAnon(arg1) + +
    + Signature: ILType -> ILParameter
    +
    +     		+ +
    + + mkILParamNamed(arg1, arg2) + +
    + Signature: (string * ILType) -> ILParameter
    +
    +     		+ +
    + + mkILPreTypeDef(arg1) + +
    + Signature: ILTypeDef -> ILPreTypeDef
    +
    +     		+ +
    + + mkILPreTypeDefComputed(arg1, arg2, arg3) + +
    + Signature: (string list * string * (unit -> ILTypeDef)) -> ILPreTypeDef
    +
    +     		+ +
    + + mkILPreTypeDefRead(...) + +
    + Signature: (string list * string * int32 * ILTypeDefStored) -> ILPreTypeDef
    +
    +     		+ +
    + + mkILProperties(arg1) + +
    + Signature: ILPropertyDef list -> ILPropertyDefs
    +
    +     		+ +
    + + mkILPropertiesLazy(arg1) + +
    + Signature: Lazy<ILPropertyDef list> -> ILPropertyDefs
    +
    +     		+ +
    + + mkILResources(arg1) + +
    + Signature: ILResource list -> ILResources
    +
    +     		+ +
    + + mkILReturn(arg1) + +
    + Signature: ILType -> ILReturn
    +
    +     		+ +
    + + mkILSecurityDecls(arg1) + +
    + Signature: ILSecurityDecl list -> ILSecurityDecls
    +
    +     		+ +
    + + mkILSecurityDeclsReader(arg1) + +
    + Signature: (int32 -> ILSecurityDecl []) -> ILSecurityDeclsStored
    +
    +     		+ +
    + + mkILSimpleClass(...) + +
    + Signature: ILGlobals -> (string * ILTypeDefAccess * ILMethodDefs * ILFieldDefs * ILTypeDefs * ILPropertyDefs * ILEventDefs * ILAttributes * ILTypeInit) -> ILTypeDef
    +
    +     		+ +
    + + mkILSimpleModule(...) + +
    + Signature: assemblyName:string -> moduleName:string -> dll:bool -> subsystemVersion:(int * int) -> useHighEntropyVA:bool -> ILTypeDefs -> int32 option -> string option -> int -> ILExportedTypesAndForwarders -> string -> ILModuleDef
    +
    +     		+

    Making modules.

    + + +
    + + mkILSimpleStorageCtor(...) + +
    + Signature: (ILSourceMarker option * ILTypeSpec option * ILType * ILParameter list * (string * ILType) list * ILMemberAccess) -> ILMethodDef
    +
    +     		+ +
    + + mkILSimpleStorageCtorWithParamNames(...) + +
    + Signature: (ILSourceMarker option * ILTypeSpec option * ILType * ILParameter list * (string * string * ILType) list * ILMemberAccess) -> ILMethodDef
    +
    +     		+ +
    + + mkILSimpleTypar(arg1) + +
    + Signature: string -> ILGenericParameterDef
    +
    +     		+ +
    + + mkILStaticField(...) + +
    + Signature: (string * ILType * ILFieldInit option * byte [] option * ILMemberAccess) -> ILFieldDef
    +
    +     		+ +
    + + mkILStaticMethod(...) + +
    + Signature: (ILGenericParameterDefs * string * ILMemberAccess * ILParameter list * ILReturn * MethodBody) -> ILMethodDef
    +
    +     		+ +
    + + mkILStaticMethSpecInTy(...) + +
    + Signature: (ILType * string * ILType list * ILType * ILGenericArgsList) -> ILMethodSpec
    +
    +     		+

    Construct references to static methods.

    + + +
    + + mkILStorageCtor(...) + +
    + Signature: (ILSourceMarker option * ILInstr list * ILType * (string * ILType) list * ILMemberAccess) -> ILMethodDef
    +
    +     		+

    Derived functions for making some simple constructors

    + + +
    + + mkILTy arg1 arg2 + +
    + Signature: ILBoxity -> ILTypeSpec -> ILType
    +
    +     		+

    Make types.

    + + +
    + + mkILTypeDefForGlobalFunctions(...) + +
    + Signature: ILGlobals -> (ILMethodDefs * ILFieldDefs) -> ILTypeDef
    +
    +     		+ +
    + + mkILTypeDefReader(arg1) + +
    + Signature: (int32 -> ILTypeDef) -> ILTypeDefStored
    +
    +     		+ +
    + + mkILTypeDefs(arg1) + +
    + Signature: ILTypeDef list -> ILTypeDefs
    +
    +     		+ +
    + + mkILTypeDefsComputed(arg1) + +
    + Signature: (unit -> ILPreTypeDef []) -> ILTypeDefs
    +
    +     		+

    Create table of types which is loaded/computed on-demand, and whose individual +elements are also loaded/computed on-demand. Any call to tdefs.AsList will +result in the laziness being forced. Operations can examine the +custom attributes and name of each type in order to decide whether +to proceed with examining the other details of the type.

    +

    Note that individual type definitions may contain further delays +in their method, field and other tables.

    + + +
    + + mkILTypeDefsFromArray(arg1) + +
    + Signature: ILTypeDef [] -> ILTypeDefs
    +
    +     		+ +
    + + mkILTypeForGlobalFunctions(arg1) + +
    + Signature: ILScopeRef -> ILType
    +
    +     		+

    The toplevel "class" for a module or assembly.

    + + +
    + + mkILTyRef(arg1, arg2) + +
    + Signature: (ILScopeRef * string) -> ILTypeRef
    +
    +     		+ +
    + + mkILTyRefInTyRef(arg1, arg2) + +
    + Signature: (ILTypeRef * string) -> ILTypeRef
    +
    +     		+ +
    + + mkILTySpec(arg1, arg2) + +
    + Signature: (ILTypeRef * ILGenericArgsList) -> ILTypeSpec
    +
    +     		+ +
    + + mkILTyvarTy(arg1) + +
    + Signature: uint16 -> ILType
    +
    +     		+ +
    + + mkILValueTy arg1 arg2 + +
    + Signature: ILTypeRef -> ILGenericArgsList -> ILType
    +
    +     		+ +
    + + mkLdarg(arg1) + +
    + Signature: uint16 -> ILInstr
    +
    +     		+ +
    + + mkLdarg0 + +
    + Signature: ILInstr
    +
    +     		+ +
    + + mkLdcInt32(arg1) + +
    + Signature: int32 -> ILInstr
    +
    +     		+ +
    + + mkLdloc(arg1) + +
    + Signature: uint16 -> ILInstr
    +
    +     		+ +
    + + mkMethBodyAux(arg1) + +
    + Signature: MethodBody -> ILLazyMethodBody
    +
    +     		+ +
    + + mkMethBodyLazyAux(arg1) + +
    + Signature: Lazy<MethodBody> -> ILLazyMethodBody
    +
    +     		+ +
    + + mkMethodBody(...) + +
    + Signature: (bool * ILLocals * int * ILCode * ILSourceMarker option) -> MethodBody
    +
    +     		+ +
    + + mkNormalCall(arg1) + +
    + Signature: ILMethodSpec -> ILInstr
    +
    +     		+

    Derived functions for making some common patterns of instructions.

    + + +
    + + mkNormalCallconstraint(arg1, arg2) + +
    + Signature: (ILType * ILMethodSpec) -> ILInstr
    +
    +     		+ +
    + + mkNormalCallvirt(arg1) + +
    + Signature: ILMethodSpec -> ILInstr
    +
    +     		+ +
    + + mkNormalLdfld(arg1) + +
    + Signature: ILFieldSpec -> ILInstr
    +
    +     		+ +
    + + mkNormalLdflda(arg1) + +
    + Signature: ILFieldSpec -> ILInstr
    +
    +     		+ +
    + + mkNormalLdobj(arg1) + +
    + Signature: ILType -> ILInstr
    +
    +     		+ +
    + + mkNormalLdsfld(arg1) + +
    + Signature: ILFieldSpec -> ILInstr
    +
    +     		+ +
    + + mkNormalNewobj(arg1) + +
    + Signature: ILMethodSpec -> ILInstr
    +
    +     		+ +
    + + mkNormalStfld(arg1) + +
    + Signature: ILFieldSpec -> ILInstr
    +
    +     		+ +
    + + mkNormalStobj(arg1) + +
    + Signature: ILType -> ILInstr
    +
    +     		+ +
    + + mkNormalStsfld(arg1) + +
    + Signature: ILFieldSpec -> ILInstr
    +
    +     		+ +
    + + mkPermissionSet arg1 (arg2, arg3) + +
    + Signature: ILGlobals -> (ILSecurityAction * (ILTypeRef * (string * ILType * ILAttribElem) list) list) -> ILSecurityDecl
    +
    +     		+ +
    + + mkRawDataValueTypeDef(...) + +
    + Signature: ILType -> (string * size:int32 * pack:uint16) -> ILTypeDef
    +
    +     		+

    Make a type definition for a value type used to point to raw data. +These are useful when generating array initialization code +according to the +ldtoken field valuetype ''/'\[struct0x6000127-1' '<PrivateImplementationDetails>'::'\]method0x6000127-1' +call void System.Runtime.CompilerServices.RuntimeHelpers::InitializeArray(class System.Array,valuetype System.RuntimeFieldHandle) +idiom.

    + + +
    + + mkRefForILField arg1 (arg2, arg3) arg4 + +
    + Signature: ILScopeRef -> (ILTypeDef list * ILTypeDef) -> ILFieldDef -> ILFieldRef
    +
    +     		+ +
    + + mkRefForILMethod arg1 (arg2, arg3) arg4 + +
    + Signature: ILScopeRef -> (ILTypeDef list * ILTypeDef) -> ILMethodDef -> ILMethodRef
    +
    +     		+ +
    + + mkRefForNestedILTypeDef(...) + +
    + Signature: ILScopeRef -> (ILTypeDef list * ILTypeDef) -> ILTypeRef
    +
    +     		+

    Generate references to existing type definitions, method definitions +etc. Useful for generating references, e.g. to a class we're processing +Also used to reference type definitions that we've generated. ILScopeRef +is normally ILScopeRef.Local, unless we've generated the ILTypeDef in +an auxiliary module or are generating multiple assemblies at +once.

    + + +
    + + mkRefToILAssembly(arg1) + +
    + Signature: ILAssemblyManifest -> ILAssemblyRef
    +
    +     		+ +
    + + mkRefToILField(arg1, arg2) + +
    + Signature: (ILTypeRef * ILFieldDef) -> ILFieldRef
    +
    +     		+ +
    + + mkRefToILMethod(arg1, arg2) + +
    + Signature: (ILTypeRef * ILMethodDef) -> ILMethodRef
    +
    +     		+ +
    + + mkRefToILModule(arg1) + +
    + Signature: ILModuleDef -> ILModuleRef
    +
    +     		+ +
    + + mkSimpleAssemblyRef(arg1) + +
    + Signature: string -> ILAssemblyRef
    +
    +     		+

    Generate simple references to assemblies and modules.

    + + +
    + + mkSimpleModRef(arg1) + +
    + Signature: string -> ILModuleRef
    +
    +     		+ +
    + + mkStloc(arg1) + +
    + Signature: uint16 -> ILInstr
    +
    +     		+ +
    + + mkTypeForwarder arg1 arg2 arg3 arg4 arg5 + +
    + Signature: ILScopeRef -> string -> ILNestedExportedTypes -> ILAttributes -> ILTypeDefAccess -> ILExportedTypeOrForwarder
    +
    +     		+ +
    + + NoMetadataIdx + +
    + Signature: int32
    +
    +     		+ +
    + + nonBranchingInstrsToCode(arg1) + +
    + Signature: ILInstr list -> ILCode
    +
    +     		+

    Make some code that is a straight line sequence of instructions. +The function will add a "return" if the last instruction is not an exiting instruction.

    + + +
    + + parseILVersion(arg1) + +
    + Signature: string -> ILVersionInfo
    +
    +     		+

    Get a version number from a CLR version string, e.g. 1.0.3705.0

    + + +
    + + prependInstrsToClassCtor arg1 arg2 arg3 + +
    + Signature: ILInstr list -> ILSourceMarker option -> ILTypeDef -> ILTypeDef
    +
    +     		+

    Injecting initialization code into a class. +Add some code to the end of the .cctor for a type. Create a .cctor +if one doesn't exist already.

    + + +
    + + prependInstrsToCode arg1 arg2 + +
    + Signature: ILInstr list -> ILCode -> ILCode
    +
    +     		+

    Injecting code into existing code blocks. A branch will +be added from the given instructions to the (unique) entry of +the code, and the first instruction will be the new entry +of the method. The instructions should be non-branching.

    + + +
    + + prependInstrsToMethod arg1 arg2 + +
    + Signature: ILInstr list -> ILMethodDef -> ILMethodDef
    +
    +     		+ +
    + + rescopeILFieldRef arg1 arg2 + +
    + Signature: ILScopeRef -> ILFieldRef -> ILFieldRef
    +
    +     		+

    Rescoping. The first argument tells the function how to reference the original scope from +the new scope.

    + + +
    + + rescopeILMethodRef arg1 arg2 + +
    + Signature: ILScopeRef -> ILMethodRef -> ILMethodRef
    +
    +     		+

    Rescoping. The first argument tells the function how to reference the original scope from +the new scope.

    + + +
    + + rescopeILScopeRef arg1 arg2 + +
    + Signature: ILScopeRef -> ILScopeRef -> ILScopeRef
    +
    +     		+

    Rescoping. The first argument tells the function how to reference the original scope from +the new scope.

    + + +
    + + rescopeILType arg1 arg2 + +
    + Signature: ILScopeRef -> ILType -> ILType
    +
    +     		+

    Rescoping. The first argument tells the function how to reference the original scope from +the new scope.

    + + +
    + + rescopeILTypeSpec arg1 arg2 + +
    + Signature: ILScopeRef -> ILTypeSpec -> ILTypeSpec
    +
    +     		+

    Rescoping. The first argument tells the function how to reference the original scope from +the new scope.

    + + +
    + + resolveILMethodRef arg1 arg2 + +
    + Signature: ILTypeDef -> ILMethodRef -> ILMethodDef
    +
    +     		+

    Find the method definition corresponding to the given property or +event operation. These are always in the same class as the property +or event. This is useful especially if your code is not using the Ilbind +API to bind references.

    + + +
    + + resolveILMethodRefWithRescope(...) + +
    + Signature: (ILType -> ILType) -> ILTypeDef -> ILMethodRef -> ILMethodDef
    +
    +     		+ +
    + + sha1HashBytes(arg1) + +
    + Signature: byte [] -> byte []
    +
    +     		+

    Get a public key token from a public key.

    + + +
    + + sha1HashInt64(arg1) + +
    + Signature: byte [] -> int64
    +
    +     		+ +
    + + splitILTypeName(arg1) + +
    + Signature: string -> string list * string
    +
    +     		+

    The splitILTypeName utility helps you split a string representing +a type name into the leading namespace elements (if any), the +names of any nested types and the type name itself. This function +memoizes and interns the splitting of the namespace portion of +the type name.

    + + +
    + + splitILTypeNameWithPossibleStaticArguments(...) + +
    + Signature: string -> string [] * string
    +
    +     		+ +
    + + splitNamespace(arg1) + +
    + Signature: string -> string list
    +
    +     		+ +
    + + splitNamespaceToArray(arg1) + +
    + Signature: string -> string []
    +
    +     		+ +
    + + splitTypeNameRight(arg1) + +
    + Signature: string -> string option * string
    +
    +     		+ splitTypeNameRight is like splitILTypeName except the + namespace is kept as a whole string, rather than split at dots. + +
    + + storeILCustomAttrs(arg1) + +
    + Signature: ILAttributes -> ILAttributesStored
    +
    +     		+ +
    + + storeILSecurityDecls(arg1) + +
    + Signature: ILSecurityDecls -> ILSecurityDeclsStored
    +
    +     		+ +
    + + typeNameForGlobalFunctions + +
    + Signature: string
    +
    +     		+ +
    + + typesOfILParams(arg1) + +
    + Signature: ILParameters -> ILType list
    +
    +     		+ +
    + + unscopeILType(arg1) + +
    + Signature: ILType -> ILType
    +
    +     		+

    Unscoping. Clears every scope information, use for looking up IL method references only.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilmodulereader.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilmodulereader.html new file mode 100644 index 0000000000..59a35e882c --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilmodulereader.html @@ -0,0 +1,135 @@ + + + + + ILModuleReader - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILModuleReader

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: ILBinaryReader
    +

    +
    +

    Represents a reader of the metadata of a .NET binary. May also give some values (e.g. IL code) from the PE file +if it was provided.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.ILAssemblyRefs + +
    + Signature: ILAssemblyRef list
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_ILAssemblyRefs

    +
    + + x.ILModuleDef + +
    + Signature: ILModuleDef
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_ILModuleDef

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadermetadatasnapshot.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadermetadatasnapshot.html new file mode 100644 index 0000000000..771f3bcbac --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadermetadatasnapshot.html @@ -0,0 +1,143 @@ + + + + + ILReaderMetadataSnapshot - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILReaderMetadataSnapshot

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: ILBinaryReader
    +

    +
    +

    Used to implement a Binary file over native memory, used by Roslyn integration

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: obj
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: nativeint
    +
    +     		+ +
    + + x.Item3 + +
    + Signature: int
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreaderoptions.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreaderoptions.html new file mode 100644 index 0000000000..a425732676 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreaderoptions.html @@ -0,0 +1,163 @@ + + + + + ILReaderOptions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILReaderOptions

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: ILBinaryReader
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + metadataOnly + +
    + Signature: MetadataOnlyFlag
    +
    +     		+

    Only open a metadata reader for the metadata portion of the .NET binary without keeping alive any data associated with the PE reader +- IL code will not be available (mdBody in ILMethodDef will return NotAvailable) +- Managed resources will be reported back as ILResourceLocation.LocalIn (as always) +- Native resources will not be available (none will be returned) +- Static data associated with fields will not be available

    + + +
    + + pdbDirPath + +
    + Signature: string option
    +
    +     		+ +
    + + reduceMemoryUsage + +
    + Signature: ReduceMemoryFlag
    +
    +     		+ +
    + + tryGetMetadataSnapshot + +
    + Signature: ILReaderTryGetMetadataSnapshot
    +
    +     		+

    A function to call to try to get an object that acts as a snapshot of the metadata section of a .NET binary, +and from which we can read the metadata. Only used when metadataOnly=true.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadertrygetmetadatasnapshot.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadertrygetmetadatasnapshot.html new file mode 100644 index 0000000000..d05d654216 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-ilreadertrygetmetadatasnapshot.html @@ -0,0 +1,94 @@ + + + + + ILReaderTryGetMetadataSnapshot - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILReaderTryGetMetadataSnapshot

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: ILBinaryReader
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-metadataonlyflag.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-metadataonlyflag.html new file mode 100644 index 0000000000..d775463201 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-metadataonlyflag.html @@ -0,0 +1,133 @@ + + + + + MetadataOnlyFlag - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MetadataOnlyFlag

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: ILBinaryReader
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + No + +
    + Signature:
    +
    +     		+ +
    + + Yes + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-reducememoryflag.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-reducememoryflag.html new file mode 100644 index 0000000000..a681ae4a99 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-reducememoryflag.html @@ -0,0 +1,133 @@ + + + + + ReduceMemoryFlag - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ReduceMemoryFlag

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: ILBinaryReader
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + No + +
    + Signature:
    +
    +     		+ +
    + + Yes + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-defaultassemblyreader.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-defaultassemblyreader.html new file mode 100644 index 0000000000..25c3f46f56 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-defaultassemblyreader.html @@ -0,0 +1,99 @@ + + + + + DefaultAssemblyReader - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    DefaultAssemblyReader

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: Shim
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-iassemblyreader.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-iassemblyreader.html new file mode 100644 index 0000000000..4e94af35fa --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim-iassemblyreader.html @@ -0,0 +1,116 @@ + + + + + IAssemblyReader - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    IAssemblyReader

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: Shim
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.GetILModuleReader(...) + +
    + Signature: (filename:string * readerOptions:ILReaderOptions) -> ILModuleReader
    + Modifiers: abstract
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim.html new file mode 100644 index 0000000000..83b214c1e2 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-shim.html @@ -0,0 +1,149 @@ + + + + + Shim - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Shim

    +

    + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: ILBinaryReader + + Attributes:
    +[<AutoOpen>]
    + +     +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + +
    TypeDescription
    + DefaultAssemblyReader + + +
    + IAssemblyReader + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + AssemblyReader + +
    + Signature: IAssemblyReader
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-statistics.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-statistics.html new file mode 100644 index 0000000000..2ee23ea72a --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader-statistics.html @@ -0,0 +1,172 @@ + + + + + Statistics - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Statistics

    +

    + + Namespace: FSharp.Compiler.AbstractIL
    + Parent Module: ILBinaryReader
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + byteFileCount + +
    + Signature: int
    + Modifiers: mutable
    +
    +     		+ +
    + + memoryMapFileClosedCount + +
    + Signature: int
    + Modifiers: mutable
    +
    +     		+ +
    + + memoryMapFileOpenedCount + +
    + Signature: int
    + Modifiers: mutable
    +
    +     		+ +
    + + rawMemoryFileCount + +
    + Signature: int
    + Modifiers: mutable
    +
    +     		+ +
    + + weakByteFileCount + +
    + Signature: int
    + Modifiers: mutable
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-ilbinaryreader.html b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader.html new file mode 100644 index 0000000000..0020ff2089 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-ilbinaryreader.html @@ -0,0 +1,229 @@ + + + + + ILBinaryReader - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ILBinaryReader

    +

    + Namespace: FSharp.Compiler.AbstractIL
    +

    +
    +

    Binary reader. Read a .NET binary and concert it to Abstract IL data +structures.

    +

    NOTE: +- The metadata in the loaded modules will be relative to +those modules, e.g. ILScopeRef.Local will mean "local to +that module". You must use [rescopeILType] etc. if you want to include +(i.e. copy) the metadata into your own module.

    +
      +
    • +

      PDB (debug info) reading/folding: +The PDB reader is invoked if you give a PDB path +This indicates if you want to search for PDB files and have the +reader fold them in. You cannot currently name the pdb file +directly - you can only name the path. Giving "None" says +"do not read the PDB file even if one exists".

      +

      The debug info appears primarily as I_seqpoint annotations in +the instruction streams. Unfortunately the PDB information does +not, for example, tell you how to map back from a class definition +to a source code line number - you will need to explicitly search +for a sequence point in the code for one of the methods of the +class. That is not particularly satisfactory, and it may be +a good idea to build a small library which extracts the information +you need.

      +
      • +
    + +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + ILModuleReader + +

    Represents a reader of the metadata of a .NET binary. May also give some values (e.g. IL code) from the PE file +if it was provided.

    + + +
    + ILReaderMetadataSnapshot + +

    Used to implement a Binary file over native memory, used by Roslyn integration

    + + +
    + ILReaderOptions + + +
    + ILReaderTryGetMetadataSnapshot + + +
    + MetadataOnlyFlag + + +
    + ReduceMemoryFlag + + +
    + Statistics + + +
    + + + + + + + + + + +
    ModuleDescription
    + Shim + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + GetStatistics() + +
    + Signature: unit -> Statistics
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-anycallerthreadtoken.html b/docs/reference/fsharp-compiler-abstractil-internal-library-anycallerthreadtoken.html new file mode 100644 index 0000000000..488a247a9b --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-anycallerthreadtoken.html @@ -0,0 +1,118 @@ + + + + + AnyCallerThreadToken - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    AnyCallerThreadToken

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    Represents a token that indicates execution on a any of several potential user threads calling the F# compiler services.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> AnyCallerThreadToken
    +
    +     		+ +

    CompiledName: .ctor

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-array.html b/docs/reference/fsharp-compiler-abstractil-internal-library-array.html new file mode 100644 index 0000000000..53f5fb5311 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-array.html @@ -0,0 +1,306 @@ + + + + + Array - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Array

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + areEqual xs ys + +
    + Signature: xs:'T [] -> ys:'T [] -> bool
    + Type parameters: 'T
    +     		+

    Optimized arrays equality. ~100x faster than array1 = array2 on strings. +~2x faster for floats +~0.8x slower for ints

    + + +
    + + endsWith suffix whole + +
    + Signature: suffix:'a [] -> whole:'a [] -> bool
    + Type parameters: 'a
    +     		+

    Returns true if one array has trailing elements equal to another's.

    + + +
    + + existsOne p l + +
    + Signature: p:('a -> bool) -> l:'a [] -> bool
    + Type parameters: 'a
    +     		+ +
    + + existsTrue(arr) + +
    + Signature: arr:bool [] -> bool
    +
    +     		+ +
    + + findFirstIndexWhereTrue arr p + +
    + Signature: arr:'a [] -> p:('a -> bool) -> int
    + Type parameters: 'a
    +     		+ +
    + + heads(array) + +
    + Signature: array:'T [] -> 'T [] []
    + Type parameters: 'T
    +     		+

    Returns all heads of a given array. +For [|1;2;3|] it returns [|[|1; 2; 3|]; [|1; 2|]; [|1|]|]

    + + +
    + + isSubArray subArray wholeArray index + +
    + Signature: subArray:'T [] -> wholeArray:'T [] -> index:int -> bool
    + Type parameters: 'T
    +     		+

    check if subArray is found in the wholeArray starting +at the provided index

    + + +
    + + lengthsEqAndForall2 p l1 l2 + +
    + Signature: p:('c -> 'd -> bool) -> l1:'c [] -> l2:'d [] -> bool
    + Type parameters: 'c, 'd
    +     		+ +
    + + mapAsync mapping array + +
    + Signature: mapping:('T -> Async<'U>) -> array:'T [] -> Async<'U []>
    + Type parameters: 'T, 'U
    +     		+

    Async implementation of Array.map.

    + + +
    + + mapq f inp + +
    + Signature: f:('?690760 -> '?690760) -> inp:'?690760 [] -> '?690760 []
    + Type parameters: '?690760
    +     		+ +
    + + order(eltOrder) + +
    + Signature: eltOrder:IComparer<'T> -> IComparer<'T array>
    + Type parameters: 'T
    +     		+ +
    + + replace index value array + +
    + Signature: index:int -> value:'a -> array:'a [] -> 'a []
    + Type parameters: 'a
    +     		+

    Returns a new array with an element replaced with a given value.

    + + +
    + + revInPlace(array) + +
    + Signature: array:'T [] -> unit
    + Type parameters: 'T
    +     		+

    pass an array byref to reverse it in place

    + + +
    + + startsWith prefix whole + +
    + Signature: prefix:'a [] -> whole:'a [] -> bool
    + Type parameters: 'a
    +     		+

    Returns true if one array has another as its subset from index 0.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-cancellable-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-cancellable-1.html new file mode 100644 index 0000000000..b7c5143298 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-cancellable-1.html @@ -0,0 +1,119 @@ + + + + + Cancellable<'TResult> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Cancellable<'TResult>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    Represents a cancellable computation with explicit representation of a cancelled result.

    +

    A cancellable computation is passed may be cancelled via a CancellationToken, which is propagated implicitly.
    +If cancellation occurs, it is propagated as data rather than by raising an OperationCanceledException.

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + Cancellable(...) + +
    + Signature: CancellationToken -> ValueOrCancelled<'TResult>
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablebuilder.html b/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablebuilder.html new file mode 100644 index 0000000000..19b488670e --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablebuilder.html @@ -0,0 +1,241 @@ + + + + + CancellableBuilder - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CancellableBuilder

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> CancellableBuilder
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Bind(e, k) + +
    + Signature: (e:Cancellable<'a> * k:('a -> Cancellable<'b>)) -> Cancellable<'b>
    + Type parameters: 'a, 'b
    +     		+ +
    + + x.Combine(e1, e2) + +
    + Signature: (e1:Cancellable<unit> * e2:Cancellable<'a>) -> Cancellable<'a>
    + Type parameters: 'a
    +     		+ +
    + + x.Delay(f) + +
    + Signature: (f:(unit -> Cancellable<'a>)) -> Cancellable<'a>
    + Type parameters: 'a
    +     		+ +
    + + x.Return(v) + +
    + Signature: v:'a -> Cancellable<'a>
    + Type parameters: 'a
    +     		+ +
    + + x.ReturnFrom(v) + +
    + Signature: v:'a -> 'a
    + Type parameters: 'a
    +     		+ +
    + + x.TryFinally(e, compensation) + +
    + Signature: (e:Cancellable<'?690633> * compensation:(unit -> unit)) -> Cancellable<'?690633>
    + Type parameters: '?690633
    +     		+ +
    + + x.TryWith(e, handler) + +
    + Signature: (e:Cancellable<'a> * handler:(exn -> Cancellable<'a>)) -> Cancellable<'a>
    + Type parameters: 'a
    +     		+ +
    + + x.Using(resource, e) + +
    + Signature: (resource:'a * e:('a -> Cancellable<'b>)) -> Cancellable<'b>
    + Type parameters: 'a, 'b
    +     		+ +
    + + x.Zero() + +
    + Signature: unit -> Cancellable<unit>
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablemodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablemodule.html new file mode 100644 index 0000000000..c5cff60079 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-cancellablemodule.html @@ -0,0 +1,290 @@ + + + + + Cancellable - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Cancellable

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library + + Attributes:
    +[<CompilationRepresentation(4)>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + bind f comp1 + +
    + Signature: f:('?690987 -> Cancellable<'?690988>) -> comp1:Cancellable<'?690987> -> Cancellable<'?690988>
    + Type parameters: '?690987, '?690988
    +     		+

    Bind the result of a cancellable computation

    + + +
    + + canceled() + +
    + Signature: unit -> Cancellable<'a>
    + Type parameters: 'a
    +     		+

    Represents a canceled computation

    + + +
    + + delay(f) + +
    + Signature: f:(unit -> Cancellable<'T>) -> Cancellable<'T>
    + Type parameters: 'T
    +     		+

    Delay a cancellable computation

    + + +
    + + each f seq + +
    + Signature: f:('a -> Cancellable<'b>) -> seq:seq<'a> -> Cancellable<'b list>
    + Type parameters: 'a, 'b
    +     		+

    Iterate a cancellable computation over a collection

    + + +
    + + fold f acc seq + +
    + Signature: f:('a -> 'b -> Cancellable<'a>) -> acc:'a -> seq:seq<'b> -> Cancellable<'a>
    + Type parameters: 'a, 'b
    +     		+

    Fold a cancellable computation along a sequence of inputs

    + + +
    + + map f oper + +
    + Signature: f:('?690990 -> '?690991) -> oper:Cancellable<'?690990> -> Cancellable<'?690991>
    + Type parameters: '?690990, '?690991
    +     		+

    Map the result of a cancellable computation

    + + +
    + + ret(x) + +
    + Signature: x:'?690993 -> Cancellable<'?690993>
    + Type parameters: '?690993
    +     		+

    Return a simple value as the result of a cancellable computation

    + + +
    + + run ct arg2 + +
    + Signature: ct:CancellationToken -> Cancellable<'a> -> ValueOrCancelled<'a>
    + Type parameters: 'a
    +     		+

    Run a cancellable computation using the given cancellation token

    + + +
    + + runWithoutCancellation(comp) + +
    + Signature: comp:Cancellable<'a> -> 'a
    + Type parameters: 'a
    +     		+

    Run the computation in a mode where it may not be cancelled. The computation never results in a +ValueOrCancelled.Cancelled.

    + + +
    + + token() + +
    + Signature: unit -> Cancellable<CancellationToken>
    +
    +     		+

    Bind the cancellation token associated with the computation

    + + +
    + + tryFinally e compensation + +
    + Signature: e:Cancellable<'?691010> -> compensation:(unit -> unit) -> Cancellable<'?691010>
    + Type parameters: '?691010
    +     		+

    Implement try/finally for a cancellable computation

    + + +
    + + tryWith e handler + +
    + Signature: e:Cancellable<'?691012> -> handler:(exn -> Cancellable<'?691012>) -> Cancellable<'?691012>
    + Type parameters: '?691012
    +     		+

    Implement try/with for a cancellable computation

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-compilationthreadtoken.html b/docs/reference/fsharp-compiler-abstractil-internal-library-compilationthreadtoken.html new file mode 100644 index 0000000000..eb069b762b --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-compilationthreadtoken.html @@ -0,0 +1,123 @@ + + + + + CompilationThreadToken - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CompilationThreadToken

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    Represents a token that indicates execution on the compilation thread, i.e. +- we have full access to the (partially mutable) TAST and TcImports data structures +- compiler execution may result in type provider invocations when resolving types and members +- we can access various caches in the SourceCodeServices

    +

    Like other execution tokens this should be passed via argument passing and not captured/stored beyond +the lifetime of stack-based calls. This is not checked, it is a discipline within the compiler code.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> CompilationThreadToken
    +
    +     		+ +

    CompiledName: .ctor

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-dictionary.html b/docs/reference/fsharp-compiler-abstractil-internal-library-dictionary.html new file mode 100644 index 0000000000..b9afdbf8f3 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-dictionary.html @@ -0,0 +1,117 @@ + + + + + Dictionary - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Dictionary

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + newWithSize(size) + +
    + Signature: size:int -> Dictionary<'a,'b>
    + Type parameters: 'a, 'b
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-dictionaryextensions.html b/docs/reference/fsharp-compiler-abstractil-internal-library-dictionaryextensions.html new file mode 100644 index 0000000000..e27a94598b --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-dictionaryextensions.html @@ -0,0 +1,163 @@ + + + + + DictionaryExtensions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    DictionaryExtensions

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    + + Attributes:
    +[<Extension>]
    + +     +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> DictionaryExtensions
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Static members

    + + + + + + + + + + + + + + +
    Static memberDescription
    + + DictionaryExtensions.BagAdd(...) + +
    + Signature: (dic:Dictionary<'key,'value list> * key:'key * value:'value) -> unit
    + Type parameters: 'key, 'value + Attributes:
    +[<Extension>]
    +     +
    +     		+ +
    + + DictionaryExtensions.BagExistsValueForKey(...) + +
    + Signature: (dic:Dictionary<'key,'value list> * key:'key * f:('value -> bool)) -> bool
    + Type parameters: 'key, 'value + Attributes:
    +[<Extension>]
    +     +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-eventually-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-eventually-1.html new file mode 100644 index 0000000000..8314a409a4 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-eventually-1.html @@ -0,0 +1,145 @@ + + + + + Eventually<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Eventually<'T>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    Computations that can cooperatively yield by returning a continuation

    +
      +
    • +

      Any yield of a NotYetDone should typically be "abandonable" without adverse consequences. No resource release +will be called when the computation is abandoned.

      +
      • +
    • +

      Computations suspend via a NotYetDone may use local state (mutables), where these are +captured by the NotYetDone closure. Computations do not need to be restartable.

      +
      • +
    • +

      The key thing is that you can take an Eventually value and run it with +Eventually.repeatedlyProgressUntilDoneOrTimeShareOverOrCanceled

      +
      • +
    • Cancellation results in a suspended computation rather than complete abandonment
      • +
    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Done('T) + +
    + Signature: 'T
    +
    +     		+ +
    + + NotYetDone(...) + +
    + Signature: CompilationThreadToken -> Eventually<'T>
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallybuilder.html b/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallybuilder.html new file mode 100644 index 0000000000..ff1940a6a8 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallybuilder.html @@ -0,0 +1,228 @@ + + + + + EventuallyBuilder - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    EventuallyBuilder

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> EventuallyBuilder
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Bind(e, k) + +
    + Signature: (e:Eventually<'a> * k:('a -> Eventually<'b>)) -> Eventually<'b>
    + Type parameters: 'a, 'b
    +     		+ +
    + + x.Combine(e1, e2) + +
    + Signature: (e1:Eventually<unit> * e2:Eventually<'a>) -> Eventually<'a>
    + Type parameters: 'a
    +     		+ +
    + + x.Delay(f) + +
    + Signature: (f:(unit -> Eventually<'a>)) -> Eventually<'a>
    + Type parameters: 'a
    +     		+ +
    + + x.Return(v) + +
    + Signature: v:'a -> Eventually<'a>
    + Type parameters: 'a
    +     		+ +
    + + x.ReturnFrom(v) + +
    + Signature: v:'a -> 'a
    + Type parameters: 'a
    +     		+ +
    + + x.TryFinally(e, compensation) + +
    + Signature: (e:Eventually<'?690651> * compensation:(unit -> unit)) -> Eventually<'?690651>
    + Type parameters: '?690651
    +     		+ +
    + + x.TryWith(e, handler) + +
    + Signature: (e:Eventually<'a> * handler:(Exception -> Eventually<'a>)) -> Eventually<'a>
    + Type parameters: 'a
    +     		+ +
    + + x.Zero() + +
    + Signature: unit -> Eventually<unit>
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallymodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallymodule.html new file mode 100644 index 0000000000..71fefa31d0 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-eventuallymodule.html @@ -0,0 +1,272 @@ + + + + + Eventually - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Eventually

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library + + Attributes:
    +[<CompilationRepresentation(4)>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + bind k e + +
    + Signature: k:('?691039 -> Eventually<'?691040>) -> e:Eventually<'?691039> -> Eventually<'?691040>
    + Type parameters: '?691039, '?691040
    +     		+ +
    + + box(e) + +
    + Signature: e:Eventually<'c> -> Eventually<obj>
    + Type parameters: 'c
    +     		+ +
    + + catch(e) + +
    + Signature: e:Eventually<'?691045> -> Eventually<ResultOrException<'?691045>>
    + Type parameters: '?691045
    +     		+ +
    + + delay(f) + +
    + Signature: f:(unit -> Eventually<'T>) -> Eventually<'T>
    + Type parameters: 'T
    +     		+ +
    + + fold f acc seq + +
    + Signature: f:('a -> 'b -> Eventually<'a>) -> acc:'a -> seq:seq<'b> -> Eventually<'a>
    + Type parameters: 'a, 'b
    +     		+ +
    + + force ctok e + +
    + Signature: ctok:CompilationThreadToken -> e:Eventually<'a> -> 'a
    + Type parameters: 'a
    +     		+ +
    + + forceAsync runner e + +
    + Signature: runner:((CompilationThreadToken -> Eventually<'T>) -> Async<Eventually<'T>>) -> e:Eventually<'T> -> Async<'T option>
    + Type parameters: 'T
    +     		+

    Keep running the asynchronous computation bit by bit. The runner gets called each time the computation is restarted. +Can be cancelled as an Async in the normal way.

    + + +
    + + forceWhile ctok check e + +
    + Signature: ctok:CompilationThreadToken -> check:(unit -> bool) -> e:Eventually<'?691030> -> '?691030 option
    + Type parameters: '?691030
    +     		+ +
    + + repeatedlyProgressUntilDoneOrTimeShareOverOrCanceled(...) + +
    + Signature: timeShareInMilliseconds:int64 -> ct:CancellationToken -> runner:(CompilationThreadToken -> ('b -> Eventually<'c>) -> Eventually<'c>) -> e:Eventually<'c> -> Eventually<'c>
    + Type parameters: 'b, 'c
    +     		+

    Keep running the computation bit by bit until a time limit is reached. +The runner gets called each time the computation is restarted

    +

    If cancellation happens, the operation is left half-complete, ready to resume.

    + + +
    + + token + +
    + Signature: Eventually<CompilationThreadToken>
    +
    +     		+ +
    + + tryFinally e compensation + +
    + Signature: e:Eventually<'?691049> -> compensation:(unit -> unit) -> Eventually<'?691049>
    + Type parameters: '?691049
    +     		+ +
    + + tryWith e handler + +
    + Signature: e:Eventually<'?691051> -> handler:(Exception -> Eventually<'?691051>) -> Eventually<'?691051>
    + Type parameters: '?691051
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-executiontoken.html b/docs/reference/fsharp-compiler-abstractil-internal-library-executiontoken.html new file mode 100644 index 0000000000..236dddc5f7 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-executiontoken.html @@ -0,0 +1,96 @@ + + + + + ExecutionToken - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ExecutionToken

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    Represents a permission active at this point in execution

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-inlinedelayinit-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-inlinedelayinit-1.html new file mode 100644 index 0000000000..54e10aaab8 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-inlinedelayinit-1.html @@ -0,0 +1,181 @@ + + + + + InlineDelayInit<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    InlineDelayInit<'T>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    + + Attributes:
    +[<Struct>]
    + +     +

    +
    +

    An efficient lazy for inline storage in a class type. Results in fewer thunks.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + func + +
    + Signature: Func<'T>
    + Modifiers: mutable
    +
    +     		+ +
    + + store + +
    + Signature: 'T
    + Modifiers: mutable
    +
    +     		+ +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(f) + +
    + Signature: (f:(unit -> 'T)) -> InlineDelayInit<'T>
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Value + +
    + Signature: 'T
    +
    +     		+ +

    CompiledName: get_Value

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer-1.html new file mode 100644 index 0000000000..34663b6de5 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer-1.html @@ -0,0 +1,120 @@ + + + + + IPartialEqualityComparer<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    IPartialEqualityComparer<'T>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    Interface that defines methods for comparing objects using partial equality relation

    + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.InEqualityRelation(arg1) + +
    + Signature: 'T -> bool
    + Modifiers: abstract
    +
    +     		+

    Can the specified object be tested for equality?

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer.html b/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer.html new file mode 100644 index 0000000000..09571eb36a --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-ipartialequalitycomparer.html @@ -0,0 +1,130 @@ + + + + + IPartialEqualityComparer - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    IPartialEqualityComparer

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + +
    Function or valueDescription
    + + On f c + +
    + Signature: f:('a -> 'b) -> c:IPartialEqualityComparer<'b> -> IPartialEqualityComparer<'a>
    + Type parameters: 'a, 'b
    +     		+ +
    + + partialDistinctBy per seq + +
    + Signature: per:IPartialEqualityComparer<'T> -> seq:'T list -> 'T list
    + Type parameters: 'T
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmap-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmap-2.html new file mode 100644 index 0000000000..94c996e13f --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmap-2.html @@ -0,0 +1,144 @@ + + + + + LayeredMap<'Key, 'Value> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LayeredMap<'Key, 'Value>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Count + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Count

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [key] + +
    + Signature: key:'Key -> 'Value
    +
    +     		+ +

    CompiledName: get_Item

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmultimap-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmultimap-2.html new file mode 100644 index 0000000000..d88e4ca06e --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-layeredmultimap-2.html @@ -0,0 +1,246 @@ + + + + + LayeredMultiMap<'Key, 'Value> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LayeredMultiMap<'Key, 'Value>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Immutable map collection, with explicit flattening to a backing dictionary

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(contents) + +
    + Signature: (contents:LayeredMap<'Key,'Value list>) -> LayeredMultiMap<'Key,'Value>
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Add(k, v) + +
    + Signature: (k:'Key * v:'Value) -> LayeredMultiMap<'Key,'Value>
    +
    +     		+ +
    + + x.AddAndMarkAsCollapsible(kvs) + +
    + Signature: (kvs:KeyValuePair<'Key,'Value> []) -> LayeredMultiMap<'Key,'Value>
    +
    +     		+ +
    + + [k] + +
    + Signature: k:'Key -> 'Value list
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.MarkAsCollapsible() + +
    + Signature: unit -> LayeredMultiMap<'Key,'Value>
    +
    +     		+ +
    + + x.TryFind(k) + +
    + Signature: k:'Key -> 'Value list option
    +
    +     		+ +
    + + x.TryGetValue(k) + +
    + Signature: k:'Key -> bool * 'Value list
    +
    +     		+ +
    + + x.Values + +
    + Signature: 'Value list
    +
    +     		+ +

    CompiledName: get_Values

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + LayeredMultiMap.Empty + +
    + Signature: LayeredMultiMap<'Key,'Value>
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-lazy.html b/docs/reference/fsharp-compiler-abstractil-internal-library-lazy.html new file mode 100644 index 0000000000..e05eae7899 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-lazy.html @@ -0,0 +1,117 @@ + + + + + Lazy - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Lazy

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + force(x) + +
    + Signature: x:Lazy<'T> -> 'T
    + Type parameters: 'T
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontext-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontext-2.html new file mode 100644 index 0000000000..8cd92069ca --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontext-2.html @@ -0,0 +1,256 @@ + + + + + LazyWithContext<'T, 'ctxt> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LazyWithContext<'T, 'ctxt>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    + + Attributes:
    +[<DefaultAugmentation(false)>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Just like "Lazy" but EVERY forcer must provide an instance of "ctxt", e.g. to help track errors +on forcing back to at least one sensible user location

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + findOriginalException + +
    + Signature: exn -> exn
    +
    +     		+

    A helper to ensure we rethrow the "original" exception

    + + +
    + + funcOrException + +
    + Signature: obj
    + Modifiers: mutable
    +
    +     		+

    This field holds either the function to run or a LazyWithContextFailure object recording the exception raised +from running the function. It is null if the thunk has been evaluated successfully.

    + + +
    + + value + +
    + Signature: 'T
    + Modifiers: mutable
    +
    +     		+

    This field holds the result of a successful computation. It's initial value is Unchecked.defaultof

    + + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Force(ctxt) + +
    + Signature: ctxt:'ctxt -> 'T
    +
    +     		+ +
    + + x.IsDelayed + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsDelayed

    +
    + + x.IsForced + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsForced

    +
    + + x.UnsynchronizedForce(ctxt) + +
    + Signature: ctxt:'ctxt -> 'T
    +
    +     		+ +
    +

    Static members

    + + + + + + + + + + + + + + +
    Static memberDescription
    + + LazyWithContext.Create(...) + +
    + Signature: (f:('ctxt -> 'T) * findOriginalException:(exn -> exn)) -> LazyWithContext<'T,'ctxt>
    +
    +     		+ +
    + + LazyWithContext.NotLazy(x) + +
    + Signature: x:'T -> LazyWithContext<'T,'ctxt>
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontextfailure.html b/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontextfailure.html new file mode 100644 index 0000000000..8308fd0954 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-lazywithcontextfailure.html @@ -0,0 +1,160 @@ + + + + + LazyWithContextFailure - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LazyWithContextFailure

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(exn) + +
    + Signature: exn:exn -> LazyWithContextFailure
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Exception + +
    + Signature: exn
    +
    +     		+ +

    CompiledName: get_Exception

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + LazyWithContextFailure.Undefined + +
    + Signature: LazyWithContextFailure
    +
    +     		+ +

    CompiledName: get_Undefined

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-list-frontandback.html b/docs/reference/fsharp-compiler-abstractil-internal-library-list-frontandback.html new file mode 100644 index 0000000000..5998e5050d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-list-frontandback.html @@ -0,0 +1,118 @@ + + + + + FrontAndBack - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FrontAndBack

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: List +

    +
    +
    + + + +

    Active patterns

    + + + + + + + + + + +
    Active patternDescription
    + + ( |NonEmpty|Empty| )(l) + +
    + Signature: l:'?690894 list -> Choice<('?690894 list * '?690894),unit>
    + Type parameters: '?690894
    +     		+ +

    CompiledName: |NonEmpty|Empty|

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-list.html b/docs/reference/fsharp-compiler-abstractil-internal-library-list.html new file mode 100644 index 0000000000..fc70cbf61c --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-list.html @@ -0,0 +1,604 @@ + + + + + List - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    List

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + +
    ModuleDescription
    + FrontAndBack + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + assoc x l + +
    + Signature: x:'d -> l:('d * 'e) list -> 'e
    + Type parameters: 'd, 'e
    +     		+ +
    + + checkq l1 l2 + +
    + Signature: l1:'?690815 list -> l2:'?690815 list -> bool
    + Type parameters: '?690815
    +     		+ +
    + + collect2 f xs ys + +
    + Signature: f:('?690865 -> '?690866 -> '?690867 list) -> xs:'?690865 list -> ys:'?690866 list -> '?690867 list
    + Type parameters: '?690865, '?690866, '?690867
    +     		+ +
    + + collectFold f s l + +
    + Signature: f:('a -> 'b -> 'c list * 'a) -> s:'a -> l:'b list -> 'c list * 'a
    + Type parameters: 'a, 'b, 'c
    +     		+ +
    + + collectSquared f xss + +
    + Signature: f:('a2 -> 'a3 list) -> xss:'a2 list list -> 'a3 list
    + Type parameters: 'a2, 'a3
    +     		+ +
    + + count pred xs + +
    + Signature: pred:('b -> bool) -> xs:'b list -> int
    + Type parameters: 'b
    +     		+ +
    + + drop n l + +
    + Signature: n:int -> l:'a list -> 'a list
    + Type parameters: 'a
    +     		+ +
    + + existsi f xs + +
    + Signature: f:(int -> 'a2 -> bool) -> xs:'a2 list -> bool
    + Type parameters: 'a2
    +     		+ +
    + + existsSquared f xss + +
    + Signature: f:('a -> bool) -> xss:'a list list -> bool
    + Type parameters: 'a
    +     		+ +
    + + existsTrue(xs) + +
    + Signature: xs:bool list -> bool
    +
    +     		+ +
    + + findi n f l + +
    + Signature: n:int -> f:('?690807 -> bool) -> l:'?690807 list -> ('?690807 * int) option
    + Type parameters: '?690807
    +     		+ +
    + + forallSquared f xss + +
    + Signature: f:('?690883 -> bool) -> xss:'?690883 list list -> bool
    + Type parameters: '?690883
    +     		+ +
    + + frontAndBack(l) + +
    + Signature: l:'a list -> 'a list * 'a
    + Type parameters: 'a
    +     		+ +
    + + headAndTail(l) + +
    + Signature: l:'a list -> 'a * 'a list
    + Type parameters: 'a
    +     		+ +
    + + indexNotFound() + +
    + Signature: unit -> '?690844
    + Type parameters: '?690844
    +     		+ +
    + + iter3 f l1 l2 l3 + +
    + Signature: f:('?690835 -> '?690836 -> '?690837 -> unit) -> l1:'?690835 list -> l2:'?690836 list -> l3:'?690837 list -> unit
    + Type parameters: '?690835, '?690836, '?690837
    +     		+ +
    + + iterSquared f xss + +
    + Signature: f:('a -> unit) -> xss:'a list list -> unit
    + Type parameters: 'a
    +     		+ +
    + + lengthsEqAndForall2 p l1 l2 + +
    + Signature: p:('a -> 'b -> bool) -> l1:'a list -> l2:'b list -> bool
    + Type parameters: 'a, 'b
    +     		+ +
    + + mapFoldSquared f z xss + +
    + Signature: f:('a2 -> 'a3 -> 'a4 * 'a2) -> z:'a2 -> xss:'a3 list list -> 'a4 list list * 'a2
    + Type parameters: 'a2, 'a3, 'a4
    +     		+ +
    + + mapHeadTail fhead ftail _arg1 + +
    + Signature: fhead:('a -> 'b) -> ftail:('a -> 'b) -> _arg1:'a list -> 'b list
    + Type parameters: 'a, 'b
    +     		+ +
    + + mapiFoldSquared f z xss + +
    + Signature: f:('a2 -> int * int * 'a3 -> 'a4 * 'a2) -> z:'a2 -> xss:'a3 list list -> 'a4 list list * 'a2
    + Type parameters: 'a2, 'a3, 'a4
    +     		+ +
    + + mapiSquared f xss + +
    + Signature: f:(int -> int -> 'a -> 'b) -> xss:'a list list -> 'b list list
    + Type parameters: 'a, 'b
    +     		+ +
    + + mapNth n f xs + +
    + Signature: n:int -> f:('a -> 'a) -> xs:'a list -> 'a list
    + Type parameters: 'a
    +     		+ +
    + + mapq f inp + +
    + Signature: f:('T -> 'T) -> inp:'T list -> 'T list
    + Type parameters: 'T
    +     		+ +
    + + mapSquared f xss + +
    + Signature: f:('a -> 'b) -> xss:'a list list -> 'b list list
    + Type parameters: 'a, 'b
    +     		+ +
    + + memAssoc x l + +
    + Signature: x:'d -> l:('d * 'e) list -> bool
    + Type parameters: 'd, 'e
    +     		+ +
    + + memq x l + +
    + Signature: x:'c -> l:'c list -> bool
    + Type parameters: 'c
    +     		+ +
    + + order(eltOrder) + +
    + Signature: eltOrder:IComparer<'T> -> IComparer<'T list>
    + Type parameters: 'T
    +     		+ +
    + + range n m + +
    + Signature: n:int -> m:int -> int list
    +
    +     		+ +
    + + sortWithOrder c elements + +
    + Signature: c:IComparer<'T> -> elements:'T list -> 'T list
    + Type parameters: 'T
    +     		+ +
    + + splitAfter n l + +
    + Signature: n:int -> l:'a list -> 'a list * 'a list
    + Type parameters: 'a
    +     		+ +
    + + splitChoose select l + +
    + Signature: select:('b -> Choice<'c,'d>) -> l:'b list -> 'c list * 'd list
    + Type parameters: 'b, 'c, 'd
    +     		+ +
    + + takeUntil p l + +
    + Signature: p:('a -> bool) -> l:'a list -> 'a list * 'a list
    + Type parameters: 'a
    +     		+ +
    + + toArraySquared(xss) + +
    + Signature: xss:'a2 list list -> 'a2 [] []
    + Type parameters: 'a2
    +     		+ +
    + + tryRemove f inp + +
    + Signature: f:('b -> bool) -> inp:'b list -> ('b * 'b list) option
    + Type parameters: 'b
    +     		+ +
    + + unzip4(l) + +
    + Signature: l:('g * 'h * 'i * 'j) list -> 'g list * 'h list * 'i list * 'j list
    + Type parameters: 'g, 'h, 'i, 'j
    +     		+ +
    + + zip4 l1 l2 l3 l4 + +
    + Signature: l1:'a2 list -> l2:'a3 list -> l3:'a4 list -> l4:'a5 list -> ('a2 * 'a3 * 'a4 * 'a5) list
    + Type parameters: 'a2, 'a3, 'a4, 'a5
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-lock-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-lock-1.html new file mode 100644 index 0000000000..c2186b55d1 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-lock-1.html @@ -0,0 +1,139 @@ + + + + + Lock<'LockTokenType> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Lock<'LockTokenType>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    Encapsulates a lock associated with a particular token-type representing the acquisition of that lock.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> Lock<'LockTokenType>
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.AcquireLock(f) + +
    + Signature: (f:('LockTokenType -> 'a)) -> 'a
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-locktoken.html b/docs/reference/fsharp-compiler-abstractil-internal-library-locktoken.html new file mode 100644 index 0000000000..c6acb1a73f --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-locktoken.html @@ -0,0 +1,97 @@ + + + + + LockToken - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LockToken

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    A base type for various types of tokens that must be passed when a lock is taken. +Each different static lock should declare a new subtype of this type.

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-map.html b/docs/reference/fsharp-compiler-abstractil-internal-library-map.html new file mode 100644 index 0000000000..8af26bc645 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-map.html @@ -0,0 +1,117 @@ + + + + + Map - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Map

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + tryFindMulti k map + +
    + Signature: k:'a -> map:Map<'a,'b list> -> 'b list
    + Type parameters: 'a, 'b
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-memoizationtable-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-memoizationtable-2.html new file mode 100644 index 0000000000..e82de36246 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-memoizationtable-2.html @@ -0,0 +1,139 @@ + + + + + MemoizationTable<'T, 'U> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MemoizationTable<'T, 'U>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    memoize tables (all entries cached, never collected)

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(compute, keyComparer, canMemoize) + +
    + Signature: (compute:('T -> 'U) * keyComparer:IEqualityComparer<'T> * canMemoize:('T -> bool) option) -> MemoizationTable<'T,'U>
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Apply(x) + +
    + Signature: x:'T -> 'U
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-multimap-2.html b/docs/reference/fsharp-compiler-abstractil-internal-library-multimap-2.html new file mode 100644 index 0000000000..6dcbf945c6 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-multimap-2.html @@ -0,0 +1,144 @@ + + + + + MultiMap<'T, 'U> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MultiMap<'T, 'U>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Count + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Count

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [key] + +
    + Signature: key:'T -> 'U list
    +
    +     		+ +

    CompiledName: get_Item

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-multimapmodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-multimapmodule.html new file mode 100644 index 0000000000..ee734af911 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-multimapmodule.html @@ -0,0 +1,187 @@ + + + + + MultiMap - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MultiMap

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library + + Attributes:
    +[<CompilationRepresentation(4)>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + add v x m + +
    + Signature: v:'b -> x:'c -> m:MultiMap<'b,'c> -> Map<'b,'c list>
    + Type parameters: 'b, 'c
    +     		+ +
    + + empty + +
    + Signature: MultiMap<'b,'c>
    + Type parameters: 'b, 'c
    +     		+ +
    + + existsInRange f m + +
    + Signature: f:('?691233 -> bool) -> m:MultiMap<'?691234,'?691233> -> bool
    + Type parameters: '?691233, '?691234
    +     		+ +
    + + find v m + +
    + Signature: v:'b -> m:MultiMap<'b,'c> -> 'c list
    + Type parameters: 'b, 'c
    +     		+ +
    + + initBy f xs + +
    + Signature: f:('a -> 'b) -> xs:seq<'a> -> MultiMap<'b,'a>
    + Type parameters: 'a, 'b
    +     		+ +
    + + range(m) + +
    + Signature: m:MultiMap<'?691242,'?691243> -> '?691243 list
    + Type parameters: '?691242, '?691243
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-namemap-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-namemap-1.html new file mode 100644 index 0000000000..df35312554 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-namemap-1.html @@ -0,0 +1,144 @@ + + + + + NameMap<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NameMap<'T>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Count + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Count

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [key] + +
    + Signature: key:string -> 'T
    +
    +     		+ +

    CompiledName: get_Item

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-namemapmodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-namemapmodule.html new file mode 100644 index 0000000000..0ab1c8bb0a --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-namemapmodule.html @@ -0,0 +1,479 @@ + + + + + NameMap - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NameMap

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library + + Attributes:
    +[<CompilationRepresentation(4)>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + add v x m + +
    + Signature: v:string -> x:'T -> m:NameMap<'T> -> Map<string,'T>
    + Type parameters: 'T
    +     		+ +
    + + empty + +
    + Signature: Map<'b,'c>
    + Type parameters: 'b, 'c
    +     		+ +
    + + exists f m + +
    + Signature: f:('a -> 'b -> bool) -> m:Map<'a,'b> -> bool
    + Type parameters: 'a, 'b
    +     		+ +
    + + existsInRange p m + +
    + Signature: p:('?691203 -> bool) -> m:Map<'?691204,'?691203> -> bool
    + Type parameters: '?691203, '?691204
    +     		+ +
    + + filterRange f l + +
    + Signature: f:('T -> bool) -> l:NameMap<'T> -> Map<string,'T>
    + Type parameters: 'T
    +     		+ +
    + + find v m + +
    + Signature: v:string -> m:NameMap<'T> -> 'T
    + Type parameters: 'T
    +     		+ +
    + + foldBack f m z + +
    + Signature: f:(string -> 'T -> '?691139 -> '?691139) -> m:NameMap<'T> -> z:'?691139 -> '?691139
    + Type parameters: 'T, '?691139
    +     		+ +
    + + foldBackRange f l acc + +
    + Signature: f:('T -> 'a -> 'a) -> l:NameMap<'T> -> acc:'a -> 'a
    + Type parameters: 'T, 'a
    +     		+ +
    + + forall f m + +
    + Signature: f:('?691141 -> '?691142 -> bool) -> m:Map<'?691141,'?691142> -> bool
    + Type parameters: '?691141, '?691142
    +     		+ +
    + + isEmpty(m) + +
    + Signature: m:NameMap<'T> -> bool
    + Type parameters: 'T
    +     		+ +
    + + iter f l + +
    + Signature: f:('T -> unit) -> l:NameMap<'T> -> unit
    + Type parameters: 'T
    +     		+ +
    + + layer m1 m2 + +
    + Signature: m1:NameMap<'T> -> m2:Map<string,'T> -> Map<string,'T>
    + Type parameters: 'T
    +     		+ +
    + + layerAdditive addf m1 m2 + +
    + Signature: addf:('a list -> 'b -> 'a list) -> m1:Map<'c,'b> -> m2:Map<'c,'a list> -> Map<'c,'a list>
    + Type parameters: 'a, 'b, 'c
    +     		+

    Not a very useful function - only called in one place - should be changed

    + + +
    + + map f l + +
    + Signature: f:('T -> 'a) -> l:NameMap<'T> -> Map<string,'a>
    + Type parameters: 'T, 'a
    +     		+ +
    + + mapFilter f l + +
    + Signature: f:('T -> '?691184 option) -> l:NameMap<'T> -> Map<string,'?691184>
    + Type parameters: 'T, '?691184
    +     		+ +
    + + mapFold f s l + +
    + Signature: f:('?691174 -> string -> 'T -> '?691176 * '?691174) -> s:'?691174 -> l:NameMap<'T> -> Map<string,'?691176> * '?691174
    + Type parameters: '?691174, 'T, '?691176
    +     		+ +
    + + mem v m + +
    + Signature: v:string -> m:NameMap<'T> -> bool
    + Type parameters: 'T
    +     		+ +
    + + ofKeyedList f l + +
    + Signature: f:('a -> 'b) -> l:'a list -> Map<'b,'a>
    + Type parameters: 'a, 'b
    +     		+ +
    + + ofList(l) + +
    + Signature: l:(string * 'T) list -> NameMap<'T>
    + Type parameters: 'T
    +     		+ +
    + + ofSeq(l) + +
    + Signature: l:seq<string * 'T> -> NameMap<'T>
    + Type parameters: 'T
    +     		+ +
    + + partition f l + +
    + Signature: f:('T -> bool) -> l:NameMap<'T> -> Map<string,'T> * Map<string,'T>
    + Type parameters: 'T
    +     		+ +
    + + range(m) + +
    + Signature: m:Map<'a,'b> -> 'b list
    + Type parameters: 'a, 'b
    +     		+ +
    + + suball2 errf p m1 m2 + +
    + Signature: errf:('b -> 'c -> bool) -> p:('d -> 'c -> bool) -> m1:Map<'b,'d> -> m2:Map<'b,'c> -> bool
    + Type parameters: 'b, 'c, 'd
    +     		+ +
    + + subfold2 errf f m1 m2 acc + +
    + Signature: errf:('?691165 -> '?691166 -> '?691167) -> f:('?691165 -> '?691168 -> '?691166 -> '?691167 -> '?691167) -> m1:Map<'?691165,'?691168> -> m2:Map<'?691165,'?691166> -> acc:'?691167 -> '?691167
    + Type parameters: '?691165, '?691166, '?691167, '?691168
    +     		+

    For every entry in m2 find an entry in m1 and fold

    + + +
    + + toList(l) + +
    + Signature: l:NameMap<'T> -> (string * 'T) list
    + Type parameters: 'T
    +     		+ +
    + + tryFind v m + +
    + Signature: v:string -> m:NameMap<'T> -> 'T option
    + Type parameters: 'T
    +     		+ +
    + + tryFindInRange p m + +
    + Signature: p:('?691206 -> bool) -> m:Map<'?691207,'?691206> -> '?691206 option
    + Type parameters: '?691206, '?691207
    +     		+ +
    + + union unionf ms + +
    + Signature: unionf:(seq<'a> -> 'b) -> ms:seq<NameMap<'a>> -> Map<string,'b>
    + Type parameters: 'a, 'b
    +     		+

    Union entries by identical key, using the provided function to union sets of values

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimap-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimap-1.html new file mode 100644 index 0000000000..379534da22 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimap-1.html @@ -0,0 +1,144 @@ + + + + + NameMultiMap<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NameMultiMap<'T>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Count + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Count

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [key] + +
    + Signature: key:string -> 'T list
    +
    +     		+ +

    CompiledName: get_Item

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimapmodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimapmodule.html new file mode 100644 index 0000000000..cc08caec16 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-namemultimapmodule.html @@ -0,0 +1,239 @@ + + + + + NameMultiMap - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NameMultiMap

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library + + Attributes:
    +[<CompilationRepresentation(4)>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + add v x m + +
    + Signature: v:string -> x:'T -> m:NameMultiMap<'T> -> Map<string,'T list>
    + Type parameters: 'T
    +     		+ +
    + + chooseRange f m + +
    + Signature: f:('T -> 'b option) -> m:NameMultiMap<'T> -> 'b list
    + Type parameters: 'T, 'b
    +     		+ +
    + + empty + +
    + Signature: NameMultiMap<'T>
    + Type parameters: 'T
    +     		+ +
    + + existsInRange f m + +
    + Signature: f:('T -> bool) -> m:NameMultiMap<'T> -> bool
    + Type parameters: 'T
    +     		+ +
    + + find v m + +
    + Signature: v:string -> m:NameMultiMap<'T> -> 'T list
    + Type parameters: 'T
    +     		+ +
    + + initBy f xs + +
    + Signature: f:('T -> string) -> xs:seq<'T> -> NameMultiMap<'T>
    + Type parameters: 'T
    +     		+ +
    + + map f m + +
    + Signature: f:('T -> '?691224) -> m:NameMultiMap<'T> -> Map<string,'?691224 list>
    + Type parameters: 'T, '?691224
    +     		+ +
    + + ofList(xs) + +
    + Signature: xs:(string * 'T) list -> NameMultiMap<'T>
    + Type parameters: 'T
    +     		+ +
    + + range(m) + +
    + Signature: m:NameMultiMap<'T> -> 'T list
    + Type parameters: 'T
    +     		+ +
    + + rangeReversingEachBucket(m) + +
    + Signature: m:NameMultiMap<'T> -> 'T list
    + Type parameters: 'T
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-option.html b/docs/reference/fsharp-compiler-abstractil-internal-library-option.html new file mode 100644 index 0000000000..973412dd43 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-option.html @@ -0,0 +1,130 @@ + + + + + Option - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Option

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + +
    Function or valueDescription
    + + attempt(f) + +
    + Signature: f:(unit -> 'T) -> 'T option
    + Type parameters: 'T
    +     		+ +
    + + mapFold f s opt + +
    + Signature: f:('a -> 'b -> 'c * 'a) -> s:'a -> opt:'b option -> 'c option * 'a
    + Type parameters: 'a, 'b, 'c
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-order.html b/docs/reference/fsharp-compiler-abstractil-internal-library-order.html new file mode 100644 index 0000000000..35842c854e --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-order.html @@ -0,0 +1,143 @@ + + + + + Order - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Order

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + orderBy(p) + +
    + Signature: p:('T -> 'U) -> IComparer<'T>
    + Type parameters: 'T, 'U
    +     		+ +
    + + orderOn p pxOrder + +
    + Signature: p:('T -> 'U) -> pxOrder:IComparer<'U> -> IComparer<'T>
    + Type parameters: 'T, 'U
    +     		+ +
    + + toFunction pxOrder x y + +
    + Signature: pxOrder:IComparer<'U> -> x:'U -> y:'U -> int
    + Type parameters: 'U
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-resizearray.html b/docs/reference/fsharp-compiler-abstractil-internal-library-resizearray.html new file mode 100644 index 0000000000..1911442f01 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-resizearray.html @@ -0,0 +1,138 @@ + + + + + ResizeArray - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ResizeArray

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + +
    Function or valueDescription
    + + chunkBySize chunkSize f items + +
    + Signature: chunkSize:int -> f:('t -> '?690899) -> items:ResizeArray<'t> -> '?690899 [] []
    + Type parameters: 't, '?690899
    +     		+

    Split a ResizeArray into an array of smaller chunks. +This requires items/chunkSize Array copies of length chunkSize if items/chunkSize % 0 = 0, +otherwise items/chunkSize + 1 Array copies.

    + + +
    + + mapToSmallArrayChunks f inp + +
    + Signature: f:('t -> 'a) -> inp:ResizeArray<'t> -> 'a [] []
    + Type parameters: 't, 'a
    +     		+

    Split a large ResizeArray into a series of array chunks that are each under the Large Object Heap limit. +This is done to help prevent a stop-the-world collection of the single large array, instead allowing for a greater +probability of smaller collections. Stop-the-world is still possible, just less likely.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexception-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexception-1.html new file mode 100644 index 0000000000..6d17427ce1 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexception-1.html @@ -0,0 +1,128 @@ + + + + + ResultOrException<'TResult> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ResultOrException<'TResult>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Exception(Exception) + +
    + Signature: Exception
    +
    +     		+ +
    + + Result('TResult) + +
    + Signature: 'TResult
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexceptionmodule.html b/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexceptionmodule.html new file mode 100644 index 0000000000..55308e97fc --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-resultorexceptionmodule.html @@ -0,0 +1,175 @@ + + + + + ResultOrException - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ResultOrException

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library + + Attributes:
    +[<CompilationRepresentation(4)>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + ( |?> ) res f + +
    + Signature: res:ResultOrException<'a> -> f:('a -> 'b) -> ResultOrException<'b>
    + Type parameters: 'a, 'b
    +     		+ +

    CompiledName: op_BarQmarkGreater

    +
    + + ForceRaise(res) + +
    + Signature: res:ResultOrException<'a> -> 'a
    + Type parameters: 'a
    +     		+ +
    + + otherwise f x + +
    + Signature: f:(unit -> ResultOrException<'a2>) -> x:ResultOrException<'a2> -> ResultOrException<'a2>
    + Type parameters: 'a2
    +     		+ +
    + + raze(b) + +
    + Signature: b:exn -> ResultOrException<'b>
    + Type parameters: 'b
    +     		+ +
    + + success(a) + +
    + Signature: a:'b -> ResultOrException<'b>
    + Type parameters: 'b
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-shim-defaultfilesystem.html b/docs/reference/fsharp-compiler-abstractil-internal-library-shim-defaultfilesystem.html new file mode 100644 index 0000000000..6b5b2451ae --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-shim-defaultfilesystem.html @@ -0,0 +1,116 @@ + + + + + DefaultFileSystem - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    DefaultFileSystem

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Shim
    +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> DefaultFileSystem
    +
    +     		+ +

    CompiledName: .ctor

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-shim-ifilesystem.html b/docs/reference/fsharp-compiler-abstractil-internal-library-shim-ifilesystem.html new file mode 100644 index 0000000000..90e004cb4d --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-shim-ifilesystem.html @@ -0,0 +1,328 @@ + + + + + IFileSystem - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    IFileSystem

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Shim
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AssemblyLoad(assemblyName) + +
    + Signature: assemblyName:AssemblyName -> Assembly
    + Modifiers: abstract
    +
    +     		+

    Used to load a dependency for F# Interactive and in an unused corner-case of type provider loading

    + + +
    + + x.AssemblyLoadFrom(fileName) + +
    + Signature: fileName:string -> Assembly
    + Modifiers: abstract
    +
    +     		+

    Used to load type providers and located assemblies in F# Interactive

    + + +
    + + x.FileDelete(fileName) + +
    + Signature: fileName:string -> unit
    + Modifiers: abstract
    +
    +     		+

    A shim over File.Delete

    + + +
    + + x.FileStreamCreateShim(fileName) + +
    + Signature: fileName:string -> Stream
    + Modifiers: abstract
    +
    +     		+

    A shim over FileStream with FileMode.Create, FileAccess.Write, FileShare.Read

    + + +
    + + x.FileStreamReadShim(fileName) + +
    + Signature: fileName:string -> Stream
    + Modifiers: abstract
    +
    +     		+

    A shim over FileStream with FileMode.Open, FileAccess.Read, FileShare.ReadWrite

    + + +
    + + x.FileStreamWriteExistingShim(fileName) + +
    + Signature: fileName:string -> Stream
    + Modifiers: abstract
    +
    +     		+

    A shim over FileStream with FileMode.Open, FileAccess.Write, FileShare.Read

    + + +
    + + x.GetFullPathShim(fileName) + +
    + Signature: fileName:string -> string
    + Modifiers: abstract
    +
    +     		+

    Take in a filename with an absolute path, and return the same filename +but canonicalized with respect to extra path separators (e.g. C:\\foo.txt) +and '..' portions

    + + +
    + + x.GetLastWriteTimeShim(fileName) + +
    + Signature: fileName:string -> DateTime
    + Modifiers: abstract
    +
    +     		+

    Utc time of the last modification

    + + +
    + + x.GetTempPathShim() + +
    + Signature: unit -> string
    + Modifiers: abstract
    +
    +     		+

    A shim over Path.GetTempPath

    + + +
    + + x.IsInvalidPathShim(filename) + +
    + Signature: filename:string -> bool
    + Modifiers: abstract
    +
    +     		+

    A shim over Path.IsInvalidPath

    + + +
    + + x.IsPathRootedShim(path) + +
    + Signature: path:string -> bool
    + Modifiers: abstract
    +
    +     		+

    A shim over Path.IsPathRooted

    + + +
    + + x.IsStableFileHeuristic(fileName) + +
    + Signature: fileName:string -> bool
    + Modifiers: abstract
    +
    +     		+

    Used to determine if a file will not be subject to deletion during the lifetime of a typical client process.

    + + +
    + + x.ReadAllBytesShim(fileName) + +
    + Signature: fileName:string -> byte []
    + Modifiers: abstract
    +
    +     		+

    A shim over File.ReadAllBytes

    + + +
    + + x.SafeExists(fileName) + +
    + Signature: fileName:string -> bool
    + Modifiers: abstract
    +
    +     		+

    A shim over File.Exists

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-shim.html b/docs/reference/fsharp-compiler-abstractil-internal-library-shim.html new file mode 100644 index 0000000000..5d098425eb --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-shim.html @@ -0,0 +1,185 @@ + + + + + Shim - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Shim

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library + + Attributes:
    +[<AutoOpen>]
    + +     +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + +
    TypeDescription
    + DefaultFileSystem + + +
    + IFileSystem + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + FileSystem + +
    + Signature: IFileSystem
    +
    +     		+ +
    +

    Type extensions

    + + + + + + + + + + + + + + +
    Type extensionDescription
    + + File.OpenReaderAndRetry(...) + +
    + Signature: (filename:string * codepage:int option * retryLocked:bool) -> StreamReader
    +
    +     		+ +

    CompiledName: File.OpenReaderAndRetry.Static

    +
    + + File.ReadBinaryChunk(...) + +
    + Signature: (fileName:string * start:int * len:int) -> byte []
    +
    +     		+ +

    CompiledName: File.ReadBinaryChunk.Static

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-string.html b/docs/reference/fsharp-compiler-abstractil-internal-library-string.html new file mode 100644 index 0000000000..a3e2e3b0a3 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-string.html @@ -0,0 +1,379 @@ + + + + + String - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    String

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + capitalize(s) + +
    + Signature: s:string -> string
    +
    +     		+ +
    + + contains s c + +
    + Signature: s:string -> c:char -> bool
    +
    +     		+ +
    + + dropPrefix s t + +
    + Signature: s:string -> t:string -> string
    +
    +     		+ +
    + + dropSuffix s t + +
    + Signature: s:string -> t:string -> string
    +
    +     		+ +
    + + extractTrailingIndex(str) + +
    + Signature: str:string -> string * int option
    +
    +     		+ +
    + + get str i + +
    + Signature: str:string -> i:int -> char
    +
    +     		+ +
    + + getLines(str) + +
    + Signature: str:string -> string []
    +
    +     		+ +
    + + isUpper(s) + +
    + Signature: s:string -> bool
    +
    +     		+ +
    + + lowercase(s) + +
    + Signature: s:string -> string
    +
    +     		+ +
    + + lowerCaseFirstChar(str) + +
    + Signature: str:string -> string
    +
    +     		+ +
    + + make n c + +
    + Signature: n:int -> c:char -> string
    +
    +     		+ +
    + + order + +
    + Signature: IComparer<string>
    +
    +     		+ +
    + + split options separator value + +
    + Signature: options:StringSplitOptions -> separator:string [] -> value:string -> string []
    +
    +     		+

    Splits a string into substrings based on the strings in the array separators

    + + +
    + + sub s start len + +
    + Signature: s:string -> start:int -> len:int -> string
    +
    +     		+ +
    + + toCharArray(str) + +
    + Signature: str:string -> char []
    +
    +     		+ +
    + + trim(value) + +
    + Signature: value:string -> string
    +
    +     		+

    Remove all trailing and leading whitespace from the string +return null if the string is null

    + + +
    + + uncapitalize(s) + +
    + Signature: s:string -> string
    +
    +     		+ +
    + + uppercase(s) + +
    + Signature: s:string -> string
    +
    +     		+ +
    +

    Active patterns

    + + + + + + + + + + + + + + +
    Active patternDescription
    + + ( |Contains|_| ) pattern value + +
    + Signature: pattern:string -> value:string -> unit option
    +
    +     		+ +

    CompiledName: |Contains|_|

    +
    + + ( |StartsWith|_| ) pattern value + +
    + Signature: pattern:string -> value:string -> unit option
    +
    +     		+ +

    CompiledName: |StartsWith|_|

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-tables.html b/docs/reference/fsharp-compiler-abstractil-internal-library-tables.html new file mode 100644 index 0000000000..ceb18c0706 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-tables.html @@ -0,0 +1,119 @@ + + + + + Tables - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Tables

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +

    Intern tables to save space.

    + +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + memoize(f) + +
    + Signature: f:('a -> 'b) -> 'a -> 'b
    + Type parameters: 'a, 'b
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-undefinedexception.html b/docs/reference/fsharp-compiler-abstractil-internal-library-undefinedexception.html new file mode 100644 index 0000000000..fddb0377fe --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-undefinedexception.html @@ -0,0 +1,94 @@ + + + + + UndefinedException - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UndefinedException

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-uniquestampgenerator-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-uniquestampgenerator-1.html new file mode 100644 index 0000000000..3d080cbfad --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-uniquestampgenerator-1.html @@ -0,0 +1,153 @@ + + + + + UniqueStampGenerator<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UniqueStampGenerator<'T>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    +

    +
    +

    Generates unique stamps

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> UniqueStampGenerator<'T>
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Encode(str) + +
    + Signature: str:'T -> int
    +
    +     		+ +
    + + x.Table + +
    + Signature: KeyCollection<'T,int>
    +
    +     		+ +

    CompiledName: get_Table

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-valueoptioninternal.html b/docs/reference/fsharp-compiler-abstractil-internal-library-valueoptioninternal.html new file mode 100644 index 0000000000..1930fbb461 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-valueoptioninternal.html @@ -0,0 +1,133 @@ + + + + + ValueOptionInternal - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ValueOptionInternal

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library +

    +
    +

    chunk the provided input into arrays that are smaller than the LOH limit +in order to prevent long-term storage of those values

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + +
    Function or valueDescription
    + + bind f x + +
    + Signature: f:('b -> 'c voption) -> x:'b voption -> 'c voption
    + Type parameters: 'b, 'c
    +     		+ +
    + + ofOption(x) + +
    + Signature: x:'b option -> 'b voption
    + Type parameters: 'b
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library-valueorcancelled-1.html b/docs/reference/fsharp-compiler-abstractil-internal-library-valueorcancelled-1.html new file mode 100644 index 0000000000..f006b06485 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library-valueorcancelled-1.html @@ -0,0 +1,133 @@ + + + + + ValueOrCancelled<'TResult> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ValueOrCancelled<'TResult>

    +

    + + Namespace: FSharp.Compiler.AbstractIL.Internal
    + Parent Module: Library
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Cancelled(OperationCanceledException) + +
    + Signature: OperationCanceledException
    +
    +     		+ +
    + + Value('TResult) + +
    + Signature: 'TResult
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-library.html b/docs/reference/fsharp-compiler-abstractil-internal-library.html new file mode 100644 index 0000000000..086af3d549 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-library.html @@ -0,0 +1,934 @@ + + + + + Library - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Library

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + AnyCallerThreadToken + +

    Represents a token that indicates execution on a any of several potential user threads calling the F# compiler services.

    + + +
    + Cancellable<'TResult> + +

    Represents a cancellable computation with explicit representation of a cancelled result.

    +

    A cancellable computation is passed may be cancelled via a CancellationToken, which is propagated implicitly.
    +If cancellation occurs, it is propagated as data rather than by raising an OperationCanceledException.

    + + +
    + CancellableBuilder + + +
    + CompilationThreadToken + +

    Represents a token that indicates execution on the compilation thread, i.e. +- we have full access to the (partially mutable) TAST and TcImports data structures +- compiler execution may result in type provider invocations when resolving types and members +- we can access various caches in the SourceCodeServices

    +

    Like other execution tokens this should be passed via argument passing and not captured/stored beyond +the lifetime of stack-based calls. This is not checked, it is a discipline within the compiler code.

    + + +
    + DictionaryExtensions + + +
    + Eventually<'T> + +

    Computations that can cooperatively yield by returning a continuation

    +
      +
    • +

      Any yield of a NotYetDone should typically be "abandonable" without adverse consequences. No resource release +will be called when the computation is abandoned.

      +
      • +
    • +

      Computations suspend via a NotYetDone may use local state (mutables), where these are +captured by the NotYetDone closure. Computations do not need to be restartable.

      +
      • +
    • +

      The key thing is that you can take an Eventually value and run it with +Eventually.repeatedlyProgressUntilDoneOrTimeShareOverOrCanceled

      +
      • +
    • Cancellation results in a suspended computation rather than complete abandonment
      • +
    + + +
    + EventuallyBuilder + + +
    + ExecutionToken + +

    Represents a permission active at this point in execution

    + + +
    + IPartialEqualityComparer<'T> + +

    Interface that defines methods for comparing objects using partial equality relation

    + + +
    + InlineDelayInit<'T> + +

    An efficient lazy for inline storage in a class type. Results in fewer thunks.

    + + +
    + LayeredMap<'Key, 'Value> + + +
    + LayeredMultiMap<'Key, 'Value> + +

    Immutable map collection, with explicit flattening to a backing dictionary

    + + +
    + LazyWithContext<'T, 'ctxt> + +

    Just like "Lazy" but EVERY forcer must provide an instance of "ctxt", e.g. to help track errors +on forcing back to at least one sensible user location

    + + +
    + LazyWithContextFailure + + +
    + Lock<'LockTokenType> + +

    Encapsulates a lock associated with a particular token-type representing the acquisition of that lock.

    + + +
    + LockToken + +

    A base type for various types of tokens that must be passed when a lock is taken. +Each different static lock should declare a new subtype of this type.

    + + +
    + MemoizationTable<'T, 'U> + +

    memoize tables (all entries cached, never collected)

    + + +
    + MultiMap<'T, 'U> + + +
    + NameMap<'T> + + +
    + NameMultiMap<'T> + + +
    + ResultOrException<'TResult> + + +
    + UndefinedException + + +
    + UniqueStampGenerator<'T> + +

    Generates unique stamps

    + + +
    + ValueOrCancelled<'TResult> + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ModuleDescription
    + Array + + +
    + Cancellable + + +
    + Dictionary + + +
    + Eventually + + +
    + IPartialEqualityComparer + + +
    + Lazy + + +
    + List + + +
    + Map + + +
    + MultiMap + + +
    + NameMap + + +
    + NameMultiMap + + +
    + Option + + +
    + Order + + +
    + ResizeArray + + +
    + ResultOrException + + +
    + Shim + + +
    + String + + +
    + Tables + +

    Intern tables to save space.

    + + +
    + ValueOptionInternal + +

    chunk the provided input into arrays that are smaller than the LOH limit +in order to prevent long-term storage of those values

    + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + ( === ) x y + +
    + Signature: x:'a -> y:'a -> bool
    + Type parameters: 'a
    +     		+ +

    CompiledName: op_EqualsEqualsEquals

    +
    + + ( >>>& ) x n + +
    + Signature: x:int32 -> n:int32 -> int32
    +
    +     		+ +

    CompiledName: op_GreaterGreaterGreaterAmp

    +
    + + AssumeAnyCallerThreadWithoutEvidence() + +
    + Signature: unit -> AnyCallerThreadToken
    +
    +     		+ +
    + + AssumeCompilationThreadWithoutEvidence() + +
    + Signature: unit -> CompilationThreadToken
    +
    +     		+

    Represents a place in the compiler codebase where we assume we are executing on a compilation thread

    + + +
    + + AssumeLockWithoutEvidence() + +
    + Signature: unit -> 'LockTokenType
    + Type parameters: 'LockTokenType
    +     		+ +
    + + cancellable + +
    + Signature: CancellableBuilder
    +
    +     		+ +
    + + DoesNotRequireCompilerThreadTokenAndCouldPossiblyBeMadeConcurrent(...) + +
    + Signature: _ctok:CompilationThreadToken -> unit
    +
    +     		+

    Represents a place in the compiler codebase where we are passed a CompilationThreadToken unnecessarily. +This represents code that may potentially not need to be executed on the compilation thread.

    + + +
    + + eventually + +
    + Signature: EventuallyBuilder
    +
    +     		+ +
    + + foldOn p f z x + +
    + Signature: p:('c -> 'd) -> f:('e -> 'd -> 'f) -> z:'e -> x:'c -> 'f
    + Type parameters: 'c, 'd, 'e, 'f
    +     		+ +
    + + getHole(r) + +
    + Signature: r:'a option ref -> 'a
    + Type parameters: 'a
    +     		+

    Get an initialization hole

    + + +
    + + isNil(l) + +
    + Signature: l:'a list -> bool
    + Type parameters: 'a
    +     		+ +
    + + isNilOrSingleton(l) + +
    + Signature: l:'a list -> bool
    + Type parameters: 'a
    +     		+

    Returns true if the list has less than 2 elements. Otherwise false.

    + + +
    + + isNonNull(x) + +
    + Signature: x:'a -> bool
    + Type parameters: 'a
    +     		+ +
    + + isSingleton(l) + +
    + Signature: l:'a list -> bool
    + Type parameters: 'a
    +     		+

    Returns true if the list contains exactly 1 element. Otherwise false.

    + + +
    + + LOH_SIZE_THRESHOLD_BYTES + +
    + Signature: int
    +
    +     		+

    Per the docs the threshold for the Large Object Heap is 85000 bytes: https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/large-object-heap#how-an-object-ends-up-on-the-large-object-heap-and-how-gc-handles-them +We set the limit to be 80k to account for larger pointer sizes for when F# is running 64-bit.

    + + +
    + + nonNull msg x + +
    + Signature: msg:string -> x:'?690544 -> '?690544
    + Type parameters: '?690544
    +     		+ +
    + + notFound() + +
    + Signature: unit -> 'd
    + Type parameters: 'd
    +     		+ +
    + + notlazy(v) + +
    + Signature: v:'a -> Lazy<'a>
    + Type parameters: 'a
    +     		+ +
    + + reportTime + +
    + Signature: bool -> string -> unit
    +
    +     		+ +
    + + RequireCompilationThread(_ctok) + +
    + Signature: _ctok:CompilationThreadToken -> unit
    +
    +     		+

    Represents a place where we are stating that execution on the compilation thread is required. The +reason why will be documented in a comment in the code at the callsite.

    + + +
    +

    Type extensions

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Type extensionDescription
    + + x.AddAndMarkAsCollapsible(kvs) + +
    + Signature: (kvs:KeyValuePair<'Key,'Value> []) -> Map<'Key,'Value>
    +
    +     		+ +

    CompiledName: Map`2.AddAndMarkAsCollapsible

    +
    + + Map.Empty + +
    + Signature: Map<'Key,'Value>
    +
    +     		+ +

    CompiledName: Map`2.get_Empty.Static

    +
    + + Map.Empty + +
    + Signature: Map<'Key,'Value>
    +
    +     		+ +

    CompiledName: Map`2.get_Empty.Static

    +
    + + x.EndsWithOrdinal(value) + +
    + Signature: value:string -> bool
    +
    +     		+ +

    CompiledName: String.EndsWithOrdinal

    +
    + + x.LinearTryModifyThenLaterFlatten(...) + +
    + Signature: (key:'Key * f:('Value option -> 'Value)) -> Map<'Key,'Value>
    +
    +     		+ +

    CompiledName: Map`2.LinearTryModifyThenLaterFlatten

    +
    + + x.MarkAsCollapsible() + +
    + Signature: unit -> Map<'Key,'Value>
    +
    +     		+ +

    CompiledName: Map`2.MarkAsCollapsible

    +
    + + x.StartsWithOrdinal(value) + +
    + Signature: value:string -> bool
    +
    +     		+ +

    CompiledName: String.StartsWithOrdinal

    +
    + + x.Values + +
    + Signature: 'Value list
    +
    +     		+ +

    CompiledName: Map`2.get_Values

    +
    + + x.Values + +
    + Signature: 'Value list
    +
    +     		+ +

    CompiledName: Map`2.get_Values

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-abstractil-internal-utils.html b/docs/reference/fsharp-compiler-abstractil-internal-utils.html new file mode 100644 index 0000000000..3cad002bf6 --- /dev/null +++ b/docs/reference/fsharp-compiler-abstractil-internal-utils.html @@ -0,0 +1,116 @@ + + + + + Utils - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Utils

    +

    + Namespace: FSharp.Compiler.AbstractIL.Internal
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + runningOnMono + +
    + Signature: bool
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-blockseparator.html b/docs/reference/fsharp-compiler-ast-blockseparator.html new file mode 100644 index 0000000000..781e4dd5c5 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-blockseparator.html @@ -0,0 +1,130 @@ + + + + + BlockSeparator - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    BlockSeparator

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +

    denotes location of the separator block + optional position of the semicolon (used for tooling support)

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: range
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: pos option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-customoperations.html b/docs/reference/fsharp-compiler-ast-customoperations.html new file mode 100644 index 0000000000..2326befa37 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-customoperations.html @@ -0,0 +1,126 @@ + + + + + CustomOperations - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CustomOperations

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Ast + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + CustomOperations.Into + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-expratomicflag.html b/docs/reference/fsharp-compiler-ast-expratomicflag.html new file mode 100644 index 0000000000..03002babd9 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-expratomicflag.html @@ -0,0 +1,134 @@ + + + + + ExprAtomicFlag - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ExprAtomicFlag

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Atomic + +
    + Signature: ExprAtomicFlag
    + Modifiers: static
    +
    +     		+

    Says that the expression is an atomic expression, i.e. is of a form that has no whitespace unless +enclosed in parentheses, e.g. 1, "3", ident, ident.[expr] and (expr). If an atomic expression has +type T, then the largest expression ending at the same range as the atomic expression also has type T.

    + + +
    + + NonAtomic + +
    + Signature: ExprAtomicFlag
    + Modifiers: static
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-fsharplib.html b/docs/reference/fsharp-compiler-ast-fsharplib.html new file mode 100644 index 0000000000..26e80ec30b --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-fsharplib.html @@ -0,0 +1,161 @@ + + + + + FSharpLib - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpLib

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Ast + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + FSharpLib.Core + +
    + Signature: string
    +
    +     		+ +
    + + FSharpLib.CorePath + +
    + Signature: string list
    +
    +     		+ +
    + + FSharpLib.Root + +
    + Signature: string
    +
    +     		+ +
    + + FSharpLib.RootPath + +
    + Signature: string list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-ident.html b/docs/reference/fsharp-compiler-ast-ident.html new file mode 100644 index 0000000000..ca0e011ea2 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-ident.html @@ -0,0 +1,160 @@ + + + + + Ident - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Ident

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<DebuggerDisplay("{idText}")>]
    +[<Struct>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(text, range) + +
    + Signature: (text:string * range:range) -> Ident
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.idRange + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_idRange

    +
    + + x.idText + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_idText

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-lexbuflocalxmldocstore.html b/docs/reference/fsharp-compiler-ast-lexbuflocalxmldocstore.html new file mode 100644 index 0000000000..5e0fca5156 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-lexbuflocalxmldocstore.html @@ -0,0 +1,99 @@ + + + + + LexbufLocalXmlDocStore - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LexbufLocalXmlDocStore

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Ast +

    +
    +

    XmlDoc F# lexer/parser state, held in the BufferLocalStore for the lexer. +This is the only use of the lexer BufferLocalStore in the codebase.

    + +
    + + + + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-lexcont.html b/docs/reference/fsharp-compiler-ast-lexcont.html new file mode 100644 index 0000000000..1ba4ddc205 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-lexcont.html @@ -0,0 +1,116 @@ + + + + + LexCont - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LexCont

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.LexerIfdefStack + +
    + Signature: LexerIfdefStackEntries
    +
    +     		+ +

    CompiledName: get_LexerIfdefStack

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-lexerendlinecontinuation.html b/docs/reference/fsharp-compiler-ast-lexerendlinecontinuation.html new file mode 100644 index 0000000000..ee5dd73e35 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-lexerendlinecontinuation.html @@ -0,0 +1,154 @@ + + + + + LexerEndlineContinuation - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LexerEndlineContinuation

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +

    Specifies how the 'endline' function in the lexer should continue after +it reaches end of line or eof. The options are to continue with 'token' function +or to continue with 'skip' function.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Skip(LexerIfdefStackEntries,int,range) + +
    + Signature: LexerIfdefStackEntries * int * range
    +
    +     		+ +
    + + Token(LexerIfdefStackEntries) + +
    + Signature: LexerIfdefStackEntries
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.LexerIfdefStack + +
    + Signature: LexerIfdefStackEntries
    +
    +     		+ +

    CompiledName: get_LexerIfdefStack

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-lexerifdefexpression.html b/docs/reference/fsharp-compiler-ast-lexerifdefexpression.html new file mode 100644 index 0000000000..2ccfa389cd --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-lexerifdefexpression.html @@ -0,0 +1,154 @@ + + + + + LexerIfdefExpression - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LexerIfdefExpression

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + IfdefAnd(...) + +
    + Signature: LexerIfdefExpression * LexerIfdefExpression
    +
    +     		+ +
    + + IfdefId(string) + +
    + Signature: string
    +
    +     		+ +
    + + IfdefNot(LexerIfdefExpression) + +
    + Signature: LexerIfdefExpression
    +
    +     		+ +
    + + IfdefOr(...) + +
    + Signature: LexerIfdefExpression * LexerIfdefExpression
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-lexerifdefstack.html b/docs/reference/fsharp-compiler-ast-lexerifdefstack.html new file mode 100644 index 0000000000..d8189d930a --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-lexerifdefstack.html @@ -0,0 +1,194 @@ + + + + + LexerIfdefStack - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LexerIfdefStack

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: LexerIfdefStackEntry * range
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> LexerIfdefStackEntry * range
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: (LexerIfdefStackEntry * range) list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: (LexerIfdefStackEntry * range) list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-lexerifdefstackentries.html b/docs/reference/fsharp-compiler-ast-lexerifdefstackentries.html new file mode 100644 index 0000000000..641503ee59 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-lexerifdefstackentries.html @@ -0,0 +1,194 @@ + + + + + LexerIfdefStackEntries - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LexerIfdefStackEntries

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: LexerIfdefStackEntry * range
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> LexerIfdefStackEntry * range
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: (LexerIfdefStackEntry * range) list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: (LexerIfdefStackEntry * range) list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-lexerifdefstackentry.html b/docs/reference/fsharp-compiler-ast-lexerifdefstackentry.html new file mode 100644 index 0000000000..fca58549ac --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-lexerifdefstackentry.html @@ -0,0 +1,128 @@ + + + + + LexerIfdefStackEntry - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LexerIfdefStackEntry

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + IfDefElse + +
    + Signature:
    +
    +     		+ +
    + + IfDefIf + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-lexerwhitespacecontinuation.html b/docs/reference/fsharp-compiler-ast-lexerwhitespacecontinuation.html new file mode 100644 index 0000000000..9770d10410 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-lexerwhitespacecontinuation.html @@ -0,0 +1,292 @@ + + + + + LexerWhitespaceContinuation - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LexerWhitespaceContinuation

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    The parser defines a number of tokens for whitespace and +comments eliminated by the lexer. These carry a specification of +a continuation for the lexer for continued processing after we've dealt with +the whitespace.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Comment(ifdef,int,range) + +
    + Signature: LexerIfdefStackEntries * int * range
    +
    +     		+ +
    + + EndLine(LexerEndlineContinuation) + +
    + Signature: LexerEndlineContinuation
    +
    +     		+ +
    + + IfDefSkip(ifdef,int,range) + +
    + Signature: LexerIfdefStackEntries * int * range
    +
    +     		+ +
    + + MLOnly(ifdef,range) + +
    + Signature: LexerIfdefStackEntries * range
    +
    +     		+ +
    + + SingleLineComment(ifdef,int,range) + +
    + Signature: LexerIfdefStackEntries * int * range
    +
    +     		+ +
    + + String(ifdef,range) + +
    + Signature: LexerIfdefStackEntries * range
    +
    +     		+ +
    + + StringInComment(ifdef,int,range) + +
    + Signature: LexerIfdefStackEntries * int * range
    +
    +     		+ +
    + + Token(ifdef) + +
    + Signature: LexerIfdefStackEntries
    +
    +     		+ +
    + + TripleQuoteString(ifdef,range) + +
    + Signature: LexerIfdefStackEntries * range
    +
    +     		+ +
    + + TripleQuoteStringInComment(...) + +
    + Signature: LexerIfdefStackEntries * int * range
    +
    +     		+ +
    + + VerbatimString(ifdef,range) + +
    + Signature: LexerIfdefStackEntries * range
    +
    +     		+ +
    + + VerbatimStringInComment(ifdef,int,range) + +
    + Signature: LexerIfdefStackEntries * int * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.LexerIfdefStack + +
    + Signature: LexerIfdefStackEntries
    +
    +     		+ +

    CompiledName: get_LexerIfdefStack

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-longident.html b/docs/reference/fsharp-compiler-ast-longident.html new file mode 100644 index 0000000000..eaa65bf6c5 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-longident.html @@ -0,0 +1,194 @@ + + + + + LongIdent - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LongIdent

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: Ident
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> Ident
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: Ident list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: Ident list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-longidentwithdots.html b/docs/reference/fsharp-compiler-ast-longidentwithdots.html new file mode 100644 index 0000000000..0d3e04b687 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-longidentwithdots.html @@ -0,0 +1,186 @@ + + + + + LongIdentWithDots - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LongIdentWithDots

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + LongIdentWithDots(id,dotms) + +
    + Signature: LongIdent * range list
    +
    +     		+

    LongIdentWithDots(lid, dotms) +Typically dotms.Length = lid.Length-1, but they may be same if (incomplete) code ends in a dot, e.g. "Foo.Bar." +The dots mostly matter for parsing, and are typically ignored by the typechecker, but +if dotms.Length = lid.Length, then the parser must have reported an error, so the typechecker is allowed +more freedom about typechecking these expressions. +LongIdent can be empty list - it is used to denote that name of some AST element is absent (i.e. empty type name in inherit)

    + + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Lid + +
    + Signature: LongIdent
    +
    +     		+ +

    CompiledName: get_Lid

    +
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + + x.RangeSansAnyExtraDot + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_RangeSansAnyExtraDot

    +
    + + x.ThereIsAnExtraDotAtTheEnd + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_ThereIsAnExtraDotAtTheEnd

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-memberflags.html b/docs/reference/fsharp-compiler-ast-memberflags.html new file mode 100644 index 0000000000..ac8affdf7f --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-memberflags.html @@ -0,0 +1,172 @@ + + + + + MemberFlags - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MemberFlags

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + IsDispatchSlot + +
    + Signature: bool
    +
    +     		+ +
    + + IsFinal + +
    + Signature: bool
    +
    +     		+ +
    + + IsInstance + +
    + Signature: bool
    +
    +     		+ +
    + + IsOverrideOrExplicitImpl + +
    + Signature: bool
    +
    +     		+ +
    + + MemberKind + +
    + Signature: MemberKind
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-memberkind.html b/docs/reference/fsharp-compiler-ast-memberkind.html new file mode 100644 index 0000000000..031a61231e --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-memberkind.html @@ -0,0 +1,191 @@ + + + + + MemberKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MemberKind

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<StructuralEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Note the member kind is actually computed partially by a syntax tree transformation in tc.fs

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ClassConstructor + +
    + Signature:
    +
    +     		+ +
    + + Constructor + +
    + Signature:
    +
    +     		+ +
    + + Member + +
    + Signature:
    +
    +     		+ +
    + + PropertyGet + +
    + Signature:
    +
    +     		+ +
    + + PropertyGetSet + +
    + Signature:
    +
    +     		+

    An artificial member kind used prior to the point where a get/set property is split into two distinct members.

    + + +
    + + PropertySet + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parsedfsiinteraction.html b/docs/reference/fsharp-compiler-ast-parsedfsiinteraction.html new file mode 100644 index 0000000000..bb3c935f7a --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parsedfsiinteraction.html @@ -0,0 +1,134 @@ + + + + + ParsedFsiInteraction - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedFsiInteraction

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + IDefns(SynModuleDecl list,range) + +
    + Signature: SynModuleDecl list * range
    +
    +     		+ +
    + + IHash(ParsedHashDirective,range) + +
    + Signature: ParsedHashDirective * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parsedhashdirective.html b/docs/reference/fsharp-compiler-ast-parsedhashdirective.html new file mode 100644 index 0000000000..715e7383dc --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parsedhashdirective.html @@ -0,0 +1,121 @@ + + + + + ParsedHashDirective - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedHashDirective

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + ParsedHashDirective(...) + +
    + Signature: string * string list * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parsedimplfile.html b/docs/reference/fsharp-compiler-ast-parsedimplfile.html new file mode 100644 index 0000000000..b558fff91f --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parsedimplfile.html @@ -0,0 +1,121 @@ + + + + + ParsedImplFile - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedImplFile

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + ParsedImplFile(...) + +
    + Signature: ParsedHashDirective list * ParsedImplFileFragment list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parsedimplfilefragment.html b/docs/reference/fsharp-compiler-ast-parsedimplfilefragment.html new file mode 100644 index 0000000000..a35288fae2 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parsedimplfilefragment.html @@ -0,0 +1,148 @@ + + + + + ParsedImplFileFragment - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedImplFileFragment

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AnonModule(SynModuleDecls,range) + +
    + Signature: SynModuleDecls * range
    +
    +     		+ +
    + + NamedModule(SynModuleOrNamespace) + +
    + Signature: SynModuleOrNamespace
    +
    +     		+ +
    + + NamespaceFragment(...) + +
    + Signature: LongIdent * bool * SynModuleOrNamespaceKind * SynModuleDecls * PreXmlDoc * SynAttributes * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parsedimplfileinput.html b/docs/reference/fsharp-compiler-ast-parsedimplfileinput.html new file mode 100644 index 0000000000..0138397beb --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parsedimplfileinput.html @@ -0,0 +1,121 @@ + + + + + ParsedImplFileInput - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedImplFileInput

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + ParsedImplFileInput(...) + +
    + Signature: string * bool * QualifiedNameOfFile * ScopedPragma list * ParsedHashDirective list * SynModuleOrNamespace list * bool * bool
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parsedinput.html b/docs/reference/fsharp-compiler-ast-parsedinput.html new file mode 100644 index 0000000000..bccdf3989b --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parsedinput.html @@ -0,0 +1,157 @@ + + + + + ParsedInput - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedInput

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ImplFile(ParsedImplFileInput) + +
    + Signature: ParsedImplFileInput
    +
    +     		+ +
    + + SigFile(ParsedSigFileInput) + +
    + Signature: ParsedSigFileInput
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parsedsigfile.html b/docs/reference/fsharp-compiler-ast-parsedsigfile.html new file mode 100644 index 0000000000..4f5ad79ad7 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parsedsigfile.html @@ -0,0 +1,121 @@ + + + + + ParsedSigFile - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedSigFile

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + ParsedSigFile(...) + +
    + Signature: ParsedHashDirective list * ParsedSigFileFragment list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parsedsigfilefragment.html b/docs/reference/fsharp-compiler-ast-parsedsigfilefragment.html new file mode 100644 index 0000000000..ec48da3e39 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parsedsigfilefragment.html @@ -0,0 +1,148 @@ + + + + + ParsedSigFileFragment - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedSigFileFragment

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AnonModule(SynModuleSigDecls,range) + +
    + Signature: SynModuleSigDecls * range
    +
    +     		+ +
    + + NamedModule(SynModuleOrNamespaceSig) + +
    + Signature: SynModuleOrNamespaceSig
    +
    +     		+ +
    + + NamespaceFragment(...) + +
    + Signature: LongIdent * bool * SynModuleOrNamespaceKind * SynModuleSigDecls * PreXmlDoc * SynAttributes * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parsedsigfileinput.html b/docs/reference/fsharp-compiler-ast-parsedsigfileinput.html new file mode 100644 index 0000000000..26a996403e --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parsedsigfileinput.html @@ -0,0 +1,121 @@ + + + + + ParsedSigFileInput - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedSigFileInput

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + ParsedSigFileInput(...) + +
    + Signature: string * QualifiedNameOfFile * ScopedPragma list * ParsedHashDirective list * SynModuleOrNamespaceSig list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-parserdetail.html b/docs/reference/fsharp-compiler-ast-parserdetail.html new file mode 100644 index 0000000000..00a50d5aa2 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-parserdetail.html @@ -0,0 +1,128 @@ + + + + + ParserDetail - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParserDetail

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Ok + +
    + Signature:
    +
    +     		+ +
    + + ThereWereSignificantParseErrorsSoDoNotTypecheckThisNode + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-prexmldoc.html b/docs/reference/fsharp-compiler-ast-prexmldoc.html new file mode 100644 index 0000000000..d85b89a7ca --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-prexmldoc.html @@ -0,0 +1,210 @@ + + + + + PreXmlDoc - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PreXmlDoc

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + PreXmlDoc(pos,XmlDocCollector) + +
    + Signature: pos * XmlDocCollector
    +
    +     		+ +
    + + PreXmlDocEmpty + +
    + Signature:
    +
    +     		+ +
    + + PreXmlMerge(PreXmlDoc,PreXmlDoc) + +
    + Signature: PreXmlDoc * PreXmlDoc
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.ToXmlDoc() + +
    + Signature: unit -> XmlDoc
    +
    +     		+ +
    +

    Static members

    + + + + + + + + + + + + + + + + + + +
    Static memberDescription
    + + PreXmlDoc.CreateFromGrabPoint(...) + +
    + Signature: (collector:XmlDocCollector * grabPointPos:pos) -> PreXmlDoc
    +
    +     		+ +
    + + PreXmlDoc.Empty + +
    + Signature: PreXmlDoc
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + + PreXmlDoc.Merge a b + +
    + Signature: a:PreXmlDoc -> b:PreXmlDoc -> PreXmlDoc
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-qualifiednameoffile.html b/docs/reference/fsharp-compiler-ast-qualifiednameoffile.html new file mode 100644 index 0000000000..b0586f3967 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-qualifiednameoffile.html @@ -0,0 +1,177 @@ + + + + + QualifiedNameOfFile - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    QualifiedNameOfFile

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    QualifiedNameOfFile acts to fully-qualify module specifications and implementations, +most importantly the ones that simply contribute fragments to a namespace (i.e. the ParsedSigFileFragment.NamespaceFragment case) +There may be multiple such fragments in a single assembly. There may thus also +be multiple matching pairs of these in an assembly, all contributing types to the same +namespace.

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + QualifiedNameOfFile(Ident) + +
    + Signature: Ident
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Id + +
    + Signature: Ident
    +
    +     		+ +

    CompiledName: get_Id

    +
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + + x.Text + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Text

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-recordfieldname.html b/docs/reference/fsharp-compiler-ast-recordfieldname.html new file mode 100644 index 0000000000..8398d6e512 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-recordfieldname.html @@ -0,0 +1,130 @@ + + + + + RecordFieldName - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    RecordFieldName

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +

    stores pair: record field name + (true if given record field name is syntactically correct and can be used in name resolution)

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: LongIdentWithDots
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: bool
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-scopedpragma.html b/docs/reference/fsharp-compiler-ast-scopedpragma.html new file mode 100644 index 0000000000..a42a72bcd0 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-scopedpragma.html @@ -0,0 +1,120 @@ + + + + + ScopedPragma - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ScopedPragma

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + WarningOff(range,int) + +
    + Signature: range * int
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-seqexpronly.html b/docs/reference/fsharp-compiler-ast-seqexpronly.html new file mode 100644 index 0000000000..f0c5a6e27f --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-seqexpronly.html @@ -0,0 +1,119 @@ + + + + + SeqExprOnly - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SeqExprOnly

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +

    Indicates if a for loop is 'for x in e1 -> e2', only valid in sequence expressions

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SeqExprOnly(bool) + +
    + Signature: bool
    +
    +     		+

    Indicates if a for loop is 'for x in e1 -> e2', only valid in sequence expressions

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforbinding.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforbinding.html new file mode 100644 index 0000000000..d229929ae0 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-sequencepointinfoforbinding.html @@ -0,0 +1,188 @@ + + + + + SequencePointInfoForBinding - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SequencePointInfoForBinding

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + NoSequencePointAtDoBinding + +
    + Signature:
    +
    +     		+ +
    + + NoSequencePointAtInvisibleBinding + +
    + Signature:
    +
    +     		+ +
    + + NoSequencePointAtLetBinding + +
    + Signature:
    +
    +     		+ +
    + + NoSequencePointAtStickyBinding + +
    + Signature:
    +
    +     		+ +
    + + SequencePointAtBinding(range) + +
    + Signature: range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Combine(y) + +
    + Signature: y:SequencePointInfoForBinding -> SequencePointInfoForBinding
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforfinally.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforfinally.html new file mode 100644 index 0000000000..d4d7e607f1 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-sequencepointinfoforfinally.html @@ -0,0 +1,128 @@ + + + + + SequencePointInfoForFinally - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SequencePointInfoForFinally

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + NoSequencePointAtFinally + +
    + Signature:
    +
    +     		+ +
    + + SequencePointAtFinally(range) + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforforloop.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforforloop.html new file mode 100644 index 0000000000..06c5137044 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-sequencepointinfoforforloop.html @@ -0,0 +1,128 @@ + + + + + SequencePointInfoForForLoop - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SequencePointInfoForForLoop

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + NoSequencePointAtForLoop + +
    + Signature:
    +
    +     		+ +
    + + SequencePointAtForLoop(range) + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforseq.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforseq.html new file mode 100644 index 0000000000..10af651520 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-sequencepointinfoforseq.html @@ -0,0 +1,141 @@ + + + + + SequencePointInfoForSeq - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SequencePointInfoForSeq

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + SequencePointsAtSeq + +
    + Signature:
    +
    +     		+ +
    + + SuppressSequencePointOnExprOfSequential + +
    + Signature:
    +
    +     		+ +
    + + SuppressSequencePointOnStmtOfSequential + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfofortarget.html b/docs/reference/fsharp-compiler-ast-sequencepointinfofortarget.html new file mode 100644 index 0000000000..8ed4fe1c96 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-sequencepointinfofortarget.html @@ -0,0 +1,128 @@ + + + + + SequencePointInfoForTarget - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SequencePointInfoForTarget

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + SequencePointAtTarget + +
    + Signature:
    +
    +     		+ +
    + + SuppressSequencePointAtTarget + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfofortry.html b/docs/reference/fsharp-compiler-ast-sequencepointinfofortry.html new file mode 100644 index 0000000000..cdc948c0ad --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-sequencepointinfofortry.html @@ -0,0 +1,141 @@ + + + + + SequencePointInfoForTry - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SequencePointInfoForTry

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + NoSequencePointAtTry + +
    + Signature:
    +
    +     		+ +
    + + SequencePointAtTry(range) + +
    + Signature: range
    +
    +     		+ +
    + + SequencePointInBodyOfTry + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforwhileloop.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforwhileloop.html new file mode 100644 index 0000000000..fa2b4bd399 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-sequencepointinfoforwhileloop.html @@ -0,0 +1,128 @@ + + + + + SequencePointInfoForWhileLoop - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SequencePointInfoForWhileLoop

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + NoSequencePointAtWhileLoop + +
    + Signature:
    +
    +     		+ +
    + + SequencePointAtWhileLoop(range) + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-sequencepointinfoforwith.html b/docs/reference/fsharp-compiler-ast-sequencepointinfoforwith.html new file mode 100644 index 0000000000..9e1ad031aa --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-sequencepointinfoforwith.html @@ -0,0 +1,128 @@ + + + + + SequencePointInfoForWith - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SequencePointInfoForWith

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + NoSequencePointAtWith + +
    + Signature:
    +
    +     		+ +
    + + SequencePointAtWith(range) + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synaccess.html b/docs/reference/fsharp-compiler-ast-synaccess.html new file mode 100644 index 0000000000..1c83167fdc --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synaccess.html @@ -0,0 +1,146 @@ + + + + + SynAccess - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynAccess

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Internal + +
    + Signature:
    +
    +     		+ +
    + + Private + +
    + Signature:
    +
    +     		+ +
    + + Public + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synarginfo.html b/docs/reference/fsharp-compiler-ast-synarginfo.html new file mode 100644 index 0000000000..35c051d4ff --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synarginfo.html @@ -0,0 +1,123 @@ + + + + + SynArgInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynArgInfo

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The argument names and other metadata for a parameter for a member or function

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynArgInfo(...) + +
    + Signature: SynAttributes * bool * Ident option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synargnamegenerator.html b/docs/reference/fsharp-compiler-ast-synargnamegenerator.html new file mode 100644 index 0000000000..8d8e29f372 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synargnamegenerator.html @@ -0,0 +1,150 @@ + + + + + SynArgNameGenerator - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynArgNameGenerator

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> SynArgNameGenerator
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.New() + +
    + Signature: unit -> string
    +
    +     		+ +
    + + x.Reset() + +
    + Signature: unit -> unit
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synattribute.html b/docs/reference/fsharp-compiler-ast-synattribute.html new file mode 100644 index 0000000000..0ed8125be2 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synattribute.html @@ -0,0 +1,178 @@ + + + + + SynAttribute - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynAttribute

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + AppliesToGetterAndSetter + +
    + Signature: bool
    +
    +     		+

    Is this attribute being applied to a property getter or setter?

    + + +
    + + ArgExpr + +
    + Signature: SynExpr
    +
    +     		+ +
    + + Range + +
    + Signature: range
    +
    +     		+ +
    + + Target + +
    + Signature: Ident option
    +
    +     		+

    Target specifier, e.g. "assembly", "module", etc.

    + + +
    + + TypeName + +
    + Signature: LongIdentWithDots
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synattributelist.html b/docs/reference/fsharp-compiler-ast-synattributelist.html new file mode 100644 index 0000000000..20715109b4 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synattributelist.html @@ -0,0 +1,130 @@ + + + + + SynAttributeList - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynAttributeList

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +

    List of attributes enclosed in [< ... >].

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Attributes + +
    + Signature: SynAttribute list
    +
    +     		+ +
    + + Range + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synattributes.html b/docs/reference/fsharp-compiler-ast-synattributes.html new file mode 100644 index 0000000000..bd7b0e07b0 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synattributes.html @@ -0,0 +1,194 @@ + + + + + SynAttributes - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynAttributes

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: SynAttributeList
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> SynAttributeList
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: SynAttributeList list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: SynAttributeList list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synbinding.html b/docs/reference/fsharp-compiler-ast-synbinding.html new file mode 100644 index 0000000000..0dced9d013 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synbinding.html @@ -0,0 +1,171 @@ + + + + + SynBinding - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynBinding

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + Binding(...) + +
    + Signature: SynAccess option * SynBindingKind * bool * bool * SynAttributes * PreXmlDoc * SynValData * SynPat * SynBindingReturnInfo option * SynExpr * range * SequencePointInfoForBinding
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.RangeOfBindingAndRhs + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_RangeOfBindingAndRhs

    +
    + + x.RangeOfBindingSansRhs + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_RangeOfBindingSansRhs

    +
    + + x.RangeOfHeadPat + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_RangeOfHeadPat

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synbindingkind.html b/docs/reference/fsharp-compiler-ast-synbindingkind.html new file mode 100644 index 0000000000..25e8576757 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synbindingkind.html @@ -0,0 +1,149 @@ + + + + + SynBindingKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynBindingKind

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +

    The kind associated with a binding - "let", "do" or a standalone expression

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + DoBinding + +
    + Signature:
    +
    +     		+

    A 'do' binding in a module. Must have type 'unit'

    + + +
    + + NormalBinding + +
    + Signature:
    +
    +     		+

    A normal 'let' binding in a module

    + + +
    + + StandaloneExpression + +
    + Signature:
    +
    +     		+

    A standalone expression in a module

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synbindingreturninfo.html b/docs/reference/fsharp-compiler-ast-synbindingreturninfo.html new file mode 100644 index 0000000000..fc3c1a746b --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synbindingreturninfo.html @@ -0,0 +1,121 @@ + + + + + SynBindingReturnInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynBindingReturnInfo

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynBindingReturnInfo(...) + +
    + Signature: SynType * range * SynAttributes
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syncomponentinfo.html b/docs/reference/fsharp-compiler-ast-syncomponentinfo.html new file mode 100644 index 0000000000..c72d1f99a2 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syncomponentinfo.html @@ -0,0 +1,149 @@ + + + + + SynComponentInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynComponentInfo

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The untyped, unchecked syntax tree associated with the name of a type definition or module +in signature or implementation.

    +

    This includes the name, attributes, type parameters, constraints, documentation and accessibility +for a type definition or module. For modules, entries such as the type parameters are +always empty.

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + ComponentInfo(...) + +
    + Signature: SynAttributes * SynTyparDecl list * SynTypeConstraint list * LongIdent * PreXmlDoc * bool * SynAccess option * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synconst.html b/docs/reference/fsharp-compiler-ast-synconst.html new file mode 100644 index 0000000000..3ca5517295 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synconst.html @@ -0,0 +1,451 @@ + + + + + SynConst - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynConst

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    The unchecked abstract syntax tree of constants in F# types and expressions.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Bool(bool) + +
    + Signature: bool
    +
    +     		+

    F# syntax: true, false

    + + +
    + + Byte(byte) + +
    + Signature: byte
    +
    +     		+

    F# syntax: 13uy, 0x40uy, 0oFFuy, 0b0111101uy

    + + +
    + + Bytes(bytes,range) + +
    + Signature: byte [] * range
    +
    +     		+

    F# syntax: verbatim or regular byte string, e.g. "abc"B.

    +

    Also used internally in the typechecker once an array of unit16 constants +is detected, to allow more efficient processing of large arrays of uint16 constants.

    + + +
    + + Char(char) + +
    + Signature: char
    +
    +     		+

    F# syntax: 'a'

    + + +
    + + Decimal(Decimal) + +
    + Signature: Decimal
    +
    +     		+

    F# syntax: 23.4M

    + + +
    + + Double(double) + +
    + Signature: double
    +
    +     		+

    F# syntax: 1.30, 1.40e10 etc.

    + + +
    + + Int16(int16) + +
    + Signature: int16
    +
    +     		+

    F# syntax: 13s, 0x4000s, 0o0777s, 0b0111101s

    + + +
    + + Int32(int32) + +
    + Signature: int32
    +
    +     		+

    F# syntax: 13, 0x4000, 0o0777

    + + +
    + + Int64(int64) + +
    + Signature: int64
    +
    +     		+

    F# syntax: 13L

    + + +
    + + IntPtr(int64) + +
    + Signature: int64
    +
    +     		+

    F# syntax: 13n

    + + +
    + + Measure(constant,SynMeasure) + +
    + Signature: SynConst * SynMeasure
    +
    +     		+

    Old comment: "we never iterate, so the const here is not another SynConst.Measure"

    + + +
    + + SByte(sbyte) + +
    + Signature: sbyte
    +
    +     		+

    F# syntax: 13y, 0xFFy, 0o077y, 0b0111101y

    + + +
    + + Single(single) + +
    + Signature: single
    +
    +     		+

    F# syntax: 1.30f, 1.40e10f etc.

    + + +
    + + String(text,range) + +
    + Signature: string * range
    +
    +     		+

    F# syntax: verbatim or regular string, e.g. "abc"

    + + +
    + + UInt16(uint16) + +
    + Signature: uint16
    +
    +     		+

    F# syntax: 13us, 0x4000us, 0o0777us, 0b0111101us

    + + +
    + + UInt16s(uint16 []) + +
    + Signature: uint16 []
    +
    +     		+

    Used internally in the typechecker once an array of unit16 constants +is detected, to allow more efficient processing of large arrays of uint16 constants.

    + + +
    + + UInt32(uint32) + +
    + Signature: uint32
    +
    +     		+

    F# syntax: 13u, 0x4000u, 0o0777u

    + + +
    + + UInt64(uint64) + +
    + Signature: uint64
    +
    +     		+

    F# syntax: 13UL

    + + +
    + + UIntPtr(uint64) + +
    + Signature: uint64
    +
    +     		+

    F# syntax: 13un

    + + +
    + + Unit + +
    + Signature:
    +
    +     		+

    F# syntax: ()

    + + +
    + + UserNum(value,suffix) + +
    + Signature: string * string
    +
    +     		+

    UserNum(value, suffix)

    +

    F# syntax: 1Q, 1Z, 1R, 1N, 1G

    + + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range(dflt) + +
    + Signature: dflt:range -> range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synconstructorargs.html b/docs/reference/fsharp-compiler-ast-synconstructorargs.html new file mode 100644 index 0000000000..33239039fe --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synconstructorargs.html @@ -0,0 +1,128 @@ + + + + + SynConstructorArgs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynConstructorArgs

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + NamePatPairs(...) + +
    + Signature: (Ident * SynPat) list * range
    +
    +     		+ +
    + + Pats(SynPat list) + +
    + Signature: SynPat list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synenumcase.html b/docs/reference/fsharp-compiler-ast-synenumcase.html new file mode 100644 index 0000000000..80d56231d8 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synenumcase.html @@ -0,0 +1,145 @@ + + + + + SynEnumCase - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynEnumCase

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + EnumCase(...) + +
    + Signature: SynAttributes * Ident * SynConst * PreXmlDoc * range
    +
    +     		+

    The untyped, unchecked syntax tree for one case in an enum definition.

    + + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synenumcases.html b/docs/reference/fsharp-compiler-ast-synenumcases.html new file mode 100644 index 0000000000..003257d4c7 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synenumcases.html @@ -0,0 +1,194 @@ + + + + + SynEnumCases - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynEnumCases

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: SynEnumCase
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> SynEnumCase
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: SynEnumCase list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: SynEnumCase list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synexceptiondefn.html b/docs/reference/fsharp-compiler-ast-synexceptiondefn.html new file mode 100644 index 0000000000..d3da40f311 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synexceptiondefn.html @@ -0,0 +1,145 @@ + + + + + SynExceptionDefn - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynExceptionDefn

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    'exception E = ... with ...'

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynExceptionDefn(...) + +
    + Signature: SynExceptionDefnRepr * SynMemberDefns * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synexceptiondefnrepr.html b/docs/reference/fsharp-compiler-ast-synexceptiondefnrepr.html new file mode 100644 index 0000000000..67bfc354b9 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synexceptiondefnrepr.html @@ -0,0 +1,145 @@ + + + + + SynExceptionDefnRepr - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynExceptionDefnRepr

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    'exception E = ... '

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynExceptionDefnRepr(...) + +
    + Signature: SynAttributes * SynUnionCase * LongIdent option * PreXmlDoc * SynAccess option * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synexceptionsig.html b/docs/reference/fsharp-compiler-ast-synexceptionsig.html new file mode 100644 index 0000000000..7e3bdb3f4d --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synexceptionsig.html @@ -0,0 +1,121 @@ + + + + + SynExceptionSig - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynExceptionSig

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynExceptionSig(...) + +
    + Signature: SynExceptionDefnRepr * SynMemberSigs * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synexpr.html b/docs/reference/fsharp-compiler-ast-synexpr.html new file mode 100644 index 0000000000..a66cf3fb9b --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synexpr.html @@ -0,0 +1,1154 @@ + + + + + SynExpr - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynExpr

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AddressOf(isByref,SynExpr,range,range) + +
    + Signature: bool * SynExpr * range * range
    +
    +     		+

    F# syntax: &expr, &&expr

    + + +
    + + AnonRecd(...) + +
    + Signature: bool * (SynExpr * BlockSeparator) option * (Ident * SynExpr) list * range
    +
    +     		+

    F# syntax: {| id1=e1; ...; idN=eN |} +F# syntax: struct {| id1=e1; ...; idN=eN |}

    + + +
    + + App(...) + +
    + Signature: ExprAtomicFlag * bool * SynExpr * SynExpr * range
    +
    +     		+

    App(exprAtomicFlag, isInfix, funcExpr, argExpr, m) +- exprAtomicFlag: indicates if the application is syntactically atomic, e.g. f.[1] is atomic, but 'f x' is not +- isInfix is true for the first app of an infix operator, e.g. 1+2 becomes App(App(+, 1), 2), where the inner node is marked isInfix +(or more generally, for higher operator fixities, if App(x, y) is such that y comes before x in the source code, then the node is marked isInfix=true)

    +

    F# syntax: f x

    + + +
    + + ArbitraryAfterError(debugStr,range) + +
    + Signature: string * range
    +
    +     		+

    Inserted for error recovery

    + + +
    + + ArrayOrList(isList,exprs,range) + +
    + Signature: bool * SynExpr list * range
    +
    +     		+

    F# syntax: [ e1; ...; en ], [| e1; ...; en |]

    + + +
    + + ArrayOrListOfSeqExpr(isArray,expr,range) + +
    + Signature: bool * SynExpr * range
    +
    +     		+

    F# syntax: [ expr ], [| expr |]

    + + +
    + + Assert(expr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    F# syntax: assert expr

    + + +
    + + CompExpr(...) + +
    + Signature: bool * bool ref * SynExpr * range
    +
    +     		+

    CompExpr(isArrayOrList, isNotNakedRefCell, expr)

    +

    F# syntax: { expr }

    + + +
    + + Const(constant,range) + +
    + Signature: SynConst * range
    +
    +     		+

    F# syntax: 1, 1.3, () etc.

    + + +
    + + DiscardAfterMissingQualificationAfterDot(...) + +
    + Signature: SynExpr * range
    +
    +     		+

    Inserted for error recovery when there is "expr." and missing tokens or error recovery after the dot

    + + +
    + + Do(expr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    F# syntax: do expr

    + + +
    + + DoBang(expr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    F# syntax: do! expr +Computation expressions only

    + + +
    + + DotGet(expr,rangeOfDot,longDotId,range) + +
    + Signature: SynExpr * range * LongIdentWithDots * range
    +
    +     		+

    DotGet(expr, rangeOfDot, lid, wholeRange)

    +

    F# syntax: expr.ident.ident

    + + +
    + + DotIndexedGet(...) + +
    + Signature: SynExpr * SynIndexerArg list * range * range
    +
    +     		+

    F# syntax: expr.[expr, ..., expr]

    + + +
    + + DotIndexedSet(...) + +
    + Signature: SynExpr * SynIndexerArg list * SynExpr * range * range * range
    +
    +     		+

    DotIndexedSet (objectExpr, indexExprs, valueExpr, rangeOfLeftOfSet, rangeOfDot, rangeOfWholeExpr)

    +

    F# syntax: expr.[expr, ..., expr] <- expr

    + + +
    + + DotNamedIndexedPropertySet(...) + +
    + Signature: SynExpr * LongIdentWithDots * SynExpr * SynExpr * range
    +
    +     		+

    F# syntax: Expr.Items (e1) <- e2, rarely used named-property-setter notation, e.g. (stringExpr).Chars(3) <- 'a'

    + + +
    + + DotSet(SynExpr,longDotId,SynExpr,range) + +
    + Signature: SynExpr * LongIdentWithDots * SynExpr * range
    +
    +     		+

    F# syntax: expr.ident...ident <- expr

    + + +
    + + Downcast(expr,typeName,range) + +
    + Signature: SynExpr * SynType * range
    +
    +     		+

    F# syntax: expr :?> type

    + + +
    + + Fixed(expr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    'use x = fixed expr'

    + + +
    + + For(...) + +
    + Signature: SequencePointInfoForForLoop * Ident * SynExpr * bool * SynExpr * SynExpr * range
    +
    +     		+

    F# syntax: 'for i = ... to ... do ...'

    + + +
    + + ForEach(...) + +
    + Signature: SequencePointInfoForForLoop * SeqExprOnly * bool * SynPat * SynExpr * SynExpr * range
    +
    +     		+

    SynExpr.ForEach (spBind, seqExprOnly, isFromSource, pat, enumExpr, bodyExpr, mWholeExpr).

    +

    F# syntax: 'for ... in ... do ...'

    + + +
    + + FromParseError(expr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    Inserted for error recovery

    + + +
    + + Ident(Ident) + +
    + Signature: Ident
    +
    +     		+

    F# syntax: ident +Optimized representation, = SynExpr.LongIdent (false, [id], id.idRange)

    + + +
    + + IfThenElse(...) + +
    + Signature: SynExpr * SynExpr * SynExpr option * SequencePointInfoForBinding * bool * range * range
    +
    +     		+

    IfThenElse(exprGuard, exprThen, optionalExprElse, spIfToThen, isFromErrorRecovery, mIfToThen, mIfToEndOfLastBranch)

    +

    F# syntax: if expr then expr +F# syntax: if expr then expr else expr

    + + +
    + + ImplicitZero(range) + +
    + Signature: range
    +
    +     		+

    Used in parser error recovery and internally during type checking for translating computation expressions.

    + + +
    + + InferredDowncast(expr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    F# syntax: downcast expr

    + + +
    + + InferredUpcast(expr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    F# syntax: upcast expr

    + + +
    + + JoinIn(SynExpr,range,SynExpr,range) + +
    + Signature: SynExpr * range * SynExpr * range
    +
    +     		+

    F# syntax: ... in ... +Computation expressions only, based on JOIN_IN token from lex filter

    + + +
    + + Lambda(...) + +
    + Signature: bool * bool * SynSimplePats * SynExpr * range
    +
    +     		+

    First bool indicates if lambda originates from a method. Patterns here are always "simple" +Second bool indicates if this is a "later" part of an iterated sequence of lambdas

    +

    F# syntax: fun pat -> expr

    + + +
    + + Lazy(SynExpr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    F# syntax: lazy expr

    + + +
    + + LetOrUse(...) + +
    + Signature: bool * bool * SynBinding list * SynExpr * range
    +
    +     		+

    LetOrUse(isRecursive, isUse, bindings, body, wholeRange)

    +

    F# syntax: let pat = expr in expr +F# syntax: let f pat1 .. patN = expr in expr +F# syntax: let rec f pat1 .. patN = expr in expr +F# syntax: use pat = expr in expr

    + + +
    + + LetOrUseBang(...) + +
    + Signature: SequencePointInfoForBinding * bool * bool * SynPat * SynExpr * (SequencePointInfoForBinding * bool * bool * SynPat * SynExpr * range) list * SynExpr * range
    +
    +     		+

    SynExpr.LetOrUseAndBang (spBind, isUse, isFromSource, pat, rhsExpr, mLetBangExpr, [(andBangSpBind, andBangIsUse, andBangIsFromSource, andBangPat, andBangRhsExpr, mAndBangExpr)], bodyExpr).

    +

    F# syntax: let! pat = expr in expr +F# syntax: use! pat = expr in expr +F# syntax: let! pat = expr and! ... and! ... and! pat = expr in expr +Computation expressions only

    + + +
    + + LibraryOnlyILAssembly(...) + +
    + Signature: ILInstr array * SynType list * SynExpr list * SynType list * range
    +
    +     		+

    Only used in FSharp.Core

    + + +
    + + LibraryOnlyStaticOptimization(...) + +
    + Signature: SynStaticOptimizationConstraint list * SynExpr * SynExpr * range
    +
    +     		+

    Only used in FSharp.Core

    + + +
    + + LibraryOnlyUnionCaseFieldGet(...) + +
    + Signature: SynExpr * LongIdent * int * range
    +
    +     		+

    Only used in FSharp.Core

    + + +
    + + LibraryOnlyUnionCaseFieldSet(...) + +
    + Signature: SynExpr * LongIdent * int * SynExpr * range
    +
    +     		+

    Only used in FSharp.Core

    + + +
    + + LongIdent(...) + +
    + Signature: bool * LongIdentWithDots * SynSimplePatAlternativeIdInfo ref option * range
    +
    +     		+

    F# syntax: ident.ident...ident +LongIdent(isOptional, longIdent, altNameRefCell, m) +isOptional: true if preceded by a '?' for an optional named parameter +altNameRefCell: Normally 'None' except for some compiler-generated variables in desugaring pattern matching. See SynSimplePat.Id

    + + +
    + + LongIdentSet(longDotId,expr,range) + +
    + Signature: LongIdentWithDots * SynExpr * range
    +
    +     		+

    F# syntax: ident.ident...ident <- expr

    + + +
    + + Match(matchSeqPoint,expr,clauses,range) + +
    + Signature: SequencePointInfoForBinding * SynExpr * SynMatchClause list * range
    +
    +     		+

    F# syntax: match expr with pat1 -> expr | ... | patN -> exprN

    + + +
    + + MatchBang(...) + +
    + Signature: SequencePointInfoForBinding * SynExpr * SynMatchClause list * range
    +
    +     		+

    F# syntax: match! expr with pat1 -> expr | ... | patN -> exprN

    + + +
    + + MatchLambda(...) + +
    + Signature: bool * range * SynMatchClause list * SequencePointInfoForBinding * range
    +
    +     		+

    F# syntax: function pat1 -> expr | ... | patN -> exprN

    + + +
    + + NamedIndexedPropertySet(...) + +
    + Signature: LongIdentWithDots * SynExpr * SynExpr * range
    +
    +     		+

    F# syntax: Type.Items(e1) <- e2, rarely used named-property-setter notation, e.g. Foo.Bar.Chars(3) <- 'a'

    + + +
    + + New(isProtected,typeName,expr,range) + +
    + Signature: bool * SynType * SynExpr * range
    +
    +     		+

    F# syntax: new C(...) +The flag is true if known to be 'family' ('protected') scope

    + + +
    + + Null(range) + +
    + Signature: range
    +
    +     		+

    F# syntax: null

    + + +
    + + ObjExpr(...) + +
    + Signature: SynType * (SynExpr * Ident option) option * SynBinding list * SynInterfaceImpl list * range * range
    +
    +     		+

    SynExpr.ObjExpr (objTy, argOpt, binds, extraImpls, mNewExpr, mWholeExpr)

    +

    F# syntax: { new ... with ... }

    + + +
    + + Paren(...) + +
    + Signature: SynExpr * range * range option * range
    +
    +     		+

    F# syntax: (expr)

    +

    Paren(expr, leftParenRange, rightParenRange, wholeRangeIncludingParentheses)

    +

    Parenthesized expressions. Kept in AST to distinguish A.M((x, y)) +from A.M(x, y), among other things.

    + + +
    + + Quote(...) + +
    + Signature: SynExpr * bool * SynExpr * bool * range
    +
    +     		+

    F# syntax: <@ expr @>, <@@ expr @@>

    +

    Quote(operator, isRaw, quotedSynExpr, isFromQueryExpression, m)

    + + +
    + + Record(...) + +
    + Signature: (SynType * SynExpr * range * BlockSeparator option * range) option * (SynExpr * BlockSeparator) option * (RecordFieldName * SynExpr option * BlockSeparator option) list * range
    +
    +     		+

    F# syntax: { f1=e1; ...; fn=en } +SynExpr.Record ((baseType, baseCtorArgs, mBaseCtor, sepAfterBase, mInherits), (copyExpr, sepAfterCopyExpr), (recordFieldName, fieldValue, sepAfterField), mWholeExpr) +inherit includes location of separator (for tooling) +copyOpt contains range of the following WITH part (for tooling) +every field includes range of separator after the field (for tooling)

    + + +
    + + Sequential(...) + +
    + Signature: SequencePointInfoForSeq * bool * SynExpr * SynExpr * range
    +
    +     		+

    Sequential(seqPoint, isTrueSeq, e1, e2, m) +isTrueSeq: false indicates "let v = a in b; v"

    +

    F# syntax: expr; expr

    + + +
    + + SequentialOrImplicitYield(...) + +
    + Signature: SequencePointInfoForSeq * SynExpr * SynExpr * SynExpr * range
    +
    +     		+

    Used internally during type checking for translating computation expressions.

    + + +
    + + Set(SynExpr,SynExpr,range) + +
    + Signature: SynExpr * SynExpr * range
    +
    +     		+

    F# syntax: expr <- expr

    + + +
    + + TraitCall(...) + +
    + Signature: SynTypar list * SynMemberSig * SynExpr * range
    +
    +     		+

    F# syntax: ((typar1 or ... or typarN): (member-dig) expr)

    + + +
    + + TryFinally(...) + +
    + Signature: SynExpr * SynExpr * range * SequencePointInfoForTry * SequencePointInfoForFinally
    +
    +     		+

    F# syntax: try expr finally expr

    + + +
    + + TryWith(...) + +
    + Signature: SynExpr * range * SynMatchClause list * range * range * SequencePointInfoForTry * SequencePointInfoForWith
    +
    +     		+

    F# syntax: try expr with pat -> expr

    + + +
    + + Tuple(isStruct,exprs,commaRanges,range) + +
    + Signature: bool * SynExpr list * range list * range
    +
    +     		+

    F# syntax: e1, ..., eN

    + + +
    + + TypeApp(...) + +
    + Signature: SynExpr * range * SynType list * range list * range option * range * range
    +
    +     		+

    TypeApp(expr, mLessThan, types, mCommas, mGreaterThan, mTypeArgs, mWholeExpr) +"mCommas" are the ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them

    +

    F# syntax: expr

    + + +
    + + Typed(expr,typeName,range) + +
    + Signature: SynExpr * SynType * range
    +
    +     		+

    F# syntax: expr: type

    + + +
    + + TypeTest(expr,typeName,range) + +
    + Signature: SynExpr * SynType * range
    +
    +     		+

    F# syntax: expr :? type

    + + +
    + + Upcast(expr,typeName,range) + +
    + Signature: SynExpr * SynType * range
    +
    +     		+

    F# syntax: expr :> type

    + + +
    + + While(...) + +
    + Signature: SequencePointInfoForWhileLoop * SynExpr * SynExpr * range
    +
    +     		+

    F# syntax: 'while ... do ...'

    + + +
    + + YieldOrReturn(bool * bool,expr,range) + +
    + Signature: bool * bool * SynExpr * range
    +
    +     		+

    F# syntax: yield expr +F# syntax: return expr +Computation expressions only

    + + +
    + + YieldOrReturnFrom(...) + +
    + Signature: bool * bool * SynExpr * range
    +
    +     		+

    F# syntax: yield! expr +F# syntax: return! expr +Computation expressions only

    + + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.IsArbExprAndThusAlreadyReportedError + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsArbExprAndThusAlreadyReportedError

    +
    + + x.Range + +
    + Signature: range
    +
    +     		+

    Get the syntactic range of source code covered by this construct.

    + + +

    CompiledName: get_Range

    +
    + + x.RangeOfFirstPortion + +
    + Signature: range
    +
    +     		+

    Attempt to get the range of the first token or initial portion only - this is extremely ad-hoc, just a cheap way to improve a certain 'query custom operation' error range

    + + +

    CompiledName: get_RangeOfFirstPortion

    +
    + + x.RangeSansAnyExtraDot + +
    + Signature: range
    +
    +     		+

    range ignoring any (parse error) extra trailing dots

    + + +

    CompiledName: get_RangeSansAnyExtraDot

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synfield.html b/docs/reference/fsharp-compiler-ast-synfield.html new file mode 100644 index 0000000000..755092c9b0 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synfield.html @@ -0,0 +1,123 @@ + + + + + SynField - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynField

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The untyped, unchecked syntax tree for a field declaration in a record or class

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + Field(...) + +
    + Signature: SynAttributes * bool * Ident option * SynType * bool * PreXmlDoc * SynAccess option * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synfields.html b/docs/reference/fsharp-compiler-ast-synfields.html new file mode 100644 index 0000000000..496b9ef80d --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synfields.html @@ -0,0 +1,194 @@ + + + + + SynFields - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynFields

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: SynField
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> SynField
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: SynField list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: SynField list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synindexerarg.html b/docs/reference/fsharp-compiler-ast-synindexerarg.html new file mode 100644 index 0000000000..2ab2d24478 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synindexerarg.html @@ -0,0 +1,171 @@ + + + + + SynIndexerArg - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynIndexerArg

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + One(SynExpr,fromEnd,range) + +
    + Signature: SynExpr * bool * range
    +
    +     		+ +
    + + Two(...) + +
    + Signature: SynExpr * bool * SynExpr * bool * range * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Exprs + +
    + Signature: SynExpr list
    +
    +     		+ +

    CompiledName: get_Exprs

    +
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syninfo.html b/docs/reference/fsharp-compiler-ast-syninfo.html new file mode 100644 index 0000000000..6a66dc9ea1 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syninfo.html @@ -0,0 +1,458 @@ + + + + + SynInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynInfo

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Ast +

    +
    +

    Operations related to the syntactic analysis of arguments of value, function and member definitions and signatures.

    +

    Function and member definitions have strongly syntactically constrained arities. We infer +the arity from the syntax.

    +

    For example, we record the arity for: +StaticProperty --> [1] -- for unit arg +this.InstanceProperty --> [1;1] -- for unit arg +StaticMethod(args) --> map InferSynArgInfoFromSimplePat args +this.InstanceMethod() --> 1 :: map InferSynArgInfoFromSimplePat args +this.InstanceProperty with get(argpat) --> 1 :: [InferSynArgInfoFromSimplePat argpat] +StaticProperty with get(argpat) --> [InferSynArgInfoFromSimplePat argpat] +this.InstanceProperty with get() --> 1 :: [InferSynArgInfoFromSimplePat argpat] +StaticProperty with get() --> [InferSynArgInfoFromSimplePat argpat]

    +

    this.InstanceProperty with set(argpat)(v) --> 1 :: [InferSynArgInfoFromSimplePat argpat; 1] +StaticProperty with set(argpat)(v) --> [InferSynArgInfoFromSimplePat argpat; 1] +this.InstanceProperty with set(v) --> 1 :: [1] +StaticProperty with set(v) --> [1]

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + AdjustArgsForUnitElimination(...) + +
    + Signature: infosForArgs:SynArgInfo list list -> SynArgInfo list list
    +
    +     		+

    Make sure only a solitary unit argument has unit elimination

    + + +
    + + AdjustMemberArgs memFlags infosForArgs + +
    + Signature: memFlags:MemberKind -> infosForArgs:'a list list -> 'a list list
    + Type parameters: 'a
    +     		+

    Transform a property declared using '[static] member P = expr' to a method taking a "unit" argument. +This is similar to IncorporateEmptyTupledArgForPropertyGetter, but applies to member definitions +rather than member signatures.

    + + +
    + + AritiesOfArgs(arg1) + +
    + Signature: SynValInfo -> int list
    +
    +     		+

    Get the argument counts for each curried argument group. Used in some adhoc places in tc.fs.

    + + +
    + + AttribsOfArgData(arg1) + +
    + Signature: SynArgInfo -> SynAttribute list
    +
    +     		+

    Get the argument attributes from the syntactic information for an argument.

    + + +
    + + emptySynValData + +
    + Signature: SynValData
    +
    +     		+ +
    + + HasNoArgs(arg1) + +
    + Signature: SynValInfo -> bool
    +
    +     		+

    Determine if a syntactic information represents a member without arguments (which is implicitly a property getter)

    + + +
    + + HasOptionalArgs(arg1) + +
    + Signature: SynValInfo -> bool
    +
    +     		+

    Check if there are any optional arguments in the syntactic argument information. Used when adjusting the +types of optional arguments for function and member signatures.

    + + +
    + + IncorporateEmptyTupledArgForPropertyGetter(...) + +
    + Signature: SynValInfo -> SynValInfo
    +
    +     		+

    Add a parameter entry to the syntactic value information to represent the '()' argument to a property getter. This is +used for the implicit '()' argument in property getter signature specifications.

    + + +
    + + IncorporateSelfArg(arg1) + +
    + Signature: SynValInfo -> SynValInfo
    +
    +     		+

    Add a parameter entry to the syntactic value information to represent the 'this' argument. This is +used for the implicit 'this' argument in member signature specifications.

    + + +
    + + IncorporateSetterArg(arg1) + +
    + Signature: SynValInfo -> SynValInfo
    +
    +     		+

    Add a parameter entry to the syntactic value information to represent the value argument for a property setter. This is +used for the implicit value argument in property setter signature specifications.

    + + +
    + + InferLambdaArgs(origRhsExpr) + +
    + Signature: origRhsExpr:SynExpr -> SynArgInfo list list
    +
    +     		+

    For 'let' definitions, we infer syntactic argument information from the r.h.s. of a definition, if it +is an immediate 'fun ... -> ...' or 'function ...' expression. This is noted in the F# language specification. +This does not apply to member definitions.

    + + +
    + + InferSynArgInfoFromPat(p) + +
    + Signature: p:SynPat -> SynArgInfo list
    +
    +     		+

    Infer the syntactic argument info for one or more arguments a pattern.

    + + +
    + + InferSynArgInfoFromSimplePat attribs p + +
    + Signature: attribs:SynAttributes -> p:SynSimplePat -> SynArgInfo
    +
    +     		+

    Infer the syntactic argument info for a single argument from a simple pattern.

    + + +
    + + InferSynArgInfoFromSimplePats(x) + +
    + Signature: x:SynSimplePats -> SynArgInfo list
    +
    +     		+

    Infer the syntactic argument info for one or more arguments one or more simple patterns.

    + + +
    + + InferSynReturnData(retInfo) + +
    + Signature: retInfo:SynReturnInfo option -> SynArgInfo
    +
    +     		+ +
    + + InferSynValData(...) + +
    + Signature: (memberFlagsOpt:MemberFlags option * pat:SynPat option * retInfo:SynReturnInfo option * origRhsExpr:SynExpr) -> SynValData
    +
    +     		+

    Infer the syntactic information for a 'let' or 'member' definition, based on the argument pattern, +any declared return information (e.g. .NET attributes on the return element), and the r.h.s. expression +in the case of 'let' definitions.

    + + +
    + + IsOptionalArg(arg1) + +
    + Signature: SynArgInfo -> bool
    +
    +     		+

    Check if one particular argument is an optional argument. Used when adjusting the +types of optional arguments for function and member signatures.

    + + +
    + + selfMetadata + +
    + Signature: SynArgInfo list
    +
    +     		+

    The 'argument' information for the 'this'/'self' parameter in the cases where it is not given explicitly

    + + +
    + + unitArgData + +
    + Signature: SynArgInfo list
    +
    +     		+

    The argument information for a '()' argument

    + + +
    + + unnamedRetVal + +
    + Signature: SynArgInfo
    +
    +     		+

    The 'argument' information for a return value where no attributes are given for the return value (the normal case)

    + + +
    + + unnamedTopArg + +
    + Signature: SynArgInfo list
    +
    +     		+

    The argument information for a curried argument without a name

    + + +
    + + unnamedTopArg1 + +
    + Signature: SynArgInfo
    +
    +     		+

    The argument information for an argument without a name

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syninterfaceimpl.html b/docs/reference/fsharp-compiler-ast-syninterfaceimpl.html new file mode 100644 index 0000000000..2cd81d443c --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syninterfaceimpl.html @@ -0,0 +1,121 @@ + + + + + SynInterfaceImpl - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynInterfaceImpl

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + InterfaceImpl(...) + +
    + Signature: SynType * SynBinding list * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmatchclause.html b/docs/reference/fsharp-compiler-ast-synmatchclause.html new file mode 100644 index 0000000000..c34e928852 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmatchclause.html @@ -0,0 +1,157 @@ + + + + + SynMatchClause - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynMatchClause

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + Clause(...) + +
    + Signature: SynPat * SynExpr option * SynExpr * range * SequencePointInfoForTarget
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + + x.RangeOfGuardAndRhs + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_RangeOfGuardAndRhs

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmeasure.html b/docs/reference/fsharp-compiler-ast-synmeasure.html new file mode 100644 index 0000000000..748e7bdbb3 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmeasure.html @@ -0,0 +1,216 @@ + + + + + SynMeasure - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynMeasure

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    The unchecked abstract syntax tree of F# unit of measure annotations. +This should probably be merged with the representation of SynType.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Anon(range) + +
    + Signature: range
    +
    +     		+ +
    + + Divide(SynMeasure,SynMeasure,range) + +
    + Signature: SynMeasure * SynMeasure * range
    +
    +     		+ +
    + + Named(longId,range) + +
    + Signature: LongIdent * range
    +
    +     		+ +
    + + One + +
    + Signature:
    +
    +     		+ +
    + + Power(SynMeasure,SynRationalConst,range) + +
    + Signature: SynMeasure * SynRationalConst * range
    +
    +     		+ +
    + + Product(SynMeasure,SynMeasure,range) + +
    + Signature: SynMeasure * SynMeasure * range
    +
    +     		+ +
    + + Seq(SynMeasure list,range) + +
    + Signature: SynMeasure list * range
    +
    +     		+ +
    + + Var(SynTypar,range) + +
    + Signature: SynTypar * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmemberdefn.html b/docs/reference/fsharp-compiler-ast-synmemberdefn.html new file mode 100644 index 0000000000..cc6dd766a0 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmemberdefn.html @@ -0,0 +1,286 @@ + + + + + SynMemberDefn - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynMemberDefn

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AbstractSlot(...) + +
    + Signature: SynValSig * MemberFlags * range
    +
    +     		+ +
    + + AutoProperty(...) + +
    + Signature: SynAttributes * bool * Ident * SynType option * MemberKind * MemberKind -> MemberFlags * PreXmlDoc * SynAccess option * SynExpr * range option * range
    +
    +     		+

    SynMemberDefn.AutoProperty (attribs, isStatic, id, tyOpt, propKind, memberFlags, xmlDoc, access, synExpr, mGetSet, mWholeAutoProp).

    +

    F# syntax: 'member val X = expr'

    + + +
    + + ImplicitCtor(...) + +
    + Signature: SynAccess option * SynAttributes * SynSimplePats * Ident option * range
    +
    +     		+

    implicit ctor args as a defn line, 'as' specification

    + + +
    + + ImplicitInherit(...) + +
    + Signature: SynType * SynExpr * Ident option * range
    +
    +     		+

    inherit (args...) as base

    + + +
    + + Inherit(SynType,Ident option,range) + +
    + Signature: SynType * Ident option * range
    +
    +     		+ +
    + + Interface(...) + +
    + Signature: SynType * SynMemberDefns option * range
    +
    +     		+ +
    + + LetBindings(...) + +
    + Signature: SynBinding list * bool * bool * range
    +
    +     		+

    LetBindings(bindingList, isStatic, isRecursive, wholeRange)

    +

    localDefns

    + + +
    + + Member(memberDefn,range) + +
    + Signature: SynBinding * range
    +
    +     		+ +
    + + NestedType(typeDefn,accessibility,range) + +
    + Signature: SynTypeDefn * SynAccess option * range
    +
    +     		+

    A feature that is not implemented

    + + +
    + + Open(longId,range) + +
    + Signature: LongIdent * range
    +
    +     		+ +
    + + ValField(SynField,range) + +
    + Signature: SynField * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmemberdefns.html b/docs/reference/fsharp-compiler-ast-synmemberdefns.html new file mode 100644 index 0000000000..ec67ef6b14 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmemberdefns.html @@ -0,0 +1,194 @@ + + + + + SynMemberDefns - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynMemberDefns

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: SynMemberDefn
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> SynMemberDefn
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: SynMemberDefn list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: SynMemberDefn list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmembersig.html b/docs/reference/fsharp-compiler-ast-synmembersig.html new file mode 100644 index 0000000000..ca0dcc2f9a --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmembersig.html @@ -0,0 +1,177 @@ + + + + + SynMemberSig - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynMemberSig

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    The untyped, unchecked syntax tree for a member signature, used in signature files, abstract member declarations +and member constraints.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Inherit(typeName,range) + +
    + Signature: SynType * range
    +
    +     		+ +
    + + Interface(typeName,range) + +
    + Signature: SynType * range
    +
    +     		+ +
    + + Member(SynValSig,MemberFlags,range) + +
    + Signature: SynValSig * MemberFlags * range
    +
    +     		+ +
    + + NestedType(SynTypeDefnSig,range) + +
    + Signature: SynTypeDefnSig * range
    +
    +     		+ +
    + + ValField(SynField,range) + +
    + Signature: SynField * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmembersigs.html b/docs/reference/fsharp-compiler-ast-synmembersigs.html new file mode 100644 index 0000000000..78dc51c532 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmembersigs.html @@ -0,0 +1,194 @@ + + + + + SynMemberSigs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynMemberSigs

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: SynMemberSig
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> SynMemberSig
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: SynMemberSig list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: SynMemberSig list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmoduledecl.html b/docs/reference/fsharp-compiler-ast-synmoduledecl.html new file mode 100644 index 0000000000..3a90c753b6 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmoduledecl.html @@ -0,0 +1,261 @@ + + + + + SynModuleDecl - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynModuleDecl

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Attributes(SynAttributes,range) + +
    + Signature: SynAttributes * range
    +
    +     		+ +
    + + DoExpr(...) + +
    + Signature: SequencePointInfoForBinding * SynExpr * range
    +
    +     		+ +
    + + Exception(SynExceptionDefn,range) + +
    + Signature: SynExceptionDefn * range
    +
    +     		+ +
    + + HashDirective(ParsedHashDirective,range) + +
    + Signature: ParsedHashDirective * range
    +
    +     		+ +
    + + Let(isRecursive,SynBinding list,range) + +
    + Signature: bool * SynBinding list * range
    +
    +     		+ +
    + + ModuleAbbrev(ident,longId,range) + +
    + Signature: Ident * LongIdent * range
    +
    +     		+ +
    + + NamespaceFragment(SynModuleOrNamespace) + +
    + Signature: SynModuleOrNamespace
    +
    +     		+ +
    + + NestedModule(...) + +
    + Signature: SynComponentInfo * bool * SynModuleDecls * bool * range
    +
    +     		+ +
    + + Open(longDotId,range) + +
    + Signature: LongIdentWithDots * range
    +
    +     		+ +
    + + Types(SynTypeDefn list,range) + +
    + Signature: SynTypeDefn list * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmoduledecls.html b/docs/reference/fsharp-compiler-ast-synmoduledecls.html new file mode 100644 index 0000000000..b7572684c3 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmoduledecls.html @@ -0,0 +1,194 @@ + + + + + SynModuleDecls - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynModuleDecls

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: SynModuleDecl
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> SynModuleDecl
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: SynModuleDecl list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: SynModuleDecl list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmoduleornamespace.html b/docs/reference/fsharp-compiler-ast-synmoduleornamespace.html new file mode 100644 index 0000000000..a1ad6d66fa --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmoduleornamespace.html @@ -0,0 +1,143 @@ + + + + + SynModuleOrNamespace - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynModuleOrNamespace

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynModuleOrNamespace(...) + +
    + Signature: LongIdent * bool * SynModuleOrNamespaceKind * SynModuleDecls * PreXmlDoc * SynAttributes * SynAccess option * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmoduleornamespacekind.html b/docs/reference/fsharp-compiler-ast-synmoduleornamespacekind.html new file mode 100644 index 0000000000..c873bd85f1 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmoduleornamespacekind.html @@ -0,0 +1,181 @@ + + + + + SynModuleOrNamespaceKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynModuleOrNamespaceKind

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<Struct>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AnonModule + +
    + Signature:
    +
    +     		+ +
    + + DeclaredNamespace + +
    + Signature:
    +
    +     		+ +
    + + GlobalNamespace + +
    + Signature:
    +
    +     		+ +
    + + NamedModule + +
    + Signature:
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.IsModule + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsModule

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmoduleornamespacesig.html b/docs/reference/fsharp-compiler-ast-synmoduleornamespacesig.html new file mode 100644 index 0000000000..7957e0d8e5 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmoduleornamespacesig.html @@ -0,0 +1,121 @@ + + + + + SynModuleOrNamespaceSig - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynModuleOrNamespaceSig

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynModuleOrNamespaceSig(...) + +
    + Signature: LongIdent * bool * SynModuleOrNamespaceKind * SynModuleSigDecls * PreXmlDoc * SynAttributes * SynAccess option * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmodulesigdecl.html b/docs/reference/fsharp-compiler-ast-synmodulesigdecl.html new file mode 100644 index 0000000000..5bf01d93c0 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmodulesigdecl.html @@ -0,0 +1,235 @@ + + + + + SynModuleSigDecl - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynModuleSigDecl

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Exception(SynExceptionSig,range) + +
    + Signature: SynExceptionSig * range
    +
    +     		+ +
    + + HashDirective(ParsedHashDirective,range) + +
    + Signature: ParsedHashDirective * range
    +
    +     		+ +
    + + ModuleAbbrev(ident,longId,range) + +
    + Signature: Ident * LongIdent * range
    +
    +     		+ +
    + + NamespaceFragment(...) + +
    + Signature: SynModuleOrNamespaceSig
    +
    +     		+ +
    + + NestedModule(...) + +
    + Signature: SynComponentInfo * bool * SynModuleSigDecls * range
    +
    +     		+ +
    + + Open(longId,range) + +
    + Signature: LongIdent * range
    +
    +     		+ +
    + + Types(SynTypeDefnSig list,range) + +
    + Signature: SynTypeDefnSig list * range
    +
    +     		+ +
    + + Val(SynValSig,range) + +
    + Signature: SynValSig * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synmodulesigdecls.html b/docs/reference/fsharp-compiler-ast-synmodulesigdecls.html new file mode 100644 index 0000000000..f783a100ca --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synmodulesigdecls.html @@ -0,0 +1,194 @@ + + + + + SynModuleSigDecls - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynModuleSigDecls

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: SynModuleSigDecl
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> SynModuleSigDecl
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: SynModuleSigDecl list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: SynModuleSigDecl list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synpat.html b/docs/reference/fsharp-compiler-ast-synpat.html new file mode 100644 index 0000000000..3339e8c97b --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synpat.html @@ -0,0 +1,392 @@ + + + + + SynPat - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynPat

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Ands(SynPat list,range) + +
    + Signature: SynPat list * range
    +
    +     		+ +
    + + ArrayOrList(bool,SynPat list,range) + +
    + Signature: bool * SynPat list * range
    +
    +     		+ +
    + + Attrib(SynPat,SynAttributes,range) + +
    + Signature: SynPat * SynAttributes * range
    +
    +     		+ +
    + + Const(SynConst,range) + +
    + Signature: SynConst * range
    +
    +     		+ +
    + + DeprecatedCharRange(char,char,range) + +
    + Signature: char * char * range
    +
    +     		+

    Deprecated character range: ranges

    + + +
    + + FromParseError(SynPat,range) + +
    + Signature: SynPat * range
    +
    +     		+

    A pattern arising from a parse error

    + + +
    + + InstanceMember(...) + +
    + Signature: Ident * Ident * Ident option * SynAccess option * range
    +
    +     		+

    Used internally in the type checker

    + + +
    + + IsInst(SynType,range) + +
    + Signature: SynType * range
    +
    +     		+

    ':? type '

    + + +
    + + LongIdent(...) + +
    + Signature: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * SynAccess option * range
    +
    +     		+ +
    + + Named(...) + +
    + Signature: SynPat * Ident * bool * SynAccess option * range
    +
    +     		+ +
    + + Null(range) + +
    + Signature: range
    +
    +     		+

    'null'

    + + +
    + + OptionalVal(Ident,range) + +
    + Signature: Ident * range
    +
    +     		+

    '?id' -- for optional argument names

    + + +
    + + Or(SynPat,SynPat,range) + +
    + Signature: SynPat * SynPat * range
    +
    +     		+ +
    + + Paren(SynPat,range) + +
    + Signature: SynPat * range
    +
    +     		+ +
    + + QuoteExpr(SynExpr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    <@ expr @>, used for active pattern arguments

    + + +
    + + Record(...) + +
    + Signature: ((LongIdent * Ident) * SynPat) list * range
    +
    +     		+ +
    + + Tuple(isStruct,SynPat list,range) + +
    + Signature: bool * SynPat list * range
    +
    +     		+ +
    + + Typed(SynPat,SynType,range) + +
    + Signature: SynPat * SynType * range
    +
    +     		+ +
    + + Wild(range) + +
    + Signature: range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synrationalconst.html b/docs/reference/fsharp-compiler-ast-synrationalconst.html new file mode 100644 index 0000000000..959b8feadb --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synrationalconst.html @@ -0,0 +1,150 @@ + + + + + SynRationalConst - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynRationalConst

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    The unchecked abstract syntax tree of F# unit of measure exponents.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Integer(int32) + +
    + Signature: int32
    +
    +     		+ +
    + + Negate(SynRationalConst) + +
    + Signature: SynRationalConst
    +
    +     		+ +
    + + Rational(int32,int32,range) + +
    + Signature: int32 * int32 * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synreturninfo.html b/docs/reference/fsharp-compiler-ast-synreturninfo.html new file mode 100644 index 0000000000..559051d610 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synreturninfo.html @@ -0,0 +1,120 @@ + + + + + SynReturnInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynReturnInfo

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +

    The syntactic elements associated with the "return" of a function or method. Some of this is +mostly dummy information to make the return element look like an argument, +the important thing is that (a) you can give a return type for the function or method, and +(b) you can associate .NET attributes to return of a function or method and these get stored in .NET metadata.

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynReturnInfo(...) + +
    + Signature: SynType * SynArgInfo * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synsimplepat.html b/docs/reference/fsharp-compiler-ast-synsimplepat.html new file mode 100644 index 0000000000..734e7efa42 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synsimplepat.html @@ -0,0 +1,159 @@ + + + + + SynSimplePat - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynSimplePat

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Attrib(SynSimplePat,SynAttributes,range) + +
    + Signature: SynSimplePat * SynAttributes * range
    +
    +     		+ +
    + + Id(...) + +
    + Signature: Ident * SynSimplePatAlternativeIdInfo ref option * bool * bool * bool * range
    +
    +     		+

    Id (ident, altNameRefCell, isCompilerGenerated, isThisVar, isOptArg, range)

    +

    Indicates a simple pattern variable.

    +

    altNameRefCell +Normally 'None' except for some compiler-generated variables in desugaring pattern matching. +Pattern processing sets this reference for hidden variable introduced by desugaring pattern matching in arguments. +The info indicates an alternative (compiler generated) identifier to be used because the name of the identifier is already bound. +See Product Studio FSharp 1.0, bug 6389.

    +

    isCompilerGenerated: true if a compiler generated name +isThisVar: true if 'this' variable in member +isOptArg: true if a '?' is in front of the name

    + + +
    + + Typed(SynSimplePat,SynType,range) + +
    + Signature: SynSimplePat * SynType * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synsimplepatalternativeidinfo.html b/docs/reference/fsharp-compiler-ast-synsimplepatalternativeidinfo.html new file mode 100644 index 0000000000..7e07508142 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synsimplepatalternativeidinfo.html @@ -0,0 +1,132 @@ + + + + + SynSimplePatAlternativeIdInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynSimplePatAlternativeIdInfo

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Decided(Ident) + +
    + Signature: Ident
    +
    +     		+

    We have decided to use an alternative name in tha pattern and related expression

    + + +
    + + Undecided(Ident) + +
    + Signature: Ident
    +
    +     		+

    We have not decided to use an alternative name in tha pattern and related expression

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synsimplepats.html b/docs/reference/fsharp-compiler-ast-synsimplepats.html new file mode 100644 index 0000000000..c09e76c264 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synsimplepats.html @@ -0,0 +1,140 @@ + + + + + SynSimplePats - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynSimplePats

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Represents a simple set of variable bindings a, (a, b) or (a: Type, b: Type) at a lambda, +function definition or other binding point, after the elimination of pattern matching +from the construct, e.g. after changing a "function pat1 -> rule1 | ..." to a +"fun v -> match v with ..."

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + SimplePats(SynSimplePat list,range) + +
    + Signature: SynSimplePat list * range
    +
    +     		+ +
    + + Typed(SynSimplePats,SynType,range) + +
    + Signature: SynSimplePats * SynType * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synstaticoptimizationconstraint.html b/docs/reference/fsharp-compiler-ast-synstaticoptimizationconstraint.html new file mode 100644 index 0000000000..8a1dac66bc --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synstaticoptimizationconstraint.html @@ -0,0 +1,134 @@ + + + + + SynStaticOptimizationConstraint - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynStaticOptimizationConstraint

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + WhenTyparIsStruct(SynTypar,range) + +
    + Signature: SynTypar * range
    +
    +     		+ +
    + + WhenTyparTyconEqualsTycon(...) + +
    + Signature: SynTypar * SynType * range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntaxerror.html b/docs/reference/fsharp-compiler-ast-syntaxerror.html new file mode 100644 index 0000000000..b57797cd8b --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntaxerror.html @@ -0,0 +1,139 @@ + + + + + SyntaxError - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SyntaxError

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The error raised by the parseerrorrich function, which is called by the parser engine +when a syntax error occurs. The first object is the ParseErrorContext which contains a dump of +information about the grammar at the point where the error occurred, e.g. what tokens +are valid to shift next at that point in the grammar. This information is processed in CompileOps.fs.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: obj
    +
    +     		+ +
    + + range + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntypar.html b/docs/reference/fsharp-compiler-ast-syntypar.html new file mode 100644 index 0000000000..67ac33a484 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntypar.html @@ -0,0 +1,143 @@ + + + + + SynTypar - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynTypar

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + Typar(ident,staticReq,isCompGen) + +
    + Signature: Ident * TyparStaticReq * bool
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntypardecl.html b/docs/reference/fsharp-compiler-ast-syntypardecl.html new file mode 100644 index 0000000000..f64d900c9e --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntypardecl.html @@ -0,0 +1,123 @@ + + + + + SynTyparDecl - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynTyparDecl

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents the explicit declaration of a type parameter

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + TyparDecl(attributes,SynTypar) + +
    + Signature: SynAttributes * SynTypar
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntype.html b/docs/reference/fsharp-compiler-ast-syntype.html new file mode 100644 index 0000000000..b744ebaea5 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntype.html @@ -0,0 +1,383 @@ + + + + + SynType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynType

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    The unchecked abstract syntax tree of F# types

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Anon(range) + +
    + Signature: range
    +
    +     		+

    F# syntax: _

    + + +
    + + AnonRecd(isStruct,typeNames,range) + +
    + Signature: bool * (Ident * SynType) list * range
    +
    +     		+

    F# syntax: {| id: type; ...; id: type |} +F# syntax: struct {| id: type; ...; id: type |}

    + + +
    + + App(...) + +
    + Signature: SynType * range option * SynType list * range list * range option * bool * range
    +
    +     		+

    App(typeName, LESSm, typeArgs, commasm, GREATERm, isPostfix, m)

    +

    F# syntax: type or type type or (type, ..., type) type +isPostfix: indicates a postfix type application e.g. "int list" or "(int, string) dict" +commasm: ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them

    + + +
    + + Array(int,elementType,range) + +
    + Signature: int * SynType * range
    +
    +     		+

    F# syntax: type[]

    + + +
    + + Fun(argType,returnType,range) + +
    + Signature: SynType * SynType * range
    +
    +     		+

    F# syntax: type -> type

    + + +
    + + HashConstraint(SynType,range) + +
    + Signature: SynType * range
    +
    +     		+

    F# syntax: #type

    + + +
    + + LongIdent(longDotId) + +
    + Signature: LongIdentWithDots
    +
    +     		+

    F# syntax: A.B.C

    + + +
    + + LongIdentApp(...) + +
    + Signature: SynType * LongIdentWithDots * range option * SynType list * range list * range option * range
    +
    +     		+

    LongIdentApp(typeName, longId, LESSm, tyArgs, commasm, GREATERm, wholem)

    +

    F# syntax: type.A.B.C +commasm: ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them

    + + +
    + + MeasureDivide(...) + +
    + Signature: SynType * SynType * range
    +
    +     		+

    F# syntax: for units of measure e.g. m / s

    + + +
    + + MeasurePower(...) + +
    + Signature: SynType * SynRationalConst * range
    +
    +     		+

    F# syntax: for units of measure e.g. m^3, kg^1/2

    + + +
    + + StaticConstant(constant,range) + +
    + Signature: SynConst * range
    +
    +     		+

    F# syntax: 1, "abc" etc, used in parameters to type providers +For the dimensionless units i.e. 1, and static parameters to provided types

    + + +
    + + StaticConstantExpr(expr,range) + +
    + Signature: SynExpr * range
    +
    +     		+

    F# syntax: const expr, used in static parameters to type providers

    + + +
    + + StaticConstantNamed(expr,SynType,range) + +
    + Signature: SynType * SynType * range
    +
    +     		+

    F# syntax: ident=1 etc., used in static parameters to type providers

    + + +
    + + Tuple(isStruct,typeNames,range) + +
    + Signature: bool * (bool * SynType) list * range
    +
    +     		+

    F# syntax: type ... type +F# syntax: struct (type ... type)

    + + +
    + + Var(genericName,range) + +
    + Signature: SynTypar * range
    +
    +     		+

    F# syntax: 'Var

    + + +
    + + WithGlobalConstraints(...) + +
    + Signature: SynType * SynTypeConstraint list * range
    +
    +     		+

    F# syntax: typ with constraints

    + + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+

    Get the syntactic range of source code covered by this construct.

    + + +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntypeconstraint.html b/docs/reference/fsharp-compiler-ast-syntypeconstraint.html new file mode 100644 index 0000000000..d151b9f54f --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntypeconstraint.html @@ -0,0 +1,275 @@ + + + + + SynTypeConstraint - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynTypeConstraint

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The unchecked abstract syntax tree of F# type constraints

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + WhereTyparDefaultsToType(...) + +
    + Signature: SynTypar * SynType * range
    +
    +     		+

    F# syntax is default ^T: type

    + + +
    + + WhereTyparIsComparable(...) + +
    + Signature: SynTypar * range
    +
    +     		+

    F# syntax is 'typar: comparison

    + + +
    + + WhereTyparIsDelegate(...) + +
    + Signature: SynTypar * SynType list * range
    +
    +     		+

    F# syntax is 'typar: delegate<'Args, unit>

    + + +
    + + WhereTyparIsEnum(...) + +
    + Signature: SynTypar * SynType list * range
    +
    +     		+

    F# syntax is 'typar: enum<'UnderlyingType>

    + + +
    + + WhereTyparIsEquatable(genericName,range) + +
    + Signature: SynTypar * range
    +
    +     		+

    F# syntax is 'typar: equality

    + + +
    + + WhereTyparIsReferenceType(...) + +
    + Signature: SynTypar * range
    +
    +     		+

    F# syntax: is 'typar: not struct

    + + +
    + + WhereTyparIsUnmanaged(genericName,range) + +
    + Signature: SynTypar * range
    +
    +     		+

    F# syntax is 'typar: unmanaged

    + + +
    + + WhereTyparIsValueType(genericName,range) + +
    + Signature: SynTypar * range
    +
    +     		+

    F# syntax: is 'typar: struct

    + + +
    + + WhereTyparSubtypeOfType(...) + +
    + Signature: SynTypar * SynType * range
    +
    +     		+

    F# syntax is 'typar :> type

    + + +
    + + WhereTyparSupportsMember(...) + +
    + Signature: SynType list * SynMemberSig * range
    +
    +     		+

    F# syntax is ^T: (static member MemberName: ^T * int -> ^T)

    + + +
    + + WhereTyparSupportsNull(...) + +
    + Signature: SynTypar * range
    +
    +     		+

    F# syntax is 'typar: null

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntypedefn.html b/docs/reference/fsharp-compiler-ast-syntypedefn.html new file mode 100644 index 0000000000..8ce8677d02 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntypedefn.html @@ -0,0 +1,143 @@ + + + + + SynTypeDefn - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynTypeDefn

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + TypeDefn(...) + +
    + Signature: SynComponentInfo * SynTypeDefnRepr * SynMemberDefns * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnkind.html b/docs/reference/fsharp-compiler-ast-syntypedefnkind.html new file mode 100644 index 0000000000..ff804ffbc9 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntypedefnkind.html @@ -0,0 +1,251 @@ + + + + + SynTypeDefnKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynTypeDefnKind

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + TyconAbbrev + +
    + Signature:
    +
    +     		+ +
    + + TyconAugmentation + +
    + Signature:
    +
    +     		+ +
    + + TyconClass + +
    + Signature:
    +
    +     		+ +
    + + TyconDelegate(SynType,SynValInfo) + +
    + Signature: SynType * SynValInfo
    +
    +     		+ +
    + + TyconHiddenRepr + +
    + Signature:
    +
    +     		+ +
    + + TyconILAssemblyCode + +
    + Signature:
    +
    +     		+ +
    + + TyconInterface + +
    + Signature:
    +
    +     		+ +
    + + TyconRecord + +
    + Signature:
    +
    +     		+ +
    + + TyconStruct + +
    + Signature:
    +
    +     		+ +
    + + TyconUnion + +
    + Signature:
    +
    +     		+ +
    + + TyconUnspecified + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnrepr.html b/docs/reference/fsharp-compiler-ast-syntypedefnrepr.html new file mode 100644 index 0000000000..be7c28586d --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntypedefnrepr.html @@ -0,0 +1,170 @@ + + + + + SynTypeDefnRepr - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynTypeDefnRepr

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Exception(SynExceptionDefnRepr) + +
    + Signature: SynExceptionDefnRepr
    +
    +     		+ +
    + + ObjectModel(...) + +
    + Signature: SynTypeDefnKind * SynMemberDefns * range
    +
    +     		+ +
    + + Simple(SynTypeDefnSimpleRepr,range) + +
    + Signature: SynTypeDefnSimpleRepr * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnsig.html b/docs/reference/fsharp-compiler-ast-syntypedefnsig.html new file mode 100644 index 0000000000..1514dc557b --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntypedefnsig.html @@ -0,0 +1,125 @@ + + + + + SynTypeDefnSig - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynTypeDefnSig

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The untyped, unchecked syntax tree for a type definition in a signature

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + TypeDefnSig(...) + +
    + Signature: SynComponentInfo * SynTypeDefnSigRepr * SynMemberSigs * range
    +
    +     		+

    The information for a type definition in a signature

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnsigrepr.html b/docs/reference/fsharp-compiler-ast-syntypedefnsigrepr.html new file mode 100644 index 0000000000..f64de2ffb3 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntypedefnsigrepr.html @@ -0,0 +1,178 @@ + + + + + SynTypeDefnSigRepr - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynTypeDefnSigRepr

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    The untyped, unchecked syntax tree for the right-hand-side of a type definition in a signature. +Note: in practice, using a discriminated union to make a distinction between +"simple" types and "object oriented" types is not particularly useful.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Exception(SynExceptionDefnRepr) + +
    + Signature: SynExceptionDefnRepr
    +
    +     		+ +
    + + ObjectModel(...) + +
    + Signature: SynTypeDefnKind * SynMemberSigs * range
    +
    +     		+

    Indicates the right right-hand-side is a class, struct, interface or other object-model type

    + + +
    + + Simple(SynTypeDefnSimpleRepr,range) + +
    + Signature: SynTypeDefnSimpleRepr * range
    +
    +     		+

    Indicates the right right-hand-side is a record, union or other simple type.

    + + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-syntypedefnsimplerepr.html b/docs/reference/fsharp-compiler-ast-syntypedefnsimplerepr.html new file mode 100644 index 0000000000..aefb5fda22 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-syntypedefnsimplerepr.html @@ -0,0 +1,256 @@ + + + + + SynTypeDefnSimpleRepr - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynTypeDefnSimpleRepr

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    The untyped, unchecked syntax tree for the core of a simple type definition, in either signature +or implementation.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Enum(SynEnumCases,range) + +
    + Signature: SynEnumCases * range
    +
    +     		+

    An enum type definition, type X = A = 1 | B = 2

    + + +
    + + Exception(SynExceptionDefnRepr) + +
    + Signature: SynExceptionDefnRepr
    +
    +     		+

    An exception definition, "exception E = ..."

    + + +
    + + General(...) + +
    + Signature: SynTypeDefnKind * (SynType * range * Ident option) list * (SynValSig * MemberFlags) list * SynField list * bool * bool * SynSimplePats option * range
    +
    +     		+

    An object oriented type definition. This is not a parse-tree form, but represents the core +type representation which the type checker splits out from the "ObjectModel" cases of type definitions.

    + + +
    + + LibraryOnlyILAssembly(ILType,range) + +
    + Signature: ILType * range
    +
    +     		+

    A type defined by using an IL assembly representation. Only used in FSharp.Core.

    +

    F# syntax: "type X = (# "..."#)

    + + +
    + + None(range) + +
    + Signature: range
    +
    +     		+

    An abstract definition, "type X"

    + + +
    + + Record(accessibility,recordFields,range) + +
    + Signature: SynAccess option * SynFields * range
    +
    +     		+

    A record type definition, type X = { A: int; B: int }

    + + +
    + + TypeAbbrev(ParserDetail,SynType,range) + +
    + Signature: ParserDetail * SynType * range
    +
    +     		+

    A type abbreviation, "type X = A.B.C"

    + + +
    + + Union(accessibility,unionCases,range) + +
    + Signature: SynAccess option * SynUnionCases * range
    +
    +     		+

    A union type definition, type X = A | B

    + + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synunioncase.html b/docs/reference/fsharp-compiler-ast-synunioncase.html new file mode 100644 index 0000000000..fa86b2ba4f --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synunioncase.html @@ -0,0 +1,145 @@ + + + + + SynUnionCase - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynUnionCase

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + UnionCase(...) + +
    + Signature: SynAttributes * Ident * SynUnionCaseType * PreXmlDoc * SynAccess option * range
    +
    +     		+

    The untyped, unchecked syntax tree for one case in a union definition.

    + + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synunioncases.html b/docs/reference/fsharp-compiler-ast-synunioncases.html new file mode 100644 index 0000000000..ccacf6e722 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synunioncases.html @@ -0,0 +1,194 @@ + + + + + SynUnionCases - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynUnionCases

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: SynUnionCase
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> SynUnionCase
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: SynUnionCase list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: SynUnionCase list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synunioncasetype.html b/docs/reference/fsharp-compiler-ast-synunioncasetype.html new file mode 100644 index 0000000000..482fbb7ef1 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synunioncasetype.html @@ -0,0 +1,141 @@ + + + + + SynUnionCaseType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynUnionCaseType

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The untyped, unchecked syntax tree for the right-hand-side of union definition, excluding members, +in either a signature or implementation.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + UnionCaseFields(cases) + +
    + Signature: SynField list
    +
    +     		+

    Normal style declaration

    + + +
    + + UnionCaseFullType(SynType * SynValInfo) + +
    + Signature: SynType * SynValInfo
    +
    +     		+

    Full type spec given by 'UnionCase: ty1 * tyN -> rty'. Only used in FSharp.Core, otherwise a warning.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synvaldata.html b/docs/reference/fsharp-compiler-ast-synvaldata.html new file mode 100644 index 0000000000..e20a4d1bd8 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synvaldata.html @@ -0,0 +1,121 @@ + + + + + SynValData - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynValData

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynValData(...) + +
    + Signature: MemberFlags option * SynValInfo * Ident option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synvalinfo.html b/docs/reference/fsharp-compiler-ast-synvalinfo.html new file mode 100644 index 0000000000..ad3760070e --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synvalinfo.html @@ -0,0 +1,147 @@ + + + + + SynValInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynValInfo

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The argument names and other metadata for a member or function

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynValInfo(...) + +
    + Signature: SynArgInfo list list * SynArgInfo
    +
    +     		+

    SynValInfo(curriedArgInfos, returnInfo)

    + + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.ArgInfos + +
    + Signature: SynArgInfo list list
    +
    +     		+ +

    CompiledName: get_ArgInfos

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synvalsig.html b/docs/reference/fsharp-compiler-ast-synvalsig.html new file mode 100644 index 0000000000..454c3d013f --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synvalsig.html @@ -0,0 +1,171 @@ + + + + + SynValSig - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynValSig

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + ValSpfn(...) + +
    + Signature: SynAttributes * Ident * SynValTyparDecls * SynType * SynValInfo * bool * bool * PreXmlDoc * SynAccess option * SynExpr option * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.RangeOfId + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_RangeOfId

    +
    + + x.SynInfo + +
    + Signature: SynValInfo
    +
    +     		+ +

    CompiledName: get_SynInfo

    +
    + + x.SynType + +
    + Signature: SynType
    +
    +     		+ +

    CompiledName: get_SynType

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-synvaltypardecls.html b/docs/reference/fsharp-compiler-ast-synvaltypardecls.html new file mode 100644 index 0000000000..02c6c82d18 --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-synvaltypardecls.html @@ -0,0 +1,123 @@ + + + + + SynValTyparDecls - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SynValTyparDecls

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    The names and other metadata for the type parameters for a member or function

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + SynValTyparDecls(...) + +
    + Signature: SynTyparDecl list * bool * SynTypeConstraint list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-typarstaticreq.html b/docs/reference/fsharp-compiler-ast-typarstaticreq.html new file mode 100644 index 0000000000..d76aa8754c --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-typarstaticreq.html @@ -0,0 +1,128 @@ + + + + + TyparStaticReq - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    TyparStaticReq

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + HeadTypeStaticReq + +
    + Signature:
    +
    +     		+ +
    + + NoStaticReq + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-xmldoc.html b/docs/reference/fsharp-compiler-ast-xmldoc.html new file mode 100644 index 0000000000..806849f9ab --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-xmldoc.html @@ -0,0 +1,188 @@ + + + + + XmlDoc - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    XmlDoc

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + XmlDoc(string []) + +
    + Signature: string []
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.NonEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_NonEmpty

    +
    +

    Static members

    + + + + + + + + + + + + + + + + + + +
    Static memberDescription
    + + XmlDoc.Empty + +
    + Signature: XmlDoc
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + + XmlDoc.Merge arg1 arg2 + +
    + Signature: XmlDoc -> XmlDoc -> XmlDoc
    +
    +     		+ +
    + + XmlDoc.Process(arg1) + +
    + Signature: XmlDoc -> XmlDoc
    +
    +     		+

    This code runs for .XML generation and thus influences cross-project xmldoc tooltips; for within-project tooltips, +see XmlDocumentation.fs in the language service

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-xmldoccollector.html b/docs/reference/fsharp-compiler-ast-xmldoccollector.html new file mode 100644 index 0000000000..d6c3aa6a4a --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-xmldoccollector.html @@ -0,0 +1,165 @@ + + + + + XmlDocCollector - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    XmlDocCollector

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +

    Used to collect XML documentation during lexing and parsing.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> XmlDocCollector
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AddGrabPoint(pos) + +
    + Signature: pos:pos -> unit
    +
    +     		+ +
    + + x.AddXmlDocLine(line, pos) + +
    + Signature: (line:string * pos:pos) -> unit
    +
    +     		+ +
    + + x.LinesBefore(grabPointPos) + +
    + Signature: grabPointPos:pos -> string []
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast-xmldocstatics.html b/docs/reference/fsharp-compiler-ast-xmldocstatics.html new file mode 100644 index 0000000000..68f780656b --- /dev/null +++ b/docs/reference/fsharp-compiler-ast-xmldocstatics.html @@ -0,0 +1,138 @@ + + + + + XmlDocStatics - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    XmlDocStatics

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Ast
    +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> XmlDocStatics
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + XmlDocStatics.Empty + +
    + Signature: XmlDoc
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-ast.html b/docs/reference/fsharp-compiler-ast.html new file mode 100644 index 0000000000..6a136250fa --- /dev/null +++ b/docs/reference/fsharp-compiler-ast.html @@ -0,0 +1,2136 @@ + + + + + Ast - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Ast

    +

    + Namespace: FSharp.Compiler
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + BlockSeparator + +

    denotes location of the separator block + optional position of the semicolon (used for tooling support)

    + + +
    + ExprAtomicFlag + + +
    + Ident + + +
    + LexCont + + +
    + LexerEndlineContinuation + +

    Specifies how the 'endline' function in the lexer should continue after +it reaches end of line or eof. The options are to continue with 'token' function +or to continue with 'skip' function.

    + + +
    + LexerIfdefExpression + + +
    + LexerIfdefStack + + +
    + LexerIfdefStackEntries + + +
    + LexerIfdefStackEntry + + +
    + LexerWhitespaceContinuation + +

    The parser defines a number of tokens for whitespace and +comments eliminated by the lexer. These carry a specification of +a continuation for the lexer for continued processing after we've dealt with +the whitespace.

    + + +
    + LongIdent + + +
    + LongIdentWithDots + + +
    + MemberFlags + + +
    + MemberKind + +

    Note the member kind is actually computed partially by a syntax tree transformation in tc.fs

    + + +
    + ParsedFsiInteraction + + +
    + ParsedHashDirective + + +
    + ParsedImplFile + + +
    + ParsedImplFileFragment + + +
    + ParsedImplFileInput + + +
    + ParsedInput + + +
    + ParsedSigFile + + +
    + ParsedSigFileFragment + + +
    + ParsedSigFileInput + + +
    + ParserDetail + + +
    + PreXmlDoc + + +
    + QualifiedNameOfFile + +

    QualifiedNameOfFile acts to fully-qualify module specifications and implementations, +most importantly the ones that simply contribute fragments to a namespace (i.e. the ParsedSigFileFragment.NamespaceFragment case) +There may be multiple such fragments in a single assembly. There may thus also +be multiple matching pairs of these in an assembly, all contributing types to the same +namespace.

    + + +
    + RecordFieldName + +

    stores pair: record field name + (true if given record field name is syntactically correct and can be used in name resolution)

    + + +
    + ScopedPragma + + +
    + SeqExprOnly + +

    Indicates if a for loop is 'for x in e1 -> e2', only valid in sequence expressions

    + + +
    + SequencePointInfoForBinding + + +
    + SequencePointInfoForFinally + + +
    + SequencePointInfoForForLoop + + +
    + SequencePointInfoForSeq + + +
    + SequencePointInfoForTarget + + +
    + SequencePointInfoForTry + + +
    + SequencePointInfoForWhileLoop + + +
    + SequencePointInfoForWith + + +
    + SynAccess + + +
    + SynArgInfo + +

    The argument names and other metadata for a parameter for a member or function

    + + +
    + SynArgNameGenerator + + +
    + SynAttribute + + +
    + SynAttributeList + +

    List of attributes enclosed in [< ... >].

    + + +
    + SynAttributes + + +
    + SynBinding + + +
    + SynBindingKind + +

    The kind associated with a binding - "let", "do" or a standalone expression

    + + +
    + SynBindingReturnInfo + + +
    + SynComponentInfo + +

    The untyped, unchecked syntax tree associated with the name of a type definition or module +in signature or implementation.

    +

    This includes the name, attributes, type parameters, constraints, documentation and accessibility +for a type definition or module. For modules, entries such as the type parameters are +always empty.

    + + +
    + SynConst + +

    The unchecked abstract syntax tree of constants in F# types and expressions.

    + + +
    + SynConstructorArgs + + +
    + SynEnumCase + + +
    + SynEnumCases + + +
    + SynExceptionDefn + +

    'exception E = ... with ...'

    + + +
    + SynExceptionDefnRepr + +

    'exception E = ... '

    + + +
    + SynExceptionSig + + +
    + SynExpr + + +
    + SynField + +

    The untyped, unchecked syntax tree for a field declaration in a record or class

    + + +
    + SynFields + + +
    + SynIndexerArg + + +
    + SynInterfaceImpl + + +
    + SynMatchClause + + +
    + SynMeasure + +

    The unchecked abstract syntax tree of F# unit of measure annotations. +This should probably be merged with the representation of SynType.

    + + +
    + SynMemberDefn + + +
    + SynMemberDefns + + +
    + SynMemberSig + +

    The untyped, unchecked syntax tree for a member signature, used in signature files, abstract member declarations +and member constraints.

    + + +
    + SynMemberSigs + + +
    + SynModuleDecl + + +
    + SynModuleDecls + + +
    + SynModuleOrNamespace + + +
    + SynModuleOrNamespaceKind + + +
    + SynModuleOrNamespaceSig + + +
    + SynModuleSigDecl + + +
    + SynModuleSigDecls + + +
    + SynPat + + +
    + SynRationalConst + +

    The unchecked abstract syntax tree of F# unit of measure exponents.

    + + +
    + SynReturnInfo + +

    The syntactic elements associated with the "return" of a function or method. Some of this is +mostly dummy information to make the return element look like an argument, +the important thing is that (a) you can give a return type for the function or method, and +(b) you can associate .NET attributes to return of a function or method and these get stored in .NET metadata.

    + + +
    + SynSimplePat + + +
    + SynSimplePatAlternativeIdInfo + + +
    + SynSimplePats + +

    Represents a simple set of variable bindings a, (a, b) or (a: Type, b: Type) at a lambda, +function definition or other binding point, after the elimination of pattern matching +from the construct, e.g. after changing a "function pat1 -> rule1 | ..." to a +"fun v -> match v with ..."

    + + +
    + SynStaticOptimizationConstraint + + +
    + SynTypar + + +
    + SynTyparDecl + +

    Represents the explicit declaration of a type parameter

    + + +
    + SynType + +

    The unchecked abstract syntax tree of F# types

    + + +
    + SynTypeConstraint + +

    The unchecked abstract syntax tree of F# type constraints

    + + +
    + SynTypeDefn + + +
    + SynTypeDefnKind + + +
    + SynTypeDefnRepr + + +
    + SynTypeDefnSig + +

    The untyped, unchecked syntax tree for a type definition in a signature

    + + +
    + SynTypeDefnSigRepr + +

    The untyped, unchecked syntax tree for the right-hand-side of a type definition in a signature. +Note: in practice, using a discriminated union to make a distinction between +"simple" types and "object oriented" types is not particularly useful.

    + + +
    + SynTypeDefnSimpleRepr + +

    The untyped, unchecked syntax tree for the core of a simple type definition, in either signature +or implementation.

    + + +
    + SynUnionCase + + +
    + SynUnionCaseType + +

    The untyped, unchecked syntax tree for the right-hand-side of union definition, excluding members, +in either a signature or implementation.

    + + +
    + SynUnionCases + + +
    + SynValData + + +
    + SynValInfo + +

    The argument names and other metadata for a member or function

    + + +
    + SynValSig + + +
    + SynValTyparDecls + +

    The names and other metadata for the type parameters for a member or function

    + + +
    + SyntaxError + +

    The error raised by the parseerrorrich function, which is called by the parser engine +when a syntax error occurs. The first object is the ParseErrorContext which contains a dump of +information about the grammar at the point where the error occurred, e.g. what tokens +are valid to shift next at that point in the grammar. This information is processed in CompileOps.fs.

    + + +
    + TyparStaticReq + + +
    + XmlDoc + + +
    + XmlDocCollector + +

    Used to collect XML documentation during lexing and parsing.

    + + +
    + XmlDocStatics + + +
    + + + + + + + + + + + + + + + + + + + + + + +
    ModuleDescription
    + CustomOperations + + +
    + FSharpLib + + +
    + LexbufLocalXmlDocStore + +

    XmlDoc F# lexer/parser state, held in the BufferLocalStore for the lexer. +This is the only use of the lexer BufferLocalStore in the codebase.

    + + +
    + SynInfo + +

    Operations related to the syntactic analysis of arguments of value, function and member definitions and signatures.

    +

    Function and member definitions have strongly syntactically constrained arities. We infer +the arity from the syntax.

    +

    For example, we record the arity for: +StaticProperty --> [1] -- for unit arg +this.InstanceProperty --> [1;1] -- for unit arg +StaticMethod(args) --> map InferSynArgInfoFromSimplePat args +this.InstanceMethod() --> 1 :: map InferSynArgInfoFromSimplePat args +this.InstanceProperty with get(argpat) --> 1 :: [InferSynArgInfoFromSimplePat argpat] +StaticProperty with get(argpat) --> [InferSynArgInfoFromSimplePat argpat] +this.InstanceProperty with get() --> 1 :: [InferSynArgInfoFromSimplePat argpat] +StaticProperty with get() --> [InferSynArgInfoFromSimplePat argpat]

    +

    this.InstanceProperty with set(argpat)(v) --> 1 :: [InferSynArgInfoFromSimplePat argpat; 1] +StaticProperty with set(argpat)(v) --> [InferSynArgInfoFromSimplePat argpat; 1] +this.InstanceProperty with set(v) --> 1 :: [1] +StaticProperty with set(v) --> [1]

    + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + AbstractMemberFlags(k) + +
    + Signature: k:MemberKind -> MemberFlags
    +
    +     		+ +
    + + appFunOpt funOpt x + +
    + Signature: funOpt:('?688608 -> '?688608) option -> x:'?688608 -> '?688608
    + Type parameters: '?688608
    +     		+ +
    + + arbExpr(debugStr, range) + +
    + Signature: (debugStr:string * range:range) -> SynExpr
    +
    +     		+ +
    + + arrPathOfLid(lid) + +
    + Signature: lid:Ident list -> string []
    +
    +     		+ +
    + + ClassCtorMemberFlags + +
    + Signature: MemberFlags
    +
    +     		+ +
    + + composeFunOpt funOpt1 funOpt2 + +
    + Signature: funOpt1:('?688610 -> '?688610) option -> funOpt2:('?688610 -> '?688610) option -> ('?688610 -> '?688610) option
    + Type parameters: '?688610
    +     		+ +
    + + ConcatAttributesLists(attrsLists) + +
    + Signature: attrsLists:SynAttributeList list -> SynAttribute list
    +
    +     		+ +
    + + CtorMemberFlags + +
    + Signature: MemberFlags
    +
    +     		+ +
    + + FsiDynamicModulePrefix + +
    + Signature: string
    +
    +     		+

    The prefix of the names used for the fake namespace path added to all dynamic code entries in FSI.EXE

    + + +
    + + ident(s, r) + +
    + Signature: (s:string * r:range) -> Ident
    +
    +     		+ +
    + + inferredTyparDecls + +
    + Signature: SynValTyparDecls
    +
    +     		+ +
    + + IsControlFlowExpression(e) + +
    + Signature: e:SynExpr -> bool
    +
    +     		+

    This affects placement of sequence points

    + + +
    + + LexerIfdefEval lookup _arg1 + +
    + Signature: lookup:(string -> bool) -> _arg1:LexerIfdefExpression -> bool
    +
    +     		+ +
    + + mkAnonField(ty) + +
    + Signature: ty:SynType -> SynField
    +
    +     		+ +
    + + mkAttributeList attrs range + +
    + Signature: attrs:SynAttribute list -> range:range -> SynAttributeList list
    +
    +     		+ +
    + + mkNamedField(ident, ty) + +
    + Signature: (ident:Ident * ty:SynType) -> SynField
    +
    +     		+ +
    + + mkSynApp1 f x1 m + +
    + Signature: f:SynExpr -> x1:SynExpr -> m:range -> SynExpr
    +
    +     		+ +
    + + mkSynApp2 f x1 x2 m + +
    + Signature: f:SynExpr -> x1:SynExpr -> x2:SynExpr -> m:range -> SynExpr
    +
    +     		+ +
    + + mkSynApp3 f x1 x2 x3 m + +
    + Signature: f:SynExpr -> x1:SynExpr -> x2:SynExpr -> x3:SynExpr -> m:range -> SynExpr
    +
    +     		+ +
    + + mkSynApp4 f x1 x2 x3 x4 m + +
    + Signature: f:SynExpr -> x1:SynExpr -> x2:SynExpr -> x3:SynExpr -> x4:SynExpr -> m:range -> SynExpr
    +
    +     		+ +
    + + mkSynApp5 f x1 x2 x3 x4 x5 m + +
    + Signature: f:SynExpr -> x1:SynExpr -> x2:SynExpr -> x3:SynExpr -> x4:SynExpr -> x5:SynExpr -> m:range -> SynExpr
    +
    +     		+ +
    + + mkSynAssign l r + +
    + Signature: l:SynExpr -> r:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynBifix m oper x1 x2 + +
    + Signature: m:range -> oper:string -> x1:SynExpr -> x2:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynBinding(...) + +
    + Signature: (xmlDoc:PreXmlDoc * headPat:SynPat) -> (vis:SynAccess option * isInline:bool * isMutable:bool * mBind:range * spBind:SequencePointInfoForBinding * retInfo:SynReturnInfo option * origRhsExpr:SynExpr * mRhs:range * staticOptimizations:(SynStaticOptimizationConstraint list * SynExpr) list * attrs:SynAttributes * memberFlagsOpt:MemberFlags option) -> SynBinding
    +
    +     		+ +
    + + mkSynBindingRhs(...) + +
    + Signature: staticOptimizations:(SynStaticOptimizationConstraint list * SynExpr) list -> rhsExpr:SynExpr -> mRhs:range -> retInfo:SynReturnInfo option -> SynExpr * SynBindingReturnInfo option
    +
    +     		+ +
    + + mkSynCaseName m n + +
    + Signature: m:range -> n:string -> Ident list
    +
    +     		+ +
    + + mkSynCompGenSimplePatVar(id) + +
    + Signature: id:Ident -> SynSimplePat
    +
    +     		+ +
    + + mkSynDelay m e + +
    + Signature: m:range -> e:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynDot dotm m l r + +
    + Signature: dotm:range -> m:range -> l:SynExpr -> r:Ident -> SynExpr
    +
    +     		+ +
    + + mkSynDotBrackGet m mDot a b fromEnd + +
    + Signature: m:range -> mDot:range -> a:SynExpr -> b:SynExpr -> fromEnd:bool -> SynExpr
    +
    +     		+ +
    + + mkSynDotBrackSeqSliceGet(...) + +
    + Signature: m:range -> mDot:range -> arr:SynExpr -> argsList:SynIndexerArg list -> SynExpr
    +
    +     		+ +
    + + mkSynDotBrackSliceGet(...) + +
    + Signature: m:range -> mDot:range -> arr:SynExpr -> sliceArg:SynIndexerArg -> SynExpr
    +
    +     		+ +
    + + mkSynDotMissing dotm m l + +
    + Signature: dotm:range -> m:range -> l:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynDotParenGet lhsm dotm a b + +
    + Signature: lhsm:range -> dotm:range -> a:SynExpr -> b:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynDotParenSet m a b c + +
    + Signature: m:range -> a:SynExpr -> b:SynExpr -> c:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynFunMatchLambdas(...) + +
    + Signature: synArgNameGenerator:SynArgNameGenerator -> isMember:bool -> wholem:range -> ps:SynPat list -> e:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynId m s + +
    + Signature: m:range -> s:string -> Ident
    +
    +     		+ +
    + + mkSynIdGet m n + +
    + Signature: m:range -> n:string -> SynExpr
    +
    +     		+ +
    + + mkSynIdGetWithAlt m id altInfo + +
    + Signature: m:range -> id:Ident -> altInfo:SynSimplePatAlternativeIdInfo ref option -> SynExpr
    +
    +     		+ +
    + + mkSynInfix opm l oper r + +
    + Signature: opm:range -> l:SynExpr -> oper:string -> r:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynLidGet m path n + +
    + Signature: m:range -> path:string list -> n:string -> SynExpr
    +
    +     		+ +
    + + mkSynOperator opm oper + +
    + Signature: opm:range -> oper:string -> SynExpr
    +
    +     		+ +
    + + mkSynPatMaybeVar lidwd vis m + +
    + Signature: lidwd:LongIdentWithDots -> vis:SynAccess option -> m:range -> SynPat
    +
    +     		+ +
    + + mkSynPatVar vis id + +
    + Signature: vis:SynAccess option -> id:Ident -> SynPat
    +
    +     		+ +
    + + mkSynPrefix opm m oper x + +
    + Signature: opm:range -> m:range -> oper:string -> x:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynPrefixPrim opm m oper x + +
    + Signature: opm:range -> m:range -> oper:string -> x:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynQMarkSet m a b c + +
    + Signature: m:range -> a:SynExpr -> b:SynExpr -> c:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynSimplePatVar isOpt id + +
    + Signature: isOpt:bool -> id:Ident -> SynSimplePat
    +
    +     		+ +
    + + mkSynThisPatVar(id) + +
    + Signature: id:Ident -> SynPat
    +
    +     		+ +
    + + mkSynTrifix m oper x1 x2 x3 + +
    + Signature: m:range -> oper:string -> x1:SynExpr -> x2:SynExpr -> x3:SynExpr -> SynExpr
    +
    +     		+ +
    + + mkSynUnit(m) + +
    + Signature: m:range -> SynExpr
    +
    +     		+ +
    + + mkSynUnitPat(m) + +
    + Signature: m:range -> SynPat
    +
    +     		+ +
    + + noInferredTypars + +
    + Signature: SynValTyparDecls
    +
    +     		+ +
    + + NonVirtualMemberFlags(k) + +
    + Signature: k:MemberKind -> MemberFlags
    +
    +     		+ +
    + + opNameParenGet + +
    + Signature: string
    +
    +     		+ +
    + + opNameQMark + +
    + Signature: string
    +
    +     		+ +
    + + OverrideMemberFlags(k) + +
    + Signature: k:MemberKind -> MemberFlags
    +
    +     		+ +
    + + ParseAssemblyCodeInstructions s m + +
    + Signature: s:string -> m:range -> ILInstr array
    +
    +     		+ +
    + + ParseAssemblyCodeType s m + +
    + Signature: s:string -> m:range -> ILType
    +
    +     		+

    Helper for parsing the inline IL fragments.

    + + +
    + + pathOfLid(lid) + +
    + Signature: lid:Ident list -> string list
    +
    +     		+ +
    + + pathToSynLid m p + +
    + Signature: m:range -> p:string list -> Ident list
    +
    +     		+ +
    + + PushCurriedPatternsToExpr(...) + +
    + Signature: synArgNameGenerator:SynArgNameGenerator -> wholem:range -> isMember:bool -> pats:SynPat list -> rhs:SynExpr -> SynSimplePats list * SynExpr
    +
    +     		+

    "fun (UnionCase x) (UnionCase y) -> body" +==> +"fun tmp1 tmp2 -> +let (UnionCase x) = tmp1 in +let (UnionCase y) = tmp2 in +body"

    + + +
    + + PushPatternToExpr(...) + +
    + Signature: synArgNameGenerator:SynArgNameGenerator -> isMember:bool -> pat:SynPat -> rhs:SynExpr -> SynSimplePats * SynExpr
    +
    +     		+ +
    + + rangeOfLid(lid) + +
    + Signature: lid:Ident list -> range
    +
    +     		+ +
    + + SimplePatOfPat synArgNameGenerator p + +
    + Signature: synArgNameGenerator:SynArgNameGenerator -> p:SynPat -> SynSimplePat * (SynExpr -> SynExpr) option
    +
    +     		+

    Push non-simple parts of a patten match over onto the r.h.s. of a lambda. +Return a simple pattern and a function to build a match on the r.h.s. if the pattern is complex

    + + +
    + + SimplePatsOfPat synArgNameGenerator p + +
    + Signature: synArgNameGenerator:SynArgNameGenerator -> p:SynPat -> SynSimplePats * (SynExpr -> SynExpr) option
    +
    +     		+ +
    + + StaticMemberFlags(k) + +
    + Signature: k:MemberKind -> MemberFlags
    +
    +     		+ +
    + + synExprContainsError(inpExpr) + +
    + Signature: inpExpr:SynExpr -> bool
    +
    +     		+ +
    + + textOfId(id) + +
    + Signature: id:Ident -> string
    +
    +     		+ +
    + + textOfLid(lid) + +
    + Signature: lid:Ident list -> string
    +
    +     		+ +
    + + textOfPath(path) + +
    + Signature: path:seq<string> -> string
    +
    +     		+ +
    +

    Active patterns

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Active patternDescription
    + + ( |Attributes| )(synAttributes) + +
    + Signature: synAttributes:SynAttributeList list -> SynAttribute list
    +
    +     		+ +

    CompiledName: |Attributes|

    +
    + + ( |LongOrSingleIdent|_| )(inp) + +
    + Signature: inp:SynExpr -> (bool * LongIdentWithDots * SynSimplePatAlternativeIdInfo ref option * range) option
    +
    +     		+

    Match a long identifier, including the case for single identifiers which gets a more optimized node in the syntax tree.

    + + +

    CompiledName: |LongOrSingleIdent|_|

    +
    + + ( |SingleIdent|_| )(inp) + +
    + Signature: inp:SynExpr -> Ident option
    +
    +     		+ +

    CompiledName: |SingleIdent|_|

    +
    + + ( |SynExprErrorSkip| )(p) + +
    + Signature: p:SynExpr -> SynExpr
    +
    +     		+ +

    CompiledName: |SynExprErrorSkip|

    +
    + + ( |SynExprParen|_| )(e) + +
    + Signature: e:SynExpr -> (SynExpr * range * range option * range) option
    +
    +     		+ +

    CompiledName: |SynExprParen|_|

    +
    + + ( |SynPatErrorSkip| )(p) + +
    + Signature: p:SynPat -> SynPat
    +
    +     		+ +

    CompiledName: |SynPatErrorSkip|

    +
    + + ( |SynPatForConstructorDecl|_| )(x) + +
    + Signature: x:SynPat -> SynPat option
    +
    +     		+

    Extract the argument for patterns corresponding to the declaration of 'new ... = ...'

    + + +

    CompiledName: |SynPatForConstructorDecl|_|

    +
    + + ( |SynPatForNullaryArgs|_| )(x) + +
    + Signature: x:SynPat -> unit option
    +
    +     		+

    Recognize the '()' in 'new()'

    + + +

    CompiledName: |SynPatForNullaryArgs|_|

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-buildphase.html b/docs/reference/fsharp-compiler-errorlogger-buildphase.html new file mode 100644 index 0000000000..2ccc238b5e --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-buildphase.html @@ -0,0 +1,252 @@ + + + + + BuildPhase - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    BuildPhase

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Closed enumeration of build phases.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + CodeGen + +
    + Signature:
    +
    +     		+ +
    + + Compile + +
    + Signature:
    +
    +     		+ +
    + + DefaultPhase + +
    + Signature:
    +
    +     		+ +
    + + IlGen + +
    + Signature:
    +
    +     		+ +
    + + IlxGen + +
    + Signature:
    +
    +     		+ +
    + + Interactive + +
    + Signature:
    +
    +     		+ +
    + + Optimize + +
    + Signature:
    +
    +     		+ +
    + + Output + +
    + Signature:
    +
    +     		+ +
    + + Parameter + +
    + Signature:
    +
    +     		+ +
    + + Parse + +
    + Signature:
    +
    +     		+ +
    + + TypeCheck + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-buildphasesubcategory.html b/docs/reference/fsharp-compiler-errorlogger-buildphasesubcategory.html new file mode 100644 index 0000000000..4285df0ff2 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-buildphasesubcategory.html @@ -0,0 +1,310 @@ + + + + + BuildPhaseSubcategory - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    BuildPhaseSubcategory

    +

    + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger +

    +
    +

    Literal build phase subcategory strings.

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + CodeGen + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + Compile + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + DefaultPhase + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + IlGen + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + IlxGen + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + Interactive + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + Internal + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + Optimize + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + Output + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + Parameter + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + Parse + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + TypeCheck + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-capturingerrorlogger.html b/docs/reference/fsharp-compiler-errorlogger-capturingerrorlogger.html new file mode 100644 index 0000000000..4c59c51f28 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-capturingerrorlogger.html @@ -0,0 +1,151 @@ + + + + + CapturingErrorLogger - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CapturingErrorLogger

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(nm) + +
    + Signature: nm:string -> CapturingErrorLogger
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.CommitDelayedDiagnostics(errorLogger) + +
    + Signature: errorLogger:ErrorLogger -> unit
    +
    +     		+ +
    + + x.Diagnostics + +
    + Signature: (PhasedDiagnostic * bool) list
    +
    +     		+ +

    CompiledName: get_Diagnostics

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-deprecated.html b/docs/reference/fsharp-compiler-errorlogger-deprecated.html new file mode 100644 index 0000000000..cc8c5b3c54 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-deprecated.html @@ -0,0 +1,128 @@ + + + + + Deprecated - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Deprecated

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: string
    +
    +     		+ +
    + + Data1 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-error.html b/docs/reference/fsharp-compiler-errorlogger-error.html new file mode 100644 index 0000000000..3e5c1b413a --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-error.html @@ -0,0 +1,128 @@ + + + + + Error - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Error

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: int * string
    +
    +     		+ +
    + + Data1 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-errorlogger.html b/docs/reference/fsharp-compiler-errorlogger-errorlogger.html new file mode 100644 index 0000000000..f14f40e6be --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-errorlogger.html @@ -0,0 +1,172 @@ + + + + + ErrorLogger - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ErrorLogger

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    + + Attributes:
    +[<AbstractClass>]
    +[<DebuggerDisplay("{DebugDisplay()}")>]
    + +     +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(nameForDebugging) + +
    + Signature: nameForDebugging:string -> ErrorLogger
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DebugDisplay() + +
    + Signature: unit -> string
    +
    +     		+ +
    + + x.DiagnosticSink(phasedError, isError) + +
    + Signature: (phasedError:PhasedDiagnostic * isError:bool) -> unit
    + Modifiers: abstract
    +
    +     		+ +
    + + x.ErrorCount + +
    + Signature: int
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_ErrorCount

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-errorloggerextensions.html b/docs/reference/fsharp-compiler-errorlogger-errorloggerextensions.html new file mode 100644 index 0000000000..086c008e15 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-errorloggerextensions.html @@ -0,0 +1,258 @@ + + + + + ErrorLoggerExtensions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ErrorLoggerExtensions

    +

    + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger + + Attributes:
    +[<AutoOpen>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + PreserveStackTrace(exn) + +
    + Signature: exn:'a -> unit
    + Type parameters: 'a
    +     		+

    Instruct the exception not to reset itself when thrown again.

    + + +
    + + ReraiseIfWatsonable(exn) + +
    + Signature: exn:exn -> unit
    +
    +     		+

    Reraise an exception if it is one we want to report to Watson.

    + + +
    + + tryAndDetectDev15 + +
    + Signature: bool
    +
    +     		+ +
    +

    Type extensions

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Type extensionDescription
    + + x.Error(exn) + +
    + Signature: exn:exn -> 'a
    + Type parameters: 'a
    +     		+ +

    CompiledName: ErrorLogger.Error

    +
    + + x.ErrorR(exn) + +
    + Signature: exn:exn -> unit
    +
    +     		+ +

    CompiledName: ErrorLogger.ErrorR

    +
    + + x.ErrorRecovery exn m + +
    + Signature: exn:exn -> m:range -> unit
    +
    +     		+ +

    CompiledName: ErrorLogger.ErrorRecovery

    +
    + + x.ErrorRecoveryNoRange(exn) + +
    + Signature: exn:exn -> unit
    +
    +     		+ +

    CompiledName: ErrorLogger.ErrorRecoveryNoRange

    +
    + + x.SimulateError(ph) + +
    + Signature: ph:PhasedDiagnostic -> '?692714
    + Type parameters: '?692714
    +     		+ +

    CompiledName: ErrorLogger.SimulateError

    +
    + + x.StopProcessingRecovery exn m + +
    + Signature: exn:exn -> m:range -> unit
    +
    +     		+ +

    CompiledName: ErrorLogger.StopProcessingRecovery

    +
    + + x.Warning(exn) + +
    + Signature: exn:exn -> unit
    +
    +     		+ +

    CompiledName: ErrorLogger.Warning

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-errorstyle.html b/docs/reference/fsharp-compiler-errorlogger-errorstyle.html new file mode 100644 index 0000000000..224dd7585f --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-errorstyle.html @@ -0,0 +1,174 @@ + + + + + ErrorStyle - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ErrorStyle

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Represents the style being used to format errors

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + DefaultErrors + +
    + Signature:
    +
    +     		+ +
    + + EmacsErrors + +
    + Signature:
    +
    +     		+ +
    + + GccErrors + +
    + Signature:
    +
    +     		+ +
    + + TestErrors + +
    + Signature:
    +
    +     		+ +
    + + VSErrors + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-errorwithsuggestions.html b/docs/reference/fsharp-compiler-errorlogger-errorwithsuggestions.html new file mode 100644 index 0000000000..6b581ae7e2 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-errorwithsuggestions.html @@ -0,0 +1,154 @@ + + + + + ErrorWithSuggestions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ErrorWithSuggestions

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: int * string
    +
    +     		+ +
    + + Data1 + +
    + Signature: range
    +
    +     		+ +
    + + Data2 + +
    + Signature: string
    +
    +     		+ +
    + + Data3 + +
    + Signature: Suggestions
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-exiter.html b/docs/reference/fsharp-compiler-errorlogger-exiter.html new file mode 100644 index 0000000000..e596b772f8 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-exiter.html @@ -0,0 +1,116 @@ + + + + + Exiter - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Exiter

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Exit(arg1) + +
    + Signature: int -> 'T
    + Modifiers: abstract
    + Type parameters: 'T
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-experimental.html b/docs/reference/fsharp-compiler-errorlogger-experimental.html new file mode 100644 index 0000000000..8cad777bac --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-experimental.html @@ -0,0 +1,128 @@ + + + + + Experimental - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Experimental

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: string
    +
    +     		+ +
    + + Data1 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-fsharperrorseverityoptions.html b/docs/reference/fsharp-compiler-errorlogger-fsharperrorseverityoptions.html new file mode 100644 index 0000000000..553af284bd --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-fsharperrorseverityoptions.html @@ -0,0 +1,202 @@ + + + + + FSharpErrorSeverityOptions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpErrorSeverityOptions

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + GlobalWarnAsError + +
    + Signature: bool
    +
    +     		+ +
    + + WarnAsError + +
    + Signature: int list
    +
    +     		+ +
    + + WarnAsWarn + +
    + Signature: int list
    +
    +     		+ +
    + + WarnLevel + +
    + Signature: int
    +
    +     		+ +
    + + WarnOff + +
    + Signature: int list
    +
    +     		+ +
    + + WarnOn + +
    + Signature: int list
    +
    +     		+ +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + FSharpErrorSeverityOptions.Default + +
    + Signature: FSharpErrorSeverityOptions
    +
    +     		+ +

    CompiledName: get_Default

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-imperativeoperationresult.html b/docs/reference/fsharp-compiler-errorlogger-imperativeoperationresult.html new file mode 100644 index 0000000000..2106854972 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-imperativeoperationresult.html @@ -0,0 +1,94 @@ + + + + + ImperativeOperationResult - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ImperativeOperationResult

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-internalerror.html b/docs/reference/fsharp-compiler-errorlogger-internalerror.html new file mode 100644 index 0000000000..ba05964a9b --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-internalerror.html @@ -0,0 +1,128 @@ + + + + + InternalError - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    InternalError

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data1 + +
    + Signature: range
    +
    +     		+ +
    + + msg + +
    + Signature: string
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-libraryuseonly.html b/docs/reference/fsharp-compiler-errorlogger-libraryuseonly.html new file mode 100644 index 0000000000..e04e63f927 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-libraryuseonly.html @@ -0,0 +1,115 @@ + + + + + LibraryUseOnly - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LibraryUseOnly

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-numberederror.html b/docs/reference/fsharp-compiler-errorlogger-numberederror.html new file mode 100644 index 0000000000..c4f06936e7 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-numberederror.html @@ -0,0 +1,128 @@ + + + + + NumberedError - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NumberedError

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: int * string
    +
    +     		+ +
    + + Data1 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-operationresult-1.html b/docs/reference/fsharp-compiler-errorlogger-operationresult-1.html new file mode 100644 index 0000000000..3c2869cfe3 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-operationresult-1.html @@ -0,0 +1,134 @@ + + + + + OperationResult<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    OperationResult<'T>

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ErrorResult(exn list,exn) + +
    + Signature: exn list * exn
    +
    +     		+ +
    + + OkResult(exn list,'T) + +
    + Signature: exn list * 'T
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-operationresult.html b/docs/reference/fsharp-compiler-errorlogger-operationresult.html new file mode 100644 index 0000000000..81d7ef689b --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-operationresult.html @@ -0,0 +1,122 @@ + + + + + OperationResult - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    OperationResult

    +

    + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + OperationResult.ignore(res) + +
    + Signature: res:OperationResult<'a> -> OperationResult<unit>
    + Type parameters: 'a
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-phaseddiagnostic.html b/docs/reference/fsharp-compiler-errorlogger-phaseddiagnostic.html new file mode 100644 index 0000000000..03dc8134c2 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-phaseddiagnostic.html @@ -0,0 +1,229 @@ + + + + + PhasedDiagnostic - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PhasedDiagnostic

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    + + Attributes:
    +[<DebuggerDisplay("{DebugDisplay()}")>]
    + +     +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Exception + +
    + Signature: exn
    +
    +     		+ +
    + + Phase + +
    + Signature: BuildPhase
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DebugDisplay() + +
    + Signature: unit -> string
    +
    +     		+ +
    + + x.IsPhaseInCompile() + +
    + Signature: unit -> bool
    +
    +     		+

    the language service knows about.

    + + +
    + + x.Subcategory() + +
    + Signature: unit -> string
    +
    +     		+

    This is the textual subcategory to display in error and warning messages (shows only under --vserrors):

    + + + +
    1: 
+
    file1.fs(72): subcategory warning FS0072: This is a warning message
+
    + + +
    +

    Static members

    + + + + + + + + + + + + + + +
    Static memberDescription
    + + PhasedDiagnostic.Create(exn, phase) + +
    + Signature: (exn:exn * phase:BuildPhase) -> PhasedDiagnostic
    +
    +     		+

    Construct a phased error

    + + +
    + + PhasedDiagnostic.IsSubcategoryOfCompile(...) + +
    + Signature: subcategory:string -> bool
    +
    +     		+

    Return true if the textual phase given is from the compile part of the build process. +This set needs to be equal to the set of subcategories that the language service can produce.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-possibleunverifiablecode.html b/docs/reference/fsharp-compiler-errorlogger-possibleunverifiablecode.html new file mode 100644 index 0000000000..9e13fc7b88 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-possibleunverifiablecode.html @@ -0,0 +1,115 @@ + + + + + PossibleUnverifiableCode - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PossibleUnverifiableCode

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-reportederror.html b/docs/reference/fsharp-compiler-errorlogger-reportederror.html new file mode 100644 index 0000000000..f241868aa0 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-reportederror.html @@ -0,0 +1,122 @@ + + + + + ReportedError - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ReportedError

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +

    Thrown when immediate, local error recovery is not possible. This indicates +we've reported an error but need to make a non-local transfer of control. +Error recovery may catch this and continue (see 'errorRecovery')

    +

    The exception that caused the report is carried as data because in some +situations (LazyWithContext) we may need to re-report the original error +when a lazy thunk is re-evaluated.

    + +
    +

    Record Fields

    + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: exn option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-stopprocessingexn.html b/docs/reference/fsharp-compiler-errorlogger-stopprocessingexn.html new file mode 100644 index 0000000000..1137824e90 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-stopprocessingexn.html @@ -0,0 +1,117 @@ + + + + + StopProcessingExn - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    StopProcessingExn

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +

    Thrown when we stop processing the F# Interactive entry or #load.

    + +
    +

    Record Fields

    + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: exn option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-suggestions.html b/docs/reference/fsharp-compiler-errorlogger-suggestions.html new file mode 100644 index 0000000000..255b6e57be --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-suggestions.html @@ -0,0 +1,94 @@ + + + + + Suggestions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Suggestions

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-trackerrorsbuilder.html b/docs/reference/fsharp-compiler-errorlogger-trackerrorsbuilder.html new file mode 100644 index 0000000000..c0124efdd7 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-trackerrorsbuilder.html @@ -0,0 +1,241 @@ + + + + + TrackErrorsBuilder - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    TrackErrorsBuilder

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> TrackErrorsBuilder
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Bind(res, k) + +
    + Signature: (res:OperationResult<'a> * k:('a -> OperationResult<'b>)) -> OperationResult<'b>
    + Type parameters: 'a, 'b
    +     		+ +
    + + x.Combine(expr1, expr2) + +
    + Signature: (expr1:OperationResult<'h> * expr2:('h -> OperationResult<'i>)) -> OperationResult<'i>
    + Type parameters: 'h, 'i
    +     		+ +
    + + x.Delay(fn) + +
    + Signature: (fn:(unit -> 'a)) -> unit -> 'a
    + Type parameters: 'a
    +     		+ +
    + + x.For(seq, k) + +
    + Signature: (seq:'a list * k:('a -> OperationResult<unit>)) -> OperationResult<unit>
    + Type parameters: 'a
    +     		+ +
    + + x.Return(res) + +
    + Signature: res:'h -> OperationResult<'h>
    + Type parameters: 'h
    +     		+ +
    + + x.ReturnFrom(res) + +
    + Signature: res:'a -> 'a
    + Type parameters: 'a
    +     		+ +
    + + x.Run(fn) + +
    + Signature: (fn:(unit -> 'a)) -> 'a
    + Type parameters: 'a
    +     		+ +
    + + x.While(gd, k) + +
    + Signature: (gd:(unit -> bool) * k:(unit -> OperationResult<unit>)) -> OperationResult<unit>
    +
    +     		+ +
    + + x.Zero() + +
    + Signature: unit -> OperationResult<unit>
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreference.html b/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreference.html new file mode 100644 index 0000000000..535d68f1e3 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreference.html @@ -0,0 +1,141 @@ + + + + + UnresolvedPathReference - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UnresolvedPathReference

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: string
    +
    +     		+ +
    + + Data1 + +
    + Signature: string
    +
    +     		+ +
    + + Data2 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreferencenorange.html b/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreferencenorange.html new file mode 100644 index 0000000000..914ec6b87b --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-unresolvedpathreferencenorange.html @@ -0,0 +1,128 @@ + + + + + UnresolvedPathReferenceNoRange - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UnresolvedPathReferenceNoRange

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: string
    +
    +     		+ +
    + + Data1 + +
    + Signature: string
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-unresolvedreferenceerror.html b/docs/reference/fsharp-compiler-errorlogger-unresolvedreferenceerror.html new file mode 100644 index 0000000000..972e970184 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-unresolvedreferenceerror.html @@ -0,0 +1,128 @@ + + + + + UnresolvedReferenceError - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UnresolvedReferenceError

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: string
    +
    +     		+ +
    + + Data1 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-unresolvedreferencenorange.html b/docs/reference/fsharp-compiler-errorlogger-unresolvedreferencenorange.html new file mode 100644 index 0000000000..f9c8390bfa --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-unresolvedreferencenorange.html @@ -0,0 +1,115 @@ + + + + + UnresolvedReferenceNoRange - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UnresolvedReferenceNoRange

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: string
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-usercompilermessage.html b/docs/reference/fsharp-compiler-errorlogger-usercompilermessage.html new file mode 100644 index 0000000000..334bbe652e --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-usercompilermessage.html @@ -0,0 +1,141 @@ + + + + + UserCompilerMessage - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UserCompilerMessage

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: string
    +
    +     		+ +
    + + Data1 + +
    + Signature: int
    +
    +     		+ +
    + + Data2 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger-wrappederror.html b/docs/reference/fsharp-compiler-errorlogger-wrappederror.html new file mode 100644 index 0000000000..f7faeb0fe7 --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger-wrappederror.html @@ -0,0 +1,130 @@ + + + + + WrappedError - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    WrappedError

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ErrorLogger
    +

    +
    +

    Thrown when we want to add some range information to a .NET exception

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: exn
    +
    +     		+ +
    + + Data1 + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-errorlogger.html b/docs/reference/fsharp-compiler-errorlogger.html new file mode 100644 index 0000000000..61f7c9eabe --- /dev/null +++ b/docs/reference/fsharp-compiler-errorlogger.html @@ -0,0 +1,1144 @@ + + + + + ErrorLogger - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ErrorLogger

    +

    + Namespace: FSharp.Compiler
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + BuildPhase + +

    Closed enumeration of build phases.

    + + +
    + CapturingErrorLogger + + +
    + Deprecated + + +
    + Error + + +
    + ErrorLogger + + +
    + ErrorStyle + +

    Represents the style being used to format errors

    + + +
    + ErrorWithSuggestions + + +
    + Exiter + + +
    + Experimental + + +
    + FSharpErrorSeverityOptions + + +
    + ImperativeOperationResult + + +
    + InternalError + + +
    + LibraryUseOnly + + +
    + NumberedError + + +
    + OperationResult<'T> + + +
    + PhasedDiagnostic + + +
    + PossibleUnverifiableCode + + +
    + ReportedError + +

    Thrown when immediate, local error recovery is not possible. This indicates +we've reported an error but need to make a non-local transfer of control. +Error recovery may catch this and continue (see 'errorRecovery')

    +

    The exception that caused the report is carried as data because in some +situations (LazyWithContext) we may need to re-report the original error +when a lazy thunk is re-evaluated.

    + + +
    + StopProcessingExn + +

    Thrown when we stop processing the F# Interactive entry or #load.

    + + +
    + Suggestions + + +
    + TrackErrorsBuilder + + +
    + UnresolvedPathReference + + +
    + UnresolvedPathReferenceNoRange + + +
    + UnresolvedReferenceError + + +
    + UnresolvedReferenceNoRange + + +
    + UserCompilerMessage + + +
    + WrappedError + +

    Thrown when we want to add some range information to a .NET exception

    + + +
    + + + + + + + + + + + + + + + + + + +
    ModuleDescription
    + BuildPhaseSubcategory + +

    Literal build phase subcategory strings.

    + + +
    + ErrorLoggerExtensions + + +
    + OperationResult + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + ( ++ ) res f + +
    + Signature: res:OperationResult<'a> -> f:('a -> OperationResult<'b>) -> OperationResult<'b>
    + Type parameters: 'a, 'b
    +     		+

    The bind in the monad. Stop on first error. Accumulate warnings and continue.

    + + +

    CompiledName: op_PlusPlus

    +
    + + AssertFalseErrorLogger + +
    + Signature: ErrorLogger
    +
    +     		+ +
    + + AtLeastOneD f l + +
    + Signature: f:('h -> OperationResult<bool>) -> l:'h list -> OperationResult<bool>
    + Type parameters: 'h
    +     		+ +
    + + AttachRange m exn + +
    + Signature: m:range -> exn:exn -> exn
    +
    +     		+ +
    + + CheckNoErrorsAndGetWarnings(res) + +
    + Signature: res:OperationResult<'c> -> exn list option
    + Type parameters: 'c
    +     		+ +
    + + CommitOperationResult(res) + +
    + Signature: res:OperationResult<'a> -> 'a
    + Type parameters: 'a
    +     		+ +
    + + CompleteD + +
    + Signature: OperationResult<unit>
    +
    +     		+ +
    + + conditionallySuppressErrorReporting(...) + +
    + Signature: cond:bool -> f:(unit -> 'a2) -> 'a2
    + Type parameters: 'a2
    +     		+ +
    + + deprecatedOperator(m) + +
    + Signature: m:range -> unit
    +
    +     		+ +
    + + deprecatedWithError s m + +
    + Signature: s:string -> m:range -> unit
    +
    +     		+ +
    + + diagnosticSink(phasedError, isError) + +
    + Signature: (phasedError:PhasedDiagnostic * isError:bool) -> unit
    +
    +     		+ +
    + + DiscardErrorsLogger + +
    + Signature: ErrorLogger
    +
    +     		+ +
    + + error(exn) + +
    + Signature: exn:exn -> 'a
    + Type parameters: 'a
    +     		+

    Raises a special exception and returns 'T - can be caught later at an errorRecovery point.

    + + +
    + + ErrorD(err) + +
    + Signature: err:exn -> OperationResult<'a>
    + Type parameters: 'a
    +     		+ +
    + + errorR(exn) + +
    + Signature: exn:exn -> unit
    +
    +     		+

    Raises an exception with error recovery and returns unit.

    + + +
    + + errorRecovery exn m + +
    + Signature: exn:exn -> m:range -> unit
    +
    +     		+ +
    + + errorRecoveryNoRange(exn) + +
    + Signature: exn:exn -> unit
    +
    +     		+ +
    + + errorSink(pe) + +
    + Signature: pe:PhasedDiagnostic -> unit
    +
    +     		+ +
    + + findOriginalException(err) + +
    + Signature: err:exn -> exn
    +
    +     		+ +
    + + Iterate2D f xs ys + +
    + Signature: f:('h -> 'i -> OperationResult<unit>) -> xs:'h list -> ys:'i list -> OperationResult<unit>
    + Type parameters: 'h, 'i
    +     		+

    Stop on first error. Accumulate warnings and continue.

    + + +
    + + IterateD f xs + +
    + Signature: f:('h -> OperationResult<unit>) -> xs:'h list -> OperationResult<unit>
    + Type parameters: 'h
    +     		+

    Stop on first error. Accumulate warnings and continue.

    + + +
    + + IterateIdxD f xs + +
    + Signature: f:(int -> 'h -> OperationResult<unit>) -> xs:'h list -> OperationResult<unit>
    + Type parameters: 'h
    +     		+

    Stop on first error. Report index

    + + +
    + + libraryOnlyError(m) + +
    + Signature: m:range -> unit
    +
    +     		+ +
    + + libraryOnlyWarning(m) + +
    + Signature: m:range -> unit
    +
    +     		+ +
    + + MapD f xs + +
    + Signature: f:('?692618 -> OperationResult<'?692619>) -> xs:'?692618 list -> OperationResult<'?692619 list>
    + Type parameters: '?692618, '?692619
    +     		+ +
    + + mlCompatWarning s m + +
    + Signature: s:String -> m:range -> unit
    +
    +     		+ +
    + + NewlineifyErrorString(message) + +
    + Signature: message:string -> string
    +
    +     		+ +
    + + NormalizeErrorString(text) + +
    + Signature: text:string -> string
    +
    +     		+

    fixes given string by replacing all control chars with spaces. +NOTE: newlines are recognized and replaced with stringThatIsAProxyForANewlineInFlatErrors (ASCII 29, the 'group separator'), +which is decoded by the IDE with 'NewlineifyErrorString' back into newlines, so that multi-line errors can be displayed in QuickInfo

    + + +
    + + NoSuggestions + +
    + Signature: Suggestions
    +
    +     		+ +
    + + OptionD f xs + +
    + Signature: f:('?692641 -> OperationResult<unit>) -> xs:'?692641 option -> OperationResult<unit>
    + Type parameters: '?692641
    +     		+

    Stop on first error. Accumulate warnings and continue.

    + + +
    + + protectAssemblyExploration dflt f + +
    + Signature: dflt:'a -> f:(unit -> 'a) -> 'a
    + Type parameters: 'a
    +     		+ +
    + + protectAssemblyExplorationF dflt f + +
    + Signature: dflt:(string * string -> 'b) -> f:(unit -> 'b) -> 'b
    + Type parameters: 'b
    +     		+ +
    + + protectAssemblyExplorationNoReraise(...) + +
    + Signature: dflt1:'a -> dflt2:'a -> f:(unit -> 'a) -> 'a
    + Type parameters: 'a
    +     		+ +
    + + PushErrorLoggerPhaseUntilUnwind(...) + +
    + Signature: errorLoggerTransformer:(ErrorLogger -> 'a) -> IDisposable
    + Type parameters: 'a
    +     		+

    NOTE: The change will be undone when the returned "unwind" object disposes

    + + +
    + + PushThreadBuildPhaseUntilUnwind(phase) + +
    + Signature: phase:BuildPhase -> IDisposable
    +
    +     		+

    NOTE: The change will be undone when the returned "unwind" object disposes

    + + +
    + + QuitProcessExiter + +
    + Signature: Exiter
    +
    +     		+ +
    + + RaiseOperationResult(res) + +
    + Signature: res:OperationResult<unit> -> unit
    +
    +     		+ +
    + + RepeatWhileD nDeep body + +
    + Signature: nDeep:int -> body:(int -> OperationResult<bool>) -> OperationResult<unit>
    +
    +     		+ +
    + + report(f) + +
    + Signature: f:(unit -> '?692587) -> '?692587
    + Type parameters: '?692587
    +     		+ +
    + + reportLibraryOnlyFeatures + +
    + Signature: bool
    +
    +     		+ +
    + + ReportWarnings(warns) + +
    + Signature: warns:'b list -> unit
    + Type parameters: 'b
    +     		+ +
    + + ResultD(x) + +
    + Signature: x:'h -> OperationResult<'h>
    + Type parameters: 'h
    +     		+ +
    + + SetThreadBuildPhaseNoUnwind(phase) + +
    + Signature: phase:BuildPhase -> unit
    +
    +     		+ +
    + + SetThreadErrorLoggerNoUnwind(...) + +
    + Signature: errorLogger:ErrorLogger -> unit
    +
    +     		+ +
    + + simulateError(p) + +
    + Signature: p:PhasedDiagnostic -> 'a
    + Type parameters: 'a
    +     		+

    Simulates an error. For test purposes only.

    + + +
    + + StopProcessing + +
    + Signature: exn
    + Type parameters: 'T
    +     		+ +
    + + stopProcessingRecovery exn m + +
    + Signature: exn:exn -> m:range -> unit
    +
    +     		+ +
    + + stringThatIsAProxyForANewlineInFlatErrors(...) + +
    + Signature: String
    +
    +     		+ +
    + + suppressErrorReporting(f) + +
    + Signature: f:(unit -> 'a2) -> 'a2
    + Type parameters: 'a2
    +     		+ +
    + + trackErrors + +
    + Signature: TrackErrorsBuilder
    +
    +     		+ +
    + + TryD f g + +
    + Signature: f:(unit -> OperationResult<'a>) -> g:(exn -> OperationResult<'a>) -> OperationResult<'a>
    + Type parameters: 'a
    +     		+

    Keep the warnings, propagate the error to the exception continuation.

    + + +
    + + WarnD(err) + +
    + Signature: err:exn -> OperationResult<unit>
    +
    +     		+ +
    + + warning(exn) + +
    + Signature: exn:exn -> unit
    +
    +     		+

    Raises a warning with error recovery and returns unit.

    + + +
    + + warnSink(pe) + +
    + Signature: pe:PhasedDiagnostic -> unit
    +
    +     		+ +
    + + WhileD gd body + +
    + Signature: gd:(unit -> bool) -> body:(unit -> OperationResult<unit>) -> OperationResult<unit>
    +
    +     		+ +
    +

    Active patterns

    + + + + + + + + + + +
    Active patternDescription
    + + ( |StopProcessing|_| )(exn) + +
    + Signature: exn:exn -> unit option
    +
    +     		+ +

    CompiledName: |StopProcessing|_|

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-compilerinputstream.html b/docs/reference/fsharp-compiler-interactive-shell-compilerinputstream.html new file mode 100644 index 0000000000..bc2da26fad --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-compilerinputstream.html @@ -0,0 +1,146 @@ + + + + + CompilerInputStream - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CompilerInputStream

    +

    + + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Shell
    + + Attributes:
    +[<AllowNullLiteral>]
    + +     +

    +
    +

    Defines a read-only input stream used to feed content to the hosted F# Interactive dynamic compiler.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> CompilerInputStream
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Add(str) + +
    + Signature: str:string -> unit
    +
    +     		+

    Feeds content into the stream.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-compileroutputstream.html b/docs/reference/fsharp-compiler-interactive-shell-compileroutputstream.html new file mode 100644 index 0000000000..a66127b7a0 --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-compileroutputstream.html @@ -0,0 +1,144 @@ + + + + + CompilerOutputStream - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CompilerOutputStream

    +

    + + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Shell
    + + Attributes:
    +[<AllowNullLiteral>]
    + +     +

    +
    +

    Defines a write-only stream used to capture output of the hosted F# Interactive dynamic compiler.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> CompilerOutputStream
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Read() + +
    + Signature: unit -> string
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-evaluationeventargs.html b/docs/reference/fsharp-compiler-interactive-shell-evaluationeventargs.html new file mode 100644 index 0000000000..480016e8be --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-evaluationeventargs.html @@ -0,0 +1,187 @@ + + + + + EvaluationEventArgs - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    EvaluationEventArgs

    +

    + + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Shell
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.FsiValue + +
    + Signature: FsiValue option
    +
    +     		+

    The value of the symbol defined, if any

    + + +

    CompiledName: get_FsiValue

    +
    + + x.ImplementationDeclaration + +
    + Signature: FSharpImplementationFileDeclaration
    +
    +     		+

    The details of the expression defined

    + + +

    CompiledName: get_ImplementationDeclaration

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    The display name of the symbol defined

    + + +

    CompiledName: get_Name

    +
    + + x.Symbol + +
    + Signature: FSharpSymbol
    +
    +     		+

    The symbol defined

    + + +

    CompiledName: get_Symbol

    +
    + + x.SymbolUse + +
    + Signature: FSharpSymbolUse
    +
    +     		+

    The FSharpSymbolUse for the symbol defined

    + + +

    CompiledName: get_SymbolUse

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-fsicompilationexception.html b/docs/reference/fsharp-compiler-interactive-shell-fsicompilationexception.html new file mode 100644 index 0000000000..b3e1be7344 --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-fsicompilationexception.html @@ -0,0 +1,145 @@ + + + + + FsiCompilationException - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FsiCompilationException

    +

    + + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Shell
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Thrown when there was an error compiling the given code in FSI.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(arg1, arg2) + +
    + Signature: (string * FSharpErrorInfo [] option) -> FsiCompilationException
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.ErrorInfos + +
    + Signature: FSharpErrorInfo [] option
    +
    +     		+ +

    CompiledName: get_ErrorInfos

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsession.html b/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsession.html new file mode 100644 index 0000000000..6b6314157b --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsession.html @@ -0,0 +1,702 @@ + + + + + FsiEvaluationSession - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FsiEvaluationSession

    +

    + + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Shell
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents an F# Interactive evaluation session.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.add_DependencyAdded(arg1) + +
    + Signature: (Handler<string * string * string list * string list>) -> unit
    + + Attributes:
    +[<CLIEvent>]
    +     +
    +     		+

    Event fires at the successful completion of adding a dependency via the dependency manager.

    + + +
    + + x.add_DependencyAdding(arg1) + +
    + Signature: (Handler<string * string>) -> unit
    + + Attributes:
    +[<CLIEvent>]
    +     +
    +     		+

    Event fires at the start of adding a dependency via the dependency manager.

    + + +
    + + x.add_DependencyFailed(arg1) + +
    + Signature: (Handler<string * string>) -> unit
    + + Attributes:
    +[<CLIEvent>]
    +     +
    +     		+

    Event fires at the failure to adding a dependency via the dependency manager.

    + + +
    + + x.CurrentPartialAssemblySignature + +
    + Signature: FSharpAssemblySignature
    +
    +     		+

    Get a handle to the resolved view of the current signature of the incrementally generated assembly.

    + + +

    CompiledName: get_CurrentPartialAssemblySignature

    +
    + + x.DependencyAdded + +
    + Signature: IEvent<string * string * string list * string list>
    + + Attributes:
    +[<CLIEvent>]
    +     +
    +     		+

    Event fires at the successful completion of adding a dependency via the dependency manager.

    + + +

    CompiledName: get_DependencyAdded

    +
    + + x.DependencyAdding + +
    + Signature: IEvent<string * string>
    + + Attributes:
    +[<CLIEvent>]
    +     +
    +     		+

    Event fires at the start of adding a dependency via the dependency manager.

    + + +

    CompiledName: get_DependencyAdding

    +
    + + x.DependencyFailed + +
    + Signature: IEvent<string * string>
    + + Attributes:
    +[<CLIEvent>]
    +     +
    +     		+

    Event fires at the failure to adding a dependency via the dependency manager.

    + + +

    CompiledName: get_DependencyFailed

    +
    + + x.DynamicAssembly + +
    + Signature: Assembly
    +
    +     		+

    Get a handle to the dynamically generated assembly

    + + +

    CompiledName: get_DynamicAssembly

    +
    + + x.EvalExpression(code) + +
    + Signature: code:string -> FsiValue option
    +
    +     		+

    Execute the code as if it had been entered as one or more interactions, with an +implicit termination at the end of the input. Stop on first error, discarding the rest +of the input. Errors are sent to the output writer. Parsing is performed on the current thread, and execution is performed +synchronously on the 'main' thread.

    +

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered +by input from 'stdin'.

    + + +
    + + x.EvalExpressionNonThrowing(code) + +
    + Signature: code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
    +
    +     		+

    Execute the code as if it had been entered as one or more interactions, with an +implicit termination at the end of the input. Stop on first error, discarding the rest +of the input. Errors and warnings are collected apart from any exception arising from execution +which is returned via a Choice. Parsing is performed on the current thread, and execution is performed +synchronously on the 'main' thread.

    +

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered +by input from 'stdin'.

    + + +
    + + x.EvalInteraction(...) + +
    + Signature: (code:string * cancellationToken:CancellationToken option) -> unit
    +
    +     		+

    Execute the code as if it had been entered as one or more interactions, with an +implicit termination at the end of the input. Stop on first error, discarding the rest +of the input. Errors are sent to the output writer, a 'true' return value indicates there +were no errors overall. Execution is performed on the 'Run()' thread.

    +

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered +by input from 'stdin'.

    + + +
    + + x.EvalInteractionNonThrowing(...) + +
    + Signature: (code:string * cancellationToken:CancellationToken option) -> Choice<FsiValue option,exn> * FSharpErrorInfo []
    +
    +     		+

    Execute the code as if it had been entered as one or more interactions, with an +implicit termination at the end of the input. Stop on first error, discarding the rest +of the input. Errors and warnings are collected apart from any exception arising from execution +which is returned via a Choice. Execution is performed on the 'Run()' thread.

    +

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered +by input from 'stdin'.

    + + +
    + + x.EvalScript(filePath) + +
    + Signature: filePath:string -> unit
    +
    +     		+

    Execute the given script. Stop on first error, discarding the rest +of the script. Errors are sent to the output writer, a 'true' return value indicates there +were no errors overall. Execution is performed on the 'Run()' thread.

    +

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered +by input from 'stdin'.

    + + +
    + + x.EvalScriptNonThrowing(filePath) + +
    + Signature: filePath:string -> Choice<unit,exn> * FSharpErrorInfo []
    +
    +     		+

    Execute the given script. Stop on first error, discarding the rest +of the script. Errors and warnings are collected apart from any exception arising from execution +which is returned via a Choice. Execution is performed on the 'Run()' thread.

    +

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered +by input from 'stdin'.

    + + +
    + + x.FormatValue(...) + +
    + Signature: (reflectionValue:obj * reflectionType:Type) -> string
    +
    +     		+

    Format a value to a string using the current PrintDepth, PrintLength etc settings provided by the active fsi configuration object

    + + +
    + + x.GetCompletions(longIdent) + +
    + Signature: longIdent:string -> seq<string>
    +
    +     		+

    A host calls this to get the completions for a long identifier, e.g. in the console

    +

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered +by input from 'stdin'.

    + + +
    + + x.InteractiveChecker + +
    + Signature: FSharpChecker
    +
    +     		+

    The single, global interactive checker to use in conjunction with other operations +on the FsiEvaluationSession.

    +

    If you are using an FsiEvaluationSession in this process, you should only use this InteractiveChecker +for additional checking operations.

    + + +

    CompiledName: get_InteractiveChecker

    +
    + + x.Interrupt() + +
    + Signature: unit -> unit
    +
    +     		+

    A host calls this to request an interrupt on the evaluation thread.

    + + +
    + + x.IsGui + +
    + Signature: bool
    +
    +     		+

    A host calls this to determine if the --gui parameter is active

    + + +

    CompiledName: get_IsGui

    +
    + + x.LCID + +
    + Signature: int option
    +
    +     		+

    A host calls this to get the active language ID if provided by fsi-server-lcid

    + + +

    CompiledName: get_LCID

    +
    + + x.ParseAndCheckInteraction(code) + +
    + Signature: code:string -> Async<FSharpParseFileResults * FSharpCheckFileResults * FSharpCheckProjectResults>
    +
    +     		+

    Typecheck the given script fragment in the type checking context implied by the current state +of F# Interactive. The results can be used to access intellisense, perform resolutions, +check brace matching and other information.

    +

    Operations may be run concurrently with other requests to the InteractiveChecker.

    +

    Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered +by input from 'stdin'.

    + + +
    + + x.PartialAssemblySignatureUpdated + +
    + Signature: IEvent<unit>
    +
    +     		+

    Raised when an interaction is successfully typechecked and executed, resulting in an update to the +type checking state.

    +

    This event is triggered after parsing and checking, either via input from 'stdin', or via a call to EvalInteraction.

    + + +

    CompiledName: get_PartialAssemblySignatureUpdated

    +
    + + x.remove_DependencyAdded(arg1) + +
    + Signature: (Handler<string * string * string list * string list>) -> unit
    + + Attributes:
    +[<CLIEvent>]
    +     +
    +     		+

    Event fires at the successful completion of adding a dependency via the dependency manager.

    + + +
    + + x.remove_DependencyAdding(arg1) + +
    + Signature: (Handler<string * string>) -> unit
    + + Attributes:
    +[<CLIEvent>]
    +     +
    +     		+

    Event fires at the start of adding a dependency via the dependency manager.

    + + +
    + + x.remove_DependencyFailed(arg1) + +
    + Signature: (Handler<string * string>) -> unit
    + + Attributes:
    +[<CLIEvent>]
    +     +
    +     		+

    Event fires at the failure to adding a dependency via the dependency manager.

    + + +
    + + x.ReportUnhandledException(exn) + +
    + Signature: exn:exn -> unit
    +
    +     		+

    A host calls this to report an unhandled exception in a standard way, e.g. an exception on the GUI thread gets printed to stderr

    + + +
    + + x.Run() + +
    + Signature: unit -> unit
    +
    +     		+

    Load the dummy interaction, load the initial files, and, +if interacting, start the background thread to read the standard input.

    +

    Performs these steps: +- Load the dummy interaction, if any +- Set up exception handling, if any +- Load the initial files, if any +- Start the background thread to read the standard input, if any +- Sit in the GUI event loop indefinitely, if needed

    + + +
    + + x.ValueBound + +
    + Signature: IEvent<obj * Type * string>
    +
    +     		+

    Event fires when a root-level value is bound to an identifier, e.g., via let x = ....

    + + +

    CompiledName: get_ValueBound

    +
    +

    Static members

    + + + + + + + + + + + + + + + + + + + + + + +
    Static memberDescription
    + + FsiEvaluationSession.Create(...) + +
    + Signature: (fsiConfig:FsiEvaluationSessionHostConfig * argv:string [] * inReader:TextReader * outWriter:TextWriter * errorWriter:TextWriter * collectible:bool option * legacyReferenceResolver:Resolver option) -> FsiEvaluationSession
    +
    +     		+

    Create an FsiEvaluationSession, reading from the given text input, writing to the given text output and error writers.

    +Create an FsiEvaluationSession, reading from the given text input, writing to the given text output and error writers +The dynamic configuration of the evaluation session +The command line arguments for the evaluation session +Read input from the given reader +Write output to the given writer +Optionally make the dynamic assembly for the session collectible + + +
    + + FsiEvaluationSession.GetDefaultConfiguration(...) + +
    + Signature: unit -> FsiEvaluationSessionHostConfig
    +
    +     		+

    Get a configuration that uses a private inbuilt implementation of the 'fsi' object and does not +implicitly reference FSharp.Compiler.Interactive.Settings.dll.

    + + +
    + + FsiEvaluationSession.GetDefaultConfiguration(...) + +
    + Signature: fsiObj:obj -> FsiEvaluationSessionHostConfig
    +
    +     		+

    Get a configuration that uses the 'fsi' object (normally from FSharp.Compiler.Interactive.Settings.dll, +an object from another DLL with identical characteristics) to provide an implementation of the configuration. +FSharp.Compiler.Interactive.Settings.dll is referenced by default.

    + + +
    + + FsiEvaluationSession.GetDefaultConfiguration(...) + +
    + Signature: (fsiObj:obj * useFsiAuxLib:bool) -> FsiEvaluationSessionHostConfig
    +
    +     		+

    Get a configuration that uses the 'fsi' object (normally from FSharp.Compiler.Interactive.Settings.dll, +an object from another DLL with identical characteristics) to provide an implementation of the configuration. +The flag indicates if FSharp.Compiler.Interactive.Settings.dll is referenced by default.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html b/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html new file mode 100644 index 0000000000..c1cba79257 --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-fsievaluationsessionhostconfig.html @@ -0,0 +1,440 @@ + + + + + FsiEvaluationSessionHostConfig - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FsiEvaluationSessionHostConfig

    +

    + + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Shell
    + + Attributes:
    +[<AbstractClass>]
    + +     +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> FsiEvaluationSessionHostConfig
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AddedPrinters + +
    + Signature: Choice<(Type * (obj -> string)),(Type * (obj -> obj))> list
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_AddedPrinters

    +
    + + x.EventLoopInvoke(codeToRun) + +
    + Signature: (codeToRun:(unit -> 'T)) -> 'T
    + Modifiers: abstract
    + Type parameters: 'T
    +     		+

    Request that the given operation be run synchronously on the event loop.

    + + +
    + + x.EventLoopRun() + +
    + Signature: unit -> bool
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host to enter a dispatch loop like Application.Run(). +Only called if --gui option is used (which is the default). +Gets called towards the end of startup and every time a ThreadAbort escaped to the backup driver loop. +Return true if a 'restart' is required, which is a bit meaningless.

    + + +
    + + x.EventLoopScheduleRestart() + +
    + Signature: unit -> unit
    + Modifiers: abstract
    +
    +     		+

    Schedule a restart for the event loop.

    + + +
    + + x.FloatingPointFormat + +
    + Signature: string
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_FloatingPointFormat

    +
    + + x.FormatProvider + +
    + Signature: IFormatProvider
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_FormatProvider

    +
    + + x.GetOptionalConsoleReadLine(...) + +
    + Signature: probeToSeeIfConsoleWorks:bool -> (unit -> string) option
    + Modifiers: abstract
    +
    +     		+

    Indicate a special console "readline" reader for the evaluation session, if any. A "console" gets used if --readline is specified (the default on Windows + .NET); and --fsi-server is not +given (always combine with --readline-), and OptionalConsoleReadLine is given. +When a console is used, special rules apply to "peekahead", which allows early typing on the console. +Peekahead happens if --peekahead- is not specified (the default). +In this case, a prompt is printed early, a background thread is created and +the OptionalConsoleReadLine is used to read the first line. +If a console is not used, then inReader.Peek() is called early instead. +Further lines are read using OptionalConsoleReadLine(). +If not provided, lines are read using inReader.ReadLine().

    + + +
    + + x.OnEvaluation + +
    + Signature: IEvent<EvaluationEventArgs>
    +
    +     		+

    Hook for listening for evaluation bindings

    + + +

    CompiledName: get_OnEvaluation

    +
    + + x.PrintDepth + +
    + Signature: int
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_PrintDepth

    +
    + + x.PrintLength + +
    + Signature: int
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_PrintLength

    +
    + + x.PrintSize + +
    + Signature: int
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_PrintSize

    +
    + + x.PrintWidth + +
    + Signature: int
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_PrintWidth

    +
    + + x.ReportUserCommandLineArgs(arg1) + +
    + Signature: (string []) -> unit
    + Modifiers: abstract
    +
    +     		+

    The evaluation session calls this to report the preferred view of the command line arguments after +stripping things like "/use:file.fsx", "-r:Foo.dll" etc.

    + + +
    + + x.ShowDeclarationValues + +
    + Signature: bool
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_ShowDeclarationValues

    +
    + + x.ShowIEnumerable + +
    + Signature: bool
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_ShowIEnumerable

    +
    + + x.ShowProperties + +
    + Signature: bool
    + Modifiers: abstract
    +
    +     		+

    Called by the evaluation session to ask the host for parameters to format text for output

    + + +

    CompiledName: get_ShowProperties

    +
    + + x.StartServer(fsiServerName) + +
    + Signature: fsiServerName:string -> unit
    + Modifiers: abstract
    +
    +     		+

    The evaluation session calls this at an appropriate point in the startup phase if the --fsi-server parameter was given

    + + +
    + + x.UseFsiAuxLib + +
    + Signature: bool
    + Modifiers: abstract
    +
    +     		+

    Implicitly reference FSharp.Compiler.Interactive.Settings.dll

    + + +

    CompiledName: get_UseFsiAuxLib

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-fsivalue.html b/docs/reference/fsharp-compiler-interactive-shell-fsivalue.html new file mode 100644 index 0000000000..991f699a7b --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-fsivalue.html @@ -0,0 +1,141 @@ + + + + + FsiValue - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FsiValue

    +

    + + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Shell
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents an evaluated F# value

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.ReflectionType + +
    + Signature: Type
    +
    +     		+

    The type of the value, from the point of view of the .NET type system

    + + +

    CompiledName: get_ReflectionType

    +
    + + x.ReflectionValue + +
    + Signature: obj
    +
    +     		+

    The value, as an object

    + + +

    CompiledName: get_ReflectionValue

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-settings-ieventloop.html b/docs/reference/fsharp-compiler-interactive-shell-settings-ieventloop.html new file mode 100644 index 0000000000..95846c16a9 --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-settings-ieventloop.html @@ -0,0 +1,153 @@ + + + + + IEventLoop - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    IEventLoop

    +

    + + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Settings
    +

    +
    +

    An event loop used by the currently executing F# Interactive session to execute code +in the context of a GUI or another event-based system.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Invoke(arg1) + +
    + Signature: ((unit -> 'T)) -> 'T
    + Modifiers: abstract
    + Type parameters: 'T
    +     		+

    Request that the given operation be run synchronously on the event loop.

    + + +
    + + x.Run() + +
    + Signature: unit -> bool
    + Modifiers: abstract
    +
    +     		+

    Run the event loop.

    + + +
    + + x.ScheduleRestart() + +
    + Signature: unit -> unit
    + Modifiers: abstract
    +
    +     		+

    Schedule a restart for the event loop.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-settings-interactivesettings.html b/docs/reference/fsharp-compiler-interactive-shell-settings-interactivesettings.html new file mode 100644 index 0000000000..88aff9f9b7 --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-settings-interactivesettings.html @@ -0,0 +1,499 @@ + + + + + InteractiveSettings - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    InteractiveSettings

    +

    + + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Settings
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Operations supported by the currently executing F# Interactive session.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AddPrinter(arg1) + +
    + Signature: (('T -> string)) -> unit
    + Type parameters: 'T
    +     		+

    Register a printer that controls the output of the interactive session.

    + + +
    + + x.AddPrintTransformer(arg1) + +
    + Signature: (('T -> obj)) -> unit
    + Type parameters: 'T
    +     		+

    Register a print transformer that controls the output of the interactive session.

    + + +
    + + x.CommandLineArgs() + +
    + Signature: unit -> string []
    +
    +     		+

    The command line arguments after ignoring the arguments relevant to the interactive +environment and replacing the first argument with the name of the last script file, +if any. Thus 'fsi.exe test1.fs test2.fs -- hello goodbye' will give arguments +'test2.fs', 'hello', 'goodbye'. This value will normally be different to those +returned by System.Environment.GetCommandLineArgs.

    + + +

    CompiledName: set_CommandLineArgs

    +
    + + x.CommandLineArgs() + +
    + Signature: unit -> unit
    +
    +     		+

    The command line arguments after ignoring the arguments relevant to the interactive +environment and replacing the first argument with the name of the last script file, +if any. Thus 'fsi.exe test1.fs test2.fs -- hello goodbye' will give arguments +'test2.fs', 'hello', 'goodbye'. This value will normally be different to those +returned by System.Environment.GetCommandLineArgs.

    + + +

    CompiledName: get_CommandLineArgs

    +
    + + x.EventLoop() + +
    + Signature: unit -> IEventLoop
    +
    +     		+

    Gets or sets a the current event loop being used to process interactions.

    + + +

    CompiledName: set_EventLoop

    +
    + + x.EventLoop() + +
    + Signature: unit -> unit
    +
    +     		+

    Gets or sets a the current event loop being used to process interactions.

    + + +

    CompiledName: get_EventLoop

    +
    + + x.FloatingPointFormat() + +
    + Signature: unit -> string
    +
    +     		+

    Get or set the floating point format used in the output of the interactive session.

    + + +

    CompiledName: set_FloatingPointFormat

    +
    + + x.FloatingPointFormat() + +
    + Signature: unit -> unit
    +
    +     		+

    Get or set the floating point format used in the output of the interactive session.

    + + +

    CompiledName: get_FloatingPointFormat

    +
    + + x.FormatProvider() + +
    + Signature: unit -> IFormatProvider
    +
    +     		+

    Get or set the format provider used in the output of the interactive session.

    + + +

    CompiledName: set_FormatProvider

    +
    + + x.FormatProvider() + +
    + Signature: unit -> unit
    +
    +     		+

    Get or set the format provider used in the output of the interactive session.

    + + +

    CompiledName: get_FormatProvider

    +
    + + x.PrintDepth() + +
    + Signature: unit -> int
    +
    +     		+

    Get or set the print depth of the interactive session.

    + + +

    CompiledName: set_PrintDepth

    +
    + + x.PrintDepth() + +
    + Signature: unit -> unit
    +
    +     		+

    Get or set the print depth of the interactive session.

    + + +

    CompiledName: get_PrintDepth

    +
    + + x.PrintLength() + +
    + Signature: unit -> int
    +
    +     		+

    Get or set the total print length of the interactive session.

    + + +

    CompiledName: set_PrintLength

    +
    + + x.PrintLength() + +
    + Signature: unit -> unit
    +
    +     		+

    Get or set the total print length of the interactive session.

    + + +

    CompiledName: get_PrintLength

    +
    + + x.PrintSize() + +
    + Signature: unit -> int
    +
    +     		+

    Get or set the total print size of the interactive session.

    + + +

    CompiledName: set_PrintSize

    +
    + + x.PrintSize() + +
    + Signature: unit -> unit
    +
    +     		+

    Get or set the total print size of the interactive session.

    + + +

    CompiledName: get_PrintSize

    +
    + + x.PrintWidth() + +
    + Signature: unit -> int
    +
    +     		+

    Get or set the print width of the interactive session.

    + + +

    CompiledName: set_PrintWidth

    +
    + + x.PrintWidth() + +
    + Signature: unit -> unit
    +
    +     		+

    Get or set the print width of the interactive session.

    + + +

    CompiledName: get_PrintWidth

    +
    + + x.ShowDeclarationValues() + +
    + Signature: unit -> bool
    +
    +     		+

    When set to 'false', disables the display of declaration values in the output of the interactive session.

    + + +

    CompiledName: set_ShowDeclarationValues

    +
    + + x.ShowDeclarationValues() + +
    + Signature: unit -> unit
    +
    +     		+

    When set to 'false', disables the display of declaration values in the output of the interactive session.

    + + +

    CompiledName: get_ShowDeclarationValues

    +
    + + x.ShowIEnumerable() + +
    + Signature: unit -> bool
    +
    +     		+

    When set to 'false', disables the display of sequences in the output of the interactive session.

    + + +

    CompiledName: set_ShowIEnumerable

    +
    + + x.ShowIEnumerable() + +
    + Signature: unit -> unit
    +
    +     		+

    When set to 'false', disables the display of sequences in the output of the interactive session.

    + + +

    CompiledName: get_ShowIEnumerable

    +
    + + x.ShowProperties() + +
    + Signature: unit -> bool
    +
    +     		+

    When set to 'false', disables the display of properties of evaluated objects in the output of the interactive session.

    + + +

    CompiledName: set_ShowProperties

    +
    + + x.ShowProperties() + +
    + Signature: unit -> unit
    +
    +     		+

    When set to 'false', disables the display of properties of evaluated objects in the output of the interactive session.

    + + +

    CompiledName: get_ShowProperties

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell-settings.html b/docs/reference/fsharp-compiler-interactive-shell-settings.html new file mode 100644 index 0000000000..de96b3d63c --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell-settings.html @@ -0,0 +1,156 @@ + + + + + Settings - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Settings

    +

    + Namespace: FSharp.Compiler.Interactive
    + Parent Module: Shell +

    +
    +

    A default implementation of the 'fsi' object, used by GetDefaultConfiguration()

    + +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + +
    TypeDescription
    + IEventLoop + +

    An event loop used by the currently executing F# Interactive session to execute code +in the context of a GUI or another event-based system.

    + + +
    + InteractiveSettings + +

    Operations supported by the currently executing F# Interactive session.

    + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + fsi + +
    + Signature: InteractiveSettings
    +
    +     		+

    A default implementation of the 'fsi' object, used by GetDefaultConfiguration(). Note this +is a different object to FSharp.Compiler.Interactive.Settings.fsi in FSharp.Compiler.Interactive.Settings.dll, +which can be used as an alternative implementation of the interactive settings if passed as a parameter +to GetDefaultConfiguration(fsiObj).

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-interactive-shell.html b/docs/reference/fsharp-compiler-interactive-shell.html new file mode 100644 index 0000000000..2203bb006e --- /dev/null +++ b/docs/reference/fsharp-compiler-interactive-shell.html @@ -0,0 +1,189 @@ + + + + + Shell - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Shell

    +

    + Namespace: FSharp.Compiler.Interactive
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + CompilerInputStream + +

    Defines a read-only input stream used to feed content to the hosted F# Interactive dynamic compiler.

    + + +
    + CompilerOutputStream + +

    Defines a write-only stream used to capture output of the hosted F# Interactive dynamic compiler.

    + + +
    + EvaluationEventArgs + + +
    + FsiCompilationException + +

    Thrown when there was an error compiling the given code in FSI.

    + + +
    + FsiEvaluationSession + +

    Represents an F# Interactive evaluation session.

    + + +
    + FsiEvaluationSessionHostConfig + + +
    + FsiValue + +

    Represents an evaluated F# value

    + + +
    + + + + + + + + + + +
    ModuleDescription
    + Settings + +

    A default implementation of the 'fsi' object, used by GetDefaultConfiguration()

    + + +
    + +
    + + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-layout.html b/docs/reference/fsharp-compiler-layout-layout.html new file mode 100644 index 0000000000..a3dada588c --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-layout.html @@ -0,0 +1,94 @@ + + + + + layout - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    layout

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Layout
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-layoutrenderer-2.html b/docs/reference/fsharp-compiler-layout-layoutrenderer-2.html new file mode 100644 index 0000000000..737a8ecd07 --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-layoutrenderer-2.html @@ -0,0 +1,174 @@ + + + + + LayoutRenderer<'a, 'b> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LayoutRenderer<'a, 'b>

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Layout
    +

    +
    +

    render a Layout yielding an 'a using a 'b (hidden state) type

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AddBreak arg1 arg2 + +
    + Signature: 'b -> int -> 'b
    + Modifiers: abstract
    +
    +     		+ +
    + + x.AddTag arg1 (arg2, arg3, arg4) + +
    + Signature: 'b -> (string * (string * string) list * bool) -> 'b
    + Modifiers: abstract
    +
    +     		+ +
    + + x.AddText arg1 arg2 + +
    + Signature: 'b -> TaggedText -> 'b
    + Modifiers: abstract
    +
    +     		+ +
    + + x.Finish(arg1) + +
    + Signature: 'b -> 'a
    + Modifiers: abstract
    +
    +     		+ +
    + + x.Start() + +
    + Signature: unit -> 'b
    + Modifiers: abstract
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-layouttag.html b/docs/reference/fsharp-compiler-layout-layouttag.html new file mode 100644 index 0000000000..6479c58ca6 --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-layouttag.html @@ -0,0 +1,94 @@ + + + + + LayoutTag - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LayoutTag

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Layout
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-leftl.html b/docs/reference/fsharp-compiler-layout-leftl.html new file mode 100644 index 0000000000..d129c654ac --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-leftl.html @@ -0,0 +1,195 @@ + + + + + LeftL - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LeftL

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Layout +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + colon + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordTypedefof + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordTypeof + +
    + Signature: Layout
    +
    +     		+ +
    + + leftBracketAngle + +
    + Signature: Layout
    +
    +     		+ +
    + + leftBracketBar + +
    + Signature: Layout
    +
    +     		+ +
    + + leftParen + +
    + Signature: Layout
    +
    +     		+ +
    + + questionMark + +
    + Signature: Layout
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-navigabletaggedtext.html b/docs/reference/fsharp-compiler-layout-navigabletaggedtext.html new file mode 100644 index 0000000000..60e5a3b939 --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-navigabletaggedtext.html @@ -0,0 +1,138 @@ + + + + + NavigableTaggedText - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NavigableTaggedText

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Layout
    +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(arg1, arg2) + +
    + Signature: (TaggedText * range) -> NavigableTaggedText
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-noresult.html b/docs/reference/fsharp-compiler-layout-noresult.html new file mode 100644 index 0000000000..18cedb42b1 --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-noresult.html @@ -0,0 +1,115 @@ + + + + + NoResult - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NoResult

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Layout
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + NoResult + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-nostate.html b/docs/reference/fsharp-compiler-layout-nostate.html new file mode 100644 index 0000000000..1d9421a12d --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-nostate.html @@ -0,0 +1,115 @@ + + + + + NoState - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NoState

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Layout
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + NoState + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-rightl.html b/docs/reference/fsharp-compiler-layout-rightl.html new file mode 100644 index 0000000000..0a36e1d6d5 --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-rightl.html @@ -0,0 +1,195 @@ + + + + + RightL - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    RightL

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Layout +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + colon + +
    + Signature: Layout
    +
    +     		+ +
    + + comma + +
    + Signature: Layout
    +
    +     		+ +
    + + rightAngle + +
    + Signature: Layout
    +
    +     		+ +
    + + rightBracket + +
    + Signature: Layout
    +
    +     		+ +
    + + rightBracketAngle + +
    + Signature: Layout
    +
    +     		+ +
    + + rightBracketBar + +
    + Signature: Layout
    +
    +     		+ +
    + + rightParen + +
    + Signature: Layout
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-sepl.html b/docs/reference/fsharp-compiler-layout-sepl.html new file mode 100644 index 0000000000..53b6f4a744 --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-sepl.html @@ -0,0 +1,247 @@ + + + + + SepL - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SepL

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Layout +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + colon + +
    + Signature: Layout
    +
    +     		+ +
    + + comma + +
    + Signature: Layout
    +
    +     		+ +
    + + dot + +
    + Signature: Layout
    +
    +     		+ +
    + + leftAngle + +
    + Signature: Layout
    +
    +     		+ +
    + + leftBracket + +
    + Signature: Layout
    +
    +     		+ +
    + + leftParen + +
    + Signature: Layout
    +
    +     		+ +
    + + lineBreak + +
    + Signature: Layout
    +
    +     		+ +
    + + questionMark + +
    + Signature: Layout
    +
    +     		+ +
    + + rightParen + +
    + Signature: Layout
    +
    +     		+ +
    + + space + +
    + Signature: Layout
    +
    +     		+ +
    + + star + +
    + Signature: Layout
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-taggedtext.html b/docs/reference/fsharp-compiler-layout-taggedtext.html new file mode 100644 index 0000000000..c1957feeab --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-taggedtext.html @@ -0,0 +1,132 @@ + + + + + TaggedText - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    TaggedText

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Layout
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Tag + +
    + Signature: LayoutTag
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_Tag

    +
    + + x.Text + +
    + Signature: string
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_Text

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-taggedtextops-literals.html b/docs/reference/fsharp-compiler-layout-taggedtextops-literals.html new file mode 100644 index 0000000000..403bf0ef18 --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-taggedtextops-literals.html @@ -0,0 +1,390 @@ + + + + + Literals - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Literals

    +

    + Namespace: FSharp.Compiler
    + Parent Module: TaggedTextOps +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + arrow + +
    + Signature: TaggedText
    +
    +     		+ +
    + + colon + +
    + Signature: TaggedText
    +
    +     		+ +
    + + comma + +
    + Signature: TaggedText
    +
    +     		+ +
    + + dot + +
    + Signature: TaggedText
    +
    +     		+ +
    + + equals + +
    + Signature: TaggedText
    +
    +     		+ +
    + + keywordFalse + +
    + Signature: TaggedText
    +
    +     		+ +
    + + keywordTrue + +
    + Signature: TaggedText
    +
    +     		+ +
    + + leftAngle + +
    + Signature: TaggedText
    +
    +     		+ +
    + + leftBrace + +
    + Signature: TaggedText
    +
    +     		+ +
    + + leftBraceBar + +
    + Signature: TaggedText
    +
    +     		+ +
    + + leftBracket + +
    + Signature: TaggedText
    +
    +     		+ +
    + + leftParen + +
    + Signature: TaggedText
    +
    +     		+ +
    + + lineBreak + +
    + Signature: TaggedText
    +
    +     		+ +
    + + minus + +
    + Signature: TaggedText
    +
    +     		+ +
    + + questionMark + +
    + Signature: TaggedText
    +
    +     		+ +
    + + rightAngle + +
    + Signature: TaggedText
    +
    +     		+ +
    + + rightBrace + +
    + Signature: TaggedText
    +
    +     		+ +
    + + rightBraceBar + +
    + Signature: TaggedText
    +
    +     		+ +
    + + rightBracket + +
    + Signature: TaggedText
    +
    +     		+ +
    + + rightParen + +
    + Signature: TaggedText
    +
    +     		+ +
    + + semicolon + +
    + Signature: TaggedText
    +
    +     		+ +
    + + space + +
    + Signature: TaggedText
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-taggedtextops.html b/docs/reference/fsharp-compiler-layout-taggedtextops.html new file mode 100644 index 0000000000..3436b0feec --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-taggedtextops.html @@ -0,0 +1,552 @@ + + + + + TaggedTextOps - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    TaggedTextOps

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Layout +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + +
    ModuleDescription
    + Literals + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + tagActivePatternCase + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagActivePatternResult + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagAlias + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagClass + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagDelegate + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagEnum + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagEvent + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagField + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagInterface + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagKeyword + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagLineBreak + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagLocal + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagMember + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagMethod + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagModule + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagModuleBinding + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagNamespace + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagNumericLiteral + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagOperator + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagParameter + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagProperty + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagPunctuation + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagRecord + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagRecordField + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagSpace + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagStringLiteral + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagStruct + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagText + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagTypeParameter + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagUnion + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagUnionCase + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagUnknownEntity + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagUnknownType + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout-wordl.html b/docs/reference/fsharp-compiler-layout-wordl.html new file mode 100644 index 0000000000..cbc50b5512 --- /dev/null +++ b/docs/reference/fsharp-compiler-layout-wordl.html @@ -0,0 +1,468 @@ + + + + + WordL - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    WordL

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Layout +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + arrow + +
    + Signature: Layout
    +
    +     		+ +
    + + bar + +
    + Signature: Layout
    +
    +     		+ +
    + + colon + +
    + Signature: Layout
    +
    +     		+ +
    + + equals + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordAbstract + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordDelegate + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordEnd + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordEnum + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordEvent + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordFalse + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordGet + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordInherit + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordInternal + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordMember + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordNested + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordNew + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordOf + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordOverride + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordPrivate + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordSet + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordStatic + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordStruct + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordTrue + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordType + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordVal + +
    + Signature: Layout
    +
    +     		+ +
    + + keywordWith + +
    + Signature: Layout
    +
    +     		+ +
    + + star + +
    + Signature: Layout
    +
    +     		+ +
    + + structUnit + +
    + Signature: Layout
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-layout.html b/docs/reference/fsharp-compiler-layout.html new file mode 100644 index 0000000000..911cfbb97a --- /dev/null +++ b/docs/reference/fsharp-compiler-layout.html @@ -0,0 +1,687 @@ + + + + + Layout - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Layout

    +

    + Namespace: FSharp.Compiler
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + LayoutRenderer<'a, 'b> + +

    render a Layout yielding an 'a using a 'b (hidden state) type

    + + +
    + LayoutTag + + +
    + NavigableTaggedText + + +
    + NoResult + + +
    + NoState + + +
    + TaggedText + + +
    + layout + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ModuleDescription
    + LeftL + + +
    + RightL + + +
    + SepL + + +
    + TaggedTextOps + + +
    + WordL + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + ( -- ) arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +

    CompiledName: op_MinusMinus

    +
    + + ( --- ) arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +

    CompiledName: op_MinusMinusMinus

    +
    + + ( ---- ) arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +

    CompiledName: op_MinusMinusMinusMinus

    +
    + + ( ----- ) arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +

    CompiledName: op_MinusMinusMinusMinusMinus

    +
    + + ( @@ ) arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +

    CompiledName: op_AtAt

    +
    + + ( @@- ) arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +

    CompiledName: op_AtAtMinus

    +
    + + ( @@-- ) arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +

    CompiledName: op_AtAtMinusMinus

    +
    + + ( ^^ ) arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +

    CompiledName: op_HatHat

    +
    + + ( ++ ) arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +

    CompiledName: op_PlusPlus

    +
    + + aboveL arg1 arg2 + +
    + Signature: Layout -> Layout -> Layout
    +
    +     		+ +
    + + aboveListL(arg1) + +
    + Signature: Layout list -> Layout
    +
    +     		+ +
    + + bracketL(arg1) + +
    + Signature: Layout -> Layout
    +
    +     		+ +
    + + bufferL arg1 arg2 + +
    + Signature: StringBuilder -> Layout -> unit
    +
    +     		+ +
    + + bufferR(arg1) + +
    + Signature: StringBuilder -> LayoutRenderer<NoResult,NoState>
    +
    +     		+ +
    + + channelR(arg1) + +
    + Signature: TextWriter -> LayoutRenderer<NoResult,NoState>
    +
    +     		+ +
    + + commaListL(arg1) + +
    + Signature: Layout list -> Layout
    +
    +     		+ +
    + + emptyL + +
    + Signature: Layout
    +
    +     		+ +
    + + isEmptyL(arg1) + +
    + Signature: Layout -> bool
    +
    +     		+ +
    + + leftL(arg1) + +
    + Signature: TaggedText -> Layout
    +
    +     		+ +
    + + listL arg1 arg2 + +
    + Signature: ('a -> Layout) -> 'a list -> Layout
    + Type parameters: 'a
    +     		+ +
    + + mkNav arg1 arg2 + +
    + Signature: range -> TaggedText -> TaggedText
    +
    +     		+ +
    + + optionL arg1 arg2 + +
    + Signature: ('a -> Layout) -> 'a option -> Layout
    + Type parameters: 'a
    +     		+ +
    + + outL arg1 arg2 + +
    + Signature: TextWriter -> Layout -> unit
    +
    +     		+ +
    + + renderL arg1 arg2 + +
    + Signature: LayoutRenderer<'b,'a> -> Layout -> 'b
    + Type parameters: 'b, 'a
    +     		+

    Run a render on a Layout

    + + +
    + + rightL(arg1) + +
    + Signature: TaggedText -> Layout
    +
    +     		+ +
    + + semiListL(arg1) + +
    + Signature: Layout list -> Layout
    +
    +     		+ +
    + + sepL(arg1) + +
    + Signature: TaggedText -> Layout
    +
    +     		+ +
    + + sepListL arg1 arg2 + +
    + Signature: Layout -> Layout list -> Layout
    +
    +     		+ +
    + + showL(arg1) + +
    + Signature: Layout -> string
    +
    +     		+ +
    + + spaceListL(arg1) + +
    + Signature: Layout list -> Layout
    +
    +     		+ +
    + + squashTo arg1 arg2 + +
    + Signature: int -> Layout -> Layout
    +
    +     		+ +
    + + stringR + +
    + Signature: LayoutRenderer<string,string list>
    +
    +     		+

    Primitive renders

    + + +
    + + taggedTextListR(collector) + +
    + Signature: collector:(TaggedText -> unit) -> LayoutRenderer<NoResult,NoState>
    +
    +     		+ +
    + + tupleL(arg1) + +
    + Signature: Layout list -> Layout
    +
    +     		+ +
    + + wordL(arg1) + +
    + Signature: TaggedText -> Layout
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-logcompilerfunctionid.html b/docs/reference/fsharp-compiler-logcompilerfunctionid.html new file mode 100644 index 0000000000..1c00d9bc20 --- /dev/null +++ b/docs/reference/fsharp-compiler-logcompilerfunctionid.html @@ -0,0 +1,171 @@ + + + + + LogCompilerFunctionId - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LogCompilerFunctionId

    +

    + + Namespace: FSharp.Compiler
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + CompileOps_TypeCheckOneInputAndFinishEventually + +
    + Signature: LogCompilerFunctionId
    + Modifiers: static
    +
    +     		+ +
    + + Service_CheckOneFile + +
    + Signature: LogCompilerFunctionId
    + Modifiers: static
    +
    +     		+ +
    + + Service_IncrementalBuildersCache_BuildingNewCache + +
    + Signature: LogCompilerFunctionId
    + Modifiers: static
    +
    +     		+ +
    + + Service_IncrementalBuildersCache_GettingCache + +
    + Signature: LogCompilerFunctionId
    + Modifiers: static
    +
    +     		+ +
    + + Service_ParseAndCheckFileInProject + +
    + Signature: LogCompilerFunctionId
    + Modifiers: static
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-nicenamegenerator.html b/docs/reference/fsharp-compiler-nicenamegenerator.html new file mode 100644 index 0000000000..023bc2662d --- /dev/null +++ b/docs/reference/fsharp-compiler-nicenamegenerator.html @@ -0,0 +1,156 @@ + + + + + NiceNameGenerator - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NiceNameGenerator

    +

    + + Namespace: FSharp.Compiler
    +

    +
    +

    Generates compiler-generated names. Each name generated also includes the StartLine number of the range passed in +at the point of first generation.

    +

    This type may be accessed concurrently, though in practice it is only used from the compilation thread. +It is made concurrency-safe since a global instance of the type is allocated in tast.fs, and it is good +policy to make all globally-allocated objects concurrency safe in case future versions of the compiler +are used to host multiple concurrent instances of compilation.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> NiceNameGenerator
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.FreshCompilerGeneratedName(name, m) + +
    + Signature: (name:string * m:range) -> string
    +
    +     		+ +
    + + x.Reset() + +
    + Signature: unit -> unit
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-partiallongname.html b/docs/reference/fsharp-compiler-partiallongname.html new file mode 100644 index 0000000000..6768b1fcd4 --- /dev/null +++ b/docs/reference/fsharp-compiler-partiallongname.html @@ -0,0 +1,186 @@ + + + + + PartialLongName - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PartialLongName

    +

    + + Namespace: FSharp.Compiler
    +

    +
    +

    Qualified long name.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + EndColumn + +
    + Signature: int
    +
    +     		+

    The column number at the end of full partial name.

    + + +
    + + LastDotPos + +
    + Signature: int option
    +
    +     		+

    Position of the last dot.

    + + +
    + + PartialIdent + +
    + Signature: string
    +
    +     		+

    Last part of long ident.

    + + +
    + + QualifyingIdents + +
    + Signature: string list
    +
    +     		+

    Qualifying idents, prior to the last dot, not including the last part.

    + + +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + PartialLongName.Empty(endColumn) + +
    + Signature: endColumn:int -> PartialLongName
    +
    +     		+

    Empty partial long name.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-prettynaming-activepatterninfo.html b/docs/reference/fsharp-compiler-prettynaming-activepatterninfo.html new file mode 100644 index 0000000000..61f043a332 --- /dev/null +++ b/docs/reference/fsharp-compiler-prettynaming-activepatterninfo.html @@ -0,0 +1,179 @@ + + + + + ActivePatternInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ActivePatternInfo

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: PrettyNaming
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + APInfo(bool,(string * range) list,range) + +
    + Signature: bool * (string * range) list * range
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.ActiveTags + +
    + Signature: string list
    +
    +     		+ +

    CompiledName: get_ActiveTags

    +
    + + x.ActiveTagsWithRanges + +
    + Signature: (string * range) list
    +
    +     		+ +

    CompiledName: get_ActiveTagsWithRanges

    +
    + + x.IsTotal + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsTotal

    +
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-prettynaming-invalidmangledstaticarg.html b/docs/reference/fsharp-compiler-prettynaming-invalidmangledstaticarg.html new file mode 100644 index 0000000000..82fb0fc180 --- /dev/null +++ b/docs/reference/fsharp-compiler-prettynaming-invalidmangledstaticarg.html @@ -0,0 +1,115 @@ + + + + + InvalidMangledStaticArg - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    InvalidMangledStaticArg

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: PrettyNaming
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + +
    Record FieldDescription
    + + Data0 + +
    + Signature: string
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-prettynaming-namearitypair.html b/docs/reference/fsharp-compiler-prettynaming-namearitypair.html new file mode 100644 index 0000000000..1f8b85af80 --- /dev/null +++ b/docs/reference/fsharp-compiler-prettynaming-namearitypair.html @@ -0,0 +1,115 @@ + + + + + NameArityPair - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NameArityPair

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: PrettyNaming
    +

    +
    +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + NameArityPair(string,int) + +
    + Signature: string * int
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-prettynaming.html b/docs/reference/fsharp-compiler-prettynaming.html new file mode 100644 index 0000000000..5b93be0999 --- /dev/null +++ b/docs/reference/fsharp-compiler-prettynaming.html @@ -0,0 +1,835 @@ + + + + + PrettyNaming - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PrettyNaming

    +

    + Namespace: FSharp.Compiler
    +

    +
    +

    Anything to do with special names of identifiers and other lexical rules

    + +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + ActivePatternInfo + + +
    + InvalidMangledStaticArg + + +
    + NameArityPair + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + ActivePatternInfoOfValName nm m + +
    + Signature: nm:string -> m:range -> ActivePatternInfo option
    +
    +     		+ +
    + + ChopPropertyName(s) + +
    + Signature: s:string -> string
    +
    +     		+

    Try to chop "get" or "set" from a string. +If the string does not start with "get" or "set", this function raises an exception.

    + + +
    + + CompileOpName + +
    + Signature: string -> string
    +
    +     		+

    Compiles an operator into a mangled operator name. +For example, "!%" becomes "op_DereferencePercent". +This function accepts both built-in and custom operators.

    + + +
    + + CompilerGeneratedName(nm) + +
    + Signature: nm:string -> string
    +
    +     		+ +
    + + CompilerGeneratedNameSuffix(...) + +
    + Signature: basicName:string -> suffix:string -> string
    +
    +     		+ +
    + + computeMangledNameWithoutDefaultArgValues(...) + +
    + Signature: (nm:string * staticArgs:obj [] * defaultArgValues:(string * string option) []) -> string
    +
    +     		+

    Mangle the static parameters for a provided type or method

    + + +
    + + DecodeGenericTypeName pos mangledName + +
    + Signature: pos:int -> mangledName:string -> NameArityPair
    +
    +     		+ +
    + + DecompileOpName + +
    + Signature: string -> string
    +
    +     		+

    Decompiles a mangled operator name back into an operator. +For example, "op_DereferencePercent" becomes "!%". +This function accepts mangled names for both built-in and custom operators.

    + + +
    + + DemangleGenericTypeName(mangledName) + +
    + Signature: mangledName:string -> string
    +
    +     		+ +
    + + DemangleGenericTypeNameWithPos(...) + +
    + Signature: pos:int -> mangledName:string -> string
    +
    +     		+ +
    + + DemangleOperatorName(nm) + +
    + Signature: nm:string -> string
    +
    +     		+ +
    + + DemangleOperatorNameAsLayout(...) + +
    + Signature: nonOpTagged:(string -> 'a) -> nm:string -> Layout
    + Type parameters: 'a
    +     		+ +
    + + demangleProvidedTypeName(...) + +
    + Signature: typeLogicalName:string -> string * (string * string) []
    +
    +     		+

    Demangle the static parameters

    + + +
    + + FSharpModuleSuffix + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + GetBasicNameOfPossibleCompilerGeneratedName(...) + +
    + Signature: name:string -> string
    +
    +     		+ +
    + + IllegalCharactersInTypeAndNamespaceNames + +
    + Signature: char []
    +
    +     		+ +
    + + IsActivePatternName(nm) + +
    + Signature: nm:string -> bool
    +
    +     		+

    Determines if the specified name is a valid name for an active pattern.

    + + +
    + + IsCompilerGeneratedName(nm) + +
    + Signature: nm:string -> bool
    +
    +     		+ +
    + + IsIdentifierFirstCharacter(c) + +
    + Signature: c:char -> bool
    +
    +     		+

    The characters that are allowed to be the first character of an identifier.

    + + +
    + + IsIdentifierPartCharacter(c) + +
    + Signature: c:char -> bool
    +
    +     		+

    The characters that are allowed to be in an identifier.

    + + +
    + + IsInfixOperator + +
    + Signature: string -> bool
    +
    +     		+ +
    + + IsLongIdentifierPartCharacter(c) + +
    + Signature: c:char -> bool
    +
    +     		+

    Is this character a part of a long identifier?

    + + +
    + + IsMangledOpName(n) + +
    + Signature: n:string -> bool
    +
    +     		+ +
    + + IsOperatorName(name) + +
    + Signature: name:string -> bool
    +
    +     		+

    Returns true if given string is an operator display name, e.g. ( |>> )

    + + +
    + + IsOperatorOrBacktickedName(name) + +
    + Signature: name:string -> bool
    +
    +     		+

    Returns true if given string is an operator or double backticked name, e.g. ( |>> ) or ( long identifier ). +(where ( long identifier ) is the display name for long identifier).

    + + +
    + + IsPrefixOperator(s) + +
    + Signature: s:string -> bool
    +
    +     		+ +
    + + IsPunctuation(s) + +
    + Signature: s:string -> bool
    +
    +     		+ +
    + + IsTernaryOperator(s) + +
    + Signature: s:string -> bool
    +
    +     		+ +
    + + IsValidPrefixOperatorDefinitionName(s) + +
    + Signature: s:string -> bool
    +
    +     		+ +
    + + IsValidPrefixOperatorUse(s) + +
    + Signature: s:string -> bool
    +
    +     		+ +
    + + MangledGlobalName + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + mangleProvidedTypeName(...) + +
    + Signature: (typeLogicalName:string * nonDefaultArgs:(string * string) []) -> string
    +
    +     		+

    Mangle the static parameters for a provided type or method

    + + +
    + + opNameCons + +
    + Signature: string
    +
    +     		+ +
    + + opNameEquals + +
    + Signature: string
    +
    +     		+ +
    + + opNameEqualsNullable + +
    + Signature: string
    +
    +     		+ +
    + + opNameNil + +
    + Signature: string
    +
    +     		+ +
    + + opNameNullableEquals + +
    + Signature: string
    +
    +     		+ +
    + + opNameNullableEqualsNullable + +
    + Signature: string
    +
    +     		+ +
    + + opNamePrefix + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+

    Prefix for compiled (mangled) operator names.

    + + +
    + + outArgCompilerGeneratedName + +
    + Signature: string
    +
    +     		+ +
    + + parenGet + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + parenSet + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + qmark + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + qmarkSet + +
    + Signature: string
    + + Attributes:
    +[<Literal>]
    +     +
    +     		+ +
    + + SplitNamesForILPath(s) + +
    + Signature: s:string -> string list
    +
    +     		+ +
    + + TryChopPropertyName(s) + +
    + Signature: s:string -> string option
    +
    +     		+

    Try to chop "get" or "set" from a string

    + + +
    + + TryDemangleGenericNameAndPos(n) + +
    + Signature: n:string -> int voption
    +
    +     		+ +
    +

    Active patterns

    + + + + + + + + + + +
    Active patternDescription
    + + ( |Control|Equality|Relational|Indexer|FixedTypes|Other| )(...) + +
    + Signature: opName:string -> Choice<unit,unit,unit,unit,unit,unit>
    +
    +     		+ +

    CompiledName: |Control|Equality|Relational|Indexer|FixedTypes|Other|

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-quickparse.html b/docs/reference/fsharp-compiler-quickparse.html new file mode 100644 index 0000000000..523d3a13a6 --- /dev/null +++ b/docs/reference/fsharp-compiler-quickparse.html @@ -0,0 +1,223 @@ + + + + + QuickParse - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    QuickParse

    +

    + Namespace: FSharp.Compiler
    +

    +
    +

    Methods for cheaply and inaccurately parsing F#.

    +

    These methods are very old and are mostly to do with extracting "long identifier islands" +A.B.C +from F# source code, an approach taken from pre-F# VS samples for implementing intelliense.

    +

    This code should really no longer be needed since the language service has access to +parsed F# source code ASTs. However, the long identifiers are still passed back to GetDeclarations and friends in the +F# Compiler Service and it's annoyingly hard to remove their use completely.

    +

    In general it is unlikely much progress will be made by fixing this code - it will be better to +extract more information from the F# ASTs.

    +

    It's also surprising how hard even the job of getting long identifier islands can be. For example the code +below is inaccurate for long identifier chains involving ... identifiers. And there are special cases +for active pattern names and so on.

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + CorrectIdentifierToken(...) + +
    + Signature: tokenText:string -> tokenTag:int -> int
    +
    +     		+ +
    + + GetCompleteIdentifierIsland(...) + +
    + Signature: tolerateJustAfter:bool -> tokenText:string -> index:int -> (string * int * bool) option
    +
    +     		+

    Given a string and a position in that string, find an identifier as +expected by GotoDefinition. This will work when the cursor is +immediately before the identifier, within the identifier, or immediately +after the identifier.

    +

    'tolerateJustAfter' indicates that we tolerate being one character after the identifier, used +for goto-definition

    +

    In general, only identifiers composed from upper/lower letters and '.' are supported, but there +are a couple of explicitly handled exceptions to allow some common scenarios: +- When the name contains only letters and '|' symbol, it may be an active pattern, so we +treat it as a valid identifier - e.g. let ( |Identity| ) a = a +(but other identifiers that include '|' are not allowed - e.g. '||' operator) +- It searches for double tick () to see if the identifier could be something likea b``

    +

    REVIEW: Also support, e.g., operators, performing the necessary mangling. +(i.e., I would like that the name returned here can be passed as-is +(post .-chopping) to `GetDeclarationLocation.)

    +

    In addition, return the position where a . would go if we were making +a call to DeclItemsForNamesAtPosition for intellisense. This will +allow us to use find the correct qualified items rather than resorting +to the more expensive and less accurate environment lookup.

    + + +
    + + GetPartialLongName(lineStr, index) + +
    + Signature: (lineStr:string * index:int) -> string list * string
    +
    +     		+

    Get the partial long name of the identifier to the left of index.

    + + +
    + + GetPartialLongNameEx(lineStr, index) + +
    + Signature: (lineStr:string * index:int) -> PartialLongName
    +
    +     		+

    Get the partial long name of the identifier to the left of index. +For example, for System.DateTime.Now it returns PartialLongName ([|"System"; "DateTime"|], "Now", Some 32), where "32" pos of the last dot.

    + + +
    + + MagicalAdjustmentConstant + +
    + Signature: int
    +
    +     		+

    Puts us after the last character.

    + + +
    + + TestMemberOrOverrideDeclaration(tokens) + +
    + Signature: tokens:FSharpTokenInfo [] -> bool
    +
    +     		+

    Tests whether the user is typing something like "member x." or "override (comment) x."

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range-fileindex.html b/docs/reference/fsharp-compiler-range-fileindex.html new file mode 100644 index 0000000000..4e43bf16ed --- /dev/null +++ b/docs/reference/fsharp-compiler-range-fileindex.html @@ -0,0 +1,96 @@ + + + + + FileIndex - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FileIndex

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Range
    +

    +
    +

    An index into a global tables of filenames

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range-line.html b/docs/reference/fsharp-compiler-range-line.html new file mode 100644 index 0000000000..18ae781fff --- /dev/null +++ b/docs/reference/fsharp-compiler-range-line.html @@ -0,0 +1,134 @@ + + + + + Line - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Line

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Range +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + +
    Function or valueDescription
    + + fromZ(arg1) + +
    + Signature: Line0 -> int
    +
    +     		+

    Convert a line number from zero-based line counting (used by Visual Studio) to one-based line counting (used internally in the F# compiler and in F# error messages)

    + + +
    + + toZ(arg1) + +
    + Signature: int -> Line0
    +
    +     		+

    Convert a line number from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio)

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range-line0.html b/docs/reference/fsharp-compiler-range-line0.html new file mode 100644 index 0000000000..090eaf347c --- /dev/null +++ b/docs/reference/fsharp-compiler-range-line0.html @@ -0,0 +1,96 @@ + + + + + Line0 - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Line0

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Range
    +

    +
    +

    Represents a line number when using zero-based line counting (used by Visual Studio)

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range-pos-0.html b/docs/reference/fsharp-compiler-range-pos-0.html new file mode 100644 index 0000000000..4a433c79a2 --- /dev/null +++ b/docs/reference/fsharp-compiler-range-pos-0.html @@ -0,0 +1,134 @@ + + + + + Pos - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Pos

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Range +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + +
    Function or valueDescription
    + + fromZ line column + +
    + Signature: line:Line0 -> column:int -> pos
    +
    +     		+

    Convert a position from zero-based line counting (used by Visual Studio) to one-based line counting (used internally in the F# compiler and in F# error messages)

    + + +
    + + toZ(arg1) + +
    + Signature: pos -> Pos01
    +
    +     		+

    Convert a position from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio)

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range-pos.html b/docs/reference/fsharp-compiler-range-pos.html new file mode 100644 index 0000000000..b9362ed4b4 --- /dev/null +++ b/docs/reference/fsharp-compiler-range-pos.html @@ -0,0 +1,198 @@ + + + + + pos - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    pos

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Range
    + + Attributes:
    +[<Struct>]
    +[<CustomEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents a position in a file

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Column + +
    + Signature: int
    +
    +     		+

    The column number for the position

    + + +

    CompiledName: get_Column

    +
    + + x.Encoding + +
    + Signature: int64
    +
    +     		+

    The encoding of the position as a 64-bit integer

    + + +

    CompiledName: get_Encoding

    +
    + + x.Line + +
    + Signature: int
    +
    +     		+

    The line number for the position

    + + +

    CompiledName: get_Line

    +
    +

    Static members

    + + + + + + + + + + + + + + +
    Static memberDescription
    + + pos.Decode(arg1) + +
    + Signature: int64 -> pos
    +
    +     		+

    Decode a position fro a 64-bit integer

    + + +
    + + pos.EncodingSize + +
    + Signature: int
    +
    +     		+

    The maximum number of bits needed to store an encoded position

    + + +

    CompiledName: get_EncodingSize

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range-pos01.html b/docs/reference/fsharp-compiler-range-pos01.html new file mode 100644 index 0000000000..0acf0e1758 --- /dev/null +++ b/docs/reference/fsharp-compiler-range-pos01.html @@ -0,0 +1,130 @@ + + + + + Pos01 - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Pos01

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Range
    +

    +
    +

    Represents a position using zero-based line counting (used by Visual Studio)

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: Line0
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: int
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range-range-0.html b/docs/reference/fsharp-compiler-range-range-0.html new file mode 100644 index 0000000000..6e0ec8cc53 --- /dev/null +++ b/docs/reference/fsharp-compiler-range-range-0.html @@ -0,0 +1,134 @@ + + + + + Range - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Range

    +

    + Namespace: FSharp.Compiler
    + Parent Module: Range +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + +
    Function or valueDescription
    + + toFileZ(arg1) + +
    + Signature: range -> string * Range01
    +
    +     		+

    Convert a range from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio)

    + + +
    + + toZ(arg1) + +
    + Signature: range -> Range01
    +
    +     		+

    Convert a range from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio)

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range-range.html b/docs/reference/fsharp-compiler-range-range.html new file mode 100644 index 0000000000..f91a6c648f --- /dev/null +++ b/docs/reference/fsharp-compiler-range-range.html @@ -0,0 +1,343 @@ + + + + + range - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    range

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Range
    + + Attributes:
    +[<Struct>]
    +[<CustomEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents a range within a known file

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.End + +
    + Signature: pos
    +
    +     		+

    The end position of the range

    + + +

    CompiledName: get_End

    +
    + + x.EndColumn + +
    + Signature: int
    +
    +     		+

    The column number for the end position of the range

    + + +

    CompiledName: get_EndColumn

    +
    + + x.EndLine + +
    + Signature: int
    +
    +     		+

    The line number for the end position of the range

    + + +

    CompiledName: get_EndLine

    +
    + + x.EndRange + +
    + Signature: range
    +
    +     		+

    The empty range that is located at the end position of the range

    + + +

    CompiledName: get_EndRange

    +
    + + x.FileIndex + +
    + Signature: int
    +
    +     		+

    The file index for the range

    + + +

    CompiledName: get_FileIndex

    +
    + + x.FileName + +
    + Signature: string
    +
    +     		+

    The file name for the file of the range

    + + +

    CompiledName: get_FileName

    +
    + + x.IsSynthetic + +
    + Signature: bool
    +
    +     		+

    Synthetic marks ranges which are produced by intermediate compilation phases. This +bit signifies that the range covers something that should not be visible to language +service operations like dot-completion.

    + + +

    CompiledName: get_IsSynthetic

    +
    + + x.MakeSynthetic() + +
    + Signature: unit -> range
    +
    +     		+

    Convert a range to be synthetic

    + + +
    + + x.Start + +
    + Signature: pos
    +
    +     		+

    The start position of the range

    + + +

    CompiledName: get_Start

    +
    + + x.StartColumn + +
    + Signature: int
    +
    +     		+

    The start column of the range

    + + +

    CompiledName: get_StartColumn

    +
    + + x.StartLine + +
    + Signature: int
    +
    +     		+

    The start line of the range

    + + +

    CompiledName: get_StartLine

    +
    + + x.StartRange + +
    + Signature: range
    +
    +     		+

    The empty range that is located at the start position of the range

    + + +

    CompiledName: get_StartRange

    +
    + + x.ToShortString() + +
    + Signature: unit -> string
    +
    +     		+

    Convert a range to string

    + + +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + range.Zero + +
    + Signature: range
    +
    +     		+

    The range where all values are zero

    + + +

    CompiledName: get_Zero

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range-range01.html b/docs/reference/fsharp-compiler-range-range01.html new file mode 100644 index 0000000000..0e6552a539 --- /dev/null +++ b/docs/reference/fsharp-compiler-range-range01.html @@ -0,0 +1,130 @@ + + + + + Range01 - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Range01

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: Range
    +

    +
    +

    Represents a range using zero-based line counting (used by Visual Studio)

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: Pos01
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: Pos01
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-range.html b/docs/reference/fsharp-compiler-range.html new file mode 100644 index 0000000000..f2f4fd1df4 --- /dev/null +++ b/docs/reference/fsharp-compiler-range.html @@ -0,0 +1,632 @@ + + + + + Range - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Range

    +

    + Namespace: FSharp.Compiler
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + FileIndex + +

    An index into a global tables of filenames

    + + +
    + Line0 + +

    Represents a line number when using zero-based line counting (used by Visual Studio)

    + + +
    + Pos01 + +

    Represents a position using zero-based line counting (used by Visual Studio)

    + + +
    + Range01 + +

    Represents a range using zero-based line counting (used by Visual Studio)

    + + +
    + pos + +

    Represents a position in a file

    + + +
    + range + +

    Represents a range within a known file

    + + +
    + + + + + + + + + + + + + + + + + + +
    ModuleDescription
    + Line + + +
    + Pos + + +
    + Range + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + commandLineArgsFileName + +
    + Signature: string
    +
    +     		+ +
    + + equals arg1 arg2 + +
    + Signature: range -> range -> bool
    +
    +     		+ +
    + + fileIndexOfFile(filePath) + +
    + Signature: filePath:string -> FileIndex
    +
    +     		+

    Convert a file path to an index

    + + +
    + + fileOfFileIndex(arg1) + +
    + Signature: FileIndex -> string
    +
    +     		+

    Convert an index into a file path

    + + +
    + + mkFileIndexRange arg1 arg2 arg3 + +
    + Signature: FileIndex -> pos -> pos -> range
    +
    +     		+

    This view of range marks uses file indexes explicitly

    + + +
    + + mkPos line column + +
    + Signature: line:int -> column:int -> pos
    +
    +     		+

    Create a position for the given line and column

    + + +
    + + mkRange arg1 arg2 arg3 + +
    + Signature: string -> pos -> pos -> range
    +
    +     		+

    This view hides the use of file indexes and just uses filenames

    + + +
    + + outputPos arg1 arg2 + +
    + Signature: TextWriter -> pos -> unit
    +
    +     		+

    Output a position

    + + +
    + + outputRange arg1 arg2 + +
    + Signature: TextWriter -> range -> unit
    +
    +     		+

    Output a range

    + + +
    + + pos0 + +
    + Signature: pos
    +
    +     		+

    The zero position

    + + +
    + + posEq arg1 arg2 + +
    + Signature: pos -> pos -> bool
    +
    +     		+

    Compare positions for equality

    + + +
    + + posGeq arg1 arg2 + +
    + Signature: pos -> pos -> bool
    +
    +     		+

    Compare positions for greater-than-or-equal-to

    + + +
    + + posGt arg1 arg2 + +
    + Signature: pos -> pos -> bool
    +
    +     		+

    Compare positions for greater-than

    + + +
    + + posLt arg1 arg2 + +
    + Signature: pos -> pos -> bool
    +
    +     		+

    Compare positions for less-than

    + + +
    + + posOrder + +
    + Signature: IComparer<pos>
    +
    +     		+

    Ordering on positions

    + + +
    + + range0 + +
    + Signature: range
    +
    +     		+

    The zero range

    + + +
    + + rangeBeforePos arg1 arg2 + +
    + Signature: range -> pos -> bool
    +
    +     		+

    Test to see if a range occurs fully before a position

    + + +
    + + rangeCmdArgs + +
    + Signature: range
    +
    +     		+

    A range associated with a dummy file for the command line arguments

    + + +
    + + rangeContainsPos arg1 arg2 + +
    + Signature: range -> pos -> bool
    +
    +     		+

    Test to see if a range contains a position

    + + +
    + + rangeContainsRange arg1 arg2 + +
    + Signature: range -> range -> bool
    +
    +     		+

    Test to see if one range contains another range

    + + +
    + + rangeN arg1 arg2 + +
    + Signature: string -> int -> range
    +
    +     		+

    Make a dummy range for a file

    + + +
    + + rangeOrder + +
    + Signature: IComparer<range>
    +
    +     		+

    not a total order, but enough to sort on ranges

    + + +
    + + rangeStartup + +
    + Signature: range
    +
    +     		+

    A range associated with a dummy file called "startup"

    + + +
    + + startupFileName + +
    + Signature: string
    +
    +     		+ +
    + + stringOfPos(arg1) + +
    + Signature: pos -> string
    +
    +     		+

    Convert a position to a string

    + + +
    + + stringOfRange(arg1) + +
    + Signature: range -> string
    +
    +     		+

    Convert a range to a string

    + + +
    + + trimRangeToLine(arg1) + +
    + Signature: range -> range
    +
    +     		+

    Reduce a range so it only covers a line

    + + +
    + + unionRanges arg1 arg2 + +
    + Signature: range -> range -> range
    +
    +     		+

    Union two ranges, taking their first occurring start position and last occurring end position

    + + +
    + + unknownFileName + +
    + Signature: string
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-referenceresolver-resolutionenvironment.html b/docs/reference/fsharp-compiler-referenceresolver-resolutionenvironment.html new file mode 100644 index 0000000000..1c96dd4ead --- /dev/null +++ b/docs/reference/fsharp-compiler-referenceresolver-resolutionenvironment.html @@ -0,0 +1,137 @@ + + + + + ResolutionEnvironment - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ResolutionEnvironment

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ReferenceResolver
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + CompilationAndEvaluation + +
    + Signature:
    +
    +     		+

    Indicates a script or source being dynamically compiled and executed. Uses implementation assemblies.

    + + +
    + + EditingOrCompilation(isEditing) + +
    + Signature: bool
    +
    +     		+

    Indicates a script or source being edited or compiled. Uses reference assemblies (not implementation assemblies).

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-referenceresolver-resolvedfile.html b/docs/reference/fsharp-compiler-referenceresolver-resolvedfile.html new file mode 100644 index 0000000000..c90f8f0d18 --- /dev/null +++ b/docs/reference/fsharp-compiler-referenceresolver-resolvedfile.html @@ -0,0 +1,147 @@ + + + + + ResolvedFile - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ResolvedFile

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ReferenceResolver
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + baggage + +
    + Signature: string
    +
    +     		+

    Round-tripped baggage

    + + +
    + + itemSpec + +
    + Signature: string
    +
    +     		+

    Item specification.

    + + +
    + + prepareToolTip + +
    + Signature: string * string -> string
    +
    +     		+

    Prepare textual information about where the assembly was resolved from, used for tooltip output

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-referenceresolver-resolver.html b/docs/reference/fsharp-compiler-referenceresolver-resolver.html new file mode 100644 index 0000000000..4dd1dd7928 --- /dev/null +++ b/docs/reference/fsharp-compiler-referenceresolver-resolver.html @@ -0,0 +1,162 @@ + + + + + Resolver - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Resolver

    +

    + + Namespace: FSharp.Compiler
    + Parent Module: ReferenceResolver
    + + Attributes:
    +[<AllowNullLiteral>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DotNetFrameworkReferenceAssembliesRootDirectory(...) + +
    + Signature: string
    + Modifiers: abstract
    +
    +     		+

    Get the Reference Assemblies directory for the .NET Framework (on Windows) +This is added to the default resolution path for +design-time compilations.

    + + +

    CompiledName: get_DotNetFrameworkReferenceAssembliesRootDirectory

    +
    + + x.HighestInstalledNetFrameworkVersion() + +
    + Signature: unit -> string
    + Modifiers: abstract
    +
    +     		+

    Get the "v4.5.1"-style moniker for the highest installed .NET Framework version. +This is the value passed back to Resolve if no explicit "mscorlib" has been given.

    +

    Note: If an explicit "mscorlib" is given, then --noframework is being used, and the whole ReferenceResolver logic is essentially +unused. However in the future an option may be added to allow an explicit specification of +a .NET Framework version to use for scripts.

    + + +
    + + x.Resolve(...) + +
    + Signature: (resolutionEnvironment:ResolutionEnvironment * references:(string * string) [] * targetFrameworkVersion:string * targetFrameworkDirectories:string list * targetProcessorArchitecture:string * fsharpCoreDir:string * explicitIncludeDirs:string list * implicitIncludeDir:string * logMessage:(string -> unit) * logDiagnostic:(bool -> string -> string -> unit)) -> ResolvedFile []
    + Modifiers: abstract
    +
    +     		+

    Perform assembly resolution on the given references under the given conditions

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-referenceresolver.html b/docs/reference/fsharp-compiler-referenceresolver.html new file mode 100644 index 0000000000..38dab0f2b6 --- /dev/null +++ b/docs/reference/fsharp-compiler-referenceresolver.html @@ -0,0 +1,130 @@ + + + + + ReferenceResolver - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ReferenceResolver

    +

    + Namespace: FSharp.Compiler
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + ResolutionEnvironment + + +
    + ResolvedFile + + +
    + Resolver + + +
    + +
    + + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontentprovider.html b/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontentprovider.html new file mode 100644 index 0000000000..5a1bc42025 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontentprovider.html @@ -0,0 +1,135 @@ + + + + + AssemblyContentProvider - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    AssemblyContentProvider

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Provides assembly content.

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + +
    Function or valueDescription
    + + getAssemblyContent(...) + +
    + Signature: withCache:((IAssemblyContentCache -> AssemblySymbol list) -> AssemblySymbol list) -> contentType:AssemblyContentType -> fileName:string option -> assemblies:FSharpAssembly list -> AssemblySymbol list
    +
    +     		+

    Returns (possibly cached) assembly content.

    + + +
    + + getAssemblySignatureContent arg1 arg2 + +
    + Signature: AssemblyContentType -> FSharpAssemblySignature -> AssemblySymbol list
    +
    +     		+

    Given a FSharpAssemblySignature, returns assembly content.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontenttype.html b/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontenttype.html new file mode 100644 index 0000000000..d613a61208 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-assemblycontenttype.html @@ -0,0 +1,133 @@ + + + + + AssemblyContentType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    AssemblyContentType

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Assembly content type.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Full + +
    + Signature:
    +
    +     		+

    All assembly content.

    + + +
    + + Public + +
    + Signature:
    +
    +     		+

    Public assembly content only.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-assemblypath.html b/docs/reference/fsharp-compiler-sourcecodeservices-assemblypath.html new file mode 100644 index 0000000000..0645a42f67 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-assemblypath.html @@ -0,0 +1,129 @@ + + + + + AssemblyPath - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    AssemblyPath

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Assembly path.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Chars(arg1) + +
    + Signature: int -> char
    +
    +     		+ +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-assemblysymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-assemblysymbol.html new file mode 100644 index 0000000000..717bfa15c2 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-assemblysymbol.html @@ -0,0 +1,244 @@ + + + + + AssemblySymbol - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    AssemblySymbol

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    Represents type, module, member, function or value in a compiled assembly.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + AutoOpenParent + +
    + Signature: Idents option
    +
    +     		+

    Parent module that has AutoOpen attribute.

    + + +
    + + CleanedIdents + +
    + Signature: Idents
    +
    +     		+

    Entity name parts with removed module suffixes (Ns.M1Module.M2Module.M3.entity -> Ns.M1.M2.M3.entity) +and replaced compiled names with display names (FSharpEntity.DisplayName, FSharpValueOrFunction.DisplayName). +Note: all parts are cleaned, not the last one.

    + + +
    + + FullName + +
    + Signature: string
    +
    +     		+

    Full entity name as it's seen in compiled code (raw FSharpEntity.FullName, FSharpValueOrFunction.FullName).

    + + +
    + + Kind + +
    + Signature: LookupType -> EntityKind
    +
    +     		+

    Function that returns EntityKind based of given LookupKind.

    + + +
    + + Namespace + +
    + Signature: Idents option
    +
    +     		+

    FSharpEntity.Namespace.

    + + +
    + + NearestRequireQualifiedAccessParent + +
    + Signature: Idents option
    +
    +     		+

    The most narrative parent module that has RequireQualifiedAccess attribute.

    + + +
    + + Symbol + +
    + Signature: FSharpSymbol
    +
    +     		+ +
    + + TopRequireQualifiedAccessParent + +
    + Signature: Idents option
    +
    +     		+

    Parent module that has the largest scope and has RequireQualifiedAccess attribute.

    + + +
    + + UnresolvedSymbol + +
    + Signature: UnresolvedSymbol
    +
    +     		+

    Cache display name and namespace, used for completion.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-astvisitorbase-1.html b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-astvisitorbase-1.html new file mode 100644 index 0000000000..f3fd4b5710 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-astvisitorbase-1.html @@ -0,0 +1,390 @@ + + + + + AstVisitorBase<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    AstVisitorBase<'T>

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: AstTraversal
    + + Attributes:
    +[<AbstractClass>]
    + +     +

    +
    +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> AstVisitorBase<'T>
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.VisitBinding(arg1, arg2) + +
    + Signature: ((SynBinding -> 'T option) * SynBinding) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitBinding allows overriding binding behavior (note: by default it would defaultTraverse expression)

    + + +
    + + x.VisitComponentInfo(arg1) + +
    + Signature: SynComponentInfo -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitComponentInfo allows overriding behavior when visiting type component infos

    + + +
    + + x.VisitExpr(arg1, arg2, arg3, arg4) + +
    + Signature: (TraversePath * (SynExpr -> 'T option) * (SynExpr -> 'T option) * SynExpr) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitExpr(path, traverseSynExpr, defaultTraverse, expr) +controls the behavior when a SynExpr is reached; it can just do +defaultTraverse(expr) if you have no special logic for this node, and want the default processing to pick which sub-node to dive deeper into +or can inject non-default behavior, which might incorporate: +traverseSynExpr(subExpr) to recurse deeper on some particular sub-expression based on your own logic +path helps to track AST nodes that were passed during traversal

    + + +
    + + x.VisitHashDirective(arg1) + +
    + Signature: range -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitHashDirective allows overriding behavior when visiting hash directives in FSX scripts, like #r, #load and #I.

    + + +
    + + x.VisitImplicitInherit(...) + +
    + Signature: ((SynExpr -> 'T option) * SynType * SynExpr * range) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitImplicitInherit(defaultTraverse,ty,expr,m), defaults to just visiting expr

    + + +
    + + x.VisitInheritSynMemberDefn(...) + +
    + Signature: (SynComponentInfo * SynTypeDefnKind * SynType * SynMemberDefns * range) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitInheritSynMemberDefn allows overriding inherit behavior (by default do nothing)

    + + +
    + + x.VisitInterfaceSynMemberDefnType(arg1) + +
    + Signature: SynType -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitInterfaceSynMemberDefnType allows overriding behavior for visiting interface member in types (by default - do nothing)

    + + +
    + + x.VisitLetOrUse(arg1, arg2, arg3, arg4) + +
    + Signature: (TraversePath * (SynBinding -> 'T option) * SynBinding list * range) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitLetOrUse allows overriding behavior when visiting module or local let or use bindings

    + + +
    + + x.VisitMatchClause(arg1, arg2) + +
    + Signature: ((SynMatchClause -> 'T option) * SynMatchClause) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitMatchClause allows overriding clause behavior (note: by default it would defaultTraverse expression)

    + + +
    + + x.VisitModuleDecl(arg1, arg2) + +
    + Signature: ((SynModuleDecl -> 'T option) * SynModuleDecl) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitModuleDecl allows overriding module declaration behavior

    + + +
    + + x.VisitModuleOrNamespace(arg1) + +
    + Signature: SynModuleOrNamespace -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitModuleOrNamespace allows overriding behavior when visiting module or namespaces

    + + +
    + + x.VisitPat(arg1, arg2) + +
    + Signature: ((SynPat -> 'T option) * SynPat) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitPat allows overriding behavior when visiting patterns

    + + +
    + + x.VisitRecordField(arg1, arg2, arg3) + +
    + Signature: (TraversePath * SynExpr option * LongIdentWithDots option) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitRecordField allows overriding behavior when visiting l.h.s. of constructed record instances

    + + +
    + + x.VisitSimplePats(arg1) + +
    + Signature: (SynSimplePat list) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitType allows overriding behavior when visiting simple pats

    + + +
    + + x.VisitType(arg1, arg2) + +
    + Signature: ((SynType -> 'T option) * SynType) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitType allows overriding behavior when visiting type hints (x: ..., etc.)

    + + +
    + + x.VisitTypeAbbrev(arg1, arg2) + +
    + Signature: (SynType * range) -> 'T option
    + Modifiers: abstract
    +
    +     		+

    VisitTypeAbbrev(ty,m), defaults to ignoring this leaf of the AST

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversepath.html b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversepath.html new file mode 100644 index 0000000000..ba34f39006 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversepath.html @@ -0,0 +1,194 @@ + + + + + TraversePath - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    TraversePath

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: AstTraversal
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Head + +
    + Signature: TraverseStep
    +
    +     		+ +

    CompiledName: get_Head

    +
    + + x.IsEmpty + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsEmpty

    +
    + + [index] + +
    + Signature: index:int -> TraverseStep
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.Tail + +
    + Signature: TraverseStep list
    +
    +     		+ +

    CompiledName: get_Tail

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + List.Empty + +
    + Signature: TraverseStep list
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversestep.html b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversestep.html new file mode 100644 index 0000000000..8ce660efbb --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal-traversestep.html @@ -0,0 +1,200 @@ + + + + + TraverseStep - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    TraverseStep

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: AstTraversal
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    used to track route during traversal AST

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Binding(SynBinding) + +
    + Signature: SynBinding
    +
    +     		+ +
    + + Expr(SynExpr) + +
    + Signature: SynExpr
    +
    +     		+ +
    + + MatchClause(SynMatchClause) + +
    + Signature: SynMatchClause
    +
    +     		+ +
    + + MemberDefn(SynMemberDefn) + +
    + Signature: SynMemberDefn
    +
    +     		+ +
    + + Module(SynModuleDecl) + +
    + Signature: SynModuleDecl
    +
    +     		+ +
    + + ModuleOrNamespace(SynModuleOrNamespace) + +
    + Signature: SynModuleOrNamespace
    +
    +     		+ +
    + + TypeDefn(SynTypeDefn) + +
    + Signature: SynTypeDefn
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal.html b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal.html new file mode 100644 index 0000000000..4544a62aab --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-asttraversal.html @@ -0,0 +1,222 @@ + + + + + AstTraversal - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    AstTraversal

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    A range of utility functions to assist with traversing an AST

    + +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + AstVisitorBase<'T> + + +
    + TraversePath + + +
    + TraverseStep + +

    used to track route during traversal AST

    + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + dive node range project + +
    + Signature: node:'d -> range:'e -> project:('d -> 'f) -> 'e * (unit -> 'f)
    + Type parameters: 'd, 'e, 'f
    +     		+ +
    + + pick(...) + +
    + Signature: pos:pos -> outerRange:range -> _debugObj:obj -> diveResults:(range * (unit -> 'c option)) list -> 'c option
    + Type parameters: 'c
    +     		+ +
    + + rangeContainsPosEdgesExclusive m1 p + +
    + Signature: m1:range -> p:pos -> bool
    +
    +     		+ +
    + + rangeContainsPosLeftEdgeExclusiveAndRightEdgeInclusive(...) + +
    + Signature: m1:range -> p:pos -> bool
    +
    +     		+ +
    + + rangeContainsPosLeftEdgeInclusive m1 p + +
    + Signature: m1:range -> p:pos -> bool
    +
    +     		+ +
    + + Traverse(pos, parseTree, visitor) + +
    + Signature: (pos:pos * parseTree:ParsedInput * visitor:AstVisitorBase<'T>) -> 'T option
    + Type parameters: 'T
    +     		+

    traverse an implementation file walking all the way down to SynExpr or TypeAbbrev at a particular location

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-basicpatterns.html b/docs/reference/fsharp-compiler-sourcecodeservices-basicpatterns.html new file mode 100644 index 0000000000..5c0eb13d2f --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-basicpatterns.html @@ -0,0 +1,829 @@ + + + + + BasicPatterns - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    BasicPatterns

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    A collection of active patterns to analyze expressions

    + +
    + + + +

    Active patterns

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Active patternDescription
    + + ( |AddressOf|_| )(arg1) + +
    + Signature: FSharpExpr -> FSharpExpr option
    +
    +     		+

    Matches expressions which take the address of a location

    + + +

    CompiledName: |AddressOf|_|

    +
    + + ( |AddressSet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    +
    +     		+

    Matches expressions which set the contents of an address

    + + +

    CompiledName: |AddressSet|_|

    +
    + + ( |AnonRecordGet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpType * int) option
    +
    +     		+

    Matches expressions getting a field from an anonymous record. The integer represents the +index into the sorted fields of the anonymous record.

    + + +

    CompiledName: |AnonRecordGet|_|

    +
    + + ( |Application|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpType list * FSharpExpr list) option
    +
    +     		+

    Matches expressions which are the application of function values

    + + +

    CompiledName: |Application|_|

    +
    + + ( |BaseValue|_| )(arg1) + +
    + Signature: FSharpExpr -> FSharpType option
    +
    +     		+

    Matches expressions which are uses of the 'base' value

    + + +

    CompiledName: |BaseValue|_|

    +
    + + ( |Call|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr option * FSharpMemberOrFunctionOrValue * FSharpType list * FSharpType list * FSharpExpr list) option
    +
    +     		+

    Matches expressions which are calls to members or module-defined functions. When calling curried functions and members the +arguments are collapsed to a single collection of arguments, as done in the compiled version of these.

    + + +

    CompiledName: |Call|_|

    +
    + + ( |Coerce|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * FSharpExpr) option
    +
    +     		+

    Matches expressions which coerce the type of a value

    + + +

    CompiledName: |Coerce|_|

    +
    + + ( |Const|_| )(arg1) + +
    + Signature: FSharpExpr -> (obj * FSharpType) option
    +
    +     		+

    Matches constant expressions, including signed and unsigned integers, strings, characters, booleans, arrays +of bytes and arrays of unit16.

    + + +

    CompiledName: |Const|_|

    +
    + + ( |DecisionTree|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * (FSharpMemberOrFunctionOrValue list * FSharpExpr) list) option
    +
    +     		+

    Matches expressions with a decision expression, each branch of which ends in DecisionTreeSuccess passing control and values to one of the targets.

    + + +

    CompiledName: |DecisionTree|_|

    +
    + + ( |DecisionTreeSuccess|_| )(arg1) + +
    + Signature: FSharpExpr -> (int * FSharpExpr list) option
    +
    +     		+

    Special expressions at the end of a conditional decision structure in the decision expression node of a DecisionTree . +The given expressions are passed as values to the decision tree target.

    + + +

    CompiledName: |DecisionTreeSuccess|_|

    +
    + + ( |DefaultValue|_| )(arg1) + +
    + Signature: FSharpExpr -> FSharpType option
    +
    +     		+

    Matches default-value expressions, including null expressions

    + + +

    CompiledName: |DefaultValue|_|

    +
    + + ( |FastIntegerForLoop|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpExpr * FSharpExpr * bool) option
    +
    +     		+

    Matches fast-integer loops (up or down)

    + + +

    CompiledName: |FastIntegerForLoop|_|

    +
    + + ( |FSharpFieldGet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr option * FSharpType * FSharpField) option
    +
    +     		+

    Matches expressions which get a field from a record or class

    + + +

    CompiledName: |FSharpFieldGet|_|

    +
    + + ( |FSharpFieldSet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr option * FSharpType * FSharpField * FSharpExpr) option
    +
    +     		+

    Matches expressions which set a field in a record or class

    + + +

    CompiledName: |FSharpFieldSet|_|

    +
    + + ( |IfThenElse|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpExpr * FSharpExpr) option
    +
    +     		+

    Matches expressions which are conditionals

    + + +

    CompiledName: |IfThenElse|_|

    +
    + + ( |ILAsm|_| )(arg1) + +
    + Signature: FSharpExpr -> (string * FSharpType list * FSharpExpr list) option
    +
    +     		+

    Matches expressions which are IL assembly code

    + + +

    CompiledName: |ILAsm|_|

    +
    + + ( |ILFieldGet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr option * FSharpType * string) option
    +
    +     		+

    Matches expressions which fetch a field from a .NET type

    + + +

    CompiledName: |ILFieldGet|_|

    +
    + + ( |ILFieldSet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr option * FSharpType * string * FSharpExpr) option
    +
    +     		+

    Matches expressions which set a field in a .NET type

    + + +

    CompiledName: |ILFieldSet|_|

    +
    + + ( |Lambda|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpExpr) option
    +
    +     		+

    Matches expressions which are lambda abstractions

    + + +

    CompiledName: |Lambda|_|

    +
    + + ( |Let|_| )(arg1) + +
    + Signature: FSharpExpr -> ((FSharpMemberOrFunctionOrValue * FSharpExpr) * FSharpExpr) option
    +
    +     		+

    Matches expressions which are let definitions

    + + +

    CompiledName: |Let|_|

    +
    + + ( |LetRec|_| )(arg1) + +
    + Signature: FSharpExpr -> ((FSharpMemberOrFunctionOrValue * FSharpExpr) list * FSharpExpr) option
    +
    +     		+

    Matches expressions which are let-rec definitions

    + + +

    CompiledName: |LetRec|_|

    +
    + + ( |NewAnonRecord|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * FSharpExpr list) option
    +
    +     		+

    Matches anonymous record expressions

    + + +

    CompiledName: |NewAnonRecord|_|

    +
    + + ( |NewArray|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * FSharpExpr list) option
    +
    +     		+

    Matches array expressions

    + + +

    CompiledName: |NewArray|_|

    +
    + + ( |NewDelegate|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * FSharpExpr) option
    +
    +     		+

    Matches expressions which create an instance of a delegate type

    + + +

    CompiledName: |NewDelegate|_|

    +
    + + ( |NewObject|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpType list * FSharpExpr list) option
    +
    +     		+

    Matches expressions which are calls to object constructors

    + + +

    CompiledName: |NewObject|_|

    +
    + + ( |NewRecord|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * FSharpExpr list) option
    +
    +     		+

    Matches record expressions

    + + +

    CompiledName: |NewRecord|_|

    +
    + + ( |NewTuple|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * FSharpExpr list) option
    +
    +     		+

    Matches tuple expressions

    + + +

    CompiledName: |NewTuple|_|

    +
    + + ( |NewUnionCase|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * FSharpUnionCase * FSharpExpr list) option
    +
    +     		+

    Matches expressions which create an object corresponding to a union case

    + + +

    CompiledName: |NewUnionCase|_|

    +
    + + ( |ObjectExpr|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * FSharpExpr * FSharpObjectExprOverride list * (FSharpType * FSharpObjectExprOverride list) list) option
    +
    +     		+

    Matches object expressions, returning the base type, the base call, the overrides and the interface implementations

    + + +

    CompiledName: |ObjectExpr|_|

    +
    + + ( |Quote|_| )(arg1) + +
    + Signature: FSharpExpr -> FSharpExpr option
    +
    +     		+

    Matches expressions which are quotation literals

    + + +

    CompiledName: |Quote|_|

    +
    + + ( |Sequential|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    +
    +     		+

    Matches sequential expressions

    + + +

    CompiledName: |Sequential|_|

    +
    + + ( |ThisValue|_| )(arg1) + +
    + Signature: FSharpExpr -> FSharpType option
    +
    +     		+

    Matches expressions which are uses of the 'this' value

    + + +

    CompiledName: |ThisValue|_|

    +
    + + ( |TraitCall|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType list * string * MemberFlags * FSharpType list * FSharpType list * FSharpExpr list) option
    +
    +     		+

    Matches expressions for an unresolved call to a trait

    + + +

    CompiledName: |TraitCall|_|

    +
    + + ( |TryFinally|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    +
    +     		+

    Matches try/finally expressions

    + + +

    CompiledName: |TryFinally|_|

    +
    + + ( |TryWith|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpMemberOrFunctionOrValue * FSharpExpr * FSharpMemberOrFunctionOrValue * FSharpExpr) option
    +
    +     		+

    Matches try/with expressions

    + + +

    CompiledName: |TryWith|_|

    +
    + + ( |TupleGet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * int * FSharpExpr) option
    +
    +     		+

    Matches expressions which get a value from a tuple

    + + +

    CompiledName: |TupleGet|_|

    +
    + + ( |TypeLambda|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpGenericParameter list * FSharpExpr) option
    +
    +     		+

    Matches expressions which are type abstractions

    + + +

    CompiledName: |TypeLambda|_|

    +
    + + ( |TypeTest|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpType * FSharpExpr) option
    +
    +     		+

    Matches expressions which test the runtime type of a value

    + + +

    CompiledName: |TypeTest|_|

    +
    + + ( |UnionCaseGet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase * FSharpField) option
    +
    +     		+

    Matches expressions which get a field from a union case

    + + +

    CompiledName: |UnionCaseGet|_|

    +
    + + ( |UnionCaseSet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase * FSharpField * FSharpExpr) option
    +
    +     		+

    Matches expressions which set a field from a union case (only used in FSharp.Core itself)

    + + +

    CompiledName: |UnionCaseSet|_|

    +
    + + ( |UnionCaseTag|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpType) option
    +
    +     		+

    Matches expressions which gets the tag for a union case

    + + +

    CompiledName: |UnionCaseTag|_|

    +
    + + ( |UnionCaseTest|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpType * FSharpUnionCase) option
    +
    +     		+

    Matches expressions which test if an expression corresponds to a particular union case

    + + +

    CompiledName: |UnionCaseTest|_|

    +
    + + ( |Value|_| )(arg1) + +
    + Signature: FSharpExpr -> FSharpMemberOrFunctionOrValue option
    +
    +     		+

    Matches expressions which are uses of values

    + + +

    CompiledName: |Value|_|

    +
    + + ( |ValueSet|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpMemberOrFunctionOrValue * FSharpExpr) option
    +
    +     		+

    Matches expressions which set the contents of a mutable variable

    + + +

    CompiledName: |ValueSet|_|

    +
    + + ( |WhileLoop|_| )(arg1) + +
    + Signature: FSharpExpr -> (FSharpExpr * FSharpExpr) option
    +
    +     		+

    Matches while loops

    + + +

    CompiledName: |WhileLoop|_|

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironment.html b/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironment.html new file mode 100644 index 0000000000..46b57ccaea --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironment.html @@ -0,0 +1,123 @@ + + + + + CompilerEnvironment - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CompilerEnvironment

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Information about the compilation environment

    + +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + CompilerEnvironment.BinFolderOfDefaultFSharpCompiler(...) + +
    + Signature: (probePoint:string option) -> string option
    +
    +     		+

    The default location of FSharp.Core.dll and fsc.exe based on the version of fsc.exe that is running

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html b/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html new file mode 100644 index 0000000000..21e1e4edff --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-compilerenvironmentmodule.html @@ -0,0 +1,156 @@ + + + + + CompilerEnvironment - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CompilerEnvironment

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<CompilationRepresentation(4)>]
    + +     +

    +
    +

    Information about the compilation environment

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + DefaultReferencesForOrphanSources(...) + +
    + Signature: assumeDotNetFramework:bool -> string list
    +
    +     		+

    These are the names of assemblies that should be referenced for .fs or .fsi files that +are not associated with a project.

    + + +
    + + GetCompilationDefinesForEditing(...) + +
    + Signature: parsingOptions:FSharpParsingOptions -> string list
    +
    +     		+

    Return the compilation defines that should be used when editing the given file.

    + + +
    + + IsCheckerSupportedSubcategory(arg1) + +
    + Signature: string -> bool
    +
    +     		+

    Return true if this is a subcategory of error or warning message that the language service can emit

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-completioncontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-completioncontext.html new file mode 100644 index 0000000000..50091ba4d7 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-completioncontext.html @@ -0,0 +1,221 @@ + + + + + CompletionContext - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CompletionContext

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AttributeApplication + +
    + Signature:
    +
    +     		+ +
    + + Inherit(...) + +
    + Signature: InheritanceContext * CompletionPath
    +
    +     		+

    completing something after the inherit keyword

    + + +
    + + Invalid + +
    + Signature:
    +
    +     		+

    completion context cannot be determined due to errors

    + + +
    + + OpenDeclaration + +
    + Signature:
    +
    +     		+ +
    + + ParameterList(pos,HashSet<string>) + +
    + Signature: pos * HashSet<string>
    +
    +     		+

    completing named parameters\setters in parameter list of constructor\method calls +end of name ast node * list of properties\parameters that were already set

    + + +
    + + PatternType + +
    + Signature:
    +
    +     		+

    completing pattern type (e.g. foo (x: |))

    + + +
    + + RangeOperator + +
    + Signature:
    +
    +     		+ +
    + + RecordField(RecordContext) + +
    + Signature: RecordContext
    +
    +     		+

    completing records field

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-completionitemkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-completionitemkind.html new file mode 100644 index 0000000000..b0dfc684d4 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-completionitemkind.html @@ -0,0 +1,197 @@ + + + + + CompletionItemKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CompletionItemKind

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Argument + +
    + Signature:
    +
    +     		+ +
    + + CustomOperation + +
    + Signature:
    +
    +     		+ +
    + + Event + +
    + Signature:
    +
    +     		+ +
    + + Field + +
    + Signature:
    +
    +     		+ +
    + + Method(isExtension) + +
    + Signature: bool
    +
    +     		+ +
    + + Other + +
    + Signature:
    +
    +     		+ +
    + + Property + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-completionpath.html b/docs/reference/fsharp-compiler-sourcecodeservices-completionpath.html new file mode 100644 index 0000000000..e0b422d3d7 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-completionpath.html @@ -0,0 +1,127 @@ + + + + + CompletionPath - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    CompletionPath

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: string list
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: string option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-debuggerenvironment.html b/docs/reference/fsharp-compiler-sourcecodeservices-debuggerenvironment.html new file mode 100644 index 0000000000..22ce0cf33c --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-debuggerenvironment.html @@ -0,0 +1,121 @@ + + + + + DebuggerEnvironment - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    DebuggerEnvironment

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Information about the debugging environment

    + +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + GetLanguageID() + +
    + Signature: unit -> Guid
    +
    +     		+

    Return the language ID, which is the expression evaluator id that the +debugger will use.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-entity.html b/docs/reference/fsharp-compiler-sourcecodeservices-entity.html new file mode 100644 index 0000000000..dc7edb862d --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-entity.html @@ -0,0 +1,178 @@ + + + + + Entity - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Entity

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Helper data structure representing a symbol, suitable for implementing unresolved identifiers resolution code fixes.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + FullRelativeName + +
    + Signature: StringLongIdent
    +
    +     		+

    Full name, relative to the current scope.

    + + +
    + + LastIdent + +
    + Signature: string
    +
    +     		+

    Last part of the entity's full name.

    + + +
    + + Name + +
    + Signature: StringLongIdent
    +
    +     		+

    Full display name (i.e. last ident plus modules with RequireQualifiedAccess attribute prefixed).

    + + +
    + + Namespace + +
    + Signature: StringLongIdent option
    +
    +     		+

    Namespace that is needed to open to make the entity resolvable in the current scope.

    + + +
    + + Qualifier + +
    + Signature: StringLongIdent
    +
    +     		+

    Ident parts needed to append to the current ident to make it resolvable in current scope.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-entitycache.html b/docs/reference/fsharp-compiler-sourcecodeservices-entitycache.html new file mode 100644 index 0000000000..cdd4b6d7e1 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-entitycache.html @@ -0,0 +1,155 @@ + + + + + EntityCache - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    EntityCache

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Thread safe wrapper over IAssemblyContentCache.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> EntityCache
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Clear() + +
    + Signature: unit -> unit
    +
    +     		+

    Clears the cache.

    + + +
    + + x.Locking(arg1) + +
    + Signature: ((IAssemblyContentCache -> 'T)) -> 'T
    + Type parameters: 'T
    +     		+

    Performs an operation on the cache in thread safe manner.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-entitykind.html b/docs/reference/fsharp-compiler-sourcecodeservices-entitykind.html new file mode 100644 index 0000000000..6a479af42f --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-entitykind.html @@ -0,0 +1,158 @@ + + + + + EntityKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    EntityKind

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Attribute + +
    + Signature:
    +
    +     		+ +
    + + FunctionOrValue(isActivePattern) + +
    + Signature: bool
    +
    +     		+ +
    + + Module(ModuleKind) + +
    + Signature: ModuleKind
    +
    +     		+ +
    + + Type + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-extensions.html b/docs/reference/fsharp-compiler-sourcecodeservices-extensions.html new file mode 100644 index 0000000000..9c368d3b9c --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-extensions.html @@ -0,0 +1,300 @@ + + + + + Extensions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Extensions

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<AutoOpen>]
    + +     +

    +
    +
    + + + +

    Type extensions

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Type extensionDescription
    + + x.FullTypeSafe + +
    + Signature: FSharpType option
    +
    +     		+

    Safe version of FullType.

    + + +

    CompiledName: FSharpMemberOrFunctionOrValue.get_FullTypeSafe

    +
    + + x.FullTypeSafe + +
    + Signature: FSharpType option
    +
    +     		+

    Safe version of FullType.

    + + +

    CompiledName: FSharpMemberOrFunctionOrValue.get_FullTypeSafe

    +
    + + x.PublicNestedEntities + +
    + Signature: seq<FSharpEntity>
    +
    +     		+

    Public nested entities (methods, functions, values, nested modules).

    + + +

    CompiledName: FSharpEntity.get_PublicNestedEntities

    +
    + + x.PublicNestedEntities + +
    + Signature: seq<FSharpEntity>
    +
    +     		+

    Public nested entities (methods, functions, values, nested modules).

    + + +

    CompiledName: FSharpEntity.get_PublicNestedEntities

    +
    + + x.TryGetEntities() + +
    + Signature: unit -> seq<FSharpEntity>
    +
    +     		+

    Safe version of Entities.

    + + +

    CompiledName: FSharpAssemblySignature.TryGetEntities

    +
    + + x.TryGetFullCompiledName() + +
    + Signature: unit -> string option
    +
    +     		+

    Safe version of CompiledName.

    + + +

    CompiledName: FSharpEntity.TryGetFullCompiledName

    +
    + + x.TryGetFullCompiledOperatorNameIdents() + +
    + Signature: unit -> Idents option
    +
    +     		+

    Full operator compiled name.

    + + +

    CompiledName: FSharpMemberOrFunctionOrValue.TryGetFullCompiledOperatorNameIdents

    +
    + + x.TryGetFullDisplayName() + +
    + Signature: unit -> string option
    +
    +     		+

    Safe version of DisplayName.

    + + +

    CompiledName: FSharpEntity.TryGetFullDisplayName

    +
    + + x.TryGetFullDisplayName() + +
    + Signature: unit -> string option
    +
    +     		+

    Full name with last part replaced with display name.

    + + +

    CompiledName: FSharpMemberOrFunctionOrValue.TryGetFullDisplayName

    +
    + + x.TryGetFullName() + +
    + Signature: unit -> string option
    +
    +     		+

    Safe version of FullName.

    + + +

    CompiledName: FSharpEntity.TryGetFullName

    +
    + + x.TryGetMembersFunctionsAndValues + +
    + Signature: IList<FSharpMemberOrFunctionOrValue>
    +
    +     		+

    Safe version of GetMembersFunctionsAndValues.

    + + +

    CompiledName: FSharpEntity.get_TryGetMembersFunctionsAndValues

    +
    + + x.TryGetMembersFunctionsAndValues + +
    + Signature: IList<FSharpMemberOrFunctionOrValue>
    +
    +     		+

    Safe version of GetMembersFunctionsAndValues.

    + + +

    CompiledName: FSharpEntity.get_TryGetMembersFunctionsAndValues

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-externalsymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-externalsymbol.html new file mode 100644 index 0000000000..e537395000 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-externalsymbol.html @@ -0,0 +1,186 @@ + + + + + ExternalSymbol - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ExternalSymbol

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Represents a symbol in an external (non F#) assembly

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Constructor(typeName,args) + +
    + Signature: string * ParamTypeSymbol list
    +
    +     		+ +
    + + Event(typeName,name) + +
    + Signature: string * string
    +
    +     		+ +
    + + Field(typeName,name) + +
    + Signature: string * string
    +
    +     		+ +
    + + Method(...) + +
    + Signature: string * string * ParamTypeSymbol list * int
    +
    +     		+ +
    + + Property(typeName,name) + +
    + Signature: string * string
    +
    +     		+ +
    + + Type(fullName) + +
    + Signature: string
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-externaltype.html b/docs/reference/fsharp-compiler-sourcecodeservices-externaltype.html new file mode 100644 index 0000000000..bf74b130de --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-externaltype.html @@ -0,0 +1,168 @@ + + + + + ExternalType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ExternalType

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Represents a type in an external (non F#) assembly.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Array(inner) + +
    + Signature: ExternalType
    +
    +     		+

    Array of type that is defined in non-F# assembly.

    + + +
    + + Pointer(inner) + +
    + Signature: ExternalType
    +
    +     		+

    Pointer defined in non-F# assembly.

    + + +
    + + Type(fullName,genericArgs) + +
    + Signature: string * ExternalType list
    +
    +     		+

    Type defined in non-F# assembly.

    + + +
    + + TypeVar(typeName) + +
    + Signature: string
    +
    +     		+

    Type variable defined in non-F# assembly.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-externaltypemodule.html b/docs/reference/fsharp-compiler-sourcecodeservices-externaltypemodule.html new file mode 100644 index 0000000000..2b3e996f7e --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-externaltypemodule.html @@ -0,0 +1,95 @@ + + + + + ExternalType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ExternalType

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractparameter.html new file mode 100644 index 0000000000..bf987e37c1 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractparameter.html @@ -0,0 +1,204 @@ + + + + + FSharpAbstractParameter - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpAbstractParameter

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents a parameter in an abstract method of a class or interface

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Attributes + +
    + Signature: IList<FSharpAttribute>
    +
    +     		+

    The declared attributes of the parameter

    + + +

    CompiledName: get_Attributes

    +
    + + x.IsInArg + +
    + Signature: bool
    +
    +     		+

    Indicate this is an in argument

    + + +

    CompiledName: get_IsInArg

    +
    + + x.IsOptionalArg + +
    + Signature: bool
    +
    +     		+

    Indicate this is an optional argument

    + + +

    CompiledName: get_IsOptionalArg

    +
    + + x.IsOutArg + +
    + Signature: bool
    +
    +     		+

    Indicate this is an out argument

    + + +

    CompiledName: get_IsOutArg

    +
    + + x.Name + +
    + Signature: string option
    +
    +     		+

    The optional name of the parameter

    + + +

    CompiledName: get_Name

    +
    + + x.Type + +
    + Signature: FSharpType
    +
    +     		+

    The declared or inferred type of the parameter

    + + +

    CompiledName: get_Type

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractsignature.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractsignature.html new file mode 100644 index 0000000000..0eb2d1c4f8 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpabstractsignature.html @@ -0,0 +1,204 @@ + + + + + FSharpAbstractSignature - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpAbstractSignature

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents the signature of an abstract slot of a class or interface

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AbstractArguments + +
    + Signature: IList<IList<FSharpAbstractParameter>>
    +
    +     		+

    Get the arguments of the abstract slot

    + + +

    CompiledName: get_AbstractArguments

    +
    + + x.AbstractReturnType + +
    + Signature: FSharpType
    +
    +     		+

    Get the return type of the abstract slot

    + + +

    CompiledName: get_AbstractReturnType

    +
    + + x.DeclaringType + +
    + Signature: FSharpType
    +
    +     		+

    Get the declaring type of the abstract slot

    + + +

    CompiledName: get_DeclaringType

    +
    + + x.DeclaringTypeGenericParameters + +
    + Signature: IList<FSharpGenericParameter>
    +
    +     		+

    Get the generic arguments of the type defining the abstract slot

    + + +

    CompiledName: get_DeclaringTypeGenericParameters

    +
    + + x.MethodGenericParameters + +
    + Signature: IList<FSharpGenericParameter>
    +
    +     		+

    Get the generic arguments of the abstract slot

    + + +

    CompiledName: get_MethodGenericParameters

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    Get the name of the abstract slot

    + + +

    CompiledName: get_Name

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibility.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibility.html new file mode 100644 index 0000000000..713d5f0868 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibility.html @@ -0,0 +1,167 @@ + + + + + FSharpAccessibility - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpAccessibility

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Indicates the accessibility of a symbol, as seen by the F# language

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.IsInternal + +
    + Signature: bool
    +
    +     		+

    Indicates the symbol has internal accessibility.

    + + +

    CompiledName: get_IsInternal

    +
    + + x.IsPrivate + +
    + Signature: bool
    +
    +     		+

    Indicates the symbol has private accessibility.

    + + +

    CompiledName: get_IsPrivate

    +
    + + x.IsProtected + +
    + Signature: bool
    +
    +     		+

    Indicates the symbol has protected accessibility.

    + + +

    CompiledName: get_IsProtected

    +
    + + x.IsPublic + +
    + Signature: bool
    +
    +     		+

    Indicates the symbol has public accessibility.

    + + +

    CompiledName: get_IsPublic

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibilityrights.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibilityrights.html new file mode 100644 index 0000000000..04f9fd6080 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpaccessibilityrights.html @@ -0,0 +1,100 @@ + + + + + FSharpAccessibilityRights - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpAccessibilityRights

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents the rights of a compilation to access symbols

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterncase.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterncase.html new file mode 100644 index 0000000000..2c97b6c8a1 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterncase.html @@ -0,0 +1,204 @@ + + + + + FSharpActivePatternCase - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpActivePatternCase

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    A subtype of FSharpSymbol that represents a single case within an active pattern

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DeclarationLocation + +
    + Signature: range
    +
    +     		+

    The location of declaration of the active pattern case

    + + +

    CompiledName: get_DeclarationLocation

    +
    + + x.Group + +
    + Signature: FSharpActivePatternGroup
    +
    +     		+

    The group of active pattern cases this belongs to

    + + +

    CompiledName: get_Group

    +
    + + x.Index + +
    + Signature: int
    +
    +     		+

    Index of the case in the pattern group

    + + +

    CompiledName: get_Index

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    The name of the active pattern case

    + + +

    CompiledName: get_Name

    +
    + + x.XmlDoc + +
    + Signature: IList<string>
    +
    +     		+

    Get the in-memory XML documentation for the active pattern case, used when code is checked in-memory

    + + +

    CompiledName: get_XmlDoc

    +
    + + x.XmlDocSig + +
    + Signature: string
    +
    +     		+

    XML documentation signature for the active pattern case, used for .xml file lookup for compiled code

    + + +

    CompiledName: get_XmlDocSig

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterngroup.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterngroup.html new file mode 100644 index 0000000000..6349f11d49 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpactivepatterngroup.html @@ -0,0 +1,188 @@ + + + + + FSharpActivePatternGroup - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpActivePatternGroup

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents all cases within an active pattern

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DeclaringEntity + +
    + Signature: FSharpEntity option
    +
    +     		+

    Try to get the entity in which the active pattern is declared

    + + +

    CompiledName: get_DeclaringEntity

    +
    + + x.IsTotal + +
    + Signature: bool
    +
    +     		+

    Indicate this is a total active pattern

    + + +

    CompiledName: get_IsTotal

    +
    + + x.Name + +
    + Signature: string option
    +
    +     		+

    The whole group name

    + + +

    CompiledName: get_Name

    +
    + + x.Names + +
    + Signature: IList<string>
    +
    +     		+

    The names of the active pattern cases

    + + +

    CompiledName: get_Names

    +
    + + x.OverallType + +
    + Signature: FSharpType
    +
    +     		+

    Get the type indicating signature of the active pattern

    + + +

    CompiledName: get_OverallType

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpanonrecordtypedetails.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpanonrecordtypedetails.html new file mode 100644 index 0000000000..c1dc66bb6c --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpanonrecordtypedetails.html @@ -0,0 +1,172 @@ + + + + + FSharpAnonRecordTypeDetails - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpAnonRecordTypeDetails

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Assembly + +
    + Signature: FSharpAssembly
    +
    +     		+

    The assembly where the compiled form of the anonymous type is defined

    + + +

    CompiledName: get_Assembly

    +
    + + x.CompiledName + +
    + Signature: string
    +
    +     		+

    The name of the compiled form of the anonymous type

    + + +

    CompiledName: get_CompiledName

    +
    + + x.EnclosingCompiledTypeNames + +
    + Signature: string list
    +
    +     		+

    Names of any enclosing types of the compiled form of the anonymous type (if the anonymous type was defined as a nested type)

    + + +

    CompiledName: get_EnclosingCompiledTypeNames

    +
    + + x.SortedFieldNames + +
    + Signature: string []
    +
    +     		+

    The sorted labels of the anonymous type

    + + +

    CompiledName: get_SortedFieldNames

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassembly.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassembly.html new file mode 100644 index 0000000000..46f15e675a --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassembly.html @@ -0,0 +1,210 @@ + + + + + FSharpAssembly - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpAssembly

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents an assembly as seen by the F# language

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.CodeLocation + +
    + Signature: string
    + + Attributes:
    +[<Obsolete("This item is obsolete, it is not useful")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    This item is obsolete, it is not useful

    +
    + +

    CompiledName: get_CodeLocation

    +
    + + x.Contents + +
    + Signature: FSharpAssemblySignature
    +
    +     		+

    The contents of the this assembly

    + + +

    CompiledName: get_Contents

    +
    + + x.FileName + +
    + Signature: string option
    +
    +     		+

    The file name for the assembly, if any

    + + +

    CompiledName: get_FileName

    +
    + + x.IsProviderGenerated + +
    + Signature: bool
    +
    +     		+

    Indicates if the assembly was generated by a type provider and is due for static linking

    + + +

    CompiledName: get_IsProviderGenerated

    +
    + + x.QualifiedName + +
    + Signature: string
    +
    +     		+

    The qualified name of the assembly

    + + +

    CompiledName: get_QualifiedName

    +
    + + x.SimpleName + +
    + Signature: string
    +
    +     		+

    The simple name for the assembly

    + + +

    CompiledName: get_SimpleName

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblycontents.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblycontents.html new file mode 100644 index 0000000000..0999a56199 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblycontents.html @@ -0,0 +1,119 @@ + + + + + FSharpAssemblyContents - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpAssemblyContents

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Represents the definitional contents of an assembly, as seen by the F# language

    + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.ImplementationFiles + +
    + Signature: FSharpImplementationFileContents list
    +
    +     		+

    The contents of the implementation files in the assembly

    + + +

    CompiledName: get_ImplementationFiles

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblysignature.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblysignature.html new file mode 100644 index 0000000000..b6d70ec4cb --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpassemblysignature.html @@ -0,0 +1,156 @@ + + + + + FSharpAssemblySignature - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpAssemblySignature

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents an inferred signature of part of an assembly as seen by the F# language

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Attributes + +
    + Signature: IList<FSharpAttribute>
    +
    +     		+

    Get the declared attributes for the assembly. +Only available when parsing an entire project.

    + + +

    CompiledName: get_Attributes

    +
    + + x.Entities + +
    + Signature: IList<FSharpEntity>
    +
    +     		+

    The (non-nested) module and type definitions in this signature

    + + +

    CompiledName: get_Entities

    +
    + + x.FindEntityByPath(arg1) + +
    + Signature: (string list) -> FSharpEntity option
    +
    +     		+

    Find entity using compiled names

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpattribute.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpattribute.html new file mode 100644 index 0000000000..ac6a6c83e2 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpattribute.html @@ -0,0 +1,187 @@ + + + + + FSharpAttribute - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpAttribute

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents a custom attribute attached to F# source code or a compiler .NET component

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AttributeType + +
    + Signature: FSharpEntity
    +
    +     		+

    The type of the attribute

    + + +

    CompiledName: get_AttributeType

    +
    + + x.ConstructorArguments + +
    + Signature: IList<FSharpType * obj>
    +
    +     		+

    The arguments to the constructor for the attribute

    + + +

    CompiledName: get_ConstructorArguments

    +
    + + x.Format(context) + +
    + Signature: context:FSharpDisplayContext -> string
    +
    +     		+

    Format the attribute using the rules of the given display context

    + + +
    + + x.IsUnresolved + +
    + Signature: bool
    +
    +     		+

    Indicates if the attribute type is in an unresolved assembly

    + + +

    CompiledName: get_IsUnresolved

    +
    + + x.NamedArguments + +
    + Signature: IList<FSharpType * string * bool * obj>
    +
    +     		+

    The named arguments for the attribute

    + + +

    CompiledName: get_NamedArguments

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpchecker.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpchecker.html new file mode 100644 index 0000000000..0a0f1119e9 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpchecker.html @@ -0,0 +1,888 @@ + + + + + FSharpChecker - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpChecker

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    +[<AutoSerializable(false)>]
    + +     +

    +
    +

    Used to parse and check F# source code.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.BeforeBackgroundFileCheck + +
    + Signature: IEvent<string * obj option>
    +
    +     		+

    Notify the host that the logical type checking context for a file has now been updated internally +and that the file has become eligible to be re-typechecked for errors.

    +

    The event will be raised on a background thread.

    + + +

    CompiledName: get_BeforeBackgroundFileCheck

    +
    + + x.CheckFileInProject(...) + +
    + Signature: (parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * textSnapshotInfo:obj option * userOpName:string option) -> Async<FSharpCheckFileAnswer>
    +
    +     		+

    Check a source code file, returning a handle to the results

    +

    Note: all files except the one being checked are read from the FileSystem API

    +

    Return FSharpCheckFileAnswer.Aborted if a parse tree was not available.

    + + +
    + + x.CheckFileInProjectAllowingStaleCachedResults(...) + +
    + Signature: (parsed:FSharpParseFileResults * filename:string * fileversion:int * source:string * options:FSharpProjectOptions * textSnapshotInfo:obj option * userOpName:string option) -> Async<FSharpCheckFileAnswer option>
    + + Attributes:
    +[<Obsolete("This member should no longer be used, please use 'CheckFileInProject'")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    This member should no longer be used, please use 'CheckFileInProject'

    +
    +

    Check a source code file, returning a handle to the results of the parse including +the reconstructed types in the file.All files except the one being checked are read from the FileSystem APINote: returns NoAntecedent if the background builder is not yet done preparing the type check context for the +file (e.g. loading references and parsing/checking files in the project that this file depends upon). +In this case, the caller can either retry, or wait for FileTypeCheckStateIsDirty to be raised for this file.

    + + +
    + + x.CheckProjectInBackground(...) + +
    + Signature: (options:FSharpProjectOptions * userOpName:string option) -> unit
    +
    +     		+

    Set the project to be checked in the background. Overrides any previous call to CheckProjectInBackground

    + + +
    + + x.ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients(...) + +
    + Signature: unit -> unit
    +
    +     		+

    Flush all caches and garbage collect

    + + +
    + + x.Compile(...) + +
    + Signature: (ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * pdbFile:string option * executable:bool option * noframework:bool option * userOpName:string option) -> Async<FSharpErrorInfo [] * int>
    +
    +     		+

    TypeCheck and compile provided AST

    + + +
    + + x.Compile(argv, userOpName) + +
    + Signature: (argv:string [] * userOpName:string option) -> Async<FSharpErrorInfo [] * int>
    +
    +     		+

    Compile using the given flags. Source files names are resolved via the FileSystem API. +The output file must be given by a -o flag. +The first argument is ignored and can just be "fsc.exe".

    + + +
    + + x.CompileToDynamicAssembly(...) + +
    + Signature: (ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * debug:bool option * noframework:bool option * userOpName:string option) -> Async<FSharpErrorInfo [] * int * Assembly option>
    +
    +     		+

    TypeCheck and compile provided AST

    + + +
    + + x.CompileToDynamicAssembly(...) + +
    + Signature: (otherFlags:string [] * execute:(TextWriter * TextWriter) option * userOpName:string option) -> Async<FSharpErrorInfo [] * int * Assembly option>
    +
    +     		+

    Compiles to a dynamic assembly using the given flags.

    +

    The first argument is ignored and can just be "fsc.exe".

    +

    Any source files names are resolved via the FileSystem API. An output file name must be given by a -o flag, but this will not +be written - instead a dynamic assembly will be created and loaded.

    +

    If the 'execute' parameter is given the entry points for the code are executed and +the given TextWriters are used for the stdout and stderr streams respectively. In this +case, a global setting is modified during the execution.

    + + +
    + + x.CurrentQueueLength + +
    + Signature: int
    +
    +     		+

    Current queue length of the service, for debug purposes. +In addition, a single async operation or a step of a background build +may be in progress - such an operation is not counted in the queue length.

    + + +

    CompiledName: get_CurrentQueueLength

    +
    + + x.FileChecked + +
    + Signature: IEvent<string * obj option>
    +
    +     		+

    Raised after a check of a file in the background analysis.

    +

    The event will be raised on a background thread.

    + + +

    CompiledName: get_FileChecked

    +
    + + x.FileParsed + +
    + Signature: IEvent<string * obj option>
    +
    +     		+

    Raised after a parse of a file in the background analysis.

    +

    The event will be raised on a background thread.

    + + +

    CompiledName: get_FileParsed

    +
    + + x.GetBackgroundCheckResultsForFileInProject(...) + +
    + Signature: (filename:string * options:FSharpProjectOptions * userOpName:string option) -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    +
    +     		+

    Like CheckFileInProject, but uses the existing results from the background builder.All files are read from the FileSystem API, including the file being checked.

    + + +
    + + x.GetBackgroundParseResultsForFileInProject(...) + +
    + Signature: (filename:string * options:FSharpProjectOptions * userOpName:string option) -> Async<FSharpParseFileResults>
    +
    +     		+

    Like ParseFile, but uses results from the background builder.All files are read from the FileSystem API, including the file being checked.

    + + +
    + + x.GetParsingOptionsFromCommandLineArgs(...) + +
    + Signature: (argv:string list * isInteractive:bool option) -> FSharpParsingOptions * FSharpErrorInfo list
    +
    +     		+

    Get the FSharpParsingOptions implied by a set of command line arguments.

    + + +
    + + x.GetParsingOptionsFromCommandLineArgs(...) + +
    + Signature: (sourceFiles:string list * argv:string list * isInteractive:bool option) -> FSharpParsingOptions * FSharpErrorInfo list
    +
    +     		+

    Get the FSharpParsingOptions implied by a set of command line arguments and list of source files.

    + + +
    + + x.GetParsingOptionsFromProjectOptions(...) + +
    + Signature: FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    +
    +     		+

    Get the FSharpParsingOptions implied by a FSharpProjectOptions.

    + + +
    + + x.GetProjectOptionsFromCommandLineArgs(...) + +
    + Signature: (projectFileName:string * argv:string [] * loadedTimeStamp:DateTime option * extraProjectInfo:obj option) -> FSharpProjectOptions
    +
    +     		+

    Get the FSharpProjectOptions implied by a set of command line arguments.

    + + +
    + + x.GetProjectOptionsFromScript(...) + +
    + Signature: (filename:string * sourceText:ISourceText * previewEnabled:bool option * loadedTimeStamp:DateTime option * otherFlags:string [] option * useFsiAuxLib:bool option * useSdkRefs:bool option * assumeDotNetFramework:bool option * extraProjectInfo:obj option * optionsStamp:int64 option * userOpName:string option) -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    +
    +     		+

    For a given script file, get the FSharpProjectOptions implied by the #load closure.All files are read from the FileSystem API, except the file being checked.

    + + +
    + + x.ImplicitlyStartBackgroundWork() + +
    + Signature: unit -> bool
    +
    +     		+

    Get or set a flag which controls if background work is started implicitly.

    +

    If true, calls to CheckFileInProject implicitly start a background check of that project, replacing +any other background checks in progress. This is useful in IDE applications with spare CPU cycles as +it prepares the project analysis results for use. The default is 'true'.

    + + +

    CompiledName: set_ImplicitlyStartBackgroundWork

    +
    + + x.ImplicitlyStartBackgroundWork() + +
    + Signature: unit -> unit
    +
    +     		+

    Get or set a flag which controls if background work is started implicitly.

    +

    If true, calls to CheckFileInProject implicitly start a background check of that project, replacing +any other background checks in progress. This is useful in IDE applications with spare CPU cycles as +it prepares the project analysis results for use. The default is 'true'.

    + + +

    CompiledName: get_ImplicitlyStartBackgroundWork

    +
    + + x.InvalidateAll() + +
    + Signature: unit -> unit
    +
    +     		+

    This function is called when the entire environment is known to have changed for reasons not encoded in the ProjectOptions of any project/compilation.

    + + +
    + + x.InvalidateConfiguration(...) + +
    + Signature: (options:FSharpProjectOptions * startBackgroundCompileIfAlreadySeen:bool option * userOpName:string option) -> unit
    +
    +     		+

    This function is called when the configuration is known to have changed for reasons not encoded in the ProjectOptions. +For example, dependent references may have been deleted or created. +Start a background compile of the project if a project with the same name has already been seen before. +An optional string used for tracing compiler operations associated with this request.

    + + +
    + + x.MatchBraces(...) + +
    + Signature: (filename:string * source:string * options:FSharpProjectOptions * userOpName:string option) -> Async<(range * range) []>
    + + Attributes:
    +[<Obsolete("Please pass FSharpParsingOptions to MatchBraces. If necessary generate FSharpParsingOptions from FSharpProjectOptions by calling checker.GetParsingOptionsFromProjectOptions(options)")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Please pass FSharpParsingOptions to MatchBraces. If necessary generate FSharpParsingOptions from FSharpProjectOptions by calling checker.GetParsingOptionsFromProjectOptions(options)

    +
    +

    Parse a source code file, returning information about brace matching in the file. +Return an enumeration of the matching parenthetical tokens in the file.

    + + +
    + + x.MatchBraces(...) + +
    + Signature: (filename:string * sourceText:ISourceText * options:FSharpParsingOptions * userOpName:string option) -> Async<(range * range) []>
    +
    +     		+

    Parse a source code file, returning information about brace matching in the file. +Return an enumeration of the matching parenthetical tokens in the file.

    + + +
    + + x.MaxMemory() + +
    + Signature: unit -> int
    +
    +     		+

    A maximum number of megabytes of allocated memory. If the figure reported by System.GC.GetTotalMemory(false) goes over this limit, the FSharpChecker object will attempt to free memory and reduce cache sizes to a minimum.

    + + +

    CompiledName: set_MaxMemory

    +
    + + x.MaxMemory() + +
    + Signature: unit -> unit
    +
    +     		+

    A maximum number of megabytes of allocated memory. If the figure reported by System.GC.GetTotalMemory(false) goes over this limit, the FSharpChecker object will attempt to free memory and reduce cache sizes to a minimum.

    + + +

    CompiledName: get_MaxMemory

    +
    + + x.MaxMemoryReached + +
    + Signature: IEvent<unit>
    +
    +     		+

    Raised after the maxMB memory threshold limit is reached

    + + +

    CompiledName: get_MaxMemoryReached

    +
    + + x.NotifyProjectCleaned(...) + +
    + Signature: (options:FSharpProjectOptions * userOpName:string option) -> Async<unit>
    +
    +     		+

    This function is called when a project has been cleaned/rebuilt, and thus any live type providers should be refreshed.

    + + +
    + + x.ParseAndCheckFileInProject(...) + +
    + Signature: (filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * textSnapshotInfo:obj option * userOpName:string option) -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    +
    +     		+

    Parse and check a source code file, returning a handle to the results

    +

    Note: all files except the one being checked are read from the FileSystem API

    +

    Return FSharpCheckFileAnswer.Aborted if a parse tree was not available.

    + + +
    + + x.ParseAndCheckProject(...) + +
    + Signature: (options:FSharpProjectOptions * userOpName:string option) -> Async<FSharpCheckProjectResults>
    +
    +     		+

    Parse and typecheck all files in a project.All files are read from the FileSystem API

    + + +
    + + x.ParseFile(...) + +
    + Signature: (filename:string * sourceText:ISourceText * options:FSharpParsingOptions * userOpName:string option) -> Async<FSharpParseFileResults>
    +
    +     		+

    Parses a source code for a file and caches the results. Returns an AST that can be traversed for various features.

    + + +
    + + x.ParseFileInProject(...) + +
    + Signature: (filename:string * source:string * options:FSharpProjectOptions * userOpName:string option) -> Async<FSharpParseFileResults>
    + + Attributes:
    +[<Obsolete("Please call checker.ParseFile instead. To do this, you must also pass FSharpParsingOptions instead of FSharpProjectOptions. If necessary generate FSharpParsingOptions from FSharpProjectOptions by calling checker.GetParsingOptionsFromProjectOptions(options)")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Please call checker.ParseFile instead. To do this, you must also pass FSharpParsingOptions instead of FSharpProjectOptions. If necessary generate FSharpParsingOptions from FSharpProjectOptions by calling checker.GetParsingOptionsFromProjectOptions(options)

    +
    +

    Parses a source code for a file. Returns an AST that can be traversed for various features.

    + + +
    + + x.ParseFileNoCache(...) + +
    + Signature: (filename:string * sourceText:ISourceText * options:FSharpParsingOptions * userOpName:string option) -> Async<FSharpParseFileResults>
    +
    +     		+

    Parses a source code for a file. Returns an AST that can be traversed for various features.

    + + +
    + + x.PauseBeforeBackgroundWork() + +
    + Signature: unit -> int
    +
    +     		+

    Get or set the pause time in milliseconds before background work is started.

    + + +

    CompiledName: set_PauseBeforeBackgroundWork

    +
    + + x.PauseBeforeBackgroundWork() + +
    + Signature: unit -> unit
    +
    +     		+

    Get or set the pause time in milliseconds before background work is started.

    + + +

    CompiledName: get_PauseBeforeBackgroundWork

    +
    + + x.ProjectChecked + +
    + Signature: IEvent<string * obj option>
    +
    +     		+

    Notify the host that a project has been fully checked in the background (using file contents provided by the file system API)

    +

    The event may be raised on a background thread.

    + + +

    CompiledName: get_ProjectChecked

    +
    + + x.StopBackgroundCompile() + +
    + Signature: unit -> unit
    +
    +     		+

    Stop the background compile.

    + + +
    + + x.TokenizeFile(source) + +
    + Signature: source:string -> FSharpTokenInfo [] []
    +
    +     		+

    Tokenize an entire file, line by line

    + + +
    + + x.TokenizeLine(line, state) + +
    + Signature: (line:string * state:FSharpTokenizerLexState) -> FSharpTokenInfo [] * FSharpTokenizerLexState
    +
    +     		+

    Tokenize a single line, returning token information and a tokenization state represented by an integer

    + + +
    + + x.TryGetRecentCheckResultsForFile(...) + +
    + Signature: (filename:string * options:FSharpProjectOptions * sourceText:ISourceText option * userOpName:string option) -> (FSharpParseFileResults * FSharpCheckFileResults * int) option
    +
    +     		+

    Try to get type check results for a file. This looks up the results of recent type checks of the +same file, regardless of contents. The version tag specified in the original check of the file is returned. +If the source of the file has changed the results returned by this function may be out of date, though may +still be usable for generating intellisense menus and information.

    + + +
    + + x.WaitForBackgroundCompile() + +
    + Signature: unit -> unit
    +
    +     		+

    Block until the background compile finishes.

    + + +
    +

    Static members

    + + + + + + + + + + + + + + + + + + + + + + +
    Static memberDescription
    + + FSharpChecker.Create(...) + +
    + Signature: (projectCacheSize:int option * keepAssemblyContents:bool option * keepAllBackgroundResolutions:bool option * legacyReferenceResolver:Resolver option * tryGetMetadataSnapshot:ILReaderTryGetMetadataSnapshot option * suggestNamesForErrors:bool option * keepAllBackgroundSymbolUses:bool option) -> FSharpChecker
    +
    +     		+

    Create an instance of an FSharpChecker.

    + + +
    + + FSharpChecker.GlobalForegroundParseCountStatistic(...) + +
    + Signature: int
    +
    +     		+

    Report a statistic for testability

    + + +

    CompiledName: get_GlobalForegroundParseCountStatistic

    +
    + + FSharpChecker.GlobalForegroundTypeCheckCountStatistic(...) + +
    + Signature: int
    +
    +     		+

    Report a statistic for testability

    + + +

    CompiledName: get_GlobalForegroundTypeCheckCountStatistic

    +
    + + FSharpChecker.Instance + +
    + Signature: FSharpChecker
    + + Attributes:
    +[<Obsolete("Please create an instance of FSharpChecker using FSharpChecker.Create")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Please create an instance of FSharpChecker using FSharpChecker.Create

    +
    + +

    CompiledName: get_Instance

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html new file mode 100644 index 0000000000..0c25c1ebfe --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileanswer.html @@ -0,0 +1,138 @@ + + + + + FSharpCheckFileAnswer - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpCheckFileAnswer

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    The result of calling TypeCheckResult including the possibility of abort and background compiler not caught up.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Aborted + +
    + Signature:
    +
    +     		+

    Aborted because cancellation caused an abandonment of the operation

    + + +
    + + Succeeded(FSharpCheckFileResults) + +
    + Signature: FSharpCheckFileResults
    +
    +     		+

    Success

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html new file mode 100644 index 0000000000..e6438dbd82 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckfileresults.html @@ -0,0 +1,472 @@ + + + + + FSharpCheckFileResults - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpCheckFileResults

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    A handle to the results of CheckFileInProject.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DependencyFiles + +
    + Signature: string []
    +
    +     		+

    Indicates the set of files which must be watched to accurately track changes that affect these results, +Clients interested in reacting to updates to these files should watch these files and take actions as described +in the documentation for compiler service.

    + + +

    CompiledName: get_DependencyFiles

    +
    + + x.Errors + +
    + Signature: FSharpErrorInfo []
    +
    +     		+

    The errors returned by parsing a source file.

    + + +

    CompiledName: get_Errors

    +
    + + x.GetAllUsesOfAllSymbolsInFile() + +
    + Signature: unit -> Async<FSharpSymbolUse []>
    +
    +     		+

    Get all textual usages of all symbols throughout the file

    + + +
    + + x.GetDeclarationListInfo(...) + +
    + Signature: (ParsedFileResultsOpt:FSharpParseFileResults option * line:int * lineText:string * partialName:PartialLongName * getAllEntities:(unit -> AssemblySymbol list) option * hasTextChangedSinceLastTypecheck:(obj * range -> bool) option * userOpName:string option) -> Async<FSharpDeclarationListInfo>
    +
    +     		+

    Get the items for a declaration list

    + + +
    + + x.GetDeclarationListSymbols(...) + +
    + Signature: (ParsedFileResultsOpt:FSharpParseFileResults option * line:int * lineText:string * partialName:PartialLongName * getAllEntities:(unit -> AssemblySymbol list) option * hasTextChangedSinceLastTypecheck:(obj * range -> bool) option * userOpName:string option) -> Async<FSharpSymbolUse list list>
    +
    +     		+

    Get the items for a declaration list in FSharpSymbol format

    + + +
    + + x.GetDeclarationLocation(...) + +
    + Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * preferFlag:bool option * userOpName:string option) -> Async<FSharpFindDeclResult>
    +
    +     		+

    Resolve the names at the given location to the declaration location of the corresponding construct.

    + + +
    + + x.GetDisplayContextForPos(pos) + +
    + Signature: pos:pos -> Async<FSharpDisplayContext option>
    +
    +     		+

    Find the most precise display environment for the given line and column.

    + + +
    + + x.GetF1Keyword(...) + +
    + Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * userOpName:string option) -> Async<string option>
    +
    +     		+

    Compute the Visual Studio F1-help key identifier for the given location, based on name resolution results

    + + +
    + + x.GetFormatSpecifierLocations() + +
    + Signature: unit -> range []
    + + Attributes:
    +[<Obsolete("This member has been replaced by GetFormatSpecifierLocationsAndArity, which returns both range and arity of specifiers")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    This member has been replaced by GetFormatSpecifierLocationsAndArity, which returns both range and arity of specifiers

    +
    +

    Get the locations of format specifiers

    + + +
    + + x.GetFormatSpecifierLocationsAndArity() + +
    + Signature: unit -> (range * int) []
    +
    +     		+

    Get the locations of and number of arguments associated with format specifiers

    + + +
    + + x.GetMethods(...) + +
    + Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list option * userOpName:string option) -> Async<FSharpMethodGroup>
    +
    +     		+

    Compute a set of method overloads to show in a dialog relevant to the given code location.

    + + +
    + + x.GetMethodsAsSymbols(...) + +
    + Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * userOpName:string option) -> Async<FSharpSymbolUse list option>
    +
    +     		+

    Compute a set of method overloads to show in a dialog relevant to the given code location. The resulting method overloads are returned as symbols.

    + + +
    + + x.GetSemanticClassification(arg1) + +
    + Signature: (range option) -> (range * SemanticClassificationType) []
    +
    +     		+

    Get any extra colorization info that is available after the typecheck

    + + +
    + + x.GetStructuredToolTipText(...) + +
    + Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * userOpName:string option) -> Async<FSharpStructuredToolTipText>
    +
    +     		+

    Compute a formatted tooltip for the given location

    + + +
    + + x.GetSymbolUseAtLocation(...) + +
    + Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * userOpName:string option) -> Async<FSharpSymbolUse option>
    +
    +     		+

    Resolve the names at the given location to a use of symbol.

    + + +
    + + x.GetToolTipText(...) + +
    + Signature: (line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * userOpName:string option) -> Async<FSharpToolTipText>
    +
    +     		+

    Compute a formatted tooltip for the given location

    + + +
    + + x.GetUsesOfSymbolInFile(symbol) + +
    + Signature: symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    +
    +     		+

    Get the textual usages that resolved to the given symbol throughout the file

    + + +
    + + x.HasFullTypeCheckInfo + +
    + Signature: bool
    +
    +     		+

    Indicates whether type checking successfully occurred with some results returned. If false, indicates that +an unrecoverable error in earlier checking/parsing/resolution steps.

    + + +

    CompiledName: get_HasFullTypeCheckInfo

    +
    + + x.ImplementationFile + +
    + Signature: FSharpImplementationFileContents option
    +
    +     		+

    Represents complete typechecked implementation file, including its typechecked signatures if any.

    + + +

    CompiledName: get_ImplementationFile

    +
    + + x.IsRelativeNameResolvableFromSymbol(...) + +
    + Signature: (cursorPos:pos * plid:string list * symbol:FSharpSymbol * userOpName:string option) -> Async<bool>
    +
    +     		+

    Determines if a long ident is resolvable at a specific point. +An optional string used for tracing compiler operations associated with this request.

    + + +
    + + x.OpenDeclarations + +
    + Signature: FSharpOpenDeclaration []
    +
    +     		+

    Open declarations in the file, including auto open modules.

    + + +

    CompiledName: get_OpenDeclarations

    +
    + + x.PartialAssemblySignature + +
    + Signature: FSharpAssemblySignature
    +
    +     		+

    Get a view of the contents of the assembly up to and including the file just checked

    + + +

    CompiledName: get_PartialAssemblySignature

    +
    + + x.ProjectContext + +
    + Signature: FSharpProjectContext
    +
    +     		+

    Get the resolution of the ProjectOptions

    + + +

    CompiledName: get_ProjectContext

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html new file mode 100644 index 0000000000..ff188ea21e --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpcheckprojectresults.html @@ -0,0 +1,251 @@ + + + + + FSharpCheckProjectResults - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpCheckProjectResults

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    A handle to the results of CheckFileInProject.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AssemblyContents + +
    + Signature: FSharpAssemblyContents
    +
    +     		+

    Get a view of the overall contents of the assembly. Only valid to use if HasCriticalErrors is false.

    + + +

    CompiledName: get_AssemblyContents

    +
    + + x.AssemblySignature + +
    + Signature: FSharpAssemblySignature
    +
    +     		+

    Get a view of the overall signature of the assembly. Only valid to use if HasCriticalErrors is false.

    + + +

    CompiledName: get_AssemblySignature

    +
    + + x.DependencyFiles + +
    + Signature: string []
    +
    +     		+

    Indicates the set of files which must be watched to accurately track changes that affect these results, +Clients interested in reacting to updates to these files should watch these files and take actions as described +in the documentation for compiler service.

    + + +

    CompiledName: get_DependencyFiles

    +
    + + x.Errors + +
    + Signature: FSharpErrorInfo []
    +
    +     		+

    The errors returned by processing the project

    + + +

    CompiledName: get_Errors

    +
    + + x.GetAllUsesOfAllSymbols() + +
    + Signature: unit -> Async<FSharpSymbolUse []>
    +
    +     		+

    Get all textual usages of all symbols throughout the project

    + + +
    + + x.GetOptimizedAssemblyContents() + +
    + Signature: unit -> FSharpAssemblyContents
    +
    +     		+

    Get an optimized view of the overall contents of the assembly. Only valid to use if HasCriticalErrors is false.

    + + +
    + + x.GetUsesOfSymbol(symbol) + +
    + Signature: symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    +
    +     		+

    Get the textual usages that resolved to the given symbol throughout the project

    + + +
    + + x.HasCriticalErrors + +
    + Signature: bool
    +
    +     		+

    Indicates if critical errors existed in the project options

    + + +

    CompiledName: get_HasCriticalErrors

    +
    + + x.ProjectContext + +
    + Signature: FSharpProjectContext
    +
    +     		+

    Get the resolution of the ProjectOptions

    + + +

    CompiledName: get_ProjectContext

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistinfo.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistinfo.html new file mode 100644 index 0000000000..3e8afa7b0e --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistinfo.html @@ -0,0 +1,173 @@ + + + + + FSharpDeclarationListInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpDeclarationListInfo

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents a set of declarations in F# source code, with information attached ready for display by an editor. +Returned by GetDeclarations.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.IsError + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsError

    +
    + + x.IsForType + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsForType

    +
    + + x.Items + +
    + Signature: FSharpDeclarationListItem []
    +
    +     		+ +

    CompiledName: get_Items

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + FSharpDeclarationListInfo.Empty + +
    + Signature: FSharpDeclarationListInfo
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistitem.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistitem.html new file mode 100644 index 0000000000..cba5460bbd --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdeclarationlistitem.html @@ -0,0 +1,315 @@ + + + + + FSharpDeclarationListItem - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpDeclarationListItem

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents a declaration in F# source code, with information attached ready for display by an editor. +Returned by GetDeclarations.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Accessibility + +
    + Signature: FSharpAccessibility option
    +
    +     		+ +

    CompiledName: get_Accessibility

    +
    + + x.DescriptionText + +
    + Signature: FSharpToolTipText
    +
    +     		+ +

    CompiledName: get_DescriptionText

    +
    + + x.DescriptionTextAsync + +
    + Signature: Async<FSharpToolTipText>
    +
    +     		+ +

    CompiledName: get_DescriptionTextAsync

    +
    + + x.FullName + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_FullName

    +
    + + x.Glyph + +
    + Signature: FSharpGlyph
    +
    +     		+ +

    CompiledName: get_Glyph

    +
    + + x.IsOwnMember + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsOwnMember

    +
    + + x.IsResolved + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsResolved

    +
    + + x.Kind + +
    + Signature: CompletionItemKind
    +
    +     		+ +

    CompiledName: get_Kind

    +
    + + x.MinorPriority + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_MinorPriority

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    Get the display name for the declaration.

    + + +

    CompiledName: get_Name

    +
    + + x.NameInCode + +
    + Signature: string
    +
    +     		+

    Get the name for the declaration as it's presented in source code.

    + + +

    CompiledName: get_NameInCode

    +
    + + x.NamespaceToOpen + +
    + Signature: string option
    +
    +     		+ +

    CompiledName: get_NamespaceToOpen

    +
    + + x.StructuredDescriptionText + +
    + Signature: FSharpStructuredToolTipText
    +
    +     		+

    Get the description text for the declaration. Computing this property may require using compiler +resources and may trigger execution of a type provider method to retrieve documentation.

    +

    May return "Loading..." if timeout occurs

    + + +

    CompiledName: get_StructuredDescriptionText

    +
    + + x.StructuredDescriptionTextAsync + +
    + Signature: Async<FSharpStructuredToolTipText>
    +
    +     		+

    Get the description text, asynchronously. Never returns "Loading...".

    + + +

    CompiledName: get_StructuredDescriptionTextAsync

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdelegatesignature.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdelegatesignature.html new file mode 100644 index 0000000000..21e6fce360 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdelegatesignature.html @@ -0,0 +1,140 @@ + + + + + FSharpDelegateSignature - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpDelegateSignature

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents a delegate signature in an F# symbol

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DelegateArguments + +
    + Signature: IList<string option * FSharpType>
    +
    +     		+

    Get the argument types of the delegate signature

    + + +

    CompiledName: get_DelegateArguments

    +
    + + x.DelegateReturnType + +
    + Signature: FSharpType
    +
    +     		+

    Get the return type of the delegate signature

    + + +

    CompiledName: get_DelegateReturnType

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdisplaycontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdisplaycontext.html new file mode 100644 index 0000000000..b927b672e3 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpdisplaycontext.html @@ -0,0 +1,146 @@ + + + + + FSharpDisplayContext - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpDisplayContext

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents the information needed to format types and other information in a style +suitable for use in F# source text at a particular source location.

    +

    Acquired via GetDisplayEnvAtLocationAlternate and similar methods. May be passed +to the Format method on FSharpType and other methods.

    + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.WithShortTypeNames(arg1) + +
    + Signature: bool -> FSharpDisplayContext
    +
    +     		+ +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + FSharpDisplayContext.Empty + +
    + Signature: FSharpDisplayContext
    +
    +     		+ +

    CompiledName: get_Empty

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpenclosingentitykind.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpenclosingentitykind.html new file mode 100644 index 0000000000..6e342cb34c --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpenclosingentitykind.html @@ -0,0 +1,210 @@ + + + + + FSharpEnclosingEntityKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpEnclosingEntityKind

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Class + +
    + Signature:
    +
    +     		+ +
    + + DU + +
    + Signature:
    +
    +     		+ +
    + + Enum + +
    + Signature:
    +
    +     		+ +
    + + Exception + +
    + Signature:
    +
    +     		+ +
    + + Interface + +
    + Signature:
    +
    +     		+ +
    + + Module + +
    + Signature:
    +
    +     		+ +
    + + Namespace + +
    + Signature:
    +
    +     		+ +
    + + Record + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpentity.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpentity.html new file mode 100644 index 0000000000..ee912cf4b4 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpentity.html @@ -0,0 +1,1021 @@ + + + + + FSharpEntity - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpEntity

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    A subtype of FSharpSymbol that represents a type definition or module as seen by the F# language

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AbbreviatedType + +
    + Signature: FSharpType
    +
    +     		+

    Get the type abbreviated by an F# type abbreviation

    + + +

    CompiledName: get_AbbreviatedType

    +
    + + x.Accessibility + +
    + Signature: FSharpAccessibility
    +
    +     		+

    Get the declared accessibility of the type

    + + +

    CompiledName: get_Accessibility

    +
    + + x.AccessPath + +
    + Signature: string
    +
    +     		+

    Get the path used to address the entity (e.g. "Namespace.Module1.NestedModule2"). Gives +"global" for items not in a namespace.

    + + +

    CompiledName: get_AccessPath

    +
    + + x.ActivePatternCases + +
    + Signature: FSharpActivePatternCase list
    +
    +     		+

    Get all active pattern cases defined in all active patterns in the module.

    + + +

    CompiledName: get_ActivePatternCases

    +
    + + x.AllCompilationPaths + +
    + Signature: string list
    +
    +     		+

    Get all compilation paths, taking Module suffixes into account.

    + + +

    CompiledName: get_AllCompilationPaths

    +
    + + x.AllInterfaces + +
    + Signature: IList<FSharpType>
    +
    +     		+

    Get all the interface implementations, by walking the type hierarchy

    + + +

    CompiledName: get_AllInterfaces

    +
    + + x.ArrayRank + +
    + Signature: int
    +
    +     		+

    Get the rank of an array type

    + + +

    CompiledName: get_ArrayRank

    +
    + + x.Attributes + +
    + Signature: IList<FSharpAttribute>
    +
    +     		+

    Get the declared attributes for the type

    + + +

    CompiledName: get_Attributes

    +
    + + x.BaseType + +
    + Signature: FSharpType option
    +
    +     		+

    Get the base type, if any

    + + +

    CompiledName: get_BaseType

    +
    + + x.CompiledName + +
    + Signature: string
    +
    +     		+

    Get the compiled name of the type or module, possibly with `n mangling. This is identical to LogicalName +unless the CompiledName attribute is used.

    + + +

    CompiledName: get_CompiledName

    +
    + + x.DeclarationLocation + +
    + Signature: range
    +
    +     		+

    Get the declaration location for the type constructor

    + + +

    CompiledName: get_DeclarationLocation

    +
    + + x.DeclaredInterfaces + +
    + Signature: IList<FSharpType>
    +
    +     		+

    Get the declared interface implementations

    + + +

    CompiledName: get_DeclaredInterfaces

    +
    + + x.DeclaringEntity + +
    + Signature: FSharpEntity option
    +
    +     		+

    Get the enclosing entity for the definition

    + + +

    CompiledName: get_DeclaringEntity

    +
    + + x.DisplayName + +
    + Signature: string
    +
    +     		+

    Get the name of the type or module as displayed in F# code

    + + +

    CompiledName: get_DisplayName

    +
    + + x.FSharpDelegateSignature + +
    + Signature: FSharpDelegateSignature
    +
    +     		+

    Indicates if the type is a delegate with the given Invoke signature

    + + +

    CompiledName: get_FSharpDelegateSignature

    +
    + + x.FSharpFields + +
    + Signature: IList<FSharpField>
    +
    +     		+

    Get the fields of a record, class, struct or enum from the perspective of the F# language. +This includes static fields, the 'val' bindings in classes and structs, and the value definitions in enums. +For classes, the list may include compiler generated fields implied by the use of primary constructors.

    + + +

    CompiledName: get_FSharpFields

    +
    + + x.FullName + +
    + Signature: string
    +
    +     		+

    Get the full name of the type or module

    + + +

    CompiledName: get_FullName

    +
    + + x.GenericParameters + +
    + Signature: IList<FSharpGenericParameter>
    +
    +     		+

    Get the generic parameters, possibly including unit-of-measure parameters

    + + +

    CompiledName: get_GenericParameters

    +
    + + x.HasAssemblyCodeRepresentation + +
    + Signature: bool
    +
    +     		+

    Indicates if the type is implemented through a mapping to IL assembly code. This is only +true for types in FSharp.Core.dll

    + + +

    CompiledName: get_HasAssemblyCodeRepresentation

    +
    + + x.HasFSharpModuleSuffix + +
    + Signature: bool
    +
    +     		+

    Indicates that a module is compiled to a class with the given mangled name. The mangling is reversed during lookup

    + + +

    CompiledName: get_HasFSharpModuleSuffix

    +
    + + x.IsArrayType + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is an array type

    + + +

    CompiledName: get_IsArrayType

    +
    + + x.IsAttributeType + +
    + Signature: bool
    +
    +     		+

    Check if the entity inherits from System.Attribute in its type hierarchy

    + + +

    CompiledName: get_IsAttributeType

    +
    + + x.IsByRef + +
    + Signature: bool
    +
    +     		+

    Indicates if is the 'byref<_>' type definition used for byref types in F#-compiled assemblies

    + + +

    CompiledName: get_IsByRef

    +
    + + x.IsClass + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a class type definition

    + + +

    CompiledName: get_IsClass

    +
    + + x.IsDelegate + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a delegate type definition

    + + +

    CompiledName: get_IsDelegate

    +
    + + x.IsEnum + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is an enum type definition

    + + +

    CompiledName: get_IsEnum

    +
    + + x.IsFSharp + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a reference to something in an F#-compiled assembly

    + + +

    CompiledName: get_IsFSharp

    +
    + + x.IsFSharpAbbreviation + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a measure, type or exception abbreviation

    + + +

    CompiledName: get_IsFSharpAbbreviation

    +
    + + x.IsFSharpExceptionDeclaration + +
    + Signature: bool
    +
    +     		+

    Indicates an F# exception declaration

    + + +

    CompiledName: get_IsFSharpExceptionDeclaration

    +
    + + x.IsFSharpModule + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is an F# module definition

    + + +

    CompiledName: get_IsFSharpModule

    +
    + + x.IsFSharpRecord + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is record type

    + + +

    CompiledName: get_IsFSharpRecord

    +
    + + x.IsFSharpUnion + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is union type

    + + +

    CompiledName: get_IsFSharpUnion

    +
    + + x.IsInterface + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is an interface type definition

    + + +

    CompiledName: get_IsInterface

    +
    + + x.IsMeasure + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a measure definition

    + + +

    CompiledName: get_IsMeasure

    +
    + + x.IsNamespace + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a part of a namespace path

    + + +

    CompiledName: get_IsNamespace

    +
    + + x.IsOpaque + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a type definition for a reference type where the implementation details are hidden by a signature

    + + +

    CompiledName: get_IsOpaque

    +
    + + x.IsProvided + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a provided type

    + + +

    CompiledName: get_IsProvided

    +
    + + x.IsProvidedAndErased + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is an erased provided type

    + + +

    CompiledName: get_IsProvidedAndErased

    +
    + + x.IsProvidedAndGenerated + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a generated provided type

    + + +

    CompiledName: get_IsProvidedAndGenerated

    +
    + + x.IsStaticInstantiation + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a 'fake' symbol related to a static instantiation of a type provider

    + + +

    CompiledName: get_IsStaticInstantiation

    +
    + + x.IsUnresolved + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is in an unresolved assembly

    + + +

    CompiledName: get_IsUnresolved

    +
    + + x.IsValueType + +
    + Signature: bool
    +
    +     		+

    Indicates if the entity is a struct or enum

    + + +

    CompiledName: get_IsValueType

    +
    + + x.LogicalName + +
    + Signature: string
    +
    +     		+

    Get the name of the type or module, possibly with `n mangling

    + + +

    CompiledName: get_LogicalName

    +
    + + x.MembersFunctionsAndValues + +
    + Signature: IList<FSharpMemberOrFunctionOrValue>
    +
    +     		+

    Get the properties, events and methods of a type definitions, or the functions and values of a module

    + + +

    CompiledName: get_MembersFunctionsAndValues

    +
    + + x.MembersOrValues + +
    + Signature: IList<FSharpMemberOrFunctionOrValue>
    + + Attributes:
    +[<Obsolete("Renamed to MembersFunctionsAndValues")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Renamed to MembersFunctionsAndValues

    +
    + +

    CompiledName: get_MembersOrValues

    +
    + + x.Namespace + +
    + Signature: string option
    +
    +     		+

    Get the namespace containing the type or module, if any. Use 'None' for item not in a namespace.

    + + +

    CompiledName: get_Namespace

    +
    + + x.NestedEntities + +
    + Signature: IList<FSharpEntity>
    +
    +     		+

    Get the modules and types defined in a module, or the nested types of a type

    + + +

    CompiledName: get_NestedEntities

    +
    + + x.QualifiedName + +
    + Signature: string
    +
    +     		+

    Get the fully qualified name of the type or module

    + + +

    CompiledName: get_QualifiedName

    +
    + + x.RecordFields + +
    + Signature: IList<FSharpField>
    + + Attributes:
    +[<Obsolete("Renamed to FSharpFields")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Renamed to FSharpFields

    +
    + +

    CompiledName: get_RecordFields

    +
    + + x.RepresentationAccessibility + +
    + Signature: FSharpAccessibility
    +
    +     		+

    Get the declared accessibility of the representation, not taking signatures into account

    + + +

    CompiledName: get_RepresentationAccessibility

    +
    + + x.StaticParameters + +
    + Signature: IList<FSharpStaticParameter>
    +
    +     		+

    Get the static parameters for a provided type

    + + +

    CompiledName: get_StaticParameters

    +
    + + x.TryFullName + +
    + Signature: string option
    +
    +     		+

    Get the full name of the type or module if it is available

    + + +

    CompiledName: get_TryFullName

    +
    + + x.UnionCases + +
    + Signature: IList<FSharpUnionCase>
    +
    +     		+

    Get the cases of a union type

    + + +

    CompiledName: get_UnionCases

    +
    + + x.UsesPrefixDisplay + +
    + Signature: bool
    +
    +     		+

    Indicates if the type prefers the "tycon" syntax for display etc.

    + + +

    CompiledName: get_UsesPrefixDisplay

    +
    + + x.XmlDoc + +
    + Signature: IList<string>
    +
    +     		+

    Get the in-memory XML documentation for the entity, used when code is checked in-memory

    + + +

    CompiledName: get_XmlDoc

    +
    + + x.XmlDocSig + +
    + Signature: string
    +
    +     		+

    Get the XML documentation signature for the entity, used for .xml file lookup for compiled code

    + + +

    CompiledName: get_XmlDocSig

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorinfo.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorinfo.html new file mode 100644 index 0000000000..e648b098f6 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorinfo.html @@ -0,0 +1,232 @@ + + + + + FSharpErrorInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpErrorInfo

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.EndColumn + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_EndColumn

    +
    + + x.EndLineAlternate + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_EndLineAlternate

    +
    + + x.ErrorNumber + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_ErrorNumber

    +
    + + x.FileName + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_FileName

    +
    + + x.Message + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Message

    +
    + + x.Severity + +
    + Signature: FSharpErrorSeverity
    +
    +     		+ +

    CompiledName: get_Severity

    +
    + + x.StartColumn + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_StartColumn

    +
    + + x.StartLineAlternate + +
    + Signature: int
    +
    +     		+ +

    CompiledName: get_StartLineAlternate

    +
    + + x.Subcategory + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Subcategory

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorseverity.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorseverity.html new file mode 100644 index 0000000000..a80d59ff16 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharperrorseverity.html @@ -0,0 +1,132 @@ + + + + + FSharpErrorSeverity - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpErrorSeverity

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Error + +
    + Signature:
    +
    +     		+ +
    + + Warning + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpexpr.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpexpr.html new file mode 100644 index 0000000000..7bf975c3e0 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpexpr.html @@ -0,0 +1,159 @@ + + + + + FSharpExpr - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpExpr

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents a checked and reduced expression, as seen by the F# language. The active patterns +in 'FSharp.Compiler.SourceCodeServices' can be used to analyze information about the expression.

    +

    Pattern matching is reduced to decision trees and conditional tests. Some other +constructs may be represented in reduced form.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.ImmediateSubExpressions + +
    + Signature: FSharpExpr list
    +
    +     		+

    The immediate sub-expressions of the expression.

    + + +

    CompiledName: get_ImmediateSubExpressions

    +
    + + x.Range + +
    + Signature: range
    +
    +     		+

    The range of the expression

    + + +

    CompiledName: get_Range

    +
    + + x.Type + +
    + Signature: FSharpType
    +
    +     		+

    The type of the expression

    + + +

    CompiledName: get_Type

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfield.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfield.html new file mode 100644 index 0000000000..f0c5ac55b1 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfield.html @@ -0,0 +1,429 @@ + + + + + FSharpField - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpField

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Accessibility + +
    + Signature: FSharpAccessibility
    +
    +     		+

    Indicates if the declared visibility of the field, not taking signatures into account

    + + +

    CompiledName: get_Accessibility

    +
    + + x.AnonRecordFieldDetails + +
    + Signature: FSharpAnonRecordTypeDetails * FSharpType [] * int
    +
    +     		+

    If the field is from an anonymous record type then get the details of the field including the index in the sorted array of fields

    + + +

    CompiledName: get_AnonRecordFieldDetails

    +
    + + x.DeclarationLocation + +
    + Signature: range
    +
    +     		+

    Get the declaration location of the field

    + + +

    CompiledName: get_DeclarationLocation

    +
    + + x.DeclaringEntity + +
    + Signature: FSharpEntity option
    +
    +     		+

    Get the declaring entity of this field, if any. Fields from anonymous types do not have a declaring entity

    + + +

    CompiledName: get_DeclaringEntity

    +
    + + x.FieldAttributes + +
    + Signature: IList<FSharpAttribute>
    +
    +     		+

    Get the attributes attached to generated field

    + + +

    CompiledName: get_FieldAttributes

    +
    + + x.FieldType + +
    + Signature: FSharpType
    +
    +     		+

    Get the type of the field, w.r.t. the generic parameters of the enclosing type constructor

    + + +

    CompiledName: get_FieldType

    +
    + + x.IsAnonRecordField + +
    + Signature: bool
    +
    +     		+

    Is this a field from an anonymous record type?

    + + +

    CompiledName: get_IsAnonRecordField

    +
    + + x.IsCompilerGenerated + +
    + Signature: bool
    +
    +     		+

    Indicates a compiler generated field, not visible to Intellisense or name resolution

    + + +

    CompiledName: get_IsCompilerGenerated

    +
    + + x.IsDefaultValue + +
    + Signature: bool
    +
    +     		+

    Indicates if the field declared is declared 'DefaultValue'

    + + +

    CompiledName: get_IsDefaultValue

    +
    + + x.IsLiteral + +
    + Signature: bool
    +
    +     		+

    Indicates if the field has a literal value

    + + +

    CompiledName: get_IsLiteral

    +
    + + x.IsMutable + +
    + Signature: bool
    +
    +     		+

    Indicates if the field is declared 'static'

    + + +

    CompiledName: get_IsMutable

    +
    + + x.IsNameGenerated + +
    + Signature: bool
    +
    +     		+

    Indicates if the field name was generated by compiler (e.g. ItemN names in union cases and DataN in exceptions). +This API returns true for source defined symbols only.

    + + +

    CompiledName: get_IsNameGenerated

    +
    + + x.IsStatic + +
    + Signature: bool
    +
    +     		+

    Indicates a static field

    + + +

    CompiledName: get_IsStatic

    +
    + + x.IsUnresolved + +
    + Signature: bool
    +
    +     		+

    Indicates if the record field is for a type in an unresolved assembly

    + + +

    CompiledName: get_IsUnresolved

    +
    + + x.IsVolatile + +
    + Signature: bool
    +
    +     		+

    Indicates if the field is declared volatile

    + + +

    CompiledName: get_IsVolatile

    +
    + + x.LiteralValue + +
    + Signature: obj option
    +
    +     		+

    Get the default initialization info, for static literals

    + + +

    CompiledName: get_LiteralValue

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    Get the name of the field

    + + +

    CompiledName: get_Name

    +
    + + x.PropertyAttributes + +
    + Signature: IList<FSharpAttribute>
    +
    +     		+

    Get the attributes attached to generated property

    + + +

    CompiledName: get_PropertyAttributes

    +
    + + x.XmlDoc + +
    + Signature: IList<string>
    +
    +     		+

    Get the in-memory XML documentation for the field, used when code is checked in-memory

    + + +

    CompiledName: get_XmlDoc

    +
    + + x.XmlDocSig + +
    + Signature: string
    +
    +     		+

    Get the XML documentation signature for .xml file lookup for the field, used for .xml file lookup for compiled code

    + + +

    CompiledName: get_XmlDocSig

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfileutilities.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfileutilities.html new file mode 100644 index 0000000000..6991b1a0d1 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfileutilities.html @@ -0,0 +1,118 @@ + + + + + FSharpFileUtilities - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpFileUtilities

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    A set of helpers for dealing with F# files.

    + +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + isScriptFile(arg1) + +
    + Signature: string -> bool
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html new file mode 100644 index 0000000000..34e33781ac --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclfailurereason.html @@ -0,0 +1,168 @@ + + + + + FSharpFindDeclFailureReason - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpFindDeclFailureReason

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Represents the reason why the GetDeclarationLocation operation failed.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + NoSourceCode + +
    + Signature:
    +
    +     		+

    Source code file is not available

    + + +
    + + ProvidedMember(string) + +
    + Signature: string
    +
    +     		+

    Trying to find declaration of ProvidedMember without TypeProviderDefinitionLocationAttribute

    + + +
    + + ProvidedType(string) + +
    + Signature: string
    +
    +     		+

    Trying to find declaration of ProvidedType without TypeProviderDefinitionLocationAttribute

    + + +
    + + Unknown(message) + +
    + Signature: string
    +
    +     		+

    Generic reason: no particular information about error apart from a message

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html new file mode 100644 index 0000000000..c9ffcc0eee --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpfinddeclresult.html @@ -0,0 +1,153 @@ + + + + + FSharpFindDeclResult - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpFindDeclResult

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Represents the result of the GetDeclarationLocation operation.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + DeclFound(range) + +
    + Signature: range
    +
    +     		+

    Indicates a declaration location was found

    + + +
    + + DeclNotFound(...) + +
    + Signature: FSharpFindDeclFailureReason
    +
    +     		+

    Indicates a declaration location was not found, with an additional reason

    + + +
    + + ExternalDecl(assembly,externalSym) + +
    + Signature: string * ExternalSymbol
    +
    +     		+

    Indicates an external declaration was found

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameter.html new file mode 100644 index 0000000000..026a998b20 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameter.html @@ -0,0 +1,236 @@ + + + + + FSharpGenericParameter - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpGenericParameter

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    A subtype of FSharpSymbol that represents a generic parameter for an FSharpSymbol

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Attributes + +
    + Signature: IList<FSharpAttribute>
    +
    +     		+

    Get the declared attributes of the type parameter.

    + + +

    CompiledName: get_Attributes

    +
    + + x.Constraints + +
    + Signature: IList<FSharpGenericParameterConstraint>
    +
    +     		+

    Get the declared or inferred constraints for the type parameter

    + + +

    CompiledName: get_Constraints

    +
    + + x.DeclarationLocation + +
    + Signature: range
    +
    +     		+

    Get the range of the generic parameter

    + + +

    CompiledName: get_DeclarationLocation

    +
    + + x.IsCompilerGenerated + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a compiler generated type parameter

    + + +

    CompiledName: get_IsCompilerGenerated

    +
    + + x.IsMeasure + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a measure variable

    + + +

    CompiledName: get_IsMeasure

    +
    + + x.IsSolveAtCompileTime + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a statically resolved type variable

    + + +

    CompiledName: get_IsSolveAtCompileTime

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    Get the name of the generic parameter

    + + +

    CompiledName: get_Name

    +
    + + x.XmlDoc + +
    + Signature: IList<string>
    +
    +     		+

    Get the in-memory XML documentation for the type parameter, used when code is checked in-memory

    + + +

    CompiledName: get_XmlDoc

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterconstraint.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterconstraint.html new file mode 100644 index 0000000000..0fe554c9a0 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterconstraint.html @@ -0,0 +1,414 @@ + + + + + FSharpGenericParameterConstraint - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpGenericParameterConstraint

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents a constraint on a generic type parameter

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.CoercesToTarget + +
    + Signature: FSharpType
    +
    +     		+

    Gets further information about a coerces-to constraint

    + + +

    CompiledName: get_CoercesToTarget

    +
    + + x.DefaultsToConstraintData + +
    + Signature: FSharpGenericParameterDefaultsToConstraint
    +
    +     		+

    Gets further information about a defaults-to constraint

    + + +

    CompiledName: get_DefaultsToConstraintData

    +
    + + x.DelegateConstraintData + +
    + Signature: FSharpGenericParameterDelegateConstraint
    +
    +     		+

    Gets further information about a delegate constraint

    + + +

    CompiledName: get_DelegateConstraintData

    +
    + + x.EnumConstraintTarget + +
    + Signature: FSharpType
    +
    +     		+

    Gets further information about an enumeration constraint

    + + +

    CompiledName: get_EnumConstraintTarget

    +
    + + x.IsCoercesToConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type is a subtype of the given type

    + + +

    CompiledName: get_IsCoercesToConstraint

    +
    + + x.IsComparisonConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type supports F# generic comparison

    + + +

    CompiledName: get_IsComparisonConstraint

    +
    + + x.IsDefaultsToConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a default value for an inference type variable should it be neither generalized nor solved

    + + +

    CompiledName: get_IsDefaultsToConstraint

    +
    + + x.IsDelegateConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type is a delegate from the given tuple of args to the given return type

    + + +

    CompiledName: get_IsDelegateConstraint

    +
    + + x.IsEnumConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type is an enum with the given underlying

    + + +

    CompiledName: get_IsEnumConstraint

    +
    + + x.IsEqualityConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type supports F# generic equality

    + + +

    CompiledName: get_IsEqualityConstraint

    +
    + + x.IsMemberConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type has a member with the given signature

    + + +

    CompiledName: get_IsMemberConstraint

    +
    + + x.IsNonNullableValueTypeConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type is a non-Nullable value type

    + + +

    CompiledName: get_IsNonNullableValueTypeConstraint

    +
    + + x.IsReferenceTypeConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type is a reference type

    + + +

    CompiledName: get_IsReferenceTypeConstraint

    +
    + + x.IsRequiresDefaultConstructorConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type has a parameterless constructor

    + + +

    CompiledName: get_IsRequiresDefaultConstructorConstraint

    +
    + + x.IsSimpleChoiceConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that is a type is a simple choice between one of the given ground types. Used by printf format strings.

    + + +

    CompiledName: get_IsSimpleChoiceConstraint

    +
    + + x.IsSupportsNullConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type has a 'null' value

    + + +

    CompiledName: get_IsSupportsNullConstraint

    +
    + + x.IsUnmanagedConstraint + +
    + Signature: bool
    +
    +     		+

    Indicates a constraint that a type is an unmanaged type

    + + +

    CompiledName: get_IsUnmanagedConstraint

    +
    + + x.MemberConstraintData + +
    + Signature: FSharpGenericParameterMemberConstraint
    +
    +     		+

    Gets further information about a member constraint

    + + +

    CompiledName: get_MemberConstraintData

    +
    + + x.SimpleChoices + +
    + Signature: IList<FSharpType>
    +
    +     		+

    Gets further information about a choice constraint

    + + +

    CompiledName: get_SimpleChoices

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdefaultstoconstraint.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdefaultstoconstraint.html new file mode 100644 index 0000000000..6b31579155 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdefaultstoconstraint.html @@ -0,0 +1,142 @@ + + + + + FSharpGenericParameterDefaultsToConstraint - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpGenericParameterDefaultsToConstraint

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents further information about a 'defaults to' constraint on a generic type parameter

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DefaultsToPriority + +
    + Signature: int
    +
    +     		+

    Get the priority off the 'defaults to' constraint

    + + +

    CompiledName: get_DefaultsToPriority

    +
    + + x.DefaultsToTarget + +
    + Signature: FSharpType
    +
    +     		+

    Get the default type associated with the 'defaults to' constraint

    + + +

    CompiledName: get_DefaultsToTarget

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdelegateconstraint.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdelegateconstraint.html new file mode 100644 index 0000000000..9d131815cf --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparameterdelegateconstraint.html @@ -0,0 +1,142 @@ + + + + + FSharpGenericParameterDelegateConstraint - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpGenericParameterDelegateConstraint

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents further information about a delegate constraint on a generic type parameter

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DelegateReturnType + +
    + Signature: FSharpType
    +
    +     		+

    Get the return type required by the constraint

    + + +

    CompiledName: get_DelegateReturnType

    +
    + + x.DelegateTupledArgumentType + +
    + Signature: FSharpType
    +
    +     		+

    Get the tupled argument type required by the constraint

    + + +

    CompiledName: get_DelegateTupledArgumentType

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparametermemberconstraint.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparametermemberconstraint.html new file mode 100644 index 0000000000..7d039ec4e8 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpgenericparametermemberconstraint.html @@ -0,0 +1,190 @@ + + + + + FSharpGenericParameterMemberConstraint - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpGenericParameterMemberConstraint

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents further information about a member constraint on a generic type parameter

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.MemberArgumentTypes + +
    + Signature: IList<FSharpType>
    +
    +     		+

    Get the argument types of the method required by the constraint

    + + +

    CompiledName: get_MemberArgumentTypes

    +
    + + x.MemberIsStatic + +
    + Signature: bool
    +
    +     		+

    Indicates if the the method required by the constraint must be static

    + + +

    CompiledName: get_MemberIsStatic

    +
    + + x.MemberName + +
    + Signature: string
    +
    +     		+

    Get the name of the method required by the constraint

    + + +

    CompiledName: get_MemberName

    +
    + + x.MemberReturnType + +
    + Signature: FSharpType
    +
    +     		+

    Get the return type of the method required by the constraint

    + + +

    CompiledName: get_MemberReturnType

    +
    + + x.MemberSources + +
    + Signature: IList<FSharpType>
    +
    +     		+

    Get the types that may be used to satisfy the constraint

    + + +

    CompiledName: get_MemberSources

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpglyph.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpglyph.html new file mode 100644 index 0000000000..d4313653f4 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpglyph.html @@ -0,0 +1,379 @@ + + + + + FSharpGlyph - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpGlyph

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Class + +
    + Signature:
    +
    +     		+ +
    + + Constant + +
    + Signature:
    +
    +     		+ +
    + + Delegate + +
    + Signature:
    +
    +     		+ +
    + + Enum + +
    + Signature:
    +
    +     		+ +
    + + EnumMember + +
    + Signature:
    +
    +     		+ +
    + + Error + +
    + Signature:
    +
    +     		+ +
    + + Event + +
    + Signature:
    +
    +     		+ +
    + + Exception + +
    + Signature:
    +
    +     		+ +
    + + ExtensionMethod + +
    + Signature:
    +
    +     		+ +
    + + Field + +
    + Signature:
    +
    +     		+ +
    + + Interface + +
    + Signature:
    +
    +     		+ +
    + + Method + +
    + Signature:
    +
    +     		+ +
    + + Module + +
    + Signature:
    +
    +     		+ +
    + + NameSpace + +
    + Signature:
    +
    +     		+ +
    + + OverridenMethod + +
    + Signature:
    +
    +     		+ +
    + + Property + +
    + Signature:
    +
    +     		+ +
    + + Struct + +
    + Signature:
    +
    +     		+ +
    + + Type + +
    + Signature:
    +
    +     		+ +
    + + Typedef + +
    + Signature:
    +
    +     		+ +
    + + Union + +
    + Signature:
    +
    +     		+ +
    + + Variable + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfilecontents.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfilecontents.html new file mode 100644 index 0000000000..0f9208d076 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfilecontents.html @@ -0,0 +1,188 @@ + + + + + FSharpImplementationFileContents - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpImplementationFileContents

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents the definitional contents of a single file or fragment in an assembly, as seen by the F# language

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Declarations + +
    + Signature: FSharpImplementationFileDeclaration list
    +
    +     		+

    Get the declarations that make up this implementation file

    + + +

    CompiledName: get_Declarations

    +
    + + x.FileName + +
    + Signature: string
    +
    +     		+

    Get the system path of the implementation file

    + + +

    CompiledName: get_FileName

    +
    + + x.HasExplicitEntryPoint + +
    + Signature: bool
    +
    +     		+

    Indicates if the implementation file has an explicit entry point

    + + +

    CompiledName: get_HasExplicitEntryPoint

    +
    + + x.IsScript + +
    + Signature: bool
    +
    +     		+

    Indicates if the implementation file is a script

    + + +

    CompiledName: get_IsScript

    +
    + + x.QualifiedName + +
    + Signature: string
    +
    +     		+

    The qualified name acts to fully-qualify module specifications and implementations

    + + +

    CompiledName: get_QualifiedName

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfiledeclaration.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfiledeclaration.html new file mode 100644 index 0000000000..02794c8085 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpimplementationfiledeclaration.html @@ -0,0 +1,148 @@ + + + + + FSharpImplementationFileDeclaration - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpImplementationFileDeclaration

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Represents a declaration in an implementation file, as seen by the F# language

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Entity(...) + +
    + Signature: FSharpEntity * FSharpImplementationFileDeclaration list
    +
    +     		+

    Represents the declaration of a type

    + + +
    + + InitAction(FSharpExpr) + +
    + Signature: FSharpExpr
    +
    +     		+

    Represents the declaration of a static initialization action

    + + +
    + + MemberOrFunctionOrValue(...) + +
    + Signature: FSharpMemberOrFunctionOrValue * FSharpMemberOrFunctionOrValue list list * FSharpExpr
    +
    +     		+

    Represents the declaration of a member, function or value, including the parameters and body of the member

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpinlineannotation.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpinlineannotation.html new file mode 100644 index 0000000000..5e14c01d12 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpinlineannotation.html @@ -0,0 +1,181 @@ + + + + + FSharpInlineAnnotation - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpInlineAnnotation

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + AggressiveInline + +
    + Signature:
    +
    +     		+

    Indicates the value is aggressively inlined by the .NET runtime

    + + +
    + + AlwaysInline + +
    + Signature:
    +
    +     		+

    Indicates the value is inlined but compiled code for the function still exists, e.g. to satisfy interfaces on objects, but that it is also always inlined

    + + +
    + + NeverInline + +
    + Signature:
    +
    +     		+

    Indicates the value is never inlined

    + + +
    + + OptionalInline + +
    + Signature:
    +
    +     		+

    Indicates the value is optionally inlined

    + + +
    + + PseudoValue + +
    + Signature:
    +
    +     		+

    Indicates the value is inlined and compiled code for the function does not exist

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharplinetokenizer.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharplinetokenizer.html new file mode 100644 index 0000000000..1ab2792c4e --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharplinetokenizer.html @@ -0,0 +1,162 @@ + + + + + FSharpLineTokenizer - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpLineTokenizer

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Object to tokenize a line of F# source code, starting with the given lexState. The lexState should be FSharpTokenizerLexState.Initial for +the first line of text. Returns an array of ranges of the text and two enumerations categorizing the +tokens and characters covered by that range, i.e. FSharpTokenColorKind and FSharpTokenCharKind. The enumerations +are somewhat adhoc but useful enough to give good colorization options to the user in an IDE.

    +

    A new lexState is also returned. An IDE-plugin should in general cache the lexState +values for each line of the edited code.

    + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.ScanToken(lexState) + +
    + Signature: lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
    +
    +     		+

    Scan one token from the line

    + + +
    +

    Static members

    + + + + + + + + + + + + + + +
    Static memberDescription
    + + FSharpLineTokenizer.ColorStateOfLexState(...) + +
    + Signature: FSharpTokenizerLexState -> FSharpTokenizerColorState
    +
    +     		+ +
    + + FSharpLineTokenizer.LexStateOfColorState(...) + +
    + Signature: FSharpTokenizerColorState -> FSharpTokenizerLexState
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmemberorfunctionorvalue.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmemberorfunctionorvalue.html new file mode 100644 index 0000000000..1bbc8a5c66 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmemberorfunctionorvalue.html @@ -0,0 +1,1045 @@ + + + + + FSharpMemberOrFunctionOrValue - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpMemberOrFunctionOrValue

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    A subtype of F# symbol that represents an F# method, property, event, function or value, including extension members.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Accessibility + +
    + Signature: FSharpAccessibility
    +
    +     		+

    Get the accessibility information for the member, function or value

    + + +

    CompiledName: get_Accessibility

    +
    + + x.ApparentEnclosingEntity + +
    + Signature: FSharpEntity
    +
    +     		+

    Get the logical enclosing entity, which for an extension member is type being extended

    + + +

    CompiledName: get_ApparentEnclosingEntity

    +
    + + x.Attributes + +
    + Signature: IList<FSharpAttribute>
    +
    +     		+

    Custom attributes attached to the value. These contain references to other values (i.e. constructors in types). Mutable to fixup
    +these value references after copying a collection of values.

    + + +

    CompiledName: get_Attributes

    +
    + + x.CompiledName + +
    + Signature: string
    +
    +     		+

    Get the member name in compiled code

    + + +

    CompiledName: get_CompiledName

    +
    + + x.CurriedParameterGroups + +
    + Signature: IList<IList<FSharpParameter>>
    +
    +     		+ +

    CompiledName: get_CurriedParameterGroups

    +
    + + x.DeclarationLocation + +
    + Signature: range
    +
    +     		+

    Get the declaration location of the member, function or value

    + + +

    CompiledName: get_DeclarationLocation

    +
    + + x.DeclaringEntity + +
    + Signature: FSharpEntity option
    +
    +     		+

    Get the enclosing entity for the definition

    + + +

    CompiledName: get_DeclaringEntity

    +
    + + x.DisplayName + +
    + Signature: string
    +
    +     		+

    Get the name as presented in F# error messages and documentation

    + + +

    CompiledName: get_DisplayName

    +
    + + x.EventAddMethod + +
    + Signature: FSharpMemberOrFunctionOrValue
    +
    +     		+

    Get an associated add method of an event

    + + +

    CompiledName: get_EventAddMethod

    +
    + + x.EventDelegateType + +
    + Signature: FSharpType
    +
    +     		+

    Get an associated delegate type of an event

    + + +

    CompiledName: get_EventDelegateType

    +
    + + x.EventForFSharpProperty + +
    + Signature: FSharpMemberOrFunctionOrValue option
    +
    +     		+

    Gets the event symbol implied by the use of a property, +for the case where the property is actually an F#-declared CLIEvent.

    +

    Uses of F#-declared events are considered to be properties as far as the language specification +and this API are concerned.

    + + +

    CompiledName: get_EventForFSharpProperty

    +
    + + x.EventIsStandard + +
    + Signature: bool
    +
    +     		+

    Indicate if an event can be considered to be a property for the F# type system of type IEvent or IDelegateEvent. +In this case ReturnParameter will have a type corresponding to the property type. For +non-standard events, ReturnParameter will have a type corresponding to the delegate type.

    + + +

    CompiledName: get_EventIsStandard

    +
    + + x.EventRemoveMethod + +
    + Signature: FSharpMemberOrFunctionOrValue
    +
    +     		+

    Get an associated remove method of an event

    + + +

    CompiledName: get_EventRemoveMethod

    +
    + + x.FormatLayout(context) + +
    + Signature: context:FSharpDisplayContext -> Layout
    +
    +     		+

    Format the type using the rules of the given display context

    + + +
    + + x.FullType + +
    + Signature: FSharpType
    +
    +     		+

    Get the full type of the member, function or value when used as a first class value

    + + +

    CompiledName: get_FullType

    +
    + + x.GenericParameters + +
    + Signature: IList<FSharpGenericParameter>
    +
    +     		+

    Get the typars of the member, function or value

    + + +

    CompiledName: get_GenericParameters

    +
    + + x.GetterMethod + +
    + Signature: FSharpMemberOrFunctionOrValue
    +
    +     		+

    Get an associated getter method of the property

    + + +

    CompiledName: get_GetterMethod

    +
    + + x.HasGetterMethod + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a property and there exists an associated getter method

    + + +

    CompiledName: get_HasGetterMethod

    +
    + + x.HasSetterMethod + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a property and there exists an associated setter method

    + + +

    CompiledName: get_HasSetterMethod

    +
    + + x.ImplementedAbstractSignatures + +
    + Signature: IList<FSharpAbstractSignature>
    +
    +     		+

    Gets the list of the abstract slot signatures implemented by the member

    + + +

    CompiledName: get_ImplementedAbstractSignatures

    +
    + + x.InlineAnnotation + +
    + Signature: FSharpInlineAnnotation
    +
    +     		+

    Get a result indicating if this is a must-inline value

    + + +

    CompiledName: get_InlineAnnotation

    +
    + + x.IsActivePattern + +
    + Signature: bool
    +
    +     		+

    Indicates if this value or member is an F# active pattern

    + + +

    CompiledName: get_IsActivePattern

    +
    + + x.IsBaseValue + +
    + Signature: bool
    +
    +     		+

    Indicates if this is "base" in "base.M(...)"

    + + +

    CompiledName: get_IsBaseValue

    +
    + + x.IsCompilerGenerated + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a compiler generated value

    + + +

    CompiledName: get_IsCompilerGenerated

    +
    + + x.IsConstructor + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a constructor.

    + + +

    CompiledName: get_IsConstructor

    +
    + + x.IsConstructorThisValue + +
    + Signature: bool
    +
    +     		+

    Indicates if this is the "x" in "type C() as x = ..."

    + + +

    CompiledName: get_IsConstructorThisValue

    +
    + + x.IsDispatchSlot + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an abstract member?

    + + +

    CompiledName: get_IsDispatchSlot

    +
    + + x.IsEvent + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an event member

    + + +

    CompiledName: get_IsEvent

    +
    + + x.IsEventAddMethod + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an add method for an event

    + + +

    CompiledName: get_IsEventAddMethod

    +
    + + x.IsEventRemoveMethod + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a remove method for an event

    + + +

    CompiledName: get_IsEventRemoveMethod

    +
    + + x.IsExplicitInterfaceImplementation + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an explicit implementation of an interface member

    + + +

    CompiledName: get_IsExplicitInterfaceImplementation

    +
    + + x.IsExtensionMember + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an extension member?

    + + +

    CompiledName: get_IsExtensionMember

    +
    + + x.IsGetterMethod + +
    + Signature: bool
    + + Attributes:
    +[<Obsolete("Renamed to IsPropertyGetterMethod, which returns 'true' only for method symbols, not for property symbols")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Renamed to IsPropertyGetterMethod, which returns 'true' only for method symbols, not for property symbols

    +
    +

    Indicates if this is a getter method for a property, or a use of a property in getter mode

    + + +

    CompiledName: get_IsGetterMethod

    +
    + + x.IsImplicitConstructor + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an implicit constructor?

    + + +

    CompiledName: get_IsImplicitConstructor

    +
    + + x.IsInstanceMember + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an instance member, when seen from F#?

    + + +

    CompiledName: get_IsInstanceMember

    +
    + + x.IsInstanceMemberInCompiledCode + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an instance member in compiled code.

    +

    Explanatory note: some members such as IsNone and IsSome on types with UseNullAsTrueValue appear +as instance members in F# code but are compiled as static members.

    + + +

    CompiledName: get_IsInstanceMemberInCompiledCode

    +
    + + x.IsMember + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a member, including extension members?

    + + +

    CompiledName: get_IsMember

    +
    + + x.IsMemberThisValue + +
    + Signature: bool
    +
    +     		+

    Indicates if this is the "x" in "member x.M = ..."

    + + +

    CompiledName: get_IsMemberThisValue

    +
    + + x.IsModuleValueOrMember + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a module or member value

    + + +

    CompiledName: get_IsModuleValueOrMember

    +
    + + x.IsMutable + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a mutable value

    + + +

    CompiledName: get_IsMutable

    +
    + + x.IsOverrideOrExplicitInterfaceImplementation(...) + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an 'override', 'default' or an explicit implementation of an interface member

    + + +

    CompiledName: get_IsOverrideOrExplicitInterfaceImplementation

    +
    + + x.IsOverrideOrExplicitMember + +
    + Signature: bool
    + + Attributes:
    +[<Obsolete("Renamed to IsOverrideOrExplicitInterfaceImplementation")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Renamed to IsOverrideOrExplicitInterfaceImplementation

    +
    + +

    CompiledName: get_IsOverrideOrExplicitMember

    +
    + + x.IsProperty + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a property member

    + + +

    CompiledName: get_IsProperty

    +
    + + x.IsPropertyGetterMethod + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a getter method for a property, or a use of a property in getter mode

    + + +

    CompiledName: get_IsPropertyGetterMethod

    +
    + + x.IsPropertySetterMethod + +
    + Signature: bool
    +
    +     		+

    Indicates if this is a setter method for a property, or a use of a property in setter mode

    + + +

    CompiledName: get_IsPropertySetterMethod

    +
    + + x.IsSetterMethod + +
    + Signature: bool
    + + Attributes:
    +[<Obsolete("Renamed to IsPropertySetterMethod, which returns 'true' only for method symbols, not for property symbols")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Renamed to IsPropertySetterMethod, which returns 'true' only for method symbols, not for property symbols

    +
    +

    Indicates if this is a setter method for a property, or a use of a property in setter mode

    + + +

    CompiledName: get_IsSetterMethod

    +
    + + x.IsTypeFunction + +
    + Signature: bool
    +
    +     		+

    Indicates if this is an F# type function

    + + +

    CompiledName: get_IsTypeFunction

    +
    + + x.IsUnresolved + +
    + Signature: bool
    +
    +     		+

    Indicates if the member, function or value is in an unresolved assembly

    + + +

    CompiledName: get_IsUnresolved

    +
    + + x.IsValCompiledAsMethod + +
    + Signature: bool
    +
    +     		+

    Indicated if this is a value compiled to a method

    + + +

    CompiledName: get_IsValCompiledAsMethod

    +
    + + x.IsValue + +
    + Signature: bool
    +
    +     		+

    Indicated if this is a value

    + + +

    CompiledName: get_IsValue

    +
    + + x.LiteralValue + +
    + Signature: obj option
    +
    +     		+

    Indicates if this is a [] value, and if so what value? (may be null)

    + + +

    CompiledName: get_LiteralValue

    +
    + + x.LogicalName + +
    + Signature: string
    +
    +     		+

    Get the logical name of the member

    + + +

    CompiledName: get_LogicalName

    +
    + + x.Overloads(arg1) + +
    + Signature: bool -> IList<FSharpMemberOrFunctionOrValue> option
    +
    +     		+

    Gets the overloads for the current method +matchParameterNumber indicates whether to filter the overloads to match the number of parameters in the current symbol

    + + +
    + + x.ReturnParameter + +
    + Signature: FSharpParameter
    +
    +     		+ +

    CompiledName: get_ReturnParameter

    +
    + + x.SetterMethod + +
    + Signature: FSharpMemberOrFunctionOrValue
    +
    +     		+

    Get an associated setter method of the property

    + + +

    CompiledName: get_SetterMethod

    +
    + + x.XmlDoc + +
    + Signature: IList<string>
    +
    +     		+

    Get the in-memory XML documentation for the value, used when code is checked in-memory

    + + +

    CompiledName: get_XmlDoc

    +
    + + x.XmlDocSig + +
    + Signature: string
    +
    +     		+

    XML documentation signature for the value, used for .xml file lookup for compiled code

    + + +

    CompiledName: get_XmlDocSig

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroup.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroup.html new file mode 100644 index 0000000000..f3c93f7fa3 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroup.html @@ -0,0 +1,140 @@ + + + + + FSharpMethodGroup - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpMethodGroup

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents a group of methods (or other items) returned by GetMethods.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.MethodName + +
    + Signature: string
    +
    +     		+

    The shared name of the methods (or other items) in the group

    + + +

    CompiledName: get_MethodName

    +
    + + x.Methods + +
    + Signature: FSharpMethodGroupItem []
    +
    +     		+

    The methods (or other items) in the group

    + + +

    CompiledName: get_Methods

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitem.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitem.html new file mode 100644 index 0000000000..34af14f01f --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitem.html @@ -0,0 +1,253 @@ + + + + + FSharpMethodGroupItem - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpMethodGroupItem

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents one method (or other item) in a method group. The item may represent either a method or +a single, non-overloaded item such as union case or a named function value.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Description + +
    + Signature: FSharpToolTipText
    +
    +     		+

    The formatted description text for the method (or other item)

    + + +

    CompiledName: get_Description

    +
    + + x.HasParamArrayArg + +
    + Signature: bool
    +
    +     		+

    Does the method support a params list arg?

    + + +

    CompiledName: get_HasParamArrayArg

    +
    + + x.HasParameters + +
    + Signature: bool
    +
    +     		+

    Does the method support an arguments list? This is always true except for static type instantiations like TP<42,"foo">.

    + + +

    CompiledName: get_HasParameters

    +
    + + x.Parameters + +
    + Signature: FSharpMethodGroupItemParameter []
    +
    +     		+

    The parameters of the method in the overload set

    + + +

    CompiledName: get_Parameters

    +
    + + x.ReturnTypeText + +
    + Signature: string
    +
    +     		+

    The formatted type text for the method (or other item)

    + + +

    CompiledName: get_ReturnTypeText

    +
    + + x.StaticParameters + +
    + Signature: FSharpMethodGroupItemParameter []
    +
    +     		+

    Does the type name or method support a static arguments list, like TP<42,"foo"> or conn.CreateCommand<42, "foo">(arg1, arg2)?

    + + +

    CompiledName: get_StaticParameters

    +
    + + x.StructuredDescription + +
    + Signature: FSharpStructuredToolTipText
    +
    +     		+

    The structured description representation for the method (or other item)

    + + +

    CompiledName: get_StructuredDescription

    +
    + + x.StructuredReturnTypeText + +
    + Signature: Layout
    +
    +     		+

    The The structured description representation for the method (or other item)

    + + +

    CompiledName: get_StructuredReturnTypeText

    +
    + + x.XmlDoc + +
    + Signature: FSharpXmlDoc
    +
    +     		+

    The documentation for the item

    + + +

    CompiledName: get_XmlDoc

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitemparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitemparameter.html new file mode 100644 index 0000000000..160440d0f1 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpmethodgroupitemparameter.html @@ -0,0 +1,190 @@ + + + + + FSharpMethodGroupItemParameter - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpMethodGroupItemParameter

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents one parameter for one method (or other item) in a group.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.CanonicalTypeTextForSorting + +
    + Signature: string
    +
    +     		+

    A key that can be used for sorting the parameters, used to help sort overloads.

    + + +

    CompiledName: get_CanonicalTypeTextForSorting

    +
    + + x.Display + +
    + Signature: string
    +
    +     		+

    The text to display for the parameter including its name, its type and visual indicators of other +information such as whether it is optional.

    + + +

    CompiledName: get_Display

    +
    + + x.IsOptional + +
    + Signature: bool
    +
    +     		+

    Is the parameter optional

    + + +

    CompiledName: get_IsOptional

    +
    + + x.ParameterName + +
    + Signature: string
    +
    +     		+

    The name of the parameter.

    + + +

    CompiledName: get_ParameterName

    +
    + + x.StructuredDisplay + +
    + Signature: Layout
    +
    +     		+

    The structured representation for the parameter including its name, its type and visual indicators of other +information such as whether it is optional.

    + + +

    CompiledName: get_StructuredDisplay

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigation.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigation.html new file mode 100644 index 0000000000..3acd06467f --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigation.html @@ -0,0 +1,116 @@ + + + + + FSharpNavigation - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpNavigation

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + getNavigation(arg1) + +
    + Signature: ParsedInput -> FSharpNavigationItems
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitem.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitem.html new file mode 100644 index 0000000000..6de3364df9 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitem.html @@ -0,0 +1,248 @@ + + + + + FSharpNavigationDeclarationItem - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpNavigationDeclarationItem

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents an item to be displayed in the navigation bar

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Access + +
    + Signature: SynAccess option
    +
    +     		+ +

    CompiledName: get_Access

    +
    + + x.BodyRange + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_BodyRange

    +
    + + x.EnclosingEntityKind + +
    + Signature: FSharpEnclosingEntityKind
    +
    +     		+ +

    CompiledName: get_EnclosingEntityKind

    +
    + + x.Glyph + +
    + Signature: FSharpGlyph
    +
    +     		+ +

    CompiledName: get_Glyph

    +
    + + x.IsAbstract + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsAbstract

    +
    + + x.IsSingleTopLevel + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsSingleTopLevel

    +
    + + x.Kind + +
    + Signature: FSharpNavigationDeclarationItemKind
    +
    +     		+ +

    CompiledName: get_Kind

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_Name

    +
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + + x.UniqueName + +
    + Signature: string
    +
    +     		+ +

    CompiledName: get_UniqueName

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitemkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitemkind.html new file mode 100644 index 0000000000..3596f05f98 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationdeclarationitemkind.html @@ -0,0 +1,220 @@ + + + + + FSharpNavigationDeclarationItemKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpNavigationDeclarationItemKind

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Indicates a kind of item to show in an F# navigation bar

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ExnDecl + +
    + Signature:
    +
    +     		+ +
    + + FieldDecl + +
    + Signature:
    +
    +     		+ +
    + + MethodDecl + +
    + Signature:
    +
    +     		+ +
    + + ModuleDecl + +
    + Signature:
    +
    +     		+ +
    + + ModuleFileDecl + +
    + Signature:
    +
    +     		+ +
    + + NamespaceDecl + +
    + Signature:
    +
    +     		+ +
    + + OtherDecl + +
    + Signature:
    +
    +     		+ +
    + + PropertyDecl + +
    + Signature:
    +
    +     		+ +
    + + TypeDecl + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationitems.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationitems.html new file mode 100644 index 0000000000..55e412d6f2 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationitems.html @@ -0,0 +1,124 @@ + + + + + FSharpNavigationItems - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpNavigationItems

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents result of 'GetNavigationItems' operation - this contains +all the members and currently selected indices. First level correspond to +types & modules and second level are methods etc.

    + +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Declarations + +
    + Signature: FSharpNavigationTopLevelDeclaration []
    +
    +     		+ +

    CompiledName: get_Declarations

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationtopleveldeclaration.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationtopleveldeclaration.html new file mode 100644 index 0000000000..d3e90ff109 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnavigationtopleveldeclaration.html @@ -0,0 +1,136 @@ + + + + + FSharpNavigationTopLevelDeclaration - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpNavigationTopLevelDeclaration

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents top-level declarations (that should be in the type drop-down) +with nested declarations (that can be shown in the member drop-down)

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Declaration + +
    + Signature: FSharpNavigationDeclarationItem
    +
    +     		+ +
    + + Nested + +
    + Signature: FSharpNavigationDeclarationItem []
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnoteworthyparaminfolocations.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnoteworthyparaminfolocations.html new file mode 100644 index 0000000000..1f77f0998e --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpnoteworthyparaminfolocations.html @@ -0,0 +1,243 @@ + + + + + FSharpNoteworthyParamInfoLocations - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpNoteworthyParamInfoLocations

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents the locations relevant to activating parameter info in an IDE

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.IsThereACloseParen + +
    + Signature: bool
    +
    +     		+

    Is false if either this is a call without parens "f x" or the parser recovered as in "f(x,y"

    + + +

    CompiledName: get_IsThereACloseParen

    +
    + + x.LongId + +
    + Signature: string list
    +
    +     		+

    The text of the long identifier prior to the open-parentheses

    + + +

    CompiledName: get_LongId

    +
    + + x.LongIdEndLocation + +
    + Signature: pos
    +
    +     		+

    The end location of long identifier prior to the open-parentheses

    + + +

    CompiledName: get_LongIdEndLocation

    +
    + + x.LongIdStartLocation + +
    + Signature: pos
    +
    +     		+

    The start location of long identifier prior to the open-parentheses

    + + +

    CompiledName: get_LongIdStartLocation

    +
    + + x.NamedParamNames + +
    + Signature: string option []
    +
    +     		+

    Either empty or a name if an actual named parameter; f(0,a=4,?b=None) would be [|None; Some "a"; Some "b"|]

    + + +

    CompiledName: get_NamedParamNames

    +
    + + x.OpenParenLocation + +
    + Signature: pos
    +
    +     		+

    The location of the open-parentheses

    + + +

    CompiledName: get_OpenParenLocation

    +
    + + x.TupleEndLocations + +
    + Signature: pos []
    +
    +     		+

    The locations of commas and close parenthesis (or, last char of last arg, if no final close parenthesis)

    + + +

    CompiledName: get_TupleEndLocations

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + FSharpNoteworthyParamInfoLocations.Find(...) + +
    + Signature: (pos * ParsedInput) -> FSharpNoteworthyParamInfoLocations option
    +
    +     		+

    Find the information about parameter info locations at a particular source location

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpobjectexproverride.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpobjectexproverride.html new file mode 100644 index 0000000000..5882454f7a --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpobjectexproverride.html @@ -0,0 +1,172 @@ + + + + + FSharpObjectExprOverride - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpObjectExprOverride

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents a checked method in an object expression, as seen by the F# language.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Body + +
    + Signature: FSharpExpr
    +
    +     		+

    The expression that forms the body of the method

    + + +

    CompiledName: get_Body

    +
    + + x.CurriedParameterGroups + +
    + Signature: FSharpMemberOrFunctionOrValue list list
    +
    +     		+

    The parameters of the method

    + + +

    CompiledName: get_CurriedParameterGroups

    +
    + + x.GenericParameters + +
    + Signature: FSharpGenericParameter list
    +
    +     		+

    The generic parameters of the method

    + + +

    CompiledName: get_GenericParameters

    +
    + + x.Signature + +
    + Signature: FSharpAbstractSignature
    +
    +     		+

    The signature of the implemented abstract slot

    + + +

    CompiledName: get_Signature

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpopendeclaration.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpopendeclaration.html new file mode 100644 index 0000000000..3382ad0450 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpopendeclaration.html @@ -0,0 +1,188 @@ + + + + + FSharpOpenDeclaration - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpOpenDeclaration

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents open declaration in F# code.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AppliedScope + +
    + Signature: range
    +
    +     		+

    Scope in which open declaration is visible.

    + + +

    CompiledName: get_AppliedScope

    +
    + + x.IsOwnNamespace + +
    + Signature: bool
    +
    +     		+

    If it's namespace Xxx.Yyy declaration.

    + + +

    CompiledName: get_IsOwnNamespace

    +
    + + x.LongId + +
    + Signature: Ident list
    +
    +     		+

    Idents.

    + + +

    CompiledName: get_LongId

    +
    + + x.Modules + +
    + Signature: FSharpEntity list
    +
    +     		+

    Modules or namespaces which is opened with this declaration.

    + + +

    CompiledName: get_Modules

    +
    + + x.Range + +
    + Signature: range option
    +
    +     		+

    Range of the open declaration.

    + + +

    CompiledName: get_Range

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparameter.html new file mode 100644 index 0000000000..38aa0269ed --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparameter.html @@ -0,0 +1,236 @@ + + + + + FSharpParameter - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpParameter

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    A subtype of FSharpSymbol that represents a parameter

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Attributes + +
    + Signature: IList<FSharpAttribute>
    +
    +     		+

    The declared attributes of the parameter

    + + +

    CompiledName: get_Attributes

    +
    + + x.DeclarationLocation + +
    + Signature: range
    +
    +     		+

    The declaration location of the parameter

    + + +

    CompiledName: get_DeclarationLocation

    +
    + + x.IsInArg + +
    + Signature: bool
    +
    +     		+

    Indicate this is an in argument

    + + +

    CompiledName: get_IsInArg

    +
    + + x.IsOptionalArg + +
    + Signature: bool
    +
    +     		+

    Indicate this is an optional argument

    + + +

    CompiledName: get_IsOptionalArg

    +
    + + x.IsOutArg + +
    + Signature: bool
    +
    +     		+

    Indicate this is an out argument

    + + +

    CompiledName: get_IsOutArg

    +
    + + x.IsParamArrayArg + +
    + Signature: bool
    +
    +     		+

    Indicate this is a param array argument

    + + +

    CompiledName: get_IsParamArrayArg

    +
    + + x.Name + +
    + Signature: string option
    +
    +     		+

    The optional name of the parameter

    + + +

    CompiledName: get_Name

    +
    + + x.Type + +
    + Signature: FSharpType
    +
    +     		+

    The declared or inferred type of the parameter

    + + +

    CompiledName: get_Type

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsefileresults.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsefileresults.html new file mode 100644 index 0000000000..e9b639ff09 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsefileresults.html @@ -0,0 +1,233 @@ + + + + + FSharpParseFileResults - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpParseFileResults

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents the results of parsing an F# file

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DependencyFiles + +
    + Signature: string []
    +
    +     		+

    When these files change then the build is invalid

    + + +

    CompiledName: get_DependencyFiles

    +
    + + x.Errors + +
    + Signature: FSharpErrorInfo []
    +
    +     		+

    Get the errors and warnings for the parse

    + + +

    CompiledName: get_Errors

    +
    + + x.FileName + +
    + Signature: string
    +
    +     		+

    Name of the file for which this information were created

    + + +

    CompiledName: get_FileName

    +
    + + x.FindNoteworthyParamInfoLocations(pos) + +
    + Signature: pos:pos -> FSharpNoteworthyParamInfoLocations option
    +
    +     		+

    Notable parse info for ParameterInfo at a given location

    + + +
    + + x.GetNavigationItems() + +
    + Signature: unit -> FSharpNavigationItems
    +
    +     		+

    Get declared items and the selected item at the specified location

    + + +
    + + x.ParseHadErrors + +
    + Signature: bool
    +
    +     		+

    Indicates if any errors occurred during the parse

    + + +

    CompiledName: get_ParseHadErrors

    +
    + + x.ParseTree + +
    + Signature: ParsedInput option
    +
    +     		+

    The syntax tree resulting from the parse

    + + +

    CompiledName: get_ParseTree

    +
    + + x.ValidateBreakpointLocation(pos) + +
    + Signature: pos:pos -> range option
    +
    +     		+

    Return the inner-most range associated with a possible breakpoint location

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html new file mode 100644 index 0000000000..8cd3ac0e94 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpparsingoptions.html @@ -0,0 +1,216 @@ + + + + + FSharpParsingOptions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpParsingOptions

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Options used to determine active --define conditionals and other options relevant to parsing files in a project

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + CompilingFsLib + +
    + Signature: bool
    +
    +     		+ +
    + + ConditionalCompilationDefines + +
    + Signature: string list
    +
    +     		+ +
    + + ErrorSeverityOptions + +
    + Signature: FSharpErrorSeverityOptions
    +
    +     		+ +
    + + IsExe + +
    + Signature: bool
    +
    +     		+ +
    + + IsInteractive + +
    + Signature: bool
    +
    +     		+ +
    + + LightSyntax + +
    + Signature: bool option
    +
    +     		+ +
    + + SourceFiles + +
    + Signature: string []
    +
    +     		+ +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + FSharpParsingOptions.Default + +
    + Signature: FSharpParsingOptions
    +
    +     		+ +

    CompiledName: get_Default

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html new file mode 100644 index 0000000000..78881d0f16 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectcontext.html @@ -0,0 +1,139 @@ + + + + + FSharpProjectContext - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpProjectContext

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents the checking context implied by the ProjectOptions

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AccessibilityRights + +
    + Signature: FSharpAccessibilityRights
    +
    +     		+

    Get the accessibility rights for this project context w.r.t. InternalsVisibleTo attributes granting access to other assemblies

    + + +

    CompiledName: get_AccessibilityRights

    +
    + + x.GetReferencedAssemblies() + +
    + Signature: unit -> FSharpAssembly list
    +
    +     		+

    Get the resolution and full contents of the assemblies referenced by the project options

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html new file mode 100644 index 0000000000..3f0072c0ac --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpprojectoptions.html @@ -0,0 +1,288 @@ + + + + + FSharpProjectOptions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpProjectOptions

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    A set of information describing a project or script build configuration.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + ExtraProjectInfo + +
    + Signature: obj option
    +
    +     		+

    Extra information passed back on event trigger

    + + +
    + + IsIncompleteTypeCheckEnvironment + +
    + Signature: bool
    +
    +     		+

    When true, the typechecking environment is known a priori to be incomplete, for +example when a .fs file is opened outside of a project. In this case, the number of error +messages reported is reduced.

    + + +
    + + LoadTime + +
    + Signature: DateTime
    +
    +     		+

    Timestamp of project/script load, used to differentiate between different instances of a project load. +This ensures that a complete reload of the project or script type checking +context occurs on project or script unload/reload.

    + + +
    + + OriginalLoadReferences + +
    + Signature: (range * string * string) list
    +
    +     		+

    Unused in this API and should be '[]' when used as user-specified input

    + + +
    + + OtherOptions + +
    + Signature: string []
    +
    +     		+

    Additional command line argument options for the project. These can include additional files and references.

    + + +
    + + ProjectFileName + +
    + Signature: string
    +
    +     		+ +
    + + ProjectId + +
    + Signature: string option
    +
    +     		+

    This is the unique identifier for the project, it is case sensitive. If it's None, will key off of ProjectFileName in our caching.

    + + +
    + + ReferencedProjects + +
    + Signature: (string * FSharpProjectOptions) []
    +
    +     		+

    The command line arguments for the other projects referenced by this project, indexed by the +exact text used in the "-r:" reference in FSharpProjectOptions.

    + + +
    + + SourceFiles + +
    + Signature: string []
    +
    +     		+

    The files in the project

    + + +
    + + Stamp + +
    + Signature: int64 option
    +
    +     		+

    An optional stamp to uniquely identify this set of options +If two sets of options both have stamps, then they are considered equal +if and only if the stamps are equal

    + + +
    + + UnresolvedReferences + +
    + Signature: UnresolvedReferencesSet option
    +
    +     		+

    Unused in this API and should be 'None' when used as user-specified input

    + + +
    + + UseScriptResolutionRules + +
    + Signature: bool
    +
    +     		+

    When true, use the reference resolution rules for scripts rather than the rules for compiler.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsourcetokenizer.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsourcetokenizer.html new file mode 100644 index 0000000000..d0b57fe183 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsourcetokenizer.html @@ -0,0 +1,156 @@ + + + + + FSharpSourceTokenizer - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpSourceTokenizer

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Tokenizer for a source file. Holds some expensive-to-compute resources at the scope of the file.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new(conditionalDefines, fileName) + +
    + Signature: (conditionalDefines:string list * fileName:string option) -> FSharpSourceTokenizer
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.CreateBufferTokenizer(bufferFiller) + +
    + Signature: (bufferFiller:(char [] * int * int -> int)) -> FSharpLineTokenizer
    +
    +     		+ +
    + + x.CreateLineTokenizer(lineText) + +
    + Signature: lineText:string -> FSharpLineTokenizer
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstaticparameter.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstaticparameter.html new file mode 100644 index 0000000000..c16028262a --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstaticparameter.html @@ -0,0 +1,210 @@ + + + + + FSharpStaticParameter - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpStaticParameter

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    A subtype of FSharpSymbol that represents a static parameter to an F# type provider

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DeclarationLocation + +
    + Signature: range
    +
    +     		+

    Get the declaration location of the static parameter

    + + +

    CompiledName: get_DeclarationLocation

    +
    + + x.DefaultValue + +
    + Signature: obj
    +
    +     		+

    Get the default value for the static parameter

    + + +

    CompiledName: get_DefaultValue

    +
    + + x.HasDefaultValue + +
    + Signature: bool
    + + Attributes:
    +[<Obsolete("This member is no longer used, use IsOptional instead")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    This member is no longer used, use IsOptional instead

    +
    + +

    CompiledName: get_HasDefaultValue

    +
    + + x.IsOptional + +
    + Signature: bool
    +
    +     		+

    Indicates if the static parameter is optional

    + + +

    CompiledName: get_IsOptional

    +
    + + x.Kind + +
    + Signature: FSharpType
    +
    +     		+

    Get the kind of the static parameter

    + + +

    CompiledName: get_Kind

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    Get the name of the static parameter

    + + +

    CompiledName: get_Name

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltipelement.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltipelement.html new file mode 100644 index 0000000000..dcf5c1b004 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltipelement.html @@ -0,0 +1,95 @@ + + + + + FSharpStructuredToolTipElement - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpStructuredToolTipElement

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    A single data tip display element with where text is expressed as

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltiptext.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltiptext.html new file mode 100644 index 0000000000..73d9f38044 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpstructuredtooltiptext.html @@ -0,0 +1,93 @@ + + + + + FSharpStructuredToolTipText - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpStructuredToolTipText

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymbol.html new file mode 100644 index 0000000000..513a505a86 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymbol.html @@ -0,0 +1,293 @@ + + + + + FSharpSymbol - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpSymbol

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    Represents a symbol in checked F# source code or a compiled .NET component.

    +

    The subtype of the symbol may reveal further information and can be one of FSharpEntity, FSharpUnionCase +FSharpField, FSharpGenericParameter, FSharpStaticParameter, FSharpMemberOrFunctionOrValue, FSharpParameter, +or FSharpActivePatternCase.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Assembly + +
    + Signature: FSharpAssembly
    +
    +     		+

    Get the assembly declaring this symbol

    + + +

    CompiledName: get_Assembly

    +
    + + x.DeclarationLocation + +
    + Signature: range option
    +
    +     		+

    Get the declaration location for the symbol

    + + +

    CompiledName: get_DeclarationLocation

    +
    + + x.DisplayName + +
    + Signature: string
    +
    +     		+

    Gets the short display name for the symbol

    + + +

    CompiledName: get_DisplayName

    +
    + + x.FullName + +
    + Signature: string
    +
    +     		+

    Get a textual representation of the full name of the symbol. The text returned for some symbols +may not be a valid identifier path in F# code, but rather a human-readable representation of the symbol.

    + + +

    CompiledName: get_FullName

    +
    + + x.GetEffectivelySameAsHash() + +
    + Signature: unit -> int
    +
    +     		+

    A hash compatible with the IsEffectivelySameAs relation

    + + +
    + + x.ImplementationLocation + +
    + Signature: range option
    +
    +     		+

    Get the implementation location for the symbol if it was declared in a signature that has an implementation

    + + +

    CompiledName: get_ImplementationLocation

    +
    + + x.IsAccessible(arg1) + +
    + Signature: FSharpAccessibilityRights -> bool
    +
    +     		+

    Computes if the symbol is accessible for the given accessibility rights

    + + +
    + + x.IsEffectivelySameAs(other) + +
    + Signature: other:FSharpSymbol -> bool
    +
    +     		+

    Return true if two symbols are effectively the same when referred to in F# source code text.
    +This sees through signatures (a symbol in a signature will be considered effectively the same as +the matching symbol in an implementation). In addition, other equivalences are applied +when the same F# source text implies the same declaration name - for example, constructors +are considered to be effectively the same symbol as the corresponding type definition.

    +

    This is the relation used by GetUsesOfSymbol and GetUsesOfSymbolInFile.

    + + +
    + + x.IsExplicitlySuppressed + +
    + Signature: bool
    +
    +     		+ +

    CompiledName: get_IsExplicitlySuppressed

    +
    + + x.SignatureLocation + +
    + Signature: range option
    +
    +     		+

    Get the signature location for the symbol if it was declared in an implementation

    + + +

    CompiledName: get_SignatureLocation

    +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + FSharpSymbol.GetAccessibility(arg1) + +
    + Signature: FSharpSymbol -> FSharpAccessibility option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymboluse.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymboluse.html new file mode 100644 index 0000000000..478034d8bf --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpsymboluse.html @@ -0,0 +1,301 @@ + + + + + FSharpSymbolUse - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpSymbolUse

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Sealed>]
    + +     +

    +
    +

    Represents the use of an F# symbol from F# source code

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.DisplayContext + +
    + Signature: FSharpDisplayContext
    +
    +     		+

    The display context active at the point where the symbol is used. Can be passed to FSharpType.Format +and other methods to format items in a way that is suitable for a specific source code location.

    + + +

    CompiledName: get_DisplayContext

    +
    + + x.FileName + +
    + Signature: string
    +
    +     		+

    The file name the reference occurs in

    + + +

    CompiledName: get_FileName

    +
    + + x.IsFromAttribute + +
    + Signature: bool
    +
    +     		+

    Indicates if the reference is in an attribute

    + + +

    CompiledName: get_IsFromAttribute

    +
    + + x.IsFromComputationExpression + +
    + Signature: bool
    +
    +     		+

    Indicates if the reference is either a builder or a custom operation in a computation expression

    + + +

    CompiledName: get_IsFromComputationExpression

    +
    + + x.IsFromDefinition + +
    + Signature: bool
    +
    +     		+

    Indicates if the reference is a definition for the symbol, either in a signature or implementation

    + + +

    CompiledName: get_IsFromDefinition

    +
    + + x.IsFromDispatchSlotImplementation + +
    + Signature: bool
    +
    +     		+

    Indicates if the reference is via the member being implemented in a class or object expression

    + + +

    CompiledName: get_IsFromDispatchSlotImplementation

    +
    + + x.IsFromOpenStatement + +
    + Signature: bool
    +
    +     		+

    Indicates if the reference is in open statement

    + + +

    CompiledName: get_IsFromOpenStatement

    +
    + + x.IsFromPattern + +
    + Signature: bool
    +
    +     		+

    Indicates if the reference is in a pattern

    + + +

    CompiledName: get_IsFromPattern

    +
    + + x.IsFromType + +
    + Signature: bool
    +
    +     		+

    Indicates if the reference is in a syntactic type

    + + +

    CompiledName: get_IsFromType

    +
    + + x.IsPrivateToFile + +
    + Signature: bool
    +
    +     		+

    Indicates if the FSharpSymbolUse is declared as private

    + + +

    CompiledName: get_IsPrivateToFile

    +
    + + x.RangeAlternate + +
    + Signature: range
    +
    +     		+

    The range of text representing the reference to the symbol

    + + +

    CompiledName: get_RangeAlternate

    +
    + + x.Symbol + +
    + Signature: FSharpSymbol
    +
    +     		+

    The symbol referenced

    + + +

    CompiledName: get_Symbol

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencharkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencharkind.html new file mode 100644 index 0000000000..fdddad9946 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencharkind.html @@ -0,0 +1,257 @@ + + + + + FSharpTokenCharKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpTokenCharKind

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Gives an indication of the class to assign to the characters of the token an IDE

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Comment + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + Default + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + Delimiter + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + Identifier + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + Keyword + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + LineComment + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + Literal + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + Operator + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + String + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + Text + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + + WhiteSpace + +
    + Signature: FSharpTokenCharKind
    + Modifiers: static
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencolorkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencolorkind.html new file mode 100644 index 0000000000..0733230bcd --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokencolorkind.html @@ -0,0 +1,271 @@ + + + + + FSharpTokenColorKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpTokenColorKind

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Gives an indication of the color class to assign to the token an IDE

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Comment + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + Default + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + Identifier + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + InactiveCode + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + Keyword + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + Number + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + Operator + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + PreprocessorKeyword + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + Punctuation + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + String + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + Text + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + + UpperIdentifier + +
    + Signature: FSharpTokenColorKind
    + Modifiers: static
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokeninfo.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokeninfo.html new file mode 100644 index 0000000000..096ebe0b5c --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokeninfo.html @@ -0,0 +1,221 @@ + + + + + FSharpTokenInfo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpTokenInfo

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Information about a particular token from the tokenizer

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + CharClass + +
    + Signature: FSharpTokenCharKind
    +
    +     		+

    Gives an indication of the class to assign to the token an IDE

    + + +
    + + ColorClass + +
    + Signature: FSharpTokenColorKind
    +
    +     		+ +
    + + FSharpTokenTriggerClass + +
    + Signature: FSharpTokenTriggerClass
    +
    +     		+

    Actions taken when the token is typed

    + + +
    + + FullMatchedLength + +
    + Signature: int
    +
    +     		+

    The full length consumed by this match, including delayed tokens (which can be ignored in naive lexers)

    + + +
    + + LeftColumn + +
    + Signature: int
    +
    +     		+

    Left column of the token.

    + + +
    + + RightColumn + +
    + Signature: int
    +
    +     		+

    Right column of the token.

    + + +
    + + Tag + +
    + Signature: int
    +
    +     		+

    The tag is an integer identifier for the token

    + + +
    + + TokenName + +
    + Signature: string
    +
    +     		+

    Provides additional information about the token

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizercolorstate.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizercolorstate.html new file mode 100644 index 0000000000..cb867f3053 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizercolorstate.html @@ -0,0 +1,299 @@ + + + + + FSharpTokenizerColorState - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpTokenizerColorState

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Represents stable information for the state of the lexing engine at the end of a line

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + CamlOnly + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + Comment + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + EndLineThenSkip + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + EndLineThenToken + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + IfDefSkip + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + InitialState + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + SingleLineComment + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + String + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + StringInComment + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + Token + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + TripleQuoteString + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + TripleQuoteStringInComment + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + VerbatimString + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + + VerbatimStringInComment + +
    + Signature: FSharpTokenizerColorState
    + Modifiers: static
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizerlexstate.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizerlexstate.html new file mode 100644 index 0000000000..412eaa87ce --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokenizerlexstate.html @@ -0,0 +1,179 @@ + + + + + FSharpTokenizerLexState - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpTokenizerLexState

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Struct>]
    +[<CustomEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Represents encoded information for the end-of-line continuation of lexing

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + OtherBits + +
    + Signature: int64
    +
    +     		+ +
    + + PosBits + +
    + Signature: int64
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + +
    Instance memberDescription
    + + x.Equals(arg1) + +
    + Signature: FSharpTokenizerLexState -> bool
    +
    +     		+ +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + FSharpTokenizerLexState.Initial + +
    + Signature: FSharpTokenizerLexState
    +
    +     		+ +

    CompiledName: get_Initial

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentag.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentag.html new file mode 100644 index 0000000000..aac08452e1 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentag.html @@ -0,0 +1,1005 @@ + + + + + FSharpTokenTag - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpTokenTag

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Some of the values in the field FSharpTokenInfo.Tag

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + AMP_AMP + +
    + Signature: int
    +
    +     		+

    Indicates the token is a @@

    + + +
    + + BAR + +
    + Signature: int
    +
    +     		+

    Indicates the token is a _

    + + +
    + + BAR_BAR + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ||

    + + +
    + + BAR_RBRACK + +
    + Signature: int
    +
    +     		+

    Indicates the token is a |]

    + + +
    + + BEGIN + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword begin

    + + +
    + + CLASS + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword class

    + + +
    + + COLON + +
    + Signature: int
    +
    +     		+

    Indicates the token is a :

    + + +
    + + COLON_COLON + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ::

    + + +
    + + COLON_EQUALS + +
    + Signature: int
    +
    +     		+

    Indicates the token is a :=

    + + +
    + + COLON_GREATER + +
    + Signature: int
    +
    +     		+

    Indicates the token is a :>

    + + +
    + + COLON_QMARK + +
    + Signature: int
    +
    +     		+

    Indicates the token is a :?

    + + +
    + + COLON_QMARK_GREATER + +
    + Signature: int
    +
    +     		+

    Indicates the token is a :?>

    + + +
    + + COMMA + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ,

    + + +
    + + COMMENT + +
    + Signature: int
    +
    +     		+

    Indicates the token is a comment

    + + +
    + + DO + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword do

    + + +
    + + DOT + +
    + Signature: int
    +
    +     		+

    Indicates the token is a .

    + + +
    + + DOT_DOT + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ..

    + + +
    + + DOT_DOT_HAT + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ..

    + + +
    + + ELSE + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword else

    + + +
    + + EQUALS + +
    + Signature: int
    +
    +     		+

    Indicates the token is a =

    + + +
    + + FUNCTION + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword function

    + + +
    + + GREATER + +
    + Signature: int
    +
    +     		+

    Indicates the token is a >

    + + +
    + + GREATER_RBRACK + +
    + Signature: int
    +
    +     		+

    Indicates the token is a >]

    + + +
    + + IDENT + +
    + Signature: int
    +
    +     		+

    Indicates the token is an identifier (synonym for FSharpTokenTag.Identifier)

    + + +
    + + Identifier + +
    + Signature: int
    +
    +     		+

    Indicates the token is an identifier

    + + +
    + + INFIX_AT_HAT_OP + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ^

    + + +
    + + INFIX_BAR_OP + +
    + Signature: int
    +
    +     		+

    Indicates the token is a |

    + + +
    + + INFIX_COMPARE_OP + +
    + Signature: int
    +
    +     		+

    Indicates the token is a |

    + + +
    + + INFIX_STAR_DIV_MOD_OP + +
    + Signature: int
    +
    +     		+

    Indicates the token is a %

    + + +
    + + INT32_DOT_DOT + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ..^

    + + +
    + + LARROW + +
    + Signature: int
    +
    +     		+

    Indicates the token is a <-

    + + +
    + + LBRACE + +
    + Signature: int
    +
    +     		+

    Indicates the token is a {

    + + +
    + + LBRACK + +
    + Signature: int
    +
    +     		+

    Indicates the token is a [

    + + +
    + + LBRACK_BAR + +
    + Signature: int
    +
    +     		+

    Indicates the token is a [|

    + + +
    + + LBRACK_LESS + +
    + Signature: int
    +
    +     		+

    Indicates the token is a [<

    + + +
    + + LESS + +
    + Signature: int
    +
    +     		+

    Indicates the token is a <

    + + +
    + + LINE_COMMENT + +
    + Signature: int
    +
    +     		+

    Indicates the token is a line comment

    + + +
    + + LPAREN + +
    + Signature: int
    +
    +     		+

    Indicates the token is a (

    + + +
    + + MINUS + +
    + Signature: int
    +
    +     		+

    Indicates the token is a -

    + + +
    + + NEW + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword new

    + + +
    + + OWITH + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword with in #light

    + + +
    + + PERCENT_OP + +
    + Signature: int
    +
    +     		+

    Indicates the token is a %

    + + +
    + + PLUS_MINUS_OP + +
    + Signature: int
    +
    +     		+

    Indicates the token is a + or -

    + + +
    + + PREFIX_OP + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ~

    + + +
    + + QMARK + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ?

    + + +
    + + QUOTE + +
    + Signature: int
    +
    +     		+

    Indicates the token is a "

    + + +
    + + RARROW + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ->

    + + +
    + + RBRACE + +
    + Signature: int
    +
    +     		+

    Indicates the token is a }

    + + +
    + + RBRACK + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ]

    + + +
    + + RPAREN + +
    + Signature: int
    +
    +     		+

    Indicates the token is a )

    + + +
    + + SEMICOLON + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ;

    + + +
    + + STAR + +
    + Signature: int
    +
    +     		+

    Indicates the token is a *

    + + +
    + + String + +
    + Signature: int
    +
    +     		+

    Indicates the token is a string

    + + +
    + + STRING + +
    + Signature: int
    +
    +     		+

    Indicates the token is an string (synonym for FSharpTokenTag.String)

    + + +
    + + STRUCT + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword struct

    + + +
    + + THEN + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword then

    + + +
    + + TRY + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword try

    + + +
    + + UNDERSCORE + +
    + Signature: int
    +
    +     		+

    Indicates the token is a ..

    + + +
    + + WHITESPACE + +
    + Signature: int
    +
    +     		+

    Indicates the token is a whitespace

    + + +
    + + WITH + +
    + Signature: int
    +
    +     		+

    Indicates the token is keyword with

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentriggerclass.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentriggerclass.html new file mode 100644 index 0000000000..cb6d0eefa5 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptokentriggerclass.html @@ -0,0 +1,215 @@ + + + + + FSharpTokenTriggerClass - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpTokenTriggerClass

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Gives an indication of what should happen when the token is typed in an IDE

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + ChoiceSelect + +
    + Signature: FSharpTokenTriggerClass
    + Modifiers: static
    +
    +     		+ +
    + + MatchBraces + +
    + Signature: FSharpTokenTriggerClass
    + Modifiers: static
    +
    +     		+ +
    + + MemberSelect + +
    + Signature: FSharpTokenTriggerClass
    + Modifiers: static
    +
    +     		+ +
    + + MethodTip + +
    + Signature: FSharpTokenTriggerClass
    + Modifiers: static
    +
    +     		+ +
    + + None + +
    + Signature: FSharpTokenTriggerClass
    + Modifiers: static
    +
    +     		+ +
    + + ParamEnd + +
    + Signature: FSharpTokenTriggerClass
    + Modifiers: static
    +
    +     		+ +
    + + ParamNext + +
    + Signature: FSharpTokenTriggerClass
    + Modifiers: static
    +
    +     		+ +
    + + ParamStart + +
    + Signature: FSharpTokenTriggerClass
    + Modifiers: static
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement-1.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement-1.html new file mode 100644 index 0000000000..3977c40b7c --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement-1.html @@ -0,0 +1,172 @@ + + + + + FSharpToolTipElement<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpToolTipElement<'T>

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    A single tool tip display element

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + CompositionError(string) + +
    + Signature: string
    +
    +     		+

    An error occurred formatting this element

    + + +
    + + Group(FSharpToolTipElementData<'T> list) + +
    + Signature: FSharpToolTipElementData<'T> list
    +
    +     		+

    A single type, method, etc with comment. May represent a method overload group.

    + + +
    + + None + +
    + Signature:
    +
    +     		+ +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + FSharpToolTipElement.Single(...) + +
    + Signature: ('T * FSharpXmlDoc * typeMapping:'T list option * paramName:string option * remarks:'T option) -> FSharpToolTipElement<'T>
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement.html new file mode 100644 index 0000000000..ac256c4b01 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelement.html @@ -0,0 +1,95 @@ + + + + + FSharpToolTipElement - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpToolTipElement

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    A single data tip display element with where text is expressed as string

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelementdata-1.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelementdata-1.html new file mode 100644 index 0000000000..ef3e26006e --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltipelementdata-1.html @@ -0,0 +1,179 @@ + + + + + FSharpToolTipElementData<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpToolTipElementData<'T>

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    A single data tip display element

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + MainDescription + +
    + Signature: 'T
    +
    +     		+ +
    + + ParamName + +
    + Signature: string option
    +
    +     		+

    Parameter name

    + + +
    + + Remarks + +
    + Signature: 'T option
    +
    +     		+

    Extra text, goes at the end

    + + +
    + + TypeMapping + +
    + Signature: 'T list
    +
    +     		+

    typar instantiation text, to go after xml

    + + +
    + + XmlDoc + +
    + Signature: FSharpXmlDoc
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext-1.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext-1.html new file mode 100644 index 0000000000..c2edc8f6f4 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext-1.html @@ -0,0 +1,118 @@ + + + + + FSharpToolTipText<'T> - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpToolTipText<'T>

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Information for building a tool tip box.

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + FSharpToolTipText(...) + +
    + Signature: FSharpToolTipElement<'T> list
    +
    +     		+

    A list of data tip elements to display.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext.html new file mode 100644 index 0000000000..1a1c738e93 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptooltiptext.html @@ -0,0 +1,93 @@ + + + + + FSharpToolTipText - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpToolTipText

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharptype.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptype.html new file mode 100644 index 0000000000..5722d98499 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharptype.html @@ -0,0 +1,541 @@ + + + + + FSharpType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpType

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.AbbreviatedType + +
    + Signature: FSharpType
    +
    +     		+

    Get the type for which this is an abbreviation

    + + +

    CompiledName: get_AbbreviatedType

    +
    + + x.AllInterfaces + +
    + Signature: IList<FSharpType>
    +
    +     		+

    Get all the interface implementations, by walking the type hierarchy, taking into account the instantiation of this type +if it is an instantiation of a generic type.

    + + +

    CompiledName: get_AllInterfaces

    +
    + + x.AnonRecordTypeDetails + +
    + Signature: FSharpAnonRecordTypeDetails
    +
    +     		+

    Get the details of the anonymous record type.

    + + +

    CompiledName: get_AnonRecordTypeDetails

    +
    + + x.BaseType + +
    + Signature: FSharpType option
    +
    +     		+

    Get the base type, if any, taking into account the instantiation of this type +if it is an instantiation of a generic type.

    + + +

    CompiledName: get_BaseType

    +
    + + x.Format(context) + +
    + Signature: context:FSharpDisplayContext -> string
    +
    +     		+

    Format the type using the rules of the given display context

    + + +
    + + x.FormatLayout(context) + +
    + Signature: context:FSharpDisplayContext -> Layout
    +
    +     		+

    Format the type using the rules of the given display context

    + + +
    + + x.GenericArguments + +
    + Signature: IList<FSharpType>
    +
    +     		+

    Get the generic arguments for a tuple type, a function type or a type constructed using a named entity

    + + +

    CompiledName: get_GenericArguments

    +
    + + x.GenericParameter + +
    + Signature: FSharpGenericParameter
    +
    +     		+

    Get the generic parameter data for a generic parameter type

    + + +

    CompiledName: get_GenericParameter

    +
    + + x.HasTypeDefinition + +
    + Signature: bool
    +
    +     		+

    Indicates if the type is constructed using a named entity, including array and byref types

    + + +

    CompiledName: get_HasTypeDefinition

    +
    + + x.Instantiate(arg1) + +
    + Signature: ((FSharpGenericParameter * FSharpType) list) -> FSharpType
    +
    +     		+

    Instantiate generic type parameters in a type

    + + +
    + + x.IsAbbreviation + +
    + Signature: bool
    +
    +     		+

    Indicates this is an abbreviation for another type

    + + +

    CompiledName: get_IsAbbreviation

    +
    + + x.IsAnonRecordType + +
    + Signature: bool
    +
    +     		+

    Indicates if the type is an anonymous record type. The GenericArguments property returns the type instantiation of the anonymous record type

    + + +

    CompiledName: get_IsAnonRecordType

    +
    + + x.IsFunctionType + +
    + Signature: bool
    +
    +     		+

    Indicates if the type is a function type. The GenericArguments property returns the domain and range of the function type.

    + + +

    CompiledName: get_IsFunctionType

    +
    + + x.IsGenericParameter + +
    + Signature: bool
    +
    +     		+

    Indicates if the type is a variable type, whether declared, generalized or an inference type parameter

    + + +

    CompiledName: get_IsGenericParameter

    +
    + + x.IsNamedType + +
    + Signature: bool
    + + Attributes:
    +[<Obsolete("Renamed to HasTypeDefinition")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Renamed to HasTypeDefinition

    +
    + +

    CompiledName: get_IsNamedType

    +
    + + x.IsStructTupleType + +
    + Signature: bool
    +
    +     		+

    Indicates if the type is a struct tuple type. The GenericArguments property returns the elements of the tuple type.

    + + +

    CompiledName: get_IsStructTupleType

    +
    + + x.IsTupleType + +
    + Signature: bool
    +
    +     		+

    Indicates if the type is a tuple type (reference or struct). The GenericArguments property returns the elements of the tuple type.

    + + +

    CompiledName: get_IsTupleType

    +
    + + x.IsUnresolved + +
    + Signature: bool
    +
    +     		+

    Indicates this is a named type in an unresolved assembly

    + + +

    CompiledName: get_IsUnresolved

    +
    + + x.NamedEntity + +
    + Signature: FSharpEntity
    + + Attributes:
    +[<Obsolete("Renamed to TypeDefinition")>]
    +     +
    +     		+
    + WARNING: This API is obsolete +

    Renamed to TypeDefinition

    +
    + +

    CompiledName: get_NamedEntity

    +
    + + x.TypeDefinition + +
    + Signature: FSharpEntity
    +
    +     		+

    Get the type definition for a type

    + + +

    CompiledName: get_TypeDefinition

    +
    +

    Static members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Static memberDescription
    + + FSharpType.Prettify(...) + +
    + Signature: (parameters:IList<IList<FSharpParameter>> * returnParameter:FSharpParameter) -> IList<IList<FSharpParameter>> * FSharpParameter
    +
    +     		+

    Adjust the types in a group of curried parameters and return type by removing any occurrences of type inference variables, replacing them +systematically with lower-case type inference variables such as 'a.

    + + +
    + + FSharpType.Prettify(parameters) + +
    + Signature: parameters:IList<IList<FSharpParameter>> -> IList<IList<FSharpParameter>>
    +
    +     		+

    Adjust the types in a group of curried parameters by removing any occurrences of type inference variables, replacing them +systematically with lower-case type inference variables such as 'a.

    + + +
    + + FSharpType.Prettify(parameters) + +
    + Signature: parameters:IList<FSharpParameter> -> IList<FSharpParameter>
    +
    +     		+

    Adjust the types in a group of parameters by removing any occurrences of type inference variables, replacing them +systematically with lower-case type inference variables such as 'a.

    + + +
    + + FSharpType.Prettify(parameter) + +
    + Signature: parameter:FSharpParameter -> FSharpParameter
    +
    +     		+

    Adjust the type in a single parameter by removing any occurrences of type inference variables, replacing them +systematically with lower-case type inference variables such as 'a.

    + + +
    + + FSharpType.Prettify(types) + +
    + Signature: types:IList<FSharpType> -> IList<FSharpType>
    +
    +     		+

    Adjust a group of types by removing any occurrences of type inference variables, replacing them +systematically with lower-case type inference variables such as 'a.

    + + +
    + + FSharpType.Prettify(ty) + +
    + Signature: ty:FSharpType -> FSharpType
    +
    +     		+

    Adjust the type by removing any occurrences of type inference variables, replacing them +systematically with lower-case type inference variables such as 'a.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpunioncase.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpunioncase.html new file mode 100644 index 0000000000..28d1e44a72 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpunioncase.html @@ -0,0 +1,284 @@ + + + + + FSharpUnionCase - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpUnionCase

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<Class>]
    + +     +

    +
    +

    A subtype of FSharpSymbol that represents a union case as seen by the F# language

    + +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Accessibility + +
    + Signature: FSharpAccessibility
    +
    +     		+

    Indicates if the declared visibility of the union constructor, not taking signatures into account

    + + +

    CompiledName: get_Accessibility

    +
    + + x.Attributes + +
    + Signature: IList<FSharpAttribute>
    +
    +     		+

    Get the attributes for the case, attached to the generated static method to make instances of the case

    + + +

    CompiledName: get_Attributes

    +
    + + x.CompiledName + +
    + Signature: string
    +
    +     		+

    Get the name of the case in generated IL code

    + + +

    CompiledName: get_CompiledName

    +
    + + x.DeclarationLocation + +
    + Signature: range
    +
    +     		+

    Get the range of the name of the case

    + + +

    CompiledName: get_DeclarationLocation

    +
    + + x.HasFields + +
    + Signature: bool
    +
    +     		+

    Indicates if the union case has field definitions

    + + +

    CompiledName: get_HasFields

    +
    + + x.IsUnresolved + +
    + Signature: bool
    +
    +     		+

    Indicates if the union case is for a type in an unresolved assembly

    + + +

    CompiledName: get_IsUnresolved

    +
    + + x.Name + +
    + Signature: string
    +
    +     		+

    Get the name of the union case

    + + +

    CompiledName: get_Name

    +
    + + x.ReturnType + +
    + Signature: FSharpType
    +
    +     		+

    Get the type constructed by the case. Normally exactly the type of the enclosing type, sometimes an abbreviation of it

    + + +

    CompiledName: get_ReturnType

    +
    + + x.UnionCaseFields + +
    + Signature: IList<FSharpField>
    +
    +     		+

    Get the data carried by the case.

    + + +

    CompiledName: get_UnionCaseFields

    +
    + + x.XmlDoc + +
    + Signature: IList<string>
    +
    +     		+

    Get the in-memory XML documentation for the union case, used when code is checked in-memory

    + + +

    CompiledName: get_XmlDoc

    +
    + + x.XmlDocSig + +
    + Signature: string
    +
    +     		+

    Get the XML documentation signature for .xml file lookup for the union case, used for .xml file lookup for compiled code

    + + +

    CompiledName: get_XmlDocSig

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-fsharpxmldoc.html b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpxmldoc.html new file mode 100644 index 0000000000..ae6ad70f97 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-fsharpxmldoc.html @@ -0,0 +1,153 @@ + + + + + FSharpXmlDoc - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FSharpXmlDoc

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Describe a comment as either a block of text or a file+signature reference into an intellidoc file.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + None + +
    + Signature:
    +
    +     		+

    No documentation is available

    + + +
    + + Text(string) + +
    + Signature: string
    +
    +     		+

    The text for documentation

    + + +
    + + XmlDocFileSignature(string,string) + +
    + Signature: string * string
    +
    +     		+

    Indicates that the text for the documentation can be found in a .xml documentation file, using the given signature key

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-iassemblycontentcache.html b/docs/reference/fsharp-compiler-sourcecodeservices-iassemblycontentcache.html new file mode 100644 index 0000000000..8708c3d11c --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-iassemblycontentcache.html @@ -0,0 +1,141 @@ + + + + + IAssemblyContentCache - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    IAssemblyContentCache

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<NoComparison>]
    +[<NoEquality>]
    + +     +

    +
    +

    Assembly content cache.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Set arg1 arg2 + +
    + Signature: AssemblyPath -> AssemblyContentCacheEntry -> unit
    + Modifiers: abstract
    +
    +     		+

    Store an assembly content.

    + + +
    + + x.TryGet(arg1) + +
    + Signature: AssemblyPath -> AssemblyContentCacheEntry option
    + Modifiers: abstract
    +
    +     		+

    Try get an assembly cached content.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-idents.html b/docs/reference/fsharp-compiler-sourcecodeservices-idents.html new file mode 100644 index 0000000000..9d3e0b8053 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-idents.html @@ -0,0 +1,95 @@ + + + + + Idents - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Idents

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    An array of ShortIdent.

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-inheritancecontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-inheritancecontext.html new file mode 100644 index 0000000000..1f8e3fea99 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-inheritancecontext.html @@ -0,0 +1,145 @@ + + + + + InheritanceContext - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    InheritanceContext

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Class + +
    + Signature:
    +
    +     		+ +
    + + Interface + +
    + Signature:
    +
    +     		+ +
    + + Unknown + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-insertcontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-insertcontext.html new file mode 100644 index 0000000000..6d1f2878ee --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-insertcontext.html @@ -0,0 +1,133 @@ + + + + + InsertContext - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    InsertContext

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Insert open namespace context.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Pos + +
    + Signature: pos
    +
    +     		+

    Current position (F# compiler line number).

    + + +
    + + ScopeKind + +
    + Signature: ScopeKind
    +
    +     		+

    Current scope kind.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-interfacedata.html b/docs/reference/fsharp-compiler-sourcecodeservices-interfacedata.html new file mode 100644 index 0000000000..7671685ea9 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-interfacedata.html @@ -0,0 +1,172 @@ + + + + + InterfaceData - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    InterfaceData

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Capture information about an interface in ASTs

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Interface(SynType,SynMemberDefns option) + +
    + Signature: SynType * SynMemberDefns option
    +
    +     		+ +
    + + ObjExpr(SynType,SynBinding list) + +
    + Signature: SynType * SynBinding list
    +
    +     		+ +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Range + +
    + Signature: range
    +
    +     		+ +

    CompiledName: get_Range

    +
    + + x.TypeParameters + +
    + Signature: string []
    +
    +     		+ +

    CompiledName: get_TypeParameters

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-interfacestubgenerator.html b/docs/reference/fsharp-compiler-sourcecodeservices-interfacestubgenerator.html new file mode 100644 index 0000000000..88abaca457 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-interfacestubgenerator.html @@ -0,0 +1,208 @@ + + + + + InterfaceStubGenerator - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    InterfaceStubGenerator

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + formatInterface(...) + +
    + Signature: startColumn:int -> indentation:int -> typeInstances:string [] -> objectIdent:string -> methodBody:string -> displayContext:FSharpDisplayContext -> excludedMemberSignatures:Set<string> -> FSharpEntity -> verboseMode:bool -> string
    +
    +     		+

    Generate stub implementation of an interface at a start column

    + + +
    + + getImplementedMemberSignatures(...) + +
    + Signature: getMemberByLocation:(string * range -> Async<FSharpSymbolUse option>) -> FSharpDisplayContext -> InterfaceData -> Async<Set<string>>
    +
    +     		+ +
    + + getInterfaceMembers(arg1) + +
    + Signature: FSharpEntity -> seq<FSharpMemberOrFunctionOrValue * seq<FSharpGenericParameter * FSharpType>>
    +
    +     		+

    Get members in the decreasing order of inheritance chain

    + + +
    + + getMemberNameAndRanges(arg1) + +
    + Signature: InterfaceData -> (string * range) list
    +
    +     		+

    Get associated member names and ranges +In case of properties, intrinsic ranges might not be correct for the purpose of getting +positions of 'member', which indicate the indentation for generating new members

    + + +
    + + hasNoInterfaceMember(arg1) + +
    + Signature: FSharpEntity -> bool
    +
    +     		+

    Check whether an interface is empty

    + + +
    + + isInterface(arg1) + +
    + Signature: FSharpEntity -> bool
    +
    +     		+

    Check whether an entity is an interface or type abbreviation of an interface

    + + +
    + + tryFindInterfaceDeclaration(...) + +
    + Signature: pos -> parsedInput:ParsedInput -> InterfaceData option
    +
    +     		+

    Find corresponding interface declaration at a given position

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-keywords.html b/docs/reference/fsharp-compiler-sourcecodeservices-keywords.html new file mode 100644 index 0000000000..e9a586e26a --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-keywords.html @@ -0,0 +1,163 @@ + + + + + Keywords - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Keywords

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + DoesIdentifierNeedQuotation(arg1) + +
    + Signature: string -> bool
    +
    +     		+

    Checks if adding backticks to identifier is needed.

    + + +
    + + KeywordsWithDescription + +
    + Signature: (string * string) list
    +
    +     		+

    Keywords paired with their descriptions. Used in completion and quick info.

    + + +
    + + NormalizeIdentifierBackticks(arg1) + +
    + Signature: string -> string
    +
    +     		+

    Remove backticks if present.

    + + +
    + + QuoteIdentifierIfNeeded(arg1) + +
    + Signature: string -> string
    +
    +     		+

    Add backticks if the identifier is a keyword.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-layout.html b/docs/reference/fsharp-compiler-sourcecodeservices-layout.html new file mode 100644 index 0000000000..3ff7352d4b --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-layout.html @@ -0,0 +1,93 @@ + + + + + Layout - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Layout

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-lookuptype.html b/docs/reference/fsharp-compiler-sourcecodeservices-lookuptype.html new file mode 100644 index 0000000000..46c423a306 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-lookuptype.html @@ -0,0 +1,134 @@ + + + + + LookupType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LookupType

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Entity lookup type.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Fuzzy + +
    + Signature:
    +
    +     		+ +
    + + Precise + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedident.html b/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedident.html new file mode 100644 index 0000000000..515697e393 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedident.html @@ -0,0 +1,129 @@ + + + + + MaybeUnresolvedIdent - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MaybeUnresolvedIdent

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    ShortIdent with a flag indicating if it's resolved in some scope.

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Ident + +
    + Signature: ShortIdent
    +
    +     		+ +
    + + Resolved + +
    + Signature: bool
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedidents.html b/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedidents.html new file mode 100644 index 0000000000..97f87d2666 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-maybeunresolvedidents.html @@ -0,0 +1,95 @@ + + + + + MaybeUnresolvedIdents - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    MaybeUnresolvedIdents

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Array of MaybeUnresolvedIdent.

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-modulekind.html b/docs/reference/fsharp-compiler-sourcecodeservices-modulekind.html new file mode 100644 index 0000000000..1e899327db --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-modulekind.html @@ -0,0 +1,127 @@ + + + + + ModuleKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ModuleKind

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + HasModuleSuffix + +
    + Signature: bool
    +
    +     		+ +
    + + IsAutoOpen + +
    + Signature: bool
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-container.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-container.html new file mode 100644 index 0000000000..155b39ef9a --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-container.html @@ -0,0 +1,128 @@ + + + + + Container - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Container

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: NavigateTo
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Name + +
    + Signature: string
    +
    +     		+ +
    + + Type + +
    + Signature: ContainerType
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-containertype.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-containertype.html new file mode 100644 index 0000000000..9e4a1eaa6b --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-containertype.html @@ -0,0 +1,172 @@ + + + + + ContainerType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ContainerType

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: NavigateTo
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Exception + +
    + Signature:
    +
    +     		+ +
    + + File + +
    + Signature:
    +
    +     		+ +
    + + Module + +
    + Signature:
    +
    +     		+ +
    + + Namespace + +
    + Signature:
    +
    +     		+ +
    + + Type + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitem.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitem.html new file mode 100644 index 0000000000..d7d37ed831 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitem.html @@ -0,0 +1,167 @@ + + + + + NavigableItem - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NavigableItem

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: NavigateTo
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Container + +
    + Signature: Container
    +
    +     		+ +
    + + IsSignature + +
    + Signature: bool
    +
    +     		+ +
    + + Kind + +
    + Signature: NavigableItemKind
    +
    +     		+ +
    + + Name + +
    + Signature: string
    +
    +     		+ +
    + + Range + +
    + Signature: range
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitemkind.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitemkind.html new file mode 100644 index 0000000000..50f0acc8d4 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto-navigableitemkind.html @@ -0,0 +1,250 @@ + + + + + NavigableItemKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NavigableItemKind

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: NavigateTo
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Constructor + +
    + Signature:
    +
    +     		+ +
    + + EnumCase + +
    + Signature:
    +
    +     		+ +
    + + Exception + +
    + Signature:
    +
    +     		+ +
    + + Field + +
    + Signature:
    +
    +     		+ +
    + + Member + +
    + Signature:
    +
    +     		+ +
    + + Module + +
    + Signature:
    +
    +     		+ +
    + + ModuleAbbreviation + +
    + Signature:
    +
    +     		+ +
    + + ModuleValue + +
    + Signature:
    +
    +     		+ +
    + + Property + +
    + Signature:
    +
    +     		+ +
    + + Type + +
    + Signature:
    +
    +     		+ +
    + + UnionCase + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-navigateto.html b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto.html new file mode 100644 index 0000000000..072a156541 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-navigateto.html @@ -0,0 +1,159 @@ + + + + + NavigateTo - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    NavigateTo

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + Container + + +
    + ContainerType + + +
    + NavigableItem + + +
    + NavigableItemKind + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + getNavigableItems(arg1) + +
    + Signature: ParsedInput -> NavigableItem []
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-openstatementinsertionpoint.html b/docs/reference/fsharp-compiler-sourcecodeservices-openstatementinsertionpoint.html new file mode 100644 index 0000000000..17f6ed9d61 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-openstatementinsertionpoint.html @@ -0,0 +1,129 @@ + + + + + OpenStatementInsertionPoint - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    OpenStatementInsertionPoint

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Where open statements should be added.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Nearest + +
    + Signature:
    +
    +     		+ +
    + + TopLevel + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbol.html new file mode 100644 index 0000000000..d4f4073f44 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbol.html @@ -0,0 +1,134 @@ + + + + + ParamTypeSymbol - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParamTypeSymbol

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Represents the type of a single method parameter

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Byref(ExternalType) + +
    + Signature: ExternalType
    +
    +     		+ +
    + + Param(ExternalType) + +
    + Signature: ExternalType
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbolmodule.html b/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbolmodule.html new file mode 100644 index 0000000000..bf6e11effd --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-paramtypesymbolmodule.html @@ -0,0 +1,95 @@ + + + + + ParamTypeSymbol - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParamTypeSymbol

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-parsedinput.html b/docs/reference/fsharp-compiler-sourcecodeservices-parsedinput.html new file mode 100644 index 0000000000..8105bcee0b --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-parsedinput.html @@ -0,0 +1,165 @@ + + + + + ParsedInput - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ParsedInput

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Parse AST helpers.

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + adjustInsertionPoint getLineStr ctx + +
    + Signature: getLineStr:(int -> string) -> ctx:InsertContext -> pos
    +
    +     		+

    Corrects insertion line number based on kind of scope and text surrounding the insertion point.

    + + +
    + + findNearestPointToInsertOpenDeclaration(...) + +
    + Signature: currentLine:int -> ast:ParsedInput -> entity:Idents -> insertionPoint:OpenStatementInsertionPoint -> InsertContext
    +
    +     		+

    Returns InsertContext based on current position and symbol idents.

    + + +
    + + getLongIdentAt ast pos + +
    + Signature: ast:ParsedInput -> pos:pos -> LongIdent option
    +
    +     		+

    Returns long identifier at position.

    + + +
    + + tryFindInsertionContext(...) + +
    + Signature: currentLine:int -> ast:ParsedInput -> MaybeUnresolvedIdents -> insertionPoint:OpenStatementInsertionPoint -> Idents option * Idents option * Idents option * Idents -> (Entity * InsertContext) []
    +
    +     		+

    Returns InsertContext based on current position and symbol idents.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-position.html b/docs/reference/fsharp-compiler-sourcecodeservices-position.html new file mode 100644 index 0000000000..96122b01f4 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-position.html @@ -0,0 +1,127 @@ + + + + + Position - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Position

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: int
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: int
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-prettynaming.html b/docs/reference/fsharp-compiler-sourcecodeservices-prettynaming.html new file mode 100644 index 0000000000..c77d35a202 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-prettynaming.html @@ -0,0 +1,200 @@ + + + + + PrettyNaming - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PrettyNaming

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    A set of helpers related to naming of identifiers

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + FormatAndOtherOverloadsString(arg1) + +
    + Signature: int -> string
    +
    +     		+ +
    + + GetLongNameFromString(arg1) + +
    + Signature: string -> string list
    +
    +     		+ +
    + + IsIdentifierPartCharacter(arg1) + +
    + Signature: char -> bool
    +
    +     		+ +
    + + IsLongIdentifierPartCharacter(arg1) + +
    + Signature: char -> bool
    +
    +     		+ +
    + + IsOperatorName(arg1) + +
    + Signature: string -> bool
    +
    +     		+ +
    + + KeywordNames + +
    + Signature: string list
    +
    +     		+

    All the keywords in the F# language

    + + +
    + + QuoteIdentifierIfNeeded(arg1) + +
    + Signature: string -> string
    +
    +     		+

    A utility to help determine if an identifier needs to be quoted

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-range.html b/docs/reference/fsharp-compiler-sourcecodeservices-range.html new file mode 100644 index 0000000000..c247090de3 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-range.html @@ -0,0 +1,127 @@ + + + + + Range - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Range

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Item1 + +
    + Signature: Position
    +
    +     		+ +
    + + x.Item2 + +
    + Signature: Position
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-recordcontext.html b/docs/reference/fsharp-compiler-sourcecodeservices-recordcontext.html new file mode 100644 index 0000000000..ae680883d4 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-recordcontext.html @@ -0,0 +1,145 @@ + + + + + RecordContext - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    RecordContext

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Constructor(string) + +
    + Signature: string
    +
    +     		+ +
    + + CopyOnUpdate(range,CompletionPath) + +
    + Signature: range * CompletionPath
    +
    +     		+ +
    + + New(CompletionPath) + +
    + Signature: CompletionPath
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-scopekind.html b/docs/reference/fsharp-compiler-sourcecodeservices-scopekind.html new file mode 100644 index 0000000000..76a5a17029 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-scopekind.html @@ -0,0 +1,168 @@ + + + + + ScopeKind - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ScopeKind

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Kind of lexical scope.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + HashDirective + +
    + Signature:
    +
    +     		+ +
    + + Namespace + +
    + Signature:
    +
    +     		+ +
    + + NestedModule + +
    + Signature:
    +
    +     		+ +
    + + OpenDeclaration + +
    + Signature:
    +
    +     		+ +
    + + TopModule + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-semanticclassificationtype.html b/docs/reference/fsharp-compiler-sourcecodeservices-semanticclassificationtype.html new file mode 100644 index 0000000000..cfab7e6728 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-semanticclassificationtype.html @@ -0,0 +1,301 @@ + + + + + SemanticClassificationType - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SemanticClassificationType

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ComputationExpression + +
    + Signature:
    +
    +     		+ +
    + + Disposable + +
    + Signature:
    +
    +     		+ +
    + + Enumeration + +
    + Signature:
    +
    +     		+ +
    + + Function + +
    + Signature:
    +
    +     		+ +
    + + Interface + +
    + Signature:
    +
    +     		+ +
    + + IntrinsicFunction + +
    + Signature:
    +
    +     		+ +
    + + Module + +
    + Signature:
    +
    +     		+ +
    + + MutableVar + +
    + Signature:
    +
    +     		+ +
    + + Operator + +
    + Signature:
    +
    +     		+ +
    + + Printf + +
    + Signature:
    +
    +     		+ +
    + + Property + +
    + Signature:
    +
    +     		+ +
    + + ReferenceType + +
    + Signature:
    +
    +     		+ +
    + + TypeArgument + +
    + Signature:
    +
    +     		+ +
    + + UnionCase + +
    + Signature:
    +
    +     		+ +
    + + ValueType + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-shortident.html b/docs/reference/fsharp-compiler-sourcecodeservices-shortident.html new file mode 100644 index 0000000000..3c626f1c9d --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-shortident.html @@ -0,0 +1,129 @@ + + + + + ShortIdent - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ShortIdent

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Short identifier, i.e. an identifier that contains no dots.

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Chars(arg1) + +
    + Signature: int -> char
    +
    +     		+ +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-simplifynames-simplifiablerange.html b/docs/reference/fsharp-compiler-sourcecodeservices-simplifynames-simplifiablerange.html new file mode 100644 index 0000000000..9131d4703d --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-simplifynames-simplifiablerange.html @@ -0,0 +1,134 @@ + + + + + SimplifiableRange - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SimplifiableRange

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: SimplifyNames
    +

    +
    +

    Data for use in finding unnecessarily-qualified names and generating diagnostics to simplify them

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Range + +
    + Signature: range
    +
    +     		+

    The range of a name that can be simplified

    + + +
    + + RelativeName + +
    + Signature: string
    +
    +     		+

    The relative name that can be applied to a simplifiable name

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-simplifynames.html b/docs/reference/fsharp-compiler-sourcecodeservices-simplifynames.html new file mode 100644 index 0000000000..0bd49216f5 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-simplifynames.html @@ -0,0 +1,139 @@ + + + + + SimplifyNames - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SimplifyNames

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + +
    TypeDescription
    + SimplifiableRange + +

    Data for use in finding unnecessarily-qualified names and generating diagnostics to simplify them

    + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + getSimplifiableNames(...) + +
    + Signature: (checkFileResults:FSharpCheckFileResults * getSourceLineStr:(int -> string)) -> Async<SimplifiableRange list>
    +
    +     		+

    Get all ranges that can be simplified in a file

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-sourcefile.html b/docs/reference/fsharp-compiler-sourcecodeservices-sourcefile.html new file mode 100644 index 0000000000..e14c9b2f42 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-sourcefile.html @@ -0,0 +1,135 @@ + + + + + SourceFile - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SourceFile

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Information about F# source file names

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + +
    Function or valueDescription
    + + IsCompilable(arg1) + +
    + Signature: string -> bool
    +
    +     		+

    Whether or not this file is compilable

    + + +
    + + MustBeSingleFileProject(arg1) + +
    + Signature: string -> bool
    +
    +     		+

    Whether or not this file should be a single-file project

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-stringlongident.html b/docs/reference/fsharp-compiler-sourcecodeservices-stringlongident.html new file mode 100644 index 0000000000..3951ef4116 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-stringlongident.html @@ -0,0 +1,129 @@ + + + + + StringLongIdent - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    StringLongIdent

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Long identifier (i.e. it may contain dots).

    + +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Chars(arg1) + +
    + Signature: int -> char
    +
    +     		+ +
    + + x.Length + +
    + Signature: int
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-structure-collapse.html b/docs/reference/fsharp-compiler-sourcecodeservices-structure-collapse.html new file mode 100644 index 0000000000..b1a9623b96 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-structure-collapse.html @@ -0,0 +1,137 @@ + + + + + Collapse - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Collapse

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: Structure
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Collapse indicates the way a range/snapshot should be collapsed. Same is for a scope inside +some kind of scope delimiter, e.g. [| ... |], [ ... ], { ... }, etc. Below is for expressions +following a binding or the right hand side of a pattern, e.g. let x = ...

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Below + +
    + Signature:
    +
    +     		+ +
    + + Same + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-structure-scope.html b/docs/reference/fsharp-compiler-sourcecodeservices-structure-scope.html new file mode 100644 index 0000000000..068e0d862b --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-structure-scope.html @@ -0,0 +1,720 @@ + + + + + Scope - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Scope

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: Structure
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Tag to identify the construct that can be stored alongside its associated ranges

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ArrayOrList + +
    + Signature:
    +
    +     		+ +
    + + Attribute + +
    + Signature:
    +
    +     		+ +
    + + Comment + +
    + Signature:
    +
    +     		+ +
    + + CompExpr + +
    + Signature:
    +
    +     		+ +
    + + CompExprInternal + +
    + Signature:
    +
    +     		+ +
    + + Do + +
    + Signature:
    +
    +     		+ +
    + + ElseInIfThenElse + +
    + Signature:
    +
    +     		+ +
    + + EnumCase + +
    + Signature:
    +
    +     		+ +
    + + FinallyInTryFinally + +
    + Signature:
    +
    +     		+ +
    + + For + +
    + Signature:
    +
    +     		+ +
    + + HashDirective + +
    + Signature:
    +
    +     		+ +
    + + IfThenElse + +
    + Signature:
    +
    +     		+ +
    + + Interface + +
    + Signature:
    +
    +     		+ +
    + + Lambda + +
    + Signature:
    +
    +     		+ +
    + + LetOrUse + +
    + Signature:
    +
    +     		+ +
    + + LetOrUseBang + +
    + Signature:
    +
    +     		+ +
    + + Match + +
    + Signature:
    +
    +     		+ +
    + + MatchBang + +
    + Signature:
    +
    +     		+ +
    + + MatchClause + +
    + Signature:
    +
    +     		+ +
    + + MatchLambda + +
    + Signature:
    +
    +     		+ +
    + + Member + +
    + Signature:
    +
    +     		+ +
    + + Module + +
    + Signature:
    +
    +     		+ +
    + + Namespace + +
    + Signature:
    +
    +     		+ +
    + + New + +
    + Signature:
    +
    +     		+ +
    + + ObjExpr + +
    + Signature:
    +
    +     		+ +
    + + Open + +
    + Signature:
    +
    +     		+ +
    + + Quote + +
    + Signature:
    +
    +     		+ +
    + + Record + +
    + Signature:
    +
    +     		+ +
    + + RecordDefn + +
    + Signature:
    +
    +     		+ +
    + + RecordField + +
    + Signature:
    +
    +     		+ +
    + + SpecialFunc + +
    + Signature:
    +
    +     		+ +
    + + ThenInIfThenElse + +
    + Signature:
    +
    +     		+ +
    + + TryFinally + +
    + Signature:
    +
    +     		+ +
    + + TryInTryFinally + +
    + Signature:
    +
    +     		+ +
    + + TryInTryWith + +
    + Signature:
    +
    +     		+ +
    + + TryWith + +
    + Signature:
    +
    +     		+ +
    + + Tuple + +
    + Signature:
    +
    +     		+ +
    + + Type + +
    + Signature:
    +
    +     		+ +
    + + TypeExtension + +
    + Signature:
    +
    +     		+ +
    + + UnionCase + +
    + Signature:
    +
    +     		+ +
    + + UnionDefn + +
    + Signature:
    +
    +     		+ +
    + + Val + +
    + Signature:
    +
    +     		+ +
    + + While + +
    + Signature:
    +
    +     		+ +
    + + WithInTryWith + +
    + Signature:
    +
    +     		+ +
    + + XmlDocComment + +
    + Signature:
    +
    +     		+ +
    + + YieldOrReturn + +
    + Signature:
    +
    +     		+ +
    + + YieldOrReturnBang + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-structure-scoperange.html b/docs/reference/fsharp-compiler-sourcecodeservices-structure-scoperange.html new file mode 100644 index 0000000000..3ef04f431a --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-structure-scoperange.html @@ -0,0 +1,166 @@ + + + + + ScopeRange - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ScopeRange

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    + Parent Module: Structure
    + + Attributes:
    +[<NoComparison>]
    + +     +

    +
    +

    Stores the range for a construct, the sub-range that should be collapsed for outlinging, +a tag for the construct type, and a tag for the collapse style

    + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + Collapse + +
    + Signature: Collapse
    +
    +     		+ +
    + + CollapseRange + +
    + Signature: range
    +
    +     		+

    TextSpan in BlockSpan

    + + +
    + + Range + +
    + Signature: range
    +
    +     		+

    HintSpan in BlockSpan

    + + +
    + + Scope + +
    + Signature: Scope
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-structure.html b/docs/reference/fsharp-compiler-sourcecodeservices-structure.html new file mode 100644 index 0000000000..94249d36d6 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-structure.html @@ -0,0 +1,162 @@ + + + + + Structure - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Structure

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + Collapse + +

    Collapse indicates the way a range/snapshot should be collapsed. Same is for a scope inside +some kind of scope delimiter, e.g. [| ... |], [ ... ], { ... }, etc. Below is for expressions +following a binding or the right hand side of a pattern, e.g. let x = ...

    + + +
    + Scope + +

    Tag to identify the construct that can be stored alongside its associated ranges

    + + +
    + ScopeRange + +

    Stores the range for a construct, the sub-range that should be collapsed for outlinging, +a tag for the construct type, and a tag for the collapse style

    + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + getOutliningRanges(...) + +
    + Signature: sourceLines:string [] -> parsedInput:ParsedInput -> seq<ScopeRange>
    +
    +     		+

    Returns outlining ranges for given parsed input.

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-symbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-symbol.html new file mode 100644 index 0000000000..11bf5bce49 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-symbol.html @@ -0,0 +1,712 @@ + + + + + Symbol - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Symbol

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    + + Attributes:
    +[<RequireQualifiedAccess>]
    + +     +

    +
    +

    Patterns over FSharpSymbol and derivatives.

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + Symbol.getAbbreviatedType(arg1) + +
    + Signature: FSharpType -> FSharpType
    +
    +     		+ +
    + + Symbol.getEntityAbbreviatedType(arg1) + +
    + Signature: FSharpEntity -> FSharpEntity * FSharpType option
    +
    +     		+ +
    + + Symbol.hasAttribute(arg1) + +
    + Signature: seq<FSharpAttribute> -> bool
    + Type parameters: 'T
    +     		+ +
    + + Symbol.hasModuleSuffixAttribute(arg1) + +
    + Signature: FSharpEntity -> bool
    +
    +     		+ +
    + + Symbol.isAttribute(arg1) + +
    + Signature: FSharpAttribute -> bool
    + Type parameters: 'T
    +     		+ +
    + + Symbol.isOperator(name) + +
    + Signature: name:string -> bool
    +
    +     		+ +
    + + Symbol.isUnnamedUnionCaseField(arg1) + +
    + Signature: FSharpField -> bool
    +
    +     		+ +
    + + Symbol.tryGetAttribute(arg1) + +
    + Signature: seq<FSharpAttribute> -> FSharpAttribute option
    + Type parameters: 'T
    +     		+ +
    +

    Active patterns

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Active patternDescription
    + + Symbol.( |AbbreviatedType|_| )(arg1) + +
    + Signature: FSharpEntity -> FSharpType option
    +
    +     		+ +

    CompiledName: |AbbreviatedType|_|

    +
    + + Symbol.( |AbstractClass|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |AbstractClass|_|

    +
    + + Symbol.( |ActivePatternCase|_| )(arg1) + +
    + Signature: FSharpSymbol -> FSharpActivePatternCase option
    +
    +     		+ +

    CompiledName: |ActivePatternCase|_|

    +
    + + Symbol.( |Array|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |Array|_|

    +
    + + Symbol.( |Attribute|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |Attribute|_|

    +
    + + Symbol.( |ByRef|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |ByRef|_|

    +
    + + Symbol.( |Class|_| )(...) + +
    + Signature: (original:FSharpEntity * abbreviated:FSharpEntity * 'a) -> unit option
    + Type parameters: 'a
    +     		+ +

    CompiledName: |Class|_|

    +
    + + Symbol.( |Constructor|_| )(arg1) + +
    + Signature: FSharpMemberOrFunctionOrValue -> FSharpEntity option
    +
    +     		+ +

    CompiledName: |Constructor|_|

    +
    + + Symbol.( |Delegate|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |Delegate|_|

    +
    + + Symbol.( |Enum|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |Enum|_|

    +
    + + Symbol.( |Event|_| )(arg1) + +
    + Signature: FSharpMemberOrFunctionOrValue -> unit option
    +
    +     		+ +

    CompiledName: |Event|_|

    +
    + + Symbol.( |ExtensionMember|_| )(arg1) + +
    + Signature: FSharpMemberOrFunctionOrValue -> unit option
    +
    +     		+ +

    CompiledName: |ExtensionMember|_|

    +
    + + Symbol.( |Field|_| )(arg1) + +
    + Signature: FSharpSymbol -> (FSharpField * FSharpType) option
    +
    +     		+ +

    CompiledName: |Field|_|

    +
    + + Symbol.( |FSharpEntity|_| )(arg1) + +
    + Signature: FSharpSymbol -> (FSharpEntity * FSharpEntity * FSharpType option) option
    +
    +     		+ +

    CompiledName: |FSharpEntity|_|

    +
    + + Symbol.( |FSharpException|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |FSharpException|_|

    +
    + + Symbol.( |FSharpModule|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |FSharpModule|_|

    +
    + + Symbol.( |FSharpType|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |FSharpType|_|

    +
    + + Symbol.( |Function|_| ) excluded arg2 + +
    + Signature: excluded:bool -> FSharpMemberOrFunctionOrValue -> unit option
    +
    +     		+ +

    CompiledName: |Function|_|

    +
    + + Symbol.( |FunctionType|_| )(arg1) + +
    + Signature: FSharpType -> unit option
    +
    +     		+ +

    CompiledName: |FunctionType|_|

    +
    + + Symbol.( |Interface|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |Interface|_|

    +
    + + Symbol.( |MemberFunctionOrValue|_| )(...) + +
    + Signature: FSharpSymbol -> FSharpMemberOrFunctionOrValue option
    +
    +     		+ +

    CompiledName: |MemberFunctionOrValue|_|

    +
    + + Symbol.( |MutableVar|_| )(arg1) + +
    + Signature: FSharpSymbol -> unit option
    +
    +     		+ +

    CompiledName: |MutableVar|_|

    +
    + + Symbol.( |Namespace|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |Namespace|_|

    +
    + + Symbol.( |Parameter|_| )(arg1) + +
    + Signature: FSharpSymbol -> unit option
    +
    +     		+ +

    CompiledName: |Parameter|_|

    +
    + + Symbol.( |Pattern|_| )(arg1) + +
    + Signature: FSharpSymbol -> unit option
    +
    +     		+ +

    CompiledName: |Pattern|_|

    +
    + + Symbol.( |ProvidedAndErasedType|_| )(...) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |ProvidedAndErasedType|_|

    +
    + + Symbol.( |ProvidedType|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |ProvidedType|_|

    +
    + + Symbol.( |Record|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |Record|_|

    +
    + + Symbol.( |RecordField|_| )(arg1) + +
    + Signature: FSharpSymbol -> FSharpField option
    +
    +     		+ +

    CompiledName: |RecordField|_|

    +
    + + Symbol.( |RefCell|_| )(arg1) + +
    + Signature: FSharpType -> unit option
    +
    +     		+ +

    CompiledName: |RefCell|_|

    +
    + + Symbol.( |Tuple|_| )(arg1) + +
    + Signature: FSharpType -> unit option
    +
    +     		+ +

    CompiledName: |Tuple|_|

    +
    + + Symbol.( |TypeWithDefinition|_| )(arg1) + +
    + Signature: FSharpType -> FSharpEntity option
    +
    +     		+ +

    CompiledName: |TypeWithDefinition|_|

    +
    + + Symbol.( |UnionCase|_| )(arg1) + +
    + Signature: FSharpSymbol -> FSharpUnionCase option
    +
    +     		+ +

    CompiledName: |UnionCase|_|

    +
    + + Symbol.( |UnionType|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |UnionType|_|

    +
    + + Symbol.( |ValueType|_| )(arg1) + +
    + Signature: FSharpEntity -> unit option
    +
    +     		+ +

    CompiledName: |ValueType|_|

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-tooltips.html b/docs/reference/fsharp-compiler-sourcecodeservices-tooltips.html new file mode 100644 index 0000000000..61c13cc5d3 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-tooltips.html @@ -0,0 +1,142 @@ + + + + + Tooltips - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Tooltips

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + Map f a + +
    + Signature: f:('T1 -> 'T2) -> a:Async<'T1> -> Async<'T2>
    + Type parameters: 'T1, 'T2
    +     		+ +
    + + ToFSharpToolTipElement(arg1) + +
    + Signature: FSharpStructuredToolTipElement -> FSharpToolTipElement
    +
    +     		+ +
    + + ToFSharpToolTipText(arg1) + +
    + Signature: FSharpStructuredToolTipText -> FSharpToolTipText
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html b/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html new file mode 100644 index 0000000000..59a0f5fb3a --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedreferencesset.html @@ -0,0 +1,95 @@ + + + + + UnresolvedReferencesSet - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UnresolvedReferencesSet

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Unused in this API

    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedsymbol.html b/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedsymbol.html new file mode 100644 index 0000000000..04b90537d7 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-unresolvedsymbol.html @@ -0,0 +1,140 @@ + + + + + UnresolvedSymbol - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UnresolvedSymbol

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + DisplayName + +
    + Signature: string
    +
    +     		+ +
    + + FullName + +
    + Signature: string
    +
    +     		+ +
    + + Namespace + +
    + Signature: string []
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-untypedparseimpl.html b/docs/reference/fsharp-compiler-sourcecodeservices-untypedparseimpl.html new file mode 100644 index 0000000000..f7b77f1dc1 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-untypedparseimpl.html @@ -0,0 +1,181 @@ + + + + + UntypedParseImpl - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UntypedParseImpl

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + GetEntityKind(arg1, arg2) + +
    + Signature: (pos * ParsedInput) -> EntityKind option
    +
    +     		+ +
    + + GetFullNameOfSmallestModuleOrNamespaceAtPoint(...) + +
    + Signature: (ParsedInput * pos) -> string []
    +
    +     		+ +
    + + GetRangeOfExprLeftOfDot(arg1, arg2) + +
    + Signature: (pos * ParsedInput option) -> range option
    +
    +     		+ +
    + + TryFindExpressionASTLeftOfDotLeftOfCursor(...) + +
    + Signature: (pos * ParsedInput option) -> (pos * bool) option
    +
    +     		+ +
    + + TryFindExpressionIslandInPosition(...) + +
    + Signature: (pos * ParsedInput option) -> string option
    +
    +     		+ +
    + + TryGetCompletionContext(...) + +
    + Signature: (pos * ParsedInput * lineStr:string) -> CompletionContext option
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-unuseddeclarations.html b/docs/reference/fsharp-compiler-sourcecodeservices-unuseddeclarations.html new file mode 100644 index 0000000000..803fe8aa4a --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-unuseddeclarations.html @@ -0,0 +1,118 @@ + + + + + UnusedDeclarations - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UnusedDeclarations

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + getUnusedDeclarations(...) + +
    + Signature: (checkFileResults:FSharpCheckFileResults * isScriptFile:bool) -> Async<range list>
    +
    +     		+

    Get all unused declarations in a file

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-unusedopens.html b/docs/reference/fsharp-compiler-sourcecodeservices-unusedopens.html new file mode 100644 index 0000000000..17dce08979 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-unusedopens.html @@ -0,0 +1,118 @@ + + + + + UnusedOpens - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    UnusedOpens

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + getUnusedOpens(...) + +
    + Signature: (checkFileResults:FSharpCheckFileResults * getSourceLineStr:(int -> string)) -> Async<range list>
    +
    +     		+

    Get all unused open declarations in a file

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-xmldocable.html b/docs/reference/fsharp-compiler-sourcecodeservices-xmldocable.html new file mode 100644 index 0000000000..b79d9f7662 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-xmldocable.html @@ -0,0 +1,116 @@ + + + + + XmlDocable - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    XmlDocable

    +

    + + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +

    Represent an Xml documentation block in source code

    + +
    +

    Union Cases

    + + + + + + + + + + +
    Union CaseDescription
    + + XmlDocable(line,indent,paramNames) + +
    + Signature: int * int * string list
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-xmldoccomment.html b/docs/reference/fsharp-compiler-sourcecodeservices-xmldoccomment.html new file mode 100644 index 0000000000..0e59537267 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-xmldoccomment.html @@ -0,0 +1,118 @@ + + + + + XmlDocComment - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    XmlDocComment

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + isBlank(arg1) + +
    + Signature: string -> int option
    +
    +     		+

    if it's a blank XML comment with trailing "<", returns Some (index of the "<"), otherwise returns None

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-sourcecodeservices-xmldocparser.html b/docs/reference/fsharp-compiler-sourcecodeservices-xmldocparser.html new file mode 100644 index 0000000000..be95e95e28 --- /dev/null +++ b/docs/reference/fsharp-compiler-sourcecodeservices-xmldocparser.html @@ -0,0 +1,118 @@ + + + + + XmlDocParser - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    XmlDocParser

    +

    + Namespace: FSharp.Compiler.SourceCodeServices
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + getXmlDocables(arg1, input) + +
    + Signature: (ISourceText * input:ParsedInput option) -> XmlDocable list
    +
    +     		+

    Get the list of Xml documentation from current source code

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-stablenicenamegenerator.html b/docs/reference/fsharp-compiler-stablenicenamegenerator.html new file mode 100644 index 0000000000..1b3dd3a156 --- /dev/null +++ b/docs/reference/fsharp-compiler-stablenicenamegenerator.html @@ -0,0 +1,155 @@ + + + + + StableNiceNameGenerator - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    StableNiceNameGenerator

    +

    + + Namespace: FSharp.Compiler
    +

    +
    +

    Generates compiler-generated names marked up with a source code location, but if given the same unique value then +return precisely the same name. Each name generated also includes the StartLine number of the range passed in +at the point of first generation.

    +

    This type may be accessed concurrently, though in practice it is only used from the compilation thread. +It is made concurrency-safe since a global instance of the type is allocated in tast.fs.

    + +
    +

    Constructors

    + + + + + + + + + + +
    ConstructorDescription
    + + new() + +
    + Signature: unit -> StableNiceNameGenerator
    +
    +     		+ +

    CompiledName: .ctor

    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.GetUniqueCompilerGeneratedName(...) + +
    + Signature: (name:string * m:range * uniq:int64) -> string
    +
    +     		+ +
    + + x.Reset() + +
    + Signature: unit -> unit
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-text-isourcetext.html b/docs/reference/fsharp-compiler-text-isourcetext.html new file mode 100644 index 0000000000..ebb169c55d --- /dev/null +++ b/docs/reference/fsharp-compiler-text-isourcetext.html @@ -0,0 +1,229 @@ + + + + + ISourceText - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    ISourceText

    +

    + + Namespace: FSharp.Compiler.Text
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.ContentEquals(sourceText) + +
    + Signature: sourceText:ISourceText -> bool
    + Modifiers: abstract
    +
    +     		+ +
    + + x.CopyTo(...) + +
    + Signature: (sourceIndex:int * destination:char [] * destinationIndex:int * count:int) -> unit
    + Modifiers: abstract
    +
    +     		+ +
    + + x.GetLastCharacterPosition() + +
    + Signature: unit -> int * int
    + Modifiers: abstract
    +
    +     		+ +
    + + x.GetLineCount() + +
    + Signature: unit -> int
    + Modifiers: abstract
    +
    +     		+ +
    + + x.GetLineString(lineIndex) + +
    + Signature: lineIndex:int -> string
    + Modifiers: abstract
    +
    +     		+ +
    + + x.GetSubTextString(start, length) + +
    + Signature: (start:int * length:int) -> string
    + Modifiers: abstract
    +
    +     		+ +
    + + [arg1] + +
    + Signature: int -> char
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_Item

    +
    + + x.Length + +
    + Signature: int
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_Length

    +
    + + x.SubTextEquals(target, startIndex) + +
    + Signature: (target:string * startIndex:int) -> bool
    + Modifiers: abstract
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/fsharp-compiler-text-sourcetext.html b/docs/reference/fsharp-compiler-text-sourcetext.html new file mode 100644 index 0000000000..64b30e3dd7 --- /dev/null +++ b/docs/reference/fsharp-compiler-text-sourcetext.html @@ -0,0 +1,116 @@ + + + + + SourceText - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    SourceText

    +

    + Namespace: FSharp.Compiler.Text
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + +
    Function or valueDescription
    + + ofString(arg1) + +
    + Signature: string -> ISourceText
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000000..5d7631c19f --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,1804 @@ + + + + + Namespaces - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + +

    F# Compiler Services

    + +

    FSharp.Compiler Namespace

    +
    + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + LogCompilerFunctionId + + +
    + NiceNameGenerator + +

    Generates compiler-generated names. Each name generated also includes the StartLine number of the range passed in +at the point of first generation.

    +

    This type may be accessed concurrently, though in practice it is only used from the compilation thread. +It is made concurrency-safe since a global instance of the type is allocated in tast.fs, and it is good +policy to make all globally-allocated objects concurrency safe in case future versions of the compiler +are used to host multiple concurrent instances of compilation.

    + + +
    + PartialLongName + +

    Qualified long name.

    + + +
    + StableNiceNameGenerator + +

    Generates compiler-generated names marked up with a source code location, but if given the same unique value then +return precisely the same name. Each name generated also includes the StartLine number of the range passed in +at the point of first generation.

    +

    This type may be accessed concurrently, though in practice it is only used from the compilation thread. +It is made concurrency-safe since a global instance of the type is allocated in tast.fs.

    + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ModuleDescription
    + Ast + + +
    + ErrorLogger + + +
    + Layout + + +
    + PrettyNaming + +

    Anything to do with special names of identifiers and other lexical rules

    + + +
    + QuickParse + +

    Methods for cheaply and inaccurately parsing F#.

    +

    These methods are very old and are mostly to do with extracting "long identifier islands" +A.B.C +from F# source code, an approach taken from pre-F# VS samples for implementing intelliense.

    +

    This code should really no longer be needed since the language service has access to +parsed F# source code ASTs. However, the long identifiers are still passed back to GetDeclarations and friends in the +F# Compiler Service and it's annoyingly hard to remove their use completely.

    +

    In general it is unlikely much progress will be made by fixing this code - it will be better to +extract more information from the F# ASTs.

    +

    It's also surprising how hard even the job of getting long identifier islands can be. For example the code +below is inaccurate for long identifier chains involving ... identifiers. And there are special cases +for active pattern names and so on.

    + + +
    + Range + + +
    + ReferenceResolver + + +
    + +
    +

    FSharp.Compiler.AbstractIL Namespace

    +
    + + + + + + + + + + + + + + +
    ModuleDescription
    + IL + +

    The "unlinked" view of .NET metadata and code. Central to the Abstract IL library

    + + +
    + ILBinaryReader + +

    Binary reader. Read a .NET binary and concert it to Abstract IL data +structures.

    +

    NOTE: +- The metadata in the loaded modules will be relative to +those modules, e.g. ILScopeRef.Local will mean "local to +that module". You must use [rescopeILType] etc. if you want to include +(i.e. copy) the metadata into your own module.

    +
      +
    • +

      PDB (debug info) reading/folding: +The PDB reader is invoked if you give a PDB path +This indicates if you want to search for PDB files and have the +reader fold them in. You cannot currently name the pdb file +directly - you can only name the path. Giving "None" says +"do not read the PDB file even if one exists".

      +

      The debug info appears primarily as I_seqpoint annotations in +the instruction streams. Unfortunately the PDB information does +not, for example, tell you how to map back from a class definition +to a source code line number - you will need to explicitly search +for a sequence point in the code for one of the methods of the +class. That is not particularly satisfactory, and it may be +a good idea to build a small library which extracts the information +you need.

      +
      • +
    + + +
    + +
    +

    FSharp.Compiler.AbstractIL.Internal Namespace

    +
    + + + + + + + + + + + + + + +
    ModuleDescription
    + Library + + +
    + Utils + + +
    + +
    +

    FSharp.Compiler.Interactive Namespace

    +
    + + + + + + + + + + +
    ModuleDescription
    + Shell + + +
    + +
    +

    FSharp.Compiler.SourceCodeServices Namespace

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + AssemblyContentType + +

    Assembly content type.

    + + +
    + AssemblyPath + +

    Assembly path.

    + + +
    + AssemblySymbol + +

    Represents type, module, member, function or value in a compiled assembly.

    + + +
    + CompilerEnvironment + +

    Information about the compilation environment

    + + +
    + CompletionContext + + +
    + CompletionItemKind + + +
    + CompletionPath + + +
    + Entity + +

    Helper data structure representing a symbol, suitable for implementing unresolved identifiers resolution code fixes.

    + + +
    + EntityCache + +

    Thread safe wrapper over IAssemblyContentCache.

    + + +
    + EntityKind + + +
    + ExternalSymbol + +

    Represents a symbol in an external (non F#) assembly

    + + +
    + ExternalType + +

    Represents a type in an external (non F#) assembly.

    + + +
    + FSharpAbstractParameter + +

    Represents a parameter in an abstract method of a class or interface

    + + +
    + FSharpAbstractSignature + +

    Represents the signature of an abstract slot of a class or interface

    + + +
    + FSharpAccessibility + +

    Indicates the accessibility of a symbol, as seen by the F# language

    + + +
    + FSharpAccessibilityRights + +

    Represents the rights of a compilation to access symbols

    + + +
    + FSharpActivePatternCase + +

    A subtype of FSharpSymbol that represents a single case within an active pattern

    + + +
    + FSharpActivePatternGroup + +

    Represents all cases within an active pattern

    + + +
    + FSharpAnonRecordTypeDetails + +

    A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language

    + + +
    + FSharpAssembly + +

    Represents an assembly as seen by the F# language

    + + +
    + FSharpAssemblyContents + +

    Represents the definitional contents of an assembly, as seen by the F# language

    + + +
    + FSharpAssemblySignature + +

    Represents an inferred signature of part of an assembly as seen by the F# language

    + + +
    + FSharpAttribute + +

    Represents a custom attribute attached to F# source code or a compiler .NET component

    + + +
    + FSharpCheckFileAnswer + +

    The result of calling TypeCheckResult including the possibility of abort and background compiler not caught up.

    + + +
    + FSharpCheckFileResults + +

    A handle to the results of CheckFileInProject.

    + + +
    + FSharpCheckProjectResults + +

    A handle to the results of CheckFileInProject.

    + + +
    + FSharpChecker + +

    Used to parse and check F# source code.

    + + +
    + FSharpDeclarationListInfo + +

    Represents a set of declarations in F# source code, with information attached ready for display by an editor. +Returned by GetDeclarations.

    + + +
    + FSharpDeclarationListItem + +

    Represents a declaration in F# source code, with information attached ready for display by an editor. +Returned by GetDeclarations.

    + + +
    + FSharpDelegateSignature + +

    Represents a delegate signature in an F# symbol

    + + +
    + FSharpDisplayContext + +

    Represents the information needed to format types and other information in a style +suitable for use in F# source text at a particular source location.

    +

    Acquired via GetDisplayEnvAtLocationAlternate and similar methods. May be passed +to the Format method on FSharpType and other methods.

    + + +
    + FSharpEnclosingEntityKind + + +
    + FSharpEntity + +

    A subtype of FSharpSymbol that represents a type definition or module as seen by the F# language

    + + +
    + FSharpErrorInfo + + +
    + FSharpErrorSeverity + + +
    + FSharpExpr + +

    Represents a checked and reduced expression, as seen by the F# language. The active patterns +in 'FSharp.Compiler.SourceCodeServices' can be used to analyze information about the expression.

    +

    Pattern matching is reduced to decision trees and conditional tests. Some other +constructs may be represented in reduced form.

    + + +
    + FSharpField + +

    A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language

    + + +
    + FSharpFindDeclFailureReason + +

    Represents the reason why the GetDeclarationLocation operation failed.

    + + +
    + FSharpFindDeclResult + +

    Represents the result of the GetDeclarationLocation operation.

    + + +
    + FSharpGenericParameter + +

    A subtype of FSharpSymbol that represents a generic parameter for an FSharpSymbol

    + + +
    + FSharpGenericParameterConstraint + +

    Represents a constraint on a generic type parameter

    + + +
    + FSharpGenericParameterDefaultsToConstraint + +

    Represents further information about a 'defaults to' constraint on a generic type parameter

    + + +
    + FSharpGenericParameterDelegateConstraint + +

    Represents further information about a delegate constraint on a generic type parameter

    + + +
    + FSharpGenericParameterMemberConstraint + +

    Represents further information about a member constraint on a generic type parameter

    + + +
    + FSharpGlyph + + +
    + FSharpImplementationFileContents + +

    Represents the definitional contents of a single file or fragment in an assembly, as seen by the F# language

    + + +
    + FSharpImplementationFileDeclaration + +

    Represents a declaration in an implementation file, as seen by the F# language

    + + +
    + FSharpInlineAnnotation + + +
    + FSharpLineTokenizer + +

    Object to tokenize a line of F# source code, starting with the given lexState. The lexState should be FSharpTokenizerLexState.Initial for +the first line of text. Returns an array of ranges of the text and two enumerations categorizing the +tokens and characters covered by that range, i.e. FSharpTokenColorKind and FSharpTokenCharKind. The enumerations +are somewhat adhoc but useful enough to give good colorization options to the user in an IDE.

    +

    A new lexState is also returned. An IDE-plugin should in general cache the lexState +values for each line of the edited code.

    + + +
    + FSharpMemberOrFunctionOrValue + +

    A subtype of F# symbol that represents an F# method, property, event, function or value, including extension members.

    + + +
    + FSharpMethodGroup + +

    Represents a group of methods (or other items) returned by GetMethods.

    + + +
    + FSharpMethodGroupItem + +

    Represents one method (or other item) in a method group. The item may represent either a method or +a single, non-overloaded item such as union case or a named function value.

    + + +
    + FSharpMethodGroupItemParameter + +

    Represents one parameter for one method (or other item) in a group.

    + + +
    + FSharpNavigationDeclarationItem + +

    Represents an item to be displayed in the navigation bar

    + + +
    + FSharpNavigationDeclarationItemKind + +

    Indicates a kind of item to show in an F# navigation bar

    + + +
    + FSharpNavigationItems + +

    Represents result of 'GetNavigationItems' operation - this contains +all the members and currently selected indices. First level correspond to +types & modules and second level are methods etc.

    + + +
    + FSharpNavigationTopLevelDeclaration + +

    Represents top-level declarations (that should be in the type drop-down) +with nested declarations (that can be shown in the member drop-down)

    + + +
    + FSharpNoteworthyParamInfoLocations + +

    Represents the locations relevant to activating parameter info in an IDE

    + + +
    + FSharpObjectExprOverride + +

    Represents a checked method in an object expression, as seen by the F# language.

    + + +
    + FSharpOpenDeclaration + +

    Represents open declaration in F# code.

    + + +
    + FSharpParameter + +

    A subtype of FSharpSymbol that represents a parameter

    + + +
    + FSharpParseFileResults + +

    Represents the results of parsing an F# file

    + + +
    + FSharpParsingOptions + +

    Options used to determine active --define conditionals and other options relevant to parsing files in a project

    + + +
    + FSharpProjectContext + +

    Represents the checking context implied by the ProjectOptions

    + + +
    + FSharpProjectOptions + +

    A set of information describing a project or script build configuration.

    + + +
    + FSharpSourceTokenizer + +

    Tokenizer for a source file. Holds some expensive-to-compute resources at the scope of the file.

    + + +
    + FSharpStaticParameter + +

    A subtype of FSharpSymbol that represents a static parameter to an F# type provider

    + + +
    + FSharpStructuredToolTipElement + +

    A single data tip display element with where text is expressed as

    + + +
    + FSharpStructuredToolTipText + + +
    + FSharpSymbol + +

    Represents a symbol in checked F# source code or a compiled .NET component.

    +

    The subtype of the symbol may reveal further information and can be one of FSharpEntity, FSharpUnionCase +FSharpField, FSharpGenericParameter, FSharpStaticParameter, FSharpMemberOrFunctionOrValue, FSharpParameter, +or FSharpActivePatternCase.

    + + +
    + FSharpSymbolUse + +

    Represents the use of an F# symbol from F# source code

    + + +
    + FSharpTokenCharKind + +

    Gives an indication of the class to assign to the characters of the token an IDE

    + + +
    + FSharpTokenColorKind + +

    Gives an indication of the color class to assign to the token an IDE

    + + +
    + FSharpTokenInfo + +

    Information about a particular token from the tokenizer

    + + +
    + FSharpTokenTriggerClass + +

    Gives an indication of what should happen when the token is typed in an IDE

    + + +
    + FSharpTokenizerColorState + +

    Represents stable information for the state of the lexing engine at the end of a line

    + + +
    + FSharpTokenizerLexState + +

    Represents encoded information for the end-of-line continuation of lexing

    + + +
    + FSharpToolTipElement<'T> + +

    A single tool tip display element

    + + +
    + FSharpToolTipElement + +

    A single data tip display element with where text is expressed as string

    + + +
    + FSharpToolTipElementData<'T> + +

    A single data tip display element

    + + +
    + FSharpToolTipText<'T> + +

    Information for building a tool tip box.

    + + +
    + FSharpToolTipText + + +
    + FSharpType + + +
    + FSharpUnionCase + +

    A subtype of FSharpSymbol that represents a union case as seen by the F# language

    + + +
    + FSharpXmlDoc + +

    Describe a comment as either a block of text or a file+signature reference into an intellidoc file.

    + + +
    + IAssemblyContentCache + +

    Assembly content cache.

    + + +
    + Idents + +

    An array of ShortIdent.

    + + +
    + InheritanceContext + + +
    + InsertContext + +

    Insert open namespace context.

    + + +
    + InterfaceData + +

    Capture information about an interface in ASTs

    + + +
    + Layout + + +
    + LookupType + +

    Entity lookup type.

    + + +
    + MaybeUnresolvedIdent + +

    ShortIdent with a flag indicating if it's resolved in some scope.

    + + +
    + MaybeUnresolvedIdents + +

    Array of MaybeUnresolvedIdent.

    + + +
    + ModuleKind + + +
    + OpenStatementInsertionPoint + +

    Where open statements should be added.

    + + +
    + ParamTypeSymbol + +

    Represents the type of a single method parameter

    + + +
    + Position + + +
    + Range + + +
    + RecordContext + + +
    + ScopeKind + +

    Kind of lexical scope.

    + + +
    + SemanticClassificationType + + +
    + ShortIdent + +

    Short identifier, i.e. an identifier that contains no dots.

    + + +
    + StringLongIdent + +

    Long identifier (i.e. it may contain dots).

    + + +
    + UnresolvedReferencesSet + +

    Unused in this API

    + + +
    + UnresolvedSymbol + + +
    + XmlDocable + +

    Represent an Xml documentation block in source code

    + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ModuleDescription
    + AssemblyContentProvider + +

    Provides assembly content.

    + + +
    + AstTraversal + +

    A range of utility functions to assist with traversing an AST

    + + +
    + BasicPatterns + +

    A collection of active patterns to analyze expressions

    + + +
    + CompilerEnvironment + +

    Information about the compilation environment

    + + +
    + DebuggerEnvironment + +

    Information about the debugging environment

    + + +
    + Extensions + + +
    + ExternalType + + +
    + FSharpFileUtilities + +

    A set of helpers for dealing with F# files.

    + + +
    + FSharpNavigation + + +
    + FSharpTokenTag + +

    Some of the values in the field FSharpTokenInfo.Tag

    + + +
    + InterfaceStubGenerator + + +
    + Keywords + + +
    + NavigateTo + + +
    + ParamTypeSymbol + + +
    + ParsedInput + +

    Parse AST helpers.

    + + +
    + PrettyNaming + +

    A set of helpers related to naming of identifiers

    + + +
    + SimplifyNames + + +
    + SourceFile + +

    Information about F# source file names

    + + +
    + Structure + + +
    + Symbol + +

    Patterns over FSharpSymbol and derivatives.

    + + +
    + Tooltips + + +
    + UntypedParseImpl + + +
    + UnusedDeclarations + + +
    + UnusedOpens + + +
    + XmlDocComment + + +
    + XmlDocParser + + +
    + +
    +

    FSharp.Compiler.Text Namespace

    +
    + + + + + + + + + + +
    TypeDescription
    + ISourceText + + +
    + + + + + + + + + + +
    ModuleDescription
    + SourceText + + +
    + +
    +

    Internal.Utilities Namespace

    +
    + + + + + + + + + + +
    TypeDescription
    + PathMap + + +
    + +
    +

    Internal.Utilities.StructuredFormat Namespace

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + FormatOptions + +

    A record of options to control structural formatting. +For F# Interactive properties matching those of this value can be accessed via the 'fsi' +value.

    +

    Floating Point format given in the same format accepted by System.Double.ToString, +e.g. f6 or g15.

    +

    If ShowProperties is set the printing process will evaluate properties of the values being +displayed. This may cause additional computation.

    +

    The ShowIEnumerable is set the printing process will force the evaluation of IEnumerable objects +to a small, finite depth, as determined by the printing parameters. +This may lead to additional computation being performed during printing.

    + +From F# Interactive the default settings can be adjusted using, for example, +
    +  open FSharp.Compiler.Interactive.Settings;;
+  setPrintWidth 120;;
+
    +     + + +
    + IEnvironment + + +
    + Joint + +

    Data representing joints in structured layouts of terms. The representation +of this data type is only for the consumption of formatting engines.

    + + +
    + Layout + +

    Data representing structured layouts of terms. The representation +of this data type is only for the consumption of formatting engines.

    + + +
    + LayoutTag + + +
    + TaggedText + + +
    + TaggedTextWriter + + +
    + + + + + + + + + + + + + + + + + + +
    ModuleDescription
    + Display + + +
    + LayoutOps + +

    A layout is a sequence of strings which have been joined together. +The strings are classified as words, separators and left and right parenthesis. +This classification determines where spaces are inserted. +A joint is either unbreakable, breakable or broken. +If a joint is broken the RHS layout occurs on the next line with optional indentation. +A layout can be squashed to for given width which forces breaks as required.

    + + +
    + TaggedTextOps + + +
    + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-pathmap.html b/docs/reference/internal-utilities-pathmap.html new file mode 100644 index 0000000000..245a87a23f --- /dev/null +++ b/docs/reference/internal-utilities-pathmap.html @@ -0,0 +1,93 @@ + + + + + PathMap - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    PathMap

    +

    + + Namespace: Internal.Utilities
    +

    +
    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-display.html b/docs/reference/internal-utilities-structuredformat-display.html new file mode 100644 index 0000000000..4556387369 --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-display.html @@ -0,0 +1,253 @@ + + + + + Display - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Display

    +

    + Namespace: Internal.Utilities.StructuredFormat
    +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + any_to_layout options (value, arg3) + +
    + Signature: options:FormatOptions -> (value:'T * Type) -> Layout
    + Type parameters: 'T
    +     		+ +
    + + any_to_string(value, arg2) + +
    + Signature: (value:'T * Type) -> string
    + Type parameters: 'T
    +     		+

    Convert any value to a string using a standard formatter +Data is typically formatted in a structured format, e.g. +lists are formatted using the "[1;2]" notation. +The details of the format are not specified and may change +from version to version and according to the flags given +to the F# compiler. The format is intended to be human-readable, +not machine readable. If alternative generic formats are required +you should develop your own formatter, using the code in the +implementation of this file as a starting point.

    +

    Data from other .NET languages is formatted using a virtual +call to Object.ToString() on the boxed version of the input.

    + + +
    + + asTaggedTextWriter(writer) + +
    + Signature: writer:TextWriter -> TaggedTextWriter
    +
    +     		+ +
    + + fsi_any_to_layout options (value, arg3) + +
    + Signature: options:FormatOptions -> (value:'T * Type) -> Layout
    + Type parameters: 'T
    +     		+ +
    + + layout_as_string options (value, arg3) + +
    + Signature: options:FormatOptions -> (value:'T * Type) -> string
    + Type parameters: 'T
    +     		+ +
    + + layout_to_string options layout + +
    + Signature: options:FormatOptions -> layout:Layout -> string
    +
    +     		+

    Convert any value to a layout using the given formatting options. The +layout can then be processed using formatting display engines such as +those in the LayoutOps module. anytostring and outputany are +built using anyto_layout with default format options.

    + + +
    + + output_any writer (value, arg3) + +
    + Signature: writer:TextWriter -> (value:'T * Type) -> unit
    + Type parameters: 'T
    +     		+

    Output any value to a channel using the same set of formatting rules +as anytostring

    + + +
    + + output_layout options writer layout + +
    + Signature: options:FormatOptions -> writer:TextWriter -> layout:Layout -> unit
    +
    +     		+ +
    + + output_layout_tagged(...) + +
    + Signature: options:FormatOptions -> writer:TaggedTextWriter -> layout:Layout -> unit
    +
    +     		+ +
    + + squash_layout options layout + +
    + Signature: options:FormatOptions -> layout:Layout -> Layout
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-formatoptions.html b/docs/reference/internal-utilities-structuredformat-formatoptions.html new file mode 100644 index 0000000000..27518718af --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-formatoptions.html @@ -0,0 +1,303 @@ + + + + + FormatOptions - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    FormatOptions

    +

    + + Namespace: Internal.Utilities.StructuredFormat
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    A record of options to control structural formatting. +For F# Interactive properties matching those of this value can be accessed via the 'fsi' +value.

    +

    Floating Point format given in the same format accepted by System.Double.ToString, +e.g. f6 or g15.

    +

    If ShowProperties is set the printing process will evaluate properties of the values being +displayed. This may cause additional computation.

    +

    The ShowIEnumerable is set the printing process will force the evaluation of IEnumerable objects +to a small, finite depth, as determined by the printing parameters. +This may lead to additional computation being performed during printing.

    + +From F# Interactive the default settings can be adjusted using, for example, +
    +  open FSharp.Compiler.Interactive.Settings;;
+  setPrintWidth 120;;
+
    +     + +
    +

    Record Fields

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Record FieldDescription
    + + AttributeProcessor + +
    + Signature: string -> (string * string) list -> bool -> unit
    +
    +     		+ +
    + + BindingFlags + +
    + Signature: BindingFlags
    +
    +     		+ +
    + + FloatingPointFormat + +
    + Signature: string
    +
    +     		+ +
    + + FormatProvider + +
    + Signature: IFormatProvider
    +
    +     		+ +
    + + PrintDepth + +
    + Signature: int
    +
    +     		+ +
    + + PrintIntercepts + +
    + Signature: (IEnvironment -> obj -> Layout option) list
    +
    +     		+ +
    + + PrintLength + +
    + Signature: int
    +
    +     		+ +
    + + PrintSize + +
    + Signature: int
    +
    +     		+ +
    + + PrintWidth + +
    + Signature: int
    +
    +     		+ +
    + + ShowIEnumerable + +
    + Signature: bool
    +
    +     		+ +
    + + ShowProperties + +
    + Signature: bool
    +
    +     		+ +
    + + StringLimit + +
    + Signature: int
    +
    +     		+ +
    +

    Static members

    + + + + + + + + + + +
    Static memberDescription
    + + FormatOptions.Default + +
    + Signature: FormatOptions
    +
    +     		+ +

    CompiledName: get_Default

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-ienvironment.html b/docs/reference/internal-utilities-structuredformat-ienvironment.html new file mode 100644 index 0000000000..0a3a069bc4 --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-ienvironment.html @@ -0,0 +1,155 @@ + + + + + IEnvironment - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    IEnvironment

    +

    + + Namespace: Internal.Utilities.StructuredFormat
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.GetLayout(arg1) + +
    + Signature: obj -> Layout
    + Modifiers: abstract
    +
    +     		+

    Return to the layout-generation +environment to layout any otherwise uninterpreted object

    + + +
    + + x.MaxColumns + +
    + Signature: int
    + Modifiers: abstract
    +
    +     		+

    The maximum number of elements for which to generate layout for +list-like structures, or columns in table-like +structures. -1 if no maximum.

    + + +

    CompiledName: get_MaxColumns

    +
    + + x.MaxRows + +
    + Signature: int
    + Modifiers: abstract
    +
    +     		+

    The maximum number of rows for which to generate layout for table-like +structures. -1 if no maximum.

    + + +

    CompiledName: get_MaxRows

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-joint.html b/docs/reference/internal-utilities-structuredformat-joint.html new file mode 100644 index 0000000000..5d5c420bc6 --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-joint.html @@ -0,0 +1,149 @@ + + + + + Joint - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Joint

    +

    + + Namespace: Internal.Utilities.StructuredFormat
    + + Attributes:
    +[<StructuralEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Data representing joints in structured layouts of terms. The representation +of this data type is only for the consumption of formatting engines.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Breakable(int) + +
    + Signature: int
    +
    +     		+ +
    + + Broken(int) + +
    + Signature: int
    +
    +     		+ +
    + + Unbreakable + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-layout.html b/docs/reference/internal-utilities-structuredformat-layout.html new file mode 100644 index 0000000000..41a7c9d2f3 --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-layout.html @@ -0,0 +1,162 @@ + + + + + Layout - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Layout

    +

    + + Namespace: Internal.Utilities.StructuredFormat
    + + Attributes:
    +[<NoEquality>]
    +[<NoComparison>]
    + +     +

    +
    +

    Data representing structured layouts of terms. The representation +of this data type is only for the consumption of formatting engines.

    + +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + Attr(...) + +
    + Signature: string * (string * string) list * Layout
    +
    +     		+ +
    + + Leaf(bool,TaggedText,bool) + +
    + Signature: bool * TaggedText * bool
    +
    +     		+ +
    + + Node(bool,Layout,bool,Layout,bool,Joint) + +
    + Signature: bool * Layout * bool * Layout * bool * Joint
    +
    +     		+ +
    + + ObjLeaf(bool,obj,bool) + +
    + Signature: bool * obj * bool
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-layoutops.html b/docs/reference/internal-utilities-structuredformat-layoutops.html new file mode 100644 index 0000000000..94cb2b6223 --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-layoutops.html @@ -0,0 +1,541 @@ + + + + + LayoutOps - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LayoutOps

    +

    + Namespace: Internal.Utilities.StructuredFormat
    +

    +
    +

    A layout is a sequence of strings which have been joined together. +The strings are classified as words, separators and left and right parenthesis. +This classification determines where spaces are inserted. +A joint is either unbreakable, breakable or broken. +If a joint is broken the RHS layout occurs on the next line with optional indentation. +A layout can be squashed to for given width which forces breaks as required.

    + +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + ( -- ) layout1 layout2 + +
    + Signature: layout1:Layout -> layout2:Layout -> Layout
    +
    +     		+

    Join, possible break with indent=1

    + + +

    CompiledName: op_MinusMinus

    +
    + + ( --- ) layout1 layout2 + +
    + Signature: layout1:Layout -> layout2:Layout -> Layout
    +
    +     		+

    Join, possible break with indent=2

    + + +

    CompiledName: op_MinusMinusMinus

    +
    + + ( @@ ) layout1 layout2 + +
    + Signature: layout1:Layout -> layout2:Layout -> Layout
    +
    +     		+

    Join broken with ident=0

    + + +

    CompiledName: op_AtAt

    +
    + + ( @@- ) layout1 layout2 + +
    + Signature: layout1:Layout -> layout2:Layout -> Layout
    +
    +     		+

    Join broken with ident=1

    + + +

    CompiledName: op_AtAtMinus

    +
    + + ( @@-- ) layout1 layout2 + +
    + Signature: layout1:Layout -> layout2:Layout -> Layout
    +
    +     		+

    Join broken with ident=2

    + + +

    CompiledName: op_AtAtMinusMinus

    +
    + + ( ^^ ) layout1 layout2 + +
    + Signature: layout1:Layout -> layout2:Layout -> Layout
    +
    +     		+

    Join, unbreakable.

    + + +

    CompiledName: op_HatHat

    +
    + + ( ++ ) layout1 layout2 + +
    + Signature: layout1:Layout -> layout2:Layout -> Layout
    +
    +     		+

    Join, possible break with indent=0

    + + +

    CompiledName: op_PlusPlus

    +
    + + aboveL layout1 layout2 + +
    + Signature: layout1:Layout -> layout2:Layout -> Layout
    +
    +     		+

    Layout two vertically.

    + + +
    + + aboveListL(layouts) + +
    + Signature: layouts:Layout list -> Layout
    +
    +     		+

    Layout list vertically.

    + + +
    + + braceL(layout) + +
    + Signature: layout:Layout -> Layout
    +
    +     		+

    Wrap braces around layout.

    + + +
    + + bracketL(layout) + +
    + Signature: layout:Layout -> Layout
    +
    +     		+

    Wrap round brackets around Layout.

    + + +
    + + commaListL(layouts) + +
    + Signature: layouts:Layout list -> Layout
    +
    +     		+

    Join layouts into a comma separated list.

    + + +
    + + emptyL + +
    + Signature: Layout
    +
    +     		+

    The empty layout

    + + +
    + + isEmptyL(layout) + +
    + Signature: layout:Layout -> bool
    +
    +     		+

    Is it the empty layout?

    + + +
    + + leftL(text) + +
    + Signature: text:TaggedText -> Layout
    +
    +     		+

    An string which is left parenthesis (no space on the right).

    + + +
    + + listL selector value + +
    + Signature: selector:('T -> Layout) -> value:'T list -> Layout
    + Type parameters: 'T
    +     		+

    Layout like an F# list.

    + + +
    + + objL(value) + +
    + Signature: value:obj -> Layout
    +
    +     		+

    An uninterpreted leaf, to be interpreted into a string +by the layout engine. This allows leaf layouts for numbers, strings and +other atoms to be customized according to culture.

    + + +
    + + optionL selector value + +
    + Signature: selector:('T -> Layout) -> value:'T option -> Layout
    + Type parameters: 'T
    +     		+

    Layout like an F# option.

    + + +
    + + rightL(text) + +
    + Signature: text:TaggedText -> Layout
    +
    +     		+

    An string which is right parenthesis (no space on the left).

    + + +
    + + semiListL(layouts) + +
    + Signature: layouts:Layout list -> Layout
    +
    +     		+

    Join layouts into a semi-colon separated list.

    + + +
    + + sepL(text) + +
    + Signature: text:TaggedText -> Layout
    +
    +     		+

    An string which requires no spaces either side.

    + + +
    + + sepListL layout1 layouts + +
    + Signature: layout1:Layout -> layouts:Layout list -> Layout
    +
    +     		+

    Join layouts into a list separated using the given Layout.

    + + +
    + + spaceListL(layouts) + +
    + Signature: layouts:Layout list -> Layout
    +
    +     		+

    Join layouts into a space separated list.

    + + +
    + + squareBracketL(layout) + +
    + Signature: layout:Layout -> Layout
    +
    +     		+

    Wrap square brackets around layout.

    + + +
    + + tagAttrL text maps layout + +
    + Signature: text:string -> maps:(string * string) list -> layout:Layout -> Layout
    +
    +     		+

    See tagL

    + + +
    + + tupleL(layouts) + +
    + Signature: layouts:Layout list -> Layout
    +
    +     		+

    Form tuple of layouts.

    + + +
    + + unfoldL selector folder state count + +
    + Signature: selector:('T -> Layout) -> folder:('State -> ('T * 'State) option) -> state:'State -> count:int -> Layout list
    + Type parameters: 'T, 'State
    +     		+

    For limiting layout of list-like sequences (lists,arrays,etc). +unfold a list of items using (project and z) making layout list via itemL. +If reach maxLength (before exhausting) then truncate.

    + + +
    + + wordL(text) + +
    + Signature: text:TaggedText -> Layout
    +
    +     		+

    An string leaf

    + + +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-layouttag.html b/docs/reference/internal-utilities-structuredformat-layouttag.html new file mode 100644 index 0000000000..f624278c4f --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-layouttag.html @@ -0,0 +1,536 @@ + + + + + LayoutTag - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    LayoutTag

    +

    + + Namespace: Internal.Utilities.StructuredFormat
    + + Attributes:
    +[<StructuralEquality>]
    +[<NoComparison>]
    + +     +

    +
    +
    +

    Union Cases

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Union CaseDescription
    + + ActivePatternCase + +
    + Signature:
    +
    +     		+ +
    + + ActivePatternResult + +
    + Signature:
    +
    +     		+ +
    + + Alias + +
    + Signature:
    +
    +     		+ +
    + + Class + +
    + Signature:
    +
    +     		+ +
    + + Delegate + +
    + Signature:
    +
    +     		+ +
    + + Enum + +
    + Signature:
    +
    +     		+ +
    + + Event + +
    + Signature:
    +
    +     		+ +
    + + Field + +
    + Signature:
    +
    +     		+ +
    + + Interface + +
    + Signature:
    +
    +     		+ +
    + + Keyword + +
    + Signature:
    +
    +     		+ +
    + + LineBreak + +
    + Signature:
    +
    +     		+ +
    + + Local + +
    + Signature:
    +
    +     		+ +
    + + Member + +
    + Signature:
    +
    +     		+ +
    + + Method + +
    + Signature:
    +
    +     		+ +
    + + Module + +
    + Signature:
    +
    +     		+ +
    + + ModuleBinding + +
    + Signature:
    +
    +     		+ +
    + + Namespace + +
    + Signature:
    +
    +     		+ +
    + + NumericLiteral + +
    + Signature:
    +
    +     		+ +
    + + Operator + +
    + Signature:
    +
    +     		+ +
    + + Parameter + +
    + Signature:
    +
    +     		+ +
    + + Property + +
    + Signature:
    +
    +     		+ +
    + + Punctuation + +
    + Signature:
    +
    +     		+ +
    + + Record + +
    + Signature:
    +
    +     		+ +
    + + RecordField + +
    + Signature:
    +
    +     		+ +
    + + Space + +
    + Signature:
    +
    +     		+ +
    + + StringLiteral + +
    + Signature:
    +
    +     		+ +
    + + Struct + +
    + Signature:
    +
    +     		+ +
    + + Text + +
    + Signature:
    +
    +     		+ +
    + + TypeParameter + +
    + Signature:
    +
    +     		+ +
    + + Union + +
    + Signature:
    +
    +     		+ +
    + + UnionCase + +
    + Signature:
    +
    +     		+ +
    + + UnknownEntity + +
    + Signature:
    +
    +     		+ +
    + + UnknownType + +
    + Signature:
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-taggedtext.html b/docs/reference/internal-utilities-structuredformat-taggedtext.html new file mode 100644 index 0000000000..99d4bb0677 --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-taggedtext.html @@ -0,0 +1,131 @@ + + + + + TaggedText - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    TaggedText

    +

    + + Namespace: Internal.Utilities.StructuredFormat
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Tag + +
    + Signature: LayoutTag
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_Tag

    +
    + + x.Text + +
    + Signature: string
    + Modifiers: abstract
    +
    +     		+ +

    CompiledName: get_Text

    +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-taggedtextops-literals.html b/docs/reference/internal-utilities-structuredformat-taggedtextops-literals.html new file mode 100644 index 0000000000..c40f75c23e --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-taggedtextops-literals.html @@ -0,0 +1,299 @@ + + + + + Literals - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    Literals

    +

    + Namespace: Internal.Utilities.StructuredFormat
    + Parent Module: TaggedTextOps +

    +
    +
    + + + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + arrow + +
    + Signature: TaggedText
    +
    +     		+ +
    + + comma + +
    + Signature: TaggedText
    +
    +     		+ +
    + + equals + +
    + Signature: TaggedText
    +
    +     		+ +
    + + leftBrace + +
    + Signature: TaggedText
    +
    +     		+ +
    + + leftBraceBar + +
    + Signature: TaggedText
    +
    +     		+ +
    + + leftBracket + +
    + Signature: TaggedText
    +
    +     		+ +
    + + leftParen + +
    + Signature: TaggedText
    +
    +     		+ +
    + + lineBreak + +
    + Signature: TaggedText
    +
    +     		+ +
    + + questionMark + +
    + Signature: TaggedText
    +
    +     		+ +
    + + rightBrace + +
    + Signature: TaggedText
    +
    +     		+ +
    + + rightBraceBar + +
    + Signature: TaggedText
    +
    +     		+ +
    + + rightBracket + +
    + Signature: TaggedText
    +
    +     		+ +
    + + rightParen + +
    + Signature: TaggedText
    +
    +     		+ +
    + + semicolon + +
    + Signature: TaggedText
    +
    +     		+ +
    + + space + +
    + Signature: TaggedText
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-taggedtextops.html b/docs/reference/internal-utilities-structuredformat-taggedtextops.html new file mode 100644 index 0000000000..a8bdc9e523 --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-taggedtextops.html @@ -0,0 +1,499 @@ + + + + + TaggedTextOps - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    TaggedTextOps

    +

    + Namespace: Internal.Utilities.StructuredFormat
    +

    +
    +
    + + +

    Nested types and modules

    +
    + + + + + + + + + + +
    ModuleDescription
    + Literals + + +
    + +
    + +

    Functions and values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Function or valueDescription
    + + keywordFunctions + +
    + Signature: Set<string>
    +
    +     		+ +
    + + tag arg1 arg2 + +
    + Signature: LayoutTag -> string -> TaggedText
    +
    +     		+ +
    + + tagAlias(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagClass(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagDelegate(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagEnum(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagEvent(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagField(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagInterface(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagKeyword(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagLineBreak(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagLocal(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagMethod(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagModule(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagModuleBinding(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagNamespace(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagNumericLiteral(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagOperator(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagParameter(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagProperty(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagPunctuation(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagRecord(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagRecordField(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagSpace(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagStringLiteral(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagStruct(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagText(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagTypeParameter(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + + tagUnionCase(arg1) + +
    + Signature: string -> TaggedText
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/reference/internal-utilities-structuredformat-taggedtextwriter.html b/docs/reference/internal-utilities-structuredformat-taggedtextwriter.html new file mode 100644 index 0000000000..ac80559285 --- /dev/null +++ b/docs/reference/internal-utilities-structuredformat-taggedtextwriter.html @@ -0,0 +1,129 @@ + + + + + TaggedTextWriter - F# Compiler Services + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    + + +

    TaggedTextWriter

    +

    + + Namespace: Internal.Utilities.StructuredFormat
    +

    +
    +
    +

    Instance members

    + + + + + + + + + + + + + + +
    Instance memberDescription
    + + x.Write(t) + +
    + Signature: t:TaggedText -> unit
    + Modifiers: abstract
    +
    +     		+ +
    + + x.WriteLine() + +
    + Signature: unit -> unit
    + Modifiers: abstract
    +
    +     		+ +
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/fcs/.idea/.idea.FSharp.Compiler.Service/.idea/.name b/fcs/.idea/.idea.FSharp.Compiler.Service/.idea/.name new file mode 100644 index 0000000000..ea534d5c8e --- /dev/null +++ b/fcs/.idea/.idea.FSharp.Compiler.Service/.idea/.name @@ -0,0 +1 @@ +FSharp.Compiler.Service \ No newline at end of file diff --git a/fcs/docsrc/tools/generate.fsx b/fcs/docsrc/tools/generate.fsx index 785ab9028e..404ce6ea17 100644 --- a/fcs/docsrc/tools/generate.fsx +++ b/fcs/docsrc/tools/generate.fsx @@ -6,11 +6,8 @@ #r "paket: groupref generate //" #load "./.fake/generate.fsx/intellisense.fsx" - // Binaries that have XML documentation (in a corresponding generated XML file) -let referenceBinaries = [ "FSharp.Compiler.Service.dll" ] -// Web site location for the generated documentation -let website = "https://fsharp.github.io/FSharp.Compiler.Service" +let referenceBinaries = [ "../../../artifacts/bin/fcs/Release/net461/FSharp.Compiler.Service.dll" ] // Specify more information about your project let info = @@ -24,12 +21,9 @@ let info = // For typical project, no changes are needed below // -------------------------------------------------------------------------------------- -open Fake -open System.IO open Fake.IO.FileSystemOperators open Fake.IO open Fake.Core -open FSharp.Literate open FSharp.Formatting.Razor let root = "." @@ -40,7 +34,7 @@ let content = __SOURCE_DIRECTORY__ @@ "../content" let output = __SOURCE_DIRECTORY__ @@ "../../../docs" let files = __SOURCE_DIRECTORY__ @@ "../files" let templates = __SOURCE_DIRECTORY__ @@ "templates" -let formatting = @"C:\Users\nojaf\.nuget\packages\fsharp.formatting\4.0.0-alpha03" // "__SOURCE_DIRECTORY__ @@ "../../packages/FSharp.Formatting/" +let formatting = __SOURCE_DIRECTORY__ @@ "../../packages/generate/FSharp.Formatting" let docTemplate = formatting @@ "templates/docpage.cshtml" // Where to look for *.csproj templates (in this order) @@ -57,10 +51,6 @@ let copyFiles () = Shell.copyRecursive (formatting @@ "styles") (output @@ "content") true |> Trace.tracefn "Copying styles and scripts: %A" -let clr = Path.GetDirectoryName(typeof.Assembly.Location) //System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory() -printfn "CLR: %s" clr -let fsfmt = @"C:\Users\nojaf\.nuget\packages\fsharp.formatting\4.0.0-alpha03\lib\netstandard2.0" // __SOURCE_DIRECTORY__ @@ ".." @@ ".." @@ @"packages" @@ "FSharp.Formatting" @@ "lib" @@ "net40" - // Build API reference from XML comments let buildReference () = Shell.cleanDir (output @@ "reference") @@ -69,46 +59,7 @@ let buildReference () = ( bin @@ lib, output @@ "reference", layoutRoots, parameters = ("root", root)::info, sourceRepo = "https://github.com/fsharp/FSharp.Compiler.Service/tree/master/src", - sourceFolder = @"..\..\..\src", - assemblyReferences = - [clr @@ "System.Runtime.dll" - clr @@ "System.dll" - clr @@ "System.Core.dll" - clr @@ "Microsoft.CSharp.dll" - clr @@ "System.Linq.dll" - // clr @@ "System.dll" - clr @@ "System.Reflection.Metadata.dll" - clr @@ "System.Numerics.dll" - clr @@ "System.Collections.Immutable.dll" - clr @@ "System.IO.dll" - clr @@ "mscorlib.dll" - fsfmt @@ "FSharp.MetadataFormat.dll" - fsfmt @@ "RazorEngine.NetCore.dll" - @"C:\Users\nojaf\.nuget\packages\fsharp.core\4.7.0\lib\netstandard2.0\FSharp.Core.dll" - // bin @@ "FSharp.Core.dll" - bin @@ "FSharp.Compiler.Service.dll" -// clr @@ "System.Collections.dll" -// clr @@ "System.Core.dll" -// clr @@ "System.Data.dll" -// clr @@ "System.dll" -// clr @@ "System.Drawing.dll" -// clr @@ "System.IO.dll" -// clr @@ "System.Linq.dll" -// clr @@ "System.Linq.Expressions.dll" -// clr @@ "System.Net.Requests.dll" -// clr @@ "System.Numerics.dll" -// clr @@ "System.Reflection.dll" -// clr @@ "System.Runtime.dll" -// clr @@ "System.Runtime.Numerics.dll" -// clr @@ "System.Threading.dll" -// clr @@ "System.Threading.Tasks.dll" -// clr @@ "System.Web.dll" -// clr @@ "System.Xml.dll" - @"C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App\2.1.13\Microsoft.AspNetCore.dll" - @"C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App\2.1.13\Microsoft.AspNetCore.Razor.dll" - @"C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App\2.1.13\Microsoft.AspNetCore.Razor.Language.dll" - @"C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App\2.1.13\Microsoft.AspNetCore.Razor.Runtime.dll" - ] ) + sourceFolder = @"..\..\..\src") // Build documentation from `fsx` and `md` files in `docsrc/content` let buildDocumentation () = @@ -119,7 +70,7 @@ let buildDocumentation () = layoutRoots = layoutRoots, generateAnchors = true, processRecursive=false ) // Generate -// copyFiles() +copyFiles() buildDocumentation() buildReference() diff --git a/fcs/paket.dependencies b/fcs/paket.dependencies index 42e0952617..6830095076 100644 --- a/fcs/paket.dependencies +++ b/fcs/paket.dependencies @@ -18,8 +18,7 @@ nuget Fake.DotNet.Paket group generate source https://api.nuget.org/v3/index.json - -storage: none +storage: packages framework: netstandard2.0 nuget FSharp.Core @@ -27,4 +26,4 @@ nuget Fake.Core nuget Fake.IO.FileSystem nuget Fake.Core.Trace nuget FSharp.Literate 4.0.0-alpha03 -nuget FSharp.Formatting 4.0.0-alpha03 +nuget FSharp.Formatting 4.0.0-alpha03 \ No newline at end of file diff --git a/fcs/paket.lock b/fcs/paket.lock index d44f49c1d2..919b93838a 100644 --- a/fcs/paket.lock +++ b/fcs/paket.lock @@ -769,26 +769,26 @@ NUGET System.Xml.XPath (>= 4.3) GROUP generate -STORAGE: NONE +STORAGE: PACKAGES RESTRICTION: == netstandard2.0 NUGET remote: https://api.nuget.org/v3/index.json Fake.Core (5.16) - Fake.Core.Context (5.18.3) + Fake.Core.Context (5.19.1) FSharp.Core (>= 4.7) - Fake.Core.Environment (5.18.3) + Fake.Core.Environment (5.19.1) FSharp.Core (>= 4.7) - Fake.Core.FakeVar (5.18.3) - Fake.Core.Context (>= 5.18.3) + Fake.Core.FakeVar (5.19.1) + Fake.Core.Context (>= 5.19.1) FSharp.Core (>= 4.7) - Fake.Core.String (5.18.3) + Fake.Core.String (5.19.1) FSharp.Core (>= 4.7) - Fake.Core.Trace (5.18.3) - Fake.Core.Environment (>= 5.18.3) - Fake.Core.FakeVar (>= 5.18.3) + Fake.Core.Trace (5.19.1) + Fake.Core.Environment (>= 5.19.1) + Fake.Core.FakeVar (>= 5.19.1) FSharp.Core (>= 4.7) - Fake.IO.FileSystem (5.18.3) - Fake.Core.String (>= 5.18.3) + Fake.IO.FileSystem (5.19.1) + Fake.Core.String (>= 5.19.1) FSharp.Core (>= 4.7) System.Diagnostics.FileVersionInfo (>= 4.3) System.IO.FileSystem.Watcher (>= 4.3) @@ -804,6 +804,11 @@ NUGET System.Runtime.Loader (>= 4.0) System.Security.Cryptography.Algorithms (>= 4.3) FSharp.Core (4.7) + FSharp.Formatting (4.0.0-alpha03) + FSharp.Compiler.Service (>= 34.0.1) + FSharp.Literate (4.0.0-alpha03) + FSharp.Compiler.Service (>= 34.0.1) + FSharp.Core (>= 4.7) Microsoft.NETCore.Platforms (3.0) Microsoft.NETCore.Targets (3.0) Microsoft.Win32.Primitives (4.3) @@ -1084,9 +1089,12 @@ NUGET System.Threading.ThreadPool (4.3) System.Runtime (>= 4.3) System.Runtime.Handles (>= 4.3) - remote: C:\Users\nojaf\Projects\FSharp.Formatting\artifacts - FSharp.Formatting (4.0.0-alpha03) - FSharp.Compiler.Service (>= 34.0.1) - FSharp.Literate (4.0.0-alpha03) - FSharp.Compiler.Service (>= 34.0.1) - FSharp.Core (>= 4.7) +GITHUB + remote: fsprojects/FSharp.Formatting + misc/templates/docpage.cshtml (fc3c431dd15605219dc392450f69541700fe5a92) + misc/templates/reference/module.cshtml (fc3c431dd15605219dc392450f69541700fe5a92) + misc/templates/reference/namespaces.cshtml (fc3c431dd15605219dc392450f69541700fe5a92) + misc/templates/reference/part-members.cshtml (fc3c431dd15605219dc392450f69541700fe5a92) + misc/templates/reference/part-nested.cshtml (fc3c431dd15605219dc392450f69541700fe5a92) + misc/templates/reference/type.cshtml (fc3c431dd15605219dc392450f69541700fe5a92) + misc/templates/template.cshtml (fc3c431dd15605219dc392450f69541700fe5a92) \ No newline at end of file From f4e36be34dc14c879c548b83f95ed8b34eb5cc0c Mon Sep 17 00:00:00 2001 From: nojaf Date: Sun, 9 Feb 2020 21:34:29 +0100 Subject: [PATCH 5/7] Added Japanese documentation. --- fcs/.gitignore | 2 +- fcs/docsrc/tools/generate.ja.fsx | 36 +++++++++++++------------------- fcs/paket.dependencies | 1 + 3 files changed, 16 insertions(+), 23 deletions(-) diff --git a/fcs/.gitignore b/fcs/.gitignore index ba316d8d5a..1ae18f2aa0 100644 --- a/fcs/.gitignore +++ b/fcs/.gitignore @@ -10,4 +10,4 @@ FSharp.Compiler.Service.netstandard/pars.fsi FSharp.Compiler.Service.netstandard/pplex.fs FSharp.Compiler.Service.netstandard/pppars.fs FSharp.Compiler.Service.netstandard/pppars.fsi - +.idea/ diff --git a/fcs/docsrc/tools/generate.ja.fsx b/fcs/docsrc/tools/generate.ja.fsx index 96049490fa..a56c9af9f6 100644 --- a/fcs/docsrc/tools/generate.ja.fsx +++ b/fcs/docsrc/tools/generate.ja.fsx @@ -3,6 +3,12 @@ // (the generated documentation is stored in the 'docs' directory) // -------------------------------------------------------------------------------------- +#r "paket: groupref generate //" +#load "./.fake/generate.ja.fsx/intellisense.fsx" + +// Binaries that have XML documentation (in a corresponding generated XML file) +let referenceBinaries = [ "../../../artifacts/bin/fcs/Release/net461/FSharp.Compiler.Service.dll" ] + // Web site location for the generated documentation let website = "/FSharp.Compiler.Service/ja" @@ -18,35 +24,22 @@ let info = // For typical project, no changes are needed below // -------------------------------------------------------------------------------------- -#I "../../packages/FSharpVSPowerTools.Core/lib/net461" -#I "../../packages/FSharp.Formatting/lib/net40" -#I "../../packages/FSharp.Compiler.Service/lib/net461" -#I "../../packages/FAKE/tools" -#r "FSharpVSPowerTools.Core.dll" -#r "System.Web.Razor.dll" -#r "FakeLib.dll" -#r "FSharp.Compiler.Service.dll" -#r "RazorEngine.dll" -#r "FSharp.Literate.dll" -#r "FSharp.CodeFormat.dll" -#r "FSharp.MetadataFormat.dll" -open Fake -open System.IO -open Fake.FileHelper -open FSharp.Literate -open FSharp.MetadataFormat +open Fake.IO.FileSystemOperators +open Fake.IO +open Fake.Core +open FSharp.Formatting.Razor // When called from 'build.fsx', use the public project URL as // otherwise, use the current 'output' directory. let root = "." // Paths with template/source/output locations -let bin = __SOURCE_DIRECTORY__ @@ "../../../release/fcs/net461" +let bin = __SOURCE_DIRECTORY__ @@ "../../../release/fcs/netcoreapp3.0" let content = __SOURCE_DIRECTORY__ @@ "../content/ja" let outputJa = __SOURCE_DIRECTORY__ @@ "../../../docs/ja" let files = __SOURCE_DIRECTORY__ @@ "../files" let templates = __SOURCE_DIRECTORY__ @@ "templates/ja" -let formatting = __SOURCE_DIRECTORY__ @@ "../../packages/FSharp.Formatting/" +let formatting = __SOURCE_DIRECTORY__ @@ "../../packages/generate/FSharp.Formatting" let docTemplate = formatting @@ "templates/docpage.cshtml" // Where to look for *.csproj templates (in this order) @@ -60,10 +53,9 @@ let layoutRoots = let buildDocumentation () = for dir in [content] do let sub = if dir.Length > content.Length then dir.Substring(content.Length + 1) else "." - printfn "root = %s" root - Literate.ProcessDirectory + RazorLiterate.ProcessDirectory ( dir, docTemplate, outputJa @@ sub, replacements = ("root", root)::info, - layoutRoots = layoutRoots, generateAnchors = true ) + layoutRoots = layoutRoots, generateAnchors = true, processRecursive=false ) // Generate buildDocumentation() diff --git a/fcs/paket.dependencies b/fcs/paket.dependencies index 6830095076..3b8a7cdc59 100644 --- a/fcs/paket.dependencies +++ b/fcs/paket.dependencies @@ -1,3 +1,4 @@ +version 5.226.0 source https://api.nuget.org/v3/index.json storage: none From f5cc5ccd344917584e956131cb49de817f31b059 Mon Sep 17 00:00:00 2001 From: nojaf Date: Sun, 9 Feb 2020 21:38:15 +0100 Subject: [PATCH 6/7] Added generated Japanese documentation. --- docs/ja/compiler.html | 227 +++++++++++++ docs/ja/corelib.html | 175 ++++++++++ docs/ja/devnotes.html | 142 ++++++++ docs/ja/editor.html | 436 ++++++++++++++++++++++++ docs/ja/filesystem.html | 425 +++++++++++++++++++++++ docs/ja/index.html | 158 +++++++++ docs/ja/interactive.html | 547 ++++++++++++++++++++++++++++++ docs/ja/project.html | 559 +++++++++++++++++++++++++++++++ docs/ja/symbols.html | 518 ++++++++++++++++++++++++++++ docs/ja/tokenizer.html | 290 ++++++++++++++++ docs/ja/untypedtree.html | 539 +++++++++++++++++++++++++++++ fcs/docsrc/tools/generate.ja.fsx | 3 - 12 files changed, 4016 insertions(+), 3 deletions(-) create mode 100644 docs/ja/compiler.html create mode 100644 docs/ja/corelib.html create mode 100644 docs/ja/devnotes.html create mode 100644 docs/ja/editor.html create mode 100644 docs/ja/filesystem.html create mode 100644 docs/ja/index.html create mode 100644 docs/ja/interactive.html create mode 100644 docs/ja/project.html create mode 100644 docs/ja/symbols.html create mode 100644 docs/ja/tokenizer.html create mode 100644 docs/ja/untypedtree.html diff --git a/docs/ja/compiler.html b/docs/ja/compiler.html new file mode 100644 index 0000000000..8ea19fac6f --- /dev/null +++ b/docs/ja/compiler.html @@ -0,0 +1,227 @@ + + + + + コンパイラの組み込み + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    コンパイラの組み込み

    +

    このチュートリアルではF#コンパイラをホストする方法を紹介します。

    +
    +

    注意: 以下で使用しているAPIは実験的なもので、 +新しいnugetパッケージの公開に伴って変更される可能性があります。 +注意: F#コンパイラをホストする方法はいくつかあります。 +一番簡単な方法は fsc.exe のプロセスを使って引数を渡す方法です。

    +
    +
    +

    まず、F# Interactiveサービスを含むライブラリへの参照を追加します:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+
    #r "FSharp.Compiler.Service.dll"
+open FSharp.Compiler.SourceCodeServices
+open System.IO
+
+let scs = FSharpChecker.Create()
+
    +

    次に、一時ファイルへコンテンツを書き込みます:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+
    let fn = Path.GetTempFileName()
+let fn2 = Path.ChangeExtension(fn, ".fs")
+let fn3 = Path.ChangeExtension(fn, ".dll")
+
+File.WriteAllText(fn2, """
+module M
+
+type C() = 
+   member x.P = 1
+
+let x = 3 + 4
+""")
+
    +

    そしてコンパイラを呼び出します:

    + + + +
    1: 
+
    let errors1, exitCode1 = scs.Compile([| "fsc.exe"; "-o"; fn3; "-a"; fn2 |]) |> Async.RunSynchronously
+
    +

    エラーが発生した場合は「終了コード」とエラーの配列から原因を特定できます:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+
    File.WriteAllText(fn2, """
+module M
+
+let x = 1.0 + "" // a type error
+""")
+
+let errors1b, exitCode1b = scs.Compile([| "fsc.exe"; "-o"; fn3; "-a"; fn2 |]) |> Async.RunSynchronously
+
+if exitCode1b <> 0 then
+    errors1b
+    |> Array.iter (printfn "%A")
+
    +

    動的アセンブリへのコンパイル

    +

    コードを動的アセンブリとしてコンパイルすることもできます。 +動的アセンブリはF# Interactiveコードジェネレータでも使用されています。

    +

    この機能はたとえばファイルシステムが必ずしも利用できないような状況で役に立ちます。

    +

    出力ファイルの名前を指定する "-o" オプションを指定することは可能ですが、 +実際には出力ファイルがディスク上に書き込まれることはありません。

    +

    'execute' 引数に 'None' を指定するとアセンブリ用の初期化コードが実行されません。

    + + + +
    1: 
+2: 
+
    let errors2, exitCode2, dynAssembly2 = 
+    scs.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], execute=None) |> Async.RunSynchronously
+
    +

    'Some' を指定するとアセンブリ用の初期化コードが実行されます。

    + + + +
    1: 
+2: 
+
    let errors3, exitCode3, dynAssembly3 = 
+    scs.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], Some(stdout,stderr)) |> Async.RunSynchronously
+
    + +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    +
    namespace FSharp.Compiler
    +
    namespace FSharp.Compiler.SourceCodeServices
    +
    namespace System
    +
    namespace System.IO
    +
    val scs : FSharpChecker
    +
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    +
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    +
    val fn : string
    +
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val PathSeparator : char
      static val InvalidPathChars : char[]
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string + 1 overload
      static member GetExtension : path:string -> string + 1 overload
      static member GetFileName : path:string -> string + 1 overload
      ...
    +
    Path.GetTempFileName() : string
    +
    val fn2 : string
    +
    Path.ChangeExtension(path: string, extension: string) : string
    +
    val fn3 : string
    +
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllLinesAsync : path:string * contents:IEnumerable<string> * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendAllTextAsync : path:string * contents:string * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 2 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      ...
    +
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: System.Text.Encoding) : unit
    +
    val errors1 : FSharpErrorInfo []
    +
    val exitCode1 : int
    +
    member FSharpChecker.Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    member FSharpChecker.Compile : ast:FSharp.Compiler.Ast.ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:System.Threading.CancellationToken -> 'T
    +
    val errors1b : FSharpErrorInfo []
    +
    val exitCode1b : int
    +
    module Array

    from Microsoft.FSharp.Collections
    +
    val iter : action:('T -> unit) -> array:'T [] -> unit
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    val errors2 : FSharpErrorInfo []
    +
    val exitCode2 : int
    +
    val dynAssembly2 : System.Reflection.Assembly option
    +
    member FSharpChecker.CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * System.Reflection.Assembly option>
    member FSharpChecker.CompileToDynamicAssembly : ast:FSharp.Compiler.Ast.ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * System.Reflection.Assembly option>
    +
    union case Option.None: Option<'T>
    +
    val errors3 : FSharpErrorInfo []
    +
    val exitCode3 : int
    +
    val dynAssembly3 : System.Reflection.Assembly option
    +
    union case Option.Some: Value: 'T -> Option<'T>
    +
    val stdout<'T> : TextWriter
    +
    val stderr<'T> : TextWriter
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/corelib.html b/docs/ja/corelib.html new file mode 100644 index 0000000000..2b795faaa2 --- /dev/null +++ b/docs/ja/corelib.html @@ -0,0 +1,175 @@ + + + + + コンパイラサービス: FSharp.Core.dll についてのメモ + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    コンパイラサービス: FSharp.Core.dll についてのメモ

    +

    あなたのアプリケーションとともに FSharp.Core を配布する

    +

    FSharp.Compiler.Service.dll を利用するアプリケーションまたはプラグイン・コンポーネントをビルドする際、普通はアプリの一部として FSharp.Core.dll のコピーも含めることになるでしょう。

    +

    例えば、 HostedCompiler.exe をビルドする場合、普通はあなたの HostedCompiler.exe と同じフォルダに FSharp.Core.dll (例えば 4.3.1.0)を配置します。

    +

    動的コンパイルや動的実行を行う場合、FSharp.Core.optdata と FSharp.Core.sigdata も含める必要があるかもしれませんが、これらについては下記の指針をご覧ください。

    +

    あなたのアプリケーションにリダイレクトをバインドする

    +

    FSharp.Compiler.Service.dll コンポーネントは FSharp.Core 4.3.0.0 に依存しています。通例、あなたのアプリケーションはこれより後のバージョンの FSharp.Core をターゲットにしており、FSharp.Core 4.3.0.0 をあなたのアプリケーションで用いる FSharp.Core.dll の最終バージョンにちゃんと転送させるようにバインド リダイレクトが必要になるでしょう。バインド リダイレクト ファイルは通常ビルドツールによって自動的に生成されます。そうでない場合、下記のようなファイル(あなたのツールが HostedCompiler.exe という名前で、バインド リダイレクト ファイルが HostedCompiler.exe.config という名前の場合)を使うことが出来ます。

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+
    <?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+    <runtime>
+      <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
+        <dependentAssembly>
+          <assemblyIdentity name="FSharp.Core" publicKeyToken="b03f5f7f11d50a3a" culture="neutral"/>
+          <bindingRedirect oldVersion="2.0.0.0-4.3.0.0" newVersion="4.3.1.0"/>
+        </dependentAssembly>
+        <dependentAssembly>
+          <assemblyIdentity name="System.Collections.Immutable" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
+          <bindingRedirect oldVersion="1.0.0.0-1.2.0.0" newVersion="1.2.1.0" />
+        </dependentAssembly>
+      </assemblyBinding>
+    </runtime>
+</configuration>
+
    +

    どの FSharp.Core と .NET フレームワークがコンパイル時に参照される？

    +

    FSharp.Combiler.Service コンポーネントは多かれ少なかれ、F#コードを コンパイルするために使われるに過ぎません。特に、コマンドライン引数(あなたのツールを実行するために使われる FSharp.Core や .NET フレームワークとは違います)に明示的に FSharp.Core および/またはフレームワークのアセンブリを参照することが出来ます。

    +

    特定の FSharp.Core および .NET フレームワーク アセンブリ、またはそのいずれかをターゲットにする場合、 --noframework 引数と適切なコマンドライン引数を使います:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+
    [<Literal>]
+let fsharpCorePath =
+    @"C:\Program Files (x86)\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.1.0\FSharp.Core.dll"
+let errors2, exitCode2 =
+  scs.Compile(
+    [| "fsc.exe"; "--noframework";
+       "-r"; fsharpCorePath;
+       "-r"; @"C:\Windows\Microsoft.NET\Framework\v4.0.30319\mscorlib.dll";
+       "-o"; fn3;
+       "-a"; fn2 |])
+
    +

    これらのアセンブリが配置されている場所を指定する必要があります。クロスプラットフォームに対応した方法でDLL を配置して、それらをコマンドライン引数に変換する最も簡単な方法は、F# プロジェクトファイルをクラックすることです。 +自分で SDK のパスを処理する代わりに、FSharp.Compiler.Service.dll 用のテストで使用しているようなヘルパー関数も用意されています。

    +

    スクリプトを処理しているか GetCheckOptionsFromScriptRoot を使っている場合

    +

    もし SDK 配置先にある FSharp.Core.dll を明示的に参照 していない 場合、または FsiEvaluationSession や GetCheckOptionsFromScriptRoot を使用してスクリプトを処理している場合、以下のいずれかの方法により、暗黙的にFSharp.Core が参照されます:

    +
      +

    1. System.Reflection.Assembly.GetEntryAssembly() によって返されるホストアセンブリから静的に参照されたFSharp.Core.dll のバージョン

      2. +
    2. +

      ホストアセンブリに FSharp.Core への静的な参照がない場合、

      +
        +
      • FSharp.Compiler.Service 0.x シリーズでは、FSharp.Core バージョン 4.3.0.0 への参照が付与されます
        • +
      • FSharp.Compiler.Service 1.3.1.x (F# 3.1 シリーズ)では、FSharp.Core バージョン 4.3.1.0 への参照が付与されます
        • +
      • FSharp.Compiler.Service 1.4.0.x (F# 4.0 シリーズ)では、FSharp.Core バージョン 4.4.0.0 への参照が付与されます
        • +
      +
      3. +
    +

    FSharp.Core.optdata と FSharp.Core.sigdata を含める必要はありますか？

    +

    もしあなたのコンパイル引数が SDK 配置先にある FSharp.Core.dll を明示的に参照している場合、FSharp.Core.sigdata と FSharp.Core.optdata はその DLL と同じフォルダになければいけません(これらのファイルがインストールされていない場合、F# SDKの インストールに問題があります)。もしコンパイル引数で常に明示的に参照していたなら、FSharp.Core.optdata と FSharp.Core.sigdata はあなたのアプリケーションの一部として含める必要は ありません 。

    +

    もしあなたが暗黙的な参照(例えば、上記のスクリプト処理など)に頼っているのなら、これはあなたのツールがアプリケーションの一部として FSharp.Core.dll を参照しているかもしれない、ということです。この場合、FSharp.Core.optdata および FSharp.Core.sigdata が FSharp.Core.dll と同じフォルダに見つからないというエラーが発生するかもしれません。 もしあなたがアプリケーションに含めている FSharp.Core.dll を暗黙的に参照したいのであれば、FSharp.Core.sigdata と FSharp.Core.optdata もアプリケーションに追加する2つのファイルとして追加しましょう。 CombileToDynamicAssembly を使用する場合、この問題によってアセンブリ解決中のスタックオーバーフローも引き起こされるでしょう。

    +

    動的コンパイルと動的コード実行を行うツール(例: HostedExecution.exe)はしばしば FSharp.Core.dll を暗黙的に参照するようになっています。 +これはつまり通常 FSharp.Core.optdata と FSharp.Core.sigdata を含んでいるということです。

    +

    要約

    +

    このデザインノートでは3つのポイントを検討しました:

    +
      +
    • どの FSharp.Core.dll があなたのコンパイルツールを実行するのに使われるか
      • +
    • あなたのコンパイルツールを実行するのに使われる FSharp.Core.dll へのバインド リダイレクトを設定する方法
      • +
    • あなたのツールによって実行されるチェック時およびコンパイル時にどの FSharp.Core.dll および/またはフレームワークのアセンブリが参照されるか
      • +
    + +
    Multiple items
    type LiteralAttribute =
      inherit Attribute
      new : unit -> LiteralAttribute

    --------------------
    new : unit -> LiteralAttribute
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/devnotes.html b/docs/ja/devnotes.html new file mode 100644 index 0000000000..f65d5a18e3 --- /dev/null +++ b/docs/ja/devnotes.html @@ -0,0 +1,142 @@ + + + + + 開発者用メモ + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    開発者用メモ

    +

    F#コンパイラの修正版クローンではクライアントの編集機能やF#コンパイラの埋め込み、 +F# Interactiveをサービスとして動作させるための機能が追加されています。

    +

    コンポーネント

    +

    まず FSharp.Compiler.Service.dll というコンポーネントがあります。 +このコンポーネントにはリファクタリングやその他の編集ツールが完全なF# ASTやパーサ機能を利用できるように +可視性を変更するというマイナーな変更だけが加えられています。 +主な狙いとしては、メインコンパイラの安定版かつドキュメントが備えられたフォークを用意することにより、 +このコンポーネントにある共通コードを様々なツールで共有できるようにすることです。

    +

    2つ目のコンポーネントはF# Interactiveをサービスとして組み込めるようにするためのもので、 +fsi.exe のソースコードに多数の変更が加えられており、 +EvalExpression や EvalInteraction といった関数が追加されています。

    +

    このレポジトリは以下の点を除けば 'fsharp' と 同一 です:

    +
      +
    • +

      FSharp.Compiler.Service.dll のビルド、特に以下の点に関する変更:

      +
        +
      • アセンブリ名の変更
        • +

      • FSharp.Compiler.Service.dll のみビルドされる

        • +
      • +

        ブートストラッパーやプロトコンパイラを使用しない。 +F#コンパイラがインストール済みであることを想定。

        +
        • +
      +
      • +
    • +

      FAKEを使用するビルドスクリプト。 +すべてのコードのビルドとNuGetパッケージ、ドキュメントの生成、 +NuGetパッケージの配布に必要なファイルの生成などがFAKEによって行われる。 +(F# プロジェクト スキャフォールド に準拠)

      +
      • +
    • +

      新機能追加のためにコンパイラのソースコードを変更。 +また、評価用関数を実装するためにF# Interactiveサービスに対する変更を追加。

      +
      • +
    • F#編集用クライアントで使用されるAPIを改善するためにコンパイラのソースコードを変更。
      • +
    • コンパイラサービスAPIに新機能を追加するためにコンパイラのソースコードを変更。
      • +
    +

    fsharp/fsharp のレポジトリに言語あるいはコンパイラが追加コミットされた場合、 +それらはこのレポジトリにもマージされるべきで、同時に新しいNuGetパッケージもリリースする必要があります。

    +

    ビルドとNuGet

    +

    ビルドの手順は F# プロジェクト スキャフォールド +で推奨されているものに準じます。 +プロジェクトを独自にビルドする場合、以下の手順に従ってください:

    + +
    1: 
+2: 
+
    git clone https://github.com/fsharp/FSharp.Compiler.Service
+cd FSharp.Compiler.Service
+
    +

    次に、(Windowsであれば) build.cmd または(LinuxやMac OSであれば) build.sh を実行してすべてをビルドします。 +ファイルは bin ディレクトリ内に出力されます。 +ドキュメントやNuGetパッケージもビルドしたい場合には build Release を実行します +(このコマンドはGitHub上のドキュメントを更新しようとしますが、GitHubのレポジトリに適切な権限を持っている場合にのみ有効です)。

    +

    クライアント

    +

    このコンポーネントは以下のようなツールで使用されています:

    + + + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/editor.html b/docs/ja/editor.html new file mode 100644 index 0000000000..da2e5204b3 --- /dev/null +++ b/docs/ja/editor.html @@ -0,0 +1,436 @@ + + + + + コンパイラサービス: エディタサービス + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    コンパイラサービス: エディタサービス

    +

    このチュートリアルはF#コンパイラによって公開されるエディタサービスの +使用方法についてのデモです。 +このAPIにより、Visual StudioやXamarin Studio、EmacsなどのF#エディタ内において、 +自動補完機能やツールチップ表示、引数情報のヘルプ表示、括弧の補完などの機能を +実装することができます +(詳細については fsharpbindings のプロジェクトを参照してください)。 +型無しASTを使用するチュートリアル と同じく、 +今回も FSharpChecker オブジェクトを作成するところから始めます。

    +
    +

    注意: 以下で使用しているAPIは試験的なもので、最新バージョンのnugetパッケージの +公開に伴って変更されることがあります。

    +
    +

    サンプルソースコードの型チェック

    +

    前回の(型無しASTを使った)チュートリアル と同じく、 +FSharp.Compiler.Service.dll への参照を追加した後に特定の名前空間をオープンし、 +FSharpChecker のインスタンスを作成します:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+8: 
+
    // F#コンパイラAPIを参照
+#r "FSharp.Compiler.Service.dll"
+
+open System
+open FSharp.Compiler.SourceCodeServices
+
+// インタラクティブチェッカーのインスタンスを作成
+let checker = FSharpChecker.Create()
+
    +

    前回 同様、 +コンパイラに渡されるファイルとしては特定の入力値だけであるという +コンテキストを想定するため、 GetCheckOptionsFromScriptRoot を使います +(この入力値はコンパイラによってスクリプトファイル、 +あるいはスタンドアロンのF#ソースコードとみなされます)。

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+
    // サンプルの入力となる複数行文字列
+let input = 
+    """
+open System
+
+let foo() = 
+let msg = String.Concat("Hello"," ","world")
+if true then 
+printfn "%s" msg.
+"""
+// 入力値の分割とファイル名の定義
+let inputLines = input.Split('\n')
+let file = "/home/user/Test.fsx"
+
+let projOptions, _errors1 = checker.GetProjectOptionsFromScript(file, input) |> Async.RunSynchronously
+
+let parsingOptions, _errors2 = checker.GetParsingOptionsFromProjectOptions(projOptions)
+
    +

    型チェックを実行するには、まず ParseFile を使って +入力値をパースする必要があります。 +このメソッドを使うと 型無しAST にアクセスできるようになります。 +しかし今回は完全な型チェックを実行するため、続けて CheckFileInProject +を呼び出す必要があります。 +このメソッドは ParseFile の結果も必要とするため、 +たいていの場合にはこれら2つのメソッドをセットで呼び出すことになります。

    + + + +
    1: 
+2: 
+3: 
+4: 
+
    // パースを実行
+let parseFileResults =
+    checker.ParseFile(file, input, parsingOptions)
+    |> Async.RunSynchronously
+
    +

    TypeCheckResults に備えられた興味深い機能の紹介に入る前に、 +サンプル入力に対して型チェッカーを実行する必要があります。 +F#コードにエラーがあった場合も何らかの型チェックの結果が返されます +(ただし間違って「推測された」結果が含まれることがあります)。

    + + + +
    1: 
+2: 
+3: 
+4: 
+
    // 型チェックを実行
+let checkFileAnswer = 
+    checker.CheckFileInProject(parseFileResults, file, 0, input, projOptions) 
+    |> Async.RunSynchronously
+
    +

    あるいは ParseAndCheckFileInProject を使用すれば1つの操作で両方のチェックを行うことができます：

    + + + +
    1: 
+2: 
+3: 
+
    let parseResults2, checkFileAnswer2 =
+    checker.ParseAndCheckFileInProject(file, 0, input, projOptions)
+    |> Async.RunSynchronously
+
    +

    この返り値は CheckFileAnswer 型で、この型に機能的に興味深いものが揃えられています...

    + + + +
    1: 
+2: 
+3: 
+4: 
+
    let checkFileResults = 
+    match checkFileAnswer with
+    | FSharpCheckFileAnswer.Succeeded(res) -> res
+    | res -> failwithf "パースが完了していません... (%A)" res
+
    +

    今回は単に(状況に応じて)「Hello world」と表示するだけの +単純な関数の型をチェックしています。 +最終行では値 msg に対する補完リストを表示することができるように、 +msg. というようにドットを追加している点に注意してください +(今回の場合は文字列型に対する様々なメソッドが期待されます)。

    +

    型チェックの結果を使用する

    +

    では TypeCheckResults 型で公開されているAPIをいくつか見ていきましょう。 +一般的に、F#ソースコードエディタサービスの実装に必要な機能は +ほとんどこの型に備えられています。

    +

    ツールチップの取得

    +

    ツールチップを取得するには GetToolTipTextAlternate メソッドを使用します。 +このメソッドには行数と文字オフセットを指定します。 +いずれも0から始まる数値です。 +サンプルコードでは3行目(0行目は空白行)、インデックス7にある文字 f から始まる関数 +foo のツールチップを取得しています +(ツールチップは識別子の中であれば任意の位置で機能します)。

    +

    またこのメソッドにはトークンタグを指定する必要もあります。 +トークンタグは一般的には IDENT を指定して、識別子に対する +ツールチップが取得できるようにします +(あるいは #r "..." を使用している場合にはアセンブリの完全パスを表示させるように +することもできるでしょう)。

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+
    // 最後の引数に指定する、IDENTトークンのタグを取得
+open FSharp.Compiler
+
+// 特定の位置におけるツールチップを取得
+let tip = checkFileResults.GetToolTipText(4, 7, inputLines.[1], ["foo"], FSharpTokenTag.Identifier)
+printfn "%A" tip
+
    +
    +

    注意： GetToolTipTextAlternate は古い関数 GetToolTipText に代わるものです。 +GetToolTipText は0から始まる行番号を受け取るようになっていたため、非推奨になりました。

    +
    +

    この関数には位置とトークンの種類の他にも、 +(ソースコードの変更時に役立つように)特定行の現在の内容と、 +現時点における完全修飾された 名前 を表す文字列のリストを指定する必要があります。 +たとえば完全修飾名 System.Random という名前を持った識別子 Random に対する +ツールチップを取得する場合、 Random という文字列が現れる場所の他に、 +["System"; "Random"] という値を指定する必要があります。

    +

    返り値の型は ToolTipText で、この型には ToolTipElement という +判別共用体が含まれます。 +この共用体は、コンパイラによって返されたツールチップの種類に応じて異なります。

    +

    自動補完リストの取得

    +

    次に紹介する TypeCheckResults のメソッドを使用すると、 +特定の位置における自動補完機能を実装できます。 +この機能は任意の識別子上、 +あるいは(特定のスコープ内で利用可能な名前の一覧を取得する場合には)任意のスコープ、 +あるいは特定のオブジェクトにおけるメンバーリストを取得する場合には +. の直後で呼び出すことができます。 +今回は文字列の値 msg に対するメンバーリストを取得することにします。

    +

    そのためには最終行( printfn "%s" msg. で終わっている行)にある +シンボル . の位置を指定して GetDeclarationListInfo を呼び出します。 +オフセットは1から始まるため、位置は 7, 23 になります。 +また、テキストが変更されていないことを表す関数と、 +現時点において補完する必要がある識別子を指定する必要もあります。

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+8: 
+9: 
+
    // 特定の位置における宣言(自動補完)を取得する
+let decls = 
+    checkFileResults.GetDeclarationListInfo
+      (Some parseFileResults, 7, inputLines.[6], PartialLongName.Empty 23, (fun _ -> []), fun _ -> false)
+      |> Async.RunSynchronously
+
+// 利用可能な項目を表示
+for item in decls.Items do
+    printfn " - %s" item.Name
+
    +
    +

    注意： GetDeclarationListInfo は古い関数 GetDeclarations に代わるものです。 +GetDeclarations は0から始まる行番号を受け取るようになっていたため、非推奨になりました。 +また、将来的には現在の GetDeclarations が削除され、 GetDeclarationListInfo が +GetDeclarations になる予定です。

    +
    +

    コードを実行してみると、 Substring や ToUpper 、 ToLower といった +文字列に対するいつものメソッドのリストが取得できていることでしょう。 +GetDeclarations の5,6番目の引数( [] および "msg" )には +自動補完用のコンテキストを指定します。 +今回の場合は完全名 msg に対する補完を行いましたが、 +たとえば ["System"; "Collections"] と "Generic" というように +完全修飾された名前空間を指定して補完リストを取得することもできます。

    +

    引数の情報を取得する

    +

    次に一般的なエディタの機能としては、メソッドのオーバーロードに +関する情報を提供するというものでしょう。 +サンプルコード中では多数のオーバーロードを持った String.Concat を使っています。 +このオーバーロード一覧は GetMethods で取得できます。 +先ほどと同じく、このメソッドには対象とする項目の位置を0基準のオフセットで指定し +(今回は String.Concat 識別子の右側の終端)、 +識別子もやはり指定します +(これにより、コンパイラはソースコードが変更された場合でも最新の情報に追従できます):

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+8: 
+9: 
+
    //String.Concatメソッドのオーバーロードを取得する
+let methods = 
+    checkFileResults.GetMethods(5, 27, inputLines.[4], Some ["String"; "Concat"]) |> Async.RunSynchronously
+
+// 連結された引数リストを表示
+for mi in methods.Methods do
+    [ for p in mi.Parameters -> p.Display ]
+    |> String.concat ", " 
+    |> printfn "%s(%s)" methods.MethodName
+
    +

    ここでは Display プロパティを使用することで各引数に対する +アノテーションを取得しています。 +このプロパティは arg0: obj あるいは params args: obj[] 、 +str0: string, str1: string といった情報を返します。 +これらの引数を連結した後、メソッド名とメソッドの型情報とともに表示させています。

    +

    非同期操作と即時操作

    +

    CheckFileInProject が非同期操作であることを気にされる人もいるかもしれません。 +これはつまり、F#コードの型チェックにはある程度時間がかかることを示唆しています。 +F#コンパイラは型チェックを(自動的に)バックグラウンドで処理を進めているため、 +CheckFileInProject メソッドを呼び出すと非同期操作が返されることになります。

    +

    また、 CheckFileInProjectIfReady というメソッドもあります。 +このメソッドは、型チェックの操作が即座に開始できない場合、 +つまりプロジェクト内の他のファイルがまだ型チェックされていない場合には +処理が即座に返されます。 +この場合、バックグラウンドワーカーは一定期間他の作業を進めるか、 +FileTypeCheckStateIsDirty イベントが発生するまでは +ファイルに対する型チェックを諦めるか、どちらか選択することになります。

    +
    +

    fsharpbinding プロジェクトには +1つのF#エージェント経由ですべてのリクエストをバックグラウンドワークとして +処理するような、より複雑な具体例も含まれています。 +エディタの機能を実装する方法としてはこちらのほうが適切です。

    +
    +

    まとめ

    +

    CheckFileAnswer にはチュートリアルで紹介していないような便利なメソッドが +多数揃えられています。 +これらを使用すれば特定の識別子に対する宣言の位置を取得したり、 +付加的な色情報を取得したりすることができます +(F# 3.1では式ビルダーの識別子やクエリ演算子も着色表示されます)。

    +

    最後に、直接.NET APIを呼び出すことができないようなエディタに対するサポート機能を +実装する場合、ここで紹介した様々な機能を +FSharp.AutoComplete +プロジェクトのコマンドラインインターフェイス経由で呼び出すこともできます。

    + +
    namespace System
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    +
    namespace FSharp.Compiler
    +
    namespace FSharp.Compiler.SourceCodeServices
    +
    val checker : FSharpChecker
    +
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    +
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    +
    val input : string
    +
    val inputLines : string []
    +
    String.Split([<ParamArray>] separator: char []) : string []
    String.Split(separator: string [], options: StringSplitOptions) : string []
    String.Split(separator: string,?options: StringSplitOptions) : string []
    String.Split(separator: char [], options: StringSplitOptions) : string []
    String.Split(separator: char [], count: int) : string []
    String.Split(separator: char,?options: StringSplitOptions) : string []
    String.Split(separator: string [], count: int, options: StringSplitOptions) : string []
    String.Split(separator: string, count: int,?options: StringSplitOptions) : string []
    String.Split(separator: char [], count: int, options: StringSplitOptions) : string []
    String.Split(separator: char, count: int,?options: StringSplitOptions) : string []
    +
    val file : string
    +
    val projOptions : FSharpProjectOptions
    +
    val _errors1 : FSharpErrorInfo list
    +
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * sourceText:FSharp.Compiler.Text.ISourceText * ?previewEnabled:bool * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?useSdkRefs:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    val parsingOptions : FSharpParsingOptions
    +
    val _errors2 : FSharpErrorInfo list
    +
    member FSharpChecker.GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    +
    val parseFileResults : FSharpParseFileResults
    +
    member FSharpChecker.ParseFile : filename:string * sourceText:FSharp.Compiler.Text.ISourceText * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    +
    val checkFileAnswer : FSharpCheckFileAnswer
    +
    member FSharpChecker.CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:FSharp.Compiler.Text.ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
    +
    val parseResults2 : FSharpParseFileResults
    +
    val checkFileAnswer2 : FSharpCheckFileAnswer
    +
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * sourceText:FSharp.Compiler.Text.ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    +
    val checkFileResults : FSharpCheckFileResults
    +
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults
    +
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    +
    val res : FSharpCheckFileResults
    +
    val res : FSharpCheckFileAnswer
    +
    val failwithf : format:Printf.StringFormat<'T,'Result> -> 'T
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>
    +
    val tip : Async<FSharpToolTipText>
    +
    member FSharpCheckFileResults.GetToolTipText : line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * ?userOpName:string -> Async<FSharpToolTipText>
    +
    module FSharpTokenTag

    from FSharp.Compiler.SourceCodeServices
    +
    val Identifier : int
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    val decls : FSharpDeclarationListInfo
    +
    member FSharpCheckFileResults.GetDeclarationListInfo : ParsedFileResultsOpt:FSharpParseFileResults option * line:int * lineText:string * partialName:PartialLongName * ?getAllEntities:(unit -> AssemblySymbol list) * ?hasTextChangedSinceLastTypecheck:(obj * Range.range -> bool) * ?userOpName:string -> Async<FSharpDeclarationListInfo>
    +
    union case Option.Some: Value: 'T -> Option<'T>
    +
    type PartialLongName =
      { QualifyingIdents: string list
        PartialIdent: string
        EndColumn: int
        LastDotPos: int option }
        static member Empty : endColumn:int -> PartialLongName
    +
    static member PartialLongName.Empty : endColumn:int -> PartialLongName
    +
    val item : FSharpDeclarationListItem
    +
    property FSharpDeclarationListInfo.Items: FSharpDeclarationListItem [] with get
    +
    property FSharpDeclarationListItem.Name: string with get
    +
    val methods : FSharpMethodGroup
    +
    member FSharpCheckFileResults.GetMethods : line:int * colAtEndOfNames:int * lineText:string * names:string list option * ?userOpName:string -> Async<FSharpMethodGroup>
    +
    val mi : FSharpMethodGroupItem
    +
    property FSharpMethodGroup.Methods: FSharpMethodGroupItem [] with get
    +
    val p : FSharpMethodGroupItemParameter
    +
    property FSharpMethodGroupItem.Parameters: FSharpMethodGroupItemParameter [] with get
    +
    property FSharpMethodGroupItemParameter.Display: string with get
    +
    Multiple items
    type String =
      new : value:char[] -> string + 8 overloads
      member Chars : int -> char
      member Clone : unit -> obj
      member CompareTo : value:obj -> int + 1 overload
      member Contains : value:string -> bool + 3 overloads
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EndsWith : value:string -> bool + 3 overloads
      member Equals : obj:obj -> bool + 2 overloads
      member GetEnumerator : unit -> CharEnumerator
      member GetHashCode : unit -> int + 1 overload
      ...

    --------------------
    String(value: char []) : String
    String(value: nativeptr<char>) : String
    String(value: nativeptr<sbyte>) : String
    String(value: ReadOnlySpan<char>) : String
    String(c: char, count: int) : String
    String(value: char [], startIndex: int, length: int) : String
    String(value: nativeptr<char>, startIndex: int, length: int) : String
    String(value: nativeptr<sbyte>, startIndex: int, length: int) : String
    String(value: nativeptr<sbyte>, startIndex: int, length: int, enc: Text.Encoding) : String
    +
    val concat : sep:string -> strings:seq<string> -> string
    +
    property FSharpMethodGroup.MethodName: string with get
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/filesystem.html b/docs/ja/filesystem.html new file mode 100644 index 0000000000..e30371f9f1 --- /dev/null +++ b/docs/ja/filesystem.html @@ -0,0 +1,425 @@ + + + + + コンパイラサービス: ファイルシステム仮想化 + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    コンパイラサービス: ファイルシステム仮想化

    +

    FSharp.Compiler.Service にはファイルシステムを表すグローバル変数があります。 +この変数を設定するこにより、ファイルシステムが利用できない状況でも +コンパイラをホストすることができるようになります。

    +
    +

    注意: 以下で使用しているAPIは実験的なもので、 +新しいnugetパッケージの公開に伴って変更される可能性があります。

    +
    +

    FileSystemの設定

    +

    以下の例ではディスクからの読み取りを行うような実装をファイルシステムに設定しています:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+18: 
+19: 
+20: 
+21: 
+22: 
+23: 
+24: 
+25: 
+26: 
+27: 
+28: 
+29: 
+30: 
+31: 
+32: 
+33: 
+34: 
+35: 
+36: 
+37: 
+38: 
+39: 
+40: 
+41: 
+42: 
+43: 
+44: 
+45: 
+46: 
+47: 
+48: 
+49: 
+50: 
+51: 
+52: 
+53: 
+54: 
+55: 
+56: 
+57: 
+58: 
+59: 
+60: 
+61: 
+62: 
+63: 
+64: 
+65: 
+66: 
+67: 
+68: 
+69: 
+70: 
+71: 
+72: 
+73: 
+74: 
+75: 
+76: 
+
    #r "FSharp.Compiler.Service.dll"
+open System
+open System.IO
+open System.Collections.Generic
+open System.Text
+open FSharp.Compiler.AbstractIL.Internal.Library
+
+let defaultFileSystem = Shim.FileSystem
+
+let fileName1 = @"c:\mycode\test1.fs" // 注意: 実際には存在しないファイルのパス
+let fileName2 = @"c:\mycode\test2.fs" // 注意: 実際には存在しないファイルのパス
+
+type MyFileSystem() = 
+    let file1 = """
+module File1
+
+let A = 1"""
+    let file2 = """
+module File2
+let B = File1.A + File1.A"""
+    let files = dict [(fileName1, file1); (fileName2, file2)]
+
+    interface IFileSystem with
+        // 読み取りおよび書き込み用にファイルをオープンする機能を実装
+        member __.FileStreamReadShim(fileName) = 
+            match files.TryGetValue fileName with
+            | true, text -> new MemoryStream(Encoding.UTF8.GetBytes(text)) :> Stream
+            | _ -> defaultFileSystem.FileStreamReadShim(fileName)
+
+        member __.FileStreamCreateShim(fileName) = 
+            defaultFileSystem.FileStreamCreateShim(fileName)
+
+        member __.IsStableFileHeuristic(fileName) = 
+            defaultFileSystem.IsStableFileHeuristic(fileName)
+
+        member __.FileStreamWriteExistingShim(fileName) = 
+            defaultFileSystem.FileStreamWriteExistingShim(fileName)
+
+        member __.ReadAllBytesShim(fileName) = 
+            match files.TryGetValue fileName with
+            | true, text -> Encoding.UTF8.GetBytes(text)
+            | _ -> defaultFileSystem.ReadAllBytesShim(fileName)
+
+        // 一時パスおよびファイルのタイムスタンプに関連する機能を実装
+        member __.GetTempPathShim() = 
+            defaultFileSystem.GetTempPathShim()
+
+        member __.GetLastWriteTimeShim(fileName) = 
+            defaultFileSystem.GetLastWriteTimeShim(fileName)
+
+        member __.GetFullPathShim(fileName) = 
+            defaultFileSystem.GetFullPathShim(fileName)
+
+        member __.IsInvalidPathShim(fileName) = 
+            defaultFileSystem.IsInvalidPathShim(fileName)
+
+        member __.IsPathRootedShim(fileName) = 
+            defaultFileSystem.IsPathRootedShim(fileName)
+
+        // ファイルの存在確認および削除に関連する機能を実装
+        member __.SafeExists(fileName) = 
+            files.ContainsKey(fileName) || defaultFileSystem.SafeExists(fileName)
+
+        member __.FileDelete(fileName) = 
+            defaultFileSystem.FileDelete(fileName)
+
+        // アセンブリのロードに関連する機能を実装。
+        // 型プロバイダやF# Interactiveで使用される。
+        member __.AssemblyLoadFrom(fileName) = 
+            defaultFileSystem.AssemblyLoadFrom fileName
+
+        member __.AssemblyLoad(assemblyName) = 
+            defaultFileSystem.AssemblyLoad assemblyName 
+
+let myFileSystem = MyFileSystem()
+Shim.FileSystem <- MyFileSystem() 
+
    +

    FileSystemによるコンパイルの実行

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+18: 
+19: 
+20: 
+21: 
+22: 
+23: 
+24: 
+25: 
+26: 
+27: 
+28: 
+29: 
+30: 
+31: 
+32: 
+33: 
+34: 
+35: 
+36: 
+37: 
+38: 
+39: 
+40: 
+41: 
+42: 
+
    open FSharp.Compiler.SourceCodeServices
+
+let checker = FSharpChecker.Create()
+let projectOptions = 
+    let allFlags = 
+        [| yield "--simpleresolution"; 
+           yield "--noframework"; 
+           yield "--debug:full"; 
+           yield "--define:DEBUG"; 
+           yield "--optimize-"; 
+           yield "--doc:test.xml"; 
+           yield "--warn:3"; 
+           yield "--fullpaths"; 
+           yield "--flaterrors"; 
+           yield "--target:library"; 
+           let references =
+             [ @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\mscorlib.dll"; 
+               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.dll"; 
+               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.Core.dll"; 
+               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.0.0\FSharp.Core.dll"]
+           for r in references do 
+                 yield "-r:" + r |]
+ 
+    { ProjectFileName = @"c:\mycode\compilation.fsproj" // 現在のディレクトリで一意な名前を指定
+      ProjectId = None
+      SourceFiles = [| fileName1; fileName2 |]
+      OriginalLoadReferences = []
+      ExtraProjectInfo=None
+      Stamp = None
+      OtherOptions = allFlags 
+      ReferencedProjects=[| |]
+      IsIncompleteTypeCheckEnvironment = false
+      UseScriptResolutionRules = true 
+      LoadTime = System.DateTime.Now // 'Now' を指定して強制的に再読込させている点に注意
+      UnresolvedReferences = None }
+
+let results = checker.ParseAndCheckProject(projectOptions) |> Async.RunSynchronously
+
+results.Errors
+results.AssemblySignature.Entities.Count //2
+results.AssemblySignature.Entities.[0].MembersFunctionsAndValues.Count //1
+results.AssemblySignature.Entities.[0].MembersFunctionsAndValues.[0].DisplayName // "B"
+
    +

    まとめ

    +

    このチュートリアルでは FSharp.Compiler.Service コンポーネントで使用される +ファイルシステムに注目して、グローバルな設定を変更する方法について紹介しました。

    +

    このチュートリアルの執筆時点では、以下に列挙したSystem.IOの操作に対しては +仮想化されたファイルシステムAPIが用意されない予定になっています。 +将来のバージョンのコンパイラサービスではこれらのAPIが追加されるかもしれません。

    +
      +
    • Path.Combine
      • +
    • Path.DirectorySeparatorChar
      • +
    • Path.GetDirectoryName
      • +
    • Path.GetFileName
      • +
    • Path.GetFileNameWithoutExtension
      • +
    • Path.HasExtension
      • +
    • Path.GetRandomFileName (アセンブリ内にコンパイル済みwin32リソースを生成する場合にのみ使用される)
      • +
    +

    注意: SourceCodeServices API内の一部の操作では、 +引数にファイルの内容だけでなくファイル名を指定する必要があります。 +これらのAPIにおいて、ファイル名はエラーの報告のためだけに使用されます。

    +

    注意: 型プロバイダーコンポーネントは仮想化されたファイルシステムを使用しません。

    +

    注意: コンパイラサービスは --simpleresolution が指定されていない場合、 +MSBuildを使ってアセンブリの解決を試みることがあります。 +FileSystem APIを使用する場合、通常はコンパイラへのフラグとして +--simpleresolution を指定することになります。 +それと同時に --noframework を指定します。 +.NETアセンブリに対するすべての参照を明示的に指定する必要があるでしょう。

    + +
    namespace System
    +
    namespace System.IO
    +
    namespace System.Collections
    +
    namespace System.Collections.Generic
    +
    namespace System.Text
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    +
    namespace FSharp.Compiler
    +
    namespace FSharp.Compiler.AbstractIL
    +
    namespace FSharp.Compiler.AbstractIL.Internal
    +
    module Library

    from FSharp.Compiler.AbstractIL.Internal
    +
    val defaultFileSystem : IFileSystem
    +
    module Shim

    from FSharp.Compiler.AbstractIL.Internal.Library
    +
    val mutable FileSystem : IFileSystem
    +
    val fileName1 : string
    +
    val fileName2 : string
    +
    Multiple items
    type MyFileSystem =
      interface IFileSystem
      new : unit -> MyFileSystem

    --------------------
    new : unit -> MyFileSystem
    +
    val file1 : string
    +
    val file2 : string
    +
    val files : IDictionary<string,string>
    +
    val dict : keyValuePairs:seq<'Key * 'Value> -> IDictionary<'Key,'Value> (requires equality)
    +
    type IFileSystem =
      interface
        abstract member AssemblyLoad : assemblyName:AssemblyName -> Assembly
        abstract member AssemblyLoadFrom : fileName:string -> Assembly
        abstract member FileDelete : fileName:string -> unit
        abstract member FileStreamCreateShim : fileName:string -> Stream
        abstract member FileStreamReadShim : fileName:string -> Stream
        abstract member FileStreamWriteExistingShim : fileName:string -> Stream
        abstract member GetFullPathShim : fileName:string -> string
        abstract member GetLastWriteTimeShim : fileName:string -> DateTime
        abstract member GetTempPathShim : unit -> string
        abstract member IsInvalidPathShim : filename:string -> bool
        ...
      end
    +
    val fileName : string
    +
    IDictionary.TryGetValue(key: string, value: byref<string>) : bool
    +
    val text : string
    +
    Multiple items
    type MemoryStream =
      inherit Stream
      new : unit -> MemoryStream + 6 overloads
      member CanRead : bool
      member CanSeek : bool
      member CanWrite : bool
      member Capacity : int with get, set
      member CopyTo : destination:Stream * bufferSize:int -> unit
      member CopyToAsync : destination:Stream * bufferSize:int * cancellationToken:CancellationToken -> Task
      member Flush : unit -> unit
      member FlushAsync : cancellationToken:CancellationToken -> Task
      member GetBuffer : unit -> byte[]
      ...

    --------------------
    MemoryStream() : MemoryStream
    MemoryStream(capacity: int) : MemoryStream
    MemoryStream(buffer: byte []) : MemoryStream
    MemoryStream(buffer: byte [], writable: bool) : MemoryStream
    MemoryStream(buffer: byte [], index: int, count: int) : MemoryStream
    MemoryStream(buffer: byte [], index: int, count: int, writable: bool) : MemoryStream
    MemoryStream(buffer: byte [], index: int, count: int, writable: bool, publiclyVisible: bool) : MemoryStream
    +
    type Encoding =
      member BodyName : string
      member Clone : unit -> obj
      member CodePage : int
      member DecoderFallback : DecoderFallback with get, set
      member EncoderFallback : EncoderFallback with get, set
      member EncodingName : string
      member Equals : value:obj -> bool
      member GetByteCount : chars:char[] -> int + 5 overloads
      member GetBytes : chars:char[] -> byte[] + 7 overloads
      member GetCharCount : bytes:byte[] -> int + 3 overloads
      ...
    +
    property Encoding.UTF8: Encoding with get
    +
    Encoding.GetBytes(s: string) : byte []
    Encoding.GetBytes(chars: char []) : byte []
    Encoding.GetBytes(chars: ReadOnlySpan<char>, bytes: Span<byte>) : int
    Encoding.GetBytes(s: string, index: int, count: int) : byte []
    Encoding.GetBytes(chars: char [], index: int, count: int) : byte []
    Encoding.GetBytes(chars: nativeptr<char>, charCount: int, bytes: nativeptr<byte>, byteCount: int) : int
    Encoding.GetBytes(s: string, charIndex: int, charCount: int, bytes: byte [], byteIndex: int) : int
    Encoding.GetBytes(chars: char [], charIndex: int, charCount: int, bytes: byte [], byteIndex: int) : int
    +
    type Stream =
      inherit MarshalByRefObject
      member BeginRead : buffer:byte[] * offset:int * count:int * callback:AsyncCallback * state:obj -> IAsyncResult
      member BeginWrite : buffer:byte[] * offset:int * count:int * callback:AsyncCallback * state:obj -> IAsyncResult
      member CanRead : bool
      member CanSeek : bool
      member CanTimeout : bool
      member CanWrite : bool
      member Close : unit -> unit
      member CopyTo : destination:Stream -> unit + 1 overload
      member CopyToAsync : destination:Stream -> Task + 3 overloads
      member Dispose : unit -> unit
      ...
    +
    abstract member IFileSystem.FileStreamReadShim : fileName:string -> Stream
    +
    val __ : MyFileSystem
    +
    abstract member IFileSystem.FileStreamCreateShim : fileName:string -> Stream
    +
    abstract member IFileSystem.IsStableFileHeuristic : fileName:string -> bool
    +
    abstract member IFileSystem.FileStreamWriteExistingShim : fileName:string -> Stream
    +
    abstract member IFileSystem.ReadAllBytesShim : fileName:string -> byte []
    +
    abstract member IFileSystem.GetTempPathShim : unit -> string
    +
    abstract member IFileSystem.GetLastWriteTimeShim : fileName:string -> DateTime
    +
    abstract member IFileSystem.GetFullPathShim : fileName:string -> string
    +
    abstract member IFileSystem.IsInvalidPathShim : filename:string -> bool
    +
    abstract member IFileSystem.IsPathRootedShim : path:string -> bool
    +
    IDictionary.ContainsKey(key: string) : bool
    +
    abstract member IFileSystem.SafeExists : fileName:string -> bool
    +
    abstract member IFileSystem.FileDelete : fileName:string -> unit
    +
    abstract member IFileSystem.AssemblyLoadFrom : fileName:string -> Reflection.Assembly
    +
    val assemblyName : Reflection.AssemblyName
    +
    abstract member IFileSystem.AssemblyLoad : assemblyName:Reflection.AssemblyName -> Reflection.Assembly
    +
    val myFileSystem : MyFileSystem
    +
    namespace FSharp.Compiler.SourceCodeServices
    +
    val checker : FSharpChecker
    +
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    +
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    +
    val projectOptions : FSharpProjectOptions
    +
    val allFlags : string []
    +
    val references : string list
    +
    val r : string
    +
    union case Option.None: Option<'T>
    +
    Multiple items
    type DateTime =
      struct
        new : ticks:int64 -> DateTime + 10 overloads
        member Add : value:TimeSpan -> DateTime
        member AddDays : value:float -> DateTime
        member AddHours : value:float -> DateTime
        member AddMilliseconds : value:float -> DateTime
        member AddMinutes : value:float -> DateTime
        member AddMonths : months:int -> DateTime
        member AddSeconds : value:float -> DateTime
        member AddTicks : value:int64 -> DateTime
        member AddYears : value:int -> DateTime
        ...
      end

    --------------------
    DateTime ()
       (+0 other overloads)
    DateTime(ticks: int64) : DateTime
       (+0 other overloads)
    DateTime(ticks: int64, kind: DateTimeKind) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) : DateTime
       (+0 other overloads)
    DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) : DateTime
       (+0 other overloads)
    +
    property DateTime.Now: DateTime with get
    +
    val results : FSharpCheckProjectResults
    +
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    property FSharpCheckProjectResults.Errors: FSharpErrorInfo [] with get
    +
    property FSharpCheckProjectResults.AssemblySignature: FSharpAssemblySignature with get
    +
    property FSharpAssemblySignature.Entities: IList<FSharpEntity> with get
    +
    property ICollection.Count: int with get
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/index.html b/docs/ja/index.html new file mode 100644 index 0000000000..51e9b71433 --- /dev/null +++ b/docs/ja/index.html @@ -0,0 +1,158 @@ + + + + + F# コンパイラサービス + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    F# コンパイラサービス

    +

    F# コンパイラサービスパッケージはF# コンパイラのソースコードから派生したコンポーネントです。 +このソースコードにはF# 言語バインディングを実装するための機能や、 +コンパイラやリファクタリングツールを元にしたツールを作成するための機能が追加されています。 +また、パッケージには自身のアプリケーションにF# スクリプトを埋め込む際に利用できるような +F# インタラクティブサービスも含まれています。

    +
    +
    +
    +
    + F# コンパイラサービスパッケージは NuGet経由でインストールできます: + 
    PM> Install-Package FSharp.Compiler.Service
    +
    +
    +
    +
    +

    利用可能なサービス

    +

    プロジェクトには現在以下のサービスがあり、いずれもテストされ、 +このページから参照可能なドキュメントがあります。 +ライブラリには他にも使用可能な公開APIがありますが、 +ここではドキュメント化されていません。

    +
      +
    • +

      F# 言語トークナイザ - F#ソースコードをトークンのストリームへと変換します。 +この機能はソースコードを色つき表示したり、基本的なツールを作成するような場合に有効です。 +ネストされたコメントや文字列なども適切に処理できます。

      +
      • +
    • +

      型無しASTの処理 - この機能を使うことで型無し抽象構文木(AST: abstract syntax tree)にアクセスできます。 +型無しASTとは型情報を含まない解析済みのF#の文法を表すもので、 +コードフォーマットやその他様々な単純処理に利用できます。

      +
      • +
    • +

      エディタ (IDE) サービスの使用 - 自動補完やツールチップ、 +引数の情報などを表示するための機能があります。 +この機能を使うと、F#サポート機能をエディタに追加したり、F#コードから +何らかの型情報を取得したりすることができるようになります。

      +
      • +
    • +

      シグネチャや型、解決済みのシンボルの処理 - +解決済みのシンボルや推測された型の表現、アセンブリ全体のシグネチャなどを +型のチェック時に返すような多数のサービスがあります。

      +
      • +
    • +

      複数プロジェクトやプロジェクト全体の処理 - +すべてのプロジェクトに対するチェックを実行することにより、 +プロジェクト全体の解析結果を使って[すべての参照の検索] のような +機能を実現できます。

      +
      • +
    • +

      F# Interactive のホスティング - 自身の.NETコードから +F# Interactiveを.NETライブラリとして呼び出すことができるようになります。 +このAPIを使用すると、自身のプロジェクト内でF#をスクリプト言語として +埋め込むことができるようになります。

      +
      • +
    • +

      F#コンパイラのホスティング - F# コンパイラを +呼び出すコードを組み込むことができます。

      +
      • +
    • +

      ファイルシステムAPI - FSharp.Compiler.Service コンポーネントには +ファイルシステムを表すグローバル変数が定義されています。 +この変数を設定することによって、ファイルシステムが使用できない状況であっても +コンパイラをホストすることができるようになります。

      +
      • +
    +
    +

    注釈: FSharp.Compiler.Service.dll には既存のものと重複する機能が多数あるため、 +将来的にはもっときちんとした形に変更されます。 +そのため、これらのサービスを使用するAPIには破壊的変更が加えられる可能性があります。

    +
    +

    貢献および著作権について

    +

    このプロジェクトは fsharp/fsharp からフォークしたもので、 +そこへさらにエディタやF#用ツール、F# Interactiveの組み込みに必要となる機能を +追加したものです。

    +

    F# ソースコードの著作権はMicrosoft Corporationおよび貢献者に、 +拡張機能の著作権は Dave Thomas, Anh-Dung Phan, Tomas Petricek および +その他の貢献者にあります。 +ソースコードは MIT ライセンス の元に公開されています。

    + + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/interactive.html b/docs/ja/interactive.html new file mode 100644 index 0000000000..5588c53b97 --- /dev/null +++ b/docs/ja/interactive.html @@ -0,0 +1,547 @@ + + + + + インタラクティブサービス: F# Interactiveの組み込み + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    インタラクティブサービス: F# Interactiveの組み込み

    +

    このチュートリアルでは、独自のアプリケーションに +F# Interactiveを組み込む方法について紹介します。 +F# Interactiveは対話式のスクリプティング環境で、 +F#コードを高度に最適化されたILコードへとコンパイルしつつ、 +それを即座に実行することができます。 +F# Interactiveサービスを使用すると、独自のアプリケーションに +F#の評価機能を追加できます。

    +
    +

    注意: F# Interactiveは様々な方法で組み込むことができます。 +最も簡単な方法は fsi.exe プロセスとの間で標準入出力経由でやりとりする方法です。 +このチュートリアルではF# Interactiveの機能を.NET APIで +直接呼び出す方法について紹介します。 +ただし入力用のコントロールを備えていない場合、別プロセスでF# Interactiveを +起動するのはよい方法だといえます。 +理由の1つとしては StackOverflowException を処理する方法がないため、 +出来の悪いスクリプトによってはホストプロセスが停止させられてしまう +場合があるからです。 +.NET APIを通じてF# Interactiveを呼び出すとしても、 --shadowcopyreferences +オプションは無視されることを覚えておきましょう。 +詳細な議論については、このスレッド +に目を通してみてください。 +注意: もしFSharp.Core.dll が見つからないというエラーが出て FsiEvaluationSession.Create +に失敗した場合、 FSharp.Core.sigdata と FSharp.Core.optdata というファイルを追加してください。 +詳しい内容はこちら +にあります。

    +
    +

    しかしそれでもF# InteractiveサービスにはF# Interactiveを実行ファイルに埋め込んで +実行出来る(そしてアプリケーションの各機能とやりとり出来る)、あるいは +機能限定されたF#コード(たとえば独自のDSLによって生成されたコード)だけを +実行させることが出来るという便利さがあります。

    +

    F# Interactiveの開始

    +

    まずF# Interactiveサービスを含むライブラリへの参照を追加します:

    + + + +
    1: 
+2: 
+3: 
+
    #r "FSharp.Compiler.Service.dll"
+open FSharp.Compiler.SourceCodeServices
+open FSharp.Compiler.Interactive.Shell
+
    +

    F# Interactiveとやりとりするには、入出力を表すストリームを作成する必要があります。 +これらのストリームを使用することで、 +いくつかのF#コードに対する評価結果を後から出力することができます:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+
    open System
+open System.IO
+open System.Text
+
+// 入出力のストリームを初期化
+let sbOut = new StringBuilder()
+let sbErr = new StringBuilder()
+let inStream = new StringReader("")
+let outStream = new StringWriter(sbOut)
+let errStream = new StringWriter(sbErr)
+
+// コマンドライン引数を組み立てて、FSIセッションを開始する
+let argv = [| "C:\\fsi.exe" |]
+let allArgs = Array.append argv [|"--noninteractive"|]
+
+let fsiConfig = FsiEvaluationSession.GetDefaultConfiguration()
+let fsiSession = FsiEvaluationSession.Create(fsiConfig, allArgs, inStream, outStream, errStream)  
+
    +

    コードの評価および実行

    +

    F# Interactiveサービスにはコードを評価するためのメソッドがいくつか用意されています。 +最初の1つは EvalExpression で、式を評価してその結果を返します。 +結果には戻り値が( obj として)含まれる他、値に対して静的に推論された型も含まれます:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+
    /// 式を評価して結果を返す
+let evalExpression text =
+  match fsiSession.EvalExpression(text) with
+  | Some value -> printfn "%A" value.ReflectionValue
+  | None -> printfn "結果が得られませんでした！"
+
    +

    これは引数に文字列を取り、それをF#コードとして評価(つまり実行)します。

    + + + +
    1: 
+
    evalExpression "42+1" // '43' を表示する
+
    +

    これは以下のように強く型付けされた方法で使うことができます:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
    /// 式を評価して、強く型付けされた結果を返す
+let evalExpressionTyped<'T> (text) =
+    match fsiSession.EvalExpression(text) with
+    | Some value -> value.ReflectionValue |> unbox<'T>
+    | None -> failwith "結果が得られませんでした！"
+
+evalExpressionTyped<int> "42+1"  // '43' になる
+
    +

    EvalInteraction メソッドは画面出力機能や宣言、 +F#の式としては不正なものの、F# Interactiveコンソールには入力できるようなものなど、 +副作用を伴う命令を評価する場合に使用できます。 +たとえば #time "on" (あるいはその他のディレクティブ)や open System 、 +その他の宣言やトップレベルステートメントなどが該当します。 +指定するコードの終端に ;; を入力する必要はありません。 +実行したいコードだけを入力します:

    + + + +
    1: 
+
    fsiSession.EvalInteraction "printfn \"bye\""
+
    +

    EvalScript メソッドを使用すると、完全な .fsx スクリプトを評価することができます。

    + + + +
    1: 
+2: 
+
    File.WriteAllText("sample.fsx", "let twenty = 10 + 10")
+fsiSession.EvalScript "sample.fsx"
+
    +

    例外処理

    +

    コードに型チェックの警告やエラーがあった場合、または評価して例外で失敗した場合、 +EvalExpression 、 EvalInteraction そして EvalScript ではあまりうまく処理されません。 +これらのケースでは、 EvalExpressionNonThrowing 、 EvalInteractionNonThrowing +そして EvalScriptNonThrowing を使うことが出来ます。 +これらは結果と FSharpErrorInfo 値の配列の組を返します。 +これらはエラーと警告を表します。結果の部分は実際の結果と例外のいずれかを表す +Choice<_,_> です。

    +

    EvalExpression および EvalExpressionNonThrowing の結果部分は +オプションの FSharpValue 値です。 +その値が存在しない場合、式が .NET オブジェクトとして表現できる具体的な結果を +持っていなかったということを指し示しています。 +この状況は実際には入力されたどんな通常の式に対しても発生すべきではなく、 +ライブラリ内で使われるプリミティブ値に対してのみ発生すべきです。

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
    File.WriteAllText("sample.fsx", "let twenty = 'a' + 10.0")
+let result, warnings = fsiSession.EvalScriptNonThrowing "sample.fsx"
+
+// 結果を表示する
+match result with 
+| Choice1Of2 () -> printfn "チェックと実行はOKでした"
+| Choice2Of2 exn -> printfn "実行例外: %s" exn.Message
+
    +

    は次のようになります:

    + + + +
    1: 
+
    実行例外: Operation could not be completed due to earlier error
+
    + + + +
    1: 
+2: 
+3: 
+
    // エラーと警告を表示する
+for w in warnings do 
+   printfn "警告 %s 場所 %d,%d" w.Message w.StartLineAlternate w.StartColumn
+
    +

    は次のようになります:

    + + + +
    1: 
+2: 
+
    警告 The type 'float' does not match the type 'char' 場所 1,19
+警告 The type 'float' does not match the type 'char' 場所 1,17
+
    +

    式に対しては:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+
    let evalExpressionTyped2<'T> text =
+   let res, warnings = fsiSession.EvalExpressionNonThrowing(text)
+   for w in warnings do 
+       printfn "警告 %s 場所 %d,%d" w.Message w.StartLineAlternate w.StartColumn 
+   match res with 
+   | Choice1Of2 (Some value) -> value.ReflectionValue |> unbox<'T>
+   | Choice1Of2 None -> failwith "null または結果がありません"
+   | Choice2Of2 (exn:exn) -> failwith (sprintf "例外 %s" exn.Message)
+
+evalExpressionTyped2<int> "42+1"  // '43' になる
+
    +

    並列実行

    +

    デフォルトでは EvalExpression に渡したコードは即時実行されます。 +並列に実行するために、タスクを開始する計算を投入します:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+
    open System.Threading.Tasks
+
+let sampleLongRunningExpr = 
+    """
+async { 
+    // 実行したいコード
+    do System.Threading.Thread.Sleep 5000
+    return 10 
+}
+  |> Async.StartAsTask"""
+
+let task1 = evalExpressionTyped<Task<int>>(sampleLongRunningExpr)  
+let task2 = evalExpressionTyped<Task<int>>(sampleLongRunningExpr)
+
    +

    両方の計算がいま開始しました。結果を取得することが出来ます:

    + + + +
    1: 
+2: 
+
    task1.Result // 完了後に結果が出てくる (最大5秒)
+task2.Result // 完了後に結果が出てくる (最大5秒)
+
    +

    評価コンテキスト内での型チェック

    +

    F# Interactiveの一連のスクリプティングセッション中で +コードの型チェックを実行したいような状況を考えてみましょう。 +たとえばまず宣言を評価します:

    + + + +
    1: 
+
    fsiSession.EvalInteraction "let xxx = 1 + 1"
+
    +

    次に部分的に完全な xxx + xx というコードの型チェックを実行したいとします:

    + + + +
    1: 
+2: 
+
    let parseResults, checkResults, checkProjectResults = 
+    fsiSession.ParseAndCheckInteraction("xxx + xx") |> Async.RunSynchronously
+
    +

    parseResults と checkResults はそれぞれ エディタ +のページで説明している ParseFileResults と CheckFileResults 型です。 +たとえば以下のようなコードでエラーを確認出来ます:

    + + + +
    1: 
+
    checkResults.Errors.Length // 1
+
    +

    コードはF# Interactiveセッション内において、その時点までに実行された +有効な宣言からなる論理的な型コンテキストと結びつく形でチェックされます。

    +

    また、宣言リスト情報やツールチップテキスト、シンボルの解決といった処理を +要求することもできます:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
    open FSharp.Compiler
+
+// ツールチップを取得する
+checkResults.GetToolTipText(1, 2, "xxx + xx", ["xxx"], FSharpTokenTag.IDENT) 
+
+checkResults.GetSymbolUseAtLocation(1, 2, "xxx + xx", ["xxx"]) // シンボル xxx
+  
+
    +

    'fsi'オブジェクト

    +

    スクリプトのコードが'fsi'オブジェクトにアクセスできるようにしたい場合、 +このオブジェクトの実装を明示的に渡さなければなりません。 +通常、FSharp.Compiler.Interactive.Settings.dll由来の1つが使われます。

    + + + +
    1: 
+
    let fsiConfig2 = FsiEvaluationSession.GetDefaultConfiguration(fsi)
+
    +

    収集可能なコード生成

    +

    FsiEvaluationSessionを使用してコードを評価すると、 +.NET の動的アセンブリを生成し、他のリソースを使用します。 +collectible=true を渡すことで、生成されたコードを収集可能に出来ます。 +しかしながら、例えば EvalExpression から返される FsiValue のような型を必要とする未解放のオブジェクト参照が無く、 +かつ FsiEvaluationSession を破棄したに違いない場合に限ってコードが収集されます。 +収集可能なアセンブリに対する制限 +も参照してください。

    +

    以下の例は200個の評価セッションを生成しています。 collectible=true と use session = ... +の両方を使っていることに気をつけてください。

    +

    収集可能なコードが正しく動いた場合、全体としてのリソース使用量は +評価が進んでも線形には増加しないでしょう。

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+
    let collectionTest() = 
+
+    for i in 1 .. 200 do
+        let defaultArgs = [|"fsi.exe";"--noninteractive";"--nologo";"--gui-"|]
+        use inStream = new StringReader("")
+        use outStream = new StringWriter()
+        use errStream = new StringWriter()
+
+        let fsiConfig = FsiEvaluationSession.GetDefaultConfiguration()
+        use session = FsiEvaluationSession.Create(fsiConfig, defaultArgs, inStream, outStream, errStream, collectible=true)
+        
+        session.EvalInteraction (sprintf "type D = { v : int }")
+        let v = session.EvalExpression (sprintf "{ v = 42 * %d }" i)
+        printfn "その %d, 結果 = %A" i v.Value.ReflectionValue
+
+// collectionTest()  <-- このようにテストを実行する
+
    + +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    +
    namespace FSharp.Compiler
    +
    namespace FSharp.Compiler.SourceCodeServices
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>
    +
    namespace FSharp.Compiler.Interactive
    +
    module Shell

    from FSharp.Compiler.Interactive
    +
    namespace System
    +
    namespace System.IO
    +
    namespace System.Text
    +
    val sbOut : StringBuilder
    +
    Multiple items
    type StringBuilder =
      new : unit -> StringBuilder + 5 overloads
      member Append : value:string -> StringBuilder + 22 overloads
      member AppendFormat : format:string * arg0:obj -> StringBuilder + 7 overloads
      member AppendJoin : separator:string * [<ParamArray>] values:obj[] -> StringBuilder + 5 overloads
      member AppendLine : unit -> StringBuilder + 1 overload
      member Capacity : int with get, set
      member Chars : int -> char with get, set
      member Clear : unit -> StringBuilder
      member CopyTo : sourceIndex:int * destination:Span<char> * count:int -> unit + 1 overload
      member EnsureCapacity : capacity:int -> int
      ...

    --------------------
    StringBuilder() : StringBuilder
    StringBuilder(capacity: int) : StringBuilder
    StringBuilder(value: string) : StringBuilder
    StringBuilder(value: string, capacity: int) : StringBuilder
    StringBuilder(capacity: int, maxCapacity: int) : StringBuilder
    StringBuilder(value: string, startIndex: int, length: int, capacity: int) : StringBuilder
    +
    val sbErr : StringBuilder
    +
    val inStream : StringReader
    +
    Multiple items
    type StringReader =
      inherit TextReader
      new : s:string -> StringReader
      member Close : unit -> unit
      member Peek : unit -> int
      member Read : unit -> int + 2 overloads
      member ReadAsync : buffer:Memory<char> * ?cancellationToken:CancellationToken -> ValueTask<int> + 1 overload
      member ReadBlock : buffer:Span<char> -> int
      member ReadBlockAsync : buffer:Memory<char> * ?cancellationToken:CancellationToken -> ValueTask<int> + 1 overload
      member ReadLine : unit -> string
      member ReadLineAsync : unit -> Task<string>
      member ReadToEnd : unit -> string
      ...

    --------------------
    StringReader(s: string) : StringReader
    +
    val outStream : StringWriter
    +
    Multiple items
    type StringWriter =
      inherit TextWriter
      new : unit -> StringWriter + 3 overloads
      member Close : unit -> unit
      member Encoding : Encoding
      member FlushAsync : unit -> Task
      member GetStringBuilder : unit -> StringBuilder
      member ToString : unit -> string
      member Write : value:char -> unit + 3 overloads
      member WriteAsync : value:char -> Task + 3 overloads
      member WriteLine : buffer:ReadOnlySpan<char> -> unit
      member WriteLineAsync : value:char -> Task + 3 overloads

    --------------------
    StringWriter() : StringWriter
    StringWriter(formatProvider: IFormatProvider) : StringWriter
    StringWriter(sb: StringBuilder) : StringWriter
    StringWriter(sb: StringBuilder, formatProvider: IFormatProvider) : StringWriter
    +
    val errStream : StringWriter
    +
    val argv : string []
    +
    val allArgs : string []
    +
    type Array =
      member Clone : unit -> obj
      member CopyTo : array:Array * index:int -> unit + 1 overload
      member GetEnumerator : unit -> IEnumerator
      member GetLength : dimension:int -> int
      member GetLongLength : dimension:int -> int64
      member GetLowerBound : dimension:int -> int
      member GetUpperBound : dimension:int -> int
      member GetValue : [<ParamArray>] indices:int[] -> obj + 7 overloads
      member Initialize : unit -> unit
      member IsFixedSize : bool
      ...
    +
    val append : array1:'T [] -> array2:'T [] -> 'T []
    +
    val fsiConfig : FsiEvaluationSessionHostConfig
    +
    type FsiEvaluationSession =
      interface IDisposable
      member EvalExpression : code:string -> FsiValue option
      member EvalExpressionNonThrowing : code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
      member EvalInteraction : code:string * ?cancellationToken:CancellationToken -> unit
      member EvalInteractionNonThrowing : code:string * ?cancellationToken:CancellationToken -> Choice<FsiValue option,exn> * FSharpErrorInfo []
      member EvalScript : filePath:string -> unit
      member EvalScriptNonThrowing : filePath:string -> Choice<unit,exn> * FSharpErrorInfo []
      member FormatValue : reflectionValue:obj * reflectionType:Type -> string
      member GetCompletions : longIdent:string -> seq<string>
      member Interrupt : unit -> unit
      ...
    +
    static member FsiEvaluationSession.GetDefaultConfiguration : unit -> FsiEvaluationSessionHostConfig
    static member FsiEvaluationSession.GetDefaultConfiguration : fsiObj:obj -> FsiEvaluationSessionHostConfig
    static member FsiEvaluationSession.GetDefaultConfiguration : fsiObj:obj * useFsiAuxLib:bool -> FsiEvaluationSessionHostConfig
    +
    val fsiSession : FsiEvaluationSession
    +
    static member FsiEvaluationSession.Create : fsiConfig:FsiEvaluationSessionHostConfig * argv:string [] * inReader:TextReader * outWriter:TextWriter * errorWriter:TextWriter * ?collectible:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver -> FsiEvaluationSession
    +
    val evalExpression : text:string -> unit


     式を評価して結果を返す
    +
    val text : string
    +
    member FsiEvaluationSession.EvalExpression : code:string -> FsiValue option
    +
    union case Option.Some: Value: 'T -> Option<'T>
    +
    val value : FsiValue
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    property FsiValue.ReflectionValue: obj with get
    +
    union case Option.None: Option<'T>
    +
    val evalExpressionTyped : text:string -> 'T


     式を評価して、強く型付けされた結果を返す
    +
    val unbox : value:obj -> 'T
    +
    val failwith : message:string -> 'T
    +
    Multiple items
    val int : value:'T -> int (requires member op_Explicit)

    --------------------
    type int = int32

    --------------------
    type int<'Measure> = int
    +
    member FsiEvaluationSession.EvalInteraction : code:string * ?cancellationToken:Threading.CancellationToken -> unit
    +
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllLinesAsync : path:string * contents:IEnumerable<string> * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendAllTextAsync : path:string * contents:string * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 2 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      ...
    +
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Encoding) : unit
    +
    member FsiEvaluationSession.EvalScript : filePath:string -> unit
    +
    val result : Choice<unit,exn>
    +
    val warnings : FSharpErrorInfo []
    +
    member FsiEvaluationSession.EvalScriptNonThrowing : filePath:string -> Choice<unit,exn> * FSharpErrorInfo []
    +
    union case Choice.Choice1Of2: 'T1 -> Choice<'T1,'T2>
    +
    union case Choice.Choice2Of2: 'T2 -> Choice<'T1,'T2>
    +
    Multiple items
    val exn : exn

    --------------------
    type exn = Exception
    +
    property Exception.Message: string with get
    +
    val not : value:bool -> bool
    +
    val w : FSharpErrorInfo
    +
    property FSharpErrorInfo.Message: string with get
    +
    property FSharpErrorInfo.StartLineAlternate: int with get
    +
    property FSharpErrorInfo.StartColumn: int with get
    +
    val evalExpressionTyped2 : text:string -> 'T
    +
    val res : Choice<FsiValue option,exn>
    +
    member FsiEvaluationSession.EvalExpressionNonThrowing : code:string -> Choice<FsiValue option,exn> * FSharpErrorInfo []
    +
    val sprintf : format:Printf.StringFormat<'T> -> 'T
    +
    namespace System.Threading
    +
    namespace System.Threading.Tasks
    +
    val sampleLongRunningExpr : string
    +
    val task1 : Task<int>
    +
    Multiple items
    type Task =
      new : action:Action -> Task + 7 overloads
      member AsyncState : obj
      member ConfigureAwait : continueOnCapturedContext:bool -> ConfiguredTaskAwaitable
      member ContinueWith : continuationAction:Action<Task> -> Task + 19 overloads
      member CreationOptions : TaskCreationOptions
      member Dispose : unit -> unit
      member Exception : AggregateException
      member GetAwaiter : unit -> TaskAwaiter
      member Id : int
      member IsCanceled : bool
      ...

    --------------------
    type Task<'TResult> =
      inherit Task
      new : function:Func<'TResult> -> Task<'TResult> + 7 overloads
      member ConfigureAwait : continueOnCapturedContext:bool -> ConfiguredTaskAwaitable<'TResult>
      member ContinueWith : continuationAction:Action<Task<'TResult>> -> Task + 19 overloads
      member GetAwaiter : unit -> TaskAwaiter<'TResult>
      member Result : 'TResult
      static member Factory : TaskFactory<'TResult>

    --------------------
    Task(action: Action) : Task
    Task(action: Action, cancellationToken: Threading.CancellationToken) : Task
    Task(action: Action, creationOptions: TaskCreationOptions) : Task
    Task(action: Action<obj>, state: obj) : Task
    Task(action: Action, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task
    Task(action: Action<obj>, state: obj, cancellationToken: Threading.CancellationToken) : Task
    Task(action: Action<obj>, state: obj, creationOptions: TaskCreationOptions) : Task
    Task(action: Action<obj>, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task

    --------------------
    Task(function: Func<'TResult>) : Task<'TResult>
    Task(function: Func<'TResult>, cancellationToken: Threading.CancellationToken) : Task<'TResult>
    Task(function: Func<'TResult>, creationOptions: TaskCreationOptions) : Task<'TResult>
    Task(function: Func<obj,'TResult>, state: obj) : Task<'TResult>
    Task(function: Func<'TResult>, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task<'TResult>
    Task(function: Func<obj,'TResult>, state: obj, cancellationToken: Threading.CancellationToken) : Task<'TResult>
    Task(function: Func<obj,'TResult>, state: obj, creationOptions: TaskCreationOptions) : Task<'TResult>
    Task(function: Func<obj,'TResult>, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task<'TResult>
    +
    val task2 : Task<int>
    +
    property Task.Result: int with get
    +
    val parseResults : FSharpParseFileResults
    +
    val checkResults : FSharpCheckFileResults
    +
    val checkProjectResults : FSharpCheckProjectResults
    +
    member FsiEvaluationSession.ParseAndCheckInteraction : code:string -> Async<FSharpParseFileResults * FSharpCheckFileResults * FSharpCheckProjectResults>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    property FSharpCheckFileResults.Errors: FSharpErrorInfo [] with get
    +
    property Array.Length: int with get
    +
    member FSharpCheckFileResults.GetToolTipText : line:int * colAtEndOfNames:int * lineText:string * names:string list * tokenTag:int * ?userOpName:string -> Async<FSharpToolTipText>
    +
    module FSharpTokenTag

    from FSharp.Compiler.SourceCodeServices
    +
    val IDENT : int
    +
    member FSharpCheckFileResults.GetSymbolUseAtLocation : line:int * colAtEndOfNames:int * lineText:string * names:string list * ?userOpName:string -> Async<FSharpSymbolUse option>
    +
    val fsiConfig2 : FsiEvaluationSessionHostConfig
    +
    val collectionTest : unit -> unit
    +
    val i : int32
    +
    val defaultArgs : string []
    +
    val session : FsiEvaluationSession
    +
    static member FsiEvaluationSession.Create : fsiConfig:FsiEvaluationSessionHostConfig * argv:string [] * inReader:TextReader * outWriter:TextWriter * errorWriter:TextWriter * ?collectible:bool * ?legacyReferenceResolver:ReferenceResolver.Resolver -> FsiEvaluationSession
    +
    val v : FsiValue option
    +
    property Option.Value: FsiValue with get
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/project.html b/docs/ja/project.html new file mode 100644 index 0000000000..fbaad56e53 --- /dev/null +++ b/docs/ja/project.html @@ -0,0 +1,559 @@ + + + + + コンパイラサービス: プロジェクトの分析 + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    コンパイラサービス: プロジェクトの分析

    +

    このチュートリアルではF#コンパイラによって提供されるサービスを使用して +プロジェクト全体を分析する方法について紹介します。

    +
    +

    注意: 以下で使用しているAPIは試験的なもので、 +最新のnugetパッケージの公開に伴って変更されることがあります。

    +
    +

    プロジェクト全体の結果を取得する

    +

    以前の(型無しASTを使った)チュートリアル と同じく、 +まずは FSharp.Compiler.Service.dll への参照追加と、適切な名前空間のオープン、 +FSharpChecker インスタンスの作成を行います:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+8: 
+9: 
+
    // F#コンパイラAPIへの参照
+#r "FSharp.Compiler.Service.dll"
+
+open System
+open System.Collections.Generic
+open FSharp.Compiler.SourceCodeServices
+
+// インタラクティブチェッカーのインスタンスを作成
+let checker = FSharpChecker.Create()
+
    +

    今回のサンプル入力は以下の通りです:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+18: 
+19: 
+20: 
+21: 
+22: 
+23: 
+24: 
+25: 
+26: 
+27: 
+28: 
+29: 
+30: 
+31: 
+32: 
+33: 
+34: 
+35: 
+
    module Inputs = 
+    open System.IO
+
+    let base1 = Path.GetTempFileName()
+    let fileName1 = Path.ChangeExtension(base1, ".fs")
+    let base2 = Path.GetTempFileName()
+    let fileName2 = Path.ChangeExtension(base2, ".fs")
+    let dllName = Path.ChangeExtension(base2, ".dll")
+    let projFileName = Path.ChangeExtension(base2, ".fsproj")
+    let fileSource1 = """
+module M
+
+type C() = 
+    member x.P = 1
+
+let xxx = 3 + 4
+let fff () = xxx + xxx
+    """
+    File.WriteAllText(fileName1, fileSource1)
+
+    let fileSource2 = """
+module N
+
+open M
+
+type D1() = 
+    member x.SomeProperty = M.xxx
+
+type D2() = 
+    member x.SomeProperty = M.fff()
+
+// 警告を発生させる
+let y2 = match 1 with 1 -> M.xxx
+    """
+    File.WriteAllText(fileName2, fileSource2)
+
    +

    GetProjectOptionsFromCommandLineArgs を使用して、 +2つのファイルを1つのプロジェクトとして扱えるようにします:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+18: 
+19: 
+20: 
+21: 
+22: 
+23: 
+
    let projectOptions = 
+    checker.GetProjectOptionsFromCommandLineArgs
+       (Inputs.projFileName,
+        [| yield "--simpleresolution" 
+           yield "--noframework" 
+           yield "--debug:full" 
+           yield "--define:DEBUG" 
+           yield "--optimize-" 
+           yield "--out:" + Inputs.dllName
+           yield "--doc:test.xml" 
+           yield "--warn:3" 
+           yield "--fullpaths" 
+           yield "--flaterrors" 
+           yield "--target:library" 
+           yield Inputs.fileName1
+           yield Inputs.fileName2
+           let references = 
+             [ @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\mscorlib.dll" 
+               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.dll" 
+               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.Core.dll" 
+               @"C:\Program Files (x86)\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.3.0.0\FSharp.Core.dll"]  
+           for r in references do
+                 yield "-r:" + r |])
+
    +

    そして(ディスク上に保存されたファイルを使用して) +プロジェクト全体をチェックします:

    + + + +
    1: 
+
    let wholeProjectResults = checker.ParseAndCheckProject(projectOptions) |> Async.RunSynchronously
+
    +

    発生したエラーと警告は以下のようにしてチェックできます:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
    wholeProjectResults.Errors.Length // 1
+wholeProjectResults.Errors.[0].Message.Contains("Incomplete pattern matches on this expression") // true
+
+wholeProjectResults.Errors.[0].StartLineAlternate // 13
+wholeProjectResults.Errors.[0].EndLineAlternate // 13
+wholeProjectResults.Errors.[0].StartColumn // 15
+wholeProjectResults.Errors.[0].EndColumn // 16
+
    +

    推測されたプロジェクトのシグネチャをチェックします:

    + + + +
    1: 
+2: 
+3: 
+4: 
+
    [ for x in wholeProjectResults.AssemblySignature.Entities -> x.DisplayName ] // ["N"; "M"]
+[ for x in wholeProjectResults.AssemblySignature.Entities.[0].NestedEntities -> x.DisplayName ] // ["D1"; "D2"]
+[ for x in wholeProjectResults.AssemblySignature.Entities.[1].NestedEntities -> x.DisplayName ] // ["C"]
+[ for x in wholeProjectResults.AssemblySignature.Entities.[0].MembersFunctionsAndValues -> x.DisplayName ] // ["y2"]
+
    +

    プロジェクト内の全シンボルを取得することもできます:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+
    let rec allSymbolsInEntities (entities: IList<FSharpEntity>) = 
+    [ for e in entities do 
+          yield (e :> FSharpSymbol) 
+          for x in e.MembersFunctionsAndValues do
+             yield (x :> FSharpSymbol)
+          for x in e.UnionCases do
+             yield (x :> FSharpSymbol)
+          for x in e.FSharpFields do
+             yield (x :> FSharpSymbol)
+          yield! allSymbolsInEntities e.NestedEntities ]
+
+let allSymbols = allSymbolsInEntities wholeProjectResults.AssemblySignature.Entities
+
    +

    プロジェクト全体のチェックが完了した後は、 +プロジェクト内の各ファイルに対する個別の結果を取得することもできます。 +この処理は即座に完了し、改めてチェックが実行されることもありません。

    + + + +
    1: 
+2: 
+3: 
+
    let backgroundParseResults1, backgroundTypedParse1 = 
+    checker.GetBackgroundCheckResultsForFileInProject(Inputs.fileName1, projectOptions) 
+    |> Async.RunSynchronously
+
    +

    そしてそれぞれのファイル内にあるシンボルを解決できます:

    + + + +
    1: 
+2: 
+3: 
+
    let xSymbol = 
+    backgroundTypedParse1.GetSymbolUseAtLocation(9,9,"",["xxx"])
+    |> Async.RunSynchronously
+
    +

    それぞれのシンボルに対して、シンボルへの参照を検索することもできます:

    + + + +
    1: 
+
    let usesOfXSymbol = wholeProjectResults.GetUsesOfSymbol(xSymbol.Value.Symbol)
+
    +

    推測されたシグネチャ内にあるすべての定義済みシンボルに対して、 +それらがどこで使用されているのかを探し出すこともできます:

    + + + +
    1: 
+2: 
+3: 
+
    let allUsesOfAllSignatureSymbols = 
+    [ for s in allSymbols do 
+         yield s.ToString(), wholeProjectResults.GetUsesOfSymbol(s) ]
+
    +

    (ローカルスコープで使用されているものも含めて) +プロジェクト全体で使用されているすべてのシンボルを確認することもできます：

    + + + +
    1: 
+
    let allUsesOfAllSymbols = wholeProjectResults.GetAllUsesOfAllSymbols()
+
    +

    また、プロジェクト内のファイルに対して、更新後のバージョンに対して +チェックを実行するようにリクエストすることもできます +(なお FileSystem API を使用していない場合には、 +プロジェクト内のその他のファイルがまだディスクから +読み取り中であることに注意してください):

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+
    let parseResults1, checkAnswer1 = 
+    checker.ParseAndCheckFileInProject(Inputs.fileName1, 0, Inputs.fileSource1, projectOptions) 
+    |> Async.RunSynchronously
+
+let checkResults1 = 
+    match checkAnswer1 with 
+    | FSharpCheckFileAnswer.Succeeded x ->  x 
+    | _ -> failwith "想定外の終了状態です"
+
+let parseResults2, checkAnswer2 = 
+    checker.ParseAndCheckFileInProject(Inputs.fileName2, 0, Inputs.fileSource2, projectOptions)
+    |> Async.RunSynchronously
+
+let checkResults2 = 
+    match checkAnswer2 with 
+    | FSharpCheckFileAnswer.Succeeded x ->  x 
+    | _ -> failwith "想定外の終了状態です"
+
    +

    そして再びシンボルを解決したり、参照を検索したりすることができます:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+
    let xSymbol2 = 
+    checkResults1.GetSymbolUseAtLocation(9,9,"",["xxx"]) 
+    |> Async.RunSynchronously
+
+let usesOfXSymbol2 = wholeProjectResults.GetUsesOfSymbol(xSymbol2.Value.Symbol)
+
    +

    あるいは(ローカルスコープで使用されているシンボルも含めて) +ファイル中で使用されているすべてのシンボルを検索することもできます：

    + + + +
    1: 
+
    let allUsesOfAllSymbolsInFile1 = checkResults1.GetAllUsesOfAllSymbolsInFile()
+
    +

    あるいは特定のファイル中で使用されているシンボルを検索することもできます：

    + + + +
    1: 
+2: 
+3: 
+
    let allUsesOfXSymbolInFile1 = checkResults1.GetUsesOfSymbolInFile(xSymbol2.Value.Symbol)
+
+let allUsesOfXSymbolInFile2 = checkResults2.GetUsesOfSymbolInFile(xSymbol2.Value.Symbol)
+
    +

    複数プロジェクトの分析

    +

    複数のプロジェクトにまたがった参照があるような、 +複数のF# プロジェクトを分析したい場合、 +それらのプロジェクトを一旦ビルドして、 +ProjectOptionsで -r:プロジェクト-出力-までの-パス.dll 引数を指定して +プロジェクトの相互参照を設定すると一番簡単です。 +しかしこの場合、それぞれのプロジェクトが正しくビルド出来、 +DLLファイルが参照可能なディスク上に生成されなければいけません。

    +

    たとえばIDEを操作している場合など、状況によっては +DLLのコンパイルが通るようになる前に +プロジェクトを参照したいことがあるでしょう。 +この場合はProjectOptionsのReferencedProjectsを設定します。 +この値には依存するプロジェクトのオプションを再帰的に指定します。 +それぞれのプロジェクト参照にはやはり、 +ReferencedProjectsのエントリそれぞれに対応する +-r:プロジェクト-出力-までの-パス.dll というコマンドライン引数を +ProjectOptionsに設定する必要があります。

    +

    プロジェクト参照が設定されると、ソースファイルからのF#プロジェクト分析処理が +インクリメンタル分析の結果を使用して行われるようになります。 +その際にはソースファイルファイルをDLLへとコンパイルする必要はありません。

    +

    相互参照を含むようなF#プロジェクトを効率よく分析するには、 +ReferencedProjectsを正しく設定した後、 +それぞれのプロジェクトを順番通りに分析していくとよいでしょう。

    +
    +

    注意： プロジェクトの参照機能は試作段階です。 +プロジェクトの参照を使用すると、依存先のプロジェクトがまだ分析中で、 +要求したサービスがまだ利用できないことがあるため、 +コンパイラサービスの性能が低下することがあります。 +注意： アセンブリが型プロバイダーのコンポーネントを含む場合、 +プロジェクト参照機能は利用できません。 +プロジェクトの分析処理を強制しない限りはプロジェクト参照を設定しても +効果がありません。 +また、分析を強制する場合にはディスク上にDLLが存在しなければいけません。

    +
    +

    まとめ

    +

    これまで説明してきた通り、 ParseAndCheckProject を使用すると +シンボルの参照などのようなプロジェクト全体の解析結果にアクセスできるようになります。 +シンボルに対する処理の詳細については シンボル のページを参照してください。

    + +
    namespace System
    +
    namespace System.Collections
    +
    namespace System.Collections.Generic
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    +
    namespace FSharp.Compiler
    +
    namespace FSharp.Compiler.SourceCodeServices
    +
    val checker : FSharpChecker
    +
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    +
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    +
    namespace System.IO
    +
    val base1 : string
    +
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val PathSeparator : char
      static val InvalidPathChars : char[]
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string + 1 overload
      static member GetExtension : path:string -> string + 1 overload
      static member GetFileName : path:string -> string + 1 overload
      ...
    +
    Path.GetTempFileName() : string
    +
    val fileName1 : string
    +
    Path.ChangeExtension(path: string, extension: string) : string
    +
    val base2 : string
    +
    val fileName2 : string
    +
    val dllName : string
    +
    val projFileName : string
    +
    val fileSource1 : string
    +
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllLinesAsync : path:string * contents:IEnumerable<string> * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendAllTextAsync : path:string * contents:string * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 2 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      ...
    +
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    +
    val fileSource2 : string
    +
    val projectOptions : FSharpProjectOptions
    +
    member FSharpChecker.GetProjectOptionsFromCommandLineArgs : projectFileName:string * argv:string [] * ?loadedTimeStamp:DateTime * ?extraProjectInfo:obj -> FSharpProjectOptions
    +
    module Inputs

    from Project
    +
    val references : string list
    +
    val r : string
    +
    val wholeProjectResults : FSharpCheckProjectResults
    +
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    property FSharpCheckProjectResults.Errors: FSharpErrorInfo [] with get
    +
    property Array.Length: int with get
    +
    val x : FSharpEntity
    +
    property FSharpCheckProjectResults.AssemblySignature: FSharpAssemblySignature with get
    +
    property FSharpAssemblySignature.Entities: IList<FSharpEntity> with get
    +
    property FSharpEntity.DisplayName: string with get
    +
    val x : FSharpMemberOrFunctionOrValue
    +
    property FSharpMemberOrFunctionOrValue.DisplayName: string with get
    +
    val allSymbolsInEntities : entities:IList<FSharpEntity> -> FSharpSymbol list
    +
    val entities : IList<FSharpEntity>
    +
    type IList<'T> =
      inherit ICollection<'T>
      inherit IEnumerable<'T>
      inherit IEnumerable
      member IndexOf : item:'T -> int
      member Insert : index:int * item:'T -> unit
      member Item : int -> 'T with get, set
      member RemoveAt : index:int -> unit
    +
    type FSharpEntity =
      inherit FSharpSymbol
      private new : SymbolEnv * EntityRef -> FSharpEntity
      member AbbreviatedType : FSharpType
      member AccessPath : string
      member Accessibility : FSharpAccessibility
      member ActivePatternCases : FSharpActivePatternCase list
      member AllCompilationPaths : string list
      member AllInterfaces : IList<FSharpType>
      member ArrayRank : int
      member Attributes : IList<FSharpAttribute>
      ...
    +
    val e : FSharpEntity
    +
    type FSharpSymbol =
      member GetEffectivelySameAsHash : unit -> int
      member IsAccessible : FSharpAccessibilityRights -> bool
      member IsEffectivelySameAs : other:FSharpSymbol -> bool
      member Assembly : FSharpAssembly
      member DeclarationLocation : range option
      member DisplayName : string
      member FullName : string
      member ImplementationLocation : range option
      member IsExplicitlySuppressed : bool
      member private Item : Item
      ...
    +
    property FSharpEntity.MembersFunctionsAndValues: IList<FSharpMemberOrFunctionOrValue> with get
    +
    val x : FSharpUnionCase
    +
    property FSharpEntity.UnionCases: IList<FSharpUnionCase> with get
    +
    val x : FSharpField
    +
    property FSharpEntity.FSharpFields: IList<FSharpField> with get
    +
    property FSharpEntity.NestedEntities: IList<FSharpEntity> with get
    +
    val allSymbols : FSharpSymbol list
    +
    val backgroundParseResults1 : FSharpParseFileResults
    +
    val backgroundTypedParse1 : FSharpCheckFileResults
    +
    member FSharpChecker.GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
    +
    val xSymbol : FSharpSymbolUse option
    +
    member FSharpCheckFileResults.GetSymbolUseAtLocation : line:int * colAtEndOfNames:int * lineText:string * names:string list * ?userOpName:string -> Async<FSharpSymbolUse option>
    +
    val usesOfXSymbol : Async<FSharpSymbolUse []>
    +
    member FSharpCheckProjectResults.GetUsesOfSymbol : symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    +
    property Option.Value: FSharpSymbolUse with get
    +
    property FSharpSymbolUse.Symbol: FSharpSymbol with get
    +
    val allUsesOfAllSignatureSymbols : (string * Async<FSharpSymbolUse []>) list
    +
    val s : FSharpSymbol
    +
    Object.ToString() : string
    +
    val allUsesOfAllSymbols : Async<FSharpSymbolUse []>
    +
    member FSharpCheckProjectResults.GetAllUsesOfAllSymbols : unit -> Async<FSharpSymbolUse []>
    +
    val parseResults1 : FSharpParseFileResults
    +
    val checkAnswer1 : FSharpCheckFileAnswer
    +
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * sourceText:FSharp.Compiler.Text.ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    +
    val checkResults1 : FSharpCheckFileResults
    +
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults
    +
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    +
    val x : FSharpCheckFileResults
    +
    val failwith : message:string -> 'T
    +
    val parseResults2 : FSharpParseFileResults
    +
    val checkAnswer2 : FSharpCheckFileAnswer
    +
    val checkResults2 : FSharpCheckFileResults
    +
    val xSymbol2 : FSharpSymbolUse option
    +
    val usesOfXSymbol2 : Async<FSharpSymbolUse []>
    +
    val allUsesOfAllSymbolsInFile1 : Async<FSharpSymbolUse []>
    +
    member FSharpCheckFileResults.GetAllUsesOfAllSymbolsInFile : unit -> Async<FSharpSymbolUse []>
    +
    val allUsesOfXSymbolInFile1 : Async<FSharpSymbolUse []>
    +
    member FSharpCheckFileResults.GetUsesOfSymbolInFile : symbol:FSharpSymbol -> Async<FSharpSymbolUse []>
    +
    val allUsesOfXSymbolInFile2 : Async<FSharpSymbolUse []>
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/symbols.html b/docs/ja/symbols.html new file mode 100644 index 0000000000..a927048ecf --- /dev/null +++ b/docs/ja/symbols.html @@ -0,0 +1,518 @@ + + + + + コンパイラサービス: シンボルの処理 + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    コンパイラサービス: シンボルの処理

    +

    このチュートリアルでは、F#コンパイラによって提供される +シンボルの扱い方についてのデモを紹介します。 +シンボルの参照に関する情報については プロジェクト全体の分析 +も参考にしてください。

    +
    +

    注意: 以下で使用しているAPIは試験的なもので、 +最新のnugetパッケージの公開に伴って変更されることがあります。

    +
    +

    これまでと同じく、 FSharp.Compiler.Service.dll への参照を追加した後、 +適切な名前空間をオープンし、 FSharpChecker のインスタンスを作成します:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+8: 
+9: 
+
    // F#コンパイラAPIへの参照
+#r "FSharp.Compiler.Service.dll"
+
+open System
+open System.IO
+open FSharp.Compiler.SourceCodeServices
+
+// インタラクティブチェッカーのインスタンスを作成
+let checker = FSharpChecker.Create()
+
    +

    そして特定の入力値に対して型チェックを行います:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+
    let parseAndTypeCheckSingleFile (file, input) = 
+    // スタンドアロンの(スクリプト)ファイルを表すコンテキストを取得
+    let projOptions, _errors = 
+        checker.GetProjectOptionsFromScript(file, input)
+        |> Async.RunSynchronously
+
+    let parseFileResults, checkFileResults = 
+        checker.ParseAndCheckFileInProject(file, 0, input, projOptions) 
+        |> Async.RunSynchronously
+
+    // 型チェックが成功(あるいは100%に到達)するまで待機
+    match checkFileResults with
+    | FSharpCheckFileAnswer.Succeeded(res) -> parseFileResults, res
+    | res -> failwithf "Parsing did not finish... (%A)" res
+
+let file = "/home/user/Test.fsx"
+
    +

    ファイルに対する解決済みのシグネチャ情報を取得する

    +

    ファイルに対する型チェックが完了すると、 +TypeCheckResults の PartialAssemblySignature プロパティを参照することにより、 +チェック中の特定のファイルを含む、推論されたプロジェクトのシグネチャに +アクセスすることができます。

    +

    モジュールや型、属性、メンバ、値、関数、共用体、レコード型、測定単位、 +およびその他のF#言語要素に対する完全なシグネチャ情報が参照できます。

    +

    ただし型付き式ツリーに対する情報は(今のところ)この方法では利用できません。

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+
    let input2 = 
+      """
+[<System.CLSCompliant(true)>]
+let foo(x, y) = 
+    let msg = String.Concat("Hello"," ","world")
+    if true then 
+        printfn "x = %d, y = %d" x y 
+        printfn "%s" msg
+
+type C() = 
+    member x.P = 1
+      """
+let parseFileResults, checkFileResults = 
+    parseAndTypeCheckSingleFile(file, input2)
+
    +

    これでコードに対する部分的なアセンブリのシグネチャが取得できるようになります:

    + + + +
    1: 
+2: 
+3: 
+
    let partialAssemblySignature = checkFileResults.PartialAssemblySignature
+
+partialAssemblySignature.Entities.Count = 1  // エンティティは1つ
+
    +

    そしてコードを含むモジュールに関連したエンティティを取得します:

    + + + +
    1: 
+2: 
+3: 
+
    let moduleEntity = partialAssemblySignature.Entities.[0]
+
+moduleEntity.DisplayName = "Test"
+
    +

    そしてコード内の型定義に関連したエンティティを取得します:

    + + + +
    1: 
+
    let classEntity = moduleEntity.NestedEntities.[0]
+
    +

    そしてコード内で定義された関数に関連した値を取得します:

    + + + +
    1: 
+
    let fnVal = moduleEntity.MembersFunctionsAndValues.[0]
+
    +

    関数値に関するプロパティの値を確認してみましょう。

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+18: 
+19: 
+20: 
+21: 
+22: 
+23: 
+
    fnVal.Attributes.Count // 1
+fnVal.CurriedParameterGroups.Count // 1
+fnVal.CurriedParameterGroups.[0].Count // 2
+fnVal.CurriedParameterGroups.[0].[0].Name // "x"
+fnVal.CurriedParameterGroups.[0].[1].Name // "y"
+fnVal.DeclarationLocation.StartLine // 3
+fnVal.DisplayName // "foo"
+fnVal.DeclaringEntity.Value.DisplayName // "Test"
+fnVal.DeclaringEntity.Value.DeclarationLocation.StartLine // 1
+fnVal.GenericParameters.Count // 0
+fnVal.InlineAnnotation // FSharpInlineAnnotation.OptionalInline
+fnVal.IsActivePattern // false
+fnVal.IsCompilerGenerated // false
+fnVal.IsDispatchSlot // false
+fnVal.IsExtensionMember // false
+fnVal.IsPropertyGetterMethod // false
+fnVal.IsImplicitConstructor // false
+fnVal.IsInstanceMember // false
+fnVal.IsMember // false
+fnVal.IsModuleValueOrMember // true
+fnVal.IsMutable // false
+fnVal.IsPropertySetterMethod // false
+fnVal.IsTypeFunction // false
+
    +

    次に、この関数の型がファーストクラスの値として使用されているかどうかチェックします。 +(ちなみに CurriedParameterGroups プロパティには引数の名前など、 +より多くの情報も含まれています)

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
    fnVal.FullType // int * int -> unit
+fnVal.FullType.IsFunctionType // true
+fnVal.FullType.GenericArguments.[0] // int * int 
+fnVal.FullType.GenericArguments.[0].IsTupleType // true
+let argTy1 = fnVal.FullType.GenericArguments.[0].GenericArguments.[0]
+
+argTy1.TypeDefinition.DisplayName // int
+
    +

    というわけで int * int -> unit という型を表現するオブジェクトが取得できて、 +その1つめの 'int' を確認できたわけです。 +また、以下のようにすると 'int' 型についてのより詳細な情報が取得でき、 +それが名前付きの型であり、F#の型省略形 type int = int32 であることがわかります:

    + + + +
    1: 
+2: 
+
    argTy1.HasTypeDefinition // true
+argTy1.TypeDefinition.IsFSharpAbbreviation // true
+
    +

    型省略形の右辺、つまり int32 についてもチェックしてみましょう:

    + + + +
    1: 
+2: 
+3: 
+
    let argTy1b = argTy1.TypeDefinition.AbbreviatedType
+argTy1b.TypeDefinition.Namespace // Some "Microsoft.FSharp.Core" 
+argTy1b.TypeDefinition.CompiledName // "int32" 
+
    +

    そして再び型省略形 type int32 = System.Int32 から型に関する完全な情報が取得できます:

    + + + +
    1: 
+2: 
+3: 
+
    let argTy1c = argTy1b.TypeDefinition.AbbreviatedType
+argTy1c.TypeDefinition.Namespace // Some "System" 
+argTy1c.TypeDefinition.CompiledName // "Int32" 
+
    +

    ファイルに対する型チェックの結果には、 +コンパイル時に使用されたプロジェクト(あるいはスクリプト)のオプションに関する +ProjectContext と呼ばれる情報も含まれています:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+
    let projectContext = checkFileResults.ProjectContext
+
+for assembly in projectContext.GetReferencedAssemblies() do
+    match assembly.FileName with 
+    | None -> printfn "コンパイル時にファイルの存在しないアセンブリを参照しました"
+    | Some s -> printfn "コンパイル時にアセンブリ '%s' を参照しました" s
+
    +

    注意:

    +
      +
    • +不完全なコードが存在する場合、一部あるいはすべての属性が意図したとおりには +並ばないことがあります。 +
      • +
    • +(実際には非常によくあることですが)一部のアセンブリが見つからない場合、 +外部アセンブリに関連する値やメンバ、エンティティにおける 'IsUnresolved' が +trueになることがあります。 +IsUnresolvedによる例外に対処できるよう、堅牢なコードにしておくべきです。 +
      • +
    +

    プロジェクト全体に対するシンボル情報を取得する

    +

    プロジェクト全体をチェックする場合、チェッカーを作成した後に parseAndCheckScript +を呼び出します。 +今回の場合は単に1つのスクリプトだけが含まれたプロジェクトをチェックします。 +異なる "projOptions" を指定すると、巨大なプロジェクトに対する設定を +構成することもできます。

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+
    let parseAndCheckScript (file, input) = 
+    let projOptions, errors = 
+        checker.GetProjectOptionsFromScript(file, input)
+        |> Async.RunSynchronously
+
+    let projResults = 
+        checker.ParseAndCheckProject(projOptions) 
+        |> Async.RunSynchronously
+
+    projResults
+
    +

    そして特定の入力に対してこの関数を呼び出します:

    + + + +
    1: 
+2: 
+3: 
+4: 
+
    let tmpFile = Path.ChangeExtension(System.IO.Path.GetTempFileName() , "fs")
+File.WriteAllText(tmpFile, input2)
+
+let projectResults = parseAndCheckScript(tmpFile, input2)
+
    +

    結果は以下の通りです:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
    let assemblySig = projectResults.AssemblySignature
+
+assemblySig.Entities.Count = 1  // エンティティは1つ
+assemblySig.Entities.[0].Namespace  // null
+assemblySig.Entities.[0].DisplayName // "Tmp28D0"
+assemblySig.Entities.[0].MembersFunctionsAndValues.Count // 1 
+assemblySig.Entities.[0].MembersFunctionsAndValues.[0].DisplayName // "foo" 
+
    + +
    namespace System
    +
    namespace System.IO
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    +
    namespace FSharp.Compiler
    +
    namespace FSharp.Compiler.SourceCodeServices
    +
    val checker : FSharpChecker
    +
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    +
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    +
    val parseAndTypeCheckSingleFile : file:string * input:FSharp.Compiler.Text.ISourceText -> FSharpParseFileResults * FSharpCheckFileResults
    +
    val file : string
    +
    val input : FSharp.Compiler.Text.ISourceText
    +
    val projOptions : FSharpProjectOptions
    +
    val _errors : FSharpErrorInfo list
    +
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * sourceText:FSharp.Compiler.Text.ISourceText * ?previewEnabled:bool * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?useSdkRefs:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    val parseFileResults : FSharpParseFileResults
    +
    val checkFileResults : FSharpCheckFileAnswer
    +
    member FSharpChecker.ParseAndCheckFileInProject : filename:string * fileversion:int * sourceText:FSharp.Compiler.Text.ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileAnswer>
    +
    type FSharpCheckFileAnswer =
      | Aborted
      | Succeeded of FSharpCheckFileResults
    +
    union case FSharpCheckFileAnswer.Succeeded: FSharpCheckFileResults -> FSharpCheckFileAnswer
    +
    val res : FSharpCheckFileResults
    +
    val res : FSharpCheckFileAnswer
    +
    val failwithf : format:Printf.StringFormat<'T,'Result> -> 'T
    +
    val input2 : string
    +
    val checkFileResults : FSharpCheckFileResults
    +
    val partialAssemblySignature : FSharpAssemblySignature
    +
    property FSharpCheckFileResults.PartialAssemblySignature: FSharpAssemblySignature with get
    +
    property FSharpAssemblySignature.Entities: Collections.Generic.IList<FSharpEntity> with get
    +
    property Collections.Generic.ICollection.Count: int with get
    +
    val moduleEntity : FSharpEntity
    +
    property FSharpEntity.DisplayName: string with get
    +
    val classEntity : FSharpEntity
    +
    property FSharpEntity.NestedEntities: Collections.Generic.IList<FSharpEntity> with get
    +
    val fnVal : FSharpMemberOrFunctionOrValue
    +
    property FSharpEntity.MembersFunctionsAndValues: Collections.Generic.IList<FSharpMemberOrFunctionOrValue> with get
    +
    property FSharpMemberOrFunctionOrValue.Attributes: Collections.Generic.IList<FSharpAttribute> with get
    +
    property FSharpMemberOrFunctionOrValue.CurriedParameterGroups: Collections.Generic.IList<Collections.Generic.IList<FSharpParameter>> with get
    +
    property FSharpMemberOrFunctionOrValue.DeclarationLocation: FSharp.Compiler.Range.range with get
    +
    property FSharp.Compiler.Range.range.StartLine: int with get
    +
    property FSharpMemberOrFunctionOrValue.DisplayName: string with get
    +
    property FSharpMemberOrFunctionOrValue.DeclaringEntity: FSharpEntity option with get
    +
    property Option.Value: FSharpEntity with get
    +
    property FSharpEntity.DeclarationLocation: FSharp.Compiler.Range.range with get
    +
    property FSharpMemberOrFunctionOrValue.GenericParameters: Collections.Generic.IList<FSharpGenericParameter> with get
    +
    property FSharpMemberOrFunctionOrValue.InlineAnnotation: FSharpInlineAnnotation with get
    +
    property FSharpMemberOrFunctionOrValue.IsActivePattern: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsCompilerGenerated: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsDispatchSlot: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsExtensionMember: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsPropertyGetterMethod: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsImplicitConstructor: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsInstanceMember: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsMember: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsModuleValueOrMember: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsMutable: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsPropertySetterMethod: bool with get
    +
    property FSharpMemberOrFunctionOrValue.IsTypeFunction: bool with get
    +
    property FSharpMemberOrFunctionOrValue.FullType: FSharpType with get
    +
    property FSharpType.IsFunctionType: bool with get
    +
    property FSharpType.GenericArguments: Collections.Generic.IList<FSharpType> with get
    +
    val argTy1 : FSharpType
    +
    property FSharpType.TypeDefinition: FSharpEntity with get
    +
    property FSharpType.HasTypeDefinition: bool with get
    +
    property FSharpEntity.IsFSharpAbbreviation: bool with get
    +
    val argTy1b : FSharpType
    +
    property FSharpEntity.AbbreviatedType: FSharpType with get
    +
    property FSharpEntity.Namespace: string option with get
    +
    property FSharpEntity.CompiledName: string with get
    +
    val argTy1c : FSharpType
    +
    val projectContext : FSharpProjectContext
    +
    property FSharpCheckFileResults.ProjectContext: FSharpProjectContext with get
    +
    val assembly : FSharpAssembly
    +
    member FSharpProjectContext.GetReferencedAssemblies : unit -> FSharpAssembly list
    +
    property FSharpAssembly.FileName: string option with get
    +
    union case Option.None: Option<'T>
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    union case Option.Some: Value: 'T -> Option<'T>
    +
    val s : string
    +
    val parseAndCheckScript : file:string * input:FSharp.Compiler.Text.ISourceText -> FSharpCheckProjectResults
    +
    val errors : FSharpErrorInfo list
    +
    val projResults : FSharpCheckProjectResults
    +
    member FSharpChecker.ParseAndCheckProject : options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpCheckProjectResults>
    +
    val tmpFile : string
    +
    type Path =
      static val DirectorySeparatorChar : char
      static val AltDirectorySeparatorChar : char
      static val VolumeSeparatorChar : char
      static val PathSeparator : char
      static val InvalidPathChars : char[]
      static member ChangeExtension : path:string * extension:string -> string
      static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
      static member GetDirectoryName : path:string -> string + 1 overload
      static member GetExtension : path:string -> string + 1 overload
      static member GetFileName : path:string -> string + 1 overload
      ...
    +
    Path.ChangeExtension(path: string, extension: string) : string
    +
    Path.GetTempFileName() : string
    +
    type File =
      static member AppendAllLines : path:string * contents:IEnumerable<string> -> unit + 1 overload
      static member AppendAllLinesAsync : path:string * contents:IEnumerable<string> * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendAllText : path:string * contents:string -> unit + 1 overload
      static member AppendAllTextAsync : path:string * contents:string * ?cancellationToken:CancellationToken -> Task + 1 overload
      static member AppendText : path:string -> StreamWriter
      static member Copy : sourceFileName:string * destFileName:string -> unit + 1 overload
      static member Create : path:string -> FileStream + 2 overloads
      static member CreateText : path:string -> StreamWriter
      static member Decrypt : path:string -> unit
      static member Delete : path:string -> unit
      ...
    +
    File.WriteAllText(path: string, contents: string) : unit
    File.WriteAllText(path: string, contents: string, encoding: Text.Encoding) : unit
    +
    val projectResults : FSharpCheckProjectResults
    +
    val assemblySig : FSharpAssemblySignature
    +
    property FSharpCheckProjectResults.AssemblySignature: FSharpAssemblySignature with get
    +
    union case ScopeKind.Namespace: ScopeKind
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/tokenizer.html b/docs/ja/tokenizer.html new file mode 100644 index 0000000000..09e7021dc8 --- /dev/null +++ b/docs/ja/tokenizer.html @@ -0,0 +1,290 @@ + + + + + コンパイラサービス：F#トークナイザを使用する + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    コンパイラサービス：F#トークナイザを使用する

    +

    このチュートリアルではF#言語トークナイザの呼び出し方を紹介します。 +F#のソースコードに対して、トークナイザは +コードの各行にあるトークンに関する情報を含んだソースコード行のリストを生成します。 +各トークンに対してはトークンの種類や位置を取得したり、 +トークンの種類(キーワード、識別子、数値、演算子など)に応じた +色を取得したりすることができます。

    +
    +

    注意: 以下で使用しているAPIは実験的なもので、 +新しいnugetパッケージの公開に伴って変更される可能性があります。

    +
    +

    トークナイザの作成

    +

    トークナイザを使用するには、 FSharp.Compiler.Service.dll への参照を追加した後に +SourceCodeServices 名前空間をオープンします：

    + + + +
    1: 
+2: 
+
    #r "FSharp.Compiler.Service.dll"
+open FSharp.Compiler.SourceCodeServices
+
    +

    すると FSharpSourceTokenizer のインスタンスを作成できるようになります。 +このクラスには2つの引数を指定します。 +最初の引数には定義済みのシンボルのリスト、 +2番目の引数にはソースコードのファイル名を指定します。 +定義済みのシンボルのリストを指定するのは、 +トークナイザが #if ディレクティブを処理する必要があるからです。 +ファイル名はソースコードの位置を特定する場合にのみ指定する必要があります +(存在しないファイル名でも指定できます):

    + + + +
    1: 
+
    let sourceTok = FSharpSourceTokenizer([], "C:\\test.fsx")
+
    +

    sourceTok オブジェクトを使用することでF#ソースコードの各行を +(繰り返し)トークン化することができます。

    +

    F#コードのトークン化

    +

    トークナイザはソースファイル全体ではなく、行単位で処理を行います。 +トークンを取得した後、トークナイザは新しいステートを( int64 値として)返します。 +この値を使うとF#コードをより効率的にトークン化できます。 +つまり、ソースコードが変更された場合もファイル全体を +再度トークン化する必要はありません。 +変更された部分だけをトークン化すればよいのです。

    +

    1行をトークン化する

    +

    1行をトークン化するには、先ほど作成した FSharpSourceTokenizer オブジェクトに対して +CreateLineTokenizer を呼び、 FSharpLineTokenizer を作成します:

    + + + +
    1: 
+
    let tokenizer = sourceTok.CreateLineTokenizer("let answer=42")
+
    +

    そして tokenizer の ScanToken を繰り返し None を返すまで +(つまり最終行に到達するまで)繰り返し呼び出すような単純な再帰関数を用意します。 +この関数が成功すると、必要な詳細情報をすべて含んだ FSharpTokenInfo オブジェクトが +返されます:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+8: 
+9: 
+
    /// F#コード1行をトークン化します
+let rec tokenizeLine (tokenizer:FSharpLineTokenizer) state =
+  match tokenizer.ScanToken(state) with
+  | Some tok, state ->
+      // トークン名を表示
+      printf "%s " tok.TokenName
+      // 新しい状態で残りをトークン化
+      tokenizeLine tokenizer state
+  | None, state -> state
+
    +

    この関数は、複数行コードや複数行コメント内の前方の行をトークン化する場合に +必要となるような新しい状態を返します。 +初期値としては 0L を指定します:

    + + + +
    1: 
+
    tokenizeLine tokenizer FSharpTokenizerLexState.Initial
+
    +

    この結果は LET WHITESPACE IDENT EQUALS INT32 という +トークン名のシーケンスになります。 +FSharpTokenInfo にはたとえば以下のような興味深いプロパティが多数あります:

    +
      +
    • +CharClass および ColorClass はF#コードを色づけする場合に使用できるような、 +トークンのカテゴリに関する情報を返します。 +
      • +
    • LeftColumn および RightColumn は行内におけるトークンの位置を返します。
      • +
    • TokenName は(F# レキサ内で定義された)トークンの名前を返します。
      • +
    +

    なおトークナイザはステートフルであることに注意してください。 +つまり、1行を複数回トークン化したい場合にはその都度 CreateLineTokenizer を +呼び出す必要があります。

    +

    サンプルコードのトークン化

    +

    トークナイザをもっと長いサンプルコードやファイル全体に対して実行する場合、 +サンプル入力を string のコレクションとして読み取る必要があります:

    + + + +
    1: 
+2: 
+3: 
+4: 
+
    let lines = """
+  // Hello world
+  let hello() =
+     printfn "Hello world!" """.Split('\r','\n')
+
    +

    複数行の入力値をトークン化する場合も、現在の状態を保持するような +再帰関数が必要になります。 +以下の関数はソースコード行を文字列のリストとして受け取ります +(また、行番号および現在の状態も受け取ります)。 +各行に対して新しいトークナイザを作成して、 +直前の行における 最後 の状態を使って tokenizeLine を呼び出します:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+
    /// 複数行のコードに対してトークンの名前を表示します
+let rec tokenizeLines state count lines = 
+  match lines with
+  | line::lines ->
+      // トークナイザを作成して1行をトークン化
+      printfn "\nLine %d" count
+      let tokenizer = sourceTok.CreateLineTokenizer(line)
+      let state = tokenizeLine tokenizer state
+      // 新しい状態を使って残りをトークン化
+      tokenizeLines state (count+1) lines
+  | [] -> ()
+
    +

    ここでは単に(先ほど定義した) tokenizeLine を呼び出して、 +各行にあるすべてのトークンの名前を表示しています。 +この関数は先と同じく、初期状態の値 0L と、1行目を表す 1 を +指定して呼び出すことができます:

    + + + +
    1: 
+2: 
+3: 
+
    lines
+|> List.ofSeq
+|> tokenizeLines FSharpTokenizerLexState.Initial 1
+
    +

    重要ではない部分(各行の先頭にある空白文字や、1行目のように空白文字しかない行) +を除けば、このコードを実行すると以下のような出力になります:

    + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+
    Line 1
+  LINE_COMMENT LINE_COMMENT (...) LINE_COMMENT 
+Line 2
+  LET WHITESPACE IDENT LPAREN RPAREN WHITESPACE EQUALS 
+Line 3
+  IDENT WHITESPACE STRING_TEXT (...) STRING_TEXT STRING 
+
    +

    注目すべきは、単一行コメントや文字列に対して、 +トークナイザが複数回(大まかにいって単語単位で) LINE_COMMENT や +STRING_TEXT を返しているところです。 +したがって、コメントや文字列全体をテキストとして取得したい場合には +それぞれのトークンを連結する必要があります。

    + +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    +
    namespace FSharp.Compiler
    +
    namespace FSharp.Compiler.SourceCodeServices
    +
    val sourceTok : FSharpSourceTokenizer
    +
    Multiple items
    type FSharpSourceTokenizer =
      new : conditionalDefines:string list * fileName:string option -> FSharpSourceTokenizer
      member CreateBufferTokenizer : bufferFiller:(char [] * int * int -> int) -> FSharpLineTokenizer
      member CreateLineTokenizer : lineText:string -> FSharpLineTokenizer

    --------------------
    new : conditionalDefines:string list * fileName:string option -> FSharpSourceTokenizer
    +
    val tokenizer : FSharpLineTokenizer
    +
    member FSharpSourceTokenizer.CreateLineTokenizer : lineText:string -> FSharpLineTokenizer
    +
    val tokenizeLine : tokenizer:FSharpLineTokenizer -> state:FSharpTokenizerLexState -> FSharpTokenizerLexState


     F#コード1行をトークン化します
    +
    type FSharpLineTokenizer =
      member ScanToken : lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
      static member ColorStateOfLexState : FSharpTokenizerLexState -> FSharpTokenizerColorState
      static member LexStateOfColorState : FSharpTokenizerColorState -> FSharpTokenizerLexState
    +
    [<Struct>]
    val state : FSharpTokenizerLexState
    +
    member FSharpLineTokenizer.ScanToken : lexState:FSharpTokenizerLexState -> FSharpTokenInfo option * FSharpTokenizerLexState
    +
    union case Option.Some: Value: 'T -> Option<'T>
    +
    val tok : FSharpTokenInfo
    +
    val printf : format:Printf.TextWriterFormat<'T> -> 'T
    +
    FSharpTokenInfo.TokenName: string
    +
    union case Option.None: Option<'T>
    +
    [<Struct>]
    type FSharpTokenizerLexState =
      { PosBits: int64
        OtherBits: int64 }
        member Equals : FSharpTokenizerLexState -> bool
        static member Initial : FSharpTokenizerLexState
    +
    property FSharpTokenizerLexState.Initial: FSharpTokenizerLexState with get
    +
    val lines : string []
    +
    val tokenizeLines : state:FSharpTokenizerLexState -> count:int -> lines:string list -> unit


     複数行のコードに対してトークンの名前を表示します
    +
    val count : int
    +
    val lines : string list
    +
    val line : string
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    Multiple items
    module List

    from Microsoft.FSharp.Collections

    --------------------
    type List<'T> =
      | ( [] )
      | ( :: ) of Head: 'T * Tail: 'T list
        interface IReadOnlyList<'T>
        interface IReadOnlyCollection<'T>
        interface IEnumerable
        interface IEnumerable<'T>
        member GetSlice : startIndex:int option * endIndex:int option -> 'T list
        member Head : 'T
        member IsEmpty : bool
        member Item : index:int -> 'T with get
        member Length : int
        member Tail : 'T list
        ...
    +
    val ofSeq : source:seq<'T> -> 'T list
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/docs/ja/untypedtree.html b/docs/ja/untypedtree.html new file mode 100644 index 0000000000..fb50ece122 --- /dev/null +++ b/docs/ja/untypedtree.html @@ -0,0 +1,539 @@ + + + + + コンパイラサービス：型無し構文木の処理 + + + + + + + + + + + + + + + + + +
    +
    + +

    F# Compiler Services

    +
    +
    +
    +
    +

    コンパイラサービス：型無し構文木の処理

    +

    このチュートリアルではF#コードに対する型無し抽象構文木 +(untyped abstract syntax tree: untyped AST) +を取得する方法、および木全体を走査する方法を紹介します。 +この処理を行うことによって、コードフォーマットツールや +基本的なリファクタリングツール、コードナビゲーションツールなどを作成できます。 +型無し構文木にはコードの構造に関する情報が含まれていますが、 +型情報が含まれていないだけでなく、後で型チェッカーを通すまでは +解決されないような曖昧さも残されています。 +また、 エディタサービス として提供されているAPIと +型無しASTの情報を組み合わせることもできます。

    +
    +

    注釈: 以下で使用しているAPIは試験的なもので、将来的に変更される場合があります。 +つまりFSharp.Compiler.Service.dll には既存のものと重複する機能が多数あるため、 +将来的にはもっときちんとした形に変更されます。 +そのため、これらのサービスを使用するAPIには破壊的変更が加えられる可能性があります。

    +
    +

    型無しASTの取得

    +

    型無しASTにアクセスするには、 FSharpChecker のインスタンスを作成します。 +これは型チェックおよびパース用のコンテキストを表す型で、、 +スタンドアロンのF#スクリプトファイル(たとえばVisual Studioで開いたファイル)、 +あるいは複数ファイルで構成されたロード済みのプロジェクトファイルの +いずれかと結びつきます。 +このインスタンスを作成すると、型チェックの最初のステップである +「型無しパース」を実行できます。 +次のフェーズは「型有りパース」で、これは エディタサービス で +使用されるものです。

    +

    インタラクティブチェッカーを使用するには、 +FSharp.Compiler.Service.dll への参照を追加した後、 +SourceCodeServices 名前空間をオープンします：

    + + + +
    1: 
+2: 
+3: 
+
    #r "FSharp.Compiler.Service.dll"
+open System
+open FSharp.Compiler.SourceCodeServices
+
    +

    型無しパースの実行

    +

    型無しパース処理は(それなりの時間がかかる型チェック処理と比較すると) +かなり高速なため、同期的に実行できます。 +まず FSharpChecker を作成します。

    + + + +
    1: 
+2: 
+
    // インタラクティブチェッカーのインスタンスを作成
+let checker = FSharpChecker.Create()
+
    +

    ASTを取得するために、ファイル名とソースコードを受け取る関数を用意します +(ファイル名は位置情報のためだけに使用されるもので、存在しなくても構いません)。 +まず、コンテキストを表す「インタラクティブチェッカーオプション」を +用意する必要があります。 +単純な処理に対しては、 GetCheckOptionsFromScriptRoot を使えば +スクリプトファイルのコンテキストを推測させることができます。 +そして UntypedParse メソッドを呼び出した後、 +ParseTree プロパティの値を返します:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+18: 
+
    /// 特定の入力に対する型無し構文木を取得する
+let getUntypedTree (file, input) = 
+  // 1つのスクリプトファイルから推測される「プロジェクト」用の
+  // コンパイラオプションを取得する
+  let projOptions, errors =
+      checker.GetProjectOptionsFromScript(file, input) 
+      |> Async.RunSynchronously
+
+  let parsingOptions, _errors = checker.GetParsingOptionsFromProjectOptions(projectOptions)
+
+  // コンパイラの第1フェーズを実行する
+  let untypedRes = 
+      checker.ParseFile(file, input, parsingOptions) 
+      |> Async.RunSynchronously
+
+  match untypedRes.ParseTree with
+  | Some tree -> tree
+  | None -> failwith "パース中に何らかの問題が発生しました!"
+
    +

    FSharpChecker の詳細については + APIドキュメント +の他に、F# ソースコードのインラインコメントも参考になるでしょう +( service.fsi のソースコードを参照 )。

    +

    ASTの走査

    +

    抽象構文木は(式やパターン、宣言など)それぞれ異なる文法的要素を表現する、 +多数の判別共用体として定義されています。 +ASTを理解するには +ast.fs内にあるソースコード +の定義を確認する方法が一番よいでしょう。

    +

    ASTに関連する要素は以下の名前空間に含まれています:

    + + + +
    1: 
+
    open FSharp.Compiler.Ast
+
    +

    ASTを処理する場合、異なる文法的要素に対するパターンマッチを行うような +相互再帰関数を多数用意することになります。 +サポートすべき要素は非常に多種多様です。 +たとえばトップレベル要素としてはモジュールや名前空間の宣言、 +モジュール内における(letバインディングや型などの)宣言などがあります。 +モジュール内のlet宣言には式が含まれ、さらにこの式に +パターンが含まれていることもあります。

    +

    パターンと式を走査する

    +

    まずは式とパターンを走査する関数から始めます。 +この関数は要素を走査しつつ、要素に関する情報を画面に表示します。 +パターンの場合、入力は SynPat 型であり、この型には Wild ( _ パターンを表す)や +Named ( <pat> という名前 のパターン)、 +LongIdent ( Foo.Bar 形式の名前)など、多数のケースがあります。 +なお、基本的にパース後のパターンは元のソースコードの見た目よりも複雑になります +(具体的には Named がかなり多数現れます):

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+
    /// パターンの走査
+/// これは let <pat> = <expr> あるいは 'match' 式に対する例です
+let rec visitPattern = function
+  | SynPat.Wild(_) -> 
+      printfn "  .. アンダースコアパターン"
+  | SynPat.Named(pat, name, _, _, _) ->
+      visitPattern pat
+      printfn "  .. 名前 '%s' のパターン" name.idText
+  | SynPat.LongIdent(LongIdentWithDots(ident, _), _, _, _, _, _) ->
+      let names = String.concat "." [ for i in ident -> i.idText ]
+      printfn "  .. 識別子: %s" names
+  | pat -> printfn "  .. その他のパターン: %A" pat
+
    +

    この関数は (bar という名前の (foo, _) のような、 +ネストされたパターンに対応するために) 再帰関数になっていますが、 +以降で定義するいずれの関数も呼び出しません +(パターンはその他の文法的な要素を含むことができないからです)。

    +

    次の関数は式全体を走査するものです。 +これは処理の大部分が行われる関数で、 +20以上のケースをカバーすることになるでしょう +( SynExpr と入力するとその他のオプションが確認できます)。 +以下のコードでは if .. then .. と let .. = ... という式を +処理する方法だけを紹介しています:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+17: 
+18: 
+19: 
+20: 
+21: 
+22: 
+23: 
+24: 
+
    /// 式を走査する。
+/// 式に2つあるいは3つの部分式が含まれていた場合('else'の分岐がない場合は2つ)、
+/// let式にはパターンおよび2つの部分式が含まれる
+let rec visitExpression = function
+  | SynExpr.IfThenElse(cond, trueBranch, falseBranchOpt, _, _, _, _) ->
+      // すべての部分式を走査
+      printfn "条件部:"
+      visitExpression cond
+      visitExpression trueBranch
+      falseBranchOpt |> Option.iter visitExpression 
+
+  | SynExpr.LetOrUse(_, _, bindings, body, _) ->
+      // バインディングを走査
+      // ('let .. = .. and .. = .. in ...' に対しては複数回走査されることがある)
+      printfn "以下のバインディングを含むLetOrUse:"
+      for binding in bindings do
+        let (Binding(access, kind, inlin, mutabl, attrs, xmlDoc, 
+                     data, pat, retInfo, init, m, sp)) = binding
+        visitPattern pat 
+        visitExpression init
+      // 本体の式を走査
+      printfn "本体は以下:"
+      visitExpression body
+  | expr -> printfn " - サポート対象外の式: %A" expr
+
    +

    visitExpression 関数はモジュール内のすべてのトップレベル宣言を走査するような +関数から呼ばれることになります。 +今回のチュートリアルでは型やメンバーを無視していますが、 +これらを走査する場合も visitExpression を呼び出すことになるでしょう。

    +

    宣言を走査する

    +

    既に説明したように、1つのファイルに対するASTには多数のモジュールや +名前空間の宣言が(トップレベルノードとして)含まれ、 +モジュール内にも(letバインディングや型の)宣言が、 +名前空間にも(こちらは単に型だけの)宣言が含まれます。 +以下の関数はそれぞれの宣言を走査します。 +ただし今回は型やネストされたモジュール、その他の要素については無視して、 +トップレベルの(値および関数に対する) let バインディングだけを対象にしています:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+12: 
+13: 
+14: 
+15: 
+16: 
+
    /// モジュール内の宣言リストを走査する。
+/// モジュール内のトップレベルに記述できるすべての要素
+/// (letバインディングやネストされたモジュール、型の宣言など)が対象になる。
+let visitDeclarations decls = 
+  for declaration in decls do
+    match declaration with
+    | SynModuleDecl.Let(isRec, bindings, range) ->
+        // 宣言としてのletバインディングは
+        // (visitExpressionで処理したような)式としてのletバインディングと
+        // 似ているが、本体を持たない
+        for binding in bindings do
+          let (Binding(access, kind, inlin, mutabl, attrs, xmlDoc, 
+                       data, pat, retInfo, body, m, sp)) = binding
+          visitPattern pat 
+          visitExpression body         
+    | _ -> printfn " - サポート対象外の宣言: %A" declaration
+
    +

    visitDeclarations 関数はモジュールや名前空間の宣言のシーケンスを走査する +関数から呼ばれることになります。 +このシーケンスはたとえば複数の namespace Foo 宣言を含むようなファイルに対応します:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+8: 
+9: 
+
    /// すべてのモジュールや名前空間の宣言を走査する
+/// (基本的には 'module Foo =' または 'namespace Foo.Bar' というコード)
+/// なおファイル中で明示的に定義されていない場合であっても
+/// 暗黙的にモジュールまたは名前空間の宣言が存在することに注意。
+let visitModulesAndNamespaces modulesOrNss =
+  for moduleOrNs in modulesOrNss do
+    let (SynModuleOrNamespace(lid, isRec, isMod, decls, xml, attrs, _, m)) = moduleOrNs
+    printfn "名前空間またはモジュール: %A" lid
+    visitDeclarations decls
+
    +

    以上でASTの要素を(宣言から始まって式やパターンに至るまで)走査するための +関数がそろったので、サンプル入力からASTを取得した後、 +上記の関数を実行することができるようになりました。

    +

    すべてを組み合わせる

    +

    既に説明したように、 getUntypedTree 関数では FSharpChecker を使って +ASTに対する第1フェーズ(パース)を行ってツリーを返しています。 +この関数にはF#のソースコードとともに、ファイルのパスを指定する必要があります。 +(単に位置情報として利用されるだけなので) +指定先のパスにファイルが存在している必要はなく、 +UnixとWindowsどちらの形式でも指定できます:

    + + + +
     1: 
+ 2: 
+ 3: 
+ 4: 
+ 5: 
+ 6: 
+ 7: 
+ 8: 
+ 9: 
+10: 
+11: 
+
    // コンパイラサービスへのサンプル入力
+let input = """
+  let foo() = 
+    let msg = "Hello world"
+    if true then 
+      printfn "%s" msg """
+// Unix形式のファイル名
+let file = "/home/user/Test.fsx"
+
+// サンプルF#コードに対するASTを取得
+let tree = getUntypedTree(file, input) 
+
    +

    このコードをF# Interactiveで実行した場合、コンソールに tree;; と入力すると、 +データ構造に対する文字列表現が表示されることが確認できます。 +ツリーには大量の情報が含まれているため、あまり読みやすいものではありませんが、 +木が動作する様子を想像することはできるでしょう。

    +

    tree の返値はやはり判別共用体で、2つのケースに分かれます。 +1つはF#のシグネチャファイル( *.fsi )を表す ParsedInput.SigFile で、 +もう1つは通常のソースコード( *.fsx または *.fs )を表す +ParsedInput.ImplFile です。 +上記の手順で作成した関数に渡すことができるモジュールや名前空間のシーケンスは +実装ファイルに含まれています:

    + + + +
    1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
    // 実装ファイルの詳細をチェックする
+match tree with
+| ParsedInput.ImplFile(implFile) ->
+    // 宣言を展開してそれぞれを走査する
+    let (ParsedImplFileInput(fn, script, name, _, _, modules, _)) = implFile
+    visitModulesAndNamespaces modules
+| _ -> failwith "F# インターフェイスファイル (*.fsi) は未サポートです。"
+
    +

    まとめ

    +

    このチュートリアルでは型無し抽象構文木に対する基本的な走査方法を紹介しました。 +このトピックは包括的なものであるため、1つの記事ですべてを説明することは不可能です。 +さらに深く理解するためには、型無しASTを活用するツールのよい例として +Fantomas project を参考にするとよいでしょう。 +実際には今回参照したような情報と、次のチュートリアルで説明する +エディタサービス から得られる情報とを +組み合わせて利用することになるでしょう。

    + +
    namespace System
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    +
    namespace FSharp.Compiler
    +
    namespace FSharp.Compiler.SourceCodeServices
    +
    val checker : FSharpChecker
    +
    type FSharpChecker =
      member CheckFileInProject : parsed:FSharpParseFileResults * filename:string * fileversion:int * sourceText:ISourceText * options:FSharpProjectOptions * ?textSnapshotInfo:obj * ?userOpName:string -> Async<FSharpCheckFileAnswer>
      member CheckProjectInBackground : options:FSharpProjectOptions * ?userOpName:string -> unit
      member ClearLanguageServiceRootCachesAndCollectAndFinalizeAllTransients : unit -> unit
      member Compile : argv:string [] * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member Compile : ast:ParsedInput list * assemblyName:string * outFile:string * dependencies:string list * ?pdbFile:string * ?executable:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int>
      member CompileToDynamicAssembly : otherFlags:string [] * execute:(TextWriter * TextWriter) option * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member CompileToDynamicAssembly : ast:ParsedInput list * assemblyName:string * dependencies:string list * execute:(TextWriter * TextWriter) option * ?debug:bool * ?noframework:bool * ?userOpName:string -> Async<FSharpErrorInfo [] * int * Assembly option>
      member GetBackgroundCheckResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults * FSharpCheckFileResults>
      member GetBackgroundParseResultsForFileInProject : filename:string * options:FSharpProjectOptions * ?userOpName:string -> Async<FSharpParseFileResults>
      member GetParsingOptionsFromCommandLineArgs : argv:string list * ?isInteractive:bool -> FSharpParsingOptions * FSharpErrorInfo list
      ...
    +
    static member FSharpChecker.Create : ?projectCacheSize:int * ?keepAssemblyContents:bool * ?keepAllBackgroundResolutions:bool * ?legacyReferenceResolver:FSharp.Compiler.ReferenceResolver.Resolver * ?tryGetMetadataSnapshot:FSharp.Compiler.AbstractIL.ILBinaryReader.ILReaderTryGetMetadataSnapshot * ?suggestNamesForErrors:bool * ?keepAllBackgroundSymbolUses:bool -> FSharpChecker
    +
    val getUntypedTree : file:string * input:FSharp.Compiler.Text.ISourceText -> FSharp.Compiler.Ast.ParsedInput


     特定の入力に対する型無し構文木を取得する
    +
    val file : string
    +
    val input : FSharp.Compiler.Text.ISourceText
    +
    val projOptions : FSharpProjectOptions
    +
    val errors : FSharpErrorInfo list
    +
    member FSharpChecker.GetProjectOptionsFromScript : filename:string * sourceText:FSharp.Compiler.Text.ISourceText * ?previewEnabled:bool * ?loadedTimeStamp:DateTime * ?otherFlags:string [] * ?useFsiAuxLib:bool * ?useSdkRefs:bool * ?assumeDotNetFramework:bool * ?extraProjectInfo:obj * ?optionsStamp:int64 * ?userOpName:string -> Async<FSharpProjectOptions * FSharpErrorInfo list>
    +
    Multiple items
    type Async =
      static member AsBeginEnd : computation:('Arg -> Async<'T>) -> ('Arg * AsyncCallback * obj -> IAsyncResult) * (IAsyncResult -> 'T) * (IAsyncResult -> unit)
      static member AwaitEvent : event:IEvent<'Del,'T> * ?cancelAction:(unit -> unit) -> Async<'T> (requires delegate and 'Del :> Delegate)
      static member AwaitIAsyncResult : iar:IAsyncResult * ?millisecondsTimeout:int -> Async<bool>
      static member AwaitTask : task:Task -> Async<unit>
      static member AwaitTask : task:Task<'T> -> Async<'T>
      static member AwaitWaitHandle : waitHandle:WaitHandle * ?millisecondsTimeout:int -> Async<bool>
      static member CancelDefaultToken : unit -> unit
      static member Catch : computation:Async<'T> -> Async<Choice<'T,exn>>
      static member Choice : computations:seq<Async<'T option>> -> Async<'T option>
      static member FromBeginEnd : beginAction:(AsyncCallback * obj -> IAsyncResult) * endAction:(IAsyncResult -> 'T) * ?cancelAction:(unit -> unit) -> Async<'T>
      ...

    --------------------
    type Async<'T> =
    +
    static member Async.RunSynchronously : computation:Async<'T> * ?timeout:int * ?cancellationToken:Threading.CancellationToken -> 'T
    +
    val parsingOptions : FSharpParsingOptions
    +
    val _errors : FSharpErrorInfo list
    +
    member FSharpChecker.GetParsingOptionsFromProjectOptions : FSharpProjectOptions -> FSharpParsingOptions * FSharpErrorInfo list
    +
    val untypedRes : FSharpParseFileResults
    +
    member FSharpChecker.ParseFile : filename:string * sourceText:FSharp.Compiler.Text.ISourceText * options:FSharpParsingOptions * ?userOpName:string -> Async<FSharpParseFileResults>
    +
    property FSharpParseFileResults.ParseTree: FSharp.Compiler.Ast.ParsedInput option with get
    +
    union case Option.Some: Value: 'T -> Option<'T>
    +
    val tree : FSharp.Compiler.Ast.ParsedInput
    +
    union case Option.None: Option<'T>
    +
    val failwith : message:string -> 'T
    +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp

    --------------------
    type FSharpAttribute =
      member Format : context:FSharpDisplayContext -> string
      member AttributeType : FSharpEntity
      member ConstructorArguments : IList<FSharpType * obj>
      member IsUnresolved : bool
      member NamedArguments : IList<FSharpType * string * bool * obj>
    +
    module Ast

    from FSharp.Compiler
    +
    val visitPattern : _arg1:SynPat -> unit


     パターンの走査
     これは let <pat> = <expr> あるいは 'match' 式に対する例です
    +
    type SynPat =
      | Const of SynConst * range: range
      | Wild of range: range
      | Named of SynPat * Ident * isSelfIdentifier: bool * accessibility: SynAccess option * range: range
      | Typed of SynPat * SynType * range: range
      | Attrib of SynPat * SynAttributes * range: range
      | Or of SynPat * SynPat * range: range
      | Ands of SynPat list * range: range
      | LongIdent of longDotId: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * accessibility: SynAccess option * range: range
      | Tuple of isStruct: bool * SynPat list * range: range
      | Paren of SynPat * range: range
      ...
        member Range : range
    +
    union case SynPat.Wild: range: FSharp.Compiler.Range.range -> SynPat
    +
    val printfn : format:Printf.TextWriterFormat<'T> -> 'T
    +
    union case SynPat.Named: SynPat * Ident * isSelfIdentifier: bool * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynPat
    +
    val pat : SynPat
    +
    val name : Ident
    +
    property Ident.idText: string with get
    +
    union case SynPat.LongIdent: longDotId: LongIdentWithDots * Ident option * SynValTyparDecls option * SynConstructorArgs * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynPat
    +
    Multiple items
    union case LongIdentWithDots.LongIdentWithDots: id: LongIdent * dotms: FSharp.Compiler.Range.range list -> LongIdentWithDots

    --------------------
    type LongIdentWithDots =
      | LongIdentWithDots of id: LongIdent * dotms: range list
        member Lid : LongIdent
        member Range : range
        member RangeSansAnyExtraDot : range
        member ThereIsAnExtraDotAtTheEnd : bool
    +
    val ident : LongIdent
    +
    val names : string
    +
    Multiple items
    type String =
      new : value:char[] -> string + 8 overloads
      member Chars : int -> char
      member Clone : unit -> obj
      member CompareTo : value:obj -> int + 1 overload
      member Contains : value:string -> bool + 3 overloads
      member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
      member EndsWith : value:string -> bool + 3 overloads
      member Equals : obj:obj -> bool + 2 overloads
      member GetEnumerator : unit -> CharEnumerator
      member GetHashCode : unit -> int + 1 overload
      ...

    --------------------
    String(value: char []) : String
    String(value: nativeptr<char>) : String
    String(value: nativeptr<sbyte>) : String
    String(value: ReadOnlySpan<char>) : String
    String(c: char, count: int) : String
    String(value: char [], startIndex: int, length: int) : String
    String(value: nativeptr<char>, startIndex: int, length: int) : String
    String(value: nativeptr<sbyte>, startIndex: int, length: int) : String
    String(value: nativeptr<sbyte>, startIndex: int, length: int, enc: Text.Encoding) : String
    +
    val concat : sep:string -> strings:seq<string> -> string
    +
    val i : Ident
    +
    val visitExpression : _arg1:SynExpr -> unit


     式を走査する。
     式に2つあるいは3つの部分式が含まれていた場合('else'の分岐がない場合は2つ)、
     let式にはパターンおよび2つの部分式が含まれる
    +
    type SynExpr =
      | Paren of expr: SynExpr * leftParenRange: range * rightParenRange: range option * range: range
      | Quote of operator: SynExpr * isRaw: bool * quotedSynExpr: SynExpr * isFromQueryExpression: bool * range: range
      | Const of constant: SynConst * range: range
      | Typed of expr: SynExpr * typeName: SynType * range: range
      | Tuple of isStruct: bool * exprs: SynExpr list * commaRanges: range list * range: range
      | AnonRecd of isStruct: bool * copyInfo: (SynExpr * BlockSeparator) option * recordFields: (Ident * SynExpr) list * range: range
      | ArrayOrList of isList: bool * exprs: SynExpr list * range: range
      | Record of baseInfo: (SynType * SynExpr * range * BlockSeparator option * range) option * copyInfo: (SynExpr * BlockSeparator) option * recordFields: (RecordFieldName * SynExpr option * BlockSeparator option) list * range: range
      | New of isProtected: bool * typeName: SynType * expr: SynExpr * range: range
      | ObjExpr of objType: SynType * argOptions: (SynExpr * Ident option) option * bindings: SynBinding list * extraImpls: SynInterfaceImpl list * newExprRange: range * range: range
      ...
        member IsArbExprAndThusAlreadyReportedError : bool
        member Range : range
        member RangeOfFirstPortion : range
        member RangeSansAnyExtraDot : range
    +
    union case SynExpr.IfThenElse: ifExpr: SynExpr * thenExpr: SynExpr * elseExpr: SynExpr option * spIfToThen: SequencePointInfoForBinding * isFromErrorRecovery: bool * ifToThenRange: FSharp.Compiler.Range.range * range: FSharp.Compiler.Range.range -> SynExpr
    +
    val cond : SynExpr
    +
    val trueBranch : SynExpr
    +
    val falseBranchOpt : SynExpr option
    +
    module Option

    from Microsoft.FSharp.Core
    +
    val iter : action:('T -> unit) -> option:'T option -> unit
    +
    union case SynExpr.LetOrUse: isRecursive: bool * isUse: bool * bindings: SynBinding list * body: SynExpr * range: FSharp.Compiler.Range.range -> SynExpr
    +
    val bindings : SynBinding list
    +
    val body : SynExpr
    +
    val binding : SynBinding
    +
    union case SynBinding.Binding: accessibility: SynAccess option * kind: SynBindingKind * mustInline: bool * isMutable: bool * attrs: SynAttributes * xmlDoc: PreXmlDoc * valData: SynValData * headPat: SynPat * returnInfo: SynBindingReturnInfo option * expr: SynExpr * range: FSharp.Compiler.Range.range * seqPoint: SequencePointInfoForBinding -> SynBinding
    +
    val access : SynAccess option
    +
    val kind : SynBindingKind
    +
    val inlin : bool
    +
    val mutabl : bool
    +
    val attrs : SynAttributes
    +
    val xmlDoc : PreXmlDoc
    +
    val data : SynValData
    +
    val retInfo : SynBindingReturnInfo option
    +
    val init : SynExpr
    +
    val m : FSharp.Compiler.Range.range
    +
    val sp : SequencePointInfoForBinding
    +
    val expr : SynExpr
    +
    val visitDeclarations : decls:seq<SynModuleDecl> -> unit


     モジュール内の宣言リストを走査する。
     モジュール内のトップレベルに記述できるすべての要素
     (letバインディングやネストされたモジュール、型の宣言など)が対象になる。
    +
    val decls : seq<SynModuleDecl>
    +
    val declaration : SynModuleDecl
    +
    type SynModuleDecl =
      | ModuleAbbrev of ident: Ident * longId: LongIdent * range: range
      | NestedModule of SynComponentInfo * isRecursive: bool * SynModuleDecls * bool * range: range
      | Let of isRecursive: bool * SynBinding list * range: range
      | DoExpr of SequencePointInfoForBinding * SynExpr * range: range
      | Types of SynTypeDefn list * range: range
      | Exception of SynExceptionDefn * range: range
      | Open of longDotId: LongIdentWithDots * range: range
      | Attributes of SynAttributes * range: range
      | HashDirective of ParsedHashDirective * range: range
      | NamespaceFragment of SynModuleOrNamespace
        member Range : range
    +
    union case SynModuleDecl.Let: isRecursive: bool * SynBinding list * range: FSharp.Compiler.Range.range -> SynModuleDecl
    +
    val isRec : bool
    +
    val range : FSharp.Compiler.Range.range
    +
    val visitModulesAndNamespaces : modulesOrNss:seq<SynModuleOrNamespace> -> unit


     すべてのモジュールや名前空間の宣言を走査する
     (基本的には 'module Foo =' または 'namespace Foo.Bar' というコード)
     なおファイル中で明示的に定義されていない場合であっても
     暗黙的にモジュールまたは名前空間の宣言が存在することに注意。
    +
    val modulesOrNss : seq<SynModuleOrNamespace>
    +
    val moduleOrNs : SynModuleOrNamespace
    +
    Multiple items
    union case SynModuleOrNamespace.SynModuleOrNamespace: longId: LongIdent * isRecursive: bool * kind: SynModuleOrNamespaceKind * decls: SynModuleDecls * xmlDoc: PreXmlDoc * attribs: SynAttributes * accessibility: SynAccess option * range: FSharp.Compiler.Range.range -> SynModuleOrNamespace

    --------------------
    type SynModuleOrNamespace =
      | SynModuleOrNamespace of longId: LongIdent * isRecursive: bool * kind: SynModuleOrNamespaceKind * decls: SynModuleDecls * xmlDoc: PreXmlDoc * attribs: SynAttributes * accessibility: SynAccess option * range: range
        member Range : range
    +
    val lid : LongIdent
    +
    [<Struct>]
    val isMod : SynModuleOrNamespaceKind
    +
    val decls : SynModuleDecls
    +
    val xml : PreXmlDoc
    +
    val input : string
    +
    val tree : ParsedInput
    +
    val getUntypedTree : file:string * input:FSharp.Compiler.Text.ISourceText -> ParsedInput


     特定の入力に対する型無し構文木を取得する
    +
    Multiple items
    module ParsedInput

    from FSharp.Compiler.SourceCodeServices

    --------------------
    type ParsedInput =
      | ImplFile of ParsedImplFileInput
      | SigFile of ParsedSigFileInput
        member Range : range
    +
    union case ParsedInput.ImplFile: ParsedImplFileInput -> ParsedInput
    +
    val implFile : ParsedImplFileInput
    +
    Multiple items
    union case ParsedImplFileInput.ParsedImplFileInput: fileName: string * isScript: bool * qualifiedNameOfFile: QualifiedNameOfFile * scopedPragmas: ScopedPragma list * hashDirectives: ParsedHashDirective list * modules: SynModuleOrNamespace list * isLastCompiland: bool * bool -> ParsedImplFileInput

    --------------------
    type ParsedImplFileInput = | ParsedImplFileInput of fileName: string * isScript: bool * qualifiedNameOfFile: QualifiedNameOfFile * scopedPragmas: ScopedPragma list * hashDirectives: ParsedHashDirective list * modules: SynModuleOrNamespace list * isLastCompiland: bool * bool
    +
    val fn : string
    +
    val script : bool
    +
    val name : QualifiedNameOfFile
    +
    val modules : SynModuleOrNamespace list
    + +
    +
    + + + + +
    +
    +
    + Fork me on GitHub + + diff --git a/fcs/docsrc/tools/generate.ja.fsx b/fcs/docsrc/tools/generate.ja.fsx index a56c9af9f6..ff7ca6bd03 100644 --- a/fcs/docsrc/tools/generate.ja.fsx +++ b/fcs/docsrc/tools/generate.ja.fsx @@ -9,9 +9,6 @@ // Binaries that have XML documentation (in a corresponding generated XML file) let referenceBinaries = [ "../../../artifacts/bin/fcs/Release/net461/FSharp.Compiler.Service.dll" ] -// Web site location for the generated documentation -let website = "/FSharp.Compiler.Service/ja" - // Specify more information about your project let info = [ "project-name", "F# Compiler Services" From 4d4e42c44499d24116d9f857c10b1eef2e3b114d Mon Sep 17 00:00:00 2001 From: nojaf Date: Sun, 9 Feb 2020 21:39:12 +0100 Subject: [PATCH 7/7] Removed .idea --- fcs/.idea/.idea.FSharp.Compiler.Service/.idea/.name | 1 - 1 file changed, 1 deletion(-) delete mode 100644 fcs/.idea/.idea.FSharp.Compiler.Service/.idea/.name diff --git a/fcs/.idea/.idea.FSharp.Compiler.Service/.idea/.name b/fcs/.idea/.idea.FSharp.Compiler.Service/.idea/.name deleted file mode 100644 index ea534d5c8e..0000000000 --- a/fcs/.idea/.idea.FSharp.Compiler.Service/.idea/.name +++ /dev/null @@ -1 +0,0 @@ -FSharp.Compiler.Service \ No newline at end of file