nonconformant clone of man 1 ed for Windows which actually works. I've tried various ports, they seem to struggle either with Unicode or with shell pipes. JakED corrects this state.
See TODO for current status. 99% complete, but the performance is kinda bad for 200MB files (which Vim can handle neatly; my goal is to eventually beat Vim!)
| File | Description |
|---|---|
jaked.cpp |
Main code (parsers, commands, state, UI). Yeah, it should be refactored |
swapfile.{h,cpp} |
Swapfile implementation |
shell.{h,cpp} |
Shell escape implementation |
jaked_test.cpp |
Internal test bed. This wraps jaked.cpp and the test suites, which are in include files to keep them slightly organized test/*.ixx |
cprintf.h |
Header containing cprintf, which is a conditionally compiled printf based on tokens. This file is generated. |
cprintf_generate.c |
Generates cprintf.h based on tokens passed to the command line. Uses cprintf_template.h as a template. |
chrono.c |
Quick re-implementation of UNIX time |
test/*.ed, test/*.ref |
External test-files. The .ed scripts are the input and the .ref files are the reference file. |
makeutf8bom.c |
generate a UTF8 file with a BOM to test that jaked "correctly" reads it as ASCII |
Currently, there are internal tests and external tests.
jaked_test.cpp is the test bed for internal tests. It includes jaked.cpp and the test suites in test/*.ixx. I've opted to use the include-a-c-file technique to allow me to properly influence the behaviour of things.
For example, application_exit is handled as an exception when under test, because calling exit(0) is not nice.
Test suites and cases are defined with the provided macros.
Each suite is executed in its own process, and this process kills itself after a certain Timeout.
Cases within a suite are executed in order, so you could pass state on if you're into that kind of thing.
The testbed has its own sanity tests, because who tests the testers?
External tests are currently of the execute commands, write, compare file with reference. The inputs are in test/*.ed files and the refs in test/*.ref files.
The last stage of nmake test is MSVC's built-in static code analysis. This is mostly to check that cprintf and printf are invoked with correct parameters.
As of 2022 this is disabled because it started giving errors where it previously didn't; TODO FIXME
The only command you need is nmake jaked.exe. It's a stand-alone executable. See the Makefile for gory details.
JakED is written in C++17 (due to if constexpr, I guess?) so you should use MSVC++15 (aka VS 2017; or 2019, that also works; newer versions should continue to work). Obviously it only runs on Windows.