Change project src folder layout to use subfolder 'ale' (#533)

Co-authored-by: Mark Towers <mark.m.towers@gmail.com>

.github/workflows/ci.yml

@@ -202,6 +202,7 @@ jobs:
     needs: [build-wheels, build-scratch]
 
     strategy:
+      fail-fast: false
       matrix:
         include:
           # example wheel names (if the wheel names change, look at the `ls wheels/` for the new names)

.gitignore

@@ -1,8 +1,8 @@
 ## ALE
-ale
 build
 doc/examples/*Example
 
+
 # Don't save roms in repo
 *.tar.gz.b64
 *.tar.gz
@@ -164,3 +164,7 @@ cython_debug/
 
 # Docs
 /docs/_build/
+
+# CLion project settings and build-folders
+cmake-build-*
+.idea

CMakeLists.txt

@@ -62,7 +62,7 @@ project(ale VERSION ${ALE_DEFAULT_VERSION}
             LANGUAGES CXX)
 
 # Main ALE src directory
-add_subdirectory(src)
+add_subdirectory(src/ale)
 
 # Only include tests in the main project
 if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)

pyproject.toml

@@ -37,7 +37,7 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
 ]
 dependencies = [
-  "numpy",
+  "numpy<2.0",
   "importlib-metadata>=4.10.0; python_version < '3.10'",
   "importlib-resources; python_version < '3.9'",
   "typing-extensions; python_version < '3.11'"
@@ -60,7 +60,7 @@ packages = [
   "ale_py",
   "ale_py.roms",
 ]
-package-dir = {ale_py = "src/python"}
+package-dir = {ale_py = "src/ale/python"}
 package-data = {"ale_py" = ["py.typed", "*.pyi", "**/*.pyi"], "ale_py.roms" = ["md5.json", "*.bin"]}
 
 [tool.pytest.ini_options]

scripts/download_unpack_roms.sh

@@ -3,7 +3,7 @@
 # define some directories
 base_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && pwd)/.."
 unpack_dir="${base_dir}/unpack_dir"
-target_dir="${base_dir}/src/python/roms"
+target_dir="${base_dir}/src/ale/python/roms"
 
 # make the directory where we will do the unpacking
 mkdir $unpack_dir

src/CMakeLists.txt → src/ale/CMakeLists.txt

@@ -1,5 +1,5 @@
 # Include src/ and cmake binary directory (for version.hpp)
-include_directories(BEFORE ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR})
+include_directories(BEFORE ${PROJECT_SOURCE_DIR}/src ${CMAKE_CURRENT_BINARY_DIR})
 
 # Project specific target properties
 set(CMAKE_CXX_STANDARD 17)
