[[ Emscripten ]] Add warning above all emterpreted functions

livecodeali · livecodeali · commit 740c3ab90106 · 2017-05-03T16:31:57.000+01:00
Whenever the signature of these functions changes, the emterpreter
whitelist needs to be updated.
diff --git a/engine/src/dispatch.cpp b/engine/src/dispatch.cpp
@@ -1266,6 +1266,9 @@ void send_relaunch(void)
 #endif
 }
 
+// Important: This function is on the emterpreter whitelist. If its
+// signature function changes, the mangled name must be updated in
+// em-whitelist.json
 void send_startup_message(bool p_do_relaunch = true)
 {
 	if (p_do_relaunch)
diff --git a/engine/src/dskmain.cpp b/engine/src/dskmain.cpp
@@ -339,6 +339,9 @@ bool X_init(const X_init_options& p_options)
 	return true;
 }
 
+// Important: This function is on the emterpreter whitelist. If its
+// signature function changes, the mangled name must be updated in
+// em-whitelist.json
 bool X_main_loop_iteration()
 {
     void *t_bottom;
diff --git a/engine/src/em-dc-mainloop.cpp b/engine/src/em-dc-mainloop.cpp
@@ -126,6 +126,9 @@ X_initialize_mcappcodepath(const X_init_options& p_options)
                           nullptr);
 }
 
+// Important: This function is on the emterpreter whitelist. If its
+// signature function changes, the mangled name must be updated in
+// em-whitelist.json
 bool
 X_init(const X_init_options& p_options)
 {
diff --git a/engine/src/em-dc.cpp b/engine/src/em-dc.cpp
@@ -171,6 +171,10 @@ MCScreenDC::GetCurrentStack()
  * Event loop
  * ================================================================ */
 
+// Important: This function is on the emterpreter whitelist. If its
+// signature function changes, the mangled name must be updated in
+// em-whitelist.json
+
 /* Returns true if quit is requested, or from any inner main loop. */
 Boolean
 MCScreenDC::wait(real64_t p_duration,
diff --git a/engine/src/eventqueue.cpp b/engine/src/eventqueue.cpp
@@ -255,6 +255,9 @@ void MCEventQueueFinalize(void)
 
 ////////////////////////////////////////////////////////////////////////////////
 
+// Important: This function is on the emterpreter whitelist. If its
+// signature function changes, the mangled name must be updated in
+// em-whitelist.json
 static void MCEventQueueDispatchEvent(MCEvent *p_event)
 {
 	MCEvent *t_event;
diff --git a/engine/src/globals.cpp b/engine/src/globals.cpp
@@ -1053,6 +1053,9 @@ X_open_environment_variables(MCStringRef envp[])
 
 /* ---------------------------------------------------------------- */
 
+// Important: This function is on the emterpreter whitelist. If its
+// signature function changes, the mangled name must be updated in
+// em-whitelist.json
 bool X_open(int argc, MCStringRef argv[], MCStringRef envp[])
 {
 	MCperror = new (nothrow) MCError();
diff --git a/engine/src/mode_standalone.cpp b/engine/src/mode_standalone.cpp
@@ -738,6 +738,9 @@ MCDispatch::startup()
 
 #else
 
+// Important: This function is on the emterpreter whitelist. If its
+// signature function changes, the mangled name must be updated in
+// em-whitelist.json
 IO_stat MCDispatch::startup(void)
 {
     char *t_mccmd;

Original file line number	Diff line number	Diff line change
`@@ -1266,6 +1266,9 @@ void send_relaunch(void)`
`1266`	`1266`	`#endif`
`1267`	`1267`	`}`
`1268`	`1268`
	`1269`	`+// Important: This function is on the emterpreter whitelist. If its`
	`1270`	`+// signature function changes, the mangled name must be updated in`
	`1271`	`+// em-whitelist.json`
`1269`	`1272`	`void send_startup_message(bool p_do_relaunch = true)`
`1270`	`1273`	`{`
`1271`	`1274`	`if (p_do_relaunch)`
Original file line number	Diff line number	Diff line change
`@@ -339,6 +339,9 @@ bool X_init(const X_init_options& p_options)`
`339`	`339`	`return true;`
`340`	`340`	`}`
`341`	`341`
	`342`	`+// Important: This function is on the emterpreter whitelist. If its`
	`343`	`+// signature function changes, the mangled name must be updated in`
	`344`	`+// em-whitelist.json`
`342`	`345`	`bool X_main_loop_iteration()`
`343`	`346`	`{`
`344`	`347`	`void *t_bottom;`
Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,9 @@ X_initialize_mcappcodepath(const X_init_options& p_options)`
`126`	`126`	`nullptr);`
`127`	`127`	`}`
`128`	`128`
	`129`	`+// Important: This function is on the emterpreter whitelist. If its`
	`130`	`+// signature function changes, the mangled name must be updated in`
	`131`	`+// em-whitelist.json`
`129`	`132`	`bool`
`130`	`133`	`X_init(const X_init_options& p_options)`
`131`	`134`	`{`
Original file line number	Diff line number	Diff line change
`@@ -255,6 +255,9 @@ void MCEventQueueFinalize(void)`
`255`	`255`
`256`	`256`	`////////////////////////////////////////////////////////////////////////////////`
`257`	`257`
	`258`	`+// Important: This function is on the emterpreter whitelist. If its`
	`259`	`+// signature function changes, the mangled name must be updated in`
	`260`	`+// em-whitelist.json`
`258`	`261`	`static void MCEventQueueDispatchEvent(MCEvent *p_event)`
`259`	`262`	`{`
`260`	`263`	`MCEvent *t_event;`
Original file line number	Diff line number	Diff line change
`@@ -1053,6 +1053,9 @@ X_open_environment_variables(MCStringRef envp[])`
`1053`	`1053`
`1054`	`1054`	`/* ---------------------------------------------------------------- */`
`1055`	`1055`
	`1056`	`+// Important: This function is on the emterpreter whitelist. If its`
	`1057`	`+// signature function changes, the mangled name must be updated in`
	`1058`	`+// em-whitelist.json`
`1056`	`1059`	`bool X_open(int argc, MCStringRef argv[], MCStringRef envp[])`
`1057`	`1060`	`{`
`1058`	`1061`	`MCperror = new (nothrow) MCError();`
Original file line number	Diff line number	Diff line change
`@@ -738,6 +738,9 @@ MCDispatch::startup()`
`738`	`738`
`739`	`739`	`#else`
`740`	`740`
	`741`	`+// Important: This function is on the emterpreter whitelist. If its`
	`742`	`+// signature function changes, the mangled name must be updated in`
	`743`	`+// em-whitelist.json`
`741`	`744`	`IO_stat MCDispatch::startup(void)`
`742`	`745`	`{`
`743`	`746`	`char *t_mccmd;`