daniel/montaukos.org
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add website

Browse Source
This commit is contained in:
daniel
2026-08-22 07:44:34 +02:00
commit 5f96c7fdd8
172 changed files with 8851 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/apm/assets/discard_dialog.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.9 KiB

docs/apm/assets/save_dialog.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

docs/apm/config.html
+236
View File
@@ -0,0 +1,236 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="MontaukOS userspace configuration and TOML API">
<title>Configuration and TOML - MontaukOS</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600&display=swap" rel="stylesheet">
<style>
body {
font-family: 'Open Sans', Arial, sans-serif;
max-width: 960px;
margin: 0 auto;
padding: 1em;
line-height: 1.5;
display: flex;
gap: 2em;
}
p { margin: 0 0 0.75em; }
h2 { margin: 1.25em 0 0.5em; }
h3 { margin: 1em 0 0.35em; }
.sidebar { width: 160px; flex-shrink: 0; }
.sidebar ul { list-style: none; padding: 0; }
.sidebar li { margin: 0.5em 0; }
.sidebar a { color: #0066CC; text-decoration: none; font-weight: 600; }
.sidebar a:hover { color: #004499; text-decoration: underline; }
.sidebar .current { color: #004499; }
.sidebar hr { border: none; border-top: 1px solid #999; margin: 0.75em 0; }
.main { flex: 1; min-width: 0; }
a { color: #0000EE; }
a:visited { color: #0066CC; }
hr { border-style: solid; border-width: 1px 0 0 0; border-color: #999; }
.center { text-align: center; }
pre {
background: #f4f4f4;
border: 1px solid #ccc;
padding: 0.75em;
overflow-x: auto;
}
code { font-family: monospace; }
@media (max-width: 700px) {
body { flex-direction: column; gap: 1em; padding: 1em 0.75em; }
.sidebar { width: auto; }
.sidebar ul { display: flex; flex-wrap: wrap; gap: 0 1em; }
.sidebar hr { width: 100%; }
}
</style>
</head>
<body>
<div class="sidebar">
<ul>
<li><a href="../../index.html">Home</a></li>
<li><a href="../../downloads.html">Downloads</a></li>
<li><a href="../index.html">Documentation</a></li>
<li><a href="https://git.montaukos.org/daniel/MontaukOS/issues">Issue tracker</a></li>
<li><a href="https://git.montaukos.org/daniel/MontaukOS">Git</a></li>
</ul>
<hr>
<ul>
<li><a href="index.html">Application Programming Manual</a></li>
<li><a href="config.html" class="current">Configuration and TOML</a></li>
</ul>
</div>
<div class="main">
<div class="center">
<h1>Configuration and TOML</h1>
</div>
<hr>
<p>MontaukOS provides a small header-only C++ API for reading and writing
TOML configuration files from userspace. Include
<code>&lt;montauk/config.h&gt;</code> for file-backed configuration and
<code>&lt;montauk/toml.h&gt;</code> for the in-memory TOML document model.</p>
<h2>Configuration locations</h2>
<p>System configuration is stored in <code>0:/config</code>. The API accepts a
name without the <code>.toml</code> extension:</p>
<pre><code>0:/config/desktop.toml
0:/config/network.toml</code></pre>
<p>Per-user configuration is stored below the user directory:</p>
<pre><code>0:/users/&lt;username&gt;/config/&lt;name&gt;.toml</code></pre>
<h2>Loading and saving</h2>
<pre><code>#include &lt;montauk/config.h&gt;
auto doc = montauk::config::load("desktop");
const char* theme = doc.get_string("appearance.theme", "light");
montauk::config::set_string(&amp;doc, "appearance.theme", "dark");
int result = montauk::config::save("desktop", &amp;doc);
doc.destroy();</code></pre>
<p><code>load()</code> returns an initialized empty document if the file does
not exist. <code>save()</code> creates the configuration directory and returns
<code>0</code> on success or a negative value on error. Saving rewrites the
whole file.</p>
<h3>System configuration API</h3>
<pre><code>toml::Doc config::load(const char* name);
int config::save(const char* name, toml::Doc* doc);
int config::remove(const char* name);</code></pre>
<h3>Per-user configuration API</h3>
<pre><code>toml::Doc config::load_user(const char* username, const char* name);
int config::save_user(const char* username,
const char* name,
toml::Doc* doc);</code></pre>
<p>For example:</p>
<pre><code>auto doc = montauk::config::load_user("alice", "desktop");
bool clock24 = doc.get_bool("display.clock_24h", false);
montauk::config::set_bool(&amp;doc, "display.clock_24h", true);
montauk::config::save_user("alice", "desktop", &amp;doc);
doc.destroy();</code></pre>
<h2>Reading values</h2>
<p>Keys may use dotted paths corresponding to TOML tables:</p>
<pre><code>[server]
host = "pool.ntp.org"
port = 123
enabled = true</code></pre>
<pre><code>const char* host = doc.get_string("server.host", "localhost");
int64_t port = doc.get_int("server.port", 80);
bool enabled = doc.get_bool("server.enabled", false);</code></pre>
<p>Typed getters return their default when the key is absent or has another
type. The available value types are:</p>
<pre><code>toml::Type::String
toml::Type::Int
toml::Type::Bool
toml::Type::Array
toml::Type::Table</code></pre>
<p>Arrays and tables are returned as <code>toml::Value*</code>. Their children
are available through <code>value-&gt;array.items</code> and
<code>value-&gt;array.count</code>:</p>
<pre><code>auto* names = doc.get_array("server.names");
if (names) {
for (int i = 0; i &lt; names-&gt;array.count; ++i) {
auto* item = names-&gt;array.items[i];
if (item-&gt;type == montauk::toml::Type::String)
montauk::print(item-&gt;str);
}
}</code></pre>
<h2>Modifying documents</h2>
<pre><code>void config::set_string(toml::Doc* doc,
const char* key, const char* value);
void config::set_int(toml::Doc* doc,
const char* key, int64_t value);
void config::set_bool(toml::Doc* doc,
const char* key, bool value);
bool config::unset(toml::Doc* doc, const char* key);</code></pre>
<p>The setters overwrite an existing value or append a new one. The
<code>unset()</code> return value is <code>true</code> when a matching key was
removed.</p>
<h2>Parsing and serialization</h2>
<p>Use <code>toml::parse()</code> when TOML is already available in memory:</p>
<pre><code>const char* text =
"[server]\n"
"port = 8080\n"
"enabled = true\n";
auto doc = montauk::toml::parse(text);
int64_t port = doc.get_int("server.port");
doc.destroy();</code></pre>
<p>A document can be serialized to newly allocated TOML text:</p>
<pre><code>char* text = montauk::config::serialize(&amp;doc);
// Use text...
montauk::mfree(text);</code></pre>
<p>Serialization produces normalized TOML and does not preserve comments or
the original formatting.</p>
<h2>Memory ownership</h2>
<p><code>toml::Doc</code> owns its parsed values and strings. Every document
returned by <code>load()</code>, <code>load_user()</code>, or
<code>toml::parse()</code> must eventually be released with
<code>doc.destroy()</code>.</p>
<p>When constructing a document manually, initialize it before using the
mutation helpers:</p>
<pre><code>montauk::toml::Doc doc;
doc.init();
montauk::config::set_bool(&amp;doc, "enabled", true);
montauk::config::save("example", &amp;doc);
doc.destroy();</code></pre>
<h2>Supported TOML features</h2>
<p>The userspace parser supports strings, literal and multiline strings,
integers (including hexadecimal, octal, and binary forms), booleans, arrays,
tables, inline tables, dotted keys, and comments.</p>
<p>There are no typed float or datetime accessors. Callers should also treat
configuration names and usernames as safe path components, since they are
used to construct filesystem paths.</p>
<hr>
<div class="center">
<a href="index.html">Back to Application Programming Manual</a>
</div>
</div>
</body>
</html>
docs/apm/dialogs.html
+291
View File
@@ -0,0 +1,291 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="MontaukOS dialogs library API">
<title>Dialogs Library - MontaukOS</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600&display=swap" rel="stylesheet">
<style>
body {
font-family: 'Open Sans', Arial, sans-serif;
max-width: 960px;
margin: 0 auto;
padding: 1em;
line-height: 1.5;
display: flex;
gap: 2em;
}
p { margin: 0 0 0.5em; }
h2 { margin: 0.5em 0; }
h3 { margin: 0.75em 0 0.35em; }
.sidebar {
width: 160px;
flex-shrink: 0;
}
.sidebar ul {
list-style: none;
padding: 0;
}
.sidebar li {
margin: 0.5em 0;
}
.sidebar a {
color: #0066CC;
text-decoration: none;
font-weight: 600;
}
.sidebar a:hover {
color: #004499;
text-decoration: underline;
}
.sidebar .current {
color: #004499;
}
.sidebar hr {
border: none;
border-top: 1px solid #999;
margin: 0.75em 0;
}
.main {
flex: 1;
min-width: 0;
}
a { color: #0000EE; }
a:visited { color: #0066CC; }
hr { border-style: solid; border-width: 1px 0 0 0; border-color: #999; }
pre { background: #f0f0f0; padding: 0.5em; overflow-x: auto; }
code { background: #f0f0f0; padding: 0 0.15em; }
pre code { padding: 0; }
table {
border-collapse: collapse;
width: 100%;
margin: 0.5em 0;
}
th, td {
border: 1px solid #999;
padding: 0.35em 0.5em;
text-align: left;
vertical-align: top;
}
th { background: #f0f0f0; }
.center { text-align: center; }
.box {
border: 1px solid #999;
padding: 0.5em;
margin: 0.5em 0;
}
.figure {
margin: 0.75em 0;
}
.figure img {
display: block;
max-width: 100%;
height: auto;
border: 1px solid #999;
}
.figure p {
color: #555;
font-size: 0.9em;
margin: 0.25em 0 0;
}
@media (max-width: 700px) {
body {
flex-direction: column;
gap: 1em;
padding: 1em 0.75em;
}
.sidebar {
width: auto;
}
.sidebar ul {
display: flex;
flex-wrap: wrap;
gap: 0 1em;
}
.sidebar hr {
width: 100%;
}
}
</style>
</head>
<body>
<div class="sidebar">
<ul>
<li><a href="../../index.html">Home</a></li>
<li><a href="../../downloads.html">Downloads</a></li>
<li><a href="../index.html">Documentation</a></li>
<li><a href="https://git.montaukos.org/daniel/MontaukOS/issues">Issue tracker</a></li>
<li><a href="https://git.montaukos.org/daniel/MontaukOS">Git</a></li>
</ul>
<hr>
<ul>
<li><a href="index.html">Application Programming Manual</a></li>
<li><a href="dialogs.html" class="current">Dialogs library</a></li>
</ul>
</div>
<div class="main">
<div class="center">
<h1>Dialogs</h1>
</div>
<hr>
<h2>Overview</h2>
<p>
The dialogs library (at 0:/os/dialogs.lib) provides the following system dialogs across apps:
</p>
<ul>
<li>File selection (Open)</li>
<li>File save location selection (Save)</li>
<li>Print setup/submission</li>
<li>Message Box popups</li>
</ul>
<h2>Message Box</h2>
<p>
<i>message_box</i> displays a popup window with text and buttons.
</p>
<pre><code>gui::dialogs::MessageBoxResult message_box(
const char* title,
const char* message,
gui::dialogs::MessageBoxButtons buttons = gui::dialogs::MESSAGE_BOX_OK,
char* out_message = nullptr,
int out_message_len = 0);</code></pre>
<h3>Button Sets</h3>
<table>
<tr><th>Value</th><th>Buttons</th></tr>
<tr><td>MESSAGE_BOX_OK</td><td>OK</td></tr>
<tr><td>MESSAGE_BOX_OK_CANCEL</td><td>OK, Cancel</td></tr>
<tr><td>MESSAGE_BOX_YES_NO</td><td>Yes, No</td></tr>
<tr><td>MESSAGE_BOX_YES_NO_CANCEL</td><td>Yes, No, Cancel</td></tr>
</table>
<h3>Results</h3>
<table>
<tr><th>Value</th><th>Meaning</th></tr>
<tr><td>MESSAGE_BOX_RESULT_OK</td><td>The user selected OK.</td></tr>
<tr><td>MESSAGE_BOX_RESULT_CANCEL</td><td>The user selected Cancel or closed a cancelable dialog.</td></tr>
<tr><td>MESSAGE_BOX_RESULT_YES</td><td>The user selected Yes.</td></tr>
<tr><td>MESSAGE_BOX_RESULT_NO</td><td>The user selected No, or closed a Yes/No dialog.</td></tr>
<tr><td>MESSAGE_BOX_RESULT_NONE</td><td>The dialog could not be loaded or invoked.</td></tr>
</table>
<h3>Example</h3>
<pre><code>#include &lt;gui/dialogs.hpp&gt;
void show_confirm() {
auto result = gui::dialogs::message_box(
"Close Document",
"Discard unsaved changes?",
gui::dialogs::MESSAGE_BOX_YES_NO_CANCEL);
if (result == gui::dialogs::MESSAGE_BOX_RESULT_YES) {
/* discard and close */
}
}</code></pre>
<div class="figure">
<img src="assets/discard_dialog.png" width="337" height="181" alt="Message box asking whether to discard unsaved changes">
<p>Example <i>MESSAGE_BOX_YES_NO_CANCEL</i> dialog.</p>
</div>
<h2>File Dialogs</h2>
<p>
File dialog helpers allow applications to use graphical file selection views (similar to the Files app) to select paths for Open/Save operations.
</p>
<pre><code>bool open_file(
const char* title,
const char* initial_path,
char* out_path,
int out_path_len,
char* out_message = nullptr,
int out_message_len = 0);
bool save_file(
const char* title,
const char* initial_path,
const char* suggested_name,
char* out_path,
int out_path_len,
char* out_message = nullptr,
int out_message_len = 0);</code></pre>
<p>
Use <code>initial_path</code> to select the starting directory or current file
context. <code>save_file</code> also accepts a <code>suggested_name</code> for
the filename field.
</p>
<h3>Open Example</h3>
<pre><code>char path[256];
char message[160];
if (gui::dialogs::open_file("Open File", "", path, sizeof(path),
message, sizeof(message))) {
/* open path */
}</code></pre>
<h3>Save Example</h3>
<pre><code>char path[256];
if (gui::dialogs::save_file("Save File", "", "untitled.txt",
path, sizeof(path))) {
/* write path */
}</code></pre>
<div class="figure">
<img src="assets/save_dialog.png" width="749" height="581" alt="Save file dialog showing folders and a filename field">
<p>Save-file dialog as used by the MontaukOS Word Processor app.</p>
</div>
<h2>Print Dialogs</h2>
<p>
Print dialog helpers allow applications to expose printer configuration to the user, and submit a file for printing.
</p>
<pre><code>bool configure_print(
const char* title,
const char* initial_printer_uri,
const char* job_name,
char* out_printer_uri,
int out_printer_uri_len,
char* out_printer_name,
int out_printer_name_len,
uint32_t* out_copies = nullptr,
char* out_message = nullptr,
int out_message_len = 0);
bool print_file(
const char* title,
const char* source_path,
const char* job_name,
char* out_job_id,
int out_job_id_len,
char* out_message = nullptr,
int out_message_len = 0);</code></pre>
<h2>Include</h2>
<pre><code>#include &lt;gui/dialogs.hpp&gt;</code></pre><br>
<hr>
<p class="center">Copyright &copy; 2026 Montauk Operating System Project. All rights reserved.<br><br>Page last revised 26 May 2026.</p>
<hr>
<div class="center">
<a href="../index.html">Back to Documentation Index</a>
</div>
</div>
</body>
</html>