@@ -102,7 +102,7 @@ if (UNIX AND BUILD_CPP_LIB)
 
   # Configure installable cmake config
   configure_package_config_file(
-    ${CMAKE_CURRENT_SOURCE_DIR}/../cmake/${PROJECT_NAME}-config.cmake.in
+    ${PROJECT_SOURCE_DIR}/cmake/${PROJECT_NAME}-config.cmake.in
     ${PROJECT_NAME}-config.cmake
     INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
 

src/ale_interface.cpp → src/ale/ale_interface.cpp

@@ -28,7 +28,7 @@
  *  The shared library interface.
  **************************************************************************** */
 
-#include "ale_interface.hpp"
+#include "ale/ale_interface.hpp"
 
 #include <algorithm>
 #include <cassert>
@@ -44,13 +44,13 @@
 #include <filesystem>
 #include <fstream>
 
-#include "common/ColourPalette.hpp"
-#include "common/Constants.h"
-#include "emucore/Console.hxx"
-#include "emucore/Props.hxx"
-#include "emucore/MD5.hxx"
-#include "environment/ale_screen.hpp"
-#include "games/RomSettings.hpp"
+#include "ale/common/ColourPalette.hpp"
+#include "ale/common/Constants.h"
+#include "ale/emucore/Console.hxx"
+#include "ale/emucore/Props.hxx"
+#include "ale/emucore/MD5.hxx"
+#include "ale/environment/ale_screen.hpp"
+#include "ale/games/RomSettings.hpp"
 
 namespace fs = std::filesystem;
 

src/ale_interface.hpp → src/ale/ale_interface.hpp

@@ -31,11 +31,11 @@
 #ifndef __ALE_INTERFACE_HPP__
 #define __ALE_INTERFACE_HPP__
 
-#include "emucore/OSystem.hxx"
-#include "games/Roms.hpp"
-#include "environment/stella_environment.hpp"
-#include "common/ScreenExporter.hpp"
-#include "common/Log.hpp"
+#include "ale/emucore/OSystem.hxx"
+#include "ale/games/Roms.hpp"
+#include "ale/environment/stella_environment.hpp"
+#include "ale/common/ScreenExporter.hpp"
+#include "ale/common/Log.hpp"
 #include "version.hpp"
 
 #include <string>

src/common/ColourPalette.cpp → src/ale/common/ColourPalette.cpp

@@ -13,7 +13,7 @@
  *  Enables conversion from NTSC/SECAM/PAL to RGB via the OSystem's palette.
  **************************************************************************** */
 
-#include "common/ColourPalette.hpp"
+#include "ale/common/ColourPalette.hpp"
 
 #include <cassert>
 #include <cmath>
@@ -23,7 +23,7 @@
 #include <fstream>
 #include <iostream>
 
-#include "common/Palettes.hpp"
+#include "ale/common/Palettes.hpp"
 
 namespace ale {
 namespace {

src/common/Constants.cpp → src/ale/common/Constants.cpp

@@ -13,7 +13,7 @@
  *
  **************************************************************************** */
 
-#include "common/Constants.h"
+#include "ale/common/Constants.h"
 
 #include <cassert>
 #include <string>

src/common/DynamicLoad.cpp → src/ale/common/DynamicLoad.cpp

@@ -12,7 +12,7 @@
  *
  *  Helper functions to manage dynamic loading libraries.
  **************************************************************************** */
-#include "common/DynamicLoad.hpp"
+#include "ale/common/DynamicLoad.hpp"
 
 #if defined(WIN32)
   #include <windows.h>

src/common/Log.cpp → src/ale/common/Log.cpp

@@ -1,4 +1,4 @@
-#include "common/Log.hpp"
+#include "ale/common/Log.hpp"
 
 #include <iostream>
 

src/common/SDL2.cpp → src/ale/common/SDL2.cpp

@@ -22,7 +22,7 @@
  * manual definition is more clear.
  */
 #ifdef SDL_DYNLOAD
-#include "common/SDL2.hpp"
+#include "ale/common/SDL2.hpp"
 
 namespace ale {
 

src/common/SDL2.hpp → src/ale/common/SDL2.hpp

@@ -24,7 +24,7 @@
 // define some macros to shim the SDL functions
 // we use in the ALE.
 #ifdef SDL_DYNLOAD
-  #include "common/DynamicLoad.hpp"
+  #include "ale/common/DynamicLoad.hpp"
 
   // Try the default dynamic library name per platform
   // if SDL2_LIBRARY_NAME is not defined.

src/common/ScreenExporter.cpp → src/ale/common/ScreenExporter.cpp

@@ -14,7 +14,7 @@
  *
  **************************************************************************** */
 
-#include "common/ScreenExporter.hpp"
+#include "ale/common/ScreenExporter.hpp"
 
 #include <zlib.h>
 #include <cassert>
@@ -24,7 +24,7 @@
 #include <vector>
 #include <iomanip>
 
-#include "common/Log.hpp"
+#include "ale/common/Log.hpp"
 
 namespace ale {
 

src/common/ScreenExporter.hpp → src/ale/common/ScreenExporter.hpp

@@ -19,9 +19,9 @@
 
 #include <string>
 
-#include "common/Constants.h"
-#include "common/ColourPalette.hpp"
-#include "environment/ale_screen.hpp"
+#include "ale/common/Constants.h"
+#include "ale/common/ColourPalette.hpp"
+#include "ale/environment/ale_screen.hpp"
 
 namespace ale {
 

src/common/ScreenSDL.cpp → src/ale/common/ScreenSDL.cpp

@@ -14,10 +14,10 @@
  *  Supports displaying the screen via SDL.
  **************************************************************************** */
 #ifdef SDL_SUPPORT
-#include "common/SDL2.hpp"
+#include "ale/common/SDL2.hpp"
 
-#include "common/ScreenSDL.hpp"
-#include "common/Log.hpp"
+#include "ale/common/ScreenSDL.hpp"
+#include "ale/common/Log.hpp"
 
 #include <cmath>
 

src/common/ScreenSDL.hpp → src/ale/common/ScreenSDL.hpp

@@ -19,12 +19,12 @@
 
 #ifdef SDL_SUPPORT
 
-#include "common/Constants.h"
-#include "common/ColourPalette.hpp"
-#include "emucore/Screen.hxx"
-#include "emucore/OSystem.hxx"
-#include "emucore/MediaSrc.hxx"
-#include "common/SDL2.hpp"
+#include "ale/common/Constants.h"
+#include "ale/common/ColourPalette.hpp"
+#include "ale/emucore/Screen.hxx"
+#include "ale/emucore/OSystem.hxx"
+#include "ale/emucore/MediaSrc.hxx"
+#include "ale/common/SDL2.hpp"
 
 namespace ale {
 

src/common/SoundExporter.cpp → src/ale/common/SoundExporter.cpp

@@ -1,4 +1,4 @@
-#include "common/SoundExporter.hpp"
+#include "ale/common/SoundExporter.hpp"
 
 #include <cassert>
 

src/common/SoundNull.cxx → src/ale/common/SoundNull.cxx

@@ -16,12 +16,12 @@
 // $Id: SoundNull.cxx,v 1.6 2007/01/01 18:04:40 stephena Exp $
 //============================================================================
 
-#include "emucore/Serializer.hxx"
-#include "emucore/Deserializer.hxx"
+#include "ale/emucore/Serializer.hxx"
+#include "ale/emucore/Deserializer.hxx"
 
 
-#include "emucore/Settings.hxx"
-#include "common/SoundNull.hxx"
+#include "ale/emucore/Settings.hxx"
+#include "ale/common/SoundNull.hxx"
 
 namespace ale {
 using namespace stella;   // Settings, Serializer, Deserializer

src/common/SoundNull.hxx → src/ale/common/SoundNull.hxx

@@ -29,7 +29,7 @@ class Deserializer;
 }  // namespace stella
 }  // namespace ale
 
-#include "emucore/Sound.hxx"
+#include "ale/emucore/Sound.hxx"
 
 namespace ale {
 

src/common/SoundSDL.cxx → src/ale/common/SoundSDL.cxx

@@ -22,16 +22,16 @@
 #include <cassert>
 #include <cmath>
 
-#include "emucore/TIASnd.hxx"
-// #include "FrameBuffer.hxx"
-#include "emucore/Serializer.hxx"
-#include "emucore/Deserializer.hxx"
-#include "emucore/Settings.hxx"
-#include "emucore/System.hxx"
-
-#include "common/SDL2.hpp"
-#include "common/SoundSDL.hxx"
-#include "common/Log.hpp"
+#include "ale/emucore/TIASnd.hxx"
+// #include "ale/FrameBuffer.hxx"
+#include "ale/emucore/Serializer.hxx"
+#include "ale/emucore/Deserializer.hxx"
+#include "ale/emucore/Settings.hxx"
+#include "ale/emucore/System.hxx"
+
+#include "ale/common/SDL2.hpp"
+#include "ale/common/SoundSDL.hxx"
+#include "ale/common/Log.hpp"
 
 namespace ale {
 using namespace stella;   // Settings, Serializer, Deserializer

src/common/SoundSDL.hxx → src/ale/common/SoundSDL.hxx

@@ -29,13 +29,13 @@ class Settings;
 }  // namespace stella
 }  // namespace ale
 
-#include "emucore/Sound.hxx"
-#include "emucore/MediaSrc.hxx"
-#include "emucore/TIASnd.hxx"
+#include "ale/emucore/Sound.hxx"
+#include "ale/emucore/MediaSrc.hxx"
+#include "ale/emucore/TIASnd.hxx"
 
-#include "common/SDL2.hpp"
+#include "ale/common/SDL2.hpp"
 // If desired, we save sound to disk
-#include "common/SoundExporter.hpp"
+#include "ale/common/SoundExporter.hpp"
 #include <memory>
 
 namespace ale {

src/emucore/Cart.cxx → src/ale/emucore/Cart.cxx

@@ -22,32 +22,32 @@
 #include <cassert>
 #include <sstream>
 
-#include "emucore/Cart.hxx"
-#include "emucore/Cart0840.hxx"
-#include "emucore/Cart2K.hxx"
-#include "emucore/Cart3E.hxx"
-#include "emucore/Cart3F.hxx"
-#include "emucore/Cart4A50.hxx"
-#include "emucore/Cart4K.hxx"
-#include "emucore/CartAR.hxx"
-#include "emucore/CartDPC.hxx"
-#include "emucore/CartE0.hxx"
-#include "emucore/CartE7.hxx"
-#include "emucore/CartF4.hxx"
-#include "emucore/CartF4SC.hxx"
-#include "emucore/CartF6.hxx"
-#include "emucore/CartF6SC.hxx"
-#include "emucore/CartF8.hxx"
-#include "emucore/CartF8SC.hxx"
-#include "emucore/CartFASC.hxx"
-#include "emucore/CartFE.hxx"
-#include "emucore/CartMC.hxx"
-#include "emucore/CartMB.hxx"
-#include "emucore/CartCV.hxx"
-#include "emucore/CartUA.hxx"
-#include "emucore/MD5.hxx"
-#include "emucore/Props.hxx"
-#include "emucore/Settings.hxx"
+#include "ale/emucore/Cart.hxx"
+#include "ale/emucore/Cart0840.hxx"
+#include "ale/emucore/Cart2K.hxx"
+#include "ale/emucore/Cart3E.hxx"
+#include "ale/emucore/Cart3F.hxx"
+#include "ale/emucore/Cart4A50.hxx"
+#include "ale/emucore/Cart4K.hxx"
+#include "ale/emucore/CartAR.hxx"
+#include "ale/emucore/CartDPC.hxx"
+#include "ale/emucore/CartE0.hxx"
+#include "ale/emucore/CartE7.hxx"
+#include "ale/emucore/CartF4.hxx"
+#include "ale/emucore/CartF4SC.hxx"
+#include "ale/emucore/CartF6.hxx"
+#include "ale/emucore/CartF6SC.hxx"
+#include "ale/emucore/CartF8.hxx"
+#include "ale/emucore/CartF8SC.hxx"
+#include "ale/emucore/CartFASC.hxx"
+#include "ale/emucore/CartFE.hxx"
+#include "ale/emucore/CartMC.hxx"
+#include "ale/emucore/CartMB.hxx"
+#include "ale/emucore/CartCV.hxx"
+#include "ale/emucore/CartUA.hxx"
+#include "ale/emucore/MD5.hxx"
+#include "ale/emucore/Props.hxx"
+#include "ale/emucore/Settings.hxx"
 
 namespace ale {
 namespace stella {

src/emucore/Cart.hxx → src/ale/emucore/Cart.hxx

@@ -31,8 +31,8 @@ class Settings;
 }  // namespace ale
 
 #include <fstream>
-#include "emucore/Device.hxx"
-#include "common/Log.hpp"
+#include "ale/emucore/Device.hxx"
+#include "ale/common/Log.hpp"
 
 namespace ale {
 namespace stella {