Don't default to SDLv1 for un-versioned SDL includes

sbc100 · sbc100 · commit 789d229d89cb · 2023-01-03T10:37:45.000-08:00
With SDL you can choose to either include the header files via the explictly version prefix (e.g. `<SDL/SDL_audio.h>` or `<SDL2/SDL_audio.h>`. Or some folks configure the include path such that the unversioned includes can be used (`#include <SDL_audio.h>`). Emscripten allows the unversioned form by putting the `SDL` or `SDL2` directory on the include path based on the USE_SDL settings, but the fact that were defaulting to enabling version 1 was causing some issues (See #18072 and #184402 for more details). After this change we default to not adding either of these include paths. This means that folks who want to use un-versioned includes will now need to opt into one version of the other via `-sUSE_SDL`. Note that folks using the explict `<SDL/SDL_audio.h>` includes are not effected by this (that will always result in an SDL v1 header being included). In order to make it more obvious that use of `<SDL_audio.h>` now requires an opt in, I created dummy headers that should give effected users and clear error message. We've already been doing this in STRICT module for a while now. Fixes: #18072, #18440
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -20,6 +20,11 @@ See docs/process.md for more on how version tagging works.
 
 3.1.30 (in development)
 -----------------------
+- The SDLv1 header directory is no longer added to the include path by default.
+  This means if you include SDL headers without the explicit version in them
+  (e.g. `SDL_events.h`) you will now need to add `-sUSE_SDL` explicitly at
+  compile time.  If you include the SDL headers with the directory name included
+  (e.g. `SDL/SDL_events.h`) you will not be affected by this change. (#18443)
 
 3.1.29 - 01/03/23
 -----------------
diff --git a/emcc.py b/emcc.py
@@ -917,6 +917,9 @@ def array_contains_any_of(hay, needles):
   if array_contains_any_of(user_args, SIMD_NEON_FLAGS):
     cflags += ['-D__ARM_NEON__=1']
 
+  if not settings.USE_SDL:
+    cflags += ['-Xclang', '-iwithsysroot' + os.path.join('/include', 'fakesdl')]
+
   return cflags + ['-Xclang', '-iwithsysroot' + os.path.join('/include', 'compat')]
 
 
@@ -1916,9 +1919,6 @@ def phase_linker_setup(options, state, newargs):
     default_setting('IGNORE_MISSING_MAIN', 0)
     default_setting('ALLOW_UNIMPLEMENTED_SYSCALLS', 0)
 
-  if not settings.AUTO_JS_LIBRARIES:
-    default_setting('USE_SDL', 0)
-
   if 'GLOBAL_BASE' not in user_settings and not settings.SHRINK_LEVEL and not settings.OPT_LEVEL:
     # When optimizing for size it helps to put static data first before
     # the stack (sincs this makes instructions for accessing this data
diff --git a/src/settings.js b/src/settings.js
@@ -1406,7 +1406,7 @@ var LEGALIZE_JS_FFI = true;
 // When AUTO_JS_LIBRARIES is set to 0 this defaults to 0 and SDL
 // is not linked in.
 // [compile+link]
-var USE_SDL = 1;
+var USE_SDL = 0;
 
 // Specify the SDL_gfx version that is being linked against. Must match USE_SDL
 // [compile+link]
diff --git a/system/include/fakesdl/SDL.h b/system/include/fakesdl/SDL.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_assert.h b/system/include/fakesdl/SDL_assert.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_atomic.h b/system/include/fakesdl/SDL_atomic.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_audio.h b/system/include/fakesdl/SDL_audio.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_blendmode.h b/system/include/fakesdl/SDL_blendmode.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_clipboard.h b/system/include/fakesdl/SDL_clipboard.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_compat.h b/system/include/fakesdl/SDL_compat.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_config.h b/system/include/fakesdl/SDL_config.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_copying.h b/system/include/fakesdl/SDL_copying.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_cpuinfo.h b/system/include/fakesdl/SDL_cpuinfo.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_endian.h b/system/include/fakesdl/SDL_endian.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_error.h b/system/include/fakesdl/SDL_error.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_events.h b/system/include/fakesdl/SDL_events.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_gesture.h b/system/include/fakesdl/SDL_gesture.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_gfxPrimitives.h b/system/include/fakesdl/SDL_gfxPrimitives.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_haptic.h b/system/include/fakesdl/SDL_haptic.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_hints.h b/system/include/fakesdl/SDL_hints.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_image.h b/system/include/fakesdl/SDL_image.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_input.h b/system/include/fakesdl/SDL_input.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_joystick.h b/system/include/fakesdl/SDL_joystick.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_keyboard.h b/system/include/fakesdl/SDL_keyboard.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_keycode.h b/system/include/fakesdl/SDL_keycode.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_loadso.h b/system/include/fakesdl/SDL_loadso.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_log.h b/system/include/fakesdl/SDL_log.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_main.h b/system/include/fakesdl/SDL_main.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_mixer.h b/system/include/fakesdl/SDL_mixer.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_mouse.h b/system/include/fakesdl/SDL_mouse.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_mutex.h b/system/include/fakesdl/SDL_mutex.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_name.h b/system/include/fakesdl/SDL_name.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_opengl.h b/system/include/fakesdl/SDL_opengl.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_opengles.h b/system/include/fakesdl/SDL_opengles.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_opengles2.h b/system/include/fakesdl/SDL_opengles2.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_pixels.h b/system/include/fakesdl/SDL_pixels.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_platform.h b/system/include/fakesdl/SDL_platform.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_power.h b/system/include/fakesdl/SDL_power.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_quit.h b/system/include/fakesdl/SDL_quit.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_rect.h b/system/include/fakesdl/SDL_rect.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_render.h b/system/include/fakesdl/SDL_render.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_revision.h b/system/include/fakesdl/SDL_revision.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_rotozoom.h b/system/include/fakesdl/SDL_rotozoom.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_rwops.h b/system/include/fakesdl/SDL_rwops.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_scancode.h b/system/include/fakesdl/SDL_scancode.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_shape.h b/system/include/fakesdl/SDL_shape.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_stdinc.h b/system/include/fakesdl/SDL_stdinc.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_surface.h b/system/include/fakesdl/SDL_surface.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_syswm.h b/system/include/fakesdl/SDL_syswm.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_thread.h b/system/include/fakesdl/SDL_thread.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_timer.h b/system/include/fakesdl/SDL_timer.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_touch.h b/system/include/fakesdl/SDL_touch.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_ttf.h b/system/include/fakesdl/SDL_ttf.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_types.h b/system/include/fakesdl/SDL_types.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_version.h b/system/include/fakesdl/SDL_version.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/system/include/fakesdl/SDL_video.h b/system/include/fakesdl/SDL_video.h
@@ -0,0 +1 @@
+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"
diff --git a/test/browser/test_sdl_alloctext.c b/test/browser/test_sdl_alloctext.c
@@ -6,8 +6,8 @@
  */
 
 #include <stdio.h>
-#include <SDL.h>
-#include <SDL_ttf.h>
+#include <SDL/SDL.h>
+#include <SDL/SDL_ttf.h>
 
 int main()
 {
diff --git a/test/browser/test_sdl_surface_refcount.c b/test/browser/test_sdl_surface_refcount.c
@@ -7,7 +7,7 @@
 
 #include <emscripten.h>
 #include <assert.h>
-#include <SDL.h>
+#include <SDL/SDL.h>
 #include <stdio.h>
 #include <stdlib.h>
 
diff --git a/test/browser/test_sdl_ttf_render_text_solid.c b/test/browser/test_sdl_ttf_render_text_solid.c
@@ -6,8 +6,8 @@
  */
 
 #include <stdio.h>
-#include <SDL.h>
-#include <SDL_ttf.h>
+#include <SDL/SDL.h>
+#include <SDL/SDL_ttf.h>
 
 int main()
 {
diff --git a/test/emscripten_api_browser.c b/test/emscripten_api_browser.c
@@ -7,7 +7,7 @@
 #include <stdio.h>
 #include <math.h>
 #include <stdlib.h>
-#include <SDL.h>
+#include <SDL/SDL.h>
 #include <emscripten.h>
 #include <assert.h>
 
diff --git a/test/test_core.py b/test/test_core.py
@@ -2483,6 +2483,7 @@ def test_llvmswitch(self):
 
   @no_wasm2js('massive switches can break js engines')
   def test_bigswitch(self):
+    self.set_setting('USE_SDL')
     self.do_runf(test_file('bigswitch.cpp'), '''34962: GL_ARRAY_BUFFER (0x8892)
 26214: what?
 35040: GL_STREAM_DRAW (0x88E0)
diff --git a/test/test_other.py b/test/test_other.py
@@ -1970,8 +1970,21 @@ def test_js_link(self):
     self.run_process([EMXX, 'main.cpp', '--pre-js', 'before.js', '--post-js', 'after.js', '-sWASM_ASYNC_COMPILATION=0'])
     self.assertContained('hello from main\nhello from js\n', self.run_js('a.out.js'))
 
+  def test_sdl_none(self):
+    create_file('main.c', r'''
+      #include <stdio.h>
+      #include <SDL.h>
+
+      int main() {
+        return 0;
+      }
+    ''')
+    err = self.expect_fail([EMCC, 'main.c'])
+    self.assertContained('SDL.h:1:2: error: "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"', err)
+    self.run_process([EMCC, 'main.c', '-sUSE_SDL'])
+
   def test_sdl_endianness(self):
-    create_file('main.cpp', r'''
+    create_file('main.c', r'''
       #include <stdio.h>
       #include <SDL/SDL.h>
 
@@ -1980,11 +1993,10 @@ def test_sdl_endianness(self):
         return 0;
       }
     ''')
-    self.run_process([EMXX, 'main.cpp'])
-    self.assertContained('1234, 1234, 4321\n', self.run_js('a.out.js'))
+    self.do_runf('main.c', '1234, 1234, 4321\n')
 
   def test_sdl_scan_code_from_key(self):
-    create_file('main.cpp', r'''
+    create_file('main.c', r'''
       #include <stdio.h>
       #include <SDL/SDL_keyboard.h>
 
@@ -1993,7 +2005,7 @@ def test_sdl_scan_code_from_key(self):
         return 0;
       }
     ''')
-    self.do_runf('main.cpp', '204\n')
+    self.do_runf('main.c', '204\n')
 
   def test_sdl2_mixer_wav(self):
     self.emcc(test_file('browser/test_sdl2_mixer_wav.c'), ['-sUSE_SDL_MIXER=2'], output_filename='a.out.js')
@@ -2168,7 +2180,7 @@ def test_undefined_symbols(self, action):
         delete_file('a.out.js')
         print('checking "%s" %s' % (args, value))
         extra = ['-s', action + '_ON_UNDEFINED_SYMBOLS=%d' % value] if action else []
-        proc = self.run_process([EMXX, 'main.cpp'] + extra + args, stderr=PIPE, check=False)
+        proc = self.run_process([EMXX, '-sUSE_SDL', 'main.cpp'] + extra + args, stderr=PIPE, check=False)
         print(proc.stderr)
         if value or action is None:
           # The default is that we error in undefined symbols
@@ -8154,7 +8166,7 @@ def test_standalone_system_headers(self):
     # everything it needs.
     directories = {'': []}
     for elem in os.listdir(path_from_root('system/include')):
-      if elem == 'compat':
+      if elem in ('compat', 'fakesdl'):
         continue
       full = path_from_root('system/include', elem)
       if os.path.isdir(full):
diff --git a/tools/ports/sdl2_net.py b/tools/ports/sdl2_net.py
@@ -26,7 +26,7 @@ def create(final):
     src_dir = os.path.join(ports.get_dir(), 'sdl2_net', 'SDL2_net-' + TAG)
     ports.install_headers(src_dir, target='SDL2')
     excludes = ['chatd.c', 'chat.cpp', 'showinterfaces.c']
-    ports.build_port(src_dir, final, 'sdl2_net', exclude_files=excludes)
+    ports.build_port(src_dir, final, 'sdl2_net', exclude_files=excludes, flags=['-sUSE_SDL=2'])
 
   return [shared.cache.get_lib('libSDL2_net.a', create, what='port')]
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+#error "To use the emscripten port of SDL use -sUSE_SDL or -sUSE_SDL=2"`