1. Epic GamesDeveloper
  3. FParse

FParse

API > API/Runtime > API/Runtime/Core

   
Name FParse
Type struct
Header File /Engine/Source/Runtime/Core/Public/Misc/Parse.h
Include Path #include "Misc/Parse.h"

Syntax

struct FParse

Structs

Name Remarks
FGrammarBasedParseResult  

Enums

Public

Name Remarks
EGrammarBasedParseErrorCode  
EGrammarBasedParseFlags CLI string parsing using grammar based parser.
ELineExtendedFlags Get a line of Stream, with support for extending beyond that line with certain characters, e.g. {} and \ the out character array will not include the ignored endlines

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AlnumToken ( const TCHAR*& Str,
FString& Arg
)

 Grabs the next alpha-numeric space-delimited token from the input stream. Misc/Parse.h  

static bool Bool ( const TCHAR* Stream,
const TCHAR* Match,
bool& OnOff
)

 Parses a boolean value. Misc/Parse.h  

static bool Command ( const TCHAR** Stream,
const TCHAR* Match,
bool bParseMightTriggerExecution
)

 Sees if Stream starts with the named command. Misc/Parse.h  

static bool Expression ( const TCHAR*& Str,
FString& OutExpression,
bool bUseEscape,
const TCHAR SingleCharacterDelimiter
)

 Parse the next space-delimited (or SingleCharacterDelmiter-delimited) expression, using brackets (), {}, or [] to allow subexpressions to be part of the single expression even if they contain the delimiter. Misc/Parse.h  

static FGrammarBasedParseResult GrammarBasedCLIParse ( const TCHAR* Stream,
TFunctionRef< void(FStringView, FStringView)> OnCommandCallback,
EGrammarBasedParseFlags Flags
)

 Grammar Line -> Cmd* Cmd -> "Cmd*" allowed if EGrammaredParseFlags::AllowQuotedCommands is given | Key(=Value)? invokes OnCommandCallback Key -> (/|(-?-?))Ident Value -> "[^"]*" Misc/Parse.h  

static int32 HexDigit ( TCHAR c
)

 Parse a hex digit. Misc/Parse.h  

static uint32 HexNumber ( FStringView HexString
)

 Parses a hexadecimal string value. Misc/Parse.h  

static uint64 HexNumber64 ( FStringView HexString
)

   Misc/Parse.h  

static bool Line ( const TCHAR** Stream,
TCHAR* Result,
int32 MaxLen,
bool Exact
)

 Get a line of Stream (everything up to, but not including, CR/LF. Returns 0 if ok, nonzero if at end of stream and returned 0-length string. Misc/Parse.h  

static bool Line ( const TCHAR** Stream,
FStringView& Result,
bool Exact
)

 Get a line of Stream (everything up to, but not including, CR/LF. Returns 0 if ok, nonzero if at end of stream and returned 0-length string. Misc/Parse.h  

static bool Line ( const TCHAR** Stream,
FString& Result,
bool Exact
)

 Get a line of Stream (everything up to, but not including, CR/LF. Returns 0 if ok, nonzero if at end of stream and returned 0-length string. Misc/Parse.h  

static bool LineExtended ( const TCHAR** Stream,
FString& Result,
int32& LinesConsumed,
ELineExtendedFlags Flags
)

   Misc/Parse.h  

static bool LineExtended ( const TCHAR** Stream,
FString& Result,
int32& LinesConsumed,
bool bExact
)

   Misc/Parse.h  

static bool LineExtended ( const TCHAR** Stream,
FStringBuilderBase& Result,
int32& LinesConsumed,
ELineExtendedFlags Flags
)

   Misc/Parse.h  

static bool LineExtended ( const TCHAR** Stream,
FStringBuilderBase& Result,
int32& LinesConsumed,
bool bExact
)

   Misc/Parse.h  

static void Next ( const TCHAR** Stream
)

 Get next command. Skips past comments and cr's. Misc/Parse.h  

static bool Param ( const TCHAR* Stream,
const TCHAR* Param
)

 Checks if a command-line parameter exists in the stream. Misc/Parse.h  

static bool QuotedString ( const TCHAR* Stream,
FStringBuilderBase& Value,
int32* OutNumCharsRead
)

   Misc/Parse.h  

static bool QuotedString ( const TCHAR* Stream,
FString& Value,
int32* OutNumCharsRead
)

 Parse a quoted string token. Misc/Parse.h  

static bool SchemeNameFromURI ( const TCHAR* InURI,
FString& OutSchemeName
)

 Parses the scheme name from a URI Misc/Parse.h  

static bool Text ( const TCHAR* Stream,
FText& Value,
const TCHAR* Namespace
)

 Parse an Text token. Misc/Parse.h  

static FString Token ( const TCHAR*& Str,
bool UseEscape
)

 Grabs the next space-delimited string from the input stream. If quoted, gets entire quoted string. Misc/Parse.h  

static bool Token ( const TCHAR*& Str,
FString& Arg,
bool bUseEscape,
const TCHAR SingleCharacterDelimiter
)

 Grabs the next space-delimited (unless SingleCharacterDelimiter is provided) string from the input stream. Misc/Parse.h  

static bool Token ( const TCHAR*& Str,
TCHAR* Result,
int32 MaxLen,
bool bUseEscape,
const TCHAR SingleCharacterDelimiter
)

 Grabs the next space-delimited (unless SingleCharacterDelimiter is provided) string from the input stream. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
FString& Value,
bool bShouldStopOnSeparator,
const TCHAR** OptStreamGotTo
)

 Parses a string. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
FText& Value,
const TCHAR* Namespace
)

 Parses an FText. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
int64& Value
)

 Parses a signed quadword. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
uint64& Value
)

 Parses a quadword. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
int32& Value
)

 Parses a signed double word. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
double& Value
)

 Parses a double precision floating-point value. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
float& Value
)

 Parses a floating-point value. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
int8& Value
)

 Parses a signed byte. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
uint16& Value
)

 Parses a uint16. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
uint8& Value
)

 Parses a byte. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
FGuid& Guid
)

 Parses a globally unique identifier. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
uint32& Value
)

 Parses a uint32. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
FName& Name
)

 Parses a name. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
int16& Value
)

 Parses a signed word. Misc/Parse.h  

static bool Value ( const TCHAR* Stream,
const TCHAR* Match,
TCHAR* Value,
int32 MaxLen,
bool bShouldStopOnSeparator,
const TCHAR** OptStreamGotTo
)

 Parses a string from a text string. Misc/Parse.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page