Move create_dom_pk_codes to tools/maint. NFC (#24016)

Author: sbc100

pyproject.toml

@@ -80,13 +80,13 @@ conf\.py |
 emrun\.py |
 site/source/_themes/ |
 tools/scons/site_scons/site_tools/emscripten/__init__\.py |
+tools/maint/create_dom_pk_codes.py |
 site/source/get_wiki\.py |
 test/parse_benchmark_output\.py
 )'''
 
 [[tool.mypy.overrides]]
 module = [
-  "tools.create_dom_pk_codes",
   "tools.webidl_binder",
   "tools.toolchain_profiler",
   "tools.filelock",

system/include/emscripten/dom_pk_codes.h

@@ -5,10 +5,10 @@
  * found in the LICENSE file.
  *
  * This file was automatically generated from script
- * tools/create_dom_pk_codes.py. Edit that file to make changes here.
- * Run
+ * tools/maint/create_dom_pk_codes.py. Edit that file to make changes here.
+ * Then run:
  *
- *   tools/create_dom_pk_codes.py
+ *   tools/maint/create_dom_pk_codes.py
  *
  * in Emscripten root directory to regenerate this file.
  */

system/lib/html5/dom_pk_codes.c

@@ -1,27 +1,29 @@
-/* This file was automatically generated from script
-tools/create_dom_pk_codes.py. Edit that file to make changes here.
-Run
-
-  python tools/create_dom_pk_codes.py
-
-in Emscripten root directory to regenerate this file. */
+/*
+ * This file was automatically generated from script
+ * tools/maint/create_dom_pk_codes.py. Edit that file to make changes here.
+ * Then run:
+ *
+ *  tools/maint/create_dom_pk_codes.py
+ *
+ * in Emscripten root directory to regenerate this file.
+ */
 
 #include <emscripten/dom_pk_codes.h>
 
-DOM_PK_CODE_TYPE emscripten_compute_dom_pk_code(const char *keyCodeString)
-{
+DOM_PK_CODE_TYPE emscripten_compute_dom_pk_code(const char *keyCodeString) {
   if (!keyCodeString) return 0;
 
   /* Compute the collision free hash. */
   unsigned int hash = 0;
-  while(*keyCodeString) hash = ((hash ^ 0x7E057D79U) << 3) ^ (unsigned int)*keyCodeString++;
-
-  /* Don't expose the hash values out to the application, but map to fixed IDs. This is useful for
-     mapping back codes to MDN documentation page at
+  while (*keyCodeString) hash = ((hash ^ 0x7E057D79U) << 3) ^ (unsigned int)*keyCodeString++;
 
-       https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code */
-  switch(hash)
-  {
+  /*
+   * Don't expose the hash values out to the application, but map to fixed IDs.
+   * This is useful for mapping back codes to MDN documentation page at
+   *
+   *   https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code
+   */
+  switch (hash) {
     case 0x98051284U /* Unidentified       */: return DOM_PK_UNKNOWN;              /* 0x0000 */
     case 0x67243A2DU /* Escape             */: return DOM_PK_ESCAPE;               /* 0x0001 */
     case 0x67251058U /* Digit0             */: return DOM_PK_0;                    /* 0x0002 */
@@ -183,10 +185,8 @@ DOM_PK_CODE_TYPE emscripten_compute_dom_pk_code(const char *keyCodeString)
   }
 }
 
-const char *emscripten_dom_pk_code_to_string(DOM_PK_CODE_TYPE code)
-{
-  switch(code)
-  {
+const char *emscripten_dom_pk_code_to_string(DOM_PK_CODE_TYPE code) {
+  switch (code) {
     case DOM_PK_UNKNOWN:              return "DOM_PK_UNKNOWN";
     case DOM_PK_ESCAPE:               return "DOM_PK_ESCAPE";
     case DOM_PK_0:                    return "DOM_PK_0";

tools/create_dom_pk_codes.py renamed to tools/maint/create_dom_pk_codes.py

@@ -30,6 +30,7 @@
 
 # Use #include <emscripten/dom_pk_codes.h> in your code to access these IDs.
 
+import os
 import sys
 import random
 
@@ -276,8 +277,16 @@ def longest_key_code_length():
   return max(map(len, [x[1] for x in input_strings]))
 
 
-h_file = open('system/include/emscripten/dom_pk_codes.h', 'w')
-c_file = open('system/lib/html5/dom_pk_codes.c', 'w')
+script_dir = os.path.dirname(os.path.abspath(__file__))
+root = os.path.dirname(os.path.dirname(script_dir))
+
+h_filename = os.path.join(root, 'system/include/emscripten/dom_pk_codes.h')
+c_filename = os.path.join(root, 'system/lib/html5/dom_pk_codes.c')
+print(f'Writing: {h_filename}')
+print(f'Writing: {c_filename}')
+h_file = open(h_filename, 'w')
+c_file = open(c_filename, 'w')
+
 
 # Generate the output file:
 
@@ -289,10 +298,10 @@ def longest_key_code_length():
  * found in the LICENSE file.
  *
  * This file was automatically generated from script
- * tools/create_dom_pk_codes.py. Edit that file to make changes here.
- * Run
+ * tools/maint/create_dom_pk_codes.py. Edit that file to make changes here.
+ * Then run:
  *
- *   tools/create_dom_pk_codes.py
+ *   tools/maint/create_dom_pk_codes.py
  *
  * in Emscripten root directory to regenerate this file.
  */
@@ -303,13 +312,16 @@ def longest_key_code_length():
 
 ''')
 
