chore: cleanup atlas header file

Author: jasper-clarke

atlas.h

@@ -4,16 +4,35 @@
 #include <X11/Xft/Xft.h>
 #include <X11/Xlib.h>
 
-/* forward declarations */
+/* Forward Declarations */
 typedef struct Monitor Monitor;
 typedef struct Client Client;
 typedef struct Drw Drw;
 typedef struct Fnt Fnt;
 
-/* enums */
-enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */
-enum { SchemeNorm, SchemeSel };                  /* color schemes */
-enum { ColFg, ColBg, ColBorder };
+/* Enumerations */
+// Cursor types
+enum {
+  CurNormal, // Default cursor
+  CurResize, // Cursor when resizing windows
+  CurMove,   // Cursor when moving windows
+  CurLast    // Marker for last cursor type
+};
+
+// Color scheme indices
+enum {
+  SchemeNorm, // Normal color scheme
+  SchemeSel   // Selected color scheme
+};
+
+// Color indices within schemes
+enum {
+  ColFg,    // Foreground color
+  ColBg,    // Background color
+  ColBorder // Border color
+};
+
+// EWMH (Extended Window Manager Hints) atoms
 enum {
   NetSupported,
   NetWMName,
@@ -25,132 +44,147 @@ enum {
   NetWMWindowTypeDialog,
   NetClientList,
   NetLast
-}; /* EWMH atoms */
-enum {
-  WMProtocols,
-  WMDelete,
-  WMState,
-  WMTakeFocus,
-  WMLast
-}; /* default atoms */
+};
+
+// Default X11 atoms
+enum { WMProtocols, WMDelete, WMState, WMTakeFocus, WMLast };
+
+// Click locations for event handling
 enum {
-  ClkTagBar,
-  ClkLtSymbol,
-  ClkStatusText,
-  ClkWinTitle,
-  ClkClientWin,
-  ClkRootWin,
-  ClkLast
-}; /* clicks */
-
-/* structs */
+  ClkTagBar,     // Tag bar area
+  ClkLtSymbol,   // Layout symbol
+  ClkStatusText, // Status text area
+  ClkWinTitle,   // Window title area
+  ClkClientWin,  // Client window
+  ClkRootWin,    // Root window
+  ClkLast        // Marker for last click type
+};
+
+/* Data Structures */
+
+// Generic argument union for flexible parameter passing
 typedef union {
-  int i;
-  unsigned int ui;
-  float f;
-  const void *v;
+  int i;           // Integer value
+  unsigned int ui; // Unsigned integer value
+  float f;         // Float value
+  const void *v;   // Void pointer for generic data
 } Arg;
 
+// Mouse button configuration
 typedef struct {
-  unsigned int click;
-  unsigned int mask;
-  unsigned int button;
-  void (*func)(const Arg *arg);
-  const Arg arg;
+  unsigned int click;           // Click type
+  unsigned int mask;            // Modifier mask
+  unsigned int button;          // Button number
+  void (*func)(const Arg *arg); // Function to call
+  const Arg arg;                // Argument to pass
 } Button;
 
+// Keyboard shortcut configuration
 typedef struct {
-  unsigned int mod;
-  KeySym keysym;
-  void (*func)(const Arg *);
-  const Arg arg;
+  unsigned int mod;          // Modifier keys
+  KeySym keysym;             // Key symbol
+  void (*func)(const Arg *); // Function to call
+  const Arg arg;             // Argument to pass
 } Key;
 
+// Window rule configuration
 typedef struct {
-  const char *class;
-  const char *instance;
-  const char *title;
-  unsigned int tags;
-  int isfloating;
-  int monitor;
+  const char *class;    // Window class
+  const char *instance; // Window instance
+  const char *title;    // Window title
+  unsigned int tags;    // Tag mask
+  int isfloating;       // Floating state
+  int monitor;          // Monitor number
 } Rule;
 
+// Cursor structure
 typedef struct {
-  Cursor cursor;
+  Cursor cursor; // X11 cursor
 } Cur;
 
+// Font structure
 struct Fnt {
-  Display *dpy;
-  unsigned int h;
-  XftFont *xfont;
-  FcPattern *pattern;
-  struct Fnt *next;
+  Display *dpy;       // Display connection
+  unsigned int h;     // Font height
+  XftFont *xfont;     // Xft font
+  FcPattern *pattern; // Font pattern
+  struct Fnt *next;   // Next font in chain
 };
 
+// Color type definition
 typedef XftColor Clr;
 
+// Drawing context structure
 struct Drw {
-  unsigned int w, h;
-  Display *dpy;
-  int screen;
-  Window root;
-  Drawable drawable;
-  GC gc;
-  Clr *scheme;
-  Fnt *fonts;
+  unsigned int w, h; // Width and height
+  Display *dpy;      // Display connection
+  int screen;        // Screen number
+  Window root;       // Root window
+  Drawable drawable; // Drawing surface
+  GC gc;             // Graphics context
+  Clr *scheme;       // Color scheme
+  Fnt *fonts;        // Font set
 };
 
