From a5121df3e6af8374d18994c6772c58ee4672e7b4 Mon Sep 17 00:00:00 2001
From: PC <TheRainbowPhoenix@users.noreply.github.com>
Date: Mon, 20 Nov 2023 22:40:15 +0000
Subject: [PATCH] Adding some more docs about GUI, button is mostly done

---
 astro.config.mjs                              |  39 +++++---
 public/img/gui/button_clickme.png             | Bin 0 -> 533 bytes
 public/img/gui/dialog_label.png               | Bin 0 -> 1930 bytes
 src/content/docs/reference/cpu/ubc.mdx        |   8 ++
 src/content/docs/reference/gui/button.mdx     |  83 ++++++++++++++++++
 src/content/docs/reference/gui/dialog.mdx     |   8 ++
 src/content/docs/reference/gui/dropDown.mdx   |   8 ++
 src/content/docs/reference/gui/label.mdx      |   8 ++
 src/content/docs/reference/gui/longLabel.mdx  |   8 ++
 .../docs/reference/gui/radioButton.mdx        |   8 ++
 src/content/docs/reference/gui/textBox.mdx    |   8 ++
 src/content/docs/reference/gui/util.mdx       |   8 ++
 src/content/docs/reference/os/debug.mdx       |  34 +++++++
 src/content/docs/reference/os/gui.mdx         |  35 ++++++++
 14 files changed, 245 insertions(+), 10 deletions(-)
 create mode 100644 public/img/gui/button_clickme.png
 create mode 100644 public/img/gui/dialog_label.png
 create mode 100644 src/content/docs/reference/cpu/ubc.mdx
 create mode 100644 src/content/docs/reference/gui/button.mdx
 create mode 100644 src/content/docs/reference/gui/dialog.mdx
 create mode 100644 src/content/docs/reference/gui/dropDown.mdx
 create mode 100644 src/content/docs/reference/gui/label.mdx
 create mode 100644 src/content/docs/reference/gui/longLabel.mdx
 create mode 100644 src/content/docs/reference/gui/radioButton.mdx
 create mode 100644 src/content/docs/reference/gui/textBox.mdx
 create mode 100644 src/content/docs/reference/gui/util.mdx
 create mode 100644 src/content/docs/reference/os/debug.mdx
 create mode 100644 src/content/docs/reference/os/gui.mdx

diff --git a/astro.config.mjs b/astro.config.mjs
index 1374a6e..484a2bf 100644
--- a/astro.config.mjs
+++ b/astro.config.mjs
@@ -27,19 +27,38 @@ export default defineConfig({
 						{ label: 'Building', link: '/getting-started/building/' },
 					],
 				},
