ParseRequest Class
Provides information to execute a parsing operation in a language service.
This API is not CLS-compliant.
Inheritance Hierarchy
Object
Microsoft.VisualStudio.Package.ParseRequest
Namespace: Microsoft.VisualStudio.Package
Assemblies: Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
Syntax
'Declaration
<CLSCompliantAttribute(False)> _
Public Class ParseRequest
[CLSCompliantAttribute(false)]
public class ParseRequest
[CLSCompliantAttribute(false)]
public ref class ParseRequest
[<CLSCompliantAttribute(false)>]
type ParseRequest = class end
public class ParseRequest
The ParseRequest type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
ParseRequest(Boolean) | Initializes a new instance of the ParseRequest class in order to terminate the thread used for background parsing operations. |
|
ParseRequest(Int32, Int32, TokenInfo, String, String, ParseReason, IVsTextView, AuthoringSink, Boolean) | Initializes a new instance of the ParseRequest class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Callback | Specifies the callback delegate to be called when the parsing operation has completed. |
|
Col | Specifies the character offset on the first line to begin the parsing operation. |
|
DirtySpan | Specifies a span of source that has changed. |
|
FileName | Specifies the name of the source file being parsed. |
|
IsSynchronous | Gets or sets whether or not the request is synchronous. |
|
Line | Specifies the line on which to start the parsing operation. |
|
Reason | Specifies the reason the parsing operation was started. |
|
Scope | Specifies the AuthoringScope object that is used to return extended information from the parsing operation. |
|
Sink | Specifies an AuthoringSink object used to contain information from the parsing operation. |
|
Terminate | Specifies whether the worker thread handling background parsing operations should exit. |
|
Text | Specifies the source text to be parsed. |
|
Timestamp | Specifies a time stamp for the parse request. |
|
TokenInfo | Specifies a TokenInfo structure that is filled in with the results of the parsing operation. |
|
View | Specifies the IVsTextView object representing the view that contains the source that is being parsed. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
This class is used to communicate information to a parser about a particular parsing operation and to return information about the parsing operation. The source used by the parser is accessed as a single block of text through the Text property. This text is passed to the ParseRequest constructor.
Notes to Implementers
Everything a typical parsing operation needs can be found in this class so there should be no reason to derive from this class. However, if you do need to derive a class from the ParseRequest class, you must derive a class from the LanguageService class and override the CreateParseRequest method to instantiate your own version of the ParseRequest class.
Note that if your language service is going to support parsing variables for display in the Autos debugging window and/or support validation of breakpoints, you must derive a class from the AuthoringSink class and set the Sink property in an instance of the ParseRequest class to your version of the AuthoringSink class. This can be done in the CreateParseRequest method after the ParseRequest object is created.
Notes to Callers
This class is instantiated by a call to the CreateParseRequest method in the LanguageService class.
Do not attempt to use the View property in a background thread: the IVsTextView object is meant only for foreground use by the base Source class.
Examples
This example shows how to create a new ParseRequest object with a custom AuthoringSink object (the class for which is not shown).
using Microsoft.VisualStudio.Package;
using Microsoft.VisualStudio.TextManager.Interop;
namespace MyLanguagePackage
{
class MyLanguageService : LanguageService
{
public ParseRequest CreateParseRequest(Source s,
int line,
int idx,
TokenInfo info,
string sourceText,
string fname,
ParseReason reason,
IVsTextView view)
{
ParseRequest req = new ParseRequest(line,
idx,
info,
sourceText,
fname,
reason,
view);
if (req != null)
{
req.Sink = new MyAuthoringSink(reason, line, idx);
}
return req;
}
}
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.