Merge pull request 'making-readme-more-tutorial-like' (#1) from making-readme-more-tutorial-like into main

Reviewed-on: #1

README.md

@@ -1,6 +1,215 @@
 # c_state_pattern
 
-a simple example of how to implement the state pattern in c. check [`main.c`](src/main.c) for the implementation
+A simple example of how to implement the state pattern in c. check [`main.c`](src/main.c) for the implementation.
+
+the state pattern is a pattern that aims to get rid of the mess that a state machine causes within your code. So i propose a problem for you, you are trying to write an state machine for a phone, sounds easy your phone only has 3 inputs that change the current state of the phone.
+
+#### inputs:
+- power button
+- lock button
+- string enter button
+
+the power button does what it says either turns the phone off or on, the lock button too does what it says on the tin locks the phone, lastly the string enter button enters what every string is in the phones buffer this is used for entering things like passwords to unlock the phone.
+
+using these buttons you determine you need 4 states for your phone these are:
+
+#### states:
+- off
+- unlock
+- locked
+- debug
+
+and you want the inter-action between these states to work as follows:
+
+```
+pwr : power button pressed
+lck : lock button pressed
+str=x : string enter button press with string x
+
+------------ state diagram ------------
+
+     pwr     ┌──────────┐    pwr    
+┌─────┴┬────►│off state │◄────┴┐    
+│      │     └────┬─────┘      │    
+│      │          │            │    
+│      │    ┌─────┘            │    
+│      │    ├ pwr              │    
+│      │    ▼                  │    
+│   ┌──┴─────┐  str=pwd   ┌────┴───┐
+│   │lock    ├─────┴─────►│unlock  │
+│   │state   │            │state   │
+│   └──────┬─┘◄───┬───────┴──┬─────┘
+│     ▲    │     lck         │      
+│ lck ┤    ├ str=dbg         ├ str=dbg      
+│     │    │                 │      
+│     │    │                 │      
+│     │    ▼                 │      
+│   ┌─┴──────┐               │      
+└───┤debug   │◄──────────────┘      
+    │        │                      
+    └────────┘                      
+
+----------- \ state diagram -----------
+```
+
+now you may read these requirements for the device and think ill just implement this with a state machine how bad can it be. Well your tech lead tells you that this systems needs to scaled to over 100 different states as they make the system more complex. you ask him "why do we need this" they reply back with management said so. And so between the idea of getting fired from throwing a brick at the management team and implementing this state diagram you decide you need this job and to implement state pattern.
+this pattern allows for greater flexibility when creating new states, since you dont have to add to an ever gowning state machine. we do some simple math to see how out of hand this can get, 
+if we assume that you end up with 100 states in the end and each state takes up 20 odd line 
+$$
+100_{\text{states}} \times 20_{\text{loc}} = 2000_{\text{loc}}
+$$
+that would be a 2k line state machine and a nightmare to debug (i should know ive seen them in the wild)
+
+so to start implement this pattern we first draw up a uml diagram of how it should go together. we can see we have the device itself and which is composed of a device state, and the entered string. 
+
+
+This "class" also has 3 methods pressPwrButton, pressStrInputButton, and pressLockButton. these methods are used to create an abstraction from the device state so the underlying state can change while using the same input functions.
+
+```mermaid
+classDiagram
+    class Device_t{
+        +DeviceState_t state
+        +String entered_string
+
+        +pressPwrButton() pressPwrMethod 
+        +pressStrInputButton() pressStrInputMethod
+        +pressLockButton() pressLockMethod
+    } 
+
+    class DeviceInterface_s {
+        +pressPwrMethod()
+        +pressStrInputMethod()
+        +pressLockMethod()
+    }
+
+    class DeviceState_t{
+        +String state_name
+        +DeviceInterface_s methods
+    }
+    Device_t *-- DeviceState_t
+    Device_t o-- DeviceInterface_s
+    DeviceInterface_s --o DeviceState_t
+
+```
+(note not real uml diagram because no one knows how to read them)
+
+1. so to implement this we will first start off with the [device struct](/src/device.h#L64) 
+    ```c
+    // device.h
+    typedef struct Device_s{
+        DeviceState_t state,
+        char* entered_string,
+    } Device_t;
+    ```
+
+2. Next we will implement the [methods](/src/device.h#L34) which in this case will be an [interface](https://en.wikipedia.org/wiki/Interface_(object-oriented_programming)). These methods are all the changes that can be made to the device i.e. your [inputs](#inputs).
+
+    ```c
+    // device.h
+    typedef struct DeviceInterface_s{
+        void (*pressPwr)(Device_t*);
+        void (*pressStrInput)(Device_t*);
+        void (*pressLock)(Device_t*);
+    } DeviceInterface_t;
+    ```
+
+
+3. and finally we will implement the [struct to hold the actual state](/src/device.h#L52) of the device. (note there is some funkiness in c with implementing this since you will need forward decls)
+    ```c
+    // device.h
+    typedef struct DeviceState_s{
+        const char* state_name;    
+        DeviceInterface_t methods;
+    }DeviceState_t;
+    ```
+4. now we need to implement the 3 functions for device inputs, ive implemented one here as the rest are very [similar](/src/device.c#L14). So this function takes the given device and then uses the methods defined within the device state to change the current state of the device. 
+    ```c
+    // device.c
+    void pressPwrButton(Device_t *device) {
+        device->state.methods.pressPwr(device);
+    }
+    ```
+5. now we will create a new header file called state, this file will contain the functions that sets the state of the given device to a new state. so we will implement a function per out defined [states](#states).
+    ```c
+    //state.h
+    void setDeviceStateToUnlock(Device_t *device);
+    void setDeviceStateToDebug(Device_t *device);
+    void setDeviceStateToLock(Device_t *device);
+    void setDeviceStateToOff(Device_t *device);
+    ```
+6. now we can implement one of these states as the rest of them should be fairly self explanatory. the state we will be implementing is the [lock state](/src/states/lock_state.c) as this should show off most of the different transitions. we will first start out with implementing the set state function. this function takes the given device and sets that devices state to this new state.
+    ```c
+    // lock_state.h
+    void setDeviceStateToLock(Device_t *device) {
+        device->state = (DeviceState_t){
+            .state_name = lock_state_name,
+            .methods = (DeviceInterface_t){
+                .pressPwr = &pressPwrMethod,
+                .pressStrInput = &pressStrInputMethod,
+                .pressLock = &pressLockMethod,
+            },
+        };
+    }
+    ```
+7. now that we have the function for setting this state we can now implement the functions for what this functions does depending on the inputs we will first start with the power button function. This is one of the simplest when the power button is press i.e. when the function is called we set the devices state to off.
+    ```c
+    // lock_state.c
+    static void pressPwrMethod(Device_t *device) {
+        printf("turning off device\n");
+        setDeviceStateToOff(device);
+    }
+
+    ```
+8. now we will implement the next function the lock button which in the lock state will do nothing.
+    ```c
+    // lock_state.c
+    static void pressLockMethod(Device_t *device) {
+        (void) device;
+        printf("nothing happens\n");
+    }
+    ```
+    
+9. finally we create the function for handling the text input, this function will check the entered string to see if its either "dbg", or "pwd" and if it is enter debug or unlock respectively.
+    ```c
+    static void pressStrInputMethod(Device_t *device) {
+        if (strcmp(device->entered_string, "dbg") == 0) {
+            printf("entering debug state\n");
+            setDeviceStateToDebug(device);
+            return;
+        }
+        if (strcmp(device->entered_string, "pwd") == 0) {
+            printf("entering unlock state\n");
+            setDeviceStateToUnlock(device);
+            return;
+        }
+        printf("unknown string %s\n", device->entered_string);
+    }
+    ```
+10. now we just need to implement the other [states](#states) in the same way we implemented this first one.
+11. finally we need to test our device. firstly within main we create a new device and set its initial state to off.
+    ```c
+    Device_t device;
+    initDevice(&device);
+    setDeviceStateToOff(&device);
+    ```
+12. now we can test that the device correctly travels through each state, by pressing one of the buttons ([invoking the input method functions](/src/device.h#L34)) then checking that the `state_name` is equal to the set state name.
+    ```c
+    
+    // turn on the device
+    pressPwrButton(&device);
+    if (strcmp(device.state.state_name, "lock_state.c") != 0) return 0;
+
+    ```
+
+now that you have implement this basic state pattern your tech lead comes to you and tells you to implement one more state then they will let you throw a brick at management as a treat this state is:
+- A calling state where:
+    - when the phone is unlocked you can type in a number in the the string input and it will call it
+    - you can also turn off the phone from this state
+    - the lock button ends the current call and returns back to the unlocked state
+
+so try implementing this yourself.
+
+other good resources for learning how this patterns works is [bob nystrom's game programming patterns book](https://gameprogrammingpatterns.com/state.html) as well as [refactoring Guru](https://refactoring.guru/design-patterns/state) however both of these implement this in the fun languages with object and interfaces.
 
 # how to build and run it
 
@@ -19,4 +228,4 @@ to build run these command in the root of the project:
 > ./build/main 
 
 ```
-and if you have a differnt complier you want to use that is posix compliant just change the `CC` macro in the `nob.c` with your one.
+and if you have a different compiler you want to use that is posix compliant just change the `CC` macro in the `nob.c` with your one.

nob.c

@@ -28,12 +28,12 @@
 #define CC "gcc"
 
 #define SRCS \
-    SRC_FOLDER"main.c", \
-    SRC_FOLDER"device.c", \
-    SRC_FOLDER"states/lock_state.c", \
-    SRC_FOLDER"states/unlock_state.c", \
-    SRC_FOLDER"states/debug_state.c", \
-    SRC_FOLDER"states/off_state.c", \
+    SRC_FOLDER "main.c", \
+    SRC_FOLDER "device.c", \
+    SRC_FOLDER "states/lock_state.c", \
+    SRC_FOLDER "states/unlock_state.c", \
+    SRC_FOLDER "states/debug_state.c", \
+    SRC_FOLDER "states/off_state.c", \
 
 #define C_ARGS \
     "-Wall", \

src/device.c

@@ -1,15 +1,21 @@
-#include "device.h"
 #include <string.h>
 
-static void pressPwrMethod(Device_t *device) {
+#include "device.h"
+
+
+// these functions are where the bulk of the ugliness happens
+// these function just pass through and call the method that 
+// is defined within the state structs methods
+
+void pressPwrButton(Device_t *device) {
     device->state.methods.pressPwr(device);
 }
 
-static void pressStrInputMethod(Device_t *device) {
+void pressStrInputButton(Device_t *device) {
     device->state.methods.pressStrInput(device);
 }
 
-static void pressLockMethod(Device_t *device) {
+void pressLockButton(Device_t *device) {
     device->state.methods.pressLock(device);
 }
 
@@ -17,12 +23,6 @@ void initDevice(Device_t* device) {
     *device = (Device_t){
         .state = NULL,
         .entered_string = "frogs",
-        .entered_string_len = 6,
-        .methods = (DeviceInterface_t){
-            .pressPwr = &pressPwrMethod, 
-            .pressStrInput = &pressStrInputMethod, 
-            .pressLock = &pressLockMethod, 
-        },
     };
 }
 

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
+
+    // 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;
+} 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);
+

src/main.c

@@ -10,25 +10,26 @@ int main() {
     if (strcmp(device.state.state_name, "off_state.c") != 0) return 0;
 
     // turn on the device
-    device.methods.pressPwr(&device);
+    pressPwrButton(&device);
+
     if (strcmp(device.state.state_name, "lock_state.c") != 0) return 0;
 
     // send the current string
-    device.methods.pressStrInput(&device);
+    pressStrInputButton(&device);
     if (strcmp(device.state.state_name, "lock_state.c") != 0) return 0;
     
     // send in the right string
     device.entered_string = "pwd";
-    device.methods.pressStrInput(&device);
+    pressStrInputButton(&device);
     if (strcmp(device.state.state_name, "unlock_state.c") != 0) return 0;
 
     // try to enter debug mode
     device.entered_string = "dbg";
-    device.methods.pressStrInput(&device);
+    pressStrInputButton(&device);
     if (strcmp(device.state.state_name, "debug_state.c") != 0) return 0;
 
     // try to power down
-    device.methods.pressPwr(&device);
+    pressPwrButton(&device);
     if (strcmp(device.state.state_name, "off_state.c") != 0) return 0;
 
     return 0;

src/states/debug_state.c

@@ -3,6 +3,7 @@
 #include "state.h"
 #include "../device.h"
 
+// this is me being lazy
 const char debug_state_name[] = __FILE_NAME__;
 
 static void pressPwrMethod(Device_t *device) {
@@ -23,7 +24,6 @@ static void pressLockMethod(Device_t *device) {
 void setDeviceStateToDebug(Device_t *device) {
     device->state = (DeviceState_t){
         .state_name = debug_state_name,
-        .device = device,
         .methods = (DeviceInterface_t){
             .pressPwr = &pressPwrMethod,
             .pressStrInput = &pressStrInputMethod,

src/states/lock_state.c

@@ -4,6 +4,7 @@
 #include "state.h"
 #include "../device.h"
 
+// this is me being lazy
 const char lock_state_name[] = __FILE_NAME__;
 
 static void pressPwrMethod(Device_t *device) {
@@ -35,7 +36,6 @@ static void pressLockMethod(Device_t *device) {
 void setDeviceStateToLock(Device_t *device) {
     device->state = (DeviceState_t){
         .state_name = lock_state_name,
-        .device = device,
         .methods = (DeviceInterface_t){
             .pressPwr = &pressPwrMethod,
             .pressStrInput = &pressStrInputMethod,

src/states/off_state.c

@@ -2,6 +2,7 @@
 #include "../device.h"
 #include <stdio.h>
 
+// this is me being lazy
 const char off_state_name[] = __FILE_NAME__;
 
 static void pressPwrMethod(Device_t *device) {
@@ -10,11 +11,13 @@ static void pressPwrMethod(Device_t *device) {
 }
 
 static void pressStrInputMethod(Device_t *device) {
+    // cast it to void since its unused
     (void) device;
     printf("nothing happens\n");
 }
 
 static void pressLockMethod(Device_t *device) {
+    // cast it to void since its unused
     (void) device;
     printf("nothing happens\n");
 }
@@ -22,7 +25,6 @@ static void pressLockMethod(Device_t *device) {
 void setDeviceStateToOff(Device_t *device) {
     device->state = (DeviceState_t){
         .state_name = off_state_name,
-        .device = device,
         .methods = (DeviceInterface_t){
             .pressPwr = &pressPwrMethod,
             .pressStrInput = &pressStrInputMethod,

src/states/state.h

@@ -1,7 +1,8 @@
 #pragma once
 #include "../device.h"
 
-// each of these are each state
+// each of these are the functions that prove 
+// the given state transition
 void setDeviceStateToLock(Device_t *device);
 void setDeviceStateToUnlock(Device_t *device);
 void setDeviceStateToDebug(Device_t *device);

src/states/unlock_state.c

@@ -13,6 +13,8 @@ static void pressPwrMethod(Device_t *device) {
 }
 
 static void pressStrInputMethod(Device_t *device) {
+
+    // check to see if the entered string is the one to enter the debug state
     if (strcmp(device->entered_string, "dbg") == 0) {
         printf("entering debug state\n");
         setDeviceStateToDebug(device);
@@ -27,9 +29,8 @@ static void pressLockMethod(Device_t *device) {
 }
 
 void setDeviceStateToUnlock(Device_t *device) {
-    device->state = (DeviceState_t){
+    device->state = (DeviceState_t) {
         .state_name = name,
-        .device = device,
         .methods = (DeviceInterface_t){
             .pressPwr = &pressPwrMethod,
             .pressStrInput = &pressStrInputMethod,