+// Client (window) structure
 struct Client {
-  char name[256];
-  float minAspectRatio, maxAspectRatio;
-  int x, y, w, h;
-  int oldx, oldy, oldw, oldh;
-  float horizontalRatio, verticalRatio;
-  int basew, baseh, incw, inch, maxw, maxh, minw, minh, hintsvalid;
-  int borderWidth, oldBorderWidth;
-  unsigned int tags;
-  int isFixedSize, isFloating, isUrgent, neverFocus, previousState,
-      isFullscreen;
-  Client *next;
-  Client *snext;
-  Monitor *mon;
-  Window win;
+  char name[256];                       // Window title
+  float minAspectRatio, maxAspectRatio; // Window aspect ratio constraints
+  int x, y, w, h;                       // Current geometry
+  int oldx, oldy, oldw, oldh;           // Previous geometry
+  float horizontalRatio, verticalRatio; // Position ratios
+  int basew, baseh, incw, inch, maxw, maxh, minw, minh; // Size constraints
+  int hintsvalid;                  // Whether size hints are valid
+  int borderWidth, oldBorderWidth; // Border widths
+  unsigned int tags;               // Tags (virtual desktops)
+  int isFixedSize;                 // Whether size is fixed
+  int isFloating;                  // Whether window is floating
+  int isUrgent;                    // Whether window needs attention
+  int neverFocus;                  // Whether window should never get focus
+  int previousState;               // Previous state
+  int isFullscreen;                // Whether window is fullscreen
+  Client *next;                    // Next client in list
+  Client *snext;                   // Next client in stack
+  Monitor *mon;                    // Monitor containing this client
+  Window win;                      // X11 window ID
 };
 
+// Layout structure
 typedef struct {
-  const char *symbol;
-  void (*arrange)(Monitor *);
+  const char *symbol;         // Layout symbol
+  void (*arrange)(Monitor *); // Layout arrangement function
 } Layout;
 
+// Monitor structure
 struct Monitor {
-  char ltsymbol[16];
-  float masterFactor;
-  int numMasterWindows;
-  int num;
-  int by;             /* bar geometry */
-  int mx, my, mw, mh; /* screen size */
-  int wx, wy, ww, wh; /* window area  */
-  unsigned int selectedTags;
-  unsigned int selectedLayout;
-  unsigned int tagset[2];
-  int showbar;
-  int topbar;
-  Client *clients;
-  Client *sel;
-  Client *stack;
-  Monitor *next;
-  Window barwin;
-  const Layout *layouts[2];
+  char ltsymbol[16];           // Current layout symbol
+  float masterFactor;          // Size of master area
+  int numMasterWindows;        // Number of windows in master area
+  int num;                     // Monitor number
+  int by;                      // Bar y position
+  int mx, my, mw, mh;          // Monitor geometry
+  int wx, wy, ww, wh;          // Window area geometry
+  unsigned int selectedTags;   // Current tag selection
+  unsigned int selectedLayout; // Current layout
+  unsigned int tagset[2];      // Tag sets
+  int showbar;                 // Bar visibility
+  int topbar;                  // Bar position
+  Client *clients;             // List of clients
+  Client *sel;                 // Selected client
+  Client *stack;               // Client stack
+  Monitor *next;               // Next monitor
+  Window barwin;               // Bar window
+  const Layout *layouts[2];    // Available layouts
 };
 
 /* Drawing Functions */
-/* Drawable abstraction */
+// Drawable creation and management
 Drw *drw_create(Display *dpy, int screen, Window win, unsigned int w,
                 unsigned int h);
 void drw_resize(Drw *drw, unsigned int w, unsigned int h);
 void drw_free(Drw *drw);
 
-/* Fnt abstraction */
+// Font management
 Fnt *drw_fontset_create(Drw *drw, const char *fonts[], size_t fontcount);
 void drw_fontset_free(Fnt *set);
 unsigned int drw_fontset_getwidth(Drw *drw, const char *text);
