UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Common.h File Reference
#include <stdlib.h>
#include <stdint.h>
#include <new>

Go to the source code of this file.

Classes

struct  uLang::SSystemParams
 Parameters to initialize the uLang module. More...
 

Namespaces

namespace  uLang
 

Macros

#define ULANG_PLATFORM_WINDOWS   0
 
#define ULANG_PLATFORM_MAC   0
 
#define ULANG_PLATFORM_LINUX   0
 
#define ULANG_PLATFORM_POSIX   (ULANG_PLATFORM_MAC || ULANG_PLATFORM_LINUX)
 
#define ULANG_PLATFORM_EXTENSION   0
 
#define ULANG_STRINGIFY(x)   ULANG_STRINGIFY_INNER(x)
 
#define ULANG_STRINGIFY_INNER(x)   #x
 
#define ULANG_PREPROCESSOR_JOIN(x, y)   ULANG_PREPROCESSOR_JOIN_INNER(x, y)
 
#define ULANG_PREPROCESSOR_JOIN_INNER(x, y)   x##y
 
#define ULANG_PLATFORM_HEADER_NAME(Suffix)   ULANG_STRINGIFY(ULANG_PREPROCESSOR_JOIN(ULANG_PLATFORM/ULANG_PLATFORM, Suffix))
 
#define ULANG_PLATFORM_HEADER_NAME_WITH_PREFIX(Prefix, Suffix)   ULANG_STRINGIFY(Prefix/ULANG_PLATFORM/ULANG_PREPROCESSOR_JOIN(ULANG_PLATFORM, Suffix))
 
#define ULANG_API_VERSION   2
 To prevent API mismatch in dynamic linking situations.
 
#define DLLIMPORT   ULANG_DLLIMPORT
 
#define DLLEXPORT   ULANG_DLLEXPORT
 
#define DLLIMPORT_VTABLE   ULANG_DLLIMPORT_VTABLE
 
#define DLLEXPORT_VTABLE   ULANG_DLLEXPORT_VTABLE
 
#define ULANG_THIRD_PARTY_INCLUDES_START
 
#define ULANG_THIRD_PARTY_INCLUDES_END
 
#define ULANG_IGNORE_CLASS_MEMACCESS_WARNING_START
 
#define ULANG_IGNORE_CLASS_MEMACCESS_WARNING_END
 
#define ULANG_SILENCE_SECURITY_WARNING_START
 
#define ULANG_SILENCE_SECURITY_WARNING_END
 
#define ULANG_DLLIMPORT
 
#define ULANG_DLLEXPORT
 
#define ULANG_DLLIMPORT_VTABLE
 
#define ULANG_DLLEXPORT_VTABLE
 
#define ULANG_GCC_PACK(n)
 
#define ULANG_GCC_ALIGN(n)
 
#define ULANG_MS_ALIGN(n)
 
#define ULANG_FORCEINLINE   inline
 
#define ULANG_FORCENOINLINE
 
#define ULANG_RESTRICT   __restrict
 
#define ULANG_LIKELY(x)   (x)
 
#define ULANG_UNLIKELY(x)   (x)
 
#define ULANG_COUNTOF(x)   (sizeof(x)/sizeof(x[0]))
 
#define ULANG_FALLTHROUGH
 
#define ULANG_UNREACHABLE()   while(true) { ULANG_BREAK(); }
 
#define ULANG_CA_ASSUME(Expr)   ((void)Expr)
 
#define ULANG_ASSERT(expr)   (void(sizeof(!!(expr))))
 
#define ULANG_VERIFY(expr)   (void(sizeof(!!(expr))))
 
#define ULANG_ENSURE(expr)   (!!(expr))
 
#define ULANG_ERRORF(format, ...)   (void(0))
 
#define ULANG_ASSERTF(expr, format, ...)   (void(sizeof(!!(expr))))
 
#define ULANG_VERIFYF(expr, format, ...)   (void(sizeof(!!(expr))))
 
#define ULANG_ENSUREF(expr, format, ...)   (!!(expr))
 
#define VERSE_SUPPRESS_UNUSED(_Variable)   (void)(_Variable);
 
#define USING_ELogVerbosity
 
#define ULANG_LOGF(verbosity, format, ...)
 
#define ULANG_AGGRESSIVE_MEMORY_SAVING   0
 

Typedefs

using uLang::NullPtrType = std::nullptr_t
 
using uLang::Integer = int64_t
 
