Code style posted and applied to code.

Trailing whitespace removed from code
Macros made for long, repetitive functions
Some binary size and runtime optimization through macros

Author: Connor

Makefile

@@ -36,7 +36,7 @@ ifeq ($(CC),gcc)
 
 ifeq ($(DEBUG),true)
 	# gcc-specific security/debug flags
-	WGCC   += -fanalyzer 
+	WGCC   += -fanalyzer
 	CFLAGS	= -ggdb $(WGCC)
 	LFLAGS  =
 
@@ -45,7 +45,7 @@ endif #debug
 else ifeq ($(CC),clang) # clang can be marginally slower
 
 	CC  	= clang
-	CFLAGS += -Weverything 
+	CFLAGS += -Weverything
 	LINKER 	= clang
 	WNOFLAGS += -Wno-disabled-macro-expansion
 
@@ -55,7 +55,7 @@ ifeq ($(DEBUG),true)
 			  -fsanitize-undefined-trap-on-error -ftrivial-auto-var-init=pattern \
 			  -fvisibility=hidden
 	CFLAGS	= -gdwarf-4 -Weverything -mspeculative-load-hardening -mretpoline
-	LFLAGS  = -fsanitize=address 
+	LFLAGS  = -fsanitize=address
 endif #debug
 
 endif #compiler
@@ -87,11 +87,11 @@ $(TARGET):
 	@# create these directories if needed
 	mkdir -p obj/modules
 	mkdir -p bin/
-	## compile with multiple threads, then link.
+	@# compile with multiple threads, then link.
 	$(MAKE) $(OBJECTS)
 	$(MAKE) link
 
-link: 
+link:
 	$(LINKER) $(OBJECTS) $(LFLAGS) -o $(BINDIR)/$(TARGET)
 	@echo "Linking complete!"
 

config.mk

@@ -1,9 +1,9 @@
 # fetchme's config.
 # options can be turned on with either
-# `Y' or `y'. to deselect an option, 
+# `Y' or `y'. to deselect an option,
 # comment it out.
 
-# to set a custom color, 
+# to set a custom color,
 # uncomment both CUSTOM_COLOR
 # and CUSTOM_COLOR_VALUE
 # M_CUSTOM_COLOR=y
@@ -25,7 +25,7 @@ M_KERNEL=y
 # Off by default.
 # Currently only works
 # with pacman-based
-# distros and 
+# distros and
 # portage-based
 # distros.
 #
@@ -47,12 +47,12 @@ M_SHELL=y
 # Works with FreeBSD
 M_TERMINAL=y
 
-# any option associated with CPU 
+# any option associated with CPU
 # needs to have CPU=y
 # Does NOT work with FreeBSD
 # M_CPU=y
 # M_CPU_THREADS=y
-# commented out by default since 
+# commented out by default since
 # it's **experimental**
 # M_CPU_TEMP=y
 # M_CPU_FREQUENCY=y

docs/CODESTYLE.md

@@ -0,0 +1,10 @@
+## Code Style
+
+# This project follows the Linux/coreboot code style:
+https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/process/coding-style.rst
+https://doc.coreboot.org/contributing/coding_style.html
+
+# ...With a couple differences.
+- indentations/tabs are 4 spaces
+- headers go in a specific order: standard libraries, POSIX libraries, system libraries, then X11 libraries. (alphabetical order if there are multiple of one type)
+- a little pedantic, but all functions on success must return ``EXIT_SUCCESS`` if they would otherwise return ``0``. This is more portable. (the same is true for ``EXIT_FAILURE`` and a nonzero value)

docs/CONTRIBUTING.md

@@ -3,7 +3,7 @@
 Thank you for considering contributing to fetchme.
 
 
-Unsure how to begin contributing? 
+Unsure how to begin contributing?
 Here is how to get started: https://makeapullrequest.com/
 
 Contributing in most cases helps to speed up the development process of the project, as I cannot work on it full time.
@@ -30,16 +30,16 @@ Small contributions such as fixing spelling errors are fine to do in a PR as lon
   - Adding logging messages or debugging output
   - Moving source files from one directory or package to another
 
