虚幻4蓝图编译剖析（三）

编译

上面基本的术语已经介绍完了，下面我们进入来进入蓝图编译过程分析。蓝图的编译过程都在FKismetCompilerContext::Compile()函数中。它根据编译的类型不同（上文编译选项中提到的只编译Skeleton、只生成字节码、只生成cpp代码等等）会走不同的分支。我们这里以完全编译来讲解。此处为大概的流程，若想看详细的流程，请参照流程图以及代码。

清除类

类是就地编译的，这意味着同一个UBlueprintGeneratedClass在每次编译的时候都会被清理，并且会重复利用，这样指向这个类的指针就不用修复了。CleanAndSanitizeClass()把属性和函数放到临时包的一个垃圾（trash）类里面，然后清除类中的所有数据。

创建类的属性

CreateClassVariablesFromBlueprint()函数遍历蓝图的NewVariables数组，也包括构造脚本、Timeline等地方来找到该类需要的所有属性，然后创建UProperties。

创建函数列表

通过处理事件图表（Event graph）、常规的函数图表、代理、以及接口中来创建函数。

处理事件图表

CreateAndProcessUberGraph()函数用来处理事件图表。它把所有的事件图表拷贝到一个大的图中，这个时候节点有机会去做展开操作（expand，如果它需要的话）。然后会为图中的每一个事件节点创建一个函数桩（stub），最终会为当前的事件图表创建一个FKismetFunctionContext，用于把整个事件图表当作一个函数来处理。

处理函数图表

常规函数图表的处理是通过ProcessOneFunctionGraph()函数来完成的，它会把图中的每一个节点拷贝到另外一个节点中去，这个时候每个节点有机会展开（expand），最后会为每一个函数创建一个FKismetFunctionContext，用来后面对该函数的编译工作。

预编译函数

函数的预编译是通过为每一个FKismetFunctionContext调用PrecompileFunction()来实现的，这个函数主要做以下操作：

1. 确定执行顺序并计算数据依赖。
2. 去除那些没有连接的或者无数据依赖的节点。
3. 为每一个剩下的运行每一个节点处理器（FNodeHandlingFunctor）的RegisterNets()函数，它会为函数中的值创建FBPTerminal。
4. 创建UFunction对象和相关的属性。

绑定和链接类

现在类已经拥有了UFunctions和UProperties，现在可以绑定和链接类了，它包含填充属性链，属性大小 以及函数的列表。这个时候它相关于有了一个类头文件，不包括最终的标记、元数据以及CDO对象。

编译函数

接下来就需要通过每一个节点处理器（FNodeHanlingFunctor）的Compile()函数使用AppendStatementForNode()函数来为该节点添加FKismetBlueprintStatement。这个函数也可能会创建FBPTerminal对象只要它们只是局部使用的。

后编译函数

PostCompileFunction()是编译函数的最后一个阶段，在所有函数调用了CompileFunction()之后调用，主要是修复交叉引用。

完成编译类

为了完成编译该类，编译器会最终设置类标记，并从父类继承标记和元数据，最后会确定所有的事情在编译过程中是正确的。

后端生成代码

编译器后端会把函数中的所有语句转换成代码，目前有两个使用的后端：

1. FKismetCompilerVMBackend 把FKismetCompilerStatement转成字节码，并把它序列化到脚本数组中。

1. FKismetCppBackend 生成C++代码，只用于调试目的。

字节码

字节码的定义在Script.h中的EExprToken枚举中，定义如下，可以看到它有一些比较通用的指令，如EX_Jump EX_JumpIfNot等，也有一些专用的指令比如EX_DynamicCast EX_SetArray。

　　　　

//

// Evaluatable expression item types.

//

enum EExprToken

{

    // Variable references.

    EX_LocalVariable        = 0x00,    // A local variable.

    EX_InstanceVariable        = 0x01,    // An object variable.

    EX_DefaultVariable        = 0x02, // Default variable for a class context.

    //                        = 0x03,

    EX_Return                = 0x04,    // Return from function.

    //                        = 0x05,

    EX_Jump                    = 0x06,    // Goto a local address in code.

    EX_JumpIfNot            = 0x07,    // Goto if not expression.

    //                        = 0x08,

    EX_Assert                = 0x09,    // Assertion.

    //                        = 0x0A,

