From 9e11019b87ba27d1dac9e097dc212a126e404218 Mon Sep 17 00:00:00 2001 From: Gary Talent Date: Fri, 1 Nov 2024 22:21:09 -0500 Subject: [PATCH] Squashed 'deps/nostalgia/' changes from 66cd5c4a..3c7652ef 3c7652ef [nostalgia/core/studio] Fix PaletteEditor to handle Palettes with 0 pages 941bc713 [studio] Fix NewMenu name input e4ae23e1 [olympic/developer-handbook] Remove Ox submodules from project structure 67187d5e [olympic/developer-handbook] Elaborate more on exception usage 3271a371 [ox] Add Project Structure section to docs ea9f50de [olympic] Add error handling back to developer-handbook.md ea3c5e03 [olympic] Remove Ox from developer-handbook.md c8c4177d [ox] Add ox-docs.md 76b540e3 [nostalgia/core] Cleanup, add missing FileAddress wrapper function 20627486 [keel] Cleanup 135f0e4c [nostalgia/core/studio/paletteeditor] Fix Alt shortcuts to respect keyboard focus cb166876 [studio] Add variant of InputText that returns an IString cb3ef0e7 [keel] Cleanup 0a62d900 [studio] Remove Editor::setRequiresConstantRefresh ba7e3929 [nostalgia/core/studio] Make TileSheetEditor palette keys behave like PaletteEditor 36c4022b [nostalgia/core/studio] Fix PaletteEditor shortcuts to differentiate based on Alt key e22b25e5 [studio] Remove Editor::requiresConstantRefresh c6efabaa [studio,nostalgia] Fix PaletteEditor color update command merging, add setObsolete 1f6fefdb [nostalgia/core/studio] Disable PaletteEditor num key shorts when page rename is open 1e34f91e Merge commit '34b7779397bd4712603b4c5a39ffc57b74da0abd' 35cb2ece [nostalgia/core/studio] Fix PaletteEditor color name edit git-subtree-dir: deps/nostalgia git-subtree-split: 3c7652efc205cb3acdb993d7eeb1e2c2d894c2cb --- deps/ox/ox-docs.md | 482 +++++++++++++++++ developer-handbook.md | 503 ++---------------- .../core/include/nostalgia/core/gfx.hpp | 8 + src/nostalgia/modules/core/src/gba/gfx.cpp | 32 -- src/nostalgia/modules/core/src/gfx.cpp | 44 ++ src/nostalgia/modules/core/src/opengl/gfx.cpp | 39 -- .../paletteeditor/paletteeditor-imgui.cpp | 91 ++-- .../paletteeditor/paletteeditor-imgui.hpp | 4 +- .../studio/paletteeditor/paletteeditor.cpp | 14 +- .../studio/paletteeditor/paletteeditor.hpp | 4 +- .../tilesheeteditor/tilesheeteditor-imgui.cpp | 16 +- .../scene/src/studio/sceneeditor-imgui.cpp | 1 - src/olympic/keel/include/keel/media.hpp | 6 +- src/olympic/keel/src/media.cpp | 8 +- src/olympic/studio/applib/src/newmenu.cpp | 2 +- .../studio/modlib/include/studio/editor.hpp | 8 +- .../modlib/include/studio/imguiutil.hpp | 28 +- .../modlib/include/studio/undocommand.hpp | 11 +- src/olympic/studio/modlib/src/editor.cpp | 12 +- src/olympic/studio/modlib/src/undocommand.cpp | 2 +- src/olympic/studio/modlib/src/undostack.cpp | 4 + 21 files changed, 679 insertions(+), 640 deletions(-) create mode 100644 deps/ox/ox-docs.md diff --git a/deps/ox/ox-docs.md b/deps/ox/ox-docs.md new file mode 100644 index 0000000..3762c29 --- /dev/null +++ b/deps/ox/ox-docs.md @@ -0,0 +1,482 @@ + +# Ox Docs + +## Project Structure + +All components have a platform indicator next to them: + + (OB) - OS, Bare Metal + (-B) - Bare Metal + (O-) - OS + +* Ox - Library of things useful for portable bare metal and userland code. Not really that external... + * clargs - Command Line Args processing (OB) + * claw - Reads and writes Metal or Organic Claw with header to indicate which + * event - Qt-like signal system (OB) + * fs - file system (OB) + * logconn - connects logging to Bullock (O-) + * mc - Metal Claw serialization, builds on model (OB) + * oc - Organic Claw serialization (wrapper around JsonCpp), builds on model (O-) + * model - Data structure modelling (OB) + * preloader - library for handling preloading of data (OB) + * std - Standard-ish Library with a lot missing and some things added (OB) + +## Systems + +### Error Handling + +Ox provides ```ox::Error``` to report errors. +```ox::Error``` is a struct that has overloaded operators to behave like an +integer error code, plus some extra fields to enhance debuggability. +If instantiated through the ```OxError(x)``` macro, it will also include the +file and line of the error. +The ```OxError(x)``` macro should only be used for the initial instantiation of +an ```ox::Error```. + +In addition to ```ox::Error``` there is also the template ```ox::Result```. +```ox::Result``` simply wraps the type T value in a struct that also includes +error information, which allows the returning of a value and an error without +resorting to output parameters. + +If a function returns an ```ox::Error``` or ```ox::Result``` it should be +declared as ```noexcept``` and all exceptions should be translated to an +```ox::Error```. + +```ox::Result``` can be used as follows: + +```cpp +ox::Result foo(int i) noexcept { + if (i < 10) { + return i + 1; // implicitly calls ox::Result::Result(T) + } + return OxError(1); // implicitly calls ox::Result::Result(ox::Error) +} + +int caller1() { + auto v = foo(argc); + if (v.error) { + return 1; + } + std::cout << v.value << '\n'; + return 0; +} + +int caller2() { + // it is also possible to capture the value and error in their own variables + auto [val, err] = foo(argc); + if (err) { + return 1; + } + std::cout << val << '\n'; + return 0; +} + +ox::Error caller3(int &i) { + return foo(i).moveTo(i); +} + +ox::Error caller4(int &i) { + return foo(i).copyTo(i); +} + +int caller5(int i) { + return foo(i).unwrap(); // unwrap will kill the program if there is an error +} + +int caller6(int i) { + return foo(i).unwrapThrow(); // unwrap will throw if there is an error +} + +int caller7(int i) { + return foo(i).or_value(0); // will return 0 if foo returned an error +} + +ox::Result caller8(int i) { + return foo(i).to(); // will convert the result of foo to uint64_t +} +``` + +Lastly, there are a few macros available to help in passing ```ox::Error```s +back up the call stack, ```oxReturnError```, ```oxThrowError```, and +```oxRequire```. + +```oxReturnError``` is by far the more helpful of the two. +```oxReturnError``` will return an ```ox::Error``` if it is not 0 and +```oxThrowError``` will throw an ```ox::Error``` if it is not 0. + +Since ```ox::Error``` is always nodiscard, you must do something with them. +In rare cases, you may not have anything you can do with them or you may know +the code will never fail in that particular instance. +This should be used sparingly. + + +```cpp +void studioCode() { + auto [val, err] = foo(1); + oxThrowError(err); + doStuff(val); +} + +ox::Error engineCode() noexcept { + auto [val, err] = foo(1); + oxReturnError(err); + doStuff(val); + return {}; +} + +void anyCode() { + auto [val, err] = foo(1); + std::ignore = err; + doStuff(val); +} +``` + +Both macros will also take the ```ox::Result``` directly: + +```cpp +void studioCode() { + auto valerr = foo(1); + oxThrowError(valerr); + doStuff(valerr.value); +} + +ox::Error engineCode() noexcept { + auto valerr = foo(1); + oxReturnError(valerr); + doStuff(valerr.value); + return {}; +} +``` + +Ox also has the ```oxRequire``` macro, which will initialize a value if there is no error, and return if there is. +It aims to somewhat emulate the ```?``` operator in Rust and Swift. + +Rust ```?``` operator: +```rust +fn f() -> Result { + // do stuff +} + +fn f2() -> Result { + let i = f()?; + Ok(i + 4) +} +``` + +```oxRequire```: +```cpp +ox::Result f() noexcept { + // do stuff +} + +ox::Result f2() noexcept { + oxRequire(i, f()); // const auto [out, oxConcat(oxRequire_err_, __LINE__)] = x; oxReturnError(oxConcat(oxRequire_err_, __LINE__)) + return i + 4; +} +``` +```oxRequire``` is not quite as versatile, but it should still cleanup a lot of otherwise less ideal code. + +```oxRequire``` also has variants for throwing the error and for making to value non-const: + +* ```oxRequireM``` - oxRequire Mutable +* ```oxRequireT``` - oxRequire Throw +* ```oxRequireMT``` - oxRequire Mutable Throw + +The throw variants of ```oxRequire``` are generally legacy code. +```ox::Result::unwrapThrow``` is generally preferred now. + +### Logging and Output + +Ox provides for logging and debug prints via the ```oxTrace```, ```oxDebug```, and ```oxError``` macros. +Each of these also provides a format variation. + +Ox also provide ```oxOut``` and ```oxErr``` for printing to stdout and stderr. +These are intended for permanent messages and always go to stdout and stderr. + +Tracing functions do not go to stdout unless the OXTRACE environment variable is set. +They also print with the channel that they are on, along with file and line. + +Debug statements go to stdout and go to the logger on the "debug" channel. +Where trace statements are intended to be written with thoughtfulness, +debug statements are intended to be quick and temporary insertions. +Debug statements trigger compilation failures if OX_NODEBUG is enabled when CMake is run, +as it is on Jenkins builds, so ```oxDebug``` statements should never be checked in. +This makes ```oxDebug``` preferable to other forms of logging, as temporary prints should +never be checked in. + +```oxError``` always prints. +It includes file and line, and is prefixed with a red "ERROR:". +It should generally be used conservatively. +It shuld be used only when there is an error that is not technically fatal, but +the user almost certainly wants to know about it. + +```oxTrace``` and ```oxTracef```: +```cpp +void f(int x, int y) { // x = 9, y = 4 + oxTrace("nostalgia.core.sdl.gfx") << "f:" << x << y; // Output: "f: 9 4" + oxTracef("nostalgia.core.sdl.gfx", "f: {}, {}", x, y); // Output: "f: 9, 4" +} +``` + +```oxDebug``` and ```oxDebugf```: +```cpp +void f(int x, int y) { // x = 9, y = 4 + oxDebug() << "f:" << x << y; // Output: "f: 9 4" + oxDebugf("f: {}, {}", x, y); // Output: "f: 9, 4" +} +``` + +```oxError``` and ```oxErrorf```: +```cpp +void f(int x, int y) { // x = 9, y = 4 + oxError() << "f:" << x << y; // Output: "ERROR: (:): f: 9 4" + oxErrorf("f: {}, {}", x, y); // Output: "ERROR: (:): f: 9, 4" +} +``` + +### Model System + +Ox has a model system that provides a sort of manual reflection mechanism. + +Models require a model function for the type that you want to model. +It is also good to provide a type name and type version number, though that is not required. + +The model function takes an instance of the type it is modelling and a template +parameter type. +The template parameter type must implement the API used in the models, but it +can do anything with the data provided to it. + +Here is an example from the Nostalgia/Core package: + +```cpp +struct NostalgiaPalette { + static constexpr auto TypeName = "net.drinkingtea.nostalgia.core.NostalgiaPalette"; + static constexpr auto TypeVersion = 1; + ox::Vector colors; +}; + +struct NostalgiaGraphic { + static constexpr auto TypeName = "net.drinkingtea.nostalgia.core.NostalgiaGraphic"; + static constexpr auto TypeVersion = 1; + int8_t bpp = 0; + // rows and columns are really only used by TileSheetEditor + int rows = 1; + int columns = 1; + ox::FileAddress defaultPalette; + NostalgiaPalette pal; + ox::Vector pixels; +}; + +template +constexpr ox::Error model(T *h, ox::CommonPtrWith auto *pal) noexcept { + h->template setTypeInfo(); + // it is also possible to provide the type name and type version as function arguments + //h->setTypeInfo("net.drinkingtea.nostalgia.core.NostalgiaPalette", 1); + oxReturnError(h->field("colors", &pal->colors)); + return {}; +} + +template +constexpr ox::Error model(T *h, ox::CommonPtrWith auto *ng) noexcept { + h->template setTypeInfo(); + oxReturnError(h->field("bpp", &ng->bpp)); + oxReturnError(h->field("rows", &ng->rows)); + oxReturnError(h->field("columns", &ng->columns)); + oxReturnError(h->field("defaultPalette", &ng->defaultPalette)); + oxReturnError(h->field("pal", &ng->pal)); + oxReturnError(h->field("pixels", &ng->pixels)); + return {}; +} +``` + +The model system also provides for unions: + +```cpp + +#include + +class FileAddress { + + template + friend constexpr Error model(T*, ox::CommonPtrWith auto*) noexcept; + + public: + static constexpr auto TypeName = "net.drinkingtea.ox.FileAddress"; + + union Data { + static constexpr auto TypeName = "net.drinkingtea.ox.FileAddress.Data"; + char *path; + const char *constPath; + uint64_t inode; + }; + + protected: + FileAddressType m_type = FileAddressType::None; + Data m_data; + +}; + +template +constexpr Error model(T *h, ox::CommonPtrWith auto *obj) noexcept { + h->template setTypeInfo(); + oxReturnError(h->fieldCString("path", &obj->path)); + oxReturnError(h->fieldCString("constPath", &obj->path)); + oxReturnError(h->field("inode", &obj->inode)); + return {}; +} + +template +constexpr Error model(T *io, ox::CommonPtrWith auto *fa) noexcept { + io->template setTypeInfo(); + // cannot read from object in Reflect operation + if constexpr(ox_strcmp(T::opType(), OpType::Reflect) == 0) { + int8_t type = 0; + oxReturnError(io->field("type", &type)); + oxReturnError(io->field("data", UnionView(&fa->m_data, 0))); + } else { + auto type = static_cast(fa->m_type); + oxReturnError(io->field("type", &type)); + fa->m_type = static_cast(type); + oxReturnError(io->field("data", UnionView(&fa->m_data, static_cast(fa->m_type)))); + } + return {}; +} + +``` + +There are also macros in `````` for simplifying the declaration of models: + +```cpp +oxModelBegin(NostalgiaGraphic) + oxModelField(bpp) + oxModelField(rows) + oxModelField(columns) + oxModelField(defaultPalette) + oxModelField(pal) + oxModelField(pixels) +oxModelEnd() +``` + +### Serialization + +Using the model system, Ox provides for serialization. +Ox has MetalClaw and OrganicClaw as its serialization format options. +MetalClaw is a custom binary format designed for minimal size. +OrganicClaw is a wrapper around JsonCpp, chosen because it technically +implements a superset of JSON. +OrganicClaw requires support for 64 bit integers, whereas normal JSON +technically does not. + +These formats do not currently support floats. + +There is also a wrapper format called Claw that provides a header at the +beginning of the file and can dynamically switch between the two depending on +what the header says is present. +The Claw header also includes information about the type and type version of +the data. + +Claw header: ```M1;net.drinkingtea.nostalgia.core.NostalgiaPalette;1;``` + +That reads: + +* Format is Metal Claw, version 1 +* Type ID is net.drinkingtea.nostalgia.core.NostalgiaPalette +* Type version is 1 + +#### Metal Claw Example + +##### Read + +```cpp +#include + +ox::Result loadPalette1(ox::BufferView const&buff) noexcept { + return ox::readMC(buff); +} + +ox::Result loadPalette2(ox::BufferView const&buff) noexcept { + NostalgiaPalette pal; + oxReturnError(ox::readMC(buff, pal)); + return pal; +} +``` + +##### Write + +```cpp +#include + +ox::Result writeSpritePalette1(NostalgiaPalette const&pal) noexcept { + ox::Buffer buffer(ox::units::MB); + std::size_t sz = 0; + oxReturnError(ox::writeMC(buffer.data(), buffer.size(), pal, &sz)); + buffer.resize(sz); + return buffer; +} + +ox::Result writeSpritePalette2(NostalgiaPalette const&pal) noexcept { + return ox::writeMC(pal); +} +``` + +#### Organic Claw Example + +##### Read + +```cpp +#include + +ox::Result loadPalette1(ox::BufferView const&buff) noexcept { + return ox::readOC(buff); +} + +ox::Result loadPalette2(ox::BufferView const&buff) noexcept { + NostalgiaPalette pal; + oxReturnError(ox::readOC(buff, &pal)); + return pal; +} +``` + +##### Write + +```cpp +#include + +ox::Result writeSpritePalette1(NostalgiaPalette const&pal) noexcept { + ox::Buffer buffer(ox::units::MB); + oxReturnError(ox::writeOC(buffer.data(), buffer.size(), pal)); + return buffer; +} + +ox::Result writeSpritePalette2(NostalgiaPalette const&pal) noexcept { + return ox::writeOC(pal); +} +``` + +#### Claw Example + +##### Read + +```cpp +#include + +ox::Result loadPalette1(ox::BufferView const&buff) noexcept { + return ox::readClaw(buff); +} + +ox::Result loadPalette2(ox::BufferView const&buff) noexcept { + NostalgiaPalette pal; + oxReturnError(ox::readClaw(buff, pal)); + return pal; +} +``` + +##### Write + +```cpp +#include + +ox::Result writeSpritePalette(NostalgiaPalette const&pal) noexcept { + return ox::writeClaw(pal); +} +``` diff --git a/developer-handbook.md b/developer-handbook.md index a2cb24e..1ea62ca 100644 --- a/developer-handbook.md +++ b/developer-handbook.md @@ -1,4 +1,4 @@ -# Nostalgia Developer Handbook +# Olympic Developer Handbook ## About @@ -44,21 +44,16 @@ All components have a platform indicator next to them: * gba - GBA implementation (PG) * glfw - GLFW implementation (P-) * deps - project dependencies - * Ox - Library of things useful for portable bare metal and userland code. Not really that external... - * clargs - Command Line Args processing (PG) - * claw - Reads and writes Metal or Organic Claw with header to indicate which - * event - Qt-like signal system - * fs - file system (PG) - * logconn - connects logging to Bullock (P-) - * mc - Metal Claw serialization, builds on model (PG) - * oc - Organic Claw serialization (wrapper around JsonCpp), builds on model (P-) - * model - Data structure modelling (PG) - * preloader - library for handling preloading of data (PG) - * std - Standard-ish Library with a lot missing and some things added (PG) + * Ox - Library of things useful for portable bare metal and userland code. + Not really that external... (PG) * GlUtils - OpenGL helpers (P-) * teagba - GBA assembly startup code (mostly pulled from devkitPro under MPL 2.0), and custom GBA hardware interop code (-G) +Most GBA code is built on PC because it is small and helps to work on both +projects with the same CMake build dir, but GBA code is never linked with any +executables on PC. + ## Platform Notes ### GBA @@ -88,6 +83,7 @@ The GBA has two major resources for learning about its hardware: * Pointer and reference designators should be bound to the identifier name and not the type, unless there is not identifier name, in which case it should be bound to the type. +* East const ### Write C++, Not C @@ -160,479 +156,40 @@ classes in question. ## Project Systems +Olympic builds on Ox as its standard-ish library. +Please read the [Ox documentation](deps/ox/ox-docs.md). +The Ox way of doing things is the Olympic way of doing things. + ### Error Handling The GBA build has exceptions disabled. -Instead of throwing exceptions, all engine code must return ```ox::Error```s. +Instead of throwing exceptions, all engine code should return +[ox::Errors](deps/ox/ox-docs.md#error-handling) for error reporting. For the sake of consistency, try to stick to ```ox::Error``` in non-engine code as well, but non-engine code is free to use exceptions when they make sense. -Nostalgia and Ox both use ```ox::Error``` to report errors. ```ox::Error``` is -a struct that has overloaded operators to behave like an integer error code, -plus some extra fields to enhance debuggability. -If instantiated through the ```OxError(x)``` macro, it will also include the -file and line of the error. -The ```OxError(x)``` macro should only be used for the initial instantiation of -an ```ox::Error```. -In addition to ```ox::Error``` there is also the template ```ox::Result```. -```ox::Result``` simply wraps the type T value in a struct that also includes -error information, which allows the returning of a value and an error without -resorting to output parameters. - -If a function returns an ```ox::Error``` or ```ox::Result``` it should be -declared as ```noexcept``` and all exceptions should be translated to an -```ox::Error```. - -```ox::Result``` can be used as follows: - -```cpp -ox::Result foo(int i) noexcept { - if (i < 10) { - return i + 1; // implicitly calls ox::Result::Result(T) - } - return OxError(1); // implicitly calls ox::Result::Result(ox::Error) -} - -int caller1() { - auto v = foo(argc); - if (v.error) { - return 1; - } - std::cout << v.value << '\n'; - return 0; -} - -int caller2() { - // it is also possible to capture the value and error in their own variables - auto [val, err] = foo(argc); - if (err) { - return 1; - } - std::cout << val << '\n'; - return 0; -} - -ox::Error caller3(int &i) { - return foo(i).moveTo(i); -} - -ox::Error caller4(int &i) { - return foo(i).copyTo(i); -} - -int caller5(int i) { - return foo(i).unwrap(); // unwrap will kill the program if there is an error -} - -int caller6(int i) { - return foo(i).unwrapThrow(); // unwrap will throw if there is an error -} - -int caller7(int i) { - return foo(i).or_value(0); // will return 0 if foo returned an error -} - -ox::Result caller8(int i) { - return foo(i).to(); // will convert the result of foo to uint64_t -} -``` - -Lastly, there are a few macros available to help in passing ```ox::Error```s -back up the call stack, ```oxReturnError```, ```oxThrowError```, and -```oxRequire```. - -```oxReturnError``` is by far the more helpful of the two. -```oxReturnError``` will return an ```ox::Error``` if it is not 0 and -```oxThrowError``` will throw an ```ox::Error``` if it is not 0. -Because exceptions are disabled for GBA builds and thus cannot be used in the -engine, ```oxThrowError``` is only really useful at the boundary between -engine libraries and Nostalgia Studio. - -Since ```ox::Error``` is always nodiscard, you must do something with them. -In rare cases, you may not have anything you can do with them or you may know -the code will never fail in that particular instance. -This should be used sparingly. - - -```cpp -void studioCode() { - auto [val, err] = foo(1); - oxThrowError(err); - doStuff(val); -} - -ox::Error engineCode() noexcept { - auto [val, err] = foo(1); - oxReturnError(err); - doStuff(val); - return {}; -} - -void anyCode() { - auto [val, err] = foo(1); - std::ignore = err; - doStuff(val); -} -``` - -Both macros will also take the ```ox::Result``` directly: - -```cpp -void studioCode() { - auto valerr = foo(1); - oxThrowError(valerr); - doStuff(valerr.value); -} - -ox::Error engineCode() noexcept { - auto valerr = foo(1); - oxReturnError(valerr); - doStuff(valerr.value); - return {}; -} -``` - -Ox also has the ```oxRequire``` macro, which will initialize a value if there is no error, and return if there is. -It aims to somewhat emulate the ```?``` operator in Rust and Swift. - -Rust ```?``` operator: -```rust -fn f() -> Result { - // do stuff -} - -fn f2() -> Result { - let i = f()?; - Ok(i + 4) -} -``` - -```oxRequire```: -```cpp -ox::Result f() noexcept { - // do stuff -} - -ox::Result f2() noexcept { - oxRequire(i, f()); // const auto [out, oxConcat(oxRequire_err_, __LINE__)] = x; oxReturnError(oxConcat(oxRequire_err_, __LINE__)) - return i + 4; -} -``` -```oxRequire``` is not quite as versatile, but it should still cleanup a lot of otherwise less ideal code. - -```oxRequire``` also has variants for throwing the error and for making to value non-const: - -* ```oxRequireM``` - oxRequire Mutable -* ```oxRequireT``` - oxRequire Throw -* ```oxRequireMT``` - oxRequire Mutable Throw - -The throw variants of ```oxRequire``` are generally legacy code. -```ox::Result::unwrapThrow``` is generally preferred now. - -### Logging and Output - -Ox provides for logging and debug prints via the ```oxTrace```, ```oxDebug```, and ```oxError``` macros. -Each of these also provides a format variation. - -Ox also provide ```oxOut``` and ```oxErr``` for printing to stdout and stderr. -These are intended for permanent messages and always go to stdout and stderr. - -Tracing functions do not go to stdout unless the OXTRACE environment variable is set. -They also print with the channel that they are on, along with file and line. - -Debug statements go to stdout and go to the logger on the "debug" channel. -Where trace statements are intended to be written with thoughtfulness, -debug statements are intended to be quick and temporary insertions. -Debug statements trigger compilation failures if OX_NODEBUG is enabled when CMake is run, -as it is on Jenkins builds, so ```oxDebug``` statements should never be checked in. -This makes ```oxDebug``` preferable to other forms of logging, as temporary prints should -never be checked in. - -```oxError``` always prints. -It includes file and line, and is prefixed with a red "ERROR:". -It should generally be used conservatively. -It shuld be used only when there is an error that is not technically fatal, but -the user almost certainly wants to know about it. - -```oxTrace``` and ```oxTracef```: -```cpp -void f(int x, int y) { // x = 9, y = 4 - oxTrace("nostalgia.core.sdl.gfx") << "f:" << x << y; // Output: "f: 9 4" - oxTracef("nostalgia.core.sdl.gfx", "f: {}, {}", x, y); // Output: "f: 9, 4" -} -``` - -```oxDebug``` and ```oxDebugf```: -```cpp -void f(int x, int y) { // x = 9, y = 4 - oxDebug() << "f:" << x << y; // Output: "f: 9 4" - oxDebugf("f: {}, {}", x, y); // Output: "f: 9, 4" -} -``` - -```oxError``` and ```oxErrorf```: -```cpp -void f(int x, int y) { // x = 9, y = 4 - oxError() << "f:" << x << y; // Output: "ERROR: (:): f: 9 4" - oxErrorf("f: {}, {}", x, y); // Output: "ERROR: (:): f: 9, 4" -} -``` +Exceptions should generally just use ```OxException```, which is bascially an +exception form of ```ox::Error```. ### File I/O -All engine file I/O should go through nostalgia::core::Context, which should go -through ox::FileSystem. Similarly, all studio file I/O should go thorough -nostalgia::studio::Project, which should go through ox::FileSystem. +All engine file I/O should go through Keel, which should go through +```ox::FileSystem```. +Similarly, all studio file I/O should go thorough +```nostalgia::studio::Project```, which should go through ```ox::FileSystem```. -ox::FileSystem abstracts away differences between conventional storage devices -and ROM. +```ox::FileSystem``` abstracts away differences between conventional storage +devices and ROM. -### Model System +Olympic files are generally just [Claw objects](deps/ox/ox-docs.md#serialization). -Ox has a model system that provides a sort of manual reflection mechanism. +#### Keel -Models require a model function for the type that you want to model. -It is also good to provide a type name and type version number, though that is not required. +Keel, as its name implies, is a foundational component of Olympic. +Keel is the asset management system. -The model function takes an instance of the type it is modelling and a template -parameter type. -The template parameter type must implement the API used in the models, but it -can do anything with the data provided to it. +Keel provides for the following needs: -Here is an example from the Nostalgia/Core package: - -```cpp -struct NostalgiaPalette { - static constexpr auto TypeName = "net.drinkingtea.nostalgia.core.NostalgiaPalette"; - static constexpr auto TypeVersion = 1; - ox::Vector colors; -}; - -struct NostalgiaGraphic { - static constexpr auto TypeName = "net.drinkingtea.nostalgia.core.NostalgiaGraphic"; - static constexpr auto TypeVersion = 1; - int8_t bpp = 0; - // rows and columns are really only used by TileSheetEditor - int rows = 1; - int columns = 1; - ox::FileAddress defaultPalette; - NostalgiaPalette pal; - ox::Vector pixels; -}; - -template -constexpr ox::Error model(T *h, ox::CommonPtrWith auto *pal) noexcept { - h->template setTypeInfo(); - // it is also possible to provide the type name and type version as function arguments - //h->setTypeInfo("net.drinkingtea.nostalgia.core.NostalgiaPalette", 1); - oxReturnError(h->field("colors", &pal->colors)); - return {}; -} - -template -constexpr ox::Error model(T *h, ox::CommonPtrWith auto *ng) noexcept { - h->template setTypeInfo(); - oxReturnError(h->field("bpp", &ng->bpp)); - oxReturnError(h->field("rows", &ng->rows)); - oxReturnError(h->field("columns", &ng->columns)); - oxReturnError(h->field("defaultPalette", &ng->defaultPalette)); - oxReturnError(h->field("pal", &ng->pal)); - oxReturnError(h->field("pixels", &ng->pixels)); - return {}; -} -``` - -The model system also provides for unions: - -```cpp - -#include - -class FileAddress { - - template - friend constexpr Error model(T*, ox::CommonPtrWith auto*) noexcept; - - public: - static constexpr auto TypeName = "net.drinkingtea.ox.FileAddress"; - - union Data { - static constexpr auto TypeName = "net.drinkingtea.ox.FileAddress.Data"; - char *path; - const char *constPath; - uint64_t inode; - }; - - protected: - FileAddressType m_type = FileAddressType::None; - Data m_data; - -}; - -template -constexpr Error model(T *h, ox::CommonPtrWith auto *obj) noexcept { - h->template setTypeInfo(); - oxReturnError(h->fieldCString("path", &obj->path)); - oxReturnError(h->fieldCString("constPath", &obj->path)); - oxReturnError(h->field("inode", &obj->inode)); - return {}; -} - -template -constexpr Error model(T *io, ox::CommonPtrWith auto *fa) noexcept { - io->template setTypeInfo(); - // cannot read from object in Reflect operation - if constexpr(ox_strcmp(T::opType(), OpType::Reflect) == 0) { - int8_t type = 0; - oxReturnError(io->field("type", &type)); - oxReturnError(io->field("data", UnionView(&fa->m_data, 0))); - } else { - auto type = static_cast(fa->m_type); - oxReturnError(io->field("type", &type)); - fa->m_type = static_cast(type); - oxReturnError(io->field("data", UnionView(&fa->m_data, static_cast(fa->m_type)))); - } - return {}; -} - -``` - -There are also macros in `````` for simplifying the declaration of models: - -```cpp -oxModelBegin(NostalgiaGraphic) - oxModelField(bpp) - oxModelField(rows) - oxModelField(columns) - oxModelField(defaultPalette) - oxModelField(pal) - oxModelField(pixels) -oxModelEnd() -``` - -### Serialization - -Using the model system, Ox provides for serialization. -Ox has MetalClaw and OrganicClaw as its serialization format options. -MetalClaw is a custom binary format designed for minimal size. -OrganicClaw is a wrapper around JsonCpp, chosen because it technically -implements a superset of JSON. -OrganicClaw requires support for 64 bit integers, whereas normal JSON -technically does not. - -These formats do not currently support floats. - -There is also a wrapper format called Claw that provides a header at the -beginning of the file and can dynamically switch between the two depending on -what the header says is present. -The Claw header also includes information about the type and type version of -the data. - -Claw header: ```M1;net.drinkingtea.nostalgia.core.NostalgiaPalette;1;``` - -That reads: - -* Format is Metal Claw, version 1 -* Type ID is net.drinkingtea.nostalgia.core.NostalgiaPalette -* Type version is 1 - -Except when the data is exported for loading on the GBA, Claw is always used as -a wrapper around the bare formats. - -#### Metal Claw Example - -##### Read - -```cpp -#include - -ox::Result loadPalette1(ox::BufferView const&buff) noexcept { - return ox::readMC(buff); -} - -ox::Result loadPalette2(ox::BufferView const&buff) noexcept { - NostalgiaPalette pal; - oxReturnError(ox::readMC(buff, pal)); - return pal; -} -``` - -##### Write - -```cpp -#include - -ox::Result writeSpritePalette1(NostalgiaPalette const&pal) noexcept { - ox::Buffer buffer(ox::units::MB); - std::size_t sz = 0; - oxReturnError(ox::writeMC(buffer.data(), buffer.size(), pal, &sz)); - buffer.resize(sz); - return buffer; -} - -ox::Result writeSpritePalette2(NostalgiaPalette const&pal) noexcept { - return ox::writeMC(pal); -} -``` - -#### Organic Claw Example - -##### Read - -```cpp -#include - -ox::Result loadPalette1(ox::BufferView const&buff) noexcept { - return ox::readOC(buff); -} - -ox::Result loadPalette2(ox::BufferView const&buff) noexcept { - NostalgiaPalette pal; - oxReturnError(ox::readOC(buff, &pal)); - return pal; -} -``` - -##### Write - -```cpp -#include - -ox::Result writeSpritePalette1(NostalgiaPalette const&pal) noexcept { - ox::Buffer buffer(ox::units::MB); - oxReturnError(ox::writeOC(buffer.data(), buffer.size(), pal)); - return buffer; -} - -ox::Result writeSpritePalette2(NostalgiaPalette const&pal) noexcept { - return ox::writeOC(pal); -} -``` - -#### Claw Example - -##### Read - -```cpp -#include - -ox::Result loadPalette1(ox::BufferView const&buff) noexcept { - return ox::readClaw(buff); -} - -ox::Result loadPalette2(ox::BufferView const&buff) noexcept { - NostalgiaPalette pal; - oxReturnError(ox::readClaw(buff, pal)); - return pal; -} -``` - -##### Write - -```cpp -#include - -ox::Result writeSpritePalette(NostalgiaPalette const&pal) noexcept { - return ox::writeClaw(pal); -} -``` +* Type conversion +* Asset bundling +* Asset loading (including flyweighting on PC and preloading to ROM on the GBA) diff --git a/src/nostalgia/modules/core/include/nostalgia/core/gfx.hpp b/src/nostalgia/modules/core/include/nostalgia/core/gfx.hpp index e15a97d..8092345 100644 --- a/src/nostalgia/modules/core/include/nostalgia/core/gfx.hpp +++ b/src/nostalgia/modules/core/include/nostalgia/core/gfx.hpp @@ -143,6 +143,14 @@ ox::Error loadBgTileSheet( size_t srcTileIdx, size_t tileCnt) noexcept; +ox::Error loadBgTileSheet( + Context &ctx, + unsigned cbb, + ox::FileAddress const&tsAddr, + size_t dstTileIdx, + size_t srcTileIdx, + size_t tileCnt) noexcept; + ox::Error loadBgTileSheet( Context &ctx, unsigned cbb, diff --git a/src/nostalgia/modules/core/src/gba/gfx.cpp b/src/nostalgia/modules/core/src/gba/gfx.cpp index 8b87084..c2dffd5 100644 --- a/src/nostalgia/modules/core/src/gba/gfx.cpp +++ b/src/nostalgia/modules/core/src/gba/gfx.cpp @@ -61,21 +61,6 @@ ox::Error loadSpritePalette( return {}; } -ox::Error loadBgPalette( - Context &ctx, - size_t palBank, - ox::FileAddress const&paletteAddr) noexcept { - oxRequire(pal, keel::readObj(keelCtx(ctx), paletteAddr)); - return loadBgPalette(ctx, palBank, *pal, 0); -} - -ox::Error loadSpritePalette( - Context &ctx, - ox::FileAddress const&paletteAddr) noexcept { - oxRequire(pal, keel::readObj(keelCtx(ctx), paletteAddr)); - return loadSpritePalette(ctx, *pal, 0); -} - static ox::Error loadTileSheetSet( Context &ctx, ox::Span tileMapTargetMem, @@ -156,15 +141,6 @@ ox::Error loadBgTileSheet( return {}; } -ox::Error loadBgTileSheet( - Context &ctx, - unsigned cbb, - ox::FileAddress const&tilesheetAddr, - ox::Optional const&paletteBank) noexcept { - oxRequire(ts, keel::readObj(keelCtx(ctx), tilesheetAddr)); - return loadBgTileSheet(ctx, cbb, *ts, paletteBank); -} - ox::Error loadBgTileSheet( Context &ctx, unsigned const cbb, @@ -206,14 +182,6 @@ ox::Error loadSpriteTileSheet( return {}; } -ox::Error loadSpriteTileSheet( - Context &ctx, - ox::FileAddress const&tilesheetAddr, - bool loadDefaultPalette) noexcept { - oxRequire(ts, keel::readObj(keelCtx(ctx), tilesheetAddr)); - return loadSpriteTileSheet(ctx, *ts, loadDefaultPalette); -} - ox::Error loadSpriteTileSheet( Context &ctx, TileSheetSet const&set) noexcept { diff --git a/src/nostalgia/modules/core/src/gfx.cpp b/src/nostalgia/modules/core/src/gfx.cpp index 85f6400..4610225 100644 --- a/src/nostalgia/modules/core/src/gfx.cpp +++ b/src/nostalgia/modules/core/src/gfx.cpp @@ -2,6 +2,7 @@ * Copyright 2016 - 2024 Gary Talent (gary@drinkingtea.net). All rights reserved. */ +#include #include namespace nostalgia::core { @@ -17,6 +18,49 @@ int tileRows(Context&) noexcept { return GbaTileRows; } +ox::Error loadBgPalette( + Context &ctx, + size_t palBank, + ox::FileAddress const&paletteAddr) noexcept { + oxRequire(pal, keel::readObj(keelCtx(ctx), paletteAddr)); + return loadBgPalette(ctx, palBank, *pal, 0); +} + +ox::Error loadSpritePalette( + Context &ctx, + ox::FileAddress const&paletteAddr) noexcept { + oxRequire(pal, keel::readObj(keelCtx(ctx), paletteAddr)); + return loadSpritePalette(ctx, *pal, 0); +} + +ox::Error loadBgTileSheet( + Context &ctx, + unsigned cbb, + ox::FileAddress const&tsAddr, + size_t dstTileIdx, + size_t srcTileIdx, + size_t tileCnt) noexcept { + oxRequire(ts, keel::readObj(keelCtx(ctx), tsAddr)); + return loadBgTileSheet(ctx, cbb, *ts, dstTileIdx, srcTileIdx, tileCnt); +} + +ox::Error loadBgTileSheet( + Context &ctx, + unsigned cbb, + ox::FileAddress const&tilesheetAddr, + ox::Optional const&paletteBank) noexcept { + oxRequire(ts, keel::readObj(keelCtx(ctx), tilesheetAddr)); + return loadBgTileSheet(ctx, cbb, *ts, paletteBank); +} + +ox::Error loadSpriteTileSheet( + Context &ctx, + ox::FileAddress const&tilesheetAddr, + bool loadDefaultPalette) noexcept { + oxRequire(ts, readObj(keelCtx(ctx), tilesheetAddr)); + return loadSpriteTileSheet(ctx, *ts, loadDefaultPalette); +} + // map ASCII values to the nostalgia charset constexpr ox::Array charMap = { 0, diff --git a/src/nostalgia/modules/core/src/opengl/gfx.cpp b/src/nostalgia/modules/core/src/opengl/gfx.cpp index a86dde8..dc10de0 100644 --- a/src/nostalgia/modules/core/src/opengl/gfx.cpp +++ b/src/nostalgia/modules/core/src/opengl/gfx.cpp @@ -531,26 +531,6 @@ ox::Error loadSpritePalette( return {}; } -ox::Error loadBgPalette( - Context &ctx, - size_t palBank, - ox::FileAddress const&paletteAddr) noexcept { - auto &kctx = keelCtx(ctx.turbineCtx); - oxRequire(palette, readObj(kctx, paletteAddr)); - renderer::loadPalette(ctx.bgPalette, palBank * 16 * 4, ctx.bgShader, *palette); - return {}; -} - -ox::Error loadSpritePalette( - Context &ctx, - ox::FileAddress const&paletteAddr) noexcept { - auto &kctx = keelCtx(ctx.turbineCtx); - oxRequire(palette, readObj(kctx, paletteAddr)); - ox::Array pal; - renderer::loadPalette(pal, 0, ctx.spriteShader, *palette); - return {}; -} - static ox::Result buildSetTsd( Context &ctx, TileSheetSet const&set) noexcept { @@ -630,16 +610,6 @@ ox::Error loadBgTileSheet( return {}; } -ox::Error loadBgTileSheet( - Context &ctx, - uint_t cbb, - ox::FileAddress const&tilesheetAddr, - ox::Optional const&paletteBank) noexcept { - auto &kctx = keelCtx(ctx.turbineCtx); - oxRequire(ts, readObj(kctx, tilesheetAddr)); - return loadBgTileSheet(ctx, cbb, *ts, paletteBank); -} - ox::Error loadBgTileSheet( Context &ctx, unsigned cbb, @@ -662,15 +632,6 @@ ox::Error loadSpriteTileSheet( return {}; } -ox::Error loadSpriteTileSheet( - Context &ctx, - ox::FileAddress const&tilesheetAddr, - bool loadDefaultPalette) noexcept { - auto &kctx = keelCtx(ctx.turbineCtx); - oxRequire(ts, readObj(kctx, tilesheetAddr)); - return loadSpriteTileSheet(ctx, *ts, loadDefaultPalette); -} - ox::Error loadSpriteTileSheet( Context &ctx, TileSheetSet const&set) noexcept { diff --git a/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor-imgui.cpp b/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor-imgui.cpp index ebf079a..5355da4 100644 --- a/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor-imgui.cpp +++ b/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor-imgui.cpp @@ -41,31 +41,10 @@ PaletteEditorImGui::PaletteEditorImGui(studio::StudioContext &sctx, ox::StringPa m_sctx(sctx), m_tctx(sctx.tctx), m_pal(*keel::readObj(keelCtx(m_tctx), itemPath()).unwrapThrow()) { - if (keel::ensureValid(m_pal).errCode) { - throw OxException(1, "PaletteEditorImGui: invalid Palette object"); - } undoStack()->changeTriggered.connect(this, &PaletteEditorImGui::handleCommand); m_pageRename.inputSubmitted.connect(this, &PaletteEditorImGui::renamePage); } -void PaletteEditorImGui::keyStateChanged(turbine::Key key, bool down) { - if (!down || m_pageRename.isOpen()) { - return; - } - if (key >= turbine::Key::Num_1 && key <= turbine::Key::Num_9) { - if (turbine::buttonDown(m_tctx, turbine::Key::Mod_Alt)) { - m_page = ox::min( - static_cast(key - turbine::Key::Num_1), m_pal.pages.size() - 1); - } - } else if (key == turbine::Key::Num_0) { - if (turbine::buttonDown(m_tctx, turbine::Key::Mod_Alt)) { - m_selectedColorRow = - ox::min( - static_cast(key - turbine::Key::Num_1 + 9), m_pal.pages.size() - 1); - } - } -} - void PaletteEditorImGui::draw(studio::StudioContext&) noexcept { auto const paneSize = ImGui::GetContentRegionAvail(); { @@ -98,6 +77,19 @@ void PaletteEditorImGui::drawColumn(ox::CStringView txt) noexcept { ImGui::Text("%s", txt.c_str()); } +void PaletteEditorImGui::numShortcuts(size_t &val, size_t const sizeRange) noexcept { + auto const lastElem = sizeRange - 1; + if (ImGui::IsKeyPressed(ImGuiKey_0)) { + val = ox::min(9, lastElem); + } else for (auto i = 9u; i < 10; --i) { + auto const key = static_cast(ImGuiKey_1 + i); + if (ImGui::IsKeyPressed(key)) { + val = ox::min(i, lastElem); + break; + } + } +} + void PaletteEditorImGui::colorInput(ox::CStringView label, int &v, bool &inputFocused) noexcept { ImGui::InputInt(label.c_str(), &v, 1, 5); inputFocused = inputFocused || ImGui::IsItemFocused(); @@ -162,22 +154,24 @@ void PaletteEditorImGui::drawColorsEditor() noexcept { ImGui::TableSetupColumn("Blue", ImGuiTableColumnFlags_WidthFixed, 40); ImGui::TableSetupColumn("Preview", ImGuiTableColumnFlags_NoHide); ImGui::TableHeadersRow(); - for (auto i = 0u; auto const&c : m_pal.pages[m_page].colors) { - ig::IDStackItem const idStackItem(static_cast(i)); - ImGui::TableNextRow(); - drawColumn(i + 1); - drawColumnLeftAlign(m_pal.colorNames[i]); - drawColumn(red16(c)); - drawColumn(green16(c)); - drawColumn(blue16(c)); - ImGui::TableNextColumn(); - auto const ic = ImGui::GetColorU32({redf(c), greenf(c), bluef(c), 1}); - ImGui::TableSetBgColor(ImGuiTableBgTarget_CellBg, ic); - if (ImGui::Selectable( - "##ColorRow", i == m_selectedColorRow, ImGuiSelectableFlags_SpanAllColumns)) { - m_selectedColorRow = i; + if (m_page < m_pal.pages.size()) { + for (auto i = 0u; auto const &c: m_pal.pages[m_page].colors) { + ig::IDStackItem const idStackItem(static_cast(i)); + ImGui::TableNextRow(); + drawColumn(i + 1); + drawColumnLeftAlign(m_pal.colorNames[i]); + drawColumn(red16(c)); + drawColumn(green16(c)); + drawColumn(blue16(c)); + ImGui::TableNextColumn(); + auto const ic = ImGui::GetColorU32({redf(c), greenf(c), bluef(c), 1}); + ImGui::TableSetBgColor(ImGuiTableBgTarget_CellBg, ic); + if (ImGui::Selectable( + "##ColorRow", i == m_selectedColorRow, ImGuiSelectableFlags_SpanAllColumns)) { + m_selectedColorRow = i; + } + ++i; } - ++i; } } ImGui::EndTable(); @@ -240,10 +234,8 @@ void PaletteEditorImGui::drawColorEditor() noexcept { int g = green16(c); int b = blue16(c); int const a = alpha16(c); - auto const¤tName = m_pal.colorNames[m_selectedColorRow]; - ox::IString<50> name; - name = currentName; - ImGui::InputText("Name", name.data(), name.cap() + 1); + auto const newName = ig::InputText<50>( + "Name", m_pal.colorNames[m_selectedColorRow]); bool inputFocused = ImGui::IsItemFocused(); ImGui::Separator(); colorInput("Red", r, inputFocused); @@ -253,25 +245,20 @@ void PaletteEditorImGui::drawColorEditor() noexcept { std::ignore = pushCommand( m_pal, m_page, m_selectedColorRow); } - if (!inputFocused) { - auto const lastColor = largestPage(m_pal) - 1; - if (ImGui::IsKeyPressed(ImGuiKey_0, false)) { - m_selectedColorRow = ox::min(9, lastColor); - } else for (auto i = 9u; i < 10; --i) { - auto const key = static_cast(ImGuiKey_1 + i); - if (ImGui::IsKeyPressed(key, false)) { - m_selectedColorRow = ox::min(i, lastColor); - break; - } + if (!inputFocused && !m_pageRename.isOpen()) { + if (!ImGui::IsKeyDown(ImGuiKey_ModAlt)) { + numShortcuts(m_selectedColorRow, largestPage(m_pal)); + } else { + numShortcuts(m_page, m_pal.pages.size()); } } auto const newColor = color16(r, g, b, a); if (c != newColor) { std::ignore = pushCommand(m_pal, m_page, m_selectedColorRow, newColor); } - if (currentName != name) { + if (newName) { std::ignore = pushCommand( - m_pal, m_selectedColorRow, ox::String{name}); + m_pal, m_selectedColorRow, ox::String{newName}); } } diff --git a/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor-imgui.hpp b/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor-imgui.hpp index d11d614..458dc64 100644 --- a/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor-imgui.hpp +++ b/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor-imgui.hpp @@ -40,8 +40,6 @@ class PaletteEditorImGui: public studio::Editor { public: PaletteEditorImGui(studio::StudioContext &sctx, ox::StringParam path); - void keyStateChanged(turbine::Key key, bool down) override; - void draw(studio::StudioContext&) noexcept final; protected: @@ -56,6 +54,8 @@ class PaletteEditorImGui: public studio::Editor { drawColumn(ox::itoa(i)); } + static void numShortcuts(size_t &val, size_t sizeRange) noexcept; + static void colorInput(ox::CStringView label, int &v, bool &inputFocused) noexcept; void drawColorsEditor() noexcept; diff --git a/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor.cpp b/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor.cpp index 854bc28..0762c73 100644 --- a/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor.cpp +++ b/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor.cpp @@ -188,19 +188,21 @@ UpdateColorInfoCommand::UpdateColorInfoCommand( } } -bool UpdateColorInfoCommand::mergeWith(UndoCommand const&cmd) noexcept { - if (cmd.commandId() != static_cast(PaletteEditorCommandId::UpdateColor)) { +bool UpdateColorInfoCommand::mergeWith(UndoCommand &cmd) noexcept { + if (cmd.commandId() != static_cast(PaletteEditorCommandId::UpdateColorInfo)) { return false; } - auto ucCmd = static_cast(&cmd); + auto ucCmd = dynamic_cast(&cmd); if (m_idx != ucCmd->m_idx) { return false; } + m_pal.colorNames[m_idx] = std::move(ucCmd->m_pal.colorNames[m_idx]); + setObsolete(m_altColorInfo == m_pal.colorNames[m_idx]); return true; } int UpdateColorInfoCommand::commandId() const noexcept { - return static_cast(PaletteEditorCommandId::UpdateColor); + return static_cast(PaletteEditorCommandId::UpdateColorInfo); } ox::Error UpdateColorInfoCommand::redo() noexcept { @@ -232,11 +234,11 @@ UpdateColorCommand::UpdateColorCommand( } } -bool UpdateColorCommand::mergeWith(UndoCommand const&cmd) noexcept { +bool UpdateColorCommand::mergeWith(UndoCommand &cmd) noexcept { if (cmd.commandId() != static_cast(PaletteEditorCommandId::UpdateColor)) { return false; } - auto ucCmd = static_cast(&cmd); + auto ucCmd = dynamic_cast(&cmd); if (m_idx != ucCmd->m_idx) { return false; } diff --git a/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor.hpp b/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor.hpp index 60efb60..7f61d16 100644 --- a/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor.hpp +++ b/src/nostalgia/modules/core/src/studio/paletteeditor/paletteeditor.hpp @@ -163,7 +163,7 @@ class UpdateColorInfoCommand: public studio::UndoCommand { ~UpdateColorInfoCommand() noexcept override = default; [[nodiscard]] - bool mergeWith(const UndoCommand &cmd) noexcept final; + bool mergeWith(UndoCommand &cmd) noexcept final; [[nodiscard]] int commandId() const noexcept final; @@ -194,7 +194,7 @@ class UpdateColorCommand: public studio::UndoCommand { ~UpdateColorCommand() noexcept override = default; [[nodiscard]] - bool mergeWith(const UndoCommand &cmd) noexcept final; + bool mergeWith(UndoCommand &cmd) noexcept final; [[nodiscard]] int commandId() const noexcept final; diff --git a/src/nostalgia/modules/core/src/studio/tilesheeteditor/tilesheeteditor-imgui.cpp b/src/nostalgia/modules/core/src/studio/tilesheeteditor/tilesheeteditor-imgui.cpp index 8274521..fc7f2d4 100644 --- a/src/nostalgia/modules/core/src/studio/tilesheeteditor/tilesheeteditor-imgui.cpp +++ b/src/nostalgia/modules/core/src/studio/tilesheeteditor/tilesheeteditor-imgui.cpp @@ -158,21 +158,25 @@ void TileSheetEditorImGui::keyStateChanged(turbine::Key key, bool down) { } else if (key >= turbine::Key::Num_1 && key <= turbine::Key::Num_9) { if (turbine::buttonDown(m_tctx, turbine::Key::Mod_Alt)) { auto const idx = ox::min( - static_cast(key - turbine::Key::Num_1), m_model.pal().pages.size() - 1); + static_cast(key - turbine::Key::Num_1), + m_model.pal().pages.size() - 1); m_model.setPalettePage(idx); - } else if (key <= turbine::Key::Num_0 + colorCnt) { + } else if (key <= turbine::Key::Num_9) { auto const idx = ox::min( - static_cast(key - turbine::Key::Num_1), colorCnt - 1); + static_cast(key - turbine::Key::Num_1), + colorCnt - 1); m_view.setPalIdx(idx); } } else if (key == turbine::Key::Num_0) { if (turbine::buttonDown(m_tctx, turbine::Key::Mod_Alt)) { auto const idx = ox::min( - static_cast(key - turbine::Key::Num_1 + 9), m_model.pal().pages.size() - 1); + static_cast(key - turbine::Key::Num_1 + 9), + m_model.pal().pages.size() - 1); m_model.setPalettePage(idx); - } else if (colorCnt >= 10) { + } else { auto const idx = ox::min( - static_cast(key - turbine::Key::Num_1 + 9), colorCnt - 1); + static_cast(key - turbine::Key::Num_1 + 9), + colorCnt - 1); m_view.setPalIdx(idx); } } diff --git a/src/nostalgia/modules/scene/src/studio/sceneeditor-imgui.cpp b/src/nostalgia/modules/scene/src/studio/sceneeditor-imgui.cpp index 4ec3e14..4a457c3 100644 --- a/src/nostalgia/modules/scene/src/studio/sceneeditor-imgui.cpp +++ b/src/nostalgia/modules/scene/src/studio/sceneeditor-imgui.cpp @@ -15,7 +15,6 @@ SceneEditorImGui::SceneEditorImGui(studio::StudioContext &ctx, ox::StringView pa m_ctx(ctx.tctx), m_editor(m_ctx, path), m_view(m_ctx, m_editor.scene()) { - setRequiresConstantRefresh(false); } void SceneEditorImGui::draw(studio::StudioContext&) noexcept { diff --git a/src/olympic/keel/include/keel/media.hpp b/src/olympic/keel/include/keel/media.hpp index 7132e7a..728ee97 100644 --- a/src/olympic/keel/include/keel/media.hpp +++ b/src/olympic/keel/include/keel/media.hpp @@ -29,8 +29,8 @@ oxModelBegin(PreloadPtr) oxModelField(preloadAddr) oxModelEnd() -ox::Result getPreloadAddr(keel::Context &ctx, ox::FileAddress const&file) noexcept; -ox::Result getPreloadAddr(keel::Context &ctx, ox::StringViewCR file) noexcept; +ox::Result getPreloadAddr(keel::Context &ctx, ox::FileAddress const&addr) noexcept; +ox::Result getPreloadAddr(keel::Context &ctx, ox::StringViewCR path) noexcept; void createUuidMapping(Context &ctx, ox::StringView filePath, ox::UUID const&uuid) noexcept; @@ -89,7 +89,7 @@ ox::Result> readObjFile( assetId = substr(assetId, 7); oxRequire(p, keel::uuidToPath(ctx, assetId)); } else { - auto const [uuid, uuidErr] = getUuid(ctx, assetId); + auto const [uuid, uuidErr] = getUuid(ctx, assetId); if (!uuidErr) { uuidStr = uuid.toString(); assetId = uuidStr; diff --git a/src/olympic/keel/src/media.cpp b/src/olympic/keel/src/media.cpp index 7f2b7cb..857e9a5 100644 --- a/src/olympic/keel/src/media.cpp +++ b/src/olympic/keel/src/media.cpp @@ -208,15 +208,15 @@ void unloadRom(char*) noexcept { ox::Result getPreloadAddr(keel::Context &ctx, ox::StringViewCR path) noexcept { oxRequire(stat, ctx.rom->stat(path)); - oxRequire(buff, static_cast(ctx.rom.get())->directAccess(path)); + oxRequire(buff, static_cast(*ctx.rom).directAccess(path)); PreloadPtr p; oxReturnError(ox::readMC({buff, static_cast(stat.size)}, p)); return static_cast(p.preloadAddr) + ctx.preloadSectionOffset; } -ox::Result getPreloadAddr(keel::Context &ctx, ox::FileAddress const&file) noexcept { - oxRequire(stat, ctx.rom->stat(file)); - oxRequire(buff, static_cast(ctx.rom.get())->directAccess(file)); +ox::Result getPreloadAddr(keel::Context &ctx, ox::FileAddress const&addr) noexcept { + oxRequire(stat, ctx.rom->stat(addr)); + oxRequire(buff, static_cast(*ctx.rom).directAccess(addr)); PreloadPtr p; oxReturnError(ox::readMC({buff, static_cast(stat.size)}, p)); return static_cast(p.preloadAddr) + ctx.preloadSectionOffset; diff --git a/src/olympic/studio/applib/src/newmenu.cpp b/src/olympic/studio/applib/src/newmenu.cpp index 35b282b..9148055 100644 --- a/src/olympic/studio/applib/src/newmenu.cpp +++ b/src/olympic/studio/applib/src/newmenu.cpp @@ -77,7 +77,7 @@ void NewMenu::drawNewItemName(studio::StudioContext &sctx) noexcept { drawWindow(sctx.tctx, &m_open, [this, &sctx] { auto const typeIdx = static_cast(m_selectedType); if (typeIdx < m_types.size()) { - ImGui::InputText("Name", m_itemName.data(), m_itemName.cap()); + ig::InputText("Name", m_itemName); } drawLastPageButtons(sctx); }); diff --git a/src/olympic/studio/modlib/include/studio/editor.hpp b/src/olympic/studio/modlib/include/studio/editor.hpp index 39d2736..548d2ad 100644 --- a/src/olympic/studio/modlib/include/studio/editor.hpp +++ b/src/olympic/studio/modlib/include/studio/editor.hpp @@ -23,7 +23,6 @@ class BaseEditor: public Widget { bool m_cutEnabled = false; bool m_copyEnabled = false; bool m_pasteEnabled = false; - bool m_requiresConstantRefresh = false; public: ~BaseEditor() override = default; @@ -52,9 +51,6 @@ class BaseEditor: public Widget { virtual void onActivated() noexcept; - [[nodiscard]] - bool requiresConstantRefresh() const noexcept; - void close() const; /** @@ -71,10 +67,10 @@ class BaseEditor: public Widget { [[nodiscard]] bool unsavedChanges() const noexcept; - void setExportable(bool); + void setExportable(bool) noexcept; [[nodiscard]] - bool exportable() const; + bool exportable() const noexcept; void setCutEnabled(bool); diff --git a/src/olympic/studio/modlib/include/studio/imguiutil.hpp b/src/olympic/studio/modlib/include/studio/imguiutil.hpp index e005390..cc343bf 100644 --- a/src/olympic/studio/modlib/include/studio/imguiutil.hpp +++ b/src/olympic/studio/modlib/include/studio/imguiutil.hpp @@ -128,9 +128,35 @@ void centerNextWindow(turbine::Context &ctx) noexcept; bool PushButton(ox::CStringView lbl, ImVec2 const&btnSz = BtnSz) noexcept; +template +struct TextInput { + bool changed{}; + Str text; + explicit constexpr operator ox::String() const noexcept { return ox::String{text}; } + constexpr operator ox::CStringView() const noexcept { return text; } + constexpr operator ox::StringView() const noexcept { return text; } + constexpr operator bool() const noexcept { return changed; } +}; + +template +TextInput> InputText( + ox::CStringViewCR label, + ox::StringViewCR currentText, + ImGuiInputTextFlags const flags = 0, + ImGuiInputTextCallback const callback = nullptr, + void *user_data = nullptr) noexcept { + TextInput> out = {.text = currentText}; + out.changed = ImGui::InputText( + label.c_str(), out.text.data(), MaxChars + 1, flags, callback, user_data); + if (out.changed) { + std::ignore = out.text.unsafeResize(ox::strlen(out.text.c_str())); + } + return out; +} + template bool InputText( - ox::CStringView label, + ox::CStringViewCR label, ox::IString &text, ImGuiInputTextFlags const flags = 0, ImGuiInputTextCallback const callback = nullptr, diff --git a/src/olympic/studio/modlib/include/studio/undocommand.hpp b/src/olympic/studio/modlib/include/studio/undocommand.hpp index 93aa2a2..ffd0009 100644 --- a/src/olympic/studio/modlib/include/studio/undocommand.hpp +++ b/src/olympic/studio/modlib/include/studio/undocommand.hpp @@ -17,13 +17,22 @@ class NoChangesException: public ox::Exception { }; class UndoCommand { + private: + bool m_obsolete{}; public: virtual ~UndoCommand() noexcept = default; virtual ox::Error redo() noexcept = 0; virtual ox::Error undo() noexcept = 0; [[nodiscard]] virtual int commandId() const noexcept = 0; - virtual bool mergeWith(UndoCommand const&cmd) noexcept; + virtual bool mergeWith(UndoCommand &cmd) noexcept; + constexpr void setObsolete(bool obsolete) noexcept { + m_obsolete = obsolete; + } + [[nodiscard]] + constexpr bool isObsolete() const noexcept { + return m_obsolete; + } }; } diff --git a/src/olympic/studio/modlib/src/editor.cpp b/src/olympic/studio/modlib/src/editor.cpp index a806d19..27f52df 100644 --- a/src/olympic/studio/modlib/src/editor.cpp +++ b/src/olympic/studio/modlib/src/editor.cpp @@ -36,10 +36,6 @@ void BaseEditor::keyStateChanged(turbine::Key, bool) { void BaseEditor::onActivated() noexcept { } -bool BaseEditor::requiresConstantRefresh() const noexcept { - return m_requiresConstantRefresh; -} - void BaseEditor::close() const { this->closed.emit(itemPath()); } @@ -66,12 +62,12 @@ bool BaseEditor::unsavedChanges() const noexcept { return m_unsavedChanges; } -void BaseEditor::setExportable(bool exportable) { +void BaseEditor::setExportable(bool exportable) noexcept { m_exportable = exportable; exportableChanged.emit(exportable); } -bool BaseEditor::exportable() const { +bool BaseEditor::exportable() const noexcept { return m_exportable; } @@ -110,10 +106,6 @@ UndoStack *BaseEditor::undoStack() noexcept { return nullptr; } -void BaseEditor::setRequiresConstantRefresh(bool value) noexcept { - m_requiresConstantRefresh = value; -} - Editor::Editor(ox::StringParam itemPath) noexcept: m_itemPath(std::move(itemPath)), diff --git a/src/olympic/studio/modlib/src/undocommand.cpp b/src/olympic/studio/modlib/src/undocommand.cpp index 6a929ca..96dec70 100644 --- a/src/olympic/studio/modlib/src/undocommand.cpp +++ b/src/olympic/studio/modlib/src/undocommand.cpp @@ -3,7 +3,7 @@ namespace studio { -bool UndoCommand::mergeWith(UndoCommand const&) noexcept { +bool UndoCommand::mergeWith(UndoCommand&) noexcept { return false; } diff --git a/src/olympic/studio/modlib/src/undostack.cpp b/src/olympic/studio/modlib/src/undostack.cpp index 77cb049..1bcf209 100644 --- a/src/olympic/studio/modlib/src/undostack.cpp +++ b/src/olympic/studio/modlib/src/undostack.cpp @@ -17,6 +17,10 @@ ox::Error UndoStack::push(ox::UPtr &&cmd) noexcept { m_stack.emplace_back(std::move(cmd)); ++m_stackIdx; } + if ((*m_stack.back().unwrap())->isObsolete()) { + m_stack.pop_back(); + --m_stackIdx; + } return {}; }