using uLang::Float = double
 Default size for uLang Integer Type.
 
using uLang::Boolean = bool
 Default size for uLang Float Type.
 

Enumerations

enum class  uLang::EVisitResult : int8_t { uLang::Continue = 0 , uLang::SkipChildren = 1 , uLang::Stop = 2 }
 Result returned from a visitor functor indicating how to continue or to quit early. More...
 
enum class  uLang::EIterateResult : int8_t { uLang::Stopped = 0 , uLang::Completed = 1 }
 Iteration result returned from an iteration. More...
 
enum class  uLang::EResult : int8_t { uLang::Unspecified = -1 , uLang::OK = 0 , uLang::Error }
 Generic error codes. More...
 
enum class  uLang::EErrorAction : int8_t { uLang::Continue = 0 , uLang::Break }
 Generic action after error has occurred. More...
 
enum class  uLang::EEquate : int8_t { uLang::Less = -1 , uLang::Equal = 0 , uLang::Greater = 1 }
 
enum  uLang::ENoInit { uLang::NoInit }
 Enum used in constructors to indicate they should not initialize anything. More...
 
enum  uLang::EDefaultInit { uLang::DefaultInit }
 Enum used to force default initialization. More...
 
enum  uLang::EIndex { uLang::IndexNone = -1 }
 Used to signify an unspecified index. More...
 
enum class  uLang::EAssertSeverity : int8_t { uLang::Fatal = 0 , uLang::Recoverable }
 
enum class  uLang::ELogVerbosity : int8_t {
  uLang::Error , uLang::Warning , uLang::Display , uLang::Verbose ,
  uLang::Log
}
 

Functions

bool uLang::operator== (const SSystemParams &Lhs, const SSystemParams &Rhs)
 
SSystemParamsuLang::GetSystemParams ()
 Global variable for efficient access.
 
EResult uLang::Initialize (const SSystemParams &Params)
 
bool uLang::IsInitialized ()
 
EResult uLang::DeInitialize ()
 
void uLang::SetGlobalVerbosity (const uLang::ELogVerbosity GlobalVerbosity)
 

Variables

const uint32_t uLang::uint32_invalid = UINT32_MAX
 Default size for uLang Boolean Type.
 

Macro Definition Documentation

◆ DLLEXPORT

#define DLLEXPORT   ULANG_DLLEXPORT

◆ DLLEXPORT_VTABLE

#define DLLEXPORT_VTABLE   ULANG_DLLEXPORT_VTABLE

◆ DLLIMPORT

#define DLLIMPORT   ULANG_DLLIMPORT

◆ DLLIMPORT_VTABLE

#define DLLIMPORT_VTABLE   ULANG_DLLIMPORT_VTABLE

◆ ULANG_AGGRESSIVE_MEMORY_SAVING

#define ULANG_AGGRESSIVE_MEMORY_SAVING   0

◆ ULANG_API_VERSION

#define ULANG_API_VERSION   2

To prevent API mismatch in dynamic linking situations.

◆ ULANG_ASSERT

#define ULANG_ASSERT (   expr)    (void(sizeof(!!(expr))))

◆ ULANG_ASSERTF

#define ULANG_ASSERTF (   expr,
  format,
  ... 
)    (void(sizeof(!!(expr))))

◆ ULANG_CA_ASSUME

#define ULANG_CA_ASSUME (   Expr)    ((void)Expr)

◆ ULANG_COUNTOF

#define ULANG_COUNTOF (   x)    (sizeof(x)/sizeof(x[0]))

◆ ULANG_DLLEXPORT

#define ULANG_DLLEXPORT

◆ ULANG_DLLEXPORT_VTABLE

#define ULANG_DLLEXPORT_VTABLE

◆ ULANG_DLLIMPORT

#define ULANG_DLLIMPORT

◆ ULANG_DLLIMPORT_VTABLE

#define ULANG_DLLIMPORT_VTABLE

◆ ULANG_ENSURE

#define ULANG_ENSURE (   expr)    (!!(expr))

◆ ULANG_ENSUREF

#define ULANG_ENSUREF (   expr,
  format,
  ... 
)    (!!(expr))

◆ ULANG_ERRORF

#define ULANG_ERRORF (   format,
  ... 
)    (void(0))

◆ ULANG_FALLTHROUGH

#define ULANG_FALLTHROUGH

◆ ULANG_FORCEINLINE