    EX_Nothing                = 0x0B,    // No operation.

    //                        = 0x0C,

    //                        = 0x0D,

    //                        = 0x0E,

    EX_Let                    = 0x0F,    // Assign an arbitrary size value to a variable.

    //                        = 0x10,

    //                        = 0x11,

    EX_ClassContext            = 0x12,    // Class default object context.

    EX_MetaCast = 0x13, // Metaclass cast.

    EX_LetBool                = 0x14, // Let boolean variable.

    EX_EndParmValue            = 0x15,    // end of default value for optional function parameter

    EX_EndFunctionParms        = 0x16,    // End of function call parameters.

    EX_Self                    = 0x17,    // Self object.

    EX_Skip                    = 0x18,    // Skippable expression.

    EX_Context                = 0x19,    // Call a function through an object context.

    EX_Context_FailSilent    = 0x1A, // Call a function through an object context (can fail silently if the context is NULL; only generated for functions that don't have output or return values).

    EX_VirtualFunction        = 0x1B,    // A function call with parameters.

    EX_FinalFunction        = 0x1C,    // A prebound function call with parameters.

    EX_IntConst                = 0x1D,    // Int constant.

    EX_FloatConst            = 0x1E,    // Floating point constant.

    EX_StringConst            = 0x1F,    // String constant.

    EX_ObjectConst         = 0x20,    // An object constant.

    EX_NameConst            = 0x21,    // A name constant.

    EX_RotationConst        = 0x22,    // A rotation constant.

    EX_VectorConst            = 0x23,    // A vector constant.

    EX_ByteConst            = 0x24,    // A byte constant.

    EX_IntZero                = 0x25,    // Zero.

    EX_IntOne                = 0x26,    // One.

    EX_True                    = 0x27,    // Bool True.

    EX_False                = 0x28,    // Bool False.

    EX_TextConst            = 0x29, // FText constant

    EX_NoObject                = 0x2A,    // NoObject.

    EX_TransformConst        = 0x2B, // A transform constant

    EX_IntConstByte            = 0x2C,    // Int constant that requires 1 byte.

    EX_NoInterface            = 0x2D, // A null interface (similar to EX_NoObject, but for interfaces)

    EX_DynamicCast            = 0x2E,    // Safe dynamic class casting.

    EX_StructConst            = 0x2F, // An arbitrary UStruct constant

    EX_EndStructConst        = 0x30, // End of UStruct constant

    EX_SetArray                = 0x31, // Set the value of arbitrary array

    EX_EndArray                = 0x32,

    //                        = 0x33,

    EX_UnicodeStringConst = 0x34, // Unicode string constant.

    EX_Int64Const            = 0x35,    // 64-bit integer constant.

    EX_UInt64Const            = 0x36,    // 64-bit unsigned integer constant.

    //                        = 0x37,

    EX_PrimitiveCast        = 0x38,    // A casting operator for primitives which reads the type as the subsequent byte

    //                        = 0x39,

    //                        = 0x3A,

    //                        = 0x3B,

    //                        = 0x3C,

    //                        = 0x3D,

    //                        = 0x3E,

    //                        = 0x3F,

    //                        = 0x40,

    //                        = 0x41,

    EX_StructMemberContext    = 0x42, // Context expression to address a property within a struct

    EX_LetMulticastDelegate    = 0x43, // Assignment to a multi-cast delegate

    EX_LetDelegate            = 0x44, // Assignment to a delegate

    //                        = 0x45,

    //                        = 0x46, // CST_ObjectToInterface

    //                        = 0x47, // CST_ObjectToBool

    EX_LocalOutVariable        = 0x48, // local out (pass by reference) function parameter

    //                        = 0x49, // CST_InterfaceToBool

    EX_DeprecatedOp4A        = 0x4A,

    EX_InstanceDelegate        = 0x4B,    // const reference to a delegate or normal function object

    EX_PushExecutionFlow    = 0x4C, // push an address on to the execution flow stack for future execution when a EX_PopExecutionFlow is executed. Execution continues on normally and doesn't change to the pushed address.

    EX_PopExecutionFlow        = 0x4D, // continue execution at the last address previously pushed onto the execution flow stack.

    EX_ComputedJump            = 0x4E,    // Goto a local address in code, specified by an integer value.

