From 5efd42326b5415887596bb5797479de83df2ef45 Mon Sep 17 00:00:00 2001
From: sirlilpanda <33928689+sirlilpanda@users.noreply.github.com>
Date: Mon, 1 Sep 2025 23:20:56 +1200
Subject: [PATCH] exposed input functions rather then hiding them in a method
 struct and added more comments

---
 src/device.h | 61 +++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 46 insertions(+), 15 deletions(-)

diff --git a/src/device.h b/src/device.h
index ec96b7b..1fc4f84 100644
--- a/src/device.h
+++ b/src/device.h
@@ -14,7 +14,7 @@
 // │   │lock    ├─────┴─────►│unlock  │
 // │   │state   │            │state   │
 // │   └──────┬─┘◄───┬───────┴──┬─────┘
-// │     ^    │     lck         │      
+// │     ▲    │     lck         │      
 // │ lck ┤    ├ str=dbg         ├ str=dbg      
 // │     │    │                 │      
 // │     │    │                 │      
@@ -23,8 +23,11 @@
 // └───┤debug   │◄──────────────┘      
 //     │        │                      
 //     └────────┘                      
+// the state pattern was primarly made in languages that had access to such great things
+// like object and interfaces but in c we must implement these ourselves
 
-// forward decl
+
+// forward decl for Device struct
 typedef struct Device_s Device_t;
 
 // the interface that you would use to interface with the state
@@ -34,27 +37,55 @@ typedef struct DeviceInterface_s{
     // but as we dont have a protected keyword
     // we have to pass in the device to change 
     // the state
-    void (*pressPwr)(Device_t*);
-    void (*pressStrInput)(Device_t*);
-    void (*pressLock)(Device_t*);
-}DeviceInterface_t;
 
-// the states themselves 
+    // the function called when the power button is pressed
+    void (*pressPwr)(Device_t*);
+
+    // the function called when we want to enter the string
+    void (*pressStrInput)(Device_t*);
+
+    // the function called when the lock button is pressed
+    void (*pressLock)(Device_t*);
+} DeviceInterface_t;
+
+// the states themselves
 typedef struct DeviceState_s{
+    
+    // the name of the current state the device is in
+    // i mainly use this for debugging
     const char* state_name;
-    Device_t* device;
+    
+    // the methods that this struct has (also called a vtable)
     DeviceInterface_t methods;
-}DeviceState_t;
+
+} DeviceState_t;
 
 // the device
 struct Device_s{
-    // in theroy this is also the flyweight pattern
-    DeviceState_t state;
-    char* entered_string;
-    int entered_string_len;
 
-    DeviceInterface_t methods;
+    // the current state of the device
+    DeviceState_t state;
+
+    // the string that the user has inputed null terminated
+    char* entered_string;
 };
 
-// creates the device
+/// @brief creates a new device at the given pointer
+/// @arg device: a pointer to where the struct is created
 void initDevice(Device_t* device);
+
+// this is your interface between the state 
+
+
+/// @brief presses the Pwr button on the device
+/// @arg device: the device that has it button pressed
+void pressPwrButton(Device_t *device);
+
+/// @brief presses the StrInput button on the device
+/// @arg device: the device that has it button pressed
+void pressStrInputButton(Device_t *device);
+
+/// @brief presses the Lock button on the device
+/// @arg device: the device that has it button pressed
+void pressLockButton(Device_t *device);
+