STextRange

A range in a text document/string expressed as (zero-based) begin and end row/column.

API > API/Runtime > API/Runtime/uLangCore > API/Runtime/uLangCore/uLang > API/Runtime/uLangCore/uLang/Common > API/Runtime/uLangCore/uLang/Common/Text

References

   
Module uLangCore
Header /Engine/Source/Runtime/Solaris/uLangCore/Public/uLang/Common/Text/TextRange.h
Include #include "uLang/Common/Text/TextRange.h"

Syntax

struct STextRange

Remarks

A range in a text document/string expressed as (zero-based) begin and end row/column. A range is comparable to a selection in an editor. Therefore the end position is exclusive. Columns are byte offsets into the UTF-8 encoded line.

To specify a range that contains a line including the line ending character(s), use an end position denoting the start of the next line (or) same row and the column just past the last character on the row.

Often used with CUTF8StringView and SIdxRange. CUTF8StringView should do the converting to and from SIdxRange and STextRange.

Similar to a LSP Range - https://microsoft.github.io/language-server-protocol/specifications/specification-3-14/#range Also similar to UE `FIntRect_

Constructors

  Type Name Description
Public function ULANG_FORCEINLINE  
Public function ULANG_FORCEINLINE  
Public function ULANG_FORCEINLINE

STextRange ( const STextPosition& BeginAndEnd
)

  
Public function ULANG_FORCEINLINE

STextRange ( const STextPosition& Begin,
const STextPosition& End
)

  
Public function ULANG_FORCEINLINE

STextRange ( uint32_t BeginRow,
uint32_t BeginColumn,
uint32_t EndRow,
uint32_t EndColumn
)

  

Functions

  Type Name Description
Public function Const uint32_t  
Public function Const uint32_t  
Public function Const uint32_t  
Public function Const uint32_t

EndRow ()

  
Public function Const ULANG_FORCEINLINESTextPosition  
Public function Const ULANG_FORCEINLINESTextPosition

GetEnd ()

  
Public function ULANG_FORCEINLINE void  
Public function ULANG_FORCEINLINE void  
Public function Const ULANG_FORCEINLINE bool

IsContainedIn ( const STextRange& ContainingRange
)

  
Public function Const ULANG_FORCEINLINE bool

IsEmpty ()

  
Public function Const ULANG_FORCEINLINE bool

IsInRange ( const STextPosition& Position
)

  
Public function Const ULANG_FORCEINLINE bool  
Public function Const ULANG_FORCEINLINE bool  
Public function Const ULANG_FORCEINLINE bool  
Public function Const ULANG_FORCEINLINE bool  
Public function Const ULANG_FORCEINLINE bool  
Public function Const ULANG_FORCEINLINE bool

IsValid ()

  
Public function Const ULANG_FORCEINLINE bool  
Public function Const ULANG_FORCEINLINE bool

Overlaps ( const STextRange& Other
)

  
Public function ULANG_FORCEINLINE void

Reset ()

  
Public function ULANG_FORCEINLINE void

SetBegin ( const STextPosition& Begin
)

  
Public function void

SetBeginColumn ( uint32_t Col
)

  
Public function void

SetBeginRow ( uint32_t Row
)

  
Public function ULANG_FORCEINLINE void

SetEnd ( const STextPosition& End
)

  
Public function void

SetEndColumn ( uint32_t Col
)

  
Public function void

SetEndRow ( uint32_t Row
)

  

Operators

  Type Name Description
Public function Const ULANG_FORCEINLINE bool

operator!= ( const STextRange& Other
)

  
Public function Const ULANG_FORCEINLINESTextRange

operator| ( const STextRange& Other
)

 Compute the union of two text ranges.
Public function ULANG_FORCEINLINESTextRange &

operator|= ( const STextRange& Other
)

 Make this text range the union of this and another.
Public function Const ULANG_FORCEINLINE bool

operator== ( const STextRange& Other
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page