脚本调试

发生编译期错误就意味着编译器无法编译并加载脚本。这种情况下，日志文件会出现包含下列信息的错误消息：

1. 使用无效语句的源码字符串。
2. 来自解译器对错误的描述消息。

花括号的错误配对是最常见的编译器错误。例如：

class Foo {		
	Foo(int a) {
		this.a = a;
	// 花括号结束符丢失
	~Foo() {}	
	
	void print() {
		log.message("a is %d\n",a);
	}
};

Parser::check_braces(): some errors with count of '{' and '}' symbols
Parser::preprocessor(): wrong number of braces

在众多明显的错误中例如不正确的语法，有一些不明显却更令人困惑的错误。最重要地是：

• 递归 includes不被追踪，因此在使用文件包时应当心，有怀疑时使用defines。
• 在用户类的定义中请确保在构造函数或方法中使用成员变量之前，这些成员变量得到声明。
  源代码 (UnigineScript)

  class Foo {		
  	Foo(int a) {
  		this.a = a;
  	}	
  	
  	~Foo() {}	
  	
  	void print() {
  		log.message("a is %d\n",a);
  	}
  };

  变量a未被声明，因此会产生一个错误：
  输出

  Interpreter::parse(): unknown "Foo" class member "a"

• 下列表达式及类似的复杂表达式会导致错误：
  源代码 (UnigineScript)

  object.doSomething().doSomethingElse();
  object.doSomething()[4];

  对于第一个表达式，会出现下列错误消息：
  输出

  Parser::expectSymbol(): bad '.' symbol expecting end of string

  对于第二个表达式，错误信息为：
  输出

  Parser::expectSymbol(): bad '[' symbol expecting end of string

  关键在于因为动态输入方式，解译器不知道通过object.doSomething()将返回什么结果或者什么都不返回，这样可能会导致运行期间的错误。

出现运行期错误通常意味着您试图操作一个已被损坏甚至不存在的对象。这种情况下，日志文件会出现包含下列内容的错误信息：

1. 解译器对错误的描述。
2. 函数调用的当前堆栈。
3. 无效表达式的组装转储。

Interpreter::run(): "int: 0" is not an extern class
Call stack:
00: 0x0001a84c update()
01: 0x00016565 nodesUpdate()
02: 0x0001612c Nodes::update()
Disassemble:
0x00016134: callecf  Node.getName
0x00016137: pop
0x00016138: pushv    parameters_tb
0x0001613a: callecf  WidgetTabBox.getCurrentTab

常见运行期错误：

• NULL objects.请记得初始化声明的对象并检查函数返回的值。
• 当为函数提供比需求更少（或更多）的参数时，堆栈下溢（或上溢）。
• 动态输入允许将某种类型的值分配给另一种类型的变量，例如：
  源代码 (UnigineScript)

  // 下列操作可行
  Object object = new ObjectMesh("file.mesh");
  object = new LightWorld(vec4_one);

  然而人们似乎忘记他们为变量分配的内容并调用不合适的方法：
  源代码 (UnigineScript)

  // 下列操作不可行，因为对象不再具有ObjectMesh类型
  Material m = object.getMaterial(0);

  这种情况下，错误信息是：
  输出

  ExternClass::run_function(): can't find "class Object * __ptr64" base class in "class LightWorld * __ptr64" class

• 在创建矢量时，请确保留有足够的容量（非负）。如果指定地是负值，默认情况下将矢量尺寸设置为0。

  当然在处理矢量内容时，请确保存在使用的索引。对于贴图及键也如此。但贴图的键不能为空。

  源代码 (UnigineScript)

  int vector[2] =	( 1, 2, 3 );	// 定义3个元素的矢量
  log.message("%d\n", vector[4]);	// 处理不存在的第4个组件

  这种情况下，错误信息为：
  输出

  UserArray::get(): bad array index 4

• 请确保使用具有合适对象的正确 swizzles。例如不能使用具有标量类型的swizzles。
  源代码 (UnigineScript)

  int a = 10;	// 标量类型值
  log.message("%d\n", a.x); // swizzling

  此示例会生成下列错误信息：
  输出

  Variable::getSwizzle(): bad component 0 for int variable

• 如果某个用户类重载了一些运算符，记得在代码中保留运算对象的顺序：
  源代码 (UnigineScript)

  class Foo {
  	int f;
  	Foo(int f = 0) {
  		this.f = f;
  	}
  	int operator+(Foo arg1,int arg2) {
  		return arg1.f + arg2;
  	}
  };
  
  //这样可行
  int ret = new Foo() + 5;
  
  // 这样不可行
  ret = 5 + new Foo();

  此实例会产生一个错误：
  输出

  Variable::add(): bad operands int and user class

• 请确保在类的方法中使用了wait控制结构，这种类的方法会作为静态方法得到调用。
  源代码 (UnigineScript)

  class Foo {
  
  	void update() { 
  		while(true) wait 1; 
  	}
  };
   