    EX_PopExecutionFlowIfNot = 0x4F, // continue execution at the last address previously pushed onto the execution flow stack, if the condition is not true.

    EX_Breakpoint            = 0x50, // Breakpoint. Only observed in the editor, otherwise it behaves like EX_Nothing.

    EX_InterfaceContext        = 0x51,    // Call a function through a native interface variable

    EX_ObjToInterfaceCast = 0x52,    // Converting an object reference to native interface variable

    EX_EndOfScript            = 0x53, // Last byte in script code

    EX_CrossInterfaceCast    = 0x54, // Converting an interface variable reference to native interface variable

    EX_InterfaceToObjCast = 0x55, // Converting an interface variable reference to an object

    //                        = 0x56,

    //                        = 0x57,

    //                        = 0x58,

    //                        = 0x59,

    EX_WireTracepoint        = 0x5A, // Trace point. Only observed in the editor, otherwise it behaves like EX_Nothing.

    EX_SkipOffsetConst        = 0x5B, // A CodeSizeSkipOffset constant

    EX_AddMulticastDelegate = 0x5C, // Adds a delegate to a multicast delegate's targets

    EX_ClearMulticastDelegate = 0x5D, // Clears all delegates in a multicast target

    EX_Tracepoint            = 0x5E, // Trace point. Only observed in the editor, otherwise it behaves like EX_Nothing.

    EX_LetObj                = 0x5F,    // assign to any object ref pointer

    EX_LetWeakObjPtr        = 0x60, // assign to a weak object pointer

    EX_BindDelegate            = 0x61, // bind object and name to delegate

    EX_RemoveMulticastDelegate = 0x62, // Remove a delegate from a multicast delegate's targets

    EX_CallMulticastDelegate = 0x63, // Call multicast delegate

    EX_LetValueOnPersistentFrame = 0x64,

    EX_ArrayConst            = 0x65,

    EX_EndArrayConst        = 0x66,

    EX_AssetConst            = 0x67,

    EX_CallMath                = 0x68, // static pure function from on local call space

    EX_SwitchValue            = 0x69,

    EX_InstrumentationEvent    = 0x6A, // Instrumentation event

    EX_ArrayGetByRef        = 0x6B,

    EX_Max                    = 0x100,

};

拷贝类默认对象（CDO）属性

使用一个特殊的函数CopyPropertiesForUnrelatedObjects()，编译器把类旧CDO中的值拷贝到新的CDO中。属性是通过带标记的序列化来拷贝的，只要名字是一致的，它们就应该被正确的复制。CDO中的组件会重新实例化。

重新实例化

由于类可能已经改变大小或者属性已经添加或删除了，编译器需要重新实例化该类实例化的所有对象。它使用TOjbectIterator来找到该类的实例，创建一个新的，并且使用CopyPropertiesForUnrelatedObjects()函数来把旧实例的数据拷贝到新的实例。详细信息参照FBlueprintCompileReinstancer类。

编译实例学习

我在蓝图里面新建了一个继承自Actor的NewBlueprint，它有一个变量StringTest并且实现了一个BeginPlay 事件和一个FunctionTest()函数，这个函数有一个局部变量LocalStringTest。

下面分别是BeginPlay和FunctionTest的定义：

为了看到编译的结果，我们需要修改BaseEngine.ini中的设置把CompileDisplaysBinaryBackend设置为true，如果要显示生成的cpp文件，也可以把CompileDisplaysTextBackend设置为true。注意需要重新启动编辑器。点击编译后在OutputLog中得到的结果如下代码所示：

　　　　

BlueprintLog: New page: Compile NewBlueprint

LogK2Compiler: [function ExecuteUbergraph_NewBlueprint]:

Label_0x0:

$4E: Computed Jump, offset specified by expression:

$0: Local variable named EntryPoint

Label_0xA:

$5E: .. debug site ..

Label_0xB:

$5A: .. wire debug site ..

Label_0xC:

$5E: .. debug site ..

Label_0xD:

$1B: Virtual Function named FunctionTest

$0: Local variable named CallFunc_FunctionTest_OutNewString

$16: EX_EndFunctionParms

Label_0x24:

$5A: .. wire debug site ..

Label_0x25:

$5E: .. debug site ..

Label_0x26:

$19: Context

ObjectExpression:

