1. Epic GamesDeveloper
  3. FTokenStream

FTokenStream

A token stream wraps up a raw string, providing accessors into it for consuming tokens

Unreal Engine C++ API Reference > Runtime > Core > Misc

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/ExpressionParserTypes.h
Include #include "Misc/ExpressionParserTypes.h"

Syntax

class FTokenStream

Remarks

A token stream wraps up a raw string, providing accessors into it for consuming tokens

Constructors

  Type Name Description
Public function  

FTokenStream ( const TCHAR* In
)

 Constructor. The stream is only valid for the lifetime of the string provided

Functions

  Type Name Description
Public function Const int32 Get the number of characters remaining in the stream after the current read position
Public function Const TOptional< FStringToken >

GenerateToken ( int32 NumChars,
FStringToken* Accumulate
)

 Generate a token for the specified number of chars, at the current read position (or end of Accumulate)
Public function Const const TCHAR *

GetEnd ()

  
Public function Const FString Get the error context from the current read position
Public function Const int32 Get the current read position from the start of the stream
Public function Const const TCHAR *

GetRead ()

  
Public function Const const TCHAR *  
Public function Const bool

IsEmpty ()

 Check if the stream is empty
Public function Const bool

IsReadPosValid ( const TCHAR* InPos,
int32 MinNumChars
)

 Check if it is valid to read (the optional number of characters) from the specified position
Public function Const TOptional< FStringToken >

ParseSymbol ( FStringToken* Accumulate
)

 Return a string token for the next character in the stream (or accumulating into the specified existing token)
Public function Const TOptional< FStringToken >

ParseSymbol ( TCHAR Symbol,
FStringToken* Accumulate
)

 Attempt parse out the specified pre-defined string from the current read position (or accumulating into the specified existing token)
Public function Const TOptional< FStringToken >

ParseToken ( TFunctionRef< EParseState(TCHAR)> Pred,
FStringToken* Accumulate
)

 Parse out a token using the supplied predicate.
Public function Const TOptional< FStringToken >

ParseToken ( const TCHAR* Symbol,
FStringToken* Accumulate
)

 Attempt parse out the specified pre-defined string from the current read position (or accumulating into the specified existing token)
Public function Const TOptional< FStringToken >

ParseTokenIgnoreCase ( const TCHAR* Symbol,
FStringToken* Accumulate
)

 Parse out a token using the supplied predicate.
Public function Const TOptional< FStringToken >

ParseWhitespace ( FStringToken* Accumulate
)

 Parse a whitespace token
Public function Const TCHAR

PeekChar ( int32 Offset
)

 Peek at the character at the specified offset from the current read position
Public function void

SetReadPos ( const FStringToken& Token
)

 Set the current read position to the character proceeding the specified token

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page