ParseRequest Class
Represents a request for a parsing operation.
public class ParseRequest : IParseRequest
- Inheritance:
- object object
- Implements:
- IParseRequest
Constructors
ParseRequest(string, ITextBufferReader, ISyntaxLanguage, IParseTarget)
Initializes a new instance of the ParseRequest
class.
public ParseRequest(string sourceKey, ITextBufferReader textBufferReader, ISyntaxLanguage language, IParseTarget parseTarget)
Parameter | Type | Description |
---|---|---|
sourceKey | string | A text key, typically a filename, that uniquely identifies the text to parse. |
textBufferReader | ITextBufferReader | The ITextBufferReader that contains the text to parse. |
language | ISyntaxLanguage | The ISyntaxLanguage for which this parse request was created. |
parseTarget | IParseTarget | An IParseTarget indicating the object that will receive the results of the parse. |
ParseRequest(string, ITextBufferReader, IParser, IParseTarget)
Initializes a new instance of the ParseRequest
class.
public ParseRequest(string sourceKey, ITextBufferReader textBufferReader, IParser parser, IParseTarget parseTarget)
Parameter | Type | Description |
---|---|---|
sourceKey | string | A text key, typically a filename, that uniquely identifies the text to parse. |
textBufferReader | ITextBufferReader | The ITextBufferReader that contains the text to parse. |
parser | IParser | The IParser that will perform the parsing operation. |
parseTarget | IParseTarget | An IParseTarget indicating the object that will receive the results of the parse. |
Properties
CreatedDateTime
Gets the DateTime at which the parse request was created.
public DateTime CreatedDateTime { get; }
Property Value
Language
Gets the ISyntaxLanguage for which this parse request was created.
public ISyntaxLanguage Language { get; }
Property Value
- ISyntaxLanguage:
The ISyntaxLanguage for which this parse request was created.
ParseHashKey
Gets a hash key that uniquely identifies the parse request for a source/target combination.
public string ParseHashKey { get; }
Property Value
- string:
A hash key that uniquely identifies the parse request for a source/target combination.
Parser
Gets the IParser that will perform the parsing operation.
public IParser Parser { get; }
Property Value
Priority
Gets or sets an integer value describing the priority of the request, where a higher number has a higher priority.
public int Priority { get; set; }
Property Value
- int:
An integer value describing the priority of the request, where a higher number has a higher priority. The default value is
ParseRequest.MediumPriority
.
RepeatedRequestPause
Gets or sets the number of milliseconds to pause if there are repeated attempts for this same request.
public int RepeatedRequestPause { get; set; }
Property Value
- int:
The number of milliseconds to pause if there are repeated attempts for this same request. The default value is
250
.
Snapshot
Gets or sets the ITextSnapshot, if available, for which the parse request was created.
public ITextSnapshot Snapshot { get; set; }
Property Value
- ITextSnapshot:
The ITextSnapshot, if available, for which the parse request was created.
SourceKey
Gets a text key, typically a filename, that uniquely identifies the text to parse.
public string SourceKey { get; }
Property Value
- string:
A text key, typically a filename, that uniquely identifies the text to parse.
State
Gets or sets the current state of the request.
public ParseRequestState State { get; set; }
Property Value
- ParseRequestState:
The current state of the request.
Remarks
This property should only be set by a IParseRequestDispatcher.
Tag
Gets or sets the object that contains user-defined data about the object.
public object Tag { get; set; }
Property Value
Remarks
Any type derived from the object class can be assigned to this property.
Target
Gets the IParseTarget that will be notified once the parsing operation is complete.
public IParseTarget Target { get; }
Property Value
- IParseTarget:
The IParseTarget that will be notified once the parsing operation is complete.
TextBufferReader
Gets the ITextBufferReader used to read the text that should be parsed.
public ITextBufferReader TextBufferReader { get; }
Property Value
- ITextBufferReader:
The ITextBufferReader used to read the text that should be parsed.
Methods
GetParseHashKey(ICodeDocument)
Returns the ParseHashKey to use for the specified ICodeDocument.
public static string GetParseHashKey(ICodeDocument document)
Parameter | Type | Description |
---|---|---|
document | ICodeDocument | The ICodeDocument to examine. |
Returns
- string:
The ParseHashKey to use for the specified ICodeDocument.
Fields
HighPriority
Specifies a high priority.
public const int HighPriority = 300
LowPriority
Specifies a low priority.
public const int LowPriority = 100
MediumPriority
Specifies a medium priority.
public const int MediumPriority = 200