  Foo f = new Foo();
  Foo::update();		// 此操作有效，因为此方法会被作为静态函数进行调用
  f.update();		// 这样会造成冲突因为会传递一个类的实例

  错误信息为：
  输出

  Interpreter::runFunction(): depth of stack is not zero

• 在使用class_cast()时应当心。请记住此函数会将用户类的实例在毫无警告的情况下转换成另一种类型，即使这些类之间毫无共同之处。
• 大量临时对象。这并不是一种错误，但如果在短期内创建了大量迅速成为未使用的用户类，由于垃圾回收器的原因，每播放32帧性能便会出现下降直到不存在未使用对象为止。这种情况下，大量的对象及昂贵的对象析构会造成性能下降。

要调用控制台调试程序，在当前使用的脚本中插入断点；指令。使用这种指令类型是为了精确地放置断点。可在脚本中插入一个以上的断点指令。

例如：

int a = 10;
breakpoint;	// 断点指令
int b = 1;
forloop(int i = 0; a){
	b += i;
	log.message("Iteration: %d\n",i);
	log.message("Value: %d\n",b);
}

如果遇到断点，引擎会停止执行动作，应用程序会停止对用户动作作出反应。相反地，外部控制台开始接收用户的输入。

在此控制台中，可使用下一个命令通过指令进行步测。当然也可在调试过程中通过break命令设置断点。 比如在调试循环时，断点就十分有用。或者在有必要的情况下，可以运行另一个调试程序命令。

如果控制台不可用，如在Windows内发布构建一样，这样看起来仿佛引擎意外停止一样。为避免这种情况出现，需使用在data/core/unigine.h文件中定义的“断点”宏指令。此指令可通过正确的方式将FPS 的值进行保存。

也可通过编辑器控制台使用指定数量的参数为每个函数设置运行编译器断点。由于所需脚本指令会被触发用于断点，因此引擎停止执行动作且外部控制台开始接收用户的输入。此外也可在调试程序内设置断点标记。

这样的断点共有3种类型：system_breakpoint， world_breakpoint 和 editor_breakpoint分别用于 系统，世界和编辑器脚本。

设置断点的语法如下： system_breakpoint/world_breakpoint/editor_breakpoint 设置/移除 function_name number_of_arguments。

例如，要在自定义函数上使用0参数设置printMyMessage()，需在编辑器控制台 中输入下列内容：

world_breakpoint set printMyMessage 0

调试程序也支持有限的自动补齐及历史命令。

有了调试程序，就不能：

• 调用函数。
• 对任意表达式进行求值。
• 使用任意键检索贴图 值。仅支持 整型 ， 浮点型 和 字符串型 。

调试程序支持下列所列出的数种控制台命令。

help

help#

run

run#

next

next#

breakpoint;	// 此处设置断点
int a = 10;	
int b = 1;
int vector [3] = ( 1, 2, 3, 4);
forloop(int i = 0; a){
	b += i;
	log.message("Iteration: %d\n",i);
	log.message("Value: %d\n",b);
}

Breakpoint at 0x00000455: setvc a = int: 10
# next
Breakpoint at 0x00000458: setvc b = int: 1

stack

stack#

calls

calls#

dasm

dasm#

# dasm
Disassemble:
0x00000465: addvv	b i
0x00000468: popv	b
0x0000046a: pushv	i
0x0000046c: pushc	string: "Iteration: %d\n"
0x0000046e: callefr	log.message
0x00000470: pushv	b
0x00000472: pushc	string: "Value: %d\n"
0x00000474: callefr	log.message

info

info#

# info a b vector
a: int: 3
b: int: 1
vector: Vector of 4 elements
0: int: 1
1: int: 2
2: int: 3
3: int: 4
# info vector[1]
vector[1]: int: 2

list

list#

fault

fault#

break

break#

int a = 10;
int b = 1;
forloop(int i = 0; a){
	b += i;
	log.message("Iteration: %d\n",i);
	log.message("Value: %d\n",b);
}

Breakpoint at 0x00000455: setvc a = int: 10
# next
Breakpoint at 0x00000458: setvc b = int: 1
# break

Disassemble:
0x00000458: ! setvc	b = int: 1
0x00000468:	  setvc	i = int: 0

Breakpoint at 0x00000455: setvc a = int: 10
# next
Breakpoint at 0x00000458: setvc b = int: 1
# break
# break

下方为汇编助记符列表用于组装转储。

设置操作：

0x00000458: setvc b = int: 1

Pop operations:

0x00000468: popv	b

推送操作：

0x0000046c: pushc	string: "Iteration: %d\n"

调用操作：

0x0000046e: callefr	log.message

数学运算：

0x0000044c: mulvc	a int: 1

0x0000044c: mulvc	a int: 2

0x0000046b: shlc	int: 1

0x00000462: borvv	a b

0x00000461: lev	b

转移操作：

0x00000456: jnevv	a b 0x0000045f

循环：