Microsoft.VisualStudio.Workspace

Convenience extension for IAccessScontrol service

Get Access to a file or folder (folder access will apply to all items under that folder recursively). Note: it will throw canceled exception if the scope CacnelRequest becomes active (in addition the cancel token).

asset access context the path to file or folder, can be absolute or WorkspaceRoot relative lock scope cancellation token maximum time to wait (in milliseconds). the access lock object, will return null if timeout reached, will throw if canceled

Get Access to a file or folder (folder access will apply to all items under that folder recursively). Note: it will throw canceled exception if the scope CacnelRequest becomes active (in addition the cancel token).

the access control service the priority of the work the path to file or folder, can be absolute or WorkspaceRoot relative sharing mode children lock scope cancellation token maximum time to wait (in milliseconds). the access lock object

Get Access to a file or folder (folder access will apply to all items under that folder recursively). Note: it will throw canceled exception if the scope CacnelRequest becomes active (in addition the cancel token).

the access control service the priority of the work the collection of strings representing path to file or folder, can be absolute or WorkspaceRoot relative sharing mode children lock scope cancellation token maximum time to wait (in milliseconds). the access lock object, null if timeout expired

Execute action wilt lock yield and retry;

result type lock context action to execute resources to lock lock scope cancellation token action result

Execute action wilt lock yield and retry;

result type lock context action to execute resource to lock lock scope cancellation token action result

Exception being thrown when attempting to acquire a lock when a higher priority scope request access to a resource already taken and not released by the current access scope.

Scope of the lock (for folders)

lock only the item

lock item and direct children

lock item and all children

Asset access scope. Locks taken in the same scope will not block each other.

Cancellation token when AccessControl services will request the context owner to yield as soon as possible when more important task require access to some of the resources currently locked

Get Access to a file or folder (folder access will apply to all items under that folder recursively). Throws OperationCanceledException if "cancel" is canceled Throws AccessLockYieldRequestException if context is requested to yield to other more important workflow

the collection of strings representing path to file or folder, can be absolute or WorkspaceRoot relative lock scope cancellation token maximum time to wait (in milliseconds). the access lock object, will return null if timeout reached, will throw if canceled

Priority for this context. It is based on the kind of work context is used to provide resource locks.

service (like indexing) is performing a background operation (does not directly affect current user action).

User initiated action that we perform on a background (like delete folder).

User initiation action that is blocked on asset access (like rename file).

Access sharing semantic.

Don't share the access with any other access scope

Can share access with other Share scopes

Used to control the access for shared resources like files and folders

Opens a assets access context to be used by a workflow.

the priority of the work new access context object sharing mode (with other contexts)

Hold an access to a [set of] file[s] or folder[s] Disposing the object will release the lock and allow other scopes to take access.

Cancellation token when AccessControl services will request the context owner to yield as soon as possible when more important task require access to some of the resources currently locked

the context used to acquire this lock

Async Event class to support firing async EventHandlers

The EventArgs type to support

Initializes a new instance of the class.

Return the async invocation list

Operator += to support standard mechanism of event subscription

The async event class Async event callback to add The existing or created Async event class

Operator -= to support standard mechanism of event subscription

The async event class Async event callback to remove The Async event

Insert a callback in the specified position

The async event class Position where to insert the callback Async event callback The Async event

Invoke async to await for each

sender object Event Argument instance The task to await to wait for all notifications to complete

Invoke async to await for each

sender object Event Argument instance Invoke the subscribers in order The task to await to wait for all notifications to complete

Invoked when changes to the Invocation List are added or removed

If a new item was added otherwise remove

IAsyncEnumerable interface

Type of item

Returns an enumerator that supports asynchronous iterates through a collection.

Async Enumerator instance

IAsyncEnumerator interface

Type of item

Gets the element in the collection at the current position of the enumerator.

Move to next item

Completion task

Class BatchFileSystemEventArgs Allow a notification of multiple FileSystemEventArgs entities

Initializes a new instance of the class.

All file systems events

All file system events

Build configuration changed event arguments

Initializes a new instance of the class.

The project file context The new build configuration

The project file affected

The new build configuration

BatchFileContext class

Initializes a new instance of the class.

The action for this batch context

Action to execute our batch

BatchFileContextActionResult class

Initializes a new instance of the class.

Collection of Success project status If overall result is success

Collection of success results

Build Configuration Context implementation

The indexed data name when defining configurations

Identifies an action context that launches a debug session.

Identifies an action context that launches a debug session.

Initializes a new instance of the class.

The build configuration

Build Context Types

Build Context type

The Clean target build type

The Rebuild target build type

Build All Context type

Rebuild All Context type

Clean All Context type

The batch build type

Custom Build context type

Project References context type

BuildUpToDateCheckProviderContext type

Identifies an action context that launches a build.

{D9212C5D-975A-49E6-A753-2F586BFBF077}

Clean context type GUID

Rebuild context type GUID

Build All context type GUID

Rebuild All context type GUID

Clean All context type GUID

Batch context type GUID

Custom Build context type GUID

Project References context type GUID

BuildUpToDateCheckProviderContext type GUID

Return the matching Type for a build type

The target build type The GUID of the context type

Return the build type for target context type

The target context type The build type that match the target

Implements IFileContextAction with the option to send a build message when the execution is cancelled

Initializes a new instance of the class.

The original source action The build message service to report Project file to report

Execute a callback and report a task cancelled exception

Callback to execute The build message service to report Project file to report Completion task

Represent a failure caused by an incremental build

Initializes a new instance of the class.

Exception message Inner exception being propagated

Type of build incremental progress status

Build started

Calculation of build dependencies

Notify projects to be built

Build finished

A Build failure exception happen during processing

A Project build begin event

A Project build end event

A Build was cancelled

Class to request a build list on the build services

The project file to build

Optional project target

Filter selected dependencies

Included projects when building our dependency graph

Excluded projects to discard building

The build configuration context

Build Message definition

Task type to create for this message

just message

Warning

Error

Code error

Project file that could have generate this message

Task type

message string to go to output window

message text for task item to create

Filename (optional) for source location of the issue

Line number of the issue.

Column number of the issue.

task subcategory

Task help keyword

Build Messages Event

Initializes a new instance of the class.

Messages to flush

Message

A context to define a project incremental build

The project to build with dependency

The build type

The project target configuration name

The build configuration context

Optional workspace data

The incremental build context

The project build order index

Result provided for incremental build

Initializes a new instance of the class.

If overall success Number of projects that succeeded Number of projects that failed Number of projects that were up to date

Number of projects that succeeded

Number of projects that failed

Number of projects that were up to date

Context returned by IFileContextProvider(BuildProjectReferencesRequest)

Initializes a new instance of the class.

If project opted out from build List of project references

If project opted out from build

List of project references

Data structure to request project references

The project target

The build configuration context

Build projects support context

Initializes a new instance of the class.

Build type Configuration context Info on projects to build Excluded Projects

IsSupported field

The build context action

The build type

The build configuration context

Optional list of project dependencies

Excluded projects

Build Request data

The build type requested

If incremental build is requested

Build types available to target

Normal incremental build

Normal incremental build

Clean build outputs

Re build target

Normal incremental build all

Rebuild all

Clean all

BuildUpToDateActionContext class

Identifies an action context that invoke up to date check

Guid of ContextType

Initializes a new instance of the class. 15.0 BACKCOMPAT OVERLOAD -- DO NOT TOUCH

IBuildUpToDateCheckProvider provider The context project file The project target Optional build configuration context Optional build target configuration

Initializes a new instance of the class.

IBuildUpToDateCheckProvider provider The context project file The project target Optional build configuration context Optional build target configuration Dependency build configuration context

Check if the context project file is up to date

A cancellation token True or false depending if the context project file is up to date

Data structure to request BuildUpToDateActionContext

The project target

The build configuration context

Dependency build configuration context

The project target configuration name

The Index workspace data

The incremental build context

BuildUpToDateCheckProviderContext class to return info for BuildUpToDateCheckProvider

Initializes a new instance of the class.

Input files Output files

Input files relevant for a project

Output files relevant for a project

Options for IBuildUpToDateCheckProvider

None

Data structure to request BuildUpToDateCheckProvider info

The project target

The build configuration context

The project target configuration name

The Index workspace data

Class DependencyBuildConfigurationContext

Initializes a new instance of the class.

Dependency project file Build configuration context Optional index workspace data

Build configuration context

The project dependency context

The Index workspace data

ExportBuildUpToDateCheckAttribute class to MEF export Build up to date provider attributes

Initializes a new instance of the class.

provider options The unique type for this IBuildUpToDateCheckProviderMetadata The supported file extension File scanner priority

Interface for a in-proc or out-of-proc build action progress

Report build status

The build message Optional data Task completion

Define a Build Configuration Context

Configuration setting context

Interface to describe a build file context