-				{
-					label: 'Guides',
-					collapsed: true,
-					autogenerate: { directory: 'guides' },
-					items: [
-						// Each item here is one entry in the navigation menu.
-						{ label: 'Example Guide', link: '/guides/example/' },
-					],
-				},
+				// {
+				// 	label: 'Guides',
+				// 	collapsed: true,
+				// 	autogenerate: { directory: 'guides' },
+				// 	items: [
+				// 		// Each item here is one entry in the navigation menu.
+				// 		{ label: 'Example Guide', link: '/guides/example/' },
+				// 	],
+				// },
 				{
 					label: 'Reference',
 					collapsed: true,
-					autogenerate: { directory: 'reference' },
+					items: [
+						{
+							label: '📱 GUI',
+							collapsed: true,
+							autogenerate: { directory: 'reference/gui' },
+
+						},
+						{
+							label: '📟 OS',
+							collapsed: true,
+							autogenerate: { directory: 'reference/os' },
+
+						},
+						{
+							label: '🧮 CPU',
+							collapsed: true,
+							autogenerate: { directory: 'reference/cpu' },
+
+						}
+					]
 				},
 				{
 					label: 'Tutorials',
diff --git a/public/img/gui/button_clickme.png b/public/img/gui/button_clickme.png
new file mode 100644
index 0000000000000000000000000000000000000000..c9a45ebe91f2ed2750b4851115c9ea55b28d58e9
GIT binary patch
literal 533
zcmV+w0_y#VP)<h;3K|Lk000e1NJLTq003|R001fo0ssI2<d;Z|00009a7bBm000tn
z000tn0p4aGcmMza$4Nv%RCwC$nlWy}FbqX=&E^(G&Xo=Ya)JW6K!J?u(7{6n4;?gg
za0LiZ1(KpEg$V5U6Mu+gNmiaIiUPEoV6L_U0ssY20EKx1J-weGMLj?duLnp}gfrg8
z9-zm!BSe&eh7fvyUcatU)9<u#B@RA7$7sXmHIA-8Z=07hP?#^!@DnyJZ=hYaf7vII
z8cVORFmnbvdp5}IqIe~#u?%H@<7}mID80=?ftEDO$qnBFfHnio{~_Yb1k?OD(9{M%
z=Yb|tB~x*(wU}V<q68VeMnSevprsGyqC$rUiu6cq(*d+L{yKn`HBCUdUvna2lrRDn
z*Uid+Do+)l`7;oos)b$A0RdFluPij}K%ZgB8+RB>aGd>AWnNJh0klf$PM|!btR@dt
zicPFJDV;)YSw@Ve7;4Fm9|x592-%nKNt=v2i4JsqOP(B%$WEdF<zIpj(VevB>|%E%
z{aWH#p2Vqg-b#`8N{@J(*>x)Zu8qI+CC}+7a}|rEqX@kNXl?v;0DXD`PypQ&P?#rB
zD9ZsT<arebQZ9=%1BDbd1C4h6I72n{0F8F}yg;Iw?}z^9U$`bFNl#jF$KKfh)Y<+3
X?^k=U*bgcF00000NkvXXu0mjfay;KV

literal 0
HcmV?d00001

diff --git a/public/img/gui/dialog_label.png b/public/img/gui/dialog_label.png
new file mode 100644
index 0000000000000000000000000000000000000000..e4d41ccb74d398bca70ec8d1240458e226de70c5
GIT binary patch
literal 1930
zcmb_dc{JN;7ygM@Tf354N`qRCZH%oHL5!`awPI<~p=fDkGzhhY*3zQdDjgD(Dq?I=
z%UF`%NMr42MRn*{Vp=lV$Z#qcN+#1e-*@JZ@6Yd?=Y8+J&%Nh4@4e?e=N6pvc9oJ;
zkpuuh%H0j=2LM6{fuAl85!_)Hjcf!)6zAvd5AX#ZzW_8T5m*VV8|pd$$m9M#LW@xv
zcmNPHa7Q`@;NPy3I%4O8U|>Aw_l}58M#<w`X^Y6F9u>1$3|87k@xe(ob*ItynYI49
z5gtE1g&LPSX(~?MSq?KD%~_t5?S-8gEpa3qRqh?)-AGNQ7~0tl+J2n8f3UyjJa1=b
zr{9wCr@h_U>$mNeuhU#)kuGp%w^DjYaB#`78<`v-#ObN++vF$$?UZ=!);;}=ocI#}
zVr)zizqt$tN{MF)<<xLU7OH(WCgD8YtL%hM9z|l{^MM(l_#$~?;%<3me8u23pUp+W
zwYKSXbF|g@6K&7)#^vz5kw8GN?4d?b#lF`c&sDu)iyb{ZG~G&9=anM^)NXr=)HdVv
zg#KeLT<U7t8LW(4%Yc>-G^mN^{F2YwS3bXGoVwXY*5PQ8E<M<Gw52fJS$orcx3<vo
zYhA@!v;99l;PsThJ9#YQ3?LCytw*TWR{C1lLEL`z-M&YJ{*zEKqq#Km;ySR1U1V5D
z)_xOWseGlY!qY050-dyZg7jP-5iY?TjP)tf@B8ZXi(WLZve>KM|0ePwS0M~aao=w=
zs+`btkqlFH9a37bjwUFGDWv~wqYceXIWo{;%xDi_+z;7zM2B=&UDeN{!^R!n$@GPn
zeM`ZWX&W|$-e#jDh}Qc>5_3Afs{O}1KR$sp$e37pvbk~?_y<+q<Ym`-v|KQggQ!Ot
zeZZQQwxu?Omd@r-m4b=NpBVgXkx379QmERk?~ebpGW%2k&m=*5#W|!@KY35Lr|U!<
za-x?m@5@~$;uqarFTF>YwaW)vRzC!XJD2?8LT|eN^1e*&se(1BQP(CeOJ5{IB?^NM
z2b!}}Op|s~w8r~V^@}JTx{>$ndK>e>;R-dvGFN<l9ZDrvCsG4<@DH0WG`7YJ=y;ND
zxHflz8Q55euGy7VaIGSZsm~1~EbzrkU!B8?N)H{6NoS~@R$IA1${5)uADx%kJ2Z-7
zJsVUa6bZvk=f6kAjDg=qIEY7AiaoBSH#hw-<>&3Nl0<WWeTc=-40LdF(AIDnZ^zyy
zFjdJ07C5z85EFjdYWUWc-a&>^=1AwO*sm34>n)Rr&pk4Y(v(sq31i^77lvB}$%(2>
zOFl0`)>gXq=~L;fcgG`HNb5yhV%sxbRvG;BD&)GV#H!)O@2AH%zWM>row@tnXx=Wd
z?8A<)U4afnnXl>UWLXCm{{pW4*ct;O)k90cHL+1no|lA_$eDsf4zJISbhC?Y^D(!c
zl96wgul8n}jJCkhUG<MB_D0=){&v1<xP`fJ$}4yH;|#9u0ME%pWL<_{2vwF@F$>mN
zzJpjo$cInUF6J9t8Jl6E?0cj`ctt45xDJLdrY-<Acen}}NoFU^5;L*W@~JJxC&(Jw
z1@vVTNyb@Tgch&U5w*7|Qx~{!f&DsGBc&xX#3hQA;$(Ky7QW%bBP}H@9v%e6#i@4>
zIDgf-uHMafxsekx&Tg+as_K#X6+VEwM!h_qOZih>?vcL`d2~YAM3rWaWRMm}gA1EC
zs&@S2Gm3jST=(cX<dR0!Sqz}3Bo}NRG@xSCgN{S<4LoNk2L_*IyPH)#9pb|WVVE~<
zuZ6O{r&i>ZzZD9ARe}R%svZ;c1Y`=DGs#cL)g;S{60EGOX4I?@`YEo3&VwE^de~2i
z3N^&f?uA<Zn0vq4ZUY{pG$hQga29HBYwJ0neWK<lQGv}K+!;(Gn3$M2$U%K6uV}`&
zW4jZXXrM-0(-eUC<Y#1EXC5kCg=B%P5Fg!0Ur4mwsmaW61j|pHgWmn52;&P8*t%Gp
ztK&`q6>h4z;U!`j<>J}>tjFhM`wGC!@y`>6uoZj!pV>w+a2or?vM^a|Gz*zatUbtu
zG>DmV%{^8(TdZAb-b3y@s%>yHAj3@|!Vomg=4Uddu6$^ccC*-4ZEiwaNwYm=8%7Y~
zhDeZfu)ncSiIlxs6DqQ56e#urgy>|cLNE(tEE!jPy80yMxA6p%3V$fK4cv}pSxb~N
z&o@j<5G`uLS-U|*ICe+Gl4|f6+>Qz4DwG%4Z>wLr`e@M>Ojn%kHE5oiU4l2<0a3!M
z(#0V5E>slw0t5ysiogK>0J^%Q0ziZX&=fpZFspw6(GpDUZ}v;#f0F;M{%_^K$^S_F
zKZM&+ESh+>UV5bDSy`mckmg1k)G<K&D1`4V*hhlUHe1s`@ONH{XE(aRpohpWtSJy6
f{iW4jsY9{lZ#ImpaV7nNRSLMfcq3b#Fxh_r2Pr=q

literal 0
HcmV?d00001

diff --git a/src/content/docs/reference/cpu/ubc.mdx b/src/content/docs/reference/cpu/ubc.mdx
new file mode 100644
index 0000000..ef72f56
--- /dev/null
+++ b/src/content/docs/reference/cpu/ubc.mdx
@@ -0,0 +1,8 @@
+---
+title: UBC (User Break Controller)
+description: User Break Controller
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/cpu/ubc.hpp)
+:::
\ No newline at end of file
diff --git a/src/content/docs/reference/gui/button.mdx b/src/content/docs/reference/gui/button.mdx
new file mode 100644
index 0000000..79fa0f0
--- /dev/null
+++ b/src/content/docs/reference/gui/button.mdx
@@ -0,0 +1,83 @@
+---
+title: Button
+description: GUIButton
+---
+
+Buttons are a fundamental GUI element that provides a clickable area with an associated action. They are commonly used in dialogs and serve as a convenient way for users to interact with the touchscreen. Below is a simplified documentation for the `GUIButton` class.
+
+:::tip[Need code ?]
+You can jump right to the [👨‍💻 Usage](#usage) or can refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui/button.hpp) if you need more details.
+:::
+
+## Constructor
+
+```c
+GUIButton(
+    uint16_t leftX, uint16_t topY, uint16_t rightX, uint16_t bottomY,
+    const char *text,
+    uint16_t eventID
+)
+```
+
+Creates a **basic button** with the specified dimensions and text.
+
+- `leftX`: x-coordinate of the left side of the button.
+- `topY`: y-coordinate of the top side of the button.
+- `rightX`: x-coordinate of the right side of the button.
+- `bottomY`: y-coordinate of the bottom side of the button.
+- `text`: text displayed on the button, indicating the action it performs.
+- `eventID`: A unique identifier associated with the button, typically used to handle button clicks.
+
+### Optional "flags" 
+
+```c
+GUIButton(
+    uint16_t leftX, uint16_t topY, uint16_t rightX, uint16_t bottomY,
+    const char *text,
+    uint16_t eventID, int flags
+)
+```
+
+Creates a **basic button** with the flag capacity. *For now*, the only flag known is the "FlagEnabled" and could be found on the [GUIButton.Flag](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui/button.hpp#L7) enum.
+
+
+## Usage
+
+Let's create a button that says "Click Me !" :
+
+![A button that says "Click Me !"](/wiki/img/gui/button_clickme.png)
+
+
+```c++
+// parent is the dialog or parent container
+
+// the BUTTON_CLICK_EVENT_ID on click
+const uint16_t BUTTON_CLICK_EVENT_ID = 1;
+
+GUIButton m_buttonOK = new GUIButton(
+    parent.GetLeftX() + 10,
+    parent.GetTopY() + 40,
+    parent.GetLeftX() + 10 + 95, // width of 95
+    parent.GetTopY() + 40 + 30  //  height of 30
+    "Click Me !",
+    BUTTON_CLICK_EVENT_ID
+);
+
+// ...
+
+// On the parent.OnEvent, here a GUIDialog :
+virtual int OnEvent(struct GUIDialog_Wrapped *dialog, struct GUIDialog_OnEvent_Data *event) {
+    if (event->GetEventID() == BUTTON_CLICK_EVENT_ID) {
+        // TODO: do some action
+        return 0;
+    }
+    // If we don't process the event, let the base class process it.
+    return GUIDialog::OnEvent(dialog, event);
+}
+```
+
+### Use in C++ dialog
+
+:::caution
+This section is **not finished**, but you can take a look at the [👨‍💻 demo gui](https://github.com/SnailMath/hollyhock-2/blob/04a4c086e1145a89d79dfe65158558398da6d8b1/demos/demo_gui/main.cpp#L21) for a complete example
+:::
\ No newline at end of file
diff --git a/src/content/docs/reference/gui/dialog.mdx b/src/content/docs/reference/gui/dialog.mdx
new file mode 100644
index 0000000..0eaca1b
--- /dev/null
+++ b/src/content/docs/reference/gui/dialog.mdx
@@ -0,0 +1,8 @@
+---
+title: Dialog
+description: GUIDialog
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui/dialog.hpp)
+:::
\ No newline at end of file
diff --git a/src/content/docs/reference/gui/dropDown.mdx b/src/content/docs/reference/gui/dropDown.mdx
new file mode 100644
index 0000000..dfcab6f
--- /dev/null
+++ b/src/content/docs/reference/gui/dropDown.mdx
@@ -0,0 +1,8 @@
+---
+title: Drop Down Menu
+description: GUIDropDownMenuItem
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui/dropDown.hpp)
+:::
\ No newline at end of file
diff --git a/src/content/docs/reference/gui/label.mdx b/src/content/docs/reference/gui/label.mdx
new file mode 100644
index 0000000..4e8621e
--- /dev/null
+++ b/src/content/docs/reference/gui/label.mdx
@@ -0,0 +1,8 @@
+---
+title: Label
+description: GUILabel
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui/label.hpp)
+:::
\ No newline at end of file
diff --git a/src/content/docs/reference/gui/longLabel.mdx b/src/content/docs/reference/gui/longLabel.mdx
new file mode 100644
index 0000000..2fb1266
--- /dev/null
+++ b/src/content/docs/reference/gui/longLabel.mdx
@@ -0,0 +1,8 @@
+---
+title: longLabel
+description: GUILongLabel
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui/longLabel.hpp)
+:::
\ No newline at end of file
diff --git a/src/content/docs/reference/gui/radioButton.mdx b/src/content/docs/reference/gui/radioButton.mdx
new file mode 100644
index 0000000..5ce83a5
--- /dev/null
+++ b/src/content/docs/reference/gui/radioButton.mdx
@@ -0,0 +1,8 @@
+---
+title: radioButton
+description: GUIRadioButton
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui/radioButton.hpp)
+:::
\ No newline at end of file
diff --git a/src/content/docs/reference/gui/textBox.mdx b/src/content/docs/reference/gui/textBox.mdx
new file mode 100644
index 0000000..94d2170
--- /dev/null
+++ b/src/content/docs/reference/gui/textBox.mdx
@@ -0,0 +1,8 @@
+---
+title: textBox
+description: GUITextBox
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui/textBox.hpp)
+:::
\ No newline at end of file
diff --git a/src/content/docs/reference/gui/util.mdx b/src/content/docs/reference/gui/util.mdx
new file mode 100644
index 0000000..4c30c34
--- /dev/null
+++ b/src/content/docs/reference/gui/util.mdx
@@ -0,0 +1,8 @@
+---
+title: Primitives & Utils
+description: GUIElement
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui/util.hpp)
+:::
\ No newline at end of file
diff --git a/src/content/docs/reference/os/debug.mdx b/src/content/docs/reference/os/debug.mdx
new file mode 100644
index 0000000..a19ada4
--- /dev/null
+++ b/src/content/docs/reference/os/debug.mdx
@@ -0,0 +1,34 @@
+---
+title: Debug
+description: Functions useful during debugging
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/debug.hpp)
+:::
+
+
+It can be useful to print text or numbers to the screen whilst debugging, without creating a full GUI, or pause execution and wait for a key press.
+Thoroughly recommended only for debugging - prefer GUI elements for user-facing input/output!
+```cpp
+// Print "Hello, world!" at 0, 0 in black on white
+Debug_SetCursorPosition(0, 0);
+Debug_PrintString("Hello, world!", false);
+
+// Print "Inverted text" at 1, 1 in white on black
+Debug_SetCursorPosition(1, 1);
+Debug_PrintString("Inverted text", true);
+
+// Print the number 0x1322 at 3, 7
+Debug_PrintNumberHex_Word(0x1322, 3, 7);
+
+// Print small text with a format string
+Debug_Printf(20, 20, false, 0, "Format strings are %s in %d!", "cool", 2018);
+
+// Draw the changes we made to VRAM onto the LCD
+// Defined in sdk/os/lcd.hpp
+LCD_Refresh();
+
+// Block until the user presses a key
+Debug_WaitKey();
+```
\ No newline at end of file
diff --git a/src/content/docs/reference/os/gui.mdx b/src/content/docs/reference/os/gui.mdx
new file mode 100644
index 0000000..011cd70
--- /dev/null
+++ b/src/content/docs/reference/os/gui.mdx
@@ -0,0 +1,35 @@
+---
+title: GUI
+description: Functions and classes to create/display GUI elements.
+---
+
+:::caution
+This doc is **WIP**, please refer to its [original SDK Code](https://github.com/SnailMath/hollyhock-2/blob/master/sdk/include/sdk/os/gui.hpp)
+:::
+
+
+__Example:__ Display a simple dialog with a label
+
+![The dialog as shown on the calculator, with "Dialog Title" as title and "Label Text" as body](/wiki/img/gui/dialog_label.png)
+
+Here we are using a [GUIDialog](../../gui/dialog/) that's wrapping a [GUILabel](../../gui/label/). The code should look like this : 
+
+```cpp
+GUIDialog dialog(
+    GUIDialog::Height25,
+    GUIDialog::AlignTop,
+    "Dialog Title",
+    GUIDialog::KeyboardStateABC
+);
+
+GUILabel label(
+    dialog.GetLeftX() + 10,
+    dialog.GetTopY() + 10,
+    "Label Text"
+);
+dialog.AddElement(label);
+
+dialog.ShowDialog();
+```
+Where the [Height25](../../gui/dialog/#Height25) means 1/4 of the screen height, and [AlignTop](../../gui/dialog/#AlignTop) that it'll be top-aligned, fixed to screen top.
+The [KeyboardStateABC](../../gui/dialog/#KeyboardStateABC) is a flag indicating what the keyboard should display if called on this dialog. Here the "ABC" tells it'll be the standard "abc" keyboard when pressing the "Keyboard" key.