LineNumberTracker Class

Native content processor implementation that tracks line and offset number for content passed through the native API.

Inheritance Hierarchy

SystemObject
  Sdl.FileTypeSupport.Framework.NativeApiAbstractNativeFileTypeComponent
    Sdl.FileTypeSupport.Framework.NativeApiAbstractNativeExtractionGenerationContentProcessor
      Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApiLineNumberTracker

Namespace: Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core.Utilities (in Sdl.FileTypeSupport.Framework.Core.Utilities.dll) Version: 1.0.0.0 (1.0.2551.0)

Syntax

C++

Copy

public class LineNumberTracker : AbstractNativeExtractionGenerationContentProcessor, 
	INativeLocationTracker

Public Class LineNumberTracker
	Inherits AbstractNativeExtractionGenerationContentProcessor
	Implements INativeLocationTracker

public ref class LineNumberTracker : public AbstractNativeExtractionGenerationContentProcessor, 
	INativeLocationTracker

type LineNumberTracker =  
    class
        inherit AbstractNativeExtractionGenerationContentProcessor
        interface INativeLocationTracker
    end

The LineNumberTracker type exposes the following members.

Constructors

	Name	Description
	LineNumberTracker	Initializes a new instance of the LineNumberTracker class

Top

Properties

	Name	Description
	ExtractionOutput	Strongly typed output content handler that can be used when the buffer is used for extraction. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	GenerationOutput	Strongly typed output content handler that can be used when the buffer is used for generation. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	LastCharacterWasCR	If true, the last processed character was a CR (0x0d). This flag is used to determine whether an LF character (0x0a) should increment the line count or not, since CR + LF is counted as a single line break character.
	Line	1-based value that expresses the number of characters that have passed through the tag and text content of this processor since the last line break.
	LineBeforeIncrement	Accessor to the field holding the value that is set to the current line number before it is incremented in the IncrementLineAndOffsetNumbers(String) implementation. Implementations that override that method without calling the base class may need to set this property. The value is used in the implementation of GetLocationBeforeCurrentContent.
	MessageReporter	The message reporter to be used for reporting non-critical issues. (Inherited from AbstractNativeFileTypeComponent.)
	Offset	1-based index that expresses the number of line break characters that have passed through the tag and text content of this processor.
	OffsetBeforeIncrement	Accessor to the field holding the value that is set to the current offset number before it is incremented in the IncrementLineAndOffsetNumbers(String) implementation. Implementations that override that method without calling the base class may need to set this property. The value is used in the implementation of GetLocationBeforeCurrentContent.
	Output	Agnostic access to the output handler; accesses the very same object instance as the ExtractionOutput and the GenerationOutput properties. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	PropertiesFactory	The factory used to create native properties objects (Inherited from AbstractNativeFileTypeComponent.)

Top

Methods

	Name	Description
	ChangeContext	Calls ChangeContext(IContextProperties) on the Output (if set). (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	CommentEnd	Calls CommentEnd on the Output. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	CommentStart	Calls CommentStart(ICommentProperties) on the Output. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	CustomInfo	Calls CustomInfo(ICustomInfoProperties) on the Output (if set). (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetCurrentLocation	Returns a text location that corresponds to the current line and offset numbers.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLocationAfterCurrentContent	Gets the current line and offset values, i.e. after the last increment.
	GetLocationBeforeCurrentContent	Gets the line and offset values as they were before the last increment.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IncrementLineAndOffsetNumbers	This method gets called for each text and tag content that is processed. The implementation parses text for CR and LF and updates the Line and Offset properties accordingly.
	InlineEndTag	Counts line breaks and characters inside tags. (Overrides AbstractNativeExtractionGenerationContentProcessorInlineEndTag(IEndTagProperties).)
	InlinePlaceholderTag	Counts line breaks and characters inside tags. (Overrides AbstractNativeExtractionGenerationContentProcessorInlinePlaceholderTag(IPlaceholderTagProperties).)
	InlineStartTag	Counts line breaks and characters inside tags. (Overrides AbstractNativeExtractionGenerationContentProcessorInlineStartTag(IStartTagProperties).)
	LocationMark	Calls LocationMark(LocationMarkerId) on the Output (if set). (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	LockedContentEnd	Calls LockedContentEnd on the Output. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	LockedContentStart	Calls LockedContentStart(ILockedContentProperties) on the Output. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ParagraphComments	Calls ParagraphComments(ICommentProperties) on the Output. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	ParagraphUnitEnd	Calls ParagraphUnitEnd on the GenerationOutput (if set). (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	ParagraphUnitStart	Calls ParagraphUnitStart(IParagraphUnitProperties) on the GenerationOutput (if set). (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	ParseText	Returns the number of lines and characters after the last line break in the text. Does not update any of the member variables.
	ReportMessage(Object, String, ErrorLevel, String, String)	Calls the corresponding method on the message reporter property. (Inherited from AbstractNativeFileTypeComponent.)
	ReportMessage(Object, String, ErrorLevel, String, LocationMarkerId, LocationMarkerId)	Calls the corresponding method on the message reporter property. (Inherited from AbstractNativeFileTypeComponent.)
	RevisionEnd	Calls RevisionEnd on the Output. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	RevisionStart	Calls RevisionStart(IRevisionProperties) on the Output. (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	SegmentEnd	Calls SegmentEnd on the GenerationOutput (if set). (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	SegmentStart	Calls SegmentStart(ISegmentPairProperties) on the GenerationOutput (if set). (Inherited from AbstractNativeExtractionGenerationContentProcessor.)
	StructureTag	Counts line breaks and characters inside structure tags. (Overrides AbstractNativeExtractionGenerationContentProcessorStructureTag(IStructureTagProperties).)
	Text	Counts line breaks and characters inside normal text. (Overrides AbstractNativeExtractionGenerationContentProcessorText(ITextProperties).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This is intended to be used for components related to native text location message reporting, where line and offset numbers is the means of specifying a location for an error message.

Both line and offset numbers are 1-based, i.e. the first line in a file is line 1, and the first character on a line is character offset 1.

Line and offsets are calculated by looking at the text and tag properties passed through the content processor. Any text or tag content that contains a line break increments the current line number. The offset is reset to 1 after each line break and is incremented by 1 for each Unicode character after the line break.

Text and tags inside locked content are counted too.

The following is considered a line break character: a combination of CR+LF, a standalone LF, or a standalone CR. A CR+LF is counted as one single line break (CR = 0x0d, LF = 0x0a).

The current line and offset numbers can be read from the Line and Offset properties. These properties can also be written to, which could be useful if the values need to be adjusted.

Reference

Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi Namespace

Community

Edit

Be the first to Edit the community content of this topic.

Comments

Send comments on this topic to https://community.sdl.com/developers/language-developers/