Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FParse Struct Reference

#include <Parse.h>

Static Public Member Functions

static bool Command (const TCHAR **Stream, const TCHAR *Match, bool bParseMightTriggerExecution=true)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, FName &Name)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, uint32 &Value)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, struct FGuid &Guid)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, TCHAR *Value, int32 MaxLen, bool bShouldStopOnSeparator=true)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, uint8 &Value)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, int8 &Value)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, uint16 &Value)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, int16 &Value)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, float &Value)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, double &Value)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, int32 &Value)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, FString &Value, bool bShouldStopOnSeparator=true)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, FText &Value, const TCHAR *Namespace=NULL)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, uint64 &Value)
 
static bool Value (const TCHAR *Stream, const TCHAR *Match, int64 &Value)
 
static bool Bool (const TCHAR *Stream, const TCHAR *Match, bool &OnOff)
 
static bool Line (const TCHAR **Stream, TCHAR *Result, int32 MaxLen, bool Exact=false)
 
static bool Line (const TCHAR **Stream, FString &Result, bool Exact=false)
 
static bool Line (const TCHAR **Stream, FStringView &Result, bool Exact=false)
 
static bool LineExtended (const TCHAR **Stream, FString &Result, int32 &LinesConsumed, bool Exact=0)
 
static bool LineExtended (const TCHAR **Stream, FStringBuilderBase &Result, int32 &LinesConsumed, bool Exact=0)
 
static bool Token (const TCHAR *&Str, TCHAR *Result, int32 MaxLen, bool UseEscape)
 
static bool Token (const TCHAR *&Str, FString &Arg, bool UseEscape)
 
static bool AlnumToken (const TCHAR *&Str, FString &Arg)
 
static FString Token (const TCHAR *&Str, bool UseEscape)
 
static void Next (const TCHAR **Stream)
 
static bool Param (const TCHAR *Stream, const TCHAR *Param)
 
static bool Text (const TCHAR *Stream, FText &Value, const TCHAR *Namespace=nullptr)
 
static bool QuotedString (const TCHAR *Stream, FString &Value, int32 *OutNumCharsRead=nullptr)
 
static bool QuotedString (const TCHAR *Stream, FStringBuilderBase &Value, int32 *OutNumCharsRead=nullptr)
 
static FORCEINLINE int32 HexDigit (TCHAR c)
 
static uint32 HexNumber (const TCHAR *HexString)
 
static uint64 HexNumber64 (const TCHAR *HexString)
 
static bool Resolution (const TCHAR *InResolution, uint32 &OutX, uint32 &OutY)
 
static bool Resolution (const TCHAR *InResolution, uint32 &OutX, uint32 &OutY, int32 &OutWindowMode)
 
static bool SchemeNameFromURI (const TCHAR *InURI, FString &OutSchemeName)
 

Detailed Description

Definition at line 19 of file Parse.h.

Member Function Documentation

◆ AlnumToken()

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

Grabs the next alpha-numeric space-delimited token from the input stream.

◆ Bool()

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

Parses a boolean value.

◆ Command()

static bool FParse::Command ( const TCHAR ** Stream,
const TCHAR * Match,
bool bParseMightTriggerExecution = true )
static

Sees if Stream starts with the named command. If it does, skips through the command and blanks past it. Returns true of match.

Parameters
bParseMightTriggerExecutiontrue: Caller guarantees this is only part of parsing and no execution happens without further parsing (good for "DumpConsoleCommands").

◆ HexDigit()

static FORCEINLINE int32 FParse::HexDigit ( TCHAR c)
inlinestatic

Definition at line 91 of file Parse.h.

◆ HexNumber()

static uint32 FParse::HexNumber ( const TCHAR * HexString)
static

Parses a hexadecimal string value.

◆ HexNumber64()

static uint64 FParse::HexNumber64 ( const TCHAR * HexString)
static

◆ Line() [1/3]

static bool FParse::Line ( const TCHAR ** Stream,
FString & Result,
bool Exact = false )
static

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.

◆ Line() [2/3]

static bool FParse::Line ( const TCHAR ** Stream,
FStringView & Result,
bool Exact = false )
static

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.

◆ Line() [3/3]

static bool FParse::Line ( const TCHAR ** Stream,
TCHAR * Result,
int32 MaxLen,
bool Exact = false )
static

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.

◆ LineExtended() [1/2]

static bool FParse::LineExtended ( const TCHAR ** Stream,
FString & Result,
int32 & LinesConsumed,
bool Exact = 0 )
static

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

◆ LineExtended() [2/2]

static bool FParse::LineExtended ( const TCHAR ** Stream,
FStringBuilderBase & Result,
int32 & LinesConsumed,
bool Exact = 0 )
static

◆ Next()

static void FParse::Next ( const TCHAR ** Stream)
static

Get next command. Skips past comments and cr's.

◆ Param()

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

Checks if a command-line parameter exists in the stream.

◆ QuotedString() [1/2]

static bool FParse::QuotedString ( const TCHAR * Stream,
FString & Value,
int32 * OutNumCharsRead = nullptr )
static

Parse a quoted string token.

◆ QuotedString() [2/2]

static bool FParse::QuotedString ( const TCHAR * Stream,
FStringBuilderBase & Value,
int32 * OutNumCharsRead = nullptr )
static

◆ Resolution() [1/2]

static bool FParse::Resolution ( const TCHAR * InResolution,
uint32 & OutX,
uint32 & OutY )
static

Parses a resolution in the form 1920x1080.

◆ Resolution() [2/2]

static bool FParse::Resolution ( const TCHAR * InResolution,
uint32 & OutX,
uint32 & OutY,
int32 & OutWindowMode )
static

Parses a resolution in the form 1920x1080<f|w|wf>. Same as above, but also attempts to process a fullscreen/windowed flag from the end

◆ SchemeNameFromURI()

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

Parses the scheme name from a URI

◆ Text()

static bool FParse::Text ( const TCHAR * Stream,
FText & Value,
const TCHAR * Namespace = nullptr )
static

Parse an Text token.

◆ Token() [1/3]

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

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

◆ Token() [2/3]

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

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

◆ Token() [3/3]

static bool FParse::Token ( const TCHAR *& Str,
TCHAR * Result,
int32 MaxLen,
bool UseEscape )
static

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

◆ Value() [1/15]

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

Parses a double precision floating-point value.

◆ Value() [2/15]

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

Parses a floating-point value.

+ Here is the caller graph for this function:

◆ Value() [3/15]

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

Parses a name.

◆ Value() [4/15]

static bool FParse::Value ( const TCHAR * Stream,
const TCHAR * Match,
FString & Value,
bool bShouldStopOnSeparator = true )
static

Parses a string.

◆ Value() [5/15]

static bool FParse::Value ( const TCHAR * Stream,
const TCHAR * Match,
FText & Value,
const TCHAR * Namespace = NULL )
static

Parses an FText.

◆ Value() [6/15]

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

Parses a signed word.

◆ Value() [7/15]

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

Parses a signed double word.

◆ Value() [8/15]

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

Parses a signed quadword.

◆ Value() [9/15]

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

Parses a signed byte.

◆ Value() [10/15]

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

Parses a globally unique identifier.

◆ Value() [11/15]

static bool FParse::Value ( const TCHAR * Stream,
const TCHAR * Match,
TCHAR * Value,
int32 MaxLen,
bool bShouldStopOnSeparator = true )
static

Parses a string from a text string.

◆ Value() [12/15]

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

Parses a uint16.

◆ Value() [13/15]

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

Parses a uint32.

◆ Value() [14/15]

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

Parses a quadword.

◆ Value() [15/15]

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

Parses a byte.

+ Here is the caller graph for this function:

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