Simplify ports by having ports.get_dir take subdirectory arguments. NFC (#22451)

sbc100 · web-flow · commit 1e3dae246e71 · 2024-08-26T15:03:49.000-07:00
diff --git a/tools/ports/__init__.py b/tools/ports/__init__.py
@@ -221,8 +221,8 @@ def build_port(src_dir, output_path, port_name, includes=[], flags=[], cxxflags=
     return output_path
 
   @staticmethod
-  def get_dir():
-    dirname = config.PORTS
+  def get_dir(*parts):
+    dirname = os.path.join(config.PORTS, *parts)
     shared.safe_ensure_dirs(dirname)
     return dirname
 
@@ -240,7 +240,7 @@ def get_build_dir():
   @staticmethod
   def fetch_project(name, url, sha512hash=None):
     # To compute the sha512 hash, run `curl URL | sha512sum`.
-    fullname = os.path.join(Ports.get_dir(), name)
+    fullname = Ports.get_dir(name)
 
     if name not in Ports.name_cache: # only mention each port once in log
       logger.debug(f'including port: {name}')
diff --git a/tools/ports/boost_headers.py b/tools/ports/boost_headers.py
@@ -20,7 +20,7 @@ def get(ports, settings, shared):
 
   def create(final):
     # includes
-    source_path = os.path.join(ports.get_dir(), 'boost_headers')
+    source_path = ports.get_dir('boost_headers')
     source_path_include = os.path.join(source_path, 'boost')
     ports.install_header_dir(source_path_include, 'boost')
 
diff --git a/tools/ports/bullet.py b/tools/ports/bullet.py
@@ -18,7 +18,7 @@ def get(ports, settings, shared):
   ports.fetch_project('bullet', f'https://github.com/emscripten-ports/bullet/archive/{TAG}.zip', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'bullet', 'Bullet-' + TAG)
+    source_path = ports.get_dir('bullet', 'Bullet-' + TAG)
     src_path = os.path.join(source_path, 'bullet', 'src')
 
     dest_include_path = ports.get_include_dir('bullet')
diff --git a/tools/ports/bzip2.py b/tools/ports/bzip2.py
@@ -3,8 +3,6 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-import os
-
 VERSION = '1.0.6'
 HASH = '512cbfde5144067f677496452f3335e9368fd5d7564899cb49e77847b9ae7dca598218276637cbf5ec524523be1e8ace4ad36a148ef7f4badf3f6d5a002a4bb2'
 
@@ -17,7 +15,7 @@ def get(ports, settings, shared):
   ports.fetch_project('bzip2', f'https://github.com/emscripten-ports/bzip2/archive/{VERSION}.zip', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'bzip2', 'bzip2-' + VERSION)
+    source_path = ports.get_dir('bzip2', 'bzip2-' + VERSION)
     ports.install_headers(source_path)
 
     # build
diff --git a/tools/ports/cocos2d.py b/tools/ports/cocos2d.py
@@ -23,7 +23,7 @@ def get(ports, settings, shared):
   def create(final):
     diagnostics.warning('experimental', 'cocos2d: library is experimental, do not expect that it will work out of the box')
 
-    cocos2d_src = os.path.join(ports.get_dir(), 'cocos2d')
+    cocos2d_src = ports.get_dir('cocos2d')
     cocos2d_root = os.path.join(cocos2d_src, 'Cocos2d-' + TAG)
     cocos2dx_root = os.path.join(cocos2d_root, 'cocos2dx')
 
diff --git a/tools/ports/freetype.py b/tools/ports/freetype.py
@@ -27,7 +27,7 @@ def get(ports, settings, shared):
   ports.fetch_project('freetype', f'https://github.com/emscripten-ports/FreeType/archive/{TAG}.zip', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'freetype', 'FreeType-' + TAG)
+    source_path = ports.get_dir('freetype', 'FreeType-' + TAG)
     ports.write_file(os.path.join(source_path, 'include/ftconfig.h'), ftconf_h)
     ports.install_header_dir(os.path.join(source_path, 'include'),
                              target=os.path.join('freetype2'))
diff --git a/tools/ports/giflib.py b/tools/ports/giflib.py
@@ -3,8 +3,6 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-import os
-
 VERSION = '5.2.1'
 HASH = '4550e53c21cb1191a4581e363fc9d0610da53f7898ca8320f0d3ef6711e76bdda2609c2df15dc94c45e28bff8de441f1227ec2da7ea827cb3c0405af4faa4736'
 
@@ -17,7 +15,7 @@ def get(ports, settings, shared):
   ports.fetch_project('giflib', f'https://storage.googleapis.com/webassembly/emscripten-ports/giflib-{VERSION}.tar.gz', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'giflib', f'giflib-{VERSION}')
+    source_path = ports.get_dir('giflib', f'giflib-{VERSION}')
     ports.install_headers(source_path)
     exclude_files = [
       'giffix.c', 'gifecho.c', 'giffilter.c', 'gifcolor.c', 'gifecho.c', 'gifinto.c',
diff --git a/tools/ports/harfbuzz.py b/tools/ports/harfbuzz.py
@@ -82,7 +82,7 @@ def get(ports, settings, shared):
   ports.fetch_project('harfbuzz', f'https://github.com/harfbuzz/harfbuzz/releases/download/{VERSION}/harfbuzz-{VERSION}.tar.xz', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'harfbuzz', 'harfbuzz-' + VERSION)
+    source_path = ports.get_dir('harfbuzz', 'harfbuzz-' + VERSION)
     freetype_include = ports.get_include_dir('freetype2')
     ports.install_headers(os.path.join(source_path, 'src'), target='harfbuzz')
 
diff --git a/tools/ports/icu.py b/tools/ports/icu.py
@@ -31,7 +31,7 @@ def get(ports, settings, shared):
 
   def prepare_build():
     nonlocal icu_source_path
-    source_path = os.path.join(ports.get_dir(), 'icu', 'icu') # downloaded icu4c path
+    source_path = ports.get_dir('icu', 'icu') # downloaded icu4c path
     icu_source_path = os.path.join(source_path, 'source')
 
   def build_lib(lib_output, lib_src, other_includes, build_flags):
diff --git a/tools/ports/libjpeg.py b/tools/ports/libjpeg.py
@@ -20,7 +20,7 @@ def get(ports, settings, shared):
   ports.fetch_project('libjpeg', f'https://storage.googleapis.com/webassembly/emscripten-ports/jpegsrc.v{VERSION}.tar.gz', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'libjpeg', f'jpeg-{VERSION}')
+    source_path = ports.get_dir('libjpeg', f'jpeg-{VERSION}')
     ports.write_file(os.path.join(source_path, 'jconfig.h'), jconfig_h)
     ports.install_headers(source_path)
     excludes = [
diff --git a/tools/ports/libmodplug.py b/tools/ports/libmodplug.py
@@ -17,7 +17,7 @@ def get(ports, settings, shared):
   ports.fetch_project('libmodplug', f'https://github.com/jancc/libmodplug/archive/v{TAG}.zip', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'libmodplug', 'libmodplug-' + TAG)
+    source_path = ports.get_dir('libmodplug', 'libmodplug-' + TAG)
     src_dir = os.path.join(source_path, 'src')
     libmodplug_path = os.path.join(src_dir, 'libmodplug')
 
diff --git a/tools/ports/libpng.py b/tools/ports/libpng.py
@@ -34,7 +34,7 @@ def get(ports, settings, shared):
   ports.fetch_project('libpng', f'https://storage.googleapis.com/webassembly/emscripten-ports/libpng-{TAG}.tar.gz', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'libpng', 'libpng-' + TAG)
+    source_path = ports.get_dir('libpng', 'libpng-' + TAG)
     ports.write_file(os.path.join(source_path, 'pnglibconf.h'), pnglibconf_h)
     ports.install_headers(source_path)
 
diff --git a/tools/ports/mpg123.py b/tools/ports/mpg123.py
@@ -17,7 +17,7 @@ def get(ports, settings, shared):
   ports.fetch_project('mpg123', f'https://www.mpg123.de/download/mpg123-{TAG}.tar.bz2', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'mpg123', 'mpg123-' + TAG)
+    source_path = ports.get_dir('mpg123', 'mpg123-' + TAG)
 
     src_path = os.path.join(source_path, 'src')
     libmpg123_path = os.path.join(src_path, 'libmpg123')
diff --git a/tools/ports/ogg.py b/tools/ports/ogg.py
@@ -17,7 +17,7 @@ def get(ports, settings, shared):
   ports.fetch_project('ogg', f'https://github.com/emscripten-ports/ogg/archive/{TAG}.zip', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'ogg', 'Ogg-' + TAG)
+    source_path = ports.get_dir('ogg', 'Ogg-' + TAG)
     ports.write_file(os.path.join(source_path, 'include', 'ogg', 'config_types.h'), config_types_h)
     ports.install_headers(os.path.join(source_path, 'include', 'ogg'), target='ogg')
     ports.build_port(os.path.join(source_path, 'src'), final, 'ogg')
diff --git a/tools/ports/regal.py b/tools/ports/regal.py
@@ -23,7 +23,7 @@ def get(ports, settings, shared):
   ports.fetch_project('regal', f'https://github.com/emscripten-ports/regal/archive/{TAG}.zip', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'regal', 'regal-' + TAG)
+    source_path = ports.get_dir('regal', 'regal-' + TAG)
 
     # copy sources
     # only what is needed is copied: regal, boost, lookup3
diff --git a/tools/ports/sdl2.py b/tools/ports/sdl2.py
@@ -26,7 +26,7 @@ def get(ports, settings, shared):
 
   def create(final):
     # copy includes to a location so they can be used as 'SDL2/'
-    src_dir = os.path.join(ports.get_dir(), 'sdl2', SUBDIR)
+    src_dir = ports.get_dir('sdl2', SUBDIR)
     source_include_path = os.path.join(src_dir, 'include')
     ports.install_headers(source_include_path, target='SDL2')
 
diff --git a/tools/ports/sdl2_gfx.py b/tools/ports/sdl2_gfx.py
@@ -21,7 +21,7 @@ def get(ports, settings, shared):
   ports.fetch_project('sdl2_gfx', f'https://github.com/svn2github/sdl2_gfx/archive/{TAG}.zip', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'sdl2_gfx', 'sdl2_gfx-' + TAG)
+    source_path = ports.get_dir('sdl2_gfx', 'sdl2_gfx-' + TAG)
     ports.build_port(source_path, final, 'sdl2_gfx', exclude_dirs=['test'], flags=['-sUSE_SDL=2'])
     ports.install_headers(source_path, target='SDL2')
 
diff --git a/tools/ports/sdl2_image.py b/tools/ports/sdl2_image.py
@@ -52,7 +52,7 @@ def get(ports, settings, shared):
   libname = get_lib_name(settings)
 
   def create(final):
-    src_dir = os.path.join(ports.get_dir(), 'sdl2_image', 'SDL_image-' + TAG)
+    src_dir = ports.get_dir('sdl2_image', 'SDL_image-' + TAG)
     ports.install_headers(src_dir, target='SDL2')
     srcs = '''IMG.c IMG_bmp.c IMG_gif.c IMG_jpg.c IMG_lbm.c IMG_pcx.c IMG_png.c IMG_pnm.c IMG_tga.c
               IMG_tif.c IMG_xcf.c IMG_xpm.c IMG_xv.c IMG_webp.c IMG_ImageIO.m
diff --git a/tools/ports/sdl2_mixer.py b/tools/ports/sdl2_mixer.py
@@ -38,7 +38,7 @@ def get(ports, settings, shared):
   libname = get_lib_name(settings)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'sdl2_mixer', 'SDL_mixer-' + TAG)
+    source_path = ports.get_dir('sdl2_mixer', 'SDL_mixer-' + TAG)
     flags = [
       '-sUSE_SDL=2',
       '-O2',
diff --git a/tools/ports/sdl2_net.py b/tools/ports/sdl2_net.py
@@ -21,7 +21,7 @@ def get(ports, settings, shared):
   ports.fetch_project('sdl2_net', f'https://github.com/emscripten-ports/SDL2_net/archive/{TAG}.zip', sha512hash=HASH)
 
   def create(final):
-    src_dir = os.path.join(ports.get_dir(), 'sdl2_net', 'SDL2_net-' + TAG)
+    src_dir = 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, flags=['-sUSE_SDL=2'])
diff --git a/tools/ports/sdl2_ttf.py b/tools/ports/sdl2_ttf.py
@@ -3,8 +3,6 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-import os
-
 TAG = 'release-2.20.2' # Latest as of 21 February 2023
 HASH = '8a625d29bef2ab7cbfe2143136a303c0fdb066ecd802d6c725de1b73ad8b056908cb524fe58f38eaee9f105471d2af50bbcb17911d46506dbcf573db218b3685'
 
@@ -19,7 +17,7 @@ def get(ports, settings, shared):
   ports.fetch_project('sdl2_ttf', f'https://github.com/libsdl-org/SDL_ttf/archive/{TAG}.zip', sha512hash=HASH)
 
   def create(final):
-    src_root = os.path.join(ports.get_dir(), 'sdl2_ttf', 'SDL_ttf-' + TAG)
+    src_root = ports.get_dir('sdl2_ttf', 'SDL_ttf-' + TAG)
     ports.install_headers(src_root, target='SDL2')
     flags = ['-DTTF_USE_HARFBUZZ=1', '-sUSE_SDL=2', '-sUSE_FREETYPE', '-sUSE_HARFBUZZ']
     ports.build_port(src_root, final, 'sdl2_ttf', flags=flags, srcs=['SDL_ttf.c'])
diff --git a/tools/ports/sqlite3.py b/tools/ports/sqlite3.py
@@ -3,8 +3,6 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-import os
-
 # sqlite amalgamation download URL uses relase year and tag
 # 2022  and (3, 38, 5) -> '/2022/sqlite-amalgamation-3380500.zip'
 VERSION = (3, 39, 0)
@@ -28,7 +26,7 @@ def get(ports, settings, shared):
   ports.fetch_project('sqlite3', f'https://www.sqlite.org/{VERSION_YEAR}/{release}.zip', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'sqlite3', release)
+    source_path = ports.get_dir('sqlite3', release)
 
     ports.install_headers(source_path)
 
diff --git a/tools/ports/vorbis.py b/tools/ports/vorbis.py
@@ -19,7 +19,7 @@ def get(ports, settings, shared):
   ports.fetch_project('vorbis', f'https://github.com/emscripten-ports/vorbis/archive/{TAG}.zip', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'vorbis', 'Vorbis-' + TAG)
+    source_path = ports.get_dir('vorbis', 'Vorbis-' + TAG)
     ports.install_headers(os.path.join(source_path, 'include', 'vorbis'), target='vorbis')
     ports.build_port(os.path.join(source_path, 'lib'), final, 'vorbis',
                      flags=['-sUSE_OGG'],
diff --git a/tools/ports/zlib.py b/tools/ports/zlib.py
@@ -17,7 +17,7 @@ def get(ports, settings, shared):
   ports.fetch_project('zlib', f'https://github.com/madler/zlib/archive/refs/tags/v{VERSION}.tar.gz', sha512hash=HASH)
 
   def create(final):
-    source_path = os.path.join(ports.get_dir(), 'zlib', 'zlib-' + VERSION)
+    source_path = ports.get_dir('zlib', 'zlib-' + VERSION)
     ports.write_file(os.path.join(source_path, 'zconf.h'), zconf_h)
     ports.install_headers(source_path)
 
