Use typedefs in html5.h for referring to callback function pointers instead of passing the function pointer types in the function declaration to avoid Sphinx doc parser from getting confused during parsing.

Author: juj

system/include/emscripten/html5.h

@@ -168,9 +168,10 @@ typedef struct EmscriptenKeyboardEvent {
  * See https://developer.mozilla.org/en/DOM/Event/UIEvent/KeyEvent
  * and http://www.javascriptkit.com/jsref/eventkeyboardmouse.shtml
  */
-extern EMSCRIPTEN_RESULT emscripten_set_keypress_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenKeyboardEvent *keyEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_keydown_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenKeyboardEvent *keyEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_keyup_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenKeyboardEvent *keyEvent, void *userData));
+typedef EM_BOOL (*em_key_callback_func)(int eventType, const EmscriptenKeyboardEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_keypress_callback(const char *target, void *userData, EM_BOOL useCapture, em_key_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_keydown_callback(const char *target, void *userData, EM_BOOL useCapture, em_key_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_keyup_callback(const char *target, void *userData, EM_BOOL useCapture, em_key_callback_func callback);
 
 /*
  * The event structure passed in mouse events click, mousedown, mouseup, dblclick and mousemove.
@@ -209,11 +210,12 @@ typedef struct EmscriptenMouseEvent {
  * Registers a callback function for receiving browser-generated mouse input events.
  * See https://developer.mozilla.org/en/DOM/MouseEvent
  */
-extern EMSCRIPTEN_RESULT emscripten_set_click_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenMouseEvent *mouseEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_mousedown_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenMouseEvent *mouseEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_mouseup_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenMouseEvent *mouseEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_dblclick_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenMouseEvent *mouseEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_mousemove_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenMouseEvent *mouseEvent, void *userData));
+typedef EM_BOOL (*em_mouse_callback_func)(int eventType, const EmscriptenMouseEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_click_callback(const char *target, void *userData, EM_BOOL useCapture, em_mouse_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_mousedown_callback(const char *target, void *userData, EM_BOOL useCapture, em_mouse_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_mouseup_callback(const char *target, void *userData, EM_BOOL useCapture, em_mouse_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_dblclick_callback(const char *target, void *userData, EM_BOOL useCapture, em_mouse_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_mousemove_callback(const char *target, void *userData, EM_BOOL useCapture, em_mouse_callback_func callback);
 /*
  * Returns the most recently received mouse event state. Note that for this function call to succeed, emscripten_set_xx_callback must have first
  * been called with one of the mouse event types and a non-zero callback function pointer to enable the Mouse state capture.
@@ -243,7 +245,8 @@ typedef struct EmscriptenWheelEvent {
  * Registers a callback function for receiving browser-generated mouse wheel events.
  * See http://www.w3.org/TR/DOM-Level-3-Events/#event-type-wheel
  */
-extern EMSCRIPTEN_RESULT emscripten_set_wheel_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenWheelEvent *wheelEvent, void *userData));
+typedef EM_BOOL (*em_wheel_callback_func)(int eventType, const EmscriptenWheelEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_wheel_callback(const char *target, void *userData, EM_BOOL useCapture, em_wheel_callback_func callback);
 
 /*
  * The event structure passed in DOM element resize and scroll events.
@@ -273,8 +276,9 @@ typedef struct EmscriptenUiEvent {
  *       requires that the Window object sends resize events. It is valid to register a resize callback to other DOM elements,
  *       but the browser is not required to fire resize events on them.
  */
-extern EMSCRIPTEN_RESULT emscripten_set_resize_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenUiEvent *uiEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_scroll_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenUiEvent *uiEvent, void *userData));
+typedef EM_BOOL (*em_ui_callback_func)(int eventType, const EmscriptenUiEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_resize_callback(const char *target, void *userData, EM_BOOL useCapture, em_ui_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_scroll_callback(const char *target, void *userData, EM_BOOL useCapture, em_ui_callback_func callback);
 
 /*
  * The event structure passed in DOM element blur, focus, focusin and focusout events.
@@ -291,10 +295,11 @@ typedef struct EmscriptenFocusEvent {
  * Registers a callback function for receiving DOM element blur, focus, focusin and focusout events.
  * See https://dvcs.w3.org/hg/dom3events/raw-file/tip/html/DOM3-Events.html#event-type-blur
  */
-extern EMSCRIPTEN_RESULT emscripten_set_blur_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenFocusEvent *focusEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_focus_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenFocusEvent *focusEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_focusin_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenFocusEvent *focusEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_focusout_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenFocusEvent *focusEvent, void *userData));
+typedef EM_BOOL (*em_focus_callback_func)(int eventType, const EmscriptenFocusEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_blur_callback(const char *target, void *userData, EM_BOOL useCapture, em_focus_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_focus_callback(const char *target, void *userData, EM_BOOL useCapture, em_focus_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_focusin_callback(const char *target, void *userData, EM_BOOL useCapture, em_focus_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_focusout_callback(const char *target, void *userData, EM_BOOL useCapture, em_focus_callback_func callback);
 
 /*
  * The event structure passed in the deviceorientation event.
@@ -315,7 +320,8 @@ typedef struct EmscriptenDeviceOrientationEvent {
  * Registers a callback function for receiving the deviceorientation event.
  * See http://dev.w3.org/geo/api/spec-source-orientation.html
  */
-extern EMSCRIPTEN_RESULT emscripten_set_deviceorientation_callback(void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenDeviceOrientationEvent *orientationEvent, void *userData));
+typedef EM_BOOL (*em_deviceorientation_callback_func)(int eventType, const EmscriptenDeviceOrientationEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_deviceorientation_callback(void *userData, EM_BOOL useCapture, em_deviceorientation_callback_func callback);
 /*
  * Returns the most recently received deviceorientation event state. Note that for this function call to succeed, emscripten_set_deviceorientation_callback
  * must have first been called with one of the mouse event types and a non-zero callback function pointer to enable the Device Orientation state capture.
@@ -347,7 +353,8 @@ typedef struct EmscriptenDeviceMotionEvent {
  * Registers a callback function for receiving the devicemotion event.
  * See http://dev.w3.org/geo/api/spec-source-orientation.html
  */
-extern EMSCRIPTEN_RESULT emscripten_set_devicemotion_callback(void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenDeviceMotionEvent *motionEvent, void *userData));
+typedef EM_BOOL (*em_devicemotion_callback_func)(int eventType, const EmscriptenDeviceMotionEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_devicemotion_callback(void *userData, EM_BOOL useCapture, em_devicemotion_callback_func callback);
 /*
  * Returns the most recently received deviceomotion event state. Note that for this function call to succeed, emscripten_set_devicemotion_callback
  * must have first been called with one of the mouse event types and a non-zero callback function pointer to enable the Device Motion state capture.
@@ -375,7 +382,8 @@ typedef struct EmscriptenOrientationChangeEvent {
  * Registers a callback function for receiving the orientationchange event.
  * https://dvcs.w3.org/hg/screen-orientation/raw-file/tip/Overview.html
  */
-extern EMSCRIPTEN_RESULT emscripten_set_orientationchange_callback(void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenOrientationChangeEvent *orientationChangeEvent, void *userData));
+typedef EM_BOOL (*em_orientationchange_callback_func)(int eventType, const EmscriptenOrientationChangeEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_orientationchange_callback(void *userData, EM_BOOL useCapture, em_orientationchange_callback_func callback);
 /*
  * Returns the current device orientation state.
  */
@@ -416,7 +424,8 @@ typedef struct EmscriptenFullscreenChangeEvent {
  * Registers a callback function for receiving the fullscreenchange event.
  * https://dvcs.w3.org/hg/screen-orientation/raw-file/tip/Overview.html
  */
-extern EMSCRIPTEN_RESULT emscripten_set_fullscreenchange_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenFullscreenChangeEvent *fullscreenChangeEvent, void *userData));
+typedef EM_BOOL (*em_fullscreenchange_callback_func)(int eventType, const EmscriptenFullscreenChangeEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_fullscreenchange_callback(const char *target, void *userData, EM_BOOL useCapture, em_fullscreenchange_callback_func callback);
 /*
  * Returns the current page fullscreen state.
  */
@@ -452,7 +461,8 @@ typedef struct EmscriptenPointerlockChangeEvent {
  * Pointer lock hides the mouse cursor and exclusively gives the target element relative mouse movement events via the mousemove event.
  * http://www.w3.org/TR/pointerlock/
  */
-extern EMSCRIPTEN_RESULT emscripten_set_pointerlockchange_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenPointerlockChangeEvent *pointerlockChangeEvent, void *userData));
+typedef EM_BOOL (*em_pointerlockchange_callback_func)(int eventType, const EmscriptenPointerlockChangeEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_pointerlockchange_callback(const char *target, void *userData, EM_BOOL useCapture, em_pointerlockchange_callback_func callback);
 /*
  * Returns the current page pointerlock state.
  */
@@ -490,7 +500,8 @@ typedef struct EmscriptenVisibilityChangeEvent {
  * Registers a callback function for receiving the visibilitychange event.
  * http://www.w3.org/TR/page-visibility/
  */
-extern EMSCRIPTEN_RESULT emscripten_set_visibilitychange_callback(void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenVisibilityChangeEvent *visibilityChangeEvent, void *userData));
+typedef EM_BOOL (*em_visibilitychange_callback_func)(int eventType, const EmscriptenVisibilityChangeEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_visibilitychange_callback(void *userData, EM_BOOL useCapture, em_visibilitychange_callback_func callback);
 /*
  * Returns the current page visibility state.
  */
@@ -542,10 +553,11 @@ typedef struct EmscriptenTouchEvent {
  * Registers a callback function for receiving the touchstart, touchend, touchmove and touchcancel events.
  * http://www.w3.org/TR/touch-events/
  */
-extern EMSCRIPTEN_RESULT emscripten_set_touchstart_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenTouchEvent *touchEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_touchend_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenTouchEvent *touchEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_touchmove_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenTouchEvent *touchEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_touchcancel_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenTouchEvent *touchEvent, void *userData));
+typedef EM_BOOL (*em_touch_callback_func)(int eventType, const EmscriptenTouchEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_touchstart_callback(const char *target, void *userData, EM_BOOL useCapture, em_touch_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_touchend_callback(const char *target, void *userData, EM_BOOL useCapture, em_touch_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_touchmove_callback(const char *target, void *userData, EM_BOOL useCapture, em_touch_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_touchcancel_callback(const char *target, void *userData, EM_BOOL useCapture, em_touch_callback_func callback);
 
 /*
  * Represents the current snapshot state of a gamepad.
@@ -578,8 +590,9 @@ typedef struct EmscriptenGamepadEvent {
  * Registers a callback function for receiving the gamepadconnected and gamepaddisconnected events.
  * http://www.w3.org/TR/gamepad/
  */
-extern EMSCRIPTEN_RESULT emscripten_set_gamepadconnected_callback(void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenGamepadEvent *gamepadEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_gamepaddisconnected_callback(void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const EmscriptenGamepadEvent *gamepadEvent, void *userData));
+typedef EM_BOOL (*em_gamepad_callback_func)(int eventType, const EmscriptenGamepadEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_gamepadconnected_callback(void *userData, EM_BOOL useCapture, em_gamepad_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_gamepaddisconnected_callback(void *userData, EM_BOOL useCapture, em_gamepad_callback_func callback);
 
 /*
  * Returns the number of gamepads connected to the system or EMSCRIPTEN_RESULT_NOT_SUPPORTED if the current browser does not support gamepads.
@@ -606,8 +619,9 @@ typedef struct EmscriptenBatteryEvent {
  * Registers a callback function for receiving the battery chargingchange and levelchange events.
  * http://www.w3.org/TR/battery-status/
  */
-extern EMSCRIPTEN_RESULT emscripten_set_batterychargingchange_callback(void *userData, EM_BOOL (*func)(int eventType, const EmscriptenBatteryEvent *batteryEvent, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_batterylevelchange_callback(void *userData, EM_BOOL (*func)(int eventType, const EmscriptenBatteryEvent *batteryEvent, void *userData));
+typedef EM_BOOL (*em_battery_callback_func)(int eventType, const EmscriptenBatteryEvent *keyEvent, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_batterychargingchange_callback(void *userData, em_battery_callback_func callback);
+extern EMSCRIPTEN_RESULT emscripten_set_batterylevelchange_callback(void *userData, em_battery_callback_func callback);
 /*
  * Returns the current battery status.
  */
@@ -631,14 +645,16 @@ extern EMSCRIPTEN_RESULT emscripten_vibrate_pattern(int *msecsArray, int numEntr
  * Hook onto this event to perform process right prior to page close, and/or display a confirmation notification asking if the user really wants to leave the page.
  * http://www.whatwg.org/specs/web-apps/current-work/multipage/history.html#beforeunloadevent
  */
-extern EMSCRIPTEN_RESULT emscripten_set_beforeunload_callback(void *userData, const char *(*func)(int eventType, const void *reserved, void *userData));
+typedef const char *(*em_beforeunload_callback)(int eventType, const void *reserved, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_beforeunload_callback(void *userData, em_beforeunload_callback callback);
 
 /*
  * Registers a callback function for the canvas webgl context webglcontextlost and webglcontextrestored events.
  * See http://www.khronos.org/registry/webgl/specs/latest/1.0/#5.15.2
  */
-extern EMSCRIPTEN_RESULT emscripten_set_webglcontextlost_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const void *reserved, void *userData));
-extern EMSCRIPTEN_RESULT emscripten_set_webglcontextrestored_callback(const char *target, void *userData, EM_BOOL useCapture, EM_BOOL (*func)(int eventType, const void *reserved, void *userData));
+typedef EM_BOOL (*em_webgl_context_callback)(int eventType, const void *reserved, void *userData);
+extern EMSCRIPTEN_RESULT emscripten_set_webglcontextlost_callback(const char *target, void *userData, EM_BOOL useCapture, em_webgl_context_callback callback);
+extern EMSCRIPTEN_RESULT emscripten_set_webglcontextrestored_callback(const char *target, void *userData, EM_BOOL useCapture, em_webgl_context_callback callback);
 
 /*
  * Queries the given canvas element for whether its WebGL context is in a lost state.