Execute a build action

A means to report progress as the build executes. A token that may cancel the build. Completion task with build succeed result.

Context of an Incremental build

Project being built

Option target on the project

The Build type being executed

The selected build configuration context

Interface to extend IBuildIncrementalContext

Custom properties

Interface to support progress on the build incremental

Report status when incremental build is in progress

The build incremental context Status progress Optional data Task completion

Build Message Service

Async event when flush messages

Report build messages

Collection of messages to report Completion task

Interface to return a list of IsSuccess status for a list of projects

Success per project status

Build Service interface

Provide per project events

Provide per project events

Get a Build Configuration Context type action

The project file context Optional project target The desired context type Callback to invoke to match a file context File context actions that match the passed target project build configuration

Get a Build Configuration Context type action

The project file context Optional project target The desired context type Optional target project build configuration File context actions that match the passed target project build configuration

Get all file contexts that match a specific target project build configuration

The project file context Optional project target The desired context type Optional target project build configuration File Contexts grouped by provider

Return a valid BuildUpToDateActionContext from a project file

The project file context Optional project target Optional target project build configuration Optional cancellation token Null or a valid BuildUpToDateActionContext for a project file

Build a project by invoking a build context actions from a provider

The project file context Optional project target The build configuration The desired build context type A progress monitor Optional cancellation token Completion task with build succeed result

Build a project incrementally by invoking a build context actions from a provider

The project file context Optional project target list of root project references to build, if null - all references list of excluded projects (typically user unloaded projects in solution case) The build configuration context build type (build, rebuild, etc) Enable incremental build (UTD check) A progress monitor Optional cancellation token Info about the incremental build

Get a build project action

The project file context Optional project target Build configuration context Optional cancellation token The build incremental action or null if no provider support

Get the dependency project file build configuration context

Target project to resolve the dependency The dependency project from our target The original build configuration context Optional cancellation token A build configuration context for the target project to resolve

Create a File context action based on multiple known actions

List of actions to chain Aggregated context action

Return a list of the projects dependencies based on a project file and optional target

The project file path Optional project file target A build configuration context The cancellation token List of projects involved in this dependency graph

Create a build project incremental action

The project file context Optional project target list of root project references to build, if null - all references list of excluded projects (typically user unloaded projects in solution case) The build configuration context build type (build, rebuild, etc) Enable incremental build (UTD check) A file context action that is able to build incremental

Interface IBuildService2 extension of IBuildService

Build a project incrementally by invoking a build context actions from a provider

The build request entity A progress monitor Optional cancellation token Info about the incremental build

Return the dependency graph of a build request

A build list request info Cancellation token Task completion with dependency graph info

Interface IBuildService3 extension of IBuildService

Gets the actions available on a workspace context

Type of the context The path to the project The file context The desired context type Target project build configuration A cancellation token File context actions that match the passed target project build configuration

Gets the actions available on a workspace context

Type of the context The path to the project The file context The context types Callback to invoke to match a file context A cancellation token File context actions that match the passed target project build configuration

interface IBuildUpToDateCheckProvider

Check if project file is up to date based on a build configuration

The project file to evaluate Optional target in the project Optional build configuration context An optional build configuration Cancellation token true of if the project file is up to date or false otherwise

Interface IBuildUpToDateCheckProvider2 Note: this is an alternative callback to IBuildUpToDateCheckProvider that provide access to the IDependencyBuildConfigurationContext context and so resolve multiple build configuration dependencies

Check if project file is up to date based on a build configuration

The project file to evaluate Optional target in the project IDependencyBuildConfigurationContext instance Cancellation token true of if the project file is up to date or false otherwise

IBuildUpToDateCheckProviderMetadata interface

Provider options

Interface to retrieve a dependency build configuration

Resolve a build configuration dependency

Optional index workspace data Path to dependency project to resolve Cancellation token Completion task

IProjectBuild interface

The project file to build

The full path of the project

Up to Date action

References

Dependencies

Event fires when project begin building

Initializes a new instance of the class.

full path to the project file we are building

Initializes a new instance of the class.

full path to the project file we are building The build configuration active for this project

Project moniker (usually the full path of the project file)

The build configuration for this project

Defines the build outcome

build succeeded

project was up to date and not built.

build failed

build was canceled

Event fires when project building is completed

Initializes a new instance of the class.

full path to the project file we are building build outcome

Initializes a new instance of the class.

full path to the project file we are building The build configuration active for this project build outcome

Project moniker (usually the full path of the project file)

The build configuration for this project

Build outcome.

Workspace Item Filter service.

Gets the Item Filter object for the given filterKey.

the file content type item filter object

Get properties associated with this content type

the content type id the workspace scope the settings defining this content type

Get the list of defined content types.

workspace scope the list of content types we have definitions on

Represent a file classification based on content type

the file full path