-c_file.write('''/* This file was automatically generated from script
-tools/create_dom_pk_codes.py. Edit that file to make changes here.
-Run
-
-  python tools/create_dom_pk_codes.py
-
-in Emscripten root directory to regenerate this file. */
+c_file.write('''\
+/*
+ * This file was automatically generated from script
+ * tools/maint/create_dom_pk_codes.py. Edit that file to make changes here.
+ * Then run:
+ *
+ *  tools/maint/create_dom_pk_codes.py
+ *
+ * in Emscripten root directory to regenerate this file.
+ */
 
 #include <emscripten/dom_pk_codes.h>
 ''')
@@ -332,20 +344,20 @@ def longest_key_code_length():
 ''')
 
 c_file.write('''
-DOM_PK_CODE_TYPE emscripten_compute_dom_pk_code(const char *keyCodeString)
-{
+DOM_PK_CODE_TYPE emscripten_compute_dom_pk_code(const char *keyCodeString) {
   if (!keyCodeString) return 0;
 
   /* Compute the collision free hash. */
   unsigned int hash = 0;
-  while(*keyCodeString) hash = ((hash ^ 0x%04XU) << %d) ^ (unsigned int)*keyCodeString++;
-
-  /* Don't expose the hash values out to the application, but map to fixed IDs. This is useful for
-     mapping back codes to MDN documentation page at
-
-       https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code */
-  switch(hash)
-  {
+  while (*keyCodeString) hash = ((hash ^ 0x%04XU) << %d) ^ (unsigned int)*keyCodeString++;
+
+  /*
+   * Don't expose the hash values out to the application, but map to fixed IDs.
+   * This is useful for mapping back codes to MDN documentation page at
+   *
+   *   https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code
+   */
+  switch (hash) {
 ''' % (k1, k2))
 
 for s in input_strings:
@@ -355,10 +367,8 @@ def longest_key_code_length():
   }
 }
 
-const char *emscripten_dom_pk_code_to_string(DOM_PK_CODE_TYPE code)
-{
-  switch(code)
-  {
+const char *emscripten_dom_pk_code_to_string(DOM_PK_CODE_TYPE code) {
+  switch (code) {
 ''')
 
 for s in input_strings: