FFeedbackContextMarkup Class Reference

#include <FeedbackContextMarkup.h>

Static Public Member Functions
static bool	ParseCommand (const FString &Line, FFeedbackContext *Warn)
static bool	PipeProcessOutput (const FText &Description, const FString &URL, const FString &Params, FFeedbackContext *Warn, int32 *OutExitCode)

Static Private Member Functions
static bool	ReadToken (const TCHAR *&Text, const TCHAR *Token)
static bool	ReadProgress (const TCHAR *&Text, int32 &OutNumerator, int32 &OutDenominator)
static bool	ReadInteger (const TCHAR *&Text, uint32 &OutInteger)
static bool	ReadString (const TCHAR *&Text, FString &OutString)
static const TCHAR *	SkipWhitespace (const TCHAR *Text)

Detailed Description

A text-based markup language can be used to allow external processes to control the state machine, allowing command-line utilities to give graphical user feedback.

Example markup:

Update the progress of the current operation: @progress 10/20 @progress 50%

Update the progress and set a status message for the current operation: @progress 'Compiling source code...' 50%

Definition at line 25 of file FeedbackContextMarkup.h.

Member Function Documentation

ParseCommand()

static bool FFeedbackContextMarkup::ParseCommand ( const FString & Line, FFeedbackContext * Warn )

static

Markup stack manipulation.

PipeProcessOutput()

static bool FFeedbackContextMarkup::PipeProcessOutput ( const FText & Description, const FString & URL, const FString & Params, FFeedbackContext * Warn, int32 * OutExitCode )

static

Utility functions for dealing with external processes.

ReadInteger()

static bool FFeedbackContextMarkup::ReadInteger ( const TCHAR *& Text, uint32 & OutInteger )

staticprivate

Read an integer from the input stream

ReadProgress()

static bool FFeedbackContextMarkup::ReadProgress ( const TCHAR *& Text, int32 & OutNumerator, int32 & OutDenominator )

staticprivate

Read a progress value from the input stream. Valid forms are <Numerator>/<Denominator> or

%

ReadString()

static bool FFeedbackContextMarkup::ReadString ( const TCHAR *& Text, FString & OutString )

staticprivate

Read a string from the input stream

ReadToken()

static bool FFeedbackContextMarkup::ReadToken ( const TCHAR *& Text, const TCHAR * Token )

staticprivate

Try to read a single exact-match token from the input stream. Must be followed by whitespace or EOL.

SkipWhitespace()

static const TCHAR * FFeedbackContextMarkup::SkipWhitespace ( const TCHAR * Text )

staticprivate

Skip over a sequence of whitespace characters in the input stream and returns a pointer to the next character

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/FeedbackContextMarkup.h