IKVM.Reflection.Emit.SequencePointEncoder Struct Reference

Helper to encode sequence points. More...

Public Member Functions
	SequencePointEncoder (BlobBuilder writer)
	initializes a new instance.
void	LocalSignature (StandaloneSignatureHandle localSignature)
	Encodes the local signature.
void	SequencePoint (DocumentHandle document, int offset, int startLine, int startColumn, int endLine, int endColumn, ref DocumentHandle previousDocument)
	Encodes a new sequence point. previousDocument is used to determine whether a new document record is required to be written first.

Public Attributes
readonly BlobBuilder	writer
bool	localSignatureEncoded = false
bool	sequencePointEncoded = false
int	prevOffset = -1
int	prevNonHiddenStartLine = -1
int	prevNonHiddenStartColumn = -1

Detailed Description

Helper to encode sequence points.

Definition at line 12 of file SequencePointEncoder.cs.

Constructor & Destructor Documentation

SequencePointEncoder()

IKVM.Reflection.Emit.SequencePointEncoder.SequencePointEncoder

(

BlobBuilder

writer

)

initializes a new instance.

Parameters

writer

Definition at line 27 of file SequencePointEncoder.cs.

        {
            this.writer = writer ?? throw new ArgumentNullException(nameof(writer));
        }

Member Function Documentation

LocalSignature()

void IKVM.Reflection.Emit.SequencePointEncoder.LocalSignature

(

StandaloneSignatureHandle

localSignature

)

Encodes the local signature.

Parameters

localSignature
initialDocument

<param name="previousDocument".

Definition at line 38 of file SequencePointEncoder.cs.

        {
            if (localSignatureEncoded)
                throw new InvalidOperationException("Local Signature already encoded.");
            if (sequencePointEncoded)
                throw new InvalidOperationException("Sequence point already encoded.");
 
            // write local signature
            writer.WriteCompressedInteger(MetadataTokens.GetRowNumber(localSignature));
 
            localSignatureEncoded = true;
        }

SequencePoint()

void IKVM.Reflection.Emit.SequencePointEncoder.SequencePoint	(	DocumentHandle	document,
		int	offset,
		int	startLine,
		int	startColumn,
		int	endLine,
		int	endColumn,
		ref DocumentHandle	previousDocument )

Encodes a new sequence point. previousDocument is used to determine whether a new document record is required to be written first.

Parameters

document
offset
startLine
startColumn
endLine
endColumn
previousDocument

Exceptions

InvalidOperationException

Definition at line 62 of file SequencePointEncoder.cs.

        {
            if (localSignatureEncoded == false)
                throw new InvalidOperationException("Local signature not already encoded.");
            if (offset <= prevOffset)
                throw new ArgumentException("Subsequent sequence points must appear at an offset greater than the previous sequence point.");
 
            // document passed, and different from previous, write new document-record
            if (document.IsNil == false && document != previousDocument)
            {
                // this isn't the initial header document, but a document-record, which requires a zero IL offset
                if (sequencePointEncoded)
                    writer.WriteCompressedInteger(0);
 
                writer.WriteCompressedInteger(MetadataTokens.GetRowNumber(document));
                previousDocument = document;
            }
 
            // IL offset or delta IL offset
            if (prevOffset == -1)
                writer.WriteCompressedInteger(offset);
            else
                writer.WriteCompressedInteger(offset - prevOffset);
 
            // hidden or non-hidden sequence point
            if (startLine == System.Reflection.Metadata.SequencePoint.HiddenLine)
            {
                writer.WriteCompressedInteger(0);
                writer.WriteCompressedInteger(0);
            }
            else
            {
                var deltaLines = endLine - startLine;
                var deltaColumns = endColumn - startColumn;
                Debug.Assert(startLine == System.Reflection.Metadata.SequencePoint.HiddenLine || deltaLines > 0 || deltaColumns > 0);
 
                // write change in lines; then change in columns (signed if change in lines)
                writer.WriteCompressedInteger(deltaLines);
                if (deltaLines == 0)
                    writer.WriteCompressedInteger(deltaColumns);
                else
                    writer.WriteCompressedSignedInteger(deltaColumns);
 
                // delta start lines & columns
                if (prevNonHiddenStartLine == -1)
                {
                    Debug.Assert(prevNonHiddenStartColumn == -1);
                    writer.WriteCompressedInteger(startLine);
                    writer.WriteCompressedInteger(startColumn);
                }
                else
                {
                    writer.WriteCompressedSignedInteger(startLine - prevNonHiddenStartLine);
                    writer.WriteCompressedSignedInteger(startColumn - prevNonHiddenStartColumn);
                }
 
                prevNonHiddenStartLine = startLine;
                prevNonHiddenStartColumn = startColumn;
            }
 
            prevOffset = offset;
            sequencePointEncoded = true;
        }

Member Data Documentation

localSignatureEncoded

bool IKVM.Reflection.Emit.SequencePointEncoder.localSignatureEncoded = false

Definition at line 17 of file SequencePointEncoder.cs.

prevNonHiddenStartColumn

int IKVM.Reflection.Emit.SequencePointEncoder.prevNonHiddenStartColumn = -1

Definition at line 21 of file SequencePointEncoder.cs.

prevNonHiddenStartLine

int IKVM.Reflection.Emit.SequencePointEncoder.prevNonHiddenStartLine = -1

Definition at line 20 of file SequencePointEncoder.cs.

prevOffset

int IKVM.Reflection.Emit.SequencePointEncoder.prevOffset = -1

Definition at line 19 of file SequencePointEncoder.cs.

sequencePointEncoded

bool IKVM.Reflection.Emit.SequencePointEncoder.sequencePointEncoded = false

Definition at line 18 of file SequencePointEncoder.cs.

writer

readonly BlobBuilder IKVM.Reflection.Emit.SequencePointEncoder.writer

Definition at line 15 of file SequencePointEncoder.cs.

---

The documentation for this struct was generated from the following file:

• src/IKVM.CoreLib/Reflection/Emit/SequencePointEncoder.cs