ParseRequest Class

 

Provides information to execute a parsing operation in a language service.

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

System.Object
  Microsoft.VisualStudio.Package.ParseRequest

[CLSCompliantAttribute(false)]
public class ParseRequest

NameDescription
System_CAPS_pubmethodParseRequest(Boolean)

Initializes a new instance of the ParseRequest class in order to terminate the thread used for background parsing operations.

System_CAPS_pubmethodParseRequest(Int32, Int32, TokenInfo, String, String, ParseReason, IVsTextView, AuthoringSink, Boolean)

Initializes a new instance of the ParseRequest class.

NameDescription
System_CAPS_pubpropertyCallback

Specifies the callback delegate to be called when the parsing operation has completed.

System_CAPS_pubpropertyCol

Specifies the character offset on the first line to begin the parsing operation.

System_CAPS_pubpropertyDirtySpan

Specifies a span of source that has changed.

System_CAPS_pubpropertyFileName

Specifies the name of the source file being parsed.

System_CAPS_pubpropertyIsSynchronous

Gets or sets whether or not the request is synchronous.

System_CAPS_pubpropertyLine

Specifies the line on which to start the parsing operation.

System_CAPS_pubpropertyReason

Specifies the reason the parsing operation was started.

System_CAPS_pubpropertyScope

Specifies the AuthoringScope object that is used to return extended information from the parsing operation.

System_CAPS_pubpropertySink

Specifies an AuthoringSink object used to contain information from the parsing operation.

System_CAPS_pubpropertyTerminate

Specifies whether the worker thread handling background parsing operations should exit.

System_CAPS_pubpropertyText

Specifies the source text to be parsed.

System_CAPS_pubpropertyTimestamp

Specifies a time stamp for the parse request.

System_CAPS_pubpropertyTokenInfo

Specifies a TokenInfo structure that is filled in with the results of the parsing operation.

System_CAPS_pubpropertyView

Specifies the IVsTextView object representing the view that contains the source that is being parsed.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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;
         }
    }
}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: