Add OPL4 playback and analyzer support
This commit is contained in:
@@ -0,0 +1,114 @@
|
||||
|
||||
## Installation Instructions
|
||||
|
||||
Requirements:
|
||||
|
||||
- GNU/Linux / Unix / macOS / BSD with bash compatible shell
|
||||
- all common system progs (grep, cat, etc...)
|
||||
- all common build requirements (libc, libstdc++, g++, GNU make, etc...)
|
||||
- optionally CMake
|
||||
|
||||
or
|
||||
|
||||
- complete MinGW environment for MS Windows, configured with MinGW bin directories added in `PATH` variable (typically `C:\MinGW\bin;` `C:\MinGW\msys\1.0\bin`) or possibly with any BASH emulator (e.g. the one which comes with [git for windows](https://gitforwindows.org/)) will do it instead of msys is missing / not set.
|
||||
- CMake installed into MinGW bin directory (optionally)
|
||||
|
||||
Compilation is tested with GCC 5.5.0, it should run also with older 5.x versions. It will not work with GCC 4.x and older.
|
||||
|
||||
## Getting full source code of sjasmplus
|
||||
|
||||
Use `git` to clone the github repository and all git-submodules:
|
||||
|
||||
git clone --recursive -j8 https://github.com/z00m128/sjasmplus.git
|
||||
|
||||
If you already have cloned repository without submodules, you can update submodules only by:
|
||||
|
||||
git submodule update --init --recursive
|
||||
|
||||
If you are not using `git`, you can download and extract archive from releases, the manually added `.tar.xz` one (the automatically github provided zip files are missing the submodules sources and will fail to build). Or you can download the github provided archives, but then you need to download each submodule individually and extract them to correct folders inside sjasmplus folder.
|
||||
|
||||
## Default method for GNU/Linux / Unix / macOS / BSD
|
||||
|
||||
Go to folder with sjasmplus project. Edit install path `PREFIX` in file `Makefile` according your preferences (default `/usr/local`). Run following commands:
|
||||
|
||||
make clean
|
||||
make
|
||||
|
||||
Then run as root or use sudo:
|
||||
|
||||
make install
|
||||
|
||||
### Gentoo GNU/Linux
|
||||
|
||||
Check [cizo2000's github gentoo-overlay/dev-util/sjasmplus](https://github.com/cizo2000/gentoo-overlay/tree/master/dev-util/sjasmplus) for ebuild files.
|
||||
|
||||
### Arch Linux
|
||||
|
||||
Recently (2022) it seems leo72 started providing AUR for z00m's fork of sjasmplus: [aur.archlinux.org/packages/sjasmplus-z00m128](https://aur.archlinux.org/packages/sjasmplus-z00m128) (AFAIK there's no connection with any maintainer of this project, but hopefully this will continue and provide good experience to AUR users, thanks leo72).
|
||||
|
||||
## Default method for MS Windows
|
||||
|
||||
Go to folder with sjasmplus project. Edit install path `PREFIX` in file `Makefile.win` according your preferences (default `c:\mingw\usr\local\bin`). Remove `-static` parameter in `CFLAGS` if you don't need standalone Windows executable (binary is MinGW dependant then, but it's smaller). Run following commands:
|
||||
|
||||
make -f Makefile.win clean
|
||||
make -f Makefile.win
|
||||
make -f Makefile.win install
|
||||
|
||||
## CMAKE method for Linux / Unix / macOS / BSD
|
||||
|
||||
Go to folder with sjasmplus project and run following set of commands:
|
||||
|
||||
mkdir build
|
||||
cd build
|
||||
cmake -DCMAKE_BUILD_TYPE=Release ..
|
||||
make
|
||||
make install
|
||||
|
||||
The project will use internal copy of Lua 5.4.4 by default, but you can use system Lua 5.4 by using `-DSYSTEM_LUA=ON`.
|
||||
|
||||
For disabling of LUA scripting support add `-DENABLE_LUA=OFF` option:
|
||||
|
||||
cmake -DENABLE_LUA=OFF ..
|
||||
|
||||
Binary sjasmplus file will be placed in `/usr/bin` by default.
|
||||
|
||||
To change install directory prefix add `-DCMAKE_INSTALL_PREFIX:PATH` option with specified prefix:
|
||||
|
||||
cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/local ..
|
||||
|
||||
## CMake method for MS Windows
|
||||
|
||||
Go to folder with sjasmplus project. Delete or rename file `Makefile`. Rename file `Makefile.win` to `Makefile`. Create `build` subdirectory and enter to it. Run following command:
|
||||
|
||||
cmake-gui
|
||||
|
||||
Click `Browse Source...` button, select extracted tarball folder. Click `Browse Build...` button, select the `build` folder. Click `Configure` button, select `MinGW Makefiles`, select `Use default native compilers`. Click `Finish` and wait until configuration is done. Change `CMAKE_INSTALL_PREFIX` install path according your preferences (click on path). Click `Generate`. Run `cmd.exe`, enter the build directory and run following commands:
|
||||
|
||||
make
|
||||
make install
|
||||
|
||||
The CMake can generate also VS project files, and sources should compile with VS compiler, since
|
||||
v1.14.1 the VS built executable should mostly work as well as MinGW, although there are still
|
||||
corner-case bugs which need to be fixed, see issues #77 and #78 for details/progress and to help.
|
||||
|
||||
The official binary "exe" is built with MinGW toolchain and that's recommended option.
|
||||
|
||||
## Helping with sjasmplus development
|
||||
|
||||
There are few extra recommendations if you want to join sjasmplus development and use all the features:
|
||||
|
||||
- work with git clone of repository ideally, so you can easily update to latest source base, track your changes or review changes of other developers
|
||||
- within the git repository init and update the submodules too, this will clone the UnitTest++ and LuaBridge2.8 repository which are required to build sjasmplus and unit tests (`git submodule init`, `git submodule update`)
|
||||
- linux + gcc + Makefile is the config of Ped7g, having access to the same config to re-create his workflow locally may be of help (when troubleshooting some issue or comparing results with different platform)
|
||||
- but having different local configuration would be very helpful to keep the source base cross-platform and in good shape
|
||||
- you can check `.cirrus.yml` file and accompanying scripts/batch-files in `ContinuousIntegration` folder to see how different environments and different build tasks are prepared and executed. If you are not familiar with CI setup and configuration yet, you should take at least a brief glimpse on it, even if you want just to contribute small patch to the sjasmplus, because any pull request will be scrutinized by the CI build system automatically.
|
||||
|
||||
My (Ped7g) local workflow is:
|
||||
|
||||
1. KDevelop IDE set up to use CMake import of project to build+install debug binary in my `~/.local/bin` folder, which is the first binary found by my search path (to build + install the sjasmplus I use Project/Install Selection [Shift+F8]).
|
||||
1. with new debug binary locally installed, I run in terminal `ContinuousIntegration/test_folder_tests.sh` to verify if it works (adding new tests exercising the feature/change which I am working at). Sometimes I limit the scope of tests being run by adding argument to the script like "module" to run only `tests/modules/*` tests.
|
||||
1. when I'm finished with a change, and I'm preparing commit, I use `make clean && make` to verify the release can be built too, and `make DEBUG=1 clean && make DEBUG=1 coverage` to run full test suite, C++ unit tests and create coverage report (text files in build directory) so I can manually check if everything did change as expected.
|
||||
1. after this review I commit + push the changes to the repository, where the Cirrus CI setup will try to replicate my local experience in different environments of the CI, if some of these fails, I check the Cirrus logs to see why build failed, and work on the fix commit.
|
||||
1. when working on small/medium change where I'm sure I can get main repository into "green" state whenever I push changes to github, I tend to work directly on `master` branch, but when experimenting with things with unclear outcome, I use experimental branches, later merging them into `master` when they are ready (or even my fork of the main repository, if the experiment is really just experiment, and I am not even sure if it will ever land in the main repository).
|
||||
|
||||
Enjoy!
|
||||
@@ -0,0 +1,72 @@
|
||||
# sjasmplus
|
||||
[](https://cirrus-ci.com/github/z00m128/sjasmplus/master)
|
||||
[](https://github.com/z00m128/sjasmplus/)
|
||||
[](https://github.com/z00m128/sjasmplus/blob/master/LICENSE.md)
|
||||
[](https://coveralls.io/github/z00m128/sjasmplus?branch=master)
|
||||
[](https://github.com/z00m128/sjasmplus/actions/workflows/codeql-analysis.yml)
|
||||
[](https://www.linux.org/)
|
||||
[](https://www.freebsd.org/)
|
||||
[](https://www.netbsd.org/)
|
||||
[](https://www.raspberrypi.org/)
|
||||
[](https://www.apple.com/lae/macos/)
|
||||
[](https://www.microsoft.com/en-us/windows)
|
||||
|
||||
Command-line cross-compiler of assembly language for [Z80 CPU](https://en.wikipedia.org/wiki/Zilog_Z80).
|
||||
|
||||
Supports many [ZX-Spectrum](https://en.wikipedia.org/wiki/ZX_Spectrum) specific directives, has built-in Lua scripting engine and 3-pass design.
|
||||
|
||||
For GNU/Linux, BSD, Raspberry Pi, macOS and [Windows (click for exe)](https://github.com/z00m128/sjasmplus/releases/latest).
|
||||
|
||||
GNU make or CMake [installation methods](INSTALL.md) for your convenience.
|
||||
|
||||
Online [documentation](http://z00m128.github.io/sjasmplus/documentation.html) (it is also included in the binary-release zip for offline viewing).
|
||||
|
||||
Post issues, feedback, feature requests, etc on [github](https://github.com/z00m128/sjasmplus/issues).
|
||||
|
||||
Main Features
|
||||
=============
|
||||
|
||||
* Full source of assembler available under BSD license, modify and extend as you wish
|
||||
* Z80/R800/Z80N/i8080/LR35902 documented and undocumented opcodes support
|
||||
* Macro language, defines, array of defines
|
||||
* Built-in Lua scripting engine
|
||||
* Conditional assembly, block repeating
|
||||
* Modules (namespaces), local and temporary labels
|
||||
* Source and binary file inclusion, include paths
|
||||
* Multi file output, file updating, various types of exports
|
||||
* Structures to work easily with structured data in memory (`STRUCT` pseudo-op)
|
||||
* Relocation data generator to support SymbOS-like relocation of executables
|
||||
* Virtual device mode for common machines: ZX 128, ZX Next, Amstrad CPC, … (pseudo op `DEVICE`)
|
||||
* ZX Spectrum specific directives and pseudo ops (SAVESNA, SAVETAP, SAVEHOB, INCHOB, INCTRD…)
|
||||
* ZX Spectrum Next specific features and directives (Z80N, 8ki memory paging, `SAVENEX`)
|
||||
* Amstrad CPC 464/6128 specific directives (`SAVECPCSNA`)
|
||||
* Correctness is assured by Cirrus-CI with 380+ automated tests (that's also 380+ examples of usage!)
|
||||
* Fake instructions as `LD HL,DE` (`LD H,D:LD L,E`) and more
|
||||
* Code inlining through colon (`LD A,C:INC A:PUSH AF:IFDEF FX:LD A,D:ENDIF`…)
|
||||
* Very fast compilation: 1 million lines by 2-3 seconds on modern computer
|
||||
* Multiline block comments and user’s messages
|
||||
|
||||
This repository was created by import from original Aprisobal's repository @ https://sourceforge.net/projects/sjasmplus/.
|
||||
|
||||
### Other useful tools for sjasmplus users
|
||||
|
||||
Some of these may be useful for sjasmplus users (depending on the platform and tools you are using):
|
||||
|
||||
[Support for Z80 macro-assemblers in Visual Studio Code](https://github.com/mborik/z80-macroasm-vscode) - syntax highlighting, "problem matcher" for assembler output, on hover info about labels, symbols, completion proposals,
|
||||
renaming provider, macro documenter and arguments definitions.
|
||||
|
||||
This can be further complemented by [Z80 Assembly meter](https://github.com/theNestruo/z80-asm-meter-vscode) plugin for Visual Studio Code.
|
||||
|
||||
[#CSpect](http://cspect.org/) is ZX Spectrum Next emulator with built-in debugger and map-files support to show labels from source code.
|
||||
|
||||
[ZEsarUX](https://github.com/chernandezba/zesarux) is multi-machine emulator focusing on ZX Spectrum family of machines, including also ZX Spectrum Next, having many many options, lot of menus, and lot debugging capabilities - if you are particularly interested into ZX Spectrum Next SW development, the #CSpect is often a bit ahead in overall emulation fidelity, but ZEsarUX is often more accurate in subtle edge-case details, so you may want to have both of them around for different occasions. Also you may want to have ZEsarUX around for:
|
||||
|
||||
[DeZog - Z80 Debugger (for Visual Studio Code)](https://github.com/maziac/DeZog) for debugging ZX Spectrum code, writing unit tests for it, time the execution, etc.
|
||||
|
||||
(if you are not excited about using VSC as IDE and want to try some alternative) Syntax highlight (only)
|
||||
for [Kate editor](https://kate-editor.org/) is
|
||||
included directly in sjasmplus [sources](https://github.com/z00m128/sjasmplus/blob/master/asm-z80-sj.xml).
|
||||
|
||||
--------------------
|
||||
|
||||
_All product names, trademarks and registered trademarks are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names,trademarks and brands does not imply endorsement._
|
||||
@@ -0,0 +1,119 @@
|
||||
|
||||
body {
|
||||
background-color: #CDF;
|
||||
}
|
||||
|
||||
/********************************/
|
||||
/* start of styles in block.xsl */
|
||||
|
||||
.formalpara-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.blockquote-title {
|
||||
font-weight: bold;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
span.msgmain-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
span.msgsub-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
span.msgrel-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.msglevel, div.msgorig, div.msgaud {
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
span.msglevel-title, span.msgorig-title, span.msgaud-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.msgexplan {
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
span.msgexplan-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* end of styles in block.xsl */
|
||||
/********************************/
|
||||
|
||||
/********************************/
|
||||
/* start of styles in autotoc.xsl */
|
||||
|
||||
|
||||
/* end of styles in autotoc.xsl */
|
||||
/********************************/
|
||||
|
||||
/********************************/
|
||||
/* start of styles in formal.xsl */
|
||||
|
||||
div.figure-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.example-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.equation-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.table-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
|
||||
/* end of styles in formal.xsl */
|
||||
/********************************/
|
||||
|
||||
/********************************/
|
||||
/* start of styles in verbatim.xsl */
|
||||
|
||||
pre.programlisting {
|
||||
font-family: monospace;
|
||||
font-size: 1.1em;
|
||||
white-space: pre;
|
||||
background: #EEE;
|
||||
border: 1px solid gray;
|
||||
padding: 1em;
|
||||
margin: 1em;
|
||||
|
||||
max-width: 80em;
|
||||
overflow: auto; /* add scrollbar if the listing doesn't fit on screen*/
|
||||
}
|
||||
|
||||
pre.synopsis {
|
||||
white-space: pre;
|
||||
font-family: monospace;
|
||||
overflow: auto; /* add scrollbar if the listing doesn't fit on screen*/
|
||||
}
|
||||
|
||||
div.screen {
|
||||
white-space: pre;
|
||||
font-family: monospace;
|
||||
}
|
||||
|
||||
/* end of styles in verbatim.xsl */
|
||||
/********************************/
|
||||
|
||||
/* footnote rule */
|
||||
hr.footnote-hr {
|
||||
width: 100;
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
Binary file not shown.
|
After Width: | Height: | Size: 4.1 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Reference in New Issue
Block a user