From aa4391905aa7f430fe6fc260d1bd11e364ddc5ba Mon Sep 17 00:00:00 2001 From: Soispha Date: Sun, 24 Mar 2024 21:09:18 +0100 Subject: [PATCH] chore(example): Switch to full trinitrix API --- example/main/build.rs | 3 +- example/main/src/bin/main/trinitrix_api.tri | 117 ++++++++++++++++++++ 2 files changed, 119 insertions(+), 1 deletion(-) create mode 100644 example/main/src/bin/main/trinitrix_api.tri diff --git a/example/main/build.rs b/example/main/build.rs index 44f55e6..fcd8af2 100644 --- a/example/main/build.rs +++ b/example/main/build.rs @@ -24,8 +24,9 @@ use trixy::macros::config::TrixyConfig; fn main() { println!("cargo:rerun-if-changed=./dist/*"); println!("cargo:rerun-if-changed=./src/bin/main/api.tri"); + println!("cargo:rerun-if-changed=./src/bin/main/trinitrix_api.tri"); TrixyConfig::new("handle_cmd") - .trixy_path("./src/bin/main/api.tri") + .trixy_path("./src/bin/main/trinitrix_api.tri") .dist_dir_path("./dist") .generate_debug(true) .generate(); diff --git a/example/main/src/bin/main/trinitrix_api.tri b/example/main/src/bin/main/trinitrix_api.tri new file mode 100644 index 0000000..885e471 --- /dev/null +++ b/example/main/src/bin/main/trinitrix_api.tri @@ -0,0 +1,117 @@ +//// Prints to the output, with a newline. +// HACK(@soispha): The stdlib Lua `print()` function has stdout as output hardcoded, +// redirecting stdout seems too much like a hack thus we are just redefining the print function +// to output to a controlled output. <2023-09-09> +// This is implemented only for lua +/* fn print(CommandTransferValue); */ + +mod trinitrix { + /// Language specific functions, which mirror the `trinitrix.api` namespace. + /// That is, if you have to choose between a `std` and a `api` function choose the `std` + /// one as it will most likely be more high-level and easier to use (as it isn't abstracted + /// over multiple languages). Feel free to drop down to the lower level api, if you feel + /// like that more, it should be as stable and user-oriented as the `std` functions + mod std {} + + /// General API to change stuff in Trinitrix + mod api { + /// Closes the application + fn exit(); + + /// Send a message to the current room + /// The send message is interpreted literally. + fn room_message_send(message: String); + + //// Open the help pages at the first occurrence of + //// the input string if it is Some, otherwise open + //// the help pages at the start + // TODO(@soispha): To be implemented <2024-03-09> + // fn help(Option); + + //// Register a function to be used with the Trinitrix api + // (This function is not actually implemented here) + /* declare register_function: false, */ + + /// Function that change the UI, or UI state + mod ui { + /// Shows the command line + fn command_line_show(); + + /// Hides the command line + fn command_line_hide(); + + /// Go to the next plane + fn cycle_planes(); + /// Go to the previous plane + fn cycle_planes_rev(); + + /// Sets the current app mode to Normal / navigation mode + fn set_mode_normal(); + /// Sets the current app mode to Insert / editing mode + fn set_mode_insert(); + } + + /// Manipulate keymappings, the mode is specified as a String build up of all mode + /// the keymapping should be active in. The mapping works as follows: + /// n => normal Mode + /// c => command Mode + /// i => insert Mode + /// + /// The key works in a similar matter, specifying the required keypresses to trigger the + /// callback. For example "aba" for require the user to press "a" then "b" then "a" again + /// to trigger the mapping. Special characters are encoded as follows: + /// "ba" => "Ctrl+a" then "b" then "a" + /// "" => "A" or "Shift+a" + /// "A" => "A" + /// " " => "Alt+a" () or "Meta+a"() (most terminals can't really differentiate between these characters) + /// "a" => "a" then "Ctrl+b" then "Ctrl+a" (also works for Shift, Alt and Super) + /// "" => "Ctrl+Shift+Alt+b" (the ordering doesn't matter) + /// "a " => "a" then a literal space (" ") + /// "å🙂" => "å" then "🙂" (full Unicode support!) + /// "" => escape key + /// "" => F3 key + /// "" => backspace key (and so forth) + /// "" => a literal "-" + /// "" or "" => a literal "<" + /// "" or "" => a literal ">" + /// + /// The callback MUST be registered first by calling + /// `trinitrix.api.register_function()` the returned value can than be used to + /// set the keymap. + mod keymaps { + /// Add a new keymapping + fn add(mode: String, key: String, callback: fn()); + + /// Remove a keymapping + /// + /// Does nothing, if the keymapping doesn't exists yet + fn remove(mode: String, key: String); + + /// List declared keymappings + fn get(mode: String); + } + + /// Functions only used internally within Trinitrix + mod raw { + /// Send an error to the default error output + fn raise_error(error_message: String); + + /// Send output to the default output + /// This is mainly used to display the final + /// output of evaluated lua commands. + fn display_output(output_message: String); + + /// Input a character without checking for possible keymaps + /// If the current state does not expect input, this character is ignored + /// The encoding is the same as in the `trinitrix.api.keymaps` commands + fn send_input_unprocessed(input: String); + + /// This namespace is used to store some command specific data (like functions, as + /// ensuring memory locations stay allocated in garbage collected language is hard) + /// + /// Treat it as an implementation detail + mod __private {} + } + } +} +// vim: syntax=rust