$20: EX_ObjectConst (000000003022A100:KismetSystemLibrary /Script/Engine.Default__KismetSystemLibrary)

Skip Bytes: 0x3D

R-Value Property: (null)

ContextExpression:

$1C: Final Function (stack node KismetSystemLibrary::PrintString)

$17: EX_Self

$0: Local variable named CallFunc_FunctionTest_OutNewString

$28: EX_False

$27: EX_True

$2F: literal struct LinearColor (serialized size: 16)

$1E: literal float 0.000000

$1E: literal float 0.660000

$1E: literal float 1.000000

$1E: literal float 1.000000

$30: EX_EndStructConst

$1E: literal float 2.000000

$16: EX_EndFunctionParms

Label_0x79:

$5A: .. wire debug site ..

Label_0x7A:

$4: Return expression

$B: EX_Nothing

Label_0x7C:

$53: EX_EndOfScript

LogK2Compiler: [function ReceiveBeginPlay]:

Label_0x0:

$1B: Virtual Function named ExecuteUbergraph_NewBlueprint

$1D: literal int32 10

$16: EX_EndFunctionParms

Label_0x13:

$4: Return expression

$B: EX_Nothing

Label_0x15:

$53: EX_EndOfScript

LogK2Compiler: [function UserConstructionScript]:

Label_0x0:

$5E: .. debug site ..

Label_0x1:

$5A: .. wire debug site ..

Label_0x2:

$4: Return expression

$B: EX_Nothing

Label_0x4:

$53: EX_EndOfScript

LogK2Compiler: [function FunctionTest]:

Label_0x0:

$5E: .. debug site ..

Label_0x1:

$5A: .. wire debug site ..

Label_0x2:

$5E: .. debug site ..

Label_0x3:

$F: Let (Variable = Expression)

Variable:

$0: Local variable named LocalStringTest

Expression:

$1F: literal ansi string "Bluepirnt Test: "

Label_0x27:

$5A: .. wire debug site ..

Label_0x28:

$F: Let (Variable = Expression)

Variable:

$0: Local variable named CallFunc_Concat_StrStr_ReturnValue

Expression:

$19: Context

ObjectExpression:

$20: EX_ObjectConst (0000000030229B00:KismetStringLibrary /Script/Engine.Default__KismetStringLibrary)

Skip Bytes: 0x1C

R-Value Property: CallFunc_Concat_StrStr_ReturnValue

ContextExpression:

$1C: Final Function (stack node KismetStringLibrary::Concat_StrStr)

$0: Local variable named LocalStringTest

$1: Instance variable named StringTest

$16: EX_EndFunctionParms

Label_0x6C:

$5E: .. debug site ..

Label_0x6D:

$F: Let (Variable = Expression)

Variable:

$48: Local out variable named OutNewString

Expression:

$0: Local variable named CallFunc_Concat_StrStr_ReturnValue

Label_0x88:

$5A: .. wire debug site ..

Label_0x89:

$4: Return expression

$B: EX_Nothing

Label_0x8B:

$53: EX_EndOfScript

有个需要说明的地方就是，我们可以看到事件ReceiveBeginPlay，如上面我们所说，它具体并没有做什么事情，整个函数的指令被放到了function ExecuteUbergraph_NewBlueprint中，而它所做的事情是调用了 Virtual Function named ExecuteUbergraph_NewBlueprint 并传递了一个int32的值，这个值是在ExecuteUbergraph_NewBlueprint处的偏移值，而在ExecuteUbergraph_NewBlueprint一开始就根据传进来的偏移值进行了无条件jump跳转到相应的位置进行程序的执行。

总结

至此，我们我们对蓝图的编译过程有了一个基本的了解，粗略地讲解了蓝图是如何从我们编辑的结果最终编译的过程，接下来的文章我们将介绍虚幻4中蓝图虚拟机的实现，敬请期待。当然由于本人理解能力有限，里面难免有错误的地方，如读者发现还请指正。

参考文档

1. https://docs.unrealengine.com/latest/INT/Engine/Blueprints/TechnicalGuide/Compiler/index.html
2. http://www.cnblogs.com/ghl_carmack/p/5804737.html
3. 脚本语言入门书籍 Game Scripting Mastery
4. http://blog.csdn.net/tangl_99/article/details/5600