This is a C (C99) library (see src/core
) implementing a divide-and-conquer
algorithm, and a collection of apps (written in C99, C++17, C++20, and
ECMAScript) to solve the tromino puzzle, over-engineered for the joy
of learning by doing.
A tromino puzzle consists of a checkered
The developer (@oboukli) was first introduced to the tromino puzzle in early 2006, via Anany Levitin's book Introduction to the Design and Analysis of Algorithms, published in 2003 by Addison-Wesley. Anany Levitin mentions Solomon W. Golomb's second edition Polyominoes: Puzzles, Patterns, Problems, and Packings, published in 1994 by Princeton University Press, as a reference to the puzzle.
The realization of the recursive solution was such a beautiful epiphany to the developer.
The command-line app is supported on Linux, macOS, and Windows. See the Desktop app section for build instruction.
The virtual terminal (VT-100) mode should work on any system with POSIX support, including supported versions of macOS and Windows.
For basic ASCII drawings, which may be useful for writing to text files,
define TROMINO_USE_ASCII
before building. The following is an example
output for a
+--+
|X||
|-+|
+--+
On Windows, a native legacy Windows Console Host (WCH) renderer, which uses DOS box-drawing characters (code page 437), is included.
The desktop app is currently actively supported on macOS. See the xcode
directory for the Xcode 13 project files.
The Xcode projects are configured to use vcpkg paths. To install the build dependencies with vcpkg:
git clone https://github.com/microsoft/vcpkg
./vcpkg/bootstrap-vcpkg.sh -disableMetrics
./vcpkg/vcpkg install sdl2 --triplet x64-osx-dynamic
./vcpkg/vcpkg install sdl2 --triplet arm64-osx-dynamic
In addition, the build script must be made executable:
chmod +x xcode/Tromino2d/scripts/uni.sh
Boost Test is required for building the the unit tests:
./vcpkg/vcpkg install boost-test
Homebrew can also be used. However, the Xcode projects must be manually reconfigured. The same applies for manual or custom SDL2 installation.
To install the build dependencies with Homebrew:
brew install boost sdl2
For Linux, and possibly any platform on which GNU Autotools are supported:
./autogen.sh
mkdir build
cd build
../configure
make
Optional steps:
make check
make install
For Windows, MSBuild files are provided which can be built with Visual Studio 2022, or from the command-line:
msbuild -maxCpuCount -property:Configuration=release -property:Platform=x64 msbuild\TrominoPuzzle.sln
The SDL2 library is required to build the desktop app.
Tip: The Debian and Ubuntu development package for SDL2 is
libsdl2-dev
.
sudo apt install libsdl2-dev
For an experimental headless tromino2d app, define TROMINO_2D_HEADLESS
before
building the tromino2d app.
The web app makes use of WebAssembly and requires Emscripten to build.
cd emscripten
emmake make
The web app can be built using the Emscripten SDK Docker image:
docker pull emscripten/emsdk
docker run --rm --volume=$(pwd):/src --workdir=/src/emscripten \
emscripten/emsdk emmake make
To run the web app:
docker pull nginx
docker run --detach --rm --publish=8080:80 \
--volume=$(pwd)/dist/web:/usr/share/nginx/html:ro --name tromino-puzzle nginx
The following is a partial list of standards, practices, software, and ideas leveraged by this project:
- C (standard C99)
- C++ (standard C++17 and C++20)
- C++ STL
- No C++ inheritance
- No C++ exceptions (experimental)
- No C++ RTTI
const
andconstexpr
where applicable--except members- SDL2
- VT-100
- Windows API
- Boost Test
- vcpkg
- Clang Format
- Emscripten
- JavaScript (ECMAScript 2016+ - vanilla)
- Web Workers
- TypeScript JSDoc type annotations
- ESLint
- HTMLHint
- Prettier
- Conventional Commits
- Xcode
- MSBuild
- GNU Make
- GNU Autotools
- Azure Pipelines
- GitHub Actions
- GitHub Pages
- Docker
- Code test coverage
- CodeQL
- DevSkim
- OpenSSF Scorecard
- EditorConfig
- Markdown
- Markdownlint
- SonarScanner
- Strongly-typed approach
- HTML5
- CSS
- SVG
- Valgrind Memcheck
- XcodeWarnings
This software is released under an MIT-style license. Copyright ยฉ 2021-2024 Omar Boukli-Hacene.
SPDX license identifier: MIT.
Written for the joy of it ๐ณ