강의 외적인 의문을 정리한 번외 파트입니다.
옵시디언에 정리한 마크다운 문서라 블로그 마크다운 양식에 일부 맞지 않을 수 있습니다.

UCLASS()
class UNREALSTRING_API UMyGameInstance : public UGameInstance
{
    GENERATED_BODY()
public:
    virtual void Init() override;
};

위와 같은 언리얼 C++을 처음 접하면 기존 C++과 다른 클래스 문법이 몇가지 보인다.

UCLASS()
UNREALSTRING_API
GENERATED_BODY()

1. 기존 C++ 클래스 문법#

C++에서 클래스는 아래와 같이 선언한다.

class 클래스명 : 접근제한자 부모클래스명
{
    // 멤버 변수와 함수
};

예시

class MyClass : public BaseClass
{
    void Hello();
};

2. UCLASS() 매크로#

2-1. UCLASS() 의미#

UCLASS()

언리얼 엔진은 자체 오브젝트/리플렉션 시스템을 보유
UCLASS() 매크로는 해당 클래스가 리플렉션 시스템에 등록된다는 표시
- 블루프린트에서 사용 가능
- 직렬화(Serialization), 네트워킹, GC 등 엔진 기능과 연동
  - UHT가 생성하는 코드와 연결

2-2. generated.h와 UHT#

UCLASS() 자체는 모든 기능을 담지 않고, UHT가 생성한 코드와 연결하는 hook 역할을 한다.

#include "MyGameInstance.generated.h" 는 UHT가 빌드 과정에서 자동 생성한 헤더
UCLASS() 매크로는 내부적으로 BODY_MACRO_COMBINE(...) 같은 토큰을 생성
- 실제 구현은 generated.h 안에서 확장

2-3. UCLASS() 매크로 확장 과정#

UCLASS()를 추적해보면 아래와 같이 define 되어있는데

#define UCLASS(...) BODY_MACRO_COMBINE(CURRENT_FILE_ID,_,__LINE__,_PROLOG)

여기서 CURRENT_FILE_ID + __LINE__ 등이 합쳐져서 고유한 매크로 이름이 생성

#define BODY_MACRO_COMBINE_INNER(A,B,C,D) A##B##C##D
#define BODY_MACRO_COMBINE(A,B,C,D) BODY_MACRO_COMBINE_INNER(A,B,C,D)

예를 들어, MyGameInstance.generated.h 안에서는 다음과 같이 확장된다.

#define FID_UnrealString_Source_UnrealString_MyGameInstance_h_16_INCLASS_NO_PURE_DECLS \
private: \
	static void StaticRegisterNativesUMyGameInstance(); \
	friend struct ::Z_Construct_UClass_UMyGameInstance_Statics; \
	static UClass* GetPrivateStaticClass(); \
	friend UNREALSTRING_API UClass* ::Z_Construct_UClass_UMyGameInstance_NoRegister(); \
public: \
	DECLARE_CLASS2(UMyGameInstance, UGameInstance, COMPILED_IN_FLAGS(0 | CLASS_Transient), CASTCLASS_None, TEXT("/Script/UnrealString"), Z_Construct_UClass_UMyGameInstance_NoRegister) \
	DECLARE_SERIALIZER(UMyGameInstance)

FID_UnrealString_Source_UnrealString_MyGameInstance_h_16_INCLASS_NO_PURE_DECLS와 같이 combine 되어 있고, 이는 다시 헤더 내부에서 define되고 있다.

2-4. 라인 번호 변화에 따른 FID 매크로 이름 변화#

_h_16_의 숫자는 클래스 선언이 위치한 소스 파일의 라인 번호를 뜻한다.

#define FID_UnrealString_Source_UnrealString_MyGameInstance_h_16_INCLASS_NO_PURE_DECLS

만약 클래스 선언 위에 엔터를 하나 더 쳐서 줄이 바뀌면, __LINE__값이 증가하여 다음과 같이 바뀐다.

#define FID_UnrealString_Source_UnrealString_MyGameInstance_h_17_INCLASS_NO_PURE_DECLS

3. UNREALSTRING_API 매크로#

UNREALSTRING_API같은 매크로는 모듈 간 심볼 export import를 처리하기 위한 장치이다.

class UNREALSTRING_API UMyGameInstance : public UGameInstance

위 코드에 UNREALSTRING_API를 VS에서 추적해보면 아래와 같이 잡힌다.

// Windows (MSVC)
#define UNREALSTRING_API DLLEXPORT
// ->
#define DLLEXPORT __declspec(dllexport)

언리얼 프로젝트는 여러 모듈로 나뉘어 있고, 각 모듈은 DLL로 빌드된다.
다른 모듈에서 정의한 클래스를 사용하려면 export import 가 필요하다.
언리얼은 멀티 플랫폼을 지원하므로, XXXXX_API 매크로를 두고 환경에 맞게 아래와 같이 치환한다.
- MSVC : __declspec(dllexport) / __declspec(dllimport)
- GCC/Clang : __attribute__((visibility("default")))

4. GENERATED_BODY() 매크로#

UCLASS()
class UNREALSTRING_API UMyGameInstance : public UGameInstance
{
    GENERATED_BODY()
};

GENERATED_BODY()는 엔진이 자동으로 필요한 내부 코드를 삽입하게 해주는 매크로
- 리플렉션, 직렬화, 블루프린트 지원 등..
클래스마다 고유한 함수/메타데이터를 생성하는 코드가 들어간다.
- StaticRegisterNativesUMyGameInstance()
- DECLARE_CLASS(...)
- DECLARE_SERIALIZER(...)

리플렉션#

리플렉션(Reflection)은 프로그램이 자기 자신을 메타 데이터로 인식하고 다룰 수 있는 기능

언리얼에서는 리플렉션을 통해 다음이 가능하다.
- 블루프린트 노출
- 직렬화(저장/로드)
- 에디터에서 프로퍼티 수정
- 네트워킹/레플리케이션

5. 결론#

언리얼 클래스 선언부는 아래와 같이 이해하면 된다

UCLASS()
class [모듈 매크로] [클래스명] : [접근제한자] [상속클래스명]
{
    GENERATED_BODY()
}

정리하면

UCLASS() : 언리얼 리플렉션 시스템 등록용 매크로
XXXXX_API : 모듈 간 심볼 export/import 처리용 매크로 (멀티 플랫폼 호환성)
GENERATED_BODY() : 엔진이 자동으로 필요한 내부 코드를 삽입하는 매크로