@@ -159,29 +193,27 @@ unsigned int drw_fontset_getwidth_clamp(Drw *drw, const char *text,
 void drw_font_getexts(Fnt *font, const char *text, unsigned int len,
                       unsigned int *w, unsigned int *h);
 
-/* Colorscheme abstraction */
+// Color management
 void drw_clr_create(Drw *drw, Clr *dest, const char *clrname);
 Clr *drw_scm_create(Drw *drw, const char *clrnames[], size_t clrcount);
 
-/* Cursor abstraction */
+// Cursor management
 Cur *drw_cur_create(Drw *drw, int shape);
 void drw_cur_free(Drw *drw, Cur *cursor);
 
-/* Drawing context manipulation */
+// Drawing context manipulation
 void drw_setfontset(Drw *drw, Fnt *set);
 void drw_setscheme(Drw *drw, Clr *scm);
 
-/* Drawing functions */
+// Basic drawing operations
 void drw_rect(Drw *drw, int x, int y, unsigned int w, unsigned int h,
               int filled, int invert);
 int drw_text(Drw *drw, int x, int y, unsigned int w, unsigned int h,
              unsigned int lpad, const char *text, int invert);
-
-/* Map functions */
 void drw_map(Drw *drw, Window win, int x, int y, unsigned int w,
              unsigned int h);
 
-/* Macros */
+/* Utility Macros */
 #define HEIGHT(X) ((X)->h + 2 * (X)->borderWidth)
 #define WIDTH(X) ((X)->w + 2 * (X)->borderWidth)
 #define ISVISIBLE(C) ((C->tags & C->mon->tagset[C->mon->selectedTags]))
@@ -190,107 +222,125 @@ void drw_map(Drw *drw, Window win, int x, int y, unsigned int w,
 #define BETWEEN(X, A, B) ((A) <= (X) && (X) <= (B))
 #define LENGTH(X) (sizeof(X) / sizeof(X[0]))
 
-/* function declarations */
+/* Function Declarations */
+// Window Functions
+void manage(Window w, XWindowAttributes *wa);
+void unmanage(Client *c, int destroyed);
+void updateWindowTitle(Client *c);
+void updateWindowTypeProps(Client *c);
+void updateWindowManagerHints(Client *c);
+void updateWindowSizeHints(Client *c);
+void configure(Client *c);
 void applyWindowRules(Client *c);
 int applyWindowSizeConstraints(Client *c, int *x, int *y, int *w, int *h,
                                int interact);
-void arrange(Monitor *m);
-void arrangeMonitor(Monitor *m);
+void setWindowFullscreen(Client *c, int fullscreen);
+void setWindowUrgent(Client *c, int urg);
+void toggleWindowFloating(const Arg *arg);
+void toggleWindowVisibility(Client *c);
+void resize(Client *c, int x, int y, int w, int h, int interact);
+void resizeclient(Client *c, int x, int y, int w, int h);
+void setclientstate(Client *c, long state);
+int sendevent(Client *c, Atom proto);
+int shouldscale(Client *c);
+void scaleclient(Client *c, int x, int y, int w, int h, float scale);
+Atom getatomprop(Client *c, Atom prop);
+long getstate(Window w);
+int gettextprop(Window w, Atom atom, char *text, unsigned int size);
+
+// Focus Functions
+void focus(Client *c);
+void unfocus(Client *c, int setfocus);
+void focusstack(const Arg *arg);
+void focusMonitor(const Arg *arg);
+void setfocus(Client *c);
+void moveCursorToClientCenter(Client *c);
+
+// Monitor Functions
+Monitor *createMonitor(void);
+void cleanupMonitor(Monitor *mon);
+int updateMonitorGeometry(void);
+Monitor *findMonitorFromWindow(Window w);
+Monitor *findMonitorInDirection(int dir);
+Monitor *getMonitorForArea(int x, int y, int w, int h);
+void sendWindowToMonitor(Client *c, Monitor *m);
+void directWindowToMonitor(const Arg *arg);
+
+// Client Functions
 void attach(Client *c);
+void detach(Client *c);
 void attachWindowToStack(Client *c);
+void detachWindowFromStack(Client *c);
+Client *findClientFromWindow(Window w);
+Client *getNextTiledWindow(Client *c);
+void updateclientlist(void);
+
+// Event Handling Functions
 void handleMouseButtonPress(XEvent *e);
-void checkForOtherWM(void);
-void cleanup(void);
-void cleanupMonitor(Monitor *mon);
 void handleClientMessage(XEvent *e);
-void configure(Client *c);
-void configurenotify(XEvent *e);
 void handleConfigureRequest(XEvent *e);
-Monitor *createMonitor(void);
 void handleWindowDestroy(XEvent *e);
-void detach(Client *c);
-void detachWindowFromStack(Client *c);
-Monitor *findMonitorInDirection(int dir);
-void drawDash(Monitor *m);
-void drawDashes(void);
 void handleMouseEnter(XEvent *e);
 void handleExpose(XEvent *e);
-void focus(Client *c);
 void handleFocusIn(XEvent *e);
-void focusMonitor(const Arg *arg);
-void focusstack(const Arg *arg);
-Atom getatomprop(Client *c, Atom prop);
-int getrootptr(int *x, int *y);
-long getstate(Window w);
-int gettextprop(Window w, Atom atom, char *text, unsigned int size);
-Client *getNextTiledWindow(Client *c);
-void registerMouseButtons(Client *c, int focused);
-void registerKeyboardShortcuts(void);
-void incNumMasterWindows(const Arg *arg);
-void keypress(XEvent *e);
-void killclient(const Arg *arg);
-void manage(Window w, XWindowAttributes *wa);
-void mappingnotify(XEvent *e);
-void maprequest(XEvent *e);
 void handleMouseMotion(XEvent *e);
-void movemouse(const Arg *arg);
-void moveCursorToClientCenter(Client *c);
-void pop(Client *c);
 void handlePropertyChange(XEvent *e);
-void quit(const Arg *arg);
-Monitor *getMonitorForArea(int x, int y, int w, int h);
-void resize(Client *c, int x, int y, int w, int h, int interact);
-void resizeclient(Client *c, int x, int y, int w, int h);
-void resizemouse(const Arg *arg);
-void restack(Monitor *m);
-void run(void);
-void scan(void);
-int sendevent(Client *c, Atom proto);
-void sendWindowToMonitor(Client *c, Monitor *m);
-void setclientstate(Client *c, long state);
-void setfocus(Client *c);
-void setWindowFullscreen(Client *c, int fullscreen);
+void handleWindowUnmap(XEvent *e);
+void mappingnotify(XEvent *e);
+void maprequest(XEvent *e);
+void keypress(XEvent *e);
+void configurenotify(XEvent *e);
+
+// Dashboard Functions
+void drawDash(Monitor *m);
+void drawDashes(void);
+void updateDashPosition(Monitor *m);
+void updatebars(void);
+void updatestatus(void);
+void toggleDash(const Arg *arg);
+
+// Layout Functions
+void arrange(Monitor *m);
+void arrangeMonitor(Monitor *m);
 void setlayout(const Arg *arg);
 void setMasterRatio(const Arg *arg);
-void setup(void);
-void setWindowUrgent(Client *c, int urg);
-void toggleWindowVisibility(Client *c);
+void incNumMasterWindows(const Arg *arg);
+void tile(Monitor *m);
+void monocle(Monitor *m);
+void dwindle(Monitor *m);
+void dwindlegaps(Monitor *m);
+void restack(Monitor *m);
+
+// Input Handling Functions
+void registerMouseButtons(Client *c, int focused);
+void registerKeyboardShortcuts(void);
+void updatenumlockmask(void);
+void movemouse(const Arg *arg);
+void resizemouse(const Arg *arg);
+int getrootptr(int *x, int *y);
+
+// Action Functions
+void killclient(const Arg *arg);
+void quit(const Arg *arg);
 void spawn(const Arg *arg);
 void tag(const Arg *arg);
-void directWindowToMonitor(const Arg *arg);
-void toggleDash(const Arg *arg);
-void toggleWindowFloating(const Arg *arg);
 void toggletag(const Arg *arg);
 void toggleview(const Arg *arg);
-void unfocus(Client *c, int setfocus);
-void unmanage(Client *c, int destroyed);
-void handleWindowUnmap(XEvent *e);
-void updateDashPosition(Monitor *m);
-void updatebars(void);
-void updateclientlist(void);
-int updateMonitorGeometry(void);
-void updatenumlockmask(void);
-void updateWindowSizeHints(Client *c);
-void updatestatus(void);
-void updateWindowTitle(Client *c);
-void updateWindowTypeProps(Client *c);
-void updateWindowManagerHints(Client *c);
 void view(const Arg *arg);
-Client *findClientFromWindow(Window w);
-Monitor *findMonitorFromWindow(Window w);
+void zoom(const Arg *arg);
+void pop(Client *c);
+
+// Main Functions
+void checkForOtherWM(void);
+void cleanup(void);
+void run(void);
+void scan(void);
+void setup(void);
 int xerror(Display *dpy, XErrorEvent *ee);
 int xerrordummy(Display *dpy, XErrorEvent *ee);
 int xerrorstart(Display *dpy, XErrorEvent *ee);
-void zoom(const Arg *arg);
-
-/* Layout functions */
-void tile(Monitor *m);
-void monocle(Monitor *m);
-void dwindle(Monitor *m);
-void dwindlegaps(Monitor *m);
-int shouldscale(Client *c);
-void scaleclient(Client *c, int x, int y, int w, int h, float scale);
 
+/* External Variables */
 extern Display *dpy;
 extern Monitor *monitors;
 extern Monitor *selectedMonitor;
@@ -299,4 +349,4 @@ extern int bh;
 extern Window root;
 extern unsigned int numlockmask;
 
-#endif // _ATLASWM_H_endif // _ATLASWM_H_
+#endif // _ATLASWM_H_

layouts.c

@@ -1,5 +1,5 @@
 #include "atlas.h"
-#include "config.h"
+#include "configurer.h"
 #include "util.h"
 #include <X11/Xlib.h>
 #include <stdio.h>