the content type (aka C++/text/C# etc)

Check if the file satisfy the selector criteria

the file selector true if file applies

Custom Configuration Constants

task.json name

'type' key

'tasks' key

'taskName' key

'taskLabel' key

'appliesTo' key

'inheritEnvironments' key

Type of context being exposed

'output' key

Defaults Key

Json version Value

EnvVars key (deprecated)

Env key

Options for IFileContextProvider

None

Helpers for a Custom settings entry

Return the file context type from a custom settings

The custom settings source GUID with the parsed file context type

Return the task label of a custom settings entry

The custom settings source The Task label name of the custom settings

MEF export helper for ILaunchConfigurationProviderMetadata

Initializes a new instance of the class.

Provider options The unique type for this List of content types to handle Anonymous content type definition (glob patterns) Custom Json schema content File scanner priority

MEF export helper for ILaunchConfigurationProviderMetadata

Initializes a new instance of the class.

Provider options The unique type for this The supported file extension Custom Json schema content File scanner priority

Initializes a new instance of the class.

Provider options The unique type for this List of content types to handle Anonymous content type definition (glob patterns) Custom Json schema content File scanner priority

Interface to access custom context services

Notifies when the custom settings has changed

Return the Schema Content for all the combined custom providers

Providers metadata JSON content of the combined schema

Customize the file context settings for a file path

File path to customize list of providers to use Result info with JSON content and created items

Extension to interface ICustomContextService

Validate a JSON content of a tasks.vs.json file by validating all the task items

The JSON content to validate Collection of BuildErrors to validate

Interface to allow customize settings to a file context

Customize the context

File path of the customized context The settings to fill with some default values

Metadata interface to export custom file contexts

Provider options

The customized json schema

A Debugger Launch Action context

Identifies an action context that launches a debug session.

Startup Project name entry

Identifies an action context that launches a debug session.

Initializes a new instance of the class.

Debug target path Provider to launch this context The target project file context Build Configuration setting

Initializes a new instance of the class.

Launch configuration parameters Provider to launch this context The target project file context Build Configuration setting

Launch configuration parameters

Optional project file target

Launch the target using the provider being initialized

Workspace context The service provider

MEF export helper for ILaunchConfigurationProviderMetadata

Initializes a new instance of the class.

provider options The unique type for this ILaunchDebugTargetProviderMetadata The supported file extension Launch type name Launch Json schema content If Runtime support context is supported File scanner priority

Initializes a new instance of the class.

The unique type for this ILaunchDebugTargetProviderMetadata The supported file extension Launch type name Launch Json schema content If Runtime support context is supported File scanner priority

DebugLaunchActionContextAttribute class to MEF export debug launch attributes

Initializes a new instance of the class.

Provider options The unique type for this ILaunchDebugTargetProviderMetadata The supported file extension File scanner priority

Initializes a new instance of the class.

The unique type for this ILaunchDebugTargetProviderMetadata The supported file extension If Runtime support context is supported File scanner priority

Specialized Context action to debug that support a build step action

A build step action to invoke before the debug action is executed

Debug Context progress update

Controls whether the debugging experience should continue or not

ILaunchConfigurationProvider interface

If a project file is being supported by this launch configuration provider

Debug Launch Action context true if this context is being supported for this provider

Create a launch configuration settings for a project file

Debug Launch Action context The launch settings instance

ILaunchConfigurationProviderMetadata interface

Provider options

Launch type name

The launch json schema

If Context support is being resolved on runtime or only by its static metadata

Define debug services to be available trough IServiceProvider

Return a debug target provider for a file path

The file path of that target A provider that is capable to launch the target being passed true if the target provider is being found

Interface ILaunchDebugService2 extension of ILaunchDebugService

Return a debug target provider for a

The project configuration A provider that is capable to launch the target being passed true if the target provider is being found

IDebugLaunchActionContext interface

Launch a Debug Context

Workspace context The service provider context The Debug context to launch

If this context is supported for this Provider

Workspace context A file workspace true if this provider is able to handle this context

IDebugLaunchActionContext interface

If the project configuration is supported by this provider.

Workspace A ProjectConfiguration true if this provider is able to handle this ProjectConfiguration

ILaunchDebugTargetProviderMetadata interface

Provider options

If the provider is capable to handle context

IProjectConfigurationManager interface

To receive notifications when properties in this are changed

Build configuration changed

All project file configurations from the different sources

Get the Current Project

Set an Active Current Project

The project file context Optional project configuration name Task completion

Add or Remove a Startup project File

The project file context if add or remove is desired Task to monitor completion

Update the current project actions

Task completion

Retrieve project configuration for a Project File

The project file context Optional name of the configuration The Active build configuration A project file settings instance

Return all build configurations for a project file

The project file context list of build configurations or null if not found

Get active build configuration

The project file context The active build configuration

Create Debug launch settings for a project file

The project file context Debug Launch Action context list of launch settings to composite A Composite launch settings

Return a build action based on an existing build action context

The target project file context The build configuration context The default build context action Completion task

Customize a launch settings to a project file

The project file context If duplication is allowed for project names if the launch.json content will be updated on disk Context position where the launch configuration section is being placed

Extension for interface IProjectConfigurationService

Refresh all the indexed project we keep track

Completion task

Create a composite settings instance

The project file context Debug Launch Action context list of launch settings to composite A Composite launch settings

Validate a JSON content of a launch.vs.json

The JSON content to validate Collection of BuildErrors to validate

Creates property settings with attached evaluator. The object returned will implement IPropertyEvaluatorHost.

generic settings the configured evaluator Settings with evaluator

Customize a launch settings to a project file

debugger template id (can be null) initial content from template The project file context If duplication is allowed for project names if the launch.json content will be updated on disk Context position where the launch configuration section is being placed

Launch Configuration Constants

Launch json file name

Name key

Project Key

Project target Key

Type Key

Target Key

Inherit Environments Key

Debug Type key

Native option key

Native option key

Arguments Key

Environment Key

Current Directory Key

Remote machine key

Program key

Port name key

Debug engine key

Stop on entry option key

No Debug key

Configurations Key

Build Configurations Key

Defaults Key

Defaults Key

Launch Json version Value

Json element name for settings based debugger templates.

Templates visual studio debugger engine guid.

JSon element that contains the array for templates for the given debugger. all of these will be displayed in Select debugger dialog.

Unique identifier for a extension template.

Template display name key.

Template description key.

The initial content to add to launch.vs.json when creating a new launch entry from the selected template.

Priority of the template.

Priority of the template.

dedicated evaluation namespace for runtime launch configuration.

section key name where templates can provide a default values for runtime evaluation properties.

custom parameters definition section in debug template.

Json schema

the value property when custom parameter is defined with extended schema. aka: "Exe" : { "value" : "${debugInfo.target}", "required" : true }

Custom parameter extended schema key specifying that template requires a non empty value for that parameter. A dedicated error is generated if the evaluated value for that parameter at runtime is null or empty.

Options for IFileContextProvider

None

Options for ILaunchDebugTargetProvider

None

If runtime support context is wanted

Evaluation error instance returned when using the Evaluation service API

Initializes a new instance of the class.

name of the variable that fails to evaluate Start position of the error End position of the error

Start position where the error is found

Start position where the error is found

End position where the error is found

Represent an evaluation result

Initializes a new instance of the class.

if success Content evaluated Collection of errors found

If evaluation succeed

The evaluated content

Collection of errors found on the evaluation

Constant defined in the Evaluation namespace

The environment namespace

The File workspace type

The Property settings type

The Workspace settings source type

The Property Variable type

The environment variable type

The project configuration type

The File workspace GUID type

The Property settings GUID type

The Property Variable GUID type

The Workspace settings source GUID type

The environment variable GUID type

The project configuration GUID type

Helpers defined for the Evaluator namespace

Return the namespace name of a value

Value in the form of namespace.value Info of namespace and name

Evaluate a single property

The evaluation service Optional namespace Name of the variable The file path Optional inherit environments to pass Optional property evaluators Info on the evaluation result

Evaluate a content and return the partial evaluation ignoring any possible error

The evaluation service Content to be evaluated The file path Optional contexts to pass Optional property evaluators Content of evaluation result

Export attribute for a IPropertyEvaluator

Initializes a new instance of the class.

The unique type for this IProviderMetadataBase List of supported namespaces Priority of this provider

Define Property group default options

Default namespace

Default scope

Default environment

Default group priority

IConfiguredPropertyEvaluator

the Property evaluator service

Evaluate a content and resolve all possible ${prefix.var} instances found

the string to evaluate An evaluation result instance

Create a new IConfiguredPropertyEvaluator by up adding new contexts and/or property providers.

Optional collection of contexts to pass to providers Local scope property valuators the updated IConfiguredPropertyEvaluator object

Represent a provider that is able to resolve properties

Return the properties that are available for a namespace

The prefix namespace to filter Optional inherit environments Collection of properties that this provider is able to support

Return the matches found on a property context

The property context Collection of matches

IPropertyEvaluatorHost Implemented by object (usually collections) that support automatic property evaluation.

Objects evaluator.

Represent the metadata of a provider that is able to resolve the value of a property

List of supported namespaces

Interface to expose a service that is able to evaluate a content and resolve all their ${prefix.Var}

Notifies when property variables are changed

Return the providers that match a filter criteria

The namespace Collection of property evaluators

Get all properties that are available for a namespace and context

The namespace Optional context Collection of possible properties

Return the matching properties for a property context

The property context to filter Optional property evaluators Collection of match property results

Evaluate a content and resolve all possible ${prefix.var} instances found

Content data to look The file scope context Optional collection of environments to pass to providers Local scope property valuators An evaluation result instance

Create a IConfiguredPropertyEvaluator that will aggragate the all available property providers. Useful to pass around across different consumers, that may not need to know how property provides were selected.

The file scope context Optional collection of environments to pass to providers Local scope property valuators the updated IConfiguredPropertyEvaluator object

Create a property evaluator based on a IPropertySettings source

The source settings Group Priority desired Priority desired The provider evaluator and metadata

Create a property evaluator based on a IWorkspaceSettingsSource source

The source settings Group Priority desired Priority desired The provider evaluator and metadata

Create property evaluator based on a collection of PropertyVariable(s)

Collection of property groups The provider evaluator and metadata

Parse a JSON content of property groups

JSON content with an array of property groups Group default options Collection of property groups

Parse a collection of IWorkspaceSettingsSource

The property groups sources Group default options Collection of property groups

Parse a collection of IPropertySettings

The property groups sources Group default options Collection of property groups

Define matched properties to be returned by property resolver provider

Initializes a new instance of the class.

The group priority Matched properties

Return an empty match

Get the group priority

Collection of matched properties

Return a single match result

The single matched instance Collection with the single element

Return a single match result

Group priority desired Property properiority desired Value of the match Collection with the single element

Define a simple entity to return a single matched property

Initializes a new instance of the struct.

Property priority Property value

Get the matched priority

Get the matched value

Operator ==

Match property 1 Match property 2 True if are the same

Operator !=

Match property 1 Match property 2 True if are different

Entity to return a Property match with a provider

Initializes a new instance of the class.

The provider evalutor info The match property

Get the provider info

Get the matched property

Represent a property context to be evaluated

Initializes a new instance of the class.

The file path context where this property is being evaluated The namespace Name of property Optional environments

Name with namespace

File path context

Namespace of this property

The property name

Optional property context

Define a group of properties to match

Initializes a new instance of the class.

Namespace for this properties Scope to apply Environment to apply Optional list of reference contexts Group priority to apply Collection of properties to include

Initializes a new instance of the class.

Namespace for this properties Scope to apply Environment to apply Optional list of reference contexts Group priority to apply Collection of properties to include

Initializes a new instance of the class.

Namespace for this properties comma separated glob patterns Environment to apply Optional list of inherit environments Group priority to apply Collection of properties to include

Initializes a new instance of the class.

Namespace for this properties implied root for the glob patterns git style glob patterns Environment to apply Optional list of reference contexts Group priority to apply Collection of properties to include

Namespace (or null) for all this group

Priority to apply for this group

Scope of this properties to apply

Environment of this properties to apply

List of reference contexts that this group needs

Properties to apply

Create a FileDataValue to be indexed

FileDataValue instance to be indexed

File matcher parameters

the implied root

The git style glob patterns

Recommended property priorities range

Lowest priority

BelowNormal priority

Normal priority

AboveNormal priority

Highest priority

Define a property variable info

Initializes a new instance of the class.

Name of the property Value of this property Priority of this property

The name of this property

Value of this property

Custom priority of this property

Class PropertyVariablesChangedEventArgs intented to notify when property varaibles has changed

Exports an to the MEF catalog with metadata as described by .

Initializes a new instance of the class.

FileContextActionProvider Options The unique type for this IFileContextActionProviderMetadata The provider priority A collection of GUIDs that identify the values that this language service can initialize from.

Initializes a new instance of the class.

The unique type for this IFileContextActionProviderMetadata The provider priority A collection of GUIDs that identify the values that this language service can initialize from.

Initializes a new instance of the class.

The unique type for this IFileContextActionProviderMetadata A collection of GUIDs that identify the values that this language service can initialize from.

Exports an to the MEF catalog with metadata as described by .

Initializes a new instance of the class.

The unique type for this IFileContextProviderMetadata The provider priority A collection of the values that may be produced for by this provider.

Initializes a new instance of the class.

The unique type for this IFileContextProviderMetadata The provider priority Supported GetContexts types A collection of the values that may be produced for by this provider.

Initializes a new instance of the class.

FileContextProvider Options The unique type for this IFileContextProviderMetadata The provider priority Supported GetContexts types A collection of the values that may be produced for by this provider.

Initializes a new instance of the class.

The unique type for this IFileContextProviderMetadata A collection of the values that may be produced for by this provider.

Export File Extension provide base

Initializes a new instance of the class.

Version for this provider The unique type for this Provider The set of file extensions (including the leading period) that this scanner is capable of parsing. Provider priority Contract type

Initializes a new instance of the class.

The unique type for this Provider The set of file extensions (including the leading period) that this scanner is capable of parsing. Provider priority Contract type

Initializes a new instance of the class.

The unique type for this Provider list of content types to handle anonymous content type definition Provider priority Contract type

Base Implementation for the IProviderMetadataBase interface

Initializes a new instance of the class.

Version for this provider The unique type for this IProviderMetadataBase The provider priority Contract Type

Initializes a new instance of the class.

The unique type for this IProviderMetadataBase The provider priority Contract Type

Initializes a new instance of the class.

The unique type for this IProviderMetadataBase Contract Type

Return the options flags internal

Class ExportWorkspaceServiceFactoryAttribute

Initializes a new instance of the class.

Options for service factory List of types supported by this factory

Data structure to request external items

External items context type

External items context type Guid

The query string to match for external items

Describes the context a file may belong to, such as a compilation unit for a source file, a consuming HTML page for a .js file, etc.

An instance of this type may be shared across many files, or members of the context.

Empty file contexts

Initializes a new instance of the class.

An identifier for the type of the provider that create this Context An identifier for the type of object and data represented in . This may be used to match with a compatible language service provider. The information a language service would need to fully initialize for a member of this context. The set of workspace-relative paths to files that served as inputs to the construction of this context. This is *not* the set of files that would be read during execution of a build. The user-friendly name for this context (e.g. "Debug|Any CPU"). May be empty, but must not be null. The INotifyFileContextChanged implementation to use it for notification

Return or set the current file context changed

The Provider source for this Context

Gets an identifier for the type of object and data represented in . This may be used to match with a compatible language service provider.

Gets the information a language service would need to fully initialize for a member of this context.

Gets the set of workspace-relative paths to files that served as inputs to computing this context. This is *not* the set of source files that would go into a compilation unit, but rather the set of files read to determine *how* to assembly the context.

This collection may be used to know when to refresh this context (e.g. when the user changes the project file or project.lock.json).

Gets the name for this context (if any) that may be displayed to the user to pick among several available contexts.

Typically a full configuration name (e.g. "Debug|Any CPU"). But may be . Never null.

Return a file context collection

Array of file contexts Read only collection of File contexts

Get the context assuming a type expected

Type expected The context casted as the type

If the contained Context is of a certain type

The type we want to check true if the context type is a subclass of the type

Implement IFileContextActionBase using a function callback

Initializes a new instance of the class.

Callback function to invoke when executing the action

FileContextActionCallback class

Initializes a new instance of the class.

The source context Callback to invoke The display name of this action

FileContextActionDelegate class

Initializes a new instance of the class.

The delegate IFileContextAction Display name

The inner action of this delegate.

Options for IFileContextProvider

None

Default implementation for a IFileContextActionResult interface

Initializes a new instance of the class.

If success or not this result instance

Options for IFileContextProvider

None

Class FileSystemContextChanged. Use the workspace file system watcher notification to propagate a FileContext notification

Initializes a new instance of the class.

Workspace instance The file system event filter to apply

Initializes a new instance of the class.

Workspace instance Input files to track Change types to track

Helper utility for FileSystemEventArgs class

Check if related to a directory changed event

The File System Event true is a directory changed event

A trivial implementation of .

The key of the group. The element type of the group.

The elements in the group.

Initializes a new instance of the class.

The key for this group. The elements in this group.

Service to allow posting actions into the workspace

The service dispose token

Post an action block into the workspace

Callback to execute in our service Completion task when the action is posted

Interface to access a service using async pattern

Get the service

Type of service desired Completion task when the service is available

Provider workspace async factory

Type of provider to create

Create an instance of provider using async pattern

The workspace context Created instance of a provider type

Create a workspace service using async pattern

Create an instance of a service in the context of a IWorkspace

The workspace context instance The Service instance

Describes an action supported by a .

File Context source of this Action

Gets the name of this action as it should be presented to the user.

Describes an action supported by a .

Executes the action.

A means to report progress as the action executes. A token that may cancel the action. A task whose result describes the result of the action.

Provides an update on the progress of an ongoing operation.

Other interfaces may be implemented by objects that implement this interface in order to provide action specific updates.

Offers arbitrary action execution for files.

An implementing type should export this interface with the .

Gets the actions appropriate for a given file and context.

The file workspace being passed The context to act with. A token that may cancel the request. A task whose result is a list of actions that may be invoked for a given file and context.

Describes an extension's applicability and capabilities.

FileContextActionProvider Options

Describes the result of some .

Other interfaces may be implemented by objects that implement this interface in order to provide data that is specific to a particular kind of action.

Gets a value indicating whether the action was successful.

An interface describing metadata found on exports that consume specific types of file contexts.

Gets a collection of GUIDs that identify the values that this language service can initialize from.

Define a file context hierarchy

Type of file context item

Return parent context

Return list of child contexts

Offers services to discover contexts defined in source files.

An implementing type should export this interface using the . Implementations should register contexts both for source files and outputs that may serve as inputs to other contexts. For example when a project B references project A, someone interested in initializing a language service for B may need to discover the context for A given A's primary output, which serves as an input for B.

Finds contexts for a given file.

The file workspace being passed A token whose cancellation should terminate the search. A task whose result is collection of contexts that the file belongs to. The collection should never be null, but it may be empty. A file may belong to contexts that are not discoverable on-demand with this method.

IFileContextProvider with context type

The type of the workspace context

Get the context

The file path for the context Context for the file Cancellation token Collection of File Contexts

Describes an extension's applicability and capabilities.

FileContextProvider Options

Gets a collection of the values that may be produced for by this provider.

Collection of types supported when custom workspace contexts are passed

Describes an

Optional. List of content types this component wants to handle.

Optional. Gets a set of rules (glob patterns) for files. This will constitute "anonymous" content type, aka set of files only available for the given provider. Files that matches this rules (if present) will be passed to the component regardless of their calculated content type.

Interface IFilesService to allow a provider to customize the behavior when a folder is being opened and the hierarchy of files an directories has to be retrieved

Get files from a sub path

The relative sub path to look for files If recursive is needed Cancellation token Collection of rooted file paths

Get directories from a sub path

The relative sub path to look for directories If recursive is needed Cancellation token Collection of rooted directory paths

Interface IFileWatcherService Sink events to receive file system notification changes using an async pattern

Event File system notification

Batch Event File system notification

Workspace service to find files

Searches the workspace for files matching a pattern.

The query to match filenames on. It may be matched based on substring, or a richer parsing of the files. Receives the full path to each file as it is discovered. A token whose cancellation will cancel the query. A task that completes when all match files have been reported.

Return all the file entities available in a workspace

Task completion with enumerable of relative paths

Interface to extend existing IFindFilesService

Get all external files of a folder

The path to the folder or file for whom we want the external items The string to use to match an external file name A token whose cancellation will cancel the query. A collection of the files external to a given path

Searches the workspace and asks all providers during runtime for files matching a pattern.

The query to match filenames on. It may be matched based on substring, or a richer parsing of the files. Receives the full path to each file as it is discovered. A token whose cancellation will cancel the query. A task that completes when all match files have been reported.

Host-specific information use for workspace construction and operation.

Gets the path to the root directory for the host application local data.

An absolute path.

Additional host-specific information provided by an implementer of .

Gets the location a workspace should store any cache files. The location must have read-write access.

A full path

Exports an to the MEF catalog with metadata as described by .

Initializes a new instance of the class.

FileScanner options Version for this provider The unique type for this IFileScannerMetadata A simple name that describes the kind of files this scanner is suitable for. The set of file names or extensions (including the leading period) that this scanner is capable of parsing. List of types supported by this file scanner File scanner priority

Initializes a new instance of the class.

FileScanner options The unique type for this IFileScannerMetadata A simple name that describes the kind of files this scanner is suitable for. The set of file names or extensions (including the leading period) that this scanner is capable of parsing. List of types supported by this file scanner File scanner priority

Initializes a new instance of the class.

The unique type for this IFileScannerMetadata A simple name that describes the kind of files this scanner is suitable for. The set of file names or extensions (including the leading period) that this scanner is capable of parsing. List of types supported by this file scanner File scanner priority

Initializes a new instance of the class.

The unique type for this IFileScannerMetadata A simple name that describes the kind of files this scanner is suitable for. The set of file names or extensions (including the leading period) that this scanner is capable of parsing. List of types supported by this file scanner

Initializes a new instance of the class.

The unique type for this IFileScannerMetadata A simple name that describes the kind of files this scanner is suitable for. The file name or extension (including the leading period) that this scanner is capable of parsing. The supported type to be scanned

Gets a simple name that describes the kind of files this scanner is suitable for.

A short string, such as "C++" or "C#".

Class FileDataResult Provide data from a previously indexed data of a file scanner provider

Type of the data being retrieved

Initializes a new instance of the class.

Name of the result Value of result Optional target Optional context

Name of the Value

Value data

Optional Target

Optional Context

FileDataValue class to return from IFileScanner interface

Initializes a new instance of the class.

The type of this data value Name of the entry Value entry(can be null) The target of this value (or null) The context of this value (or null)

Type of this scanned entry

Name of the scanned entry

Value of the scanned entry

The Target of this Value (or null if there is none)

The Context of this Value (or null if there is none)

File Entity changed

Entity content has changed

Entity was deleted

Entity is created

Entity was renamed

A folder and all its child entities were refreshed

FileEntityChanged EventArgs

Initializes a new instance of the class.

The entity path Change type If entity is a file

Entity Path

If the entity is a file

Changed type

Describes the definition of a file reference

Initializes a new instance of the class.

The file relative path The target of this reference (or null) The context of this reference (or null) Type of this reference (or null) If file system entity can be used

The workspace relative reference file path

The Target of this Reference (or null if there is none)

The Context of this Reference (or null if there is none)

If File system entity can be used to track the workspace reference

The reference type

Default enumeration types for FileScannerInfo

None

A source file

An output file

A Project Reference file

A tracked dependency

A Project Dependency file

An external item

Class FileReferenceResult

Initializes a new instance of the class.

Workspace relative path Target of reference Context of reference Type of reference

Path to reference file

Target of reference

Context of reference

Type of Reference (Input, Output, etc..)

Provide information on the file scanner cache of an entity

Initializes a new instance of the class.

The type of the file scanner When this was tracked The provider ID that create the scan data The provider version who create the data

Retrieve scanner type

Retrieve Timestamp of the cache

The Provider type

The Provider version

EventArg for File scanning phase

Initializes a new instance of the class.

Relative workspace file/directory path Scanning content

Relative workspace file path. An empty value mean is the root folder itself

The file scanned content

Query a content value

Type of expected content Result of the data value or null if not found True if type content is found

Options for IFileContextProvider

None

If evaluate dependencies is desired for up to date check

Class FileScannerTypes

Unknown scanner type

File Reference scanner type

File Data scanner type

Symbol scanner type

Content type

Class FileScannerTypes

File Index Info Type

File Data Values Info Type

Symbols definition type

Scanner content definition type

Represents the data for events using a particular .

Initializes a new instance of the class.

The type of file scanner related to an event

Gets the type of file scanner related to an event.

Represent a failure caused when a file scanner job throws an error

Initializes a new instance of the class.

Initializes a new instance of the class.

Exception message Inner exception being propagated

Initializes a new instance of the class.

Exception message

Initializes a new instance of the class.

Serialization Info Streaming context

IDeferredQuery interface

Type of the item

Offers services to discover symbols defined in source files.

An implementing type should export this interface with the . Each instance of this interface should be prepared to deal with just one file type. If a single scanner advertises multiple , it should be prepared to identify which file type it is (if necessary) based solely on the content of the file and not the file name. If the file extension is an important distinguishing factor, use multiple instances of this interface, each advertising support for the various file extensions.

Scan a source file for symbol definitions.

the expected type to be scanned The workspace file to scan A token that can cancel the scan. A task whose result is the collection of discovered symbols.

Describes an extension's applicability and capabilities.

FileScanner options

Gets a simple name that describes the kind of files this scanner is suitable for.

A short string, such as "C++" or "C#".

An interface that may be exported to provide a collection of symbol scanners at runtime.

Gets a collection of symbol scanners.

A cancellation token. A collection of symbol scanners with metadata.

Provides a method that helps to determine if a file is up to date.

Check if a file is up to date before scanning it.

Indexed timestamp The file path The scanner type A token that can cancel the check. True is the file is up to date

Interface to access the indexing data trough a snapshot

Return cached File Reference info

File entity path Target for the reference (or null) Context for the reference (or null) Cancellation token Completion task with results

Return cached File Dependents info

File entity path Target for the reference (or null) Context for the reference (or null) Cancellation token Completion task with results

Return cached File Data value info

Type of data expected File entity path The type storage being used Target for the reference (or null) Context for the reference (or null) Cancellation token Completion task with results

Provider a cache layer on top of the index workspace service

Create an index workspace data to start working

And instance of a IIndexWorkspaceData

IIndexWorkspaceService interface definition

Index Workspace state

To receive notifications when properties are changed

File Entity changed notification

File Scanner notification

File Scanner cache invalidation

Verify if a path is being part of this indexing

The file entity exist True if the indexing has this entity

Refreshes the contents of any caches or subscriptions with the actual contents from disk.

Type of elements being refreshed Use true to continuously watch the file system and provide updates until is canceled. Use false to refresh just once. A progress reference callback A token to cancel the refresh operation. Must not be if is true. Optional pause token A task representing the long-running operation.

Refresh an element

Enumerable of entities to refresh Type of elements being refreshed Cancellation token A task representing the long-running operation.

Get the File scanner state type

Reference to element path Type of file scanner DateTimeOffset when the file scanner data or null

Return dependent files on a file contained in our workspace

File entity path Target for the reference (or null) Context for the reference (or null) reference types list of dependent files

Return file references to a file contained in our workspace

File entity path Refresh option Cancellation token Target for the reference (or null) Context for the reference (or null) reference types list of references

Return a enumerable of data from a File system entity

Type of Value being expected File entity path The type of data being retrieved Refresh option Cancellation token Target for the reference (or null) Context for the reference (or null) Collection of data

Return a dictionary of data for multiple files

Type of Value being expected The type of data being retrieved Cancellation token Target for the reference (or null) Context for the reference (or null) Dictionary with file and data

Get setting value

Type of setting being expected The setting name Completion task with the value

Set a setting value

The setting name Value to be set Completion task

Invalidate all the file scanner cache

Completion task with number of rows affected

Purge all data produced by a provider

The provider types Completion Task

Purge data for file entity

The indexed file path Optional provider type Task completion

Get All files that are indexed

A deferred query

Get Files from our entities with a pattern matching

Pattern to look for Cancellation token List of files that match the criteria

Extension interface for for

Find files in our File References using pattern match

The pattern to use to match a file reference path Cancellation token Optional target filter Optional Context filter Optional Reference types Completion task with a Dictionary results

Push data into our indexing service

File path of entity we want to push The provider unique id responsable of this data Data to push Cancellation token Completion task

Return File scanner cache for an file entity

The file path Cancellation token Completion task with result

Return multiple file scanner cache

Enumerable of file paths Cancellation token Completion task with Dictionary of data

Return FileReferences for a set of file entities

Enumerable of file paths Cancellation token Return Completion task with Dictionary of data

Check if entity has a file scanner type up to date

The file path> Info about the file scanner Cancellation token Completion task

Extension interface for

This event will be fired when scanning of certain file scanner type is considered complete including the case there's no supported scanner of that type.

Helper class for interface IIndexWorkspaceService

Retrieve data value as Dictionary data

Type of value to expect The index service File path Guid type of value Refresh option Cancellation token Optional target Optional context Dictionary with name/value

Retrieve data values as Dictionary using the context as the key

Type of value to expect The index service File path Guid type of value Refresh option Cancellation token Optional target Dictionary with name/value

Refresh an element

The index service Reference to element path Type of elements being refreshed Cancellation token A task representing the long-running operation.

Refresh options for indexing

No index element.

The cache of the file listings in the workspace.

File reference scanning

File data values scanning

Symbol scanning

File content scanning

If evaluate dependencies is need

If invalidate cache for the elements

The cache of all symbol definitions in the workspace.

All elements of the cache.

Data available for indexed entity

Initializes a new instance of the class.

Symbols indexed Data values indexed File references indexed

Symbols indexed

Data values indexed

File references being indexed

IndexProgress class

Initializes a new instance of the class.

The progress state Percent completed Current elements progress

Current elements

Current state of the indexing progress

Gets the symbol name and location.

Index progress state

Initialize state

File indexing

File scanning

Completed state

Represents the result of the index process

Initializes a new instance of the class.

The total duration of the index process. The duration of the work on the database. The file content scan start time since index starts The file content scan end time since index starts The file reference scan start time since index starts The file reference scan end time since index starts The file data scan start time since index starts The file data scan end time since index starts The symbol scan start time since index starts The symbol scan end time since index starts The number of time that an overall indexing process has been started. The corresponding to the file index step. The dictionary of that represents the information about the steps of the indexer.

Gets the total duration of the indexing process.

Gets the duration of the work on the database.

Gets the file content scanning start time since index starts

Gets the file content scanning end time since index starts

Gets the file reference scan start time since index starts

Gets the file reference scan end time since index starts

Gets the file data scan start time since index starts

Gets the file data scan end time since index starts

Gets the symbol scan start time since index starts

Gets the symbol scan end time since index starts

Gets the number of time that an overall indexing process has been started.

Gets the corresponding to the file index step.

Gets a dictionary of that represents the information about the steps of the indexer.

Represents the information about a step in the indexer.

Initializes a new instance of the class.

The duration of the step. The total number of entities produced by an indexing step. The number of files to scan. The number of files that has been scanned.

Initializes a new instance of the class.

The duration of the step. The total number of entities produced by an indexing step. The number of files to scan. The number of files that has been scanned. The list of scanner details. The list of extension details

Gets the duration of the step.

Gets the total number of entities produced by an indexing step.

Gets the number of files that has been scanned.

Gets the number of files to scan.

Gets the list of scanner details

Gets the list of extension details

Represents detail about a file extension that symbol scanners work on.

Initializes a new instance of the class.

The number of symbols that symbol scanners found for this extension. The total duration of symbol scanners have spent on this extension. The number of files with this extension that has been scanned.

Gets number of symbols that symbol scanners found for this extension.

Gets the total duration in milliseconds that symbol scanners have spent on this extension.

Gets number of files with this extension that has been scanned.

Represents details about a symbol scanner.

Initializes a new instance of the class.

The total duration of the scanner for all the scanned files. It excludes persisting scanner data. The number of files that has been scanned for this scanner.

Gets the total duration of the scanner for all the scanned files. It excludes persisting scanner data.

Gets the number of files that has been scanned for this scanner.

IndexWorkspace properties

State property

Our Index Workspace state

None

FileSystem is in progress

File scanning phase

Indexing is completed

The indexing was canceled before completion

The indexing finished with a failure

An interface to access the data content in the storage

Get Entity from path

Entity id Relative path parts

Get the entity id in our database

The relative path to lookup The entity id or -1 if not found in our storage

Execute a SQL statement

The SQL statement to execute List of substitution parameters Number of rows affected by this statement

Query a Data structure statement from our storage

Type for mapping our expected result The Data structure statement List of substitution parameters List with results

Query a SQL statement from our storage. Iterate on the IEnumerable will start feeding data

Type for mapping our expected result The SQL statement List of substitution parameters IEnumerable with results

A SQL connection service to be used on the indexing data

Query our database

Type of data being returned for each row The query callback Completion task with results

Return a deferred query on our storage

Type of data being returned for each row First query callback An instance of a IDeferredQuery instance

Return a deferred query on our storage

Type of data being returned for each row Type of data being returned by the first query First query callback Adapter callback to return the result type An instance of a IDeferredQuery instance

Execute a statement on our database

The execute callback Completion task with affected rows

A symbol type service

Searches for symbol definitions that match a given query.

A leading substring of the symbol to find. Receives A token that may cancel the search. Optional current document path. A task whose completion indicates the search is complete.

Renamed version of

Initializes a new instance of the class.

Original path of the entity New path of the entity Change type If entity is a file

Old path for the entity

Describes the visibility of the symbol to surrounding code.

None

The symbol has public visibility.

The symbol has internal visibility.

The symbol has friend visibility.

The symbol has protected visibility.

The symbol has private visibility.

Describes the definition of a symbol, within the context of a source file.

This interface does not specify the path to the source file because some of its producers (e.g. may not know the path to the source file. Also, some source files may not even exist locally, so setting the context of which file the symbol appears in is the responsibility of other code that hands this interface around.

Initializes a new instance of the class.

The name of the symbol. The kind of symbol. The visibility of the symbol to surrounding code. The location of the definition.

Initializes a new instance of the class.

The name of the symbol. The fully-qualified name of the symbol. The kind of symbol. The visibility of the symbol to surrounding code. The location of the definition.

Gets the short name of the symbol.

Gets the fully-qualified name of the symbol.

Gets the position of the symbol's definition within the source file.

Gets the kind of symbol.

Gets the accessibility of the symbol.

Describes a symbol's definition with metadata describing where it is found.

Initializes a new instance of the class.

The symbol definition. The path to the file that defines the symbol.

Gets the symbol name and location.

Gets the absolute path to the file containing the symbol.

Describes the various types of symbols.

None

A class.

A constant.

A delegate.

An enumerator.

A member of an enumerator.

An event.

A field.

An interface.

A method.

A module.

A property.

A structure.

A namespace

Symbol scanner base class

perform a symbol scanning on a file content

the content of source file a cancellation token Symbols found during scanning

Describes a location in a text file.

Initializes a new instance of the struct.

The line number in the text file. Starts at 1. The column number in the text file. Starts at 1.

Gets the line number within the text file. The first line of a file is considered Line 1.

Gets the column within the text file. The first column on a line is considered column 1.

Determines whether two are equal.

First Second true if the two are equal; otherwise, false.

Determines whether two are not equal.

First Second true if the two are not equal; otherwise, false.

Interface to provide an action when a file context has been modified

When the File Context has changed

Exports an to the MEF catalog with metadata as described by .

Initializes a new instance of the class.

The unique type for this ILanguageServiceProviderMetadata The provider priority A collection of GUIDs that identify the values that this language service can initialize from.

Gets a collection of GUIDs that identify the values that this language service can initialize from.

Offers language service activation for open files.

An implementing type should export this interface with the .

Initializes the language service for the specified file, or updates it with a new set of contexts.

The absolute path of the file to initialize the language service for. The contexts available for this file. A token that may cancel initialization of the language service. A task that tracks the asynchronous operation.

Removes the language service integration for the specified file.

The absolute path of the file to initialize the language service for. A task that tracks the asynchronous operation.

Describes an extension's applicability and capabilities.

IPropertySettings interface

Provider Metadata Base

Version tracking

The Unique Type for this Provider

Provider priority

The Options defined for this metadata as flags attribute

Supported types metadata

Gets the set of supported types by this metadata

file matcher. Applies as set of [glob] rules against the file name;

Match an item against the rules

fullPath of the item item is a folder true, item is filtered out

Workspace (settings based) Item Filter;

the filter key (used to create this filter by IWorkspaceItemFilterService).

Fires when filter settings (may have) changed

Check a single item against the filter

full path to the item (file or folder) we want to check true to consider path a folder, false a file true if items is "filtered out" by current filter settings

Check a single item against the filter. The item must exist on disk.

full path to the item (file or folder) we want to check true if items is "filtered out" by current filter settings

Check a single item against the filter. This will also check if any parent folder is filtered out.

full path to the item (file or folder) we want to check true to consider path a folder, false a file true if items is "filtered out" by current filter settings

Check a single item against the filter. The item must exist on disk. This will also check if any parent folder is filtered out.

full path to the item (file or folder) we want to check true if items is "filtered out" by current filter settings

Workspace Item Filter service.

Gets the Item Filter object for the given filterKey.

the item filter key.The "filterKey" is used as a name of the string array property in the Generic Workspace settings that contains individual filter patterns. item filter object

Create file matcher from list or glob rules.

list of rules implied root for the rules, if null that will be workspace root the implementing object

Filters change event data.

Initializes a new instance of the class.

affected cone

Full path. the ScopePath is the "root" of a subtree that is being (potentially) affected by the changes. All items outside the ScopePath cone are not affected by the changes.

IWorkspace interface definition

Gets the path to the root directory of the source tree.

An absolute path.

Instance of JoinableTaskFactory associated with JTFCollection. Use IWorkspace.JTF to start async work (instead of Task.Run).

Gets the absolute path for a given path, which may be relative to Workspace.Location.

The path that is absolute, or relative to the workspace root folder. May be empty. An absolute path.

Converts an absolute path to a path relative to the root of this workspace.

The path to make relative. A relative path.

Gets the file contexts associated with the specified workspace location.

The path to the file or folder for which a context is required. May be absolute or relative to workspace root . The collection of file context types of interest of the caller. A cancellation token. The collection of applicable file context providers.

Get file contexts for a workspace context

The path to the file or folder for which a context is required. May be absolute or relative to workspace root . Type of the workspace context being passed Instance of the workspace context The collection of file context types of interest to the caller. A cancellation token. The collection of applicable file context providers.

Return matched ILanguageServiceProvider's for a file context path

Absolute path of the file which will provide the context Cancellation token Collection with matched services with it's file contexts

Gets the actions available at the specified path.

The path to the file or folder for which a context is required. May be absolute or relative to workspace root . Optional list of file context types A cancellation token. A task whose result is a collection of actions that can be taken on the specified . The collection should never be null, but it may be empty.

Gets the actions available on a workspace context

Type of the workspace context The path to the file or folder for which a context is required. May be absolute or relative to workspace root . The instance of the workspace context Optional list of file context types A cancellation token. Actions available

Gets actions that apply to a set of file contexts

File path of the target List of file contexts A cancellation token. List of actions to apply to the file contexts

Gets a set of files within the workspace.

The folder within the workspace that should be searched for files. May be absolute, or relative to the . An empty path is interpreted as the workspace root. true to return files in and its sub-folders; false to return only files found in the immediate folder. A token that cancels the query. A task whose result is the set of files found.

Gets a set of directories within the workspace.

The folder within the workspace that should be searched for directories. May be absolute, or relative to the . An empty path is interpreted as the workspace root. true to return files in and its sub-folders; false to return only files found in the immediate folder. A token that cancels the query. A task whose result is the set of files found.

Interface to extend .

The workspace dispose token

Provider workspace factory

Type of provider to create

Create an instance of provider

The workspace context Created instance of a provider type

Workspace service factory

Create an instance of a service in the context of a IWorkspace

The workspace context instance The Service instance

IWorkspaceServiceFactoryMetadata interface

Workspace service factory options

Logger listener delegate

Log Record generated

Workspace Logger class

CurrentLevel Singleton property

List of loggers available

Name property

Level property

Return the Logging level from a Diagnostic level

Teh diagnostic level to be converted The closer Logging level

Create a logger instance using a name

name of the logger a Logger class instance

Add a logger listener delegate

listener delegate instance

Remove a logger listener delegate

listener delegate instance

Log a message.

level desired for this message Message being logged Message arguments being passed

Log a message.

If the message is PII compliant level desired for this message Message being logged Message arguments being passed

Return true if a logging level is enabled

level desired to evaluate true if the level is enabled

Log a Error level message.

Message being logged Message arguments being passed

Log a Warning level message.

Message being logged Message arguments being passed

Log a Debug level message.

Message being logged Message arguments being passed

Log a Info level message.

Message being logged Message arguments being passed

Initializes a new instance of the class.

Logging level property

Add a logger listener delegate

listener delegate instance

Remove a logger listener delegate

listener delegate instance

Log internal

the Logger instance level desired Message being logged If message is PII compliant

Logging level enumeration

Logging is off

Fatal level

Error level

Warning level

Info level

Debug level

Trace level

LogRecord class

Initializes a new instance of the class.

Logger instance desired level Message being logged true if the message is PII compliant

Logger instance who generated this Record

Logging level of the Record

When logging happened

Managed thread id of Record

Message being logged

PII compliant

Class NotifyFileContextChanged

Initializes a new instance of the class.

Callback action when subscriptions changed

If we are sink to the source

A pause token

Initializes a new instance of the struct.

token source

IsPaused property

Wait if the token source is paused

Completion task

A source token to allow pausing a task

Completed task helper

IsPaused property

The Token property

An optional cancellation token to be use on our pause task

Pause request

Resume request

Wait if we are paused

Completion task

Class ProjectConfiguration

Initializes a new instance of the class.

The project file path Optional target Launch settings

Launch settings

Gets the id to uniquely identify a debug target configuration

Change type enumeration

AllProjectFileConfigurations property changed

Current Active Project

Current Debug Context Action

Current Build Context Action

Project target file context

Initializes a new instance of the class.

Project File path Target in the project file

Initializes a new instance of the class.

Project File

Relative workspace path

Target of the project file

PropertyChangedEventArgs class

Properties type

Initializes a new instance of the class.

Array of properties that changed

The property that changed

Return true if this event contains a change for a property

The property id true if the property is part of this event

If any properties is contained in the changes

Array of properties to check True if any of the property is found

Default IPropertySettings implementation

Empty settings

Initializes a new instance of the class.

Array of KeyValuePair to initialize

Initializes a new instance of the class.

Helper class for the type IPropertySettings

Create a KeyValuePair class

String key Object value A Key value pair

Deep copy of a configuration instance

The input settings instance Factory creator for IPropertySettings Copy of the configuration instance

Get Value of type (T)

Desired type expected The input settings instance Key to look for in the configuration The value contained in the settings

Retrieve a value using a path

Desired type expected The input settings instance Path of keys The value contained in the settings

TryGetValue pattern extension

Desired type expected The setting instance Key to look for in the configuration The value in the setting entry true if key was found

Get Value of type (T)

Desired type expected The setting instance Key to look for in the configuration Default value to provide if no value is found The value contained in the configuration or the default value being passed

GetValues using Reflection API

The setting instance Target object to set values List of property infos to populate An optional property name converter

GetValues using Reflection API

The setting instance Target object to set values Binding flags of target An optional property name converter

SetValues using Reflection API

The setting instance Source object to get values List of property infos to populate An optional property name converter

SetValues using Reflection API

The setting instance Source object to get values Binding flags of target An optional property name converter

Return an array of PropertyInfo from a type

The type class List of property names Array of PropertyInfo types

Priority enumeration for Providers

Lowest priority

BelowNormal priority

Normal priority

AboveNormal priority

Highest priority

Result Event arguments class

Type of result being fired

Initializes a new instance of the class.

The result instance

The result instance

Result of retrieving a single setting value from the current settings files.

the value was successfully read from a settings file. This result means there is a such an element set in settings file.

The value is not present in the settings file. A default value is returned instead.

The value is present in the settings file, but it is corrupted (for example wrong type). A default value is returned instead.

Workspace Settings interface.

Get the absolute path for the property scope where definition originate.

Parent (lower priority) Settings wrapper.

get a [base] settings value (property), the type and meaning of the value is defined by the caller. This override also specifies the particular settings source that provided the value. Used in cases where implied root is needed, or when doing "unification" for arrays.

type of the value the name of the property the current value as persisted in the settings the workspace settings source that is providing the value. optional default value to use if the current value is not present or corrupted see WorkspaceSettingsResult

Dynamic settings providers These providers contribute properties to the hierarchical settings collection that comes from a different sources than on disk json files. Example can be "intrinsic in memory providers" or "converters" (components that parse other tools formats into a Workspace settings schema).

Provide zero or more workspace schema settings collections to be merged with the rest of the Workpace's sources.

settings type (corresponding to the independent settings file name) Use SettingsTypes class constants location under workspace we require the settings for. settings readers

Per workspace object that is responsible for facilitating the reading and writing the workspace settings as well as corresponding notifications. Retrieved by "Workspace.SettingsManager".

Event fire when a setting source (a file or in memory provider) changes. Listeners would need to reacquire (via GetAggregatedSettingsAsync) a new settings collection if they need to reflect the settings changes. The SettingsChangedEventArgs parameter can be used to narrow down the changes to a particular settings type and scopePath.

the settings reader (note that when reading the settings hierarchy is already applied, the consumer should not differentiate between where property is defined on use). The object returned by this property is immutable. when changes happen a new object will be create (and OnWorkspaceSettingsChanged fired). will apply build in inheritance override rules(aka PerUser > PerWorkspace > PerMachine) and return the winning value for a named property, array or child settings

settings type (corresponding to the independent settings file name) Use SettingsTypes class constants location under workspace we require the settings for. Note that because of hierarchical aggregation model different parts of the workspace tree will have different settings values. settings reader

"Parse" a single settings file.

the full path to a settings file the settings object

Access the settings writer. All changes made are in memory until the writer is released. note we will not lock any of the settings files until commit. Also we are not going to lock the writer within the process. the individual actions (like individual property writes) will be protected. We would ensure a machine-wise locking via named event, which will protect against multiple VS instance writing at the same time, yet it would be possible if via other editor (notepad) or when settings file is shared on network, to have a conflicting writes. in this rare case commit may still fail.

if true the caller does not need to call commit at the end (note it is still possible to abort) the persistence instance

transactional writer. Note within the single VS process multiple of this can be active simultaneously. Last release will trigger settings file writes on disk. It is expected that the persistence writer wrappers to be very short lived.

Get a writer for a single file.

settings tuple (corresponding to the independent settings file name) Use SettingsTypes class constants (relative) location under workspace root where to place the file. null = "per user /per workspace" (under our .vs folder) Empty = "workspace root". writer

notify that writing was successful for this scope. Needed if autoCommit was false, otherwise closing the scope will cause entire write transaction to be canceled. Used by features that needs to write multiple related properties when a partial persistence may cause inconsistent results.

Abort setting writing transaction. The settings files will not be updated on disk

Dynamic settings providers These providers contribute properties to the hierarchical settings collection that comes from a different sources than on disk json files. Example can be "intrinsic in memory providers" or "converters" (components that parse other tools formats into a Workspace settings schema).

Event fire when a settings source managed by the particular provider changes. The Settings manager will monitor this events and will propagate them to consumers as required.

Provide a workspace schema settings collection to be merged with the rest of the Workspace's sources. Note provider should only provide a single source that applies only to the "scopePath".

settings type (corresponding to the independent settings file name) Use SettingsTypes class constants location under workspace we require the settings for. settings reader

called when workspace is disposed. The provider should disconnect listeners to other IWorkspace related components here, release resource and such. The potentially cached IWorkspace is available to be used, but some functionality may not work (for example it is likely attempting to use SymbolsService will fail)

async task

Dynamic settings providers These providers contribute properties to the hierarchical settings collection that comes from a different sources than on disk json files. Example can be "intrinsic in memory providers" or "converters" (components that parse other tools formats into our settings schema). The factory interface is

the priority property is used to order the provider settings among other potential providers that can apply for the exact same location.

Create provider object for the given workspace instance

workspace that will query for the settings settings reader

Workspace Settings interface.

Enumerate all available property names.

property names enumerator

get a [base] settings value (property), the type and meaning of the value is defined by the caller.

type of the value the name of the property the current value as persisted in the settings optional default value to use if the current value is not present or corrupted see WorkspaceSettingsResult

Workspace Settings source writer interface. Used for "automated" settings persistence driven by features.

Persist a value in workspace settings.

>type of the value the name of this entry the value to persist

delete a particular setting (regardless of type - can be property, property collection or array )

the property name

Create a new inner scope workspace (to be used later for SetProperty[Array](key, IWorkspaceSettingsSource...);

a compatible IWorkspaceSettingsSource implementation

standard settings types

Launch.json we use that for settings specifically related to F5 experience

task.json for custom file contexts

Generic Workspace settings.

Immutable workspace control properties. These are special control properties that are not changable during lifteme of workspace settings.

providers.json we use to select a provider

State cache settings.

Feature flags settings

Settings change events data.

Initializes a new instance of the class.

settings type settings scope

Settings tuple (aka generic launch)

The relative path to location under workspace folders, that is affected by the particular change. This is related to the Settings scope used to acquire the settings from Settings manager such that any such location under The value presented here should be considered invalidated.

Convenience extension for IWorkspaceSettings interface

Wrapper around WorkspaceSettingsResult GetProperty. Used when caller is not interested by the current state, but just want to get the current value to use.

type of the value the settings instance the name of the property optional default value to use if the current value is not present or corrupted the current value as persisted in the settings or default

Get a string value with implied root

the settings instance the name of the property the string value the implied root true if exist

Get a string value representing potentially relative path as full path, using implied root as a base

the settings instance the name of the property default value the absolute path

Wrapper around WorkspaceSettingsResult GetPropertyArray. Used when caller is not interested by the current state, but just want to get the current value to use.

type of the elements in array the settings instance the name of the property the current value as persisted in the settings or empty array if there is none

This method will return union of all values in hierarchical chain, not just the top array.

type of the elements in array the settings instance the name of the property the current value as persisted in the settings or empty array if there is none

A special provider of inner named settings collection (T=IWorkspaceSettings) Used when caller is not interested by the current state, but just want to get the current value to use.

the settings instance the name of the property the current value as persisted in the settings or empty

A variant of "Scope", used during "Save" it will create and add a collection property with "key" name if it does not already exists. Used when caller is not interested by the current state, but just want to get the current value to use.

the settings instance the name of the property the current value as persisted in the settings or empty

A special accessors for inner named settings collection array (T=IWorkspaceSettings) Used when caller is not interested by the current state, but just want to get the current value to use.

the settings instance the name of the property the current value as persisted in the settings or empty array

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to Collection must not be empty..

Looks up a localized string similar to All members must be initialized..

Looks up a localized string similar to Value must not be the empty string..

IWorkspace extensions

Get the first available action for a workspace context

Type of the workspace context The workspace instance The workspace file path The instance of the workspace context Optional list of file context types A cancellation token. The first available action (or null)

Get the first available context for a workspace context

Type of the workspace context The workspace instance The workspace file path The instance of the workspace context Optional list of file context types A cancellation token. The first available file context

Get the working folder for this workspace

the workspace working folder

Get the working folder for this workspace

the workspace working folder

Get a full path under workspace working folder.

the workspace relative path full path under working folder

Options for workspace service factories.

Default workspace factory options.

Create the factory instance when workspace is being initialized

If the service has async creation pattern

IWorkspace service helpers Contains method to access IWorkspace based services

Get a service type from a workspace

Type of the service to ask for The workspace context Throw exception if service not found The workspace service or null if not found

Get a service type from a workspace using the async pattern

Type of the service to ask for The workspace context Throw exception if service not found The workspace service or null if not found

Get the IFindFilesService service for a workspace

workspace instance The instance of the IFindFilesService

Get the IFileSystemChanged service for a workspace

workspace instance The instance of the IFileSystemChanged

Get the IWorkspaceSettingsManager service for a workspace

workspace instance The instance of the IWorkspaceSettingsManager

Get the shared access control service

workspace instance The instance of the AssetsControl.IAssetsAccessManager

Get the IIndexWorkspaceService for a workspace instance

workspace instance The instance of the IIndexWorkspaceService or null if not found

Get the IIndexWorkspaceDataService for a workspace instance

workspace instance The instance of the IIndexWorkspaceDataService or null if not found

Return the build service from a workspace

workspace instance Instance of an IBuildService or null if not found

Return the IBuildService2 from a workspace

workspace instance Instance of an IBuildService2

Return the IBuildService3 from a workspace

workspace instance Instance of an IBuildService3

Return the build message service from a workspace

workspace instance Instance of an IBuildMessageService or null if not found

Return the IProjectConfigurationManager service

workspace instance Instance of an IProjectConfigurationManager or null if not found

Return the ICustomContextService service

workspace instance Instance of an ICustomContextService or null if not found

Return the IPropertyEvaluatorService service

workspace instance Instance of an IPropertyEvaluatorService or null if not found

A collection of file system path analysis and manipulation functions.

Generates an absolute path from a base path and another path.

An absolute path to use as the root if is relative. IMPORTANT: if basePath is a directory, it must end with a directory separator character or else it will be treated like a filename and discarded. A relative or absolute path, that needs to be absolute. Thrown when the argument is not an absolute path. A normalized, absolute path. A path with relative parents (i.e. c:\temp\tmp\..\a.txt) will never be returned. Not necessarily canonical, in that the file casing of the path is not guaranteed to be consistent.

given the absolute location of a file, and a disc location, returns relative file path to that disk location.

The base path we want to relativize to. Must be absolute. Should not include a filename as the last segment will be interpreted as a directory. The path we need to make relative to basePath. The path can be either absolute path or a relative path in which case it is relative to the base path The relative path (can be the full path when no relationship exists). If and are equivalent, the empty string is returned.

Make sure there is no [unnecessary] trailing directory separator.

directory path directory path without trailing slash

Make sure there is a trailing directory separator.

directory path directory path with trailing slash

Detects whether a given file falls within a given directory.

The absolute, normalized path to the directory. The absolute, normalized path to the file. true if the given file falls within the given directory. The current implementation of this method does NOT normalize the paths before the check.

Tests a path to see if it is absolute or not. More reliable that Path.IsPathRooted.

The path to check. true if the path is rooted; false otherwise.

Check if path is a directory

The path to check true if the path is a directory

Gets the correctly cased path for a given directory.

Full file system path of a file or directory. New file system info with correctly cased path.

Gets the correctly cased path for a given directory.

Directory to find the correct casing for. New directory with correctly cased path.

Verify a valid path

The path to verify True if a valid path

Check if the scope is the root workspace scope

the scope path (can be either relative or absolute) the workspace root path True if it is a root scope

Check if a rooted path is inside the temp folder

rooted path true if path is under temp folder, false otherwise

A few fast checks that determine whether normalization of a path is warranted.

A non-empty path. true if normalization is likely needed; false if normalization doesn't appear to be needed. In the interest of executing very fast (since this method is used in fast-or-slow-path checks) this method by no means is comprehensive, but it should catch the common causes for needing normalization.

Helper function to create Uri object form path.

path string uri object

Fixes common problems with local paths like double-backslash.

The path to fix up. The cleaned up path.