F# Compiler Services


F# Compiler Services

Microsoft.FSharp.Compiler Namespace

TypeDescription
ErrorInfo

Renamed to FSharpErrorInfo

FSharpErrorInfo
FSharpErrorSeverity
Severity

Renamed to FSharpErrorSeverity

ModuleDescription
Ast
ErrorLogger
PrettyNaming

Anything to do with special names of identifiers and other lexical rules

Range

Microsoft.FSharp.Compiler.AbstractIL Namespace

ModuleDescription
IL

The "unlinked" view of .NET metadata and code. Central to to Abstract IL library

Microsoft.FSharp.Compiler.AbstractIL.Internal Namespace

ModuleDescription
Library

Microsoft.FSharp.Compiler.Interactive Namespace

ModuleDescription
Shell

Microsoft.FSharp.Compiler.SimpleSourceCodeServices Namespace

TypeDescription
SimpleCheckFileResults

Represents the results of type checking. A mild simplification of SourceCodeService's CheckFileResults. Normally it is better to use the full CheckFileResults directly, available from 'FullResults'.

SimpleDeclaration

Represents a declaration returned by GetDeclarations. Simpler than the one in 'SourceCodeServices' because it formats the XML content for you (apart from ones read from XML doc files using xmlCommentRetriever)

SimpleSourceCodeServices

Provides simpler version of services for checking and compiling F# scripts

Microsoft.FSharp.Compiler.SourceCodeServices Namespace

TypeDescription
CheckFileAnswer

Renamed to FSharpCheckFileAnswer

CheckFileResults

Renamed to FSharpCheckFileResults

CheckOptions

Renamed to FSharpProjectOptions

CheckProjectResults

Renamed to FSharpCheckProjectResults

ColorState

Renamed to FSharpTokenizerColorState

CompilerEnvironment

Information about the compilation environment

DataTipText

Renamed to FSharpToolTipText

Declaration

Renamed to FSharpDeclarationListItem

DeclarationGroup

Renamed to FSharpDeclarationListInfo

DeclarationItem

Renamed to FSharpNavigationDeclarationItem

DeclarationItemKind

Renamed to FSharpNavigationDeclarationItemKind

DeclarationSet

Renamed to FSharpDeclarationListInfo

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

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.

FSharpDeclaration

Renamed to FSharpDeclarationListItem

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.

FSharpDeclarationSet

Renamed to FSharpDeclarationListInfo

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 simialr 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

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

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 0 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.

FSharpMemberFunctionOrValue

Renamed to FSharpMemberOrFunctionOrValue

FSharpMemberOrFunctionOrValue

A subtype of F# symbol that represents an F# method, property, event, function or value, including extension members.

FSharpMemberOrVal

Renamed to FSharpMemberOrFunctionOrValue

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
FSharpObjectExprOverride

Represents a checked method in an object expression, as seen by the F# language.

FSharpParameter

A subtype of FSharpSymbol that represents a parameter

FSharpParseFileResults

Represents the results of parsing an F# file

FSharpProjectContext

Represents the checking context implied by the ProjectOptions

FSharpProjectOptions

A set of information describing a project or script build configuration.

FSharpRecordField

Renamed to FSharpField

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

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

A single tool tip display element

FSharpToolTipText

Information for building a tool tip box.

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.

FindDeclFailureReason

Renamed to FSharpFindDeclFailureReason

FindDeclResult

Renamed to FSharpFindDeclResult

InteractiveChecker

Renamed to FSharpChecker

IsResultObsolete

Callback which can be used by the host to indicate to the checker that a requested result has become obsolete, e.g. because of typing by the user in the editor window. This can be used to marginally increase accuracy of intellisense results in some situations.

LexState

Renamed to FSharpTokenizerLexState

LineTokenizer

Renamed to FSharpLineTokenizer

Method

Renamed to FSharpMethodGroupItem

MethodGroup

Renamed to FSharpMethodGroup

MethodGroupItem

Renamed to FSharpMethodGroupItem

NavigationItems

Renamed to FSharpNavigationItems

NoteworthyParamInfoLocations

Renamed to FSharpNoteworthyParamInfoLocations

NotifyFileTypeCheckStateIsDirty

Obsolete and replaced

Param

Renamed to FSharpMethodGroupItemParameter

ParseFileResults

Renamed to FSharpParseFileResults

Position
ProjectContext

Renamed to FSharpProjectContext

ProjectOptions

Renamed to FSharpProjectOptions

Range
SourceTokenizer

Renamed to FSharpSourceTokenizer

TokenCharKind

Renamed to FSharpTokenCharKind

TokenColorKind

Renamed to FSharpTokenColorKind

TokenInformation

Renamed to FSharpTokenInfo

ToolTipElement

Renamed to FSharpToolTipElement

ToolTipText

Renamed to FSharpToolTipText

TopLevelDeclaration

Renamed to FSharpNavigationTopLevelDeclaration

TriggerClass

Renamed to FSharpTokenTriggerClass

TypeCheckAnswer

Renamed to FSharpCheckFileAnswer

TypeCheckResults

Renamed to FSharpCheckFileResults

UnresolvedReferencesSet

Unused in this API

UntypedParseInfo

Renamed to FSharpParseFileResults

XmlComment

Renamed to FSharpXmlDoc

ModuleDescription
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

FSharpTokenTag

Some of the values in the field FSharpTokenInfo.Tag

Obsoletes
PrettyNaming

A set of helpers related to naming of identifiers

UntypedParseImpl
Fork me on GitHub