#define ULANG_FORCEINLINE   inline

◆ ULANG_FORCENOINLINE

#define ULANG_FORCENOINLINE

◆ ULANG_GCC_ALIGN

#define ULANG_GCC_ALIGN (   n)

◆ ULANG_GCC_PACK

#define ULANG_GCC_PACK (   n)

◆ ULANG_IGNORE_CLASS_MEMACCESS_WARNING_END

#define ULANG_IGNORE_CLASS_MEMACCESS_WARNING_END

◆ ULANG_IGNORE_CLASS_MEMACCESS_WARNING_START

#define ULANG_IGNORE_CLASS_MEMACCESS_WARNING_START

◆ ULANG_LIKELY

#define ULANG_LIKELY (   x)    (x)

◆ ULANG_LOGF

#define ULANG_LOGF (   verbosity,
  format,
  ... 
)
Value:
}
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
#define USING_ELogVerbosity
Definition Common.h:301
SSystemParams & GetSystemParams()
Global variable for efficient access.
Definition Common.cpp:9
FLog _LogMessage
Print a message.
Definition Common.h:418

◆ ULANG_MS_ALIGN

#define ULANG_MS_ALIGN (   n)

◆ ULANG_PLATFORM_EXTENSION

#define ULANG_PLATFORM_EXTENSION   0

◆ ULANG_PLATFORM_HEADER_NAME

#define ULANG_PLATFORM_HEADER_NAME (   Suffix)    ULANG_STRINGIFY(ULANG_PREPROCESSOR_JOIN(ULANG_PLATFORM/ULANG_PLATFORM, Suffix))

◆ ULANG_PLATFORM_HEADER_NAME_WITH_PREFIX

#define ULANG_PLATFORM_HEADER_NAME_WITH_PREFIX (   Prefix,
  Suffix 
)    ULANG_STRINGIFY(Prefix/ULANG_PLATFORM/ULANG_PREPROCESSOR_JOIN(ULANG_PLATFORM, Suffix))

◆ ULANG_PLATFORM_LINUX

#define ULANG_PLATFORM_LINUX   0

◆ ULANG_PLATFORM_MAC

#define ULANG_PLATFORM_MAC   0

◆ ULANG_PLATFORM_POSIX

#define ULANG_PLATFORM_POSIX   (ULANG_PLATFORM_MAC || ULANG_PLATFORM_LINUX)

◆ ULANG_PLATFORM_WINDOWS

#define ULANG_PLATFORM_WINDOWS   0

◆ ULANG_PREPROCESSOR_JOIN

#define ULANG_PREPROCESSOR_JOIN (   x,
 
)    ULANG_PREPROCESSOR_JOIN_INNER(x, y)

◆ ULANG_PREPROCESSOR_JOIN_INNER

#define ULANG_PREPROCESSOR_JOIN_INNER (   x,
 
)    x##y

◆ ULANG_RESTRICT

#define ULANG_RESTRICT   __restrict

◆ ULANG_SILENCE_SECURITY_WARNING_END

#define ULANG_SILENCE_SECURITY_WARNING_END

◆ ULANG_SILENCE_SECURITY_WARNING_START

#define ULANG_SILENCE_SECURITY_WARNING_START

◆ ULANG_STRINGIFY

#define ULANG_STRINGIFY (   x)    ULANG_STRINGIFY_INNER(x)

◆ ULANG_STRINGIFY_INNER

#define ULANG_STRINGIFY_INNER (   x)    #x

◆ ULANG_THIRD_PARTY_INCLUDES_END

#define ULANG_THIRD_PARTY_INCLUDES_END

◆ ULANG_THIRD_PARTY_INCLUDES_START

#define ULANG_THIRD_PARTY_INCLUDES_START

◆ ULANG_UNLIKELY

#define ULANG_UNLIKELY (   x)    (x)

◆ ULANG_UNREACHABLE

#define ULANG_UNREACHABLE ( )    while(true) { ULANG_BREAK(); }

◆ ULANG_VERIFY

#define ULANG_VERIFY (   expr)    (void(sizeof(!!(expr))))

◆ ULANG_VERIFYF

#define ULANG_VERIFYF (   expr,
  format,
  ... 
)    (void(sizeof(!!(expr))))

◆ USING_ELogVerbosity

◆ VERSE_SUPPRESS_UNUSED

#define VERSE_SUPPRESS_UNUSED (   _Variable)    (void)(_Variable);