-[//]:  # "If you find a security vulnerability, do NOT open an issue. Email <this will be added soon> instead."
+# If you find a security vulnerability, do NOT open an issue. Email connor-gh <at> outlook <dot> com instead.
 # For security Vulnerabilities:
 You can open an issue currently, but this will be changed in the future.
 
-Lastly, 
+Lastly,
 ## When filing an issue, make sure to answer these five questions:
 
-   - What version of GCC/Linux are you using (``gcc -v && uname -r``)?
+   - What version of GCC and Linux/BSD are you using (``gcc -v && uname -r``)?
    - What processor architecture are you using?
    - What did you do?
    - What did you expect to see?
-   - What did you see instead? 
+   - What did you see instead?
 ## At this point, you're ready to make your changes!

src/fetchme.c

@@ -1,52 +1,48 @@
 #include <stdio.h> // for those two printfs
-#include <string.h> 
+
 #include "./modules/include/color.h"
 #include "./modules/include/fetchme.h"
 
-/* 
+/*
  * the current state:
  *
- * - 1:1 features with the previous 
- *   version (repo private)
+ * - Feature improvements being worked on.
  *
- * - bug patching needed (as always)
- * - code style rework
  */
 
 int
 main(int argc, char *argv[])
 {
-    if (argc > 1)
-    {
-        if (argv[1][0] == '-')
-        {
-            switch (argv[1][1])
-            {
-                case 'v':
-                     printf("%s version %s\n", _PACKAGE_NAME, _PACKAGE_VERSION);
-                    break;
-                case 'h': /* fall through */
-                default:
-                    fprintf(stderr, 
-                        "Usage: \n"
-                        "\tfetchme [ -v ]\t\tPrint version info\n"
-                        "\tfetchme [ -h ]\t\tPrint this help message\n"
-                        "\tfetchme [ no options ]\tPrint system info\n"
-                        "\n\tFor more help, please consult the man page.\n");
-                    break;
+    if (argc > 1) {
+
+        if (argv[1][0] == '-') {
+
+            switch (argv[1][1]) {
+            case 'v':
+                printf("%s version %s\n", _PACKAGE_NAME, _PACKAGE_VERSION);
+                break;
+            case 'h': /* fall through */
+            default:
+                fprintf(stderr,
+                    "Usage: \n"
+                    "\tfetchme [ -v ]\t\tPrint version info\n"
+                    "\tfetchme [ -h ]\t\tPrint this help message\n"
+                    "\tfetchme [ no options ]\tPrint system info\n"
+                    "\n\tFor more help, please consult the man page.\n");
+                break;
             }
 
         }
         return 0;
     }
     // disable line wrapping.
-    // yes, I disabled 
+    // yes, I disabled
     // line wrapping for
     // something this simple.
 
     printf("\033[?7l");
-#ifdef USERNAME_HOSTNAME 
-    username_at_hostname(); 
+#ifdef USERNAME_HOSTNAME
+    username_at_hostname();
 #endif
 
 #ifdef DISTRO

src/modules/color.c

@@ -5,20 +5,20 @@
 #include "include/color.h"
 
 const char *
-color_distro() 
+color_distro()
 {
     char os_name[50];
     FILE *os_release = fopen("/etc/os-release", "r");
 
 
-    if(os_release == NULL) {
+    if (os_release == NULL) {
         perror("/etc/os-release");
         exit(EXIT_FAILURE);
     }
 
     fscanf(os_release, "NAME=%49[^\n]+", os_name);  /* get everything
-                                                         * that isn't a
-                                                         * newline */
+                                                     * that isn't a
+                                                     * newline */
     fclose(os_release);
     /*
      * remove quotation marks from
@@ -27,26 +27,34 @@ color_distro()
     sscanf(os_name, "\"%[^\"]", os_name); // get everything that isn't quotes
         /* if statement for distro name */
 #ifndef CUSTOM_COLOR
-    if (strstr(os_name, "Gentoo") != NULL)          return PURPLE;
-    else if (strstr(os_name, "Debian") != NULL)     return RED;
-    else if (strstr(os_name, "Void") != NULL)       return "\033[1;38;5;34m";
-    else if (strstr(os_name, "Ubuntu") != NULL)     return "\033[1;38;5;202m";
-    else if (strstr(os_name, "Solus") != NULL)      return BLUE;
-    else if ((strstr(os_name, "Pop!_OS")) \
+    if (strstr(os_name, "Gentoo") != NULL) {
+        return PURPLE;
+    } else if (strstr(os_name, "Debian") != NULL) {
+        return RED;
+    } else if (strstr(os_name, "Void") != NULL) {
+        return "\033[1;38;5;34m";
+    } else if (strstr(os_name, "Ubuntu") != NULL) {
+        return "\033[1;38;5;202m";
+    } else if (strstr(os_name, "Solus") != NULL) {
+        return BLUE;
+    } else if ((strstr(os_name, "Pop!_OS")) \
             || (strstr(os_name, "popos")) \
-            || (strstr(os_name, "pop_os")) != NULL) return "\033[1;38;5;29m";
-    else if ((strstr(os_name, "Mint")) \
+            || (strstr(os_name, "pop_os")) != NULL) {
+        return "\033[1;38;5;29m";
+    } else if ((strstr(os_name, "Mint")) \
             || (strstr(os_name, "OpenSUSE")) \
             || (strstr(os_name, "openSUSE")) \
-            || (strstr(os_name, "Manjaro")) != NULL)return GREEN;
-    else if ((strstr(os_name, "Arch")) \
-            || (strstr(os_name, "Artix")) != NULL)  return CYAN; 
-    else { 
+            || (strstr(os_name, "Manjaro")) != NULL) {
+        return GREEN;
+    } else if ((strstr(os_name, "Arch")) \
+            || (strstr(os_name, "Artix")) != NULL) {
+        return CYAN;
+    } else {
         fprintf(stderr, "Exception: distro color not found.");
-        exit(EXIT_FAILURE); // return value is 1
+        exit(EXIT_FAILURE);
     }
 #endif
 #ifdef CUSTOM_COLOR
-    return CUSTOM_COLOR_VALUE; 
+    return CUSTOM_COLOR_VALUE;
 #endif
 }

src/modules/cpu_info.c

@@ -5,18 +5,25 @@
 #include "./include/color.h"
 
 int
-cpu_info() 
+cpu_info()
 {
+#define ITER(x) (for (int i = 0; i < x; i++) \
+        while ((c = fgetc(cpu)) != '\n' && c != EOF))
 
     char brand[10];     // cpu brand
     char lineup[10];    // lineup (Ryzen, Core, Xeon, Epyc, etc)
     char sublineup[10]; // sublineup (5, 7, 9 or i5 i7 i9 etc)
     char model_num[10]; // model number (3600, 9900k, 3900X, etc)
-    char freq[10];      //cpu frequency
-    char threads[10];   //cpu threads
+#ifdef CPU_FREQUENCY
+    char freq[10];  // cpu frequency
+#endif /* CPU_FREQUENCY */
+#ifdef CPU_THREADS
+    char threads[10];   // cpu threads
+#endif /* CPU_THREADS */
 #ifdef CPU_TEMP
     float TEMP;
-#endif
+    FILE *cpu3 = fopen("/sys/class/hwmon/hwmon1/temp3_input", "r");
+#endif /* CPU_TEMP */
 
     int c;
 
@@ -26,48 +33,56 @@ cpu_info()
         exit(EXIT_FAILURE);
         }
     // this long line is used to skip lines.
-    for (int i = 0; i < 4; i++) while ((c = fgetc(cpu)) != '\n' && c != EOF);
+    //for (int i = 0; i < 4; i++)
+        //while ((c = fgetc(cpu)) != '\n' && c != EOF);
+    ITER(4);
 
     fscanf(cpu, "%*9s %*9s \t: %9s %9s %9s %9s", \
             brand, lineup, sublineup, model_num);
-    for(int i = 0; i < 3; i++) while ((c = fgetc(cpu)) != '\n' && c != EOF);
-
+#if defined(CPU_FREQUENCY) || defined(CPU_THREADS) || defined(CPU_TEMP)
+    /*for (int i = 0; i < 3; i++)
+        while ((c = fgetc(cpu)) != '\n' && c != EOF);*/
+    ITER(3);
 
+#ifdef CPU_FREQUENCY
     fscanf(cpu, "%*9s %*9s \t: %9s", freq);
-    for(int i = 0; i < 3; i++) while ((c = fgetc(cpu)) != '\n' && c != EOF);
-    
+#endif /* CPU_FREQUENCY */
+    /*for (int i = 0; i < 3; i++)
+        while ((c = fgetc(cpu)) != '\n' && c != EOF);*/
+    ITER(3);
 
+#ifdef CPU_THREADS
     fscanf(cpu, "%*9s \t: %9s", threads);
+#endif /* CPU_THREADS */
+#endif /* CPU_FREQUENCY || CPU_THREADS || CPU_TEMP */
     fclose(cpu);
 #ifdef CPU_TEMP
-    FILE *cpu3 = fopen("/sys/class/hwmon/hwmon1/temp3_input", "r");
 
-    if (cpu3 == NULL) TEMP = 0.;
-
-    else {
+    if (cpu3 == NULL) {
+        TEMP = 0.;
+    } else {
         char line1_value[100];
+        int x2 = 0;
         fscanf(cpu3, "%99s", line1_value);
         fclose(cpu3);
-        int x2;
         sscanf(line1_value, "%d", &x2);
-        TEMP =(x2/1000.);
+        TEMP = (x2/1000.);
     }
-#endif
-
+#endif /* CPU_TEMP */
 
     printf("%sCPU:\033[0m %s %s %s %s",\
         color_distro(), brand, lineup, sublineup, model_num);
 
 
 #ifdef CPU_THREADS
     printf(" (%s)", threads);
-#endif
+#endif /* CPU_THREADS */
 #ifdef CPU_FREQUENCY
     printf(" @ %sMHz", freq);
-#endif
+#endif /* CPU_FREQUENCY */
 #ifdef CPU_TEMP
   printf(" (%.1f°C)", TEMP);
-#endif
+#endif /* CPU_TEMP */
 printf("\n");
     return EXIT_